Add enrichment into activity get (#115)

Fixes #114

Author: ferhatelmas

README.md

@@ -104,6 +104,9 @@ client.get_activities(foreign_id_times=[
     (foreign_id, activity_time),
 ])
 
+# Enrich while getting activities
+client.get_activities(ids=[activity_id], enrich=True, reactions={"counts": True})
+
 # Update some parts of an activity with activity_partial_update
 set = {
     'product.name': 'boots',

stream/client.py

@@ -352,10 +352,14 @@ def update_activity(self, activity):
         """
         return self.update_activities([activity])
 
-    def get_activities(self, ids=None, foreign_id_times=None):
+    def get_activities(
+        self, ids=None, foreign_id_times=None, enrich=False, reactions=None, **params
+    ):
         """
         Retrieves activities by their ID or foreign_id + time combination
 
+        Pass enrich and reactions options for enrichment
+
         ids: list of activity IDs
         foreign_id_time: list of tuples (foreign_id, time)
         """
@@ -371,7 +375,13 @@ def get_activities(self, ids=None, foreign_id_times=None):
                 "At most one of the parameters ids or foreign_id_time must be provided"
             )
 
+        endpoint = "activities/"
+        if enrich or reactions is not None:
+            endpoint = "enrich/" + endpoint
+
         query_params = {}
+        for key in params:
+            query_params[key] = params[key]
 
         if ids is not None:
             query_params["ids"] = ",".join(ids)
@@ -383,7 +393,18 @@ def get_activities(self, ids=None, foreign_id_times=None):
             query_params["foreign_ids"] = ",".join(foreign_ids)
             query_params["timestamps"] = ",".join(timestamps)
 
-        return self.get("activities/", auth_token, params=query_params)
+        if reactions is not None and not isinstance(reactions, (dict,)):
+            raise TypeError("reactions argument should be a dictionary")
+
+        if reactions is not None:
+            if reactions.get("own"):
+                query_params["withOwnReactions"] = True
+            if reactions.get("recent"):
+                query_params["withRecentReactions"] = True
+            if reactions.get("counts"):
+                query_params["withReactionCounts"] = True
+
+        return self.get(endpoint, auth_token, params=query_params)
 
     def activity_partial_update(
         self, id=None, foreign_id=None, time=None, set={}, unset=[]

stream/tests/test_client.py

@@ -1159,6 +1159,46 @@ def test_get_activities_full(self):
         self.assertEqual(len(response["results"]), 1)
         self.assertEqual(activity["foreign_id"], response["results"][0]["foreign_id"])
 
+    def test_get_activities_full_with_enrichment(self):
+        dt = datetime.datetime.utcnow()
+        fid = "awesome-test"
+
+        actor = self.c.users.add(str(uuid1()), data={"name": "barry"})
+        activity = {
+            "actor": self.c.users.create_reference(actor["id"]),
+            "object": "09",
+            "verb": "tweet",
+            "time": dt,
+            "foreign_id": fid,
+        }
+
+        feed = getfeed("user", "test_get_activity")
+        activity = feed.add_activity(activity)
+
+        reaction1 = self.c.reactions.add("like", activity["id"], "liker")
+        reaction2 = self.c.reactions.add("reshare", activity["id"], "sharer")
+
+        def validate(response):
+            self.assertEqual(len(response["results"]), 1)
+            self.assertEqual(response["results"][0]["id"], activity["id"])
+            self.assertEqual(
+                response["results"][0]["foreign_id"], activity["foreign_id"]
+            )
+            self.assertEqual(response["results"][0]["actor"]["data"]["name"], "barry")
+            latest_reactions = response["results"][0]["latest_reactions"]
+            self.assertEqual(len(latest_reactions), 2)
+            self.assertEqual(latest_reactions["like"][0]["id"], reaction1["id"])
+            self.assertEqual(latest_reactions["reshare"][0]["id"], reaction2["id"])
+            self.assertEqual(
+                response["results"][0]["reaction_counts"], {"like": 1, "reshare": 1}
+            )
+
+        reactions = {"recent": True, "counts": True}
+        validate(self.c.get_activities(ids=[activity["id"]], reactions=reactions))
+        validate(
+            self.c.get_activities(foreign_id_times=[(fid, dt)], reactions=reactions)
+        )
+
     def test_activity_partial_update(self):
         now = datetime.datetime.utcnow()
         feed = self.c.feed("user", uuid4())