Add channel mute/unmute (#54)

Author: ferhatelmas

.gitignore

@@ -62,3 +62,4 @@ pip-selfcheck.json
 .vscode
 *,cover
 .eggs
+.envrc

stream_chat/async_chat/channel.py

@@ -281,3 +281,34 @@ async def hide(self, user_id):
 
     async def show(self, user_id):
         return await self.client.post(f"{self.url}/show", data={"user_id": user_id})
+
+    async def mute(self, user_id, expiration=None):
+        """
+        Mutes the channel for the given user for an optional expiration in milliseconds
+
+        :param user_id: the id of the user muting the channel
+        :param expiration: optional expiration in ms. If not given, mute doesn't expire until unmutes
+        :return: The server response
+        """
+
+        params = {
+            "user_id": user_id,
+            "channel_cid": self.cid,
+        }
+        if expiration:
+            params["expiration"] = expiration
+        return await self.client.post("moderation/mute/channel", data=params)
+
+    async def unmute(self, user_id):
+        """
+        Unmutes the channel for the given user
+
+        :param user_id: the id of the user unmuting the channel
+        :return: The server response
+        """
+
+        params = {
+            "user_id": user_id,
+            "channel_cid": self.cid,
+        }
+        return await self.client.post("moderation/unmute/channel", data=params)

stream_chat/base/channel.py

@@ -18,6 +18,12 @@ def url(self):
             raise StreamChannelException("channel does not have an id")
         return f"channels/{self.channel_type}/{self.id}"
 
+    @property
+    def cid(self):
+        if self.id is None:
+            raise StreamChannelException("channel does not have an id")
+        return f"{self.channel_type}:{self.id}"
+
     @abc.abstractmethod
     def send_message(self, message, user_id, **options):
         """
@@ -277,6 +283,14 @@ def hide(self, user_id):
     def show(self, user_id):
         pass
 
+    @abc.abstractmethod
+    def mute(self, user_id, expiration=None):
+        pass
+
+    @abc.abstractmethod
+    def unmute(self, user_id):
+        pass
+
 
 def add_user_id(payload, user_id):
     return {**payload, "user": {"id": user_id}}

stream_chat/channel.py

@@ -279,3 +279,34 @@ def hide(self, user_id):
 
     def show(self, user_id):
         return self.client.post(f"{self.url}/show", data={"user_id": user_id})
+
+    def mute(self, user_id, expiration=None):
+        """
+        Mutes the channel for the given user for an optional expiration in milliseconds
+
+        :param user_id: the id of the user muting the channel
+        :param expiration: optional expiration in ms. If not given, mute doesn't expire until unmutes
+        :return: The server response
+        """
+
+        params = {
+            "user_id": user_id,
+            "channel_cid": self.cid,
+        }
+        if expiration:
+            params["expiration"] = expiration
+        return self.client.post("moderation/mute/channel", data=params)
+
+    def unmute(self, user_id):
+        """
+        Unmutes the channel for the given user
+
+        :param user_id: the id of the user unmuting the channel
+        :return: The server response
+        """
+
+        params = {
+            "user_id": user_id,
+            "channel_cid": self.cid,
+        }
+        return self.client.post("moderation/unmute/channel", data=params)

stream_chat/tests/async_chat/test_channel.py

@@ -288,3 +288,24 @@ async def test_query_members(self, event_loop, client, channel):
         assert len(response) == 2
         assert response[0]["user"]["id"] == "jessica"
         assert response[1]["user"]["id"] == "john2"
+
+    @pytest.mark.asyncio
+    async def test_mute_umute(self, event_loop, client, channel, random_users):
+        user_id = random_users[0]["id"]
+        response = await channel.mute(user_id, expiration=30000)
+        assert "channel_mute" in response
+        assert response["channel_mute"]["channel"]["cid"] == channel.cid
+        assert response["channel_mute"]["user"]["id"] == user_id
+
+        response = await client.query_channels(
+            {"muted": True, "cid": channel.cid},
+            user_id=user_id,
+        )
+        assert len(response["channels"]) == 1
+
+        await channel.unmute(user_id)
+        response = await client.query_channels(
+            {"muted": True, "cid": channel.cid},
+            user_id=user_id,
+        )
+        assert len(response["channels"]) == 0

stream_chat/tests/test_channel.py

@@ -258,3 +258,24 @@ def test_query_members(self, client, channel):
         assert len(response) == 2
         assert response[0]["user"]["id"] == "jessica"
         assert response[1]["user"]["id"] == "john2"
+
+    def test_mute_unmute(self, client, channel, random_users):
+        user_id = random_users[0]["id"]
+        response = channel.mute(user_id, expiration=30000)
+        assert "channel_mute" in response
+        assert "expires" in response["channel_mute"]
+        assert response["channel_mute"]["channel"]["cid"] == channel.cid
+        assert response["channel_mute"]["user"]["id"] == user_id
+
+        response = client.query_channels(
+            {"muted": True, "cid": channel.cid}, user_id=user_id
+        )
+        print(response, channel.cid)
+        assert len(response["channels"]) == 1
+
+        channel.unmute(user_id)
+        response = client.query_channels(
+            {"muted": True, "cid": channel.cid},
+            user_id=user_id,
+        )
+        assert len(response["channels"]) == 0