Merge branch 'master' into task/ERP-1225/upgrade_python_to_3_12

Author: Georgii Aleksahin

docs/conf.py

@@ -1,15 +1,20 @@
 import datetime
 from pathlib import Path
+
 from sphinx.ext import apidoc
 
+
 copyright = f"{datetime.datetime.now().year}, Evrone"
 
 # Auto generate documentation
 if False:
-    apidoc.main([
-        '-f', # force overwrite
-        '-T', # no modules.rst toc
-        '-e', # Each module on it's own page
-        '-o', str(Path(__file__).parent), # Output dir relative to "Sphinx root"
-        str(Path(__file__).parent.parent / 'toggl_python') # Source code root
-    ])
+    apidoc.main(
+        [
+            "-f",  # force overwrite
+            "-T",  # no modules.rst toc
+            "-e",  # Each module on it's own page
+            "-o",
+            str(Path(__file__).parent),  # Output dir relative to "Sphinx root"
+            str(Path(__file__).parent.parent / "toggl_python"),  # Source code root
+        ]
+    )

poetry.lock

@@ -64,4 +64,4 @@ lines_after_imports = 2
 
 [build-system]
 requires = ["poetry>=0.12"]
-build-backend = "poetry.masonry.api"
+build-backend = "poetry.masonry.api"

pyproject.toml

@@ -28,13 +28,13 @@ def test_client_entity():
 
 
 def test_group_entity():
-    Group(name="foo", wid=1)
-    Group(name="foo", wid=1, notes="some string")
+    Group(name="foo", workspace_id=1)
+    Group(name="foo", workspace_id=1, notes="some string")
 
     with pytest.raises(pydantic.ValidationError):
         Group(name="foo")
     with pytest.raises(pydantic.ValidationError):
-        Group(wid=1)
+        Group(workspace_id=1)
     with pytest.raises(pydantic.ValidationError):
         Group(name=1, wid=None)
 
@@ -65,23 +65,23 @@ def test_project_user_entity():
 
 
 def test_tag_entity():
-    Tag(name="foo", wid=1)
+    Tag(name="foo", workspace_id=1)
 
     with pytest.raises(pydantic.ValidationError):
         Tag(name="foo")
     with pytest.raises(pydantic.ValidationError):
-        Tag(wid=1)
+        Tag(workspace_id=1)
 
 
 def test_task_entity():
-    Task(name="foo", pid=1, wid=1)
+    Task(name="foo", project_id=1, workspace_id=1)
 
     with pytest.raises(pydantic.ValidationError):
-        Task(name="foo", pid=1)
+        Task(name="foo", project_id=1)
     with pytest.raises(pydantic.ValidationError):
-        Task(name="foo", wid=1)
+        Task(name="foo", workspace_id=1)
     with pytest.raises(pydantic.ValidationError):
-        Task(pid=1, wid=1)
+        Task(project_id=1, workspace_id=1)
 
 
 def test_time_entry_entity():

tests/test_entities.py

@@ -16,7 +16,7 @@ class Api:
     Allow to interact with official Toggl API via httpx.
     """
 
-    BASE_URL: httpx.URL = httpx.URL("https://api.track.toggl.com/api/v8/")
+    BASE_URL: httpx.URL = httpx.URL("https://api.track.toggl.com/api/v9/")
     HEADERS = {
         "content-type": "application/json",
         "user_agent": "toggl-python",

toggl_python/api.py

@@ -1,7 +1,7 @@
 from datetime import datetime
-from typing import Any, Callable, Dict, List, Optional, Union
+from typing import Callable, List, Optional, Union
 
-from pydantic import BaseModel, EmailStr, HttpUrl
+from pydantic import BaseModel, EmailStr, Field, HttpUrl
 
 
 class BaseEntity(BaseModel):
@@ -17,7 +17,7 @@ class Client(BaseEntity):
 
 class Group(BaseEntity):
     name: str
-    wid: int
+    wid: int = Field(alias="workspace_id")
 
 
 class Project(BaseEntity):
@@ -28,7 +28,7 @@ class Project(BaseEntity):
     is_private: bool = True
     template: Optional[bool] = None
     template_id: Optional[int] = None
-    billable: bool = True
+    billable: Optional[bool] = True
     auto_estimates: Optional[bool] = False
     estimated_hours: Optional[int] = None
     color: Union[str, int] = 0
@@ -48,15 +48,16 @@ class ProjectUser(BaseEntity):
 
 class Tag(BaseEntity):
     name: str
-    wid: int
+    wid: int = Field(alias="workspace_id")
 
 
 class Task(BaseEntity):
     name: str
-    pid: int
-    wid: int
-    uid: Optional[int] = None
+    pid: int = Field(alias="project_id")
+    wid: int = Field(alias="workspace_id")
+    uid: Optional[int] = Field(alias="user_id", default=None)
     estimated_seconds: Optional[int] = None
+    tracked_seconds: Optional[int] = None
     active: Optional[bool] = True
 
 
@@ -89,33 +90,11 @@ class ReportTimeEntry(BaseEntity):
     tags: List[str] = []
 
 
-class User(BaseEntity):
-    api_token: Optional[str] = None
-    default_wid: Optional[int] = None
-    email: EmailStr
-    fullname: str
-    jquery_timeofday_format: str
-    jquery_date_format: str
-    timeofday_format: str
-    date_format: str
-    store_start_and_stop_time: bool
-    beginning_of_week: int = 0
-    language: str
-    image_url: HttpUrl
-    sidebar_piechart: bool
-    new_blog_post: Optional[Dict[str, Any]] = None
-    send_product_emails: bool
-    send_weekly_report: bool
-    send_timer_notifications: bool
-    openid_enabled: bool
-    timezone: str
-
-
 class Workspace(BaseEntity):
     name: str
     premium: bool
     admin: bool
-    default_hourly_rate: float
+    default_hourly_rate: Optional[float] = None
     default_currency: str
     only_admins_may_create_projects: bool
     only_admins_see_billable_rates: bool
@@ -124,6 +103,24 @@ class Workspace(BaseEntity):
     logo_url: Optional[HttpUrl] = None
 
 
+class User(BaseEntity):
+    api_token: Optional[str] = None
+    default_wid: Optional[int] = Field(alias="default_workspace_id", default=None)
+    email: EmailStr
+    fullname: str
+    beginning_of_week: int = 0
+    image_url: Optional[HttpUrl] = None
+    openid_enabled: Optional[bool] = None
+    timezone: Optional[str] = None
+    country_id: Optional[int] = None
+    projects: Optional[Project] = None
+    tags: Optional[Tag] = None
+    tasks: Optional[Task] = None
+    time_entries: Optional[TimeEntry] = None
+    updated_at: str
+    workspaces: Optional[Workspace] = None
+
+
 class WorkspaceUser(BaseEntity):
     uid: int
     wid: int

toggl_python/entities.py

@@ -106,15 +106,14 @@ def additionat_method(
             if not self.DETAIL_URL:
                 raise AttributeError("Not defined DETAIL_URL")
             _url = (self.DETAIL_URL + "/" + url).format(id=_id)
-            return self._list(_url, entity, headers=self.HEADERS, param=params)
+            return self._list(_url, entity, headers=self.HEADERS, param=params, data_key=data_key)
         elif single_item:
-            _url = str(self.BASE_URL) + "/" + url
+            _url = str(self.BASE_URL) + f"{url}"
             return self._retrieve(
                 _url,
                 entity,
                 headers=self.HEADERS,
                 params=params,
-                data_key="data",
             )
         else:
             raise NotSupported
@@ -123,7 +122,7 @@ def _retrieve(
         self,
         _url: Union[str, httpx.URL],
         entity_class: Any,
-        data_key: Optional[str] = "data",
+        data_key: Optional[str] = None,
         **kwargs: Any,
     ) -> Any:
         params = kwargs
@@ -229,7 +228,7 @@ class Tasks(BaseRepository):
 
 
 class TimeEntries(BaseRepository):
-    LIST_URL = "time_entries"
+    LIST_URL = "me/time_entries"
     ENTITY_CLASS = TimeEntry
 
 
@@ -259,7 +258,7 @@ class Workspaces(BaseRepository):
         "users": {"url": "users", "entity": User, "detail": False},
         "clients": {"url": "clients", "entity": Client, "detail": False},
         "groups": {"url": "groups", "entity": Group, "detail": False},
-        "tasks": {"url": "tasks", "entity": Task, "detail": False},
+        "tasks": {"url": "tasks", "entity": Task, "data_key": "data", "detail": False},
         "tags": {"url": "tags", "entity": Tag, "detail": False},
         "workspace_users": {
             "url": "workspace_users",