Add flag and unflag methods (#2)

* Bump version. Add flag and unflag methods

* Add flag/unflag tests for messages and users

* Use new user_id parameter in tests

Author: Nekuromento

stream_chat/__pkg__.py

@@ -1,7 +1,6 @@
 __author__ = "Tommaso Barbugli"
 __copyright__ = "Copyright 2019, Stream.io, Inc"
-__version__ = "0.4.0"
+__version__ = "0.4.1"
 __maintainer__ = "Tommaso Barbugli"
 __email__ = "[email protected]"
 __status__ = "Production"
-

stream_chat/channel.py

@@ -189,7 +189,7 @@ def get_reactions(self, message_id, **options):
         """
         return self.client.get("messages/{}/reactions".format(message_id), params=options)
 
-    def ban_user(self, user_id, **options):
+    def ban_user(self, target_id, **options):
         """
         Bans a user from this channel
 
@@ -198,17 +198,19 @@ def ban_user(self, user_id, **options):
         :return: The server response
         """
         return self.client.ban_user(
-            user_id, type=self.channel_type, id=self.id, **options
+            target_id, type=self.channel_type, id=self.id, **options
         )
 
-    def unban_user(self, user_id):
+    def unban_user(self, target_id, **options):
         """
         Removes the ban for a user on this channel
 
         :param user_id: the ID of the user to unban
         :return: The server response
         """
-        return self.client.unban_user(user_id, type=self.channel_type, id=self.id)
+        return self.client.unban_user(
+            target_id, type=self.channel_type, id=self.id, **options
+        )
 
     def accept_invite(self, user_id):
         raise NotImplementedError

stream_chat/client.py

@@ -124,6 +124,26 @@ def unban_user(self, target_id, **options):
         params.update(options)
         return self.delete("moderation/ban", params)
 
+    def flag_message(self, target_id, **options):
+        data = dict(target_message_id=target_id)
+        data.update(options)
+        return self.post("moderation/flag", data=data)
+
+    def unflag_message(self, target_id, **options):
+        data = dict(target_message_id=target_id)
+        data.update(options)
+        return self.post("moderation/unflag", data=data)
+
+    def flag_user(self, target_id, **options):
+        data = dict(target_user_id=target_id)
+        data.update(options)
+        return self.post("moderation/flag", data=data)
+
+    def unflag_user(self, target_id, **options):
+        data = dict(target_user_id=target_id)
+        data.update(options)
+        return self.post("moderation/unflag", data=data)
+
     def mute_user(self, target_id, user_id):
         """
         Create a mute

stream_chat/tests/conftest.py

@@ -37,6 +37,15 @@ def random_user(client):
     return user
 
 
+@pytest.fixture(scope="function")
+def server_user(client):
+    user = {"id": str(uuid.uuid4())}
+    response = client.update_user(user)
+    assert "users" in response
+    assert user["id"] in response["users"]
+    return user
+
+
 @pytest.fixture(scope="function")
 def random_users(client):
     user1 = {"id": str(uuid.uuid4())}

stream_chat/tests/test_channel.py

@@ -3,12 +3,13 @@
 
 @pytest.mark.incremental
 class TestChannel(object):
-    def test_ban_user(self, channel, random_user):
-        channel.ban_user(random_user["id"])
+    def test_ban_user(self, channel, random_user, server_user):
+        channel.ban_user(random_user["id"], user_id=server_user["id"])
         channel.ban_user(
             random_user["id"],
             timeout=3600,
             reason="offensive language is not allowed here",
+            user_id=server_user["id"],
         )
         channel.unban_user(random_user["id"])
 

stream_chat/tests/test_client.py

@@ -63,12 +63,19 @@ def test_export_user(self, client, fellowship_of_the_ring):
         assert "user" in response
         assert response["user"]["name"] == "Gandalf the Grey"
 
-    def test_ban_user(self, client, random_user):
-        client.ban_user(random_user["id"])
+    def test_ban_user(self, client, random_user, server_user):
+        client.ban_user(random_user["id"], user_id=server_user["id"])
 
-    def test_unban_user(self, client, random_user):
-        client.ban_user(random_user["id"])
-        client.unban_user(random_user["id"])
+    def test_unban_user(self, client, random_user, server_user):
+        client.ban_user(random_user["id"], user_id=server_user["id"])
+        client.unban_user(random_user["id"], user_id=server_user["id"])
+
+    def test_flag_user(self, client, random_user, server_user):
+        client.flag_user(random_user["id"], user_id=server_user["id"])
+
+    def test_unflag_user(self, client, random_user, server_user):
+        client.flag_user(random_user["id"], user_id=server_user["id"])
+        client.unflag_user(random_user["id"], user_id=server_user["id"])
 
     def test_mark_all_read(self, client, random_user):
         client.mark_all_read(random_user["id"])
@@ -93,6 +100,17 @@ def test_delete_message(self, client, channel, random_user):
         channel.send_message({"id": msg_id, "text": "helloworld"}, random_user["id"])
         client.delete_message(msg_id)
 
+    def test_flag_message(self, client, channel, random_user, server_user):
+        msg_id = str(uuid.uuid4())
+        channel.send_message({"id": msg_id, "text": "helloworld"}, random_user["id"])
+        client.flag_message(msg_id, user_id=server_user["id"])
+
+    def test_unflag_message(self, client, channel, random_user, server_user):
+        msg_id = str(uuid.uuid4())
+        channel.send_message({"id": msg_id, "text": "helloworld"}, random_user["id"])
+        client.flag_message(msg_id, user_id=server_user["id"])
+        client.unflag_message(msg_id, user_id=server_user["id"])
+
     def test_query_users_young_hobbits(self, client, fellowship_of_the_ring):
         response = client.query_users({"race": {"$eq": "Hobbit"}}, {"age": -1})
         assert len(response["users"]) == 4