Add channel update partial (#52)

Author: ferhatelmas

stream_chat/async_chat/channel.py

@@ -121,6 +121,16 @@ async def update(self, channel_data, update_message=None):
         payload = {"data": channel_data, "message": update_message}
         return await self.client.post(self.url, data=payload)
 
+    async def update_partial(self, to_set=None, to_unset=None):
+        """
+        Update channel partially
+
+        :param to_set: a dictionary of key/value pairs to set or to override
+        :param to_unset: a list of keys to clear
+        """
+        payload = {"set": to_set or {}, "unset": to_unset or []}
+        return await self.client.patch(self.url, data=payload)
+
     async def delete(self):
         """
         Delete the channel. Messages are permanently removed.

stream_chat/base/channel.py

@@ -113,6 +113,16 @@ def update(self, channel_data, update_message=None):
         """
         pass
 
+    @abc.abstractmethod
+    def update_partial(self, to_set=None, to_unset=None):
+        """
+        Update channel partially
+
+        :param to_set: a dictionary of key/value pairs to set or to override
+        :param to_unset: a list of keys to clear
+        """
+        pass
+
     @abc.abstractmethod
     def delete(self):
         """

stream_chat/channel.py

@@ -119,6 +119,16 @@ def update(self, channel_data, update_message=None):
         payload = {"data": channel_data, "message": update_message}
         return self.client.post(self.url, data=payload)
 
+    def update_partial(self, to_set=None, to_unset=None):
+        """
+        Update channel partially
+
+        :param to_set: a dictionary of key/value pairs to set or to override
+        :param to_unset: a list of keys to clear
+        """
+        payload = {"set": to_set or {}, "unset": to_unset or []}
+        return self.client.patch(self.url, data=payload)
+
     def delete(self):
         """
         Delete the channel. Messages are permanently removed.

stream_chat/tests/async_chat/test_channel.py

@@ -62,6 +62,20 @@ async def test_update(self, event_loop, channel):
         assert "channel" in response
         assert response["channel"]["motd"] == "one apple a day..."
 
+    @pytest.mark.asyncio
+    async def test_update_partial(self, event_loop, channel):
+        response = await channel.update({"color": "blue", "age": 30})
+        assert "channel" in response
+        assert response["channel"]["color"] == "blue"
+        assert response["channel"]["age"] == 30
+
+        response = await channel.update_partial(
+            to_set={"color": "red"}, to_unset=["age"]
+        )
+        assert "channel" in response
+        assert response["channel"]["color"] == "red"
+        assert "age" not in response["channel"]
+
     @pytest.mark.asyncio
     async def test_delete(self, event_loop, channel):
         response = await channel.delete()

stream_chat/tests/test_channel.py

@@ -54,6 +54,17 @@ def test_update(self, channel):
         assert "channel" in response
         assert response["channel"]["motd"] == "one apple a day..."
 
+    def test_update_partial(self, channel):
+        response = channel.update({"color": "blue", "age": 30})
+        assert "channel" in response
+        assert response["channel"]["color"] == "blue"
+        assert response["channel"]["age"] == 30
+
+        response = channel.update_partial(to_set={"color": "red"}, to_unset=["age"])
+        assert "channel" in response
+        assert response["channel"]["color"] == "red"
+        assert "age" not in response["channel"]
+
     def test_delete(self, channel):
         response = channel.delete()
         assert "channel" in response