Add kind filter support for enrichment (#123)

Author: ferhatelmas

stream/client.py

@@ -13,7 +13,12 @@
 from stream.reactions import Reactions
 from stream.serializer import _datetime_encoder
 from stream.users import Users
-from stream.utils import validate_feed_slug, validate_foreign_id_time, validate_user_id
+from stream.utils import (
+    validate_feed_slug,
+    validate_foreign_id_time,
+    validate_user_id,
+    get_reaction_params,
+)
 
 try:
     from urllib.parse import urlparse
@@ -389,16 +394,7 @@ def get_activities(
             query_params["foreign_ids"] = ",".join(foreign_ids)
             query_params["timestamps"] = ",".join(timestamps)
 
-        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
+        query_params.update(get_reaction_params(reactions))
 
         return self.get(endpoint, auth_token, params=query_params)
 

stream/feed.py

@@ -1,4 +1,9 @@
-from stream.utils import validate_feed_id, validate_feed_slug, validate_user_id
+from stream.utils import (
+    validate_feed_id,
+    validate_feed_slug,
+    validate_user_id,
+    get_reaction_params,
+)
 
 
 class Feed:
@@ -130,17 +135,7 @@ def get(self, enrich=False, reactions=None, **params):
         else:
             feed_url = self.feed_url
 
-        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"):
-                params["withOwnReactions"] = True
-            if reactions.get("recent"):
-                params["withRecentReactions"] = True
-            if reactions.get("counts"):
-                params["withReactionCounts"] = True
-
+        params.update(get_reaction_params(reactions))
         return self.client.get(feed_url, params=params, signature=token)
 
     def follow(

stream/tests/test_client.py

@@ -1198,6 +1198,56 @@ def validate(response):
             self.c.get_activities(foreign_id_times=[(fid, dt)], reactions=reactions)
         )
 
+    def test_get_activities_full_with_enrichment_and_reaction_kinds(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)
+
+        self.c.reactions.add("like", activity["id"], "liker")
+        self.c.reactions.add("reshare", activity["id"], "sharer")
+        self.c.reactions.add("comment", activity["id"], "commenter")
+
+        reactions = {"recent": True, "counts": True, "kinds": "like,comment"}
+        response = self.c.get_activities(ids=[activity["id"]], reactions=reactions)
+        self.assertEqual(len(response["results"]), 1)
+        self.assertEqual(response["results"][0]["id"], activity["id"])
+        self.assertEqual(
+            sorted(response["results"][0]["latest_reactions"].keys()),
+            ["comment", "like"],
+        )
+        self.assertEqual(
+            response["results"][0]["reaction_counts"], {"like": 1, "comment": 1}
+        )
+
+        reactions = {
+            "recent": True,
+            "counts": True,
+            "kinds": ["", "reshare   ", "comment\n"],
+        }
+        response = self.c.get_activities(
+            foreign_id_times=[(fid, dt)], reactions=reactions
+        )
+        self.assertEqual(len(response["results"]), 1)
+        self.assertEqual(response["results"][0]["id"], activity["id"])
+        self.assertEqual(
+            sorted(response["results"][0]["latest_reactions"].keys()),
+            ["comment", "reshare"],
+        )
+        self.assertEqual(
+            response["results"][0]["reaction_counts"], {"comment": 1, "reshare": 1}
+        )
+
     def test_activity_partial_update(self):
         now = datetime.datetime.utcnow()
         feed = self.c.feed("user", uuid4())

stream/utils.py

@@ -54,3 +54,23 @@ def validate_foreign_id_time(foreign_id_time):
 
         if len(v) != 2:
             raise ValueError("foreign_id_time elements should have two elements")
+
+
+def get_reaction_params(reactions):
+    if reactions is not None and not isinstance(reactions, (dict,)):
+        raise TypeError("reactions argument should be a dictionary")
+
+    params = {}
+    if reactions is not None:
+        if reactions.get("own"):
+            params["withOwnReactions"] = True
+        if reactions.get("recent"):
+            params["withRecentReactions"] = True
+        if reactions.get("counts"):
+            params["withReactionCounts"] = True
+        kinds = reactions.get("kinds")
+        if kinds:
+            if isinstance(kinds, list):
+                kinds = ",".join(k.strip() for k in kinds if k.strip())
+            params["reactionKindsFilter"] = kinds
+    return params