feat: implement user management methods including add, update, and delete functionalities

Author: guptadev21

rapyuta_io_sdk_v2/async_client.py

@@ -16,7 +16,6 @@
 from typing import Any
 
 import httpx
-from munch import Munch
 from yaml import safe_load
 
 from rapyuta_io_sdk_v2.config import Configuration
@@ -55,6 +54,8 @@
     OAuth2UpdateURI,
     ServiceAccountList,
     ServiceAccount,
+)
+from rapyuta_io_sdk_v2.models.serviceaccount import (
     ServiceAccountToken,
     ServiceAccountTokenInfo,
     ServiceAccountTokenList,
@@ -251,10 +252,10 @@ async def update_organization(
     # ---------------------User--------------------
     async def list_users(
         self,
-        organization_guid: str | None = None,
-        guid: str | None = None,
         cont: int = 0,
         limit: int = 50,
+        organization_guid: str | None = None,
+        guid: str | None = None,
         **kwargs,
     ) -> UserList:
         parameters: dict[str, Any] = {
@@ -276,8 +277,26 @@ async def list_users(
 
         return UserList(**result.json())
 
+    async def add_user(self, user: User | dict, **kwargs) -> User:
+        """Add a User in Organization.
+
+        Returns:
+            User: User details as a user object.
+        """
+        if isinstance(user, dict):
+            user = User.model_validate(user)
+        result = await self.c.post(
+            url=f"{self.v2api_host}/v2/users/",
+            headers=self.config.get_headers(with_project=False, **kwargs),
+            body=user.model_dump(by_alias=True),
+        )
+
+        handle_server_errors(result)
+
+        return UserList(**result.json())
+
     async def get_myself(self, **kwargs) -> User:
-        """Get User details.
+        """Get my User details.
 
         Returns:
             User: User details as a User object.
@@ -291,16 +310,44 @@ async def get_myself(self, **kwargs) -> User:
         handle_server_errors(result)
         return User(**result.json())
 
-    # Alias for backward compatibility
-    async def get_user(self, **kwargs) -> User:
-        """Get User details. (Alias for get_myself)
+    async def update_myself(self, body: User | dict[str, Any], **kwargs) -> User:
+        """Update my user details.
+
+        Args:
+            body (dict): User details
 
         Returns:
             User: User details as a User object.
         """
-        return await self.get_myself(**kwargs)
+        if isinstance(body, dict):
+            body = User.model_validate(body)
 
-    async def update_user(self, body: User | dict[str, Any], **kwargs) -> User:
+        result = await self.c.put(
+            url=f"{self.v2api_host}/v2/users/me/",
+            headers=self.config.get_headers(
+                with_project=False, with_organization=False, **kwargs
+            ),
+            json=body.model_dump(by_alias=True),
+        )
+        handle_server_errors(result)
+        return User(**result.json())
+
+    async def get_user(self, email_id: str, **kwargs) -> User:
+        """Get User details.
+
+        Returns:
+            User: User details as a User object.
+        """
+        result = await self.c.get(
+            url=f"{self.v2api_host}/v2/users/{email_id}",
+            headers=self.config.get_headers(with_project=False, **kwargs),
+        )
+        handle_server_errors(result)
+        return User(**result.json())
+
+    async def update_user(
+        self, email_id: str, body: User | dict[str, Any], **kwargs
+    ) -> User:
         """Update the user details.
 
         Args:
@@ -313,15 +360,24 @@ async def update_user(self, body: User | dict[str, Any], **kwargs) -> User:
             body = User.model_validate(body)
 
         result = await self.c.put(
-            url=f"{self.v2api_host}/v2/users/me/",
-            headers=self.config.get_headers(
-                with_project=False, with_organization=False, **kwargs
-            ),
+            url=f"{self.v2api_host}/v2/users/{email_id}/",
+            headers=self.config.get_headers(with_project=False, **kwargs),
             json=body.model_dump(by_alias=True),
         )
         handle_server_errors(result)
         return User(**result.json())
 
+    async def delete_user(self, email_id: str, **kwargs):
+        """
+        Delete the User
+        """
+        result = await self.c.delete(
+            url=f"{self.v2api_host}/v2/users/{email_id}/",
+            headers=self.config.get_headers(with_project=False, **kwargs),
+        )
+        handle_server_errors(result)
+        return None
+
     # ----------------- Projects -----------------
     async def list_projects(
         self,
@@ -1637,6 +1693,9 @@ async def commit_revision(
             json=config_tree_revision,
         )
 
+        handle_server_errors(result)
+        return result.json()
+
     async def get_key_in_revision(
         self,
         tree_name: str,
@@ -1666,9 +1725,6 @@ async def get_key_in_revision(
         # passing it through YAML parser.
         return safe_load(result.text)
 
-        handle_server_errors(result)
-        return result.json()
-
     async def put_key_in_revision(
         self,
         tree_name: str,

rapyuta_io_sdk_v2/client.py

@@ -16,7 +16,6 @@
 from typing import Any
 
 import httpx
-from munch import Munch
 from yaml import safe_load
 
 from rapyuta_io_sdk_v2.config import Configuration
@@ -268,8 +267,26 @@ def list_users(
 
         return UserList(**result.json())
 
+    def add_user(self, user: User | dict, **kwargs) -> User:
+        """Add a User in Organization.
+
+        Returns:
+            User: User details as a user object.
+        """
+        if isinstance(user, dict):
+            user = User.model_validate(user)
+        result = self.c.post(
+            url=f"{self.v2api_host}/v2/users/",
+            headers=self.config.get_headers(with_project=False, **kwargs),
+            body=user.model_dump(by_alias=True),
+        )
+
+        handle_server_errors(result)
+
+        return UserList(**result.json())
+
     def get_myself(self, **kwargs) -> User:
-        """Get User details.
+        """Get my User details.
 
         Returns:
             User: User details as a User object.
@@ -283,8 +300,8 @@ def get_myself(self, **kwargs) -> User:
         handle_server_errors(result)
         return User(**result.json())
 
-    def update_user(self, body: User | dict[str, Any], **kwargs) -> User:
-        """Update the user details.
+    def update_myself(self, body: User | dict[str, Any], **kwargs) -> User:
+        """Update my user details.
 
         Args:
             body (dict): User details
@@ -305,6 +322,50 @@ def update_user(self, body: User | dict[str, Any], **kwargs) -> User:
         handle_server_errors(result)
         return User(**result.json())
 
+    def get_user(self, email_id: str, **kwargs) -> User:
+        """Get User details.
+
+        Returns:
+            User: User details as a User object.
+        """
+        result = self.c.get(
+            url=f"{self.v2api_host}/v2/users/{email_id}",
+            headers=self.config.get_headers(with_project=False, **kwargs),
+        )
+        handle_server_errors(result)
+        return User(**result.json())
+
+    def update_user(self, email_id: str, body: User | dict[str, Any], **kwargs) -> User:
+        """Update the user details.
+
+        Args:
+            body (dict): User details
+
+        Returns:
+            User: User details as a User object.
+        """
+        if isinstance(body, dict):
+            body = User.model_validate(body)
+
+        result = self.c.put(
+            url=f"{self.v2api_host}/v2/users/{email_id}/",
+            headers=self.config.get_headers(with_project=False, **kwargs),
+            json=body.model_dump(by_alias=True),
+        )
+        handle_server_errors(result)
+        return User(**result.json())
+
+    def delete_user(self, email_id: str, **kwargs):
+        """
+        Delete the User
+        """
+        result = self.c.delete(
+            url=f"{self.v2api_host}/v2/users/{email_id}/",
+            headers=self.config.get_headers(with_project=False, **kwargs),
+        )
+        handle_server_errors(result)
+        return None
+
     # -------------------Project-------------------
     def get_project(self, project_guid: str | None = None, **kwargs) -> Project:
         """Get a project by its GUID.

tests/async_tests/test_configtree_async.py

@@ -261,7 +261,7 @@ async def test_commit_revision_success(async_client, mocker: AsyncMock):
 
 
 @pytest.mark.asyncio
-async def test_get_key_in_revision_str(client, mocker: AsyncMock):  # noqa: F811
+async def test_get_key_in_revision_str(async_client, mocker: AsyncMock):  # noqa: F811
     # Mock the httpx.AsyncClient.get method
     mock_get = mocker.patch("httpx.AsyncClient.get")
 
@@ -279,15 +279,15 @@ async def test_get_key_in_revision_str(client, mocker: AsyncMock):  # noqa: F811
 
 
 @pytest.mark.asyncio
-async def test_get_key_in_revision_int(client, mocker: AsyncMock):  # noqa: F811
+async def test_get_key_in_revision_int(async_client, mocker: AsyncMock):  # noqa: F811
     # Mock the httpx.AsyncClient.get method
     mock_get = mocker.patch("httpx.AsyncClient.get")
 
     # Set up the mock response
     mock_get.return_value = httpx.Response(status_code=200, text="999")
 
     # Call the get_key_in_revision method
-    response = await client.get_key_in_revision(
+    response = await async_client.get_key_in_revision(
         tree_name="mock_configtree_name", revision_id="mock_revision_id", key="mock_key"
     )
 
@@ -297,15 +297,15 @@ async def test_get_key_in_revision_int(client, mocker: AsyncMock):  # noqa: F811
 
 
 @pytest.mark.asyncio
-async def test_get_key_in_revision_bool(client, mocker: AsyncMock):  # noqa: F811
+async def test_get_key_in_revision_bool(async_client, mocker: AsyncMock):  # noqa: F811
     # Mock the httpx.AsyncClient.get method
     mock_get = mocker.patch("httpx.AsyncClient.get")
 
     # Set up the mock response
     mock_get.return_value = httpx.Response(status_code=200, text="false")
 
     # Call the get_key_in_revision method
-    response = await client.get_key_in_revision(
+    response = await async_client.get_key_in_revision(
         tree_name="mock_configtree_name", revision_id="mock_revision_id", key="mock_key"
     )
 

tests/async_tests/test_organization_async.py

@@ -25,12 +25,20 @@ async def test_get_organization_success(
     # Validate that response is an Organization model object
     assert isinstance(response, Organization)
     assert response.metadata.name == "test-org"
-    assert response.metadata.guid == "mock_org_guid"
-    assert len(response.spec.users) == 2
-    assert response.spec.users[0].emailID == "[email protected]"
-    assert response.spec.users[0].roleInOrganization == "viewer"
-    assert response.spec.users[1].emailID == "[email protected]"
-    assert response.spec.users[1].roleInOrganization == "admin"
+    assert response.metadata.guid == "org-testorg123456789abcdef"
+    assert len(response.spec.members) == 4
+    # Check first member (ServiceAccount)
+    assert response.spec.members[0].subject.kind == "ServiceAccount"
+    assert response.spec.members[0].subject.name == "test-project-builtin-paramsync-sa"
+    assert response.spec.members[0].roleNames == ["rio-org_member"]
+    # Check second member (User - admin)
+    assert response.spec.members[1].subject.kind == "User"
+    assert response.spec.members[1].subject.name == "[email protected]"
+    assert response.spec.members[1].roleNames == ["rio-org_admin", "rio-org_member"]
+    # Check third member (User - member only)
+    assert response.spec.members[2].subject.kind == "User"
+    assert response.spec.members[2].subject.name == "[email protected]"
+    assert response.spec.members[2].roleNames == ["rio-org_member"]
 
 
 @pytest.mark.asyncio
@@ -63,14 +71,16 @@ async def test_update_organization_success(
     )
 
     response = await client.update_organization(
-        organization_guid="mock_org_guid",
+        organization_guid="org-testorg123456789abcdef",
         body=organization_body,
     )
 
     # Validate that response is an Organization model object
     assert isinstance(response, Organization)
     assert response.metadata.name == "test-org"
-    assert response.metadata.guid == "mock_org_guid"
-    assert len(response.spec.users) == 2
-    assert response.spec.users[0].roleInOrganization == "viewer"
-    assert response.spec.users[1].roleInOrganization == "admin"
+    assert response.metadata.guid == "org-testorg123456789abcdef"
+    assert len(response.spec.members) == 4
+    # Verify admin member
+    assert response.spec.members[1].roleNames == ["rio-org_admin", "rio-org_member"]
+    # Verify regular member
+    assert response.spec.members[2].roleNames == ["rio-org_member"]