support GetRateLimits (#57)

Author: ruggi

stream_chat/async_chat/client.py

@@ -272,6 +272,33 @@ async def get_devices(self, user_id):
         """
         return await self.get("devices", {"user_id": user_id})
 
+    async def get_rate_limits(
+        self, server_side=False, android=False, ios=False, web=False, endpoints=None
+    ):
+        """
+        Get rate limit quotas and usage.
+        If no params are toggled, all limits for all endpoints are returned.
+
+        :param server_side: if true, show server_side limits.
+        :param android: if true, show android limits.
+        :param ios: if true, show ios limits.
+        :param web: if true, show web limits.
+        :param endpoints: restrict returned limits to the given list of endpoints.
+        """
+        params = {}
+        if server_side:
+            params["server_side"] = "true"
+        if android:
+            params["android"] = "true"
+        if ios:
+            params["ios"] = "true"
+        if web:
+            params["web"] = "true"
+        if endpoints is not None and len(endpoints) > 0:
+            params["endpoints"] = ",".join(endpoints)
+
+        return await self.get("rate_limits", params)
+
     async def search(self, filter_conditions, query, **options):
         params = {**options, "filter_conditions": filter_conditions, "query": query}
         return await self.get("search", params={"payload": json.dumps(params)})

stream_chat/base/client.py

@@ -260,6 +260,20 @@ def get_devices(self, user_id):
         """
         pass
 
+    @abc.abstractmethod
+    def get_rate_limits(self, server_side, android, ios, web, endpoints):
+        """
+        Get rate limit quotas and usage.
+        If no params are toggled, all limits for all endpoints are returned.
+
+        :param server_side: if true, show server_side limits.
+        :param android: if true, show android limits.
+        :param ios: if true, show ios limits.
+        :param web: if true, show web limits.
+        :param endpoints: restrict returned limits to the given list of endpoints.
+        """
+        pass
+
     @abc.abstractmethod
     def search(self, filter_conditions, query, **options):
         pass

stream_chat/client.py

@@ -267,6 +267,33 @@ def get_devices(self, user_id):
         """
         return self.get("devices", {"user_id": user_id})
 
+    def get_rate_limits(
+        self, server_side=False, android=False, ios=False, web=False, endpoints=None
+    ):
+        """
+        Get rate limit quotas and usage.
+        If no params are toggled, all limits for all endpoints are returned.
+
+        :param server_side: if true, show server_side limits.
+        :param android: if true, show android limits.
+        :param ios: if true, show ios limits.
+        :param web: if true, show web limits.
+        :param endpoints: restrict returned limits to the given list of endpoints.
+        """
+        params = {}
+        if server_side:
+            params["server_side"] = "true"
+        if android:
+            params["android"] = "true"
+        if ios:
+            params["ios"] = "true"
+        if web:
+            params["web"] = "true"
+        if endpoints is not None and len(endpoints) > 0:
+            params["endpoints"] = ",".join(endpoints)
+
+        return self.get("rate_limits", params)
+
     def search(self, filter_conditions, query, **options):
         params = {**options, "filter_conditions": filter_conditions, "query": query}
         return self.get("search", params={"payload": json.dumps(params)})

stream_chat/tests/async_chat/test_client.py

@@ -265,6 +265,38 @@ async def test_devices(self, event_loop, client, random_user):
         response = await client.get_devices(random_user["id"])
         assert len(response["devices"]) == 1
 
+    @pytest.mark.asyncio
+    async def test_get_rate_limits(self, event_loop, client):
+        response = await client.get_rate_limits()
+        assert "server_side" in response
+        assert "android" in response
+        assert "ios" in response
+        assert "web" in response
+
+        response = await client.get_rate_limits(server_side=True, android=True)
+        assert "server_side" in response
+        assert "android" in response
+        assert "ios" not in response
+        assert "web" not in response
+
+        response = await client.get_rate_limits(
+            server_side=True, android=True, endpoints=["GetRateLimits", "SendMessage"]
+        )
+        assert "server_side" in response
+        assert "android" in response
+        assert "ios" not in response
+        assert "web" not in response
+        assert len(response["android"]) == 2
+        assert len(response["server_side"]) == 2
+        assert (
+            response["android"]["GetRateLimits"]["limit"]
+            == response["android"]["GetRateLimits"]["remaining"]
+        )
+        assert (
+            response["server_side"]["GetRateLimits"]["limit"]
+            > response["server_side"]["GetRateLimits"]["remaining"]
+        )
+
     @pytest.mark.asyncio
     async def test_search(self, event_loop, client, channel, random_user):
         query = "supercalifragilisticexpialidocious"

stream_chat/tests/test_client.py

@@ -217,6 +217,37 @@ def test_devices(self, client, random_user):
         response = client.get_devices(random_user["id"])
         assert len(response["devices"]) == 1
 
+    def test_get_rate_limits(self, client):
+        response = client.get_rate_limits()
+        assert "server_side" in response
+        assert "android" in response
+        assert "ios" in response
+        assert "web" in response
+
+        response = client.get_rate_limits(server_side=True, android=True)
+        assert "server_side" in response
+        assert "android" in response
+        assert "ios" not in response
+        assert "web" not in response
+
+        response = client.get_rate_limits(
+            server_side=True, android=True, endpoints=["GetRateLimits", "SendMessage"]
+        )
+        assert "server_side" in response
+        assert "android" in response
+        assert "ios" not in response
+        assert "web" not in response
+        assert len(response["android"]) == 2
+        assert len(response["server_side"]) == 2
+        assert (
+            response["android"]["GetRateLimits"]["limit"]
+            == response["android"]["GetRateLimits"]["remaining"]
+        )
+        assert (
+            response["server_side"]["GetRateLimits"]["limit"]
+            > response["server_side"]["GetRateLimits"]["remaining"]
+        )
+
     def test_search(self, client, channel, random_user):
         query = "supercalifragilisticexpialidocious"
         channel.send_message(