Merge pull request #1 from evrone/feature/ERP-1353/report-time-entry-pagination

Added response meta to report entries list.

Author: art-vasilyev

.gitignore

@@ -104,3 +104,4 @@ ENV/
 # IDE settings
 .vscode/
 local_*.py
+.idea/

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "toggl_python"
-version = "0.2.5"
+version = "0.2.6"
 description = "Python wraper for Toggl API."
 authors = ["Ivlev Denis <[email protected]>"]
 readme = "README.md"

tests/conftest.py

@@ -0,0 +1,30 @@
+import pytest
+
+from tests.fixtures import REPORT_TIME_ENTRIES_RESPONSE, TIME_ENTRIES_RESPONSE
+from toggl_python import ReportTimeEntries, TimeEntries
+
+
+@pytest.fixture
+def patch_report_time_entries(monkeypatch):
+    class MockResponse:
+        def __init__(self, *args, **kwargs):
+            pass
+
+        @staticmethod
+        def json():
+            return REPORT_TIME_ENTRIES_RESPONSE
+
+    monkeypatch.setattr(ReportTimeEntries, "get", MockResponse, raising=False)
+
+
+@pytest.fixture
+def patch_time_entries(monkeypatch):
+    class MockResponse:
+        def __init__(self, *args, **kwargs):
+            pass
+
+        @staticmethod
+        def json():
+            return TIME_ENTRIES_RESPONSE
+
+    monkeypatch.setattr(TimeEntries, "get", MockResponse, raising=False)

tests/fixtures.py

@@ -0,0 +1,47 @@
+REPORT_TIME_ENTRIES_RESPONSE = {
+    "total_grand": 0,
+    "total_billable": None,
+    "total_currencies": [{"currency": None, "amount": None}],
+    "total_count": 1,
+    "per_page": 50,
+    "data": [
+        {
+            "id": 45675345,
+            "pid": 44556545,
+            "tid": None,
+            "uid": 123456,
+            "description": "",
+            "start": "2020-08-24T15:43:11+03:00",
+            "end": "2020-08-24T15:43:19+03:00",
+            "updated": "2020-08-24T15:43:19+03:00",
+            "dur": 8000,
+            "user": "Test User",
+            "use_stop": True,
+            "client": "test-client",
+            "project": "test project",
+            "project_color": "0",
+            "project_hex_color": "#990099",
+            "task": None,
+            "billable": None,
+            "is_billable": False,
+            "cur": None,
+            "tags": [],
+        }
+    ],
+}
+
+TIME_ENTRIES_RESPONSE = [
+    {
+        "id": 45675345,
+        "guid": "3ab9166aac16cbf1374edda1cb652f69",
+        "wid": 4581172,
+        "pid": 44556545,
+        "billable": False,
+        "start": "2020-08-24T12:43:11+00:00",
+        "stop": "2020-08-24T12:43:19+00:00",
+        "duration": 8,
+        "duronly": False,
+        "at": "2020-08-24T12:43:19+00:00",
+        "uid": 123456,
+    },
+]

tests/test_repositories.py

@@ -0,0 +1,30 @@
+from toggl_python import (
+    ReportTimeEntries,
+    TokenAuth,
+    ReportTimeEntry,
+    TimeEntries,
+    TimeEntry,
+)
+from tests.fixtures import REPORT_TIME_ENTRIES_RESPONSE, TIME_ENTRIES_RESPONSE
+
+
+def test_report_time_entries_pagination(patch_report_time_entries):
+    auth = TokenAuth("token")
+    report_time_entries = ReportTimeEntries(auth=auth).list()
+    total_count = REPORT_TIME_ENTRIES_RESPONSE["total_count"]
+    per_page = REPORT_TIME_ENTRIES_RESPONSE["per_page"]
+    assert report_time_entries.total_count == total_count
+    assert report_time_entries.per_page == per_page
+    assert len(report_time_entries) == len(REPORT_TIME_ENTRIES_RESPONSE["data"])
+    for report_time_entry in report_time_entries:
+        assert isinstance(report_time_entry, ReportTimeEntry)
+
+
+def test_time_entries_no_pagination(patch_time_entries):
+    auth = TokenAuth("token")
+    time_entries = TimeEntries(auth=auth).list()
+    assert not hasattr(time_entries, "total_count")
+    assert not hasattr(time_entries, "per_page")
+    assert len(time_entries) == len(TIME_ENTRIES_RESPONSE)
+    for time_entry in time_entries:
+        assert isinstance(time_entry, TimeEntry)

toggl_python/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.2.5"
+__version__ = "0.2.6"
 
 from .auth import BasicAuth, TokenAuth  # noqa: F401
 from .entities import Dashboard  # noqa: F401
@@ -10,6 +10,7 @@
     MostActiveUser,
     Project,
     ProjectUser,
+    ReportTimeEntry,
     Tag,
     Task,
     TimeEntry,
@@ -23,6 +24,7 @@
     Dashboards,
     Groups,
     ProjectUsers,
+    ReportTimeEntries,
     Tags,
     Tasks,
     TimeEntries,
@@ -46,6 +48,8 @@
     "Projects",
     "ProjectUser",
     "ProjectUsers",
+    "ReportTimeEntry",
+    "ReportTimeEntries",
     "Tag",
     "Tags",
     "Task",

toggl_python/exceptions.py

@@ -1,24 +1,28 @@
-class BadRequest(Exception):
+class TogglException(Exception):
     pass
 
 
-class Unauthorized(Exception):
+class BadRequest(TogglException):
     pass
 
 
-class Forbidden(Exception):
+class Unauthorized(TogglException):
     pass
 
 
-class NotFound(Exception):
+class Forbidden(TogglException):
     pass
 
 
-class MethodNotAllowed(Exception):
+class NotFound(TogglException):
     pass
 
 
-class NotSupported(Exception):
+class MethodNotAllowed(TogglException):
+    pass
+
+
+class NotSupported(TogglException):
     pass
 
 

toggl_python/repository.py

@@ -19,6 +19,7 @@
     ReportTimeEntry,
 )
 from .exceptions import MethodNotAllowed, NotSupported
+from .response import ReportTimeEntriesList
 
 
 class BaseRepository(Api):
@@ -29,6 +30,7 @@ class BaseRepository(Api):
     EXCLUDED_METHODS = ()
     ADDITIONAL_PARAMS = {}
     DATA_CONTAINER = {}
+    LIST_RESPONSE = None
 
     def __init__(self, base_url=None, auth=None):
         super().__init__(base_url=base_url, auth=auth)
@@ -109,12 +111,17 @@ def _list(self, _url, entity_class, data_key: str = None, **kwargs):
         params.update(self.ADDITIONAL_PARAMS.get("list", {}))
 
         response = self.get(_url, params=params)
-        data = response.json()
+        response_body = response.json()
+
+        data = response_body
         data_key = data_key or self.DATA_CONTAINER.get("list", None)
         if data_key:
             data = data[data_key]
         if data:
-            return [entity_class(**entity) for entity in data]
+            value = [entity_class(**entity) for entity in data]
+            if self.LIST_RESPONSE:
+                value = self.LIST_RESPONSE(value, response_body)
+            return value
 
     def list(self, **kwargs):
         if "list" in self.EXCLUDED_METHODS:
@@ -185,6 +192,7 @@ class ReportTimeEntries(BaseRepository):
     DATA_CONTAINER = {"list": "data"}
     LIST_URL = "details"
     ENTITY_CLASS = ReportTimeEntry
+    LIST_RESPONSE = ReportTimeEntriesList
 
 
 class Users(BaseRepository):

toggl_python/response.py

@@ -0,0 +1,19 @@
+class ListResponse(list):
+    response_parameters = ()
+
+    def __init__(self, value, response_body):
+        super(ListResponse, self).__init__(value)
+
+        for parameter in self.response_parameters:
+            if parameter in response_body:
+                setattr(self, parameter, response_body[parameter])
+
+
+class ReportTimeEntriesList(ListResponse):
+    response_parameters = (
+        "total_count",
+        "per_page",
+        "total_grand",
+        "total_billable",
+        "total_currencies",
+    )