[CHAT-2590] added pin_message, unpin_message & update_message_partial (#84)

* added pin_message, unpin_message & update_message_partial

* linting fix

* Update stream_chat/async_chat/client.py

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

Author: gumuz

stream_chat/async_chat/client.py

@@ -187,11 +187,35 @@ async def unmute_user(self, target_id, user_id):
     async def mark_all_read(self, user_id):
         return await self.post("channels/read", data={"user": {"id": user_id}})
 
+    async def pin_message(self, message_id, user_id, expiration=None):
+        updates = {
+            "set": {
+                "pinned": True,
+                "pin_expires": expiration,
+            }
+        }
+        return await self.update_message_partial(message_id, updates, user_id)
+
+    async def unpin_message(self, message_id, user_id):
+        updates = {
+            "set": {
+                "pinned": False,
+            }
+        }
+        return await self.update_message_partial(message_id, updates, user_id)
+
     async def update_message(self, message):
         if message.get("id") is None:
             raise ValueError("message must have an id")
         return await self.post(f"messages/{message['id']}", data={"message": message})
 
+    async def update_message_partial(self, message_id, updates, user_id, **options):
+        data = updates.copy()
+        if user_id:
+            data["user"] = {"id": user_id}
+        data.update(options)
+        return await self.put(f"messages/{message_id}", data=data)
+
     async def delete_message(self, message_id, **options):
         return await self.delete(f"messages/{message_id}", options)
 

stream_chat/base/client.py

@@ -184,10 +184,22 @@ def unmute_user(self, target_id, user_id):
     def mark_all_read(self, user_id):
         pass
 
+    @abc.abstractmethod
+    def pin_message(self, message_id, user_id, expiration=None):
+        pass
+
+    @abc.abstractmethod
+    def unpin_message(self, message_id, user_id):
+        pass
+
     @abc.abstractmethod
     def update_message(self, message):
         pass
 
+    @abc.abstractmethod
+    def update_message_partial(self, message_id, updates, user_id, **options):
+        pass
+
     @abc.abstractmethod
     def delete_message(self, message_id, **options):
         pass

stream_chat/client.py

@@ -183,11 +183,35 @@ def unmute_user(self, target_id, user_id):
     def mark_all_read(self, user_id):
         return self.post("channels/read", data={"user": {"id": user_id}})
 
+    def pin_message(self, message_id, user_id, expiration=None):
+        updates = {
+            "set": {
+                "pinned": True,
+                "pin_expires": expiration,
+            }
+        }
+        return self.update_message_partial(message_id, updates, user_id)
+
+    def unpin_message(self, message_id, user_id):
+        updates = {
+            "set": {
+                "pinned": False,
+            }
+        }
+        return self.update_message_partial(message_id, updates, user_id)
+
     def update_message(self, message):
         if message.get("id") is None:
             raise ValueError("message must have an id")
         return self.post(f"messages/{message['id']}", data={"message": message})
 
+    def update_message_partial(self, message_id, updates, user_id, **options):
+        data = updates.copy()
+        if user_id:
+            data["user"] = {"id": user_id}
+        data.update(options)
+        return self.put(f"messages/{message_id}", data=data)
+
     def delete_message(self, message_id, **options):
         return self.delete(f"messages/{message_id}", options)
 

stream_chat/tests/async_chat/test_client.py

@@ -245,6 +245,21 @@ async def test_unflag_user(self, event_loop, client, random_user, server_user):
     async def test_mark_all_read(self, event_loop, client, random_user):
         await client.mark_all_read(random_user["id"])
 
+    @pytest.mark.asyncio
+    async def test_pin_unpin_message(self, event_loop, client, channel, random_user):
+        msg_id = str(uuid.uuid4())
+        response = await channel.send_message(
+            {"id": msg_id, "text": "hello world"}, random_user["id"]
+        )
+        assert response["message"]["text"] == "hello world"
+        response = await client.pin_message(msg_id, random_user["id"])
+        assert response["message"]["pinned_at"] is not None
+        assert response["message"]["pinned_by"]["id"] == random_user["id"]
+
+        response = await client.unpin_message(msg_id, random_user["id"])
+        assert response["message"]["pinned_at"] is None
+        assert response["message"]["pinned_by"] is None
+
     @pytest.mark.asyncio
     async def test_update_message(self, event_loop, client, channel, random_user):
         msg_id = str(uuid.uuid4())
@@ -261,6 +276,23 @@ async def test_update_message(self, event_loop, client, channel, random_user):
             }
         )
 
+    @pytest.mark.asyncio
+    async def test_update_message_partial(
+        self, event_loop, client, channel, random_user
+    ):
+        msg_id = str(uuid.uuid4())
+        response = await channel.send_message(
+            {"id": msg_id, "text": "hello world"}, random_user["id"]
+        )
+        assert response["message"]["text"] == "hello world"
+        response = await client.update_message_partial(
+            msg_id,
+            dict(set=dict(awesome=True, text="helloworld")),
+            random_user["id"],
+        )
+        assert response["message"]["text"] == "helloworld"
+        assert response["message"]["awesome"] is True
+
     @pytest.mark.asyncio
     async def test_delete_message(self, event_loop, client, channel, random_user):
         msg_id = str(uuid.uuid4())

stream_chat/tests/test_client.py

@@ -212,6 +212,20 @@ def test_unflag_user(self, client, random_user, server_user):
     def test_mark_all_read(self, client, random_user):
         client.mark_all_read(random_user["id"])
 
+    def test_pin_unpin_message(self, client, channel, random_user):
+        msg_id = str(uuid.uuid4())
+        response = channel.send_message(
+            {"id": msg_id, "text": "hello world"}, random_user["id"]
+        )
+        assert response["message"]["text"] == "hello world"
+        response = client.pin_message(msg_id, random_user["id"])
+        assert response["message"]["pinned_at"] is not None
+        assert response["message"]["pinned_by"]["id"] == random_user["id"]
+
+        response = client.unpin_message(msg_id, random_user["id"])
+        assert response["message"]["pinned_at"] is None
+        assert response["message"]["pinned_by"] is None
+
     def test_update_message(self, client, channel, random_user):
         msg_id = str(uuid.uuid4())
         response = channel.send_message(
@@ -227,6 +241,20 @@ def test_update_message(self, client, channel, random_user):
             }
         )
 
+    def test_update_message_partial(self, client, channel, random_user):
+        msg_id = str(uuid.uuid4())
+        response = channel.send_message(
+            {"id": msg_id, "text": "hello world"}, random_user["id"]
+        )
+        assert response["message"]["text"] == "hello world"
+        response = client.update_message_partial(
+            msg_id,
+            dict(set=dict(awesome=True, text="helloworld")),
+            random_user["id"],
+        )
+        assert response["message"]["text"] == "helloworld"
+        assert response["message"]["awesome"] is True
+
     def test_delete_message(self, client, channel, random_user):
         msg_id = str(uuid.uuid4())
         channel.send_message({"id": msg_id, "text": "helloworld"}, random_user["id"])