Merge pull request #122 from david-engelmann/master

Functions and Classes for UserDetails to Pair with create_user

Author: Hironsan

doccano_client/client.py

@@ -23,6 +23,7 @@
 from doccano_client.models.role import Role
 from doccano_client.models.task_status import TaskStatus
 from doccano_client.models.user import User
+from doccano_client.models.user_details import PasswordUpdated, UserDetails
 from doccano_client.repositories.base import BaseRepository
 from doccano_client.repositories.comment import CommentRepository
 from doccano_client.repositories.data_download import DataDownloadRepository
@@ -47,6 +48,7 @@
 from doccano_client.repositories.role import RoleRepository
 from doccano_client.repositories.task_status import TaskStatusRepository
 from doccano_client.repositories.user import UserRepository
+from doccano_client.repositories.user_details import UserDetailsRepository
 from doccano_client.services.label_type import LabelTypeService
 from doccano_client.usecase.comment import CommentUseCase
 from doccano_client.usecase.data_download import DataDownloadUseCase
@@ -63,6 +65,7 @@
 from doccano_client.usecase.label_type import LabelTypeUseCase
 from doccano_client.usecase.member import MemberUseCase
 from doccano_client.usecase.project import ProjectType, ProjectUseCase
+from doccano_client.usecase.user_details import UserDetailsUseCase
 
 
 class DoccanoClient:
@@ -82,6 +85,7 @@ def __init__(self, base_url: str, verify: Optional[str | bool] = None):
         """
         self._base_repository = BaseRepository(base_url, verify=verify)
         self._user_repository = UserRepository(self._base_repository)
+        self._user_details_repository = UserDetailsRepository(self._base_repository)
         self._role_repository = RoleRepository(self._base_repository)
         self._project_repository = ProjectRepository(self._base_repository)
         self._metrics_repository = MetricsRepository(self._base_repository)
@@ -182,6 +186,10 @@ def bounding_box(self) -> BoundingBoxUseCase:
     def text(self) -> TextUseCase:
         return TextUseCase(self._text_repository)
 
+    @property
+    def user_details(self) -> UserDetailsUseCase:
+        return UserDetailsUseCase(self._user_details_repository)
+
     def _get_label_type_usecase(self, type: Literal["category", "span", "relation"]) -> LabelTypeUseCase:
         if type == "category":
             return self.category_type
@@ -208,6 +216,36 @@ def get_profile(self) -> User:
         """
         return self._user_repository.get_profile()
 
+    def change_current_user_password(self, password: str, confirm_password: str) -> PasswordUpdated:
+        """Change the current user's password
+
+        Args:
+            password (str): the new password to set for the current user
+            confirm_password(str): confirm the new password to set for the current user
+
+        Returns:
+            PasswordUpdated: Message confirming password change.
+        """
+        return self.user_details.change_current_user_password(password=password, confirm_password=confirm_password)
+
+    def update_current_user_details(
+        self, username: str = None, first_name: str = None, last_name: str = None
+    ) -> UserDetails:
+        """Update either username, first name or last name of the current user.
+           If any args are left as None the current info will be kept
+
+        Args:
+            username (str): The username to change the current user to.
+            first_name (str): The first name to change the current user to.
+            last_name (str): The last name to change the current user to
+
+        Returns:
+            UserDetails: the updated user login info
+        """
+        return self.user_details.update_current_user_details(
+            username=username, first_name=first_name, last_name=last_name
+        )
+
     def search_users(self, name: str = "") -> List[User]:
         """Search users by name.
 

doccano_client/models/user_details.py

@@ -0,0 +1,37 @@
+from pydantic import BaseModel, root_validator
+from pydantic.types import ConstrainedStr
+
+
+class UserDetails(BaseModel):
+    """Contains the data relevant to a user on a Doccano project"""
+
+    pk: int
+    username: str
+    email: str
+    first_name: str
+    last_name: str
+
+
+class PasswordUpdated(BaseModel):
+    """Contains the data relevant to a password adjustment"""
+
+    detail: str
+
+
+class Password(ConstrainedStr):
+    min_length = 2
+    max_length = 128
+    strip_whitespace = True
+
+
+class PasswordChange(BaseModel):
+    new_password: Password
+    confirm_password: Password
+
+    @root_validator
+    def new_password_matches_confirm_password(cls, values):
+        new_password = values.get("new_password")
+        confirm_password = values.get("confirm_password")
+        if new_password != confirm_password:
+            raise ValueError("The new password does not match the confirm one.")
+        return values

doccano_client/repositories/user_details.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+from doccano_client.models.user_details import (
+    PasswordChange,
+    PasswordUpdated,
+    UserDetails,
+)
+from doccano_client.repositories.base import BaseRepository
+
+
+class UserDetailsRepository:
+    """Repository for interacting with the Doccano UserDetails API"""
+
+    def __init__(self, client: BaseRepository):
+        self._client = client
+
+    def get_current_user_details(self) -> UserDetails:
+        """Get the Current User Details
+
+        Returns:
+            UserDetails: The user login info.
+        """
+        response = self._client.get("auth/user/")
+        return UserDetails.parse_obj(response.json())
+
+    def update_current_user_details(self, user_details: UserDetails) -> UserDetails:
+        """Update either username, first name or last name of the current user.
+           If any args are left as None the current info will be kept
+
+        Args:
+            user_details (UserDetails): The user details.
+
+        Returns:
+            UserDetails: the updated user login info
+        """
+        response = self._client.put("auth/user/", json=user_details.dict())
+        return UserDetails.parse_obj(response.json())
+
+    def change_current_user_password(self, password_change: PasswordChange) -> PasswordUpdated:
+        """Change the password of the Current User
+
+        Args:
+            password_change (PasswordChange): the new password to set for the current user
+
+        Returns:
+            PasswordUpdated: Message confirming password change.
+        """
+        response = self._client.post(
+            "auth/password/change/",
+            json={"new_password1": password_change.new_password, "new_password2": password_change.confirm_password},
+        )
+        return PasswordUpdated.parse_obj(response.json())

doccano_client/usecase/user_details.py

@@ -0,0 +1,56 @@
+from doccano_client.models.user_details import (
+    PasswordChange,
+    PasswordUpdated,
+    UserDetails,
+)
+from doccano_client.repositories.user_details import UserDetailsRepository
+
+
+class UserDetailsUseCase:
+    def __init__(self, user_details_repository: UserDetailsRepository):
+        self._user_details_repository = user_details_repository
+
+    def get_current_user_details(self) -> UserDetails:
+        """Get the Current User Details
+
+        Returns:
+            UserDetails: The user login info.
+        """
+        return self._user_details_repository.get_current_user_details()
+
+    def update_current_user_details(
+        self, username: str = None, first_name: str = None, last_name: str = None
+    ) -> UserDetails:
+        """Update either username, first name or last name of the current user.
+           If any args are left as None the current info will be kept
+
+        Args:
+            username (str): The username to change the current user to.
+            first_name (str): The first name to change the current user to.
+            last_name (str): The last name to change the current user to
+
+        Returns:
+            UserDetails: the updated user login info
+        """
+        user_details = self.get_current_user_details()
+        user_details = UserDetails(
+            pk=user_details.pk,
+            username=username or user_details.username,
+            first_name=first_name or user_details.first_name,
+            last_name=last_name or user_details.last_name,
+            email=user_details.email,
+        )
+        return self._user_details_repository.update_current_user_details(user_details)
+
+    def change_current_user_password(self, password: str, confirm_password: str) -> PasswordUpdated:
+        """Change the password of the current user
+
+        Args:
+            password (str): the new password to set for the current user
+            confirm_password(str): confirm the new password to set for the current user
+
+        Returns:
+            PasswordUpdated: Message confirming password change.
+        """
+        password_change = PasswordChange(new_password=password, confirm_password=confirm_password)
+        return self._user_details_repository.change_current_user_password(password_change)

docs/usage.md

@@ -11,10 +11,15 @@
 
 ## User
 
-::: doccano_client.DoccanoClient.get_profile
 ::: doccano_client.DoccanoClient.search_users
 ::: doccano_client.DoccanoClient.find_user_by_name
 
+## User Details
+
+::: doccano_client.DoccanoClient.get_profile
+::: doccano_client.DoccanoClient.change_current_user_password
+::: doccano_client.DoccanoClient.update_current_user_details
+
 ## Role
 
 ::: doccano_client.DoccanoClient.list_roles

tests/integration/usecase/fixtures/user_details/change_password.yaml

@@ -0,0 +1,110 @@
+interactions:
+- request:
+    body: '{"new_password1": "foobarbaz1", "new_password2": "foobarbaz1"}'
+    headers:
+      Accept-Encoding:
+      - gzip, deflate
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '62'
+      Cookie:
+      - csrftoken=1maJEoZrCA1kd0Nfr0oWeZYuVVPFo1sziTKwuMSkSi5Cn3WdgrBLyMkS0teizEun;
+        sessionid=prauleg5y1gzxdagjyq4zgt7yccz7puj
+      User-Agent:
+      - python-requests/2.28.1
+      X-CSRFToken:
+      - 1maJEoZrCA1kd0Nfr0oWeZYuVVPFo1sziTKwuMSkSi5Cn3WdgrBLyMkS0teizEun
+      accept:
+      - application/json
+      content-type:
+      - application/json
+      referer:
+      - http://localhost:8000
+    method: POST
+    uri: http://localhost:8000/v1/auth/password/change/
+  response:
+    body:
+      string: '{"detail":"New password has been saved."}'
+    headers:
+      Allow:
+      - POST, OPTIONS
+      Content-Length:
+      - '41'
+      Content-Type:
+      - application/json
+      Cross-Origin-Opener-Policy:
+      - same-origin
+      Date:
+      - Thu, 27 Oct 2022 05:26:19 GMT
+      Referrer-Policy:
+      - same-origin
+      Server:
+      - WSGIServer/0.2 CPython/3.8.15
+      Set-Cookie:
+      - sessionid=yzvlcvrsvei7fx43svdc4xyrh2pwmhm1; expires=Thu, 10 Nov 2022 05:26:19
+        GMT; HttpOnly; Max-Age=1209600; Path=/; SameSite=Lax
+      Vary:
+      - Accept, Origin, Cookie
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - DENY
+    status:
+      code: 200
+      message: OK
+- request:
+    body: '{"new_password1": "foobarbaz", "new_password2": "foobarbaz"}'
+    headers:
+      Accept-Encoding:
+      - gzip, deflate
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '60'
+      Cookie:
+      - csrftoken=1maJEoZrCA1kd0Nfr0oWeZYuVVPFo1sziTKwuMSkSi5Cn3WdgrBLyMkS0teizEun;
+        sessionid=yzvlcvrsvei7fx43svdc4xyrh2pwmhm1
+      User-Agent:
+      - python-requests/2.28.1
+      X-CSRFToken:
+      - 1maJEoZrCA1kd0Nfr0oWeZYuVVPFo1sziTKwuMSkSi5Cn3WdgrBLyMkS0teizEun
+      accept:
+      - application/json
+      content-type:
+      - application/json
+      referer:
+      - http://localhost:8000
+    method: POST
+    uri: http://localhost:8000/v1/auth/password/change/
+  response:
+    body:
+      string: '{"detail":"New password has been saved."}'
+    headers:
+      Allow:
+      - POST, OPTIONS
+      Content-Length:
+      - '41'
+      Content-Type:
+      - application/json
+      Cross-Origin-Opener-Policy:
+      - same-origin
+      Date:
+      - Thu, 27 Oct 2022 05:26:19 GMT
+      Referrer-Policy:
+      - same-origin
+      Server:
+      - WSGIServer/0.2 CPython/3.8.15
+      Set-Cookie:
+      - sessionid=srwlwknapbj7op6hu8yuqy0pl2cmor7c; expires=Thu, 10 Nov 2022 05:26:19
+        GMT; HttpOnly; Max-Age=1209600; Path=/; SameSite=Lax
+      Vary:
+      - Accept, Origin, Cookie
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - DENY
+    status:
+      code: 200
+      message: OK
+version: 1