[CHAT-2479] added shadow_ban / remove_shadow_ban methods (#82)

Author: gumuz

stream_chat/async_chat/client.py

@@ -125,6 +125,12 @@ async def ban_user(self, target_id, **options):
         data = {"target_user_id": target_id, **options}
         return await self.post("moderation/ban", data=data)
 
+    async def shadow_ban(self, target_id, **options):
+        return await self.ban_user(target_id, shadow=True, **options)
+
+    async def remove_shadow_ban(self, target_id, **options):
+        return await self.unban_user(target_id, shadow=True, **options)
+
     async def unban_user(self, target_id, **options):
         params = {"target_user_id": target_id, **options}
         return await self.delete("moderation/ban", params)

stream_chat/base/client.py

@@ -124,6 +124,14 @@ def export_user(self, user_id, **options):
     def ban_user(self, target_id, **options):
         pass
 
+    @abc.abstractmethod
+    def shadow_ban(self, target_id, **options):
+        pass
+
+    @abc.abstractmethod
+    def remove_shadow_ban(self, target_id, **options):
+        pass
+
     @abc.abstractmethod
     def unban_user(self, target_id, **options):
         pass

stream_chat/client.py

@@ -121,6 +121,12 @@ def ban_user(self, target_id, **options):
         data = {"target_user_id": target_id, **options}
         return self.post("moderation/ban", data=data)
 
+    def shadow_ban(self, target_id, **options):
+        return self.ban_user(target_id, shadow=True, **options)
+
+    def remove_shadow_ban(self, target_id, **options):
+        return self.unban_user(target_id, shadow=True, **options)
+
     def unban_user(self, target_id, **options):
         params = {"target_user_id": target_id, **options}
         return self.delete("moderation/ban", params)

stream_chat/tests/async_chat/test_client.py

@@ -193,6 +193,40 @@ async def test_export_user(self, event_loop, client, fellowship_of_the_ring):
     async def test_ban_user(self, event_loop, client, random_user, server_user):
         await client.ban_user(random_user["id"], user_id=server_user["id"])
 
+    @pytest.mark.asyncio
+    async def test_shadow_ban(
+        self, event_loop, client, random_user, server_user, channel
+    ):
+        msg_id = str(uuid.uuid4())
+        response = await channel.send_message(
+            {"id": msg_id, "text": "hello world"}, random_user["id"]
+        )
+
+        response = await client.get_message(msg_id)
+        assert response["message"]["shadowed"] == False
+
+        response = await client.shadow_ban(random_user["id"], user_id=server_user["id"])
+
+        msg_id = str(uuid.uuid4())
+        response = await channel.send_message(
+            {"id": msg_id, "text": "hello world"}, random_user["id"]
+        )
+
+        response = await client.get_message(msg_id)
+        assert response["message"]["shadowed"] == True
+
+        response = await client.remove_shadow_ban(
+            random_user["id"], user_id=server_user["id"]
+        )
+
+        msg_id = str(uuid.uuid4())
+        response = await channel.send_message(
+            {"id": msg_id, "text": "hello world"}, random_user["id"]
+        )
+
+        response = await client.get_message(msg_id)
+        assert response["message"]["shadowed"] == False
+
     @pytest.mark.asyncio
     async def test_unban_user(self, event_loop, client, random_user, server_user):
         await client.ban_user(random_user["id"], user_id=server_user["id"])

stream_chat/tests/test_client.py

@@ -164,6 +164,37 @@ def test_export_user(self, client, fellowship_of_the_ring):
         assert "user" in response
         assert response["user"]["name"] == "Gandalf the Grey"
 
+    def test_shadow_ban(self, client, random_user, server_user, channel):
+        msg_id = str(uuid.uuid4())
+        response = channel.send_message(
+            {"id": msg_id, "text": "hello world"}, random_user["id"]
+        )
+
+        response = client.get_message(msg_id)
+        assert response["message"]["shadowed"] == False
+
+        response = client.shadow_ban(random_user["id"], user_id=server_user["id"])
+
+        msg_id = str(uuid.uuid4())
+        response = channel.send_message(
+            {"id": msg_id, "text": "hello world"}, random_user["id"]
+        )
+
+        response = client.get_message(msg_id)
+        assert response["message"]["shadowed"] == True
+
+        response = client.remove_shadow_ban(
+            random_user["id"], user_id=server_user["id"]
+        )
+
+        msg_id = str(uuid.uuid4())
+        response = channel.send_message(
+            {"id": msg_id, "text": "hello world"}, random_user["id"]
+        )
+
+        response = client.get_message(msg_id)
+        assert response["message"]["shadowed"] == False
+
     def test_ban_user(self, client, random_user, server_user):
         client.ban_user(random_user["id"], user_id=server_user["id"])