added client method for query_message_flags endpoint (#62)

Co-authored-by: ferhat elmas <[email protected]>

Author: gumuz

stream_chat/async_chat/client.py

@@ -130,6 +130,15 @@ async def unflag_message(self, target_id, **options):
         data = {"target_message_id": target_id, **options}
         return await self.post("moderation/unflag", data=data)
 
+    async def query_message_flags(self, filter_conditions, **options):
+        params = {
+            **options,
+            "filter_conditions": filter_conditions,
+        }
+        return await self.get(
+            "moderation/flags/message", params={"payload": json.dumps(params)}
+        )
+
     async def flag_user(self, target_id, **options):
         data = {"target_user_id": target_id, **options}
         return await self.post("moderation/flag", data=data)

stream_chat/base/client.py

@@ -115,6 +115,10 @@ def flag_message(self, target_id, **options):
     def unflag_message(self, target_id, **options):
         pass
 
+    @abc.abstractmethod
+    def query_message_flags(self, filter_conditions, **options):
+        pass
+
     @abc.abstractmethod
     def flag_user(self, target_id, **options):
         pass

stream_chat/client.py

@@ -125,6 +125,15 @@ def unflag_message(self, target_id, **options):
         data = {"target_message_id": target_id, **options}
         return self.post("moderation/unflag", data=data)
 
+    def query_message_flags(self, filter_conditions, **options):
+        params = {
+            **options,
+            "filter_conditions": filter_conditions,
+        }
+        return self.get(
+            "moderation/flags/message", params={"payload": json.dumps(params)}
+        )
+
     def flag_user(self, target_id, **options):
         data = {"target_user_id": target_id, **options}
         return self.post("moderation/flag", data=data)

stream_chat/tests/async_chat/test_client.py

@@ -233,6 +233,22 @@ async def test_flag_message(
         )
         await client.flag_message(msg_id, user_id=server_user["id"])
 
+    @pytest.mark.asyncio
+    async def test_query_message_flags(
+        self, event_loop, client, channel, random_user, server_user
+    ):
+        msg_id = str(uuid.uuid4())
+        await channel.send_message(
+            {"id": msg_id, "text": "helloworld"}, random_user["id"]
+        )
+        await client.flag_message(msg_id, user_id=server_user["id"])
+        response = await client.query_message_flags({"channel_cid": channel.cid})
+        assert len(response["flags"]) == 1
+        response = await client.query_message_flags(
+            {"user_id": {"$in": [random_user["id"]]}}
+        )
+        assert len(response["flags"]) == 1
+
     @pytest.mark.asyncio
     async def test_unflag_message(
         self, event_loop, client, channel, random_user, server_user

stream_chat/tests/test_client.py

@@ -193,6 +193,15 @@ def test_flag_message(self, client, channel, random_user, server_user):
         channel.send_message({"id": msg_id, "text": "helloworld"}, random_user["id"])
         client.flag_message(msg_id, user_id=server_user["id"])
 
+    def test_query_message_flags(self, client, channel, random_user, server_user):
+        msg_id = str(uuid.uuid4())
+        channel.send_message({"id": msg_id, "text": "helloworld"}, random_user["id"])
+        client.flag_message(msg_id, user_id=server_user["id"])
+        response = client.query_message_flags({"channel_cid": channel.cid})
+        assert len(response["flags"]) == 1
+        response = client.query_message_flags({"user_id": {"$in": [random_user["id"]]}})
+        assert len(response["flags"]) == 1
+
     def test_unflag_message(self, client, channel, random_user, server_user):
         msg_id = str(uuid.uuid4())
         channel.send_message({"id": msg_id, "text": "helloworld"}, random_user["id"])