Permissions API follow-up changes (#67)

Author: Anatoly Rugalev

stream_chat/async_chat/client.py

@@ -400,13 +400,13 @@ async def check_sqs(self, sqs_key=None, sqs_secret=None, sqs_url=None):
         data = {"sqs_key": sqs_key, "sqs_secret": sqs_secret, "sqs_url": sqs_url}
         return await self.post("check_sqs", data=data)
 
-    async def get_permission(self, name):
+    async def get_permission(self, id):
         """
         Get the definition for a permission
 
-        :param name: Name of the permission
+        :param id: ID of the permission
         """
-        return await self.get(f"permissions/{name}")
+        return await self.get(f"permissions/{id}")
 
     async def create_permission(self, permission):
         """
@@ -416,22 +416,22 @@ async def create_permission(self, permission):
         """
         return await self.post("permissions", data=permission)
 
-    async def update_permission(self, name, permission):
+    async def update_permission(self, id, permission):
         """
         Update a custom permission
 
-        :param name: Name of the permission
+        :param id: ID of the permission
         :param permission: New definition of the permission
         """
-        return await self.put(f"permissions/{name}", data=permission)
+        return await self.put(f"permissions/{id}", data=permission)
 
-    async def delete_permission(self, name):
+    async def delete_permission(self, id):
         """
         Delete a custom permission
 
-        :param name: Name of the permission
+        :param id: ID of the permission
         """
-        return await self.delete(f"permissions/{name}")
+        return await self.delete(f"permissions/{id}")
 
     async def list_permissions(self):
         """

stream_chat/client.py

@@ -388,66 +388,66 @@ def check_sqs(self, sqs_key=None, sqs_secret=None, sqs_url=None):
         data = {"sqs_key": sqs_key, "sqs_secret": sqs_secret, "sqs_url": sqs_url}
         return self.post("check_sqs", data=data)
 
-    def get_permission(self, name):
+    def get_permission(self, id):
         """
         Get the definition for a permission
 
-        :param name: Name of the permission
+        :param id: ID of the permission
         """
-        return self.get(f"custom_permission/{name}")
+        return self.get(f"permissions/{id}")
 
     def create_permission(self, permission):
         """
         Create a custom permission
 
         :param permission: Definition of the permission
         """
-        return self.post("custom_permission", data=permission)
+        return self.post("permissions", data=permission)
 
-    def update_permission(self, name, permission):
+    def update_permission(self, id, permission):
         """
         Update a custom permission
 
-        :param name: Name of the permission
+        :param id: ID of the permission
         :param permission: New definition of the permission
         """
-        return self.post(f"custom_permission/{name}", data=permission)
+        return self.put(f"permissions/{id}", data=permission)
 
-    def delete_permission(self, name):
+    def delete_permission(self, id):
         """
         Delete a custom permission
 
-        :param name: Name of the permission
+        :param id: ID of the permission
         """
-        return self.delete(f"custom_permission/{name}")
+        return self.delete(f"permissions/{id}")
 
     def list_permissions(self):
         """
         List custom permissions of the app
         """
-        return self.get("custom_permission")
+        return self.get("permissions")
 
     def create_role(self, name):
         """
         Create a custom role
 
         :param name: Name of the role
         """
-        return self.post("custom_role", data={"name": name})
+        return self.post("roles", data={"name": name})
 
     def delete_role(self, name):
         """
         Delete a custom role
 
         :param name: Name of the role
         """
-        return self.delete(f"custom_role/{name}")
+        return self.delete(f"roles/{name}")
 
     def list_roles(self):
         """
-        List custom roles of the app
+        List all roles of the app
         """
-        return self.get("custom_role")
+        return self.get("roles")
 
     def create_segment(self, segment):
         """

stream_chat/tests/async_chat/test_client.py

@@ -450,50 +450,51 @@ async def test_check_sqs(self, client):
     @pytest.mark.asyncio
     @pytest.mark.skip(reason="slow and flaky due to waits")
     async def test_custom_permission_and_roles(self, client):
-        name, role = "Something restricted", "god"
+        id, role = "my-custom-permission", "god"
 
         def wait():
             time.sleep(3)
 
         with suppress(Exception):
-            await client.delete_permission(name)
+            await client.delete_permission(id)
             wait()
         with suppress(Exception):
             await client.delete_role(role)
             wait()
 
         custom = {
-            "name": name,
-            "resource": "DeleteChannel",
+            "id": id,
+            "name": "My Custom Permission",
+            "action": "DeleteChannel",
             "owner": False,
             "same_team": True,
         }
 
         await client.create_permission(custom)
         wait()
-        response = await client.get_permission(name)
-        assert response["permission"]["name"] == name
+        response = await client.get_permission(id)
+        assert response["permission"]["id"] == id
         assert response["permission"]["custom"]
         assert not response["permission"]["owner"]
-        assert response["permission"]["resource"] == custom["resource"]
+        assert response["permission"]["action"] == custom["action"]
 
         custom["owner"] = True
-        await client.update_permission(name, custom)
+        await client.update_permission(id, custom)
 
         wait()
-        response = await client.get_permission(name)
-        assert response["permission"]["name"] == name
+        response = await client.get_permission(id)
+        assert response["permission"]["id"] == id
         assert response["permission"]["custom"]
         assert response["permission"]["owner"]
-        assert response["permission"]["resource"] == custom["resource"]
+        assert response["permission"]["action"] == custom["action"]
 
         response = await client.list_permissions()
-        assert len(response["permissions"]) == 1
-        assert response["permissions"][0]["name"] == name
-        await client.delete_permission(name)
+        original_len = len(response["permissions"])
+        assert response["permissions"][0]["id"] == id
+        await client.delete_permission(id)
         wait()
         response = await client.list_permissions()
-        assert len(response["permissions"]) == 0
+        assert len(response["permissions"]) == original_len - 1
 
         await client.create_role(role)
         wait()

stream_chat/tests/test_client.py

@@ -376,47 +376,48 @@ def test_check_sqs(self, client):
 
     @pytest.mark.skip(reason="slow and flaky due to waits")
     def test_custom_permission_and_roles(self, client):
-        name, role = "Something restricted", "god"
+        id, role = "my-custom-permission", "god"
 
         def wait():
             time.sleep(3)
 
         with suppress(Exception):
-            client.delete_permission(name)
+            client.delete_permission(id)
             wait()
         with suppress(Exception):
             client.delete_role(role)
             wait()
 
         custom = {
-            "name": name,
+            "id": id,
+            "name": "My Custom Permission",
             "action": "DeleteChannel",
             "owner": False,
             "same_team": True,
         }
 
         client.create_permission(custom)
         wait()
-        response = client.get_permission(name)
-        assert response["permission"]["name"] == name
+        response = client.get_permission(id)
+        assert response["permission"]["id"] == id
         assert response["permission"]["custom"]
         assert not response["permission"]["owner"]
         assert response["permission"]["action"] == custom["action"]
 
         custom["owner"] = True
-        client.update_permission(name, custom)
+        client.update_permission(id, custom)
 
         wait()
-        response = client.get_permission(name)
-        assert response["permission"]["name"] == name
+        response = client.get_permission(id)
+        assert response["permission"]["id"] == id
         assert response["permission"]["custom"]
         assert response["permission"]["owner"]
         assert response["permission"]["action"] == custom["action"]
 
         response = client.list_permissions()
         original_len = len(response["permissions"])
-        assert response["permissions"][0]["name"] == name
-        client.delete_permission(name)
+        assert response["permissions"][0]["id"] == id
+        client.delete_permission(id)
         wait()
         response = client.list_permissions()
         assert len(response["permissions"]) == original_len - 1