From ca367947a4c4cdbc25857808439e3c41feafe409 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D0=94=D0=BC=D0=B8=D1=82=D1=80=D0=B8=D0=B9=20=D0=90=D0=BD?=
 =?UTF-8?q?=D1=84=D0=B8=D0=BC=D0=BE=D0=B2?= <danfimov@yandex-team.ru>
Date: Thu, 28 Sep 2023 21:59:41 +0300
Subject: [PATCH] feat: time tracking support

---
 ya_tracker_client/domain/client/base.py       |  4 +-
 ya_tracker_client/domain/entities/duration.py | 67 +++++++++++++
 ya_tracker_client/domain/entities/worklog.py  | 45 +++++++++
 .../domain/repositories/__init__.py           |  2 +
 ya_tracker_client/domain/repositories/base.py | 21 +++-
 .../domain/repositories/checklist.py          | 12 +--
 .../domain/repositories/component.py          |  4 +-
 .../domain/repositories/issue.py              | 12 +--
 .../domain/repositories/issue_relationship.py |  6 +-
 .../domain/repositories/queue.py              | 14 ++-
 ya_tracker_client/domain/repositories/user.py |  7 +-
 .../domain/repositories/worklog.py            | 97 +++++++++++++++++++
 ya_tracker_client/service/api.py              |  2 +
 13 files changed, 255 insertions(+), 38 deletions(-)
 create mode 100644 ya_tracker_client/domain/entities/duration.py
 create mode 100644 ya_tracker_client/domain/entities/worklog.py
 create mode 100644 ya_tracker_client/domain/repositories/worklog.py

diff --git a/ya_tracker_client/domain/client/base.py b/ya_tracker_client/domain/client/base.py
index b9b270e..f8cb2ba 100644
--- a/ya_tracker_client/domain/client/base.py
+++ b/ya_tracker_client/domain/client/base.py
@@ -57,8 +57,6 @@ async def request(
         params: dict[str, Any] | None = None,
         payload: dict[str, Any] | None = None,
     ) -> bytes:
-        uri = f"{self._base_url}/{self._api_version}{uri}"
-
         bytes_payload = BytesPayload(
             value=bytes(serialize_entity(payload), encoding="utf-8"),
             content_type="application/json",
@@ -66,7 +64,7 @@ async def request(
 
         status, body = await self._make_request(
             method=method,
-            url=uri,
+            url=f"{self._base_url}/{self._api_version}{uri}",
             params=params,
             data=bytes_payload,
         )
diff --git a/ya_tracker_client/domain/entities/duration.py b/ya_tracker_client/domain/entities/duration.py
new file mode 100644
index 0000000..948e59c
--- /dev/null
+++ b/ya_tracker_client/domain/entities/duration.py
@@ -0,0 +1,67 @@
+from re import compile
+from typing import Any
+
+from pydantic import model_validator
+
+from ya_tracker_client.domain.entities.base import AbstractEntity
+
+
+PATTERN = compile(
+    r"^P(?=\d+[YMWD])"
+    r"((?P<years>\d+)Y)?"
+    r"((?P<months>\d+)M)?"
+    r"((?P<weeks>\d+)W)?"
+    r"((?P<days>\d+)D)?"
+    r"(?P<time>T(?=\d+[HMS])"
+    r"((?P<hours>\d+)H)?"
+    r"((?P<minutes>\d+)M)?"
+    r"((?P<seconds>\d+)S)?)?$",
+)
+
+
+class Duration(AbstractEntity):
+    years: int = 0
+    months: int = 0
+    days: int = 0
+    hours: int = 0
+    minutes: int = 0
+    seconds: int = 0
+
+    @model_validator(mode="before")
+    @classmethod
+    def validate(cls, model_value: Any) -> dict | None:
+        if not isinstance(model_value, str):
+            return
+
+        result = PATTERN.match(model_value)
+        if result is None:
+            msg = "Duration is not matched to ISO duration pattern."
+            raise ValueError(msg)
+
+        data: dict[str, int] = {}
+        for field in Duration.model_fields:
+            if value := result.group(field):
+                data[field] = int(value)
+        return data
+
+    def __str__(self) -> str:
+        time = ""
+        if self.hours:
+            time = f"{time}{self.hours}H"
+        if self.minutes:
+            time = f"{time}{self.minutes}M"
+        if self.seconds:
+            time = f"{time}{self.seconds}S"
+
+        duration = "P"
+        if self.years:
+            duration = f"{duration}{self.years}Y"
+        if self.months:
+            duration = f"{duration}{self.months}M"
+        if self.days:
+            duration = f"{duration}{self.days}D"
+        if time:
+            duration = f"{duration}T{time}"
+
+        return duration
+
diff --git a/ya_tracker_client/domain/entities/worklog.py b/ya_tracker_client/domain/entities/worklog.py
new file mode 100644
index 0000000..e7dbe81
--- /dev/null
+++ b/ya_tracker_client/domain/entities/worklog.py
@@ -0,0 +1,45 @@
+from datetime import datetime
+
+from pydantic import field_serializer
+
+from ya_tracker_client.domain.entities.base import AbstractEntity
+from ya_tracker_client.domain.entities.duration import Duration
+from ya_tracker_client.domain.entities.issue import IssueShort
+from ya_tracker_client.domain.entities.user import UserShort
+
+
+class Worklog(AbstractEntity):
+    url: str
+    id: int
+    version: int
+    issue: IssueShort
+    comment: str | None = None
+    created_by: UserShort
+    updated_by: UserShort | None
+    created_at: datetime
+    updated_at: datetime | None
+    start: datetime
+    duration: Duration
+
+    @field_serializer("duration")
+    def serialize_duration(self, duration: Duration):
+        return str(duration)
+
+
+class WorklogCreate(AbstractEntity):
+    start: datetime
+    duration: Duration
+    comment: str | None = None
+
+    @field_serializer("duration")
+    def serialize_duration(self, duration: Duration):
+        return str(duration)
+
+
+class WorklogEdit(AbstractEntity):
+    duration: Duration | None = None
+    comment: str | None = None
+
+    @field_serializer("duration")
+    def serialize_duration(self, duration: Duration):
+        return str(duration)
diff --git a/ya_tracker_client/domain/repositories/__init__.py b/ya_tracker_client/domain/repositories/__init__.py
index 595b31d..dc4fb25 100644
--- a/ya_tracker_client/domain/repositories/__init__.py
+++ b/ya_tracker_client/domain/repositories/__init__.py
@@ -4,6 +4,7 @@
 from ya_tracker_client.domain.repositories.issue_relationship import IssueRelationshipRepository
 from ya_tracker_client.domain.repositories.queue import QueueRepository
 from ya_tracker_client.domain.repositories.user import UserRepository
+from ya_tracker_client.domain.repositories.worklog import WorklogRepository
 
 
 __all__ = [
@@ -12,5 +13,6 @@
     "IssueRelationshipRepository",
     "IssueRepository",
     "QueueRepository",
+    "WorklogRepository",
     "UserRepository",
 ]
diff --git a/ya_tracker_client/domain/repositories/base.py b/ya_tracker_client/domain/repositories/base.py
index 2cce275..5860870 100644
--- a/ya_tracker_client/domain/repositories/base.py
+++ b/ya_tracker_client/domain/repositories/base.py
@@ -1,7 +1,24 @@
-from ya_tracker_client.domain.client import BaseClient
+from json import loads
+from typing import Any, Type
 
+from pydantic import BaseModel
 
-class EntityRepository:
+from ya_tracker_client.infrastructure.client import BaseClient
+
+
+class DeserializationMixin:
+    @staticmethod
+    def deserialize(
+        value: bytes,
+        return_type: Type[BaseModel] | None = None,
+        plural: bool = False,
+    ) -> Any:
+        if plural:
+            return [return_type(**raw_item) for raw_item in loads(value)]
+        return return_type(**loads(value))
+
+
+class EntityRepository(DeserializationMixin):
     def __init__(self, client: BaseClient) -> None:
         self._client = client
         super().__init__()
diff --git a/ya_tracker_client/domain/repositories/checklist.py b/ya_tracker_client/domain/repositories/checklist.py
index 5b6b009..8f5bb4b 100644
--- a/ya_tracker_client/domain/repositories/checklist.py
+++ b/ya_tracker_client/domain/repositories/checklist.py
@@ -1,5 +1,3 @@
-from json import loads
-
 from ya_tracker_client.domain.entities.checklist import ChecklistCreate, ChecklistItem, ChecklistItemEdit
 from ya_tracker_client.domain.entities.deadline import Deadline
 from ya_tracker_client.domain.entities.issue import IssueWithChecklist
@@ -30,7 +28,7 @@ async def create_checklist_item(
                 deadline=deadline,
             ).model_dump(exclude_none=True, by_alias=True),
         )
-        return IssueWithChecklist(**loads(raw_response))
+        return self.deserialize(raw_response, IssueWithChecklist)
 
     async def get_checklist_items(self, issue_id: str) -> list[ChecklistItem]:
         """
@@ -42,7 +40,7 @@ async def get_checklist_items(self, issue_id: str) -> list[ChecklistItem]:
             method="GET",
             uri=f"/issues/{issue_id}/checklistItems",
         )
-        return [ChecklistItem(**raw_checklist_item) for raw_checklist_item in loads(raw_response)]
+        return self.deserialize(raw_response, ChecklistItem, plural=True)
 
     async def edit_checklist_item(
         self,
@@ -66,7 +64,7 @@ async def edit_checklist_item(
                 deadline=deadline,
             ).model_dump(exclude_none=True, by_alias=True),
         )
-        return IssueWithChecklist(**loads(raw_response))
+        return self.deserialize(raw_response, IssueWithChecklist)
 
     async def delete_checklist(self, issue_id: str) -> IssueWithChecklist:
         """
@@ -76,7 +74,7 @@ async def delete_checklist(self, issue_id: str) -> IssueWithChecklist:
             method="DELETE",
             uri=f"/issues/{issue_id}/checklistItems",
         )
-        return IssueWithChecklist(**loads(raw_response))
+        return self.deserialize(raw_response, IssueWithChecklist)
 
     async def delete_checklist_item(self, issue_id: str, checklist_item_id: str):
         """
@@ -86,4 +84,4 @@ async def delete_checklist_item(self, issue_id: str, checklist_item_id: str):
             method="DELETE",
             uri=f"/issues/{issue_id}/checklistItems/{checklist_item_id}",
         )
-        return IssueWithChecklist(**loads(raw_response))
+        return self.deserialize(raw_response, IssueWithChecklist)
diff --git a/ya_tracker_client/domain/repositories/component.py b/ya_tracker_client/domain/repositories/component.py
index a05a79a..9431e44 100644
--- a/ya_tracker_client/domain/repositories/component.py
+++ b/ya_tracker_client/domain/repositories/component.py
@@ -1,5 +1,3 @@
-from json import loads
-
 from ya_tracker_client.domain.entities.component import Component
 from ya_tracker_client.domain.repositories.base import EntityRepository
 
@@ -13,4 +11,4 @@ async def get_components(self) -> list[Component]:
             method="GET",
             uri="/components",
         )
-        return [Component(**raw_component) for raw_component in loads(raw_response)]
+        return self.deserialize(raw_response, Component, plural=True)
diff --git a/ya_tracker_client/domain/repositories/issue.py b/ya_tracker_client/domain/repositories/issue.py
index 54a7ea6..3b54893 100644
--- a/ya_tracker_client/domain/repositories/issue.py
+++ b/ya_tracker_client/domain/repositories/issue.py
@@ -1,5 +1,3 @@
-from json import loads
-
 from ya_tracker_client.domain.entities.issue import Issue, IssueCreate, IssueEdit, IssueShort
 from ya_tracker_client.domain.entities.issue_type import IssueType
 from ya_tracker_client.domain.entities.priority import Priority
@@ -19,7 +17,7 @@ async def get_issue(self, issue_id: str) -> Issue:
             method="GET",
             uri=f"/issues/{issue_id}",
         )
-        return Issue(**loads(raw_response))
+        return self.deserialize(raw_response, Issue)
 
     async def create_issue(
         self,
@@ -55,7 +53,7 @@ async def create_issue(
                 attachment_ids=attachment_ids,
             ).model_dump(exclude_none=True, by_alias=True),
         )
-        return Issue(**loads(raw_response))
+        return self.deserialize(raw_response, Issue)
 
     async def edit_issue(
         self,
@@ -72,7 +70,7 @@ async def edit_issue(
             params={"version": version} if version is not None else None,
             payload=IssueEdit(**kwargs).model_dump(exclude_unset=True),
         )
-        return Issue(**loads(raw_response))
+        return self.deserialize(raw_response, Issue)
 
     async def get_priorities(
         self,
@@ -86,7 +84,7 @@ async def get_priorities(
             uri="/priorities/",
             params={"localized": str(localized)},
         )
-        return [Priority(**raw_issue_priority) for raw_issue_priority in loads(raw_response)]
+        return self.deserialize(raw_response, Priority)
 
     async def get_issue_transitions(
         self,
@@ -99,4 +97,4 @@ async def get_issue_transitions(
             method="GET",
             uri=f"/issues/{issue_id}/transitions/",
         )
-        return [Transition(**raw_issue_transition) for raw_issue_transition in loads(raw_response)]
+        return self.deserialize(raw_response, Transition, plural=True)
diff --git a/ya_tracker_client/domain/repositories/issue_relationship.py b/ya_tracker_client/domain/repositories/issue_relationship.py
index debee33..c14a514 100644
--- a/ya_tracker_client/domain/repositories/issue_relationship.py
+++ b/ya_tracker_client/domain/repositories/issue_relationship.py
@@ -1,5 +1,3 @@
-from json import loads
-
 from ya_tracker_client.domain.entities.issue_relationship import (
     IssueRelationship,
     IssueRelationshipCreate,
@@ -26,7 +24,7 @@ async def create_issue_relationship(
                 relationship=relationship,
             ).model_dump(exclude_none=True, by_alias=True),
         )
-        return IssueRelationship(**loads(raw_response))
+        return self.deserialize(raw_response, IssueRelationship)
 
     async def get_issue_relationships(
         self,
@@ -39,7 +37,7 @@ async def get_issue_relationships(
             method="GET",
             uri=f"/issues/{issue_id}/links",
         )
-        return [IssueRelationship(**raw_issue_relationship) for raw_issue_relationship in loads(raw_response)]
+        return self.deserialize(raw_response, IssueRelationship, plural=True)
 
     async def delete_issue_relationships(
         self,
diff --git a/ya_tracker_client/domain/repositories/queue.py b/ya_tracker_client/domain/repositories/queue.py
index 08817d7..c42b973 100644
--- a/ya_tracker_client/domain/repositories/queue.py
+++ b/ya_tracker_client/domain/repositories/queue.py
@@ -1,5 +1,3 @@
-from json import loads
-
 from ya_tracker_client.domain.entities.issue_type_config import IssueTypeConfig
 from ya_tracker_client.domain.entities.queue import Queue, QueueCreate
 from ya_tracker_client.domain.entities.queue_field import QueueField
@@ -32,7 +30,7 @@ async def create_queue(
                 issue_types_config=issue_types_config,
             ).model_dump(exclude_none=True, by_alias=True),
         )
-        return Queue(**loads(raw_response))
+        return self.deserialize(raw_response, Queue)
 
     async def get_queue(self, queue_id: str | int) -> Queue:
         """
@@ -42,7 +40,7 @@ async def get_queue(self, queue_id: str | int) -> Queue:
             method="GET",
             uri=f"/queues/{queue_id}",
         )
-        return Queue(**loads(raw_response))
+        return self.deserialize(raw_response, Queue)
 
     async def get_queues(self) -> list[Queue]:
         """
@@ -52,7 +50,7 @@ async def get_queues(self) -> list[Queue]:
             method="GET",
             uri="/queues/",
         )
-        return [Queue(**raw_queue) for raw_queue in loads(raw_response)]
+        return self.deserialize(raw_response, Queue, plural=True)
 
     async def get_queue_versions(self, queue_id: str | int) -> list[QueueVersion]:
         """
@@ -62,7 +60,7 @@ async def get_queue_versions(self, queue_id: str | int) -> list[QueueVersion]:
             method="GET",
             uri=f"/queues/{queue_id}/versions",
         )
-        return [QueueVersion(**raw_queue_version) for raw_queue_version in loads(raw_response)]
+        return self.deserialize(raw_response, QueueVersion, plural=True)
 
     async def get_queue_fields(self, queue_id: str | int) -> list[QueueField]:
         """
@@ -72,7 +70,7 @@ async def get_queue_fields(self, queue_id: str | int) -> list[QueueField]:
             method="GET",
             uri=f"/queues/{queue_id}/fields",
         )
-        return [QueueField(**raw_queue_field) for raw_queue_field in loads(raw_response)]
+        return self.deserialize(raw_response, QueueField, plural=True)
 
     async def delete_queue(self, queue_id: str | int) -> None:
         """
@@ -91,7 +89,7 @@ async def restore_queue(self, queue_id: str | int) -> Queue:
             method="POST",
             uri=f"/queues/{queue_id}/_restore",
         )
-        return Queue(**loads(raw_response))
+        return self.deserialize(raw_response, Queue)
 
     async def delete_tag_in_queue(self, queue_id: str | int, tag_name: str) -> None:
         """
diff --git a/ya_tracker_client/domain/repositories/user.py b/ya_tracker_client/domain/repositories/user.py
index ba90896..e70477a 100644
--- a/ya_tracker_client/domain/repositories/user.py
+++ b/ya_tracker_client/domain/repositories/user.py
@@ -1,4 +1,3 @@
-from json import loads
 from logging import getLogger
 
 from ya_tracker_client.domain.client.errors import ClientError
@@ -18,7 +17,7 @@ async def get_myself(self) -> User:
             method="GET",
             uri="/myself/",
         )
-        return User(**loads(raw_response))
+        return self.deserialize(raw_response, User)
 
     async def get_user(
         self,
@@ -39,7 +38,7 @@ async def get_user(
             method="GET",
             uri=f"/users/{login or uid}",
         )
-        return User(**loads(raw_response))
+        return self.deserialize(raw_response, User)
 
     async def get_users(self) -> list[User]:
         """
@@ -49,4 +48,4 @@ async def get_users(self) -> list[User]:
             method="GET",
             uri="/users/",
         )
-        return [User(**raw_user) for raw_user in loads(raw_response)]
+        return self.deserialize(raw_response, User, plural=True)
diff --git a/ya_tracker_client/domain/repositories/worklog.py b/ya_tracker_client/domain/repositories/worklog.py
new file mode 100644
index 0000000..535c430
--- /dev/null
+++ b/ya_tracker_client/domain/repositories/worklog.py
@@ -0,0 +1,97 @@
+from datetime import datetime
+
+from ya_tracker_client.domain.entities.duration import Duration
+from ya_tracker_client.domain.entities.worklog import Worklog, WorklogCreate, WorklogEdit
+from ya_tracker_client.domain.repositories.base import EntityRepository
+
+
+class WorklogRepository(EntityRepository):
+    async def add_worklog_record(
+        self,
+        issue_id: str,
+        start: datetime | str,
+        duration: str,
+        comment: str | None = None,
+    ) -> Worklog:
+        """
+        YC docs: https://cloud.yandex.com/en/docs/tracker/concepts/issues/new-worklog
+        """
+        raw_response = await self._client.request(
+            method="POST",
+            uri=f"/issues/{issue_id}/worklog",
+            payload=WorklogCreate(
+                start=start,
+                duration=duration,
+                comment=comment,
+            ).model_dump(exclude_none=True, by_alias=True),
+        )
+        return self.deserialize(raw_response, Worklog)
+
+    async def edit_worklog_record(
+        self,
+        issue_id: str,
+        worklog_id: int | str,
+        duration: str | Duration,
+        comment: str | None = None,
+    ) -> Worklog:
+        """
+        YC docs: https://cloud.yandex.com/en/docs/tracker/concepts/issues/patch-worklog
+        """
+        raw_response = await self._client.request(
+            method="PATCH",
+            uri=f"/issues/{issue_id}/worklog/{worklog_id}",
+            payload=WorklogEdit(
+                duration=duration,
+                comment=comment,
+            ).model_dump(exclude_none=True, by_alias=True),
+        )
+        return self.deserialize(raw_response, Worklog)
+
+    async def delete_worklog_record(
+        self,
+        issue_id: str,
+        worklog_id: int | str,
+    ) -> None:
+        """
+        YC docs: https://cloud.yandex.com/en/docs/tracker/concepts/issues/delete-worklog
+        """
+        await self._client.request(
+            method="DELETE",
+            uri=f"/issues/{issue_id}/worklog/{worklog_id}",
+        )
+
+    async def get_worklog(self, issue_id: str) -> list[Worklog]:
+        """
+        YC docs: https://cloud.yandex.com/en/docs/tracker/concepts/issues/issue-worklog
+        """
+        raw_response = await self._client.request(
+            method="GET",
+            uri=f"/issues/{issue_id}/worklog",
+        )
+        return self.deserialize(raw_response, Worklog, plural=True)
+
+    async def get_worklog_records_by_parameters(
+        self,
+        created_by: str | None = None,
+        created_at_from: datetime | None = None,
+        created_at_to: datetime | None = None,
+    ) -> list[Worklog]:
+        """
+        YC docs: https://cloud.yandex.com/en/docs/tracker/concepts/issues/get-worklog
+        """
+        payload = {}
+        if created_by is not None:
+            payload["createdBy"] = created_by
+        if created_at_from is not None:
+            payload["createdAt"] = {"from": created_at_from}
+        if created_at_to is not None:
+            if payload.get("createdAt") is None:
+                payload["createdAt"]["to"] = created_at_to
+            else:
+                payload["createdAt"] = {"to": created_at_to}
+        raw_response = await self._client.request(
+            method="POST",
+            uri="/worklog/_search",
+            payload=payload,
+        )
+        return self.deserialize(raw_response, Worklog, plural=True)
diff --git a/ya_tracker_client/service/api.py b/ya_tracker_client/service/api.py
index 196dad0..3522884 100644
--- a/ya_tracker_client/service/api.py
+++ b/ya_tracker_client/service/api.py
@@ -5,6 +5,7 @@
     IssueRepository,
     QueueRepository,
     UserRepository,
+    WorklogRepository,
 )
 from ya_tracker_client.infrastructure.client import AiohttpClient
 
@@ -16,6 +17,7 @@ class YaTrackerClient(
     IssueRepository,
     QueueRepository,
     UserRepository,
+    WorklogRepository,
 ):
     def __init__(
         self,