Add follow stats (#124)

Add endpoint support to get follow stats of a feed

Author: ferhatelmas

stream/client.py

@@ -489,3 +489,34 @@ def og(self, target_url):
         auth_token = self.create_jwt_token("*", "*", feed_id="*")
         params = {"url": target_url}
         return self.get("og/", auth_token, params=params)
+
+    def follow_stats(self, feed_id, followers_slugs=None, following_slugs=None):
+        """
+        Retrieve the number of follower and following feed stats of a given feed.
+        For each count, feed slugs can be provided to filter counts accordingly.
+
+        eg.
+        client.follow_stats(me, followers_slugs=['user'], following_slugs=['commodities'])
+        this means to find counts of users following me and count of commodities I am following
+        """
+        auth_token = self.create_jwt_token("*", "*", feed_id="*")
+        params = {
+            "followers": feed_id,
+            "following": feed_id,
+        }
+
+        if followers_slugs:
+            params["followers_slugs"] = (
+                ",".join(followers_slugs)
+                if isinstance(followers_slugs, list)
+                else followers_slugs
+            )
+
+        if following_slugs:
+            params["following_slugs"] = (
+                ",".join(following_slugs)
+                if isinstance(following_slugs, list)
+                else following_slugs
+            )
+
+        return self.get("stats/follow/", auth_token, params=params)

stream/tests/test_client.py

@@ -1620,3 +1620,24 @@ def test_og(self):
         response = client.og("https://google.com")
         self.assertTrue("title" in response)
         self.assertTrue("description" in response)
+
+    def test_follow_stats(self):
+        uniq = uuid4()
+        f = client.feed("user", uniq)
+        f.follow("user", uuid4())
+        f.follow("user", uuid4())
+        f.follow("user", uuid4())
+
+        client.feed("user", uuid4()).follow("user", uniq)
+        client.feed("timeline", uuid4()).follow("user", uniq)
+
+        feed_id = "user:" + str(uniq)
+        response = client.follow_stats(feed_id)["results"]
+        self.assertEqual(response["following"]["count"], 3)
+        self.assertEqual(response["followers"]["count"], 2)
+
+        response = client.follow_stats(
+            feed_id, followers_slugs=["timeline"], following_slugs=["timeline"]
+        )["results"]
+        self.assertEqual(response["following"]["count"], 0)
+        self.assertEqual(response["followers"]["count"], 1)