chore(release): version 1.4.0

Author: ddkasa

docs/CHANGELOG.md

@@ -2,6 +2,58 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.4.0] - 2024-11-11
+
+### 🚀 Features
+
+- *(exceptions)* Custom exceptions for commonly raised value errors
+- *(cache)* Custom missing parent error
+
+### 🐛 Bug Fixes
+
+- *(project)* Wrong hex code for gray color
+- *(utils)* Remove unnecessary import
+
+### 🚜 Refactor
+
+- *(tag)* Edit endpoint method accepts seperate name argument
+- *(tag)* Validate minimum name length
+- *(endpoint)* Use generics with base endpoint
+- *(cache)* User generic type with cache
+- *(endpoint)* Assign generics to all endpoints
+- *(endpoint)* Cache query method always returns list
+- *(typing)* Generics implementation
+- *(workspace)* Use custom exceptions for raised errors
+- *(user)* Use custom exceptions for raised errors
+- *(user)* Use custom exceptions for raised errors
+- *(tag)* Use custom exceptions for raised errors
+- *(project)* Use custom exceptions for raised errors
+- *(client)* Use custom exceptions for raised errors
+- *(models)* Use naming error instead of value error
+- *(cache)* Implement new error subclass
+
+### 🕸 Deprecations
+
+- *(tag)* Remove the internal usage of a modified name in a tag
+- *(trackers)* Change exception type in add endpoint method
+
+### 📚 Documentation
+
+- *(tag)* Update edit endpoint docstring
+- *(tag)* Improve delete endpoint docstring
+- *(tag)* Improve add endpoint method docstring
+- *(tag)* Improve endpoint class docstring
+- *(organization)* Use custom exceptions for raised errors docstring
+- *(exceptions)* Document new exception classes
+- *(mkdocs)* Enable symbols in table of contents
+- *(config)* Reconfigure headings
+
+### 🧪 Testing
+
+- *(tag)* Validate tag name length
+- *(conftest)* Rate limit trackers teardown
+- *(utility)* Make sure version is updated
+
 ## [1.3.2] - 2024-11-05
 
 ### 🐛 Bug Fixes

docs/api-guide/cache.md

@@ -4,6 +4,8 @@
 {% include "static/mermaid/cache.mmd" %}
 ```
 
+::: toggl_api.MissingParentError
+
 ::: toggl_api.meta.cache.TogglCache
 
 ---

docs/api-guide/config.md

@@ -1,4 +1,4 @@
-# Authentication
+## Authentication
 
 ::: toggl_api.config.AuthenticationError
 
@@ -9,9 +9,7 @@
 > [!NOTE]  
 > The [UserEndpoint](/toggl-api-wrapper/api-guide/tracker.html#toggl_api.modules.user.UserEndpoint) has a [verify_authentication](/toggl-api-wrapper/api-guide/tracker.html#toggl_api.modules.user.UserEndpoint.check_authentication) method for verifying authentication with the Toggl API.
 
----
-
-# Default Workspace
+## Default Workspace
 
 ::: toggl_api.config.retrieve_workspace_id
 

docs/api-guide/exceptions.md

@@ -0,0 +1,3 @@
+::: toggl_api.NamingError
+
+::: toggl_api.DateTimeError

mkdocs.yml

@@ -133,6 +133,7 @@ plugins:
             show_source: false
             show_signature_annotations: true
             show_symbol_type_heading: true
+            show_symbol_type_toc: true
   - callouts
   - panzoom:
       full_screen: true

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "toggl-api-wrapper"
-version = "1.3.2"
+version = "1.4.0"
 description = "Simple Toggl API wrapper for non-premium features."
 authors = ["David Kasakaitis <[email protected]>"]
 license = "MIT"
@@ -54,6 +54,7 @@ pytest-cov = "^5.0.0"
 pytest-replay = "^1.5.2"
 pytest-rerunfailures = "^14.0"
 pytest-dependency = "^0.6.0"
+tomli = "^2.0.2"
 
 [tool.poetry.group.docs.dependencies]
 mkdocs = "^1.6.0"

pyproject.toml

@@ -16,7 +16,6 @@
 from toggl_api.tag import TagEndpoint
 from toggl_api.tracker import TrackerEndpoint
 from toggl_api.user import UserEndpoint
-from toggl_api.workspace import WorkspaceEndpoint
 
 
 def _path_cleanup(cache_path: Path) -> None:

scripts/utils.py

@@ -8,10 +8,11 @@
 from pathlib import Path
 
 import pytest
+from sqlalchemy.util.langhelpers import MissingOr
 
 from tests.conftest import EndPointTest
 from toggl_api.meta import CustomDecoder, CustomEncoder, JSONCache, RequestMethod
-from toggl_api.meta.cache.base_cache import Comparison, TogglQuery
+from toggl_api.meta.cache.base_cache import Comparison, MissingParentError, TogglQuery
 from toggl_api.meta.cache.json_cache import JSONSession
 from toggl_api.models.models import TogglTag, TogglTracker
 from toggl_api.user import UserEndpoint
@@ -87,7 +88,7 @@ def test_cache_path(meta_object):
 
 @pytest.mark.unit
 def test_cache_parent(config_setup, get_sqlite_cache, get_workspace_id):
-    assert get_sqlite_cache.parent is None
+    assert get_sqlite_cache._parent is None  # noqa: SLF001
     endpoint = EndPointTest(get_workspace_id, config_setup, get_sqlite_cache)
     assert endpoint.cache.parent == endpoint
 
@@ -138,7 +139,8 @@ def test_encoder_json(model_data, tmp_path):
 
 
 @pytest.mark.unit
-def test_max_length(model_data, get_json_cache):
+def test_max_length(model_data, get_json_cache, tracker_object):
+    tracker_object.cache = get_json_cache
     get_json_cache.session.data = []
     assert get_json_cache.session.max_length == 10000  # noqa: PLR2004
     get_json_cache.session.max_length = 10
@@ -234,11 +236,11 @@ def test_query_tag_distict(model_data, tracker_object, faker, number):
 def test_query_parent(tmp_path):
     cache = JSONCache(Path(tmp_path))
 
-    with pytest.raises(ValueError, match="Cannot load cache without parent!"):
+    with pytest.raises(MissingParentError):
         cache.query()
 
 
-# FIX:: Flaky test that will fail occassionaly on windows testing.
+# FIX:: Flaky test that will fail occasionally on windows testing.
 @pytest.mark.unit
 @pytest.mark.flaky(rerun_except="AssertionError", reruns=3)
 def test_cache_sync(

tests/test_meta/test_cache.py

@@ -10,7 +10,7 @@
 from sqlalchemy.orm import Query, Session
 
 from toggl_api.meta import RequestMethod
-from toggl_api.meta.cache.base_cache import Comparison, TogglQuery
+from toggl_api.meta.cache.base_cache import Comparison, MissingParentError, TogglQuery
 from toggl_api.meta.cache.sqlite_cache import SqliteCache
 from toggl_api.models import TogglTag, TogglTracker, TogglWorkspace
 from toggl_api.models._decorators import UTCDateTime  # noqa: PLC2701
@@ -101,7 +101,7 @@ def test_add_entries_sqlite_parent(meta_object_sqlite, model_data):
     tracker = model_data["tracker"]
     meta_object_sqlite.cache.add_entries(tracker)
     meta_object_sqlite.cache.parent = None
-    with pytest.raises(ValueError, match="Cannot load cache without parent set!"):
+    with pytest.raises(MissingParentError):
         assert tracker in meta_object_sqlite.cache.load_cache()
 
 
@@ -135,7 +135,7 @@ def test_find_sqlite(meta_object_sqlite, model_data):
 @pytest.mark.unit
 def test_find_sqlite_parent(meta_object_sqlite):
     meta_object_sqlite.cache.parent = None
-    with pytest.raises(ValueError, match="Cannot load cache without parent set!"):
+    with pytest.raises(MissingParentError):
         meta_object_sqlite.cache.find_entry({"id": 5})
 
 
@@ -187,7 +187,7 @@ def test_query_sqlite(tracker_object_sqlite, model_data, faker):
     tracker_object_sqlite.cache.commit()
     assert tracker_object_sqlite.load_cache().count() == 11  # noqa: PLR2004
     assert tracker_object_sqlite.query(TogglQuery("name", tracker.name))[0] == tracker
-    assert tracker_object_sqlite.query(TogglQuery("name", list(picked_names))).count() == total_picks
+    assert tracker_object_sqlite.cache.query(TogglQuery("name", list(picked_names))).count() == total_picks
 
 
 @pytest.mark.unit
@@ -204,13 +204,13 @@ def test_query_sqlite_distinct(tracker_object_sqlite, model_data, faker):
         d["timestamp"] = datetime.now(timezone.utc)
         tracker_object_sqlite.save_cache(tracker.from_kwargs(**d), RequestMethod.GET)
 
-    assert tracker_object_sqlite.query(TogglQuery("name", name), distinct=True).count() == 1
+    assert tracker_object_sqlite.cache.query(TogglQuery("name", name), distinct=True).count() == 1
 
 
 @pytest.mark.unit
 def test_query_sqlite_parent(meta_object_sqlite):
     meta_object_sqlite.cache.parent = None
-    with pytest.raises(ValueError, match="Cannot load cache without parent set!"):
+    with pytest.raises(MissingParentError):
         meta_object_sqlite.cache.find_entry({"id": 5})