feat: add multi user mute/unmute (#140)

Co-authored-by: Nathan <[email protected]>

Author: totalimmersion

stream_chat/async_chat/client.py

@@ -256,6 +256,12 @@ async def _review_flag_report(
         }
         return await self.patch(f"moderation/reports/{report_id}", data=data)
 
+    async def mute_users(
+        self, target_ids: List[str], user_id: str, **options: Any
+    ) -> StreamResponse:
+        data = {"target_ids": target_ids, "user_id": user_id, **options}
+        return await self.post("moderation/mute", data=data)
+
     async def mute_user(
         self, target_id: str, user_id: str, **options: Any
     ) -> StreamResponse:
@@ -266,6 +272,10 @@ async def unmute_user(self, target_id: str, user_id: str) -> StreamResponse:
         data = {"target_id": target_id, "user_id": user_id}
         return await self.post("moderation/unmute", data=data)
 
+    async def unmute_users(self, target_ids: List[str], user_id: str) -> StreamResponse:
+        data = {"target_ids": target_ids, "user_id": user_id}
+        return await self.post("moderation/unmute", data=data)
+
     async def mark_all_read(self, user_id: str) -> StreamResponse:
         return await self.post("channels/read", data={"user": {"id": user_id}})
 

stream_chat/base/client.py

@@ -384,6 +384,12 @@ def unflag_user(
         """
         pass
 
+    @abc.abstractmethod
+    def mute_users(
+        self, target_ids: List[str], user_id: str, **options: Any
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        pass
+
     @abc.abstractmethod
     def mute_user(
         self, target_id: str, user_id: str, **options: Any
@@ -409,7 +415,12 @@ def unmute_user(
         :param user_id: the user muting the target
         :return:
         """
+        pass
 
+    @abc.abstractmethod
+    def unmute_users(
+        self, target_ids: List[str], user_id: str
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
         pass
 
     @abc.abstractmethod

stream_chat/channel.py

@@ -88,7 +88,10 @@ def truncate(self, **options: Any) -> StreamResponse:
         return self.client.post(f"{self.url}/truncate", data=options)
 
     def add_members(
-        self, members: Iterable[Dict], message: Dict = None, **options: Any
+        self,
+        members: Union[Iterable[Dict], Iterable[str]],
+        message: Dict = None,
+        **options: Any,
     ) -> StreamResponse:
         payload = {"add_members": members, "message": message, **options}
         return self.client.post(self.url, data=payload)

stream_chat/client.py

@@ -250,10 +250,20 @@ def mute_user(self, target_id: str, user_id: str, **options: Any) -> StreamRespo
         data = {"target_id": target_id, "user_id": user_id, **options}
         return self.post("moderation/mute", data=data)
 
+    def mute_users(
+        self, target_ids: List[str], user_id: str, **options: Any
+    ) -> StreamResponse:
+        data = {"target_ids": target_ids, "user_id": user_id, **options}
+        return self.post("moderation/mute", data=data)
+
     def unmute_user(self, target_id: str, user_id: str) -> StreamResponse:
         data = {"target_id": target_id, "user_id": user_id}
         return self.post("moderation/unmute", data=data)
 
+    def unmute_users(self, target_ids: List[str], user_id: str) -> StreamResponse:
+        data = {"target_ids": target_ids, "user_id": user_id}
+        return self.post("moderation/unmute", data=data)
+
     def mark_all_read(self, user_id: str) -> StreamResponse:
         return self.post("channels/read", data={"user": {"id": user_id}})
 

stream_chat/tests/async_chat/conftest.py

@@ -70,9 +70,10 @@ async def server_user(client: StreamChatAsync):
 async def random_users(client: StreamChatAsync):
     user1 = {"id": str(uuid.uuid4())}
     user2 = {"id": str(uuid.uuid4())}
-    await client.upsert_users([user1, user2])
-    yield [user1, user2]
-    await hard_delete_users(client, [user1["id"], user2["id"]])
+    user3 = {"id": str(uuid.uuid4())}
+    await client.upsert_users([user1, user2, user3])
+    yield [user1, user2, user3]
+    await hard_delete_users(client, [user1["id"], user2["id"], user3["id"]])
 
 
 @pytest.fixture(scope="function")

stream_chat/tests/async_chat/test_client.py

@@ -48,6 +48,22 @@ async def test_mute_user(self, client: StreamChatAsync, random_users: List[Dict]
         assert response["mute"]["user"]["id"] == random_users[1]["id"]
         await client.unmute_user(random_users[0]["id"], random_users[1]["id"])
 
+    async def test_mute_users(self, client: StreamChatAsync, random_users: List[Dict]):
+        user_ids = [random_user["id"] for random_user in random_users]
+        user_id = user_ids[0]
+        target_user_ids = user_ids[1:]
+        response = await client.mute_users(target_user_ids, user_id)
+        assert "mutes" in response
+        assert "expires" not in response["mutes"]
+        assert all(
+            [
+                mute["user"]["id"] == user_id
+                and mute["target"]["id"] in target_user_ids
+                for mute in response["mutes"]
+            ]
+        )
+        await client.unmute_users(target_user_ids, user_id)
+
     async def test_mute_user_with_timeout(
         self, client: StreamChatAsync, random_users: List[Dict]
     ):

stream_chat/tests/conftest.py

@@ -61,9 +61,10 @@ def server_user(client: StreamChat):
 def random_users(client: StreamChat):
     user1 = {"id": str(uuid.uuid4())}
     user2 = {"id": str(uuid.uuid4())}
-    client.update_users([user1, user2])
-    yield [user1, user2]
-    hard_delete_users(client, [user1["id"], user2["id"]])
+    user3 = {"id": str(uuid.uuid4())}
+    client.update_users([user1, user2, user3])
+    yield [user1, user2, user3]
+    hard_delete_users(client, [user1["id"], user2["id"], user3["id"]])
 
 
 @pytest.fixture(scope="function")

stream_chat/tests/test_client.py

@@ -48,6 +48,22 @@ def test_mute_user(self, client: StreamChat, random_users: List[Dict]):
         assert response["mute"]["user"]["id"] == random_users[1]["id"]
         client.unmute_user(random_users[0]["id"], random_users[1]["id"])
 
+    def test_mute_users(self, client: StreamChat, random_users: List[Dict]):
+        user_ids = [random_user["id"] for random_user in random_users]
+        user_id = user_ids[0]
+        target_user_ids = user_ids[1:]
+        response = client.mute_users(target_user_ids, user_id)
+        assert "mutes" in response
+        assert "expires" not in response["mutes"]
+        assert all(
+            [
+                mute["user"]["id"] == user_id
+                and mute["target"]["id"] in target_user_ids
+                for mute in response["mutes"]
+            ]
+        )
+        client.unmute_users(target_user_ids, user_id)
+
     def test_mute_user_with_timeout(self, client: StreamChat, random_users: List[Dict]):
         response = client.mute_user(
             random_users[0]["id"], random_users[1]["id"], timeout=10