Extract Create and Delete mixins as Agreements can't be created or deleted

Author: albertsola

mpt_api_client/http/async_service.py

@@ -78,17 +78,6 @@ async def iterate(self, batch_size: int = 100) -> AsyncIterator[Model]:
                 break
             offset = items_collection.meta.pagination.next_offset()
 
-    async def create(self, resource_data: ResourceData) -> Model:
-        """Create a new resource using `POST /endpoint`.
-
-        Returns:
-            New resource created.
-        """
-        response = await self.http_client.post(self._endpoint, json=resource_data)
-        response.raise_for_status()
-
-        return self._model_class.from_response(response)
-
     async def get(self, resource_id: str, select: list[str] | str | None = None) -> Model:
         """Fetch a specific resource using `GET /endpoint/{resource_id}`.
 
@@ -116,16 +105,6 @@ async def update(self, resource_id: str, resource_data: ResourceData) -> Model:
         """
         return await self._resource_action(resource_id, "PUT", json=resource_data)
 
-    async def delete(self, resource_id: str) -> None:
-        """Delete resource using `DELETE /endpoint/{resource_id}`.
-
-        Args:
-            resource_id: Resource ID.
-        """
-        url = urljoin(f"{self._endpoint}/", resource_id)
-        response = await self.http_client.delete(url)
-        response.raise_for_status()
-
     async def _fetch_page_as_response(self, limit: int = 100, offset: int = 0) -> httpx.Response:
         """Fetch one page of resources.
 
@@ -193,3 +172,32 @@ async def _resource_action(
             resource_id, method, action, json=json, query_params=query_params
         )
         return self._model_class.from_response(response)
+
+
+class AsyncCreateMixin[Model: BaseModel](AsyncService[Model]):
+    """Create resource mixin."""
+
+    async def create(self, resource_data: ResourceData) -> Model:
+        """Create a new resource using `POST /endpoint`.
+
+        Returns:
+            New resource created.
+        """
+        response = await self.http_client.post(self._endpoint, json=resource_data)
+        response.raise_for_status()
+
+        return self._model_class.from_response(response)
+
+
+class AsyncDeleteMixin[Model: BaseModel](AsyncService[Model]):
+    """Delete resource mixin."""
+
+    async def delete(self, resource_id: str) -> None:
+        """Delete resource using `DELETE /endpoint/{resource_id}`.
+
+        Args:
+            resource_id: Resource ID.
+        """
+        url = urljoin(f"{self._endpoint}/", resource_id)
+        response = await self.http_client.delete(url)
+        response.raise_for_status()

mpt_api_client/http/service.py

@@ -77,17 +77,6 @@ def iterate(self, batch_size: int = 100) -> Iterator[Model]:
                 break
             offset = items_collection.meta.pagination.next_offset()
 
-    def create(self, resource_data: ResourceData) -> Model:
-        """Create a new resource using `POST /endpoint`.
-
-        Returns:
-            New resource created.
-        """
-        response = self.http_client.post(self._endpoint, json=resource_data)
-        response.raise_for_status()
-
-        return self._model_class.from_response(response)
-
     def get(self, resource_id: str, select: list[str] | str | None = None) -> Model:
         """Fetch a specific resource using `GET /endpoint/{resource_id}`.
 
@@ -116,15 +105,6 @@ def update(self, resource_id: str, resource_data: ResourceData) -> Model:
         """
         return self._resource_action(resource_id, "PUT", json=resource_data)
 
-    def delete(self, resource_id: str) -> None:
-        """Delete resource using `DELETE /endpoint/{resource_id}`.
-
-        Args:
-            resource_id: Resource ID.
-        """
-        response = self._resource_do_request(resource_id, "DELETE")
-        response.raise_for_status()
-
     def _fetch_page_as_response(self, limit: int = 100, offset: int = 0) -> httpx.Response:
         """Fetch one page of resources.
 
@@ -192,3 +172,31 @@ def _resource_action(
             resource_id, method, action, json=json, query_params=query_params
         )
         return self._model_class.from_response(response)
+
+
+class CreateMixin[Model: BaseModel](Service[Model]):
+    """Create resource mixin."""
+
+    def create(self, resource_data: ResourceData) -> Model:
+        """Create a new resource using `POST /endpoint`.
+
+        Returns:
+            New resource created.
+        """
+        response = self.http_client.post(self._endpoint, json=resource_data)
+        response.raise_for_status()
+
+        return self._model_class.from_response(response)
+
+
+class DeleteMixin[Model: BaseModel](Service[Model]):
+    """Delete resource mixin."""
+
+    def delete(self, resource_id: str) -> None:
+        """Delete resource using `DELETE /endpoint/{resource_id}`.
+
+        Args:
+            resource_id: Resource ID.
+        """
+        response = self._resource_do_request(resource_id, "DELETE")
+        response.raise_for_status()

mpt_api_client/resources/commerce/orders.py

@@ -1,4 +1,6 @@
 from mpt_api_client.http import AsyncService, Service
+from mpt_api_client.http.async_service import AsyncCreateMixin, AsyncDeleteMixin
+from mpt_api_client.http.service import CreateMixin, DeleteMixin
 from mpt_api_client.models import Model, ResourceData
 
 
@@ -14,7 +16,12 @@ class OrdersServiceConfig:
     _collection_key = "data"
 
 
-class OrdersService(Service[Order], OrdersServiceConfig):
+class OrdersService(  # noqa: WPS215
+    CreateMixin[Order],
+    DeleteMixin[Order],
+    Service[Order],
+    OrdersServiceConfig,
+):
     """Orders service."""
 
     def validate(self, resource_id: str, resource_data: ResourceData | None = None) -> Order:
@@ -84,7 +91,12 @@ def template(self, resource_id: str) -> str:
         return response.text
 
 
-class AsyncOrdersService(AsyncService[Order], OrdersServiceConfig):
+class AsyncOrdersService(  # noqa: WPS215
+    AsyncCreateMixin[Order],
+    AsyncDeleteMixin[Order],
+    AsyncService[Order],
+    OrdersServiceConfig,
+):
     """Async Orders service."""
 
     async def validate(self, resource_id: str, resource_data: ResourceData | None = None) -> Order:

tests/http/conftest.py

@@ -2,17 +2,25 @@
 import pytest
 
 from mpt_api_client import RQLQuery
-from mpt_api_client.http.async_service import AsyncService
-from mpt_api_client.http.service import Service
+from mpt_api_client.http.async_service import AsyncCreateMixin, AsyncDeleteMixin, AsyncService
+from mpt_api_client.http.service import CreateMixin, DeleteMixin, Service
 from tests.conftest import DummyModel
 
 
-class DummyService(Service[DummyModel]):
+class DummyService(
+    CreateMixin[DummyModel],
+    DeleteMixin[DummyModel],
+    Service[DummyModel],
+):
     _endpoint = "/api/v1/test"
     _model_class = DummyModel
 
 
-class AsyncDummyService(AsyncService[DummyModel]):
+class AsyncDummyService(
+    AsyncCreateMixin[DummyModel],
+    AsyncDeleteMixin[DummyModel],
+    AsyncService[DummyModel],
+):
     _endpoint = "/api/v1/test"
     _model_class = DummyModel
 

tests/http/test_async_service.py

@@ -8,6 +8,39 @@
 from tests.http.conftest import AsyncDummyService
 
 
+async def test_async_create_mixin(async_dummy_service):  # noqa: WPS210
+    resource_data = {"name": "Test Resource", "status": "active"}
+    new_resource_data = {"id": "new-resource-id", "name": "Test Resource", "status": "active"}
+    create_response = httpx.Response(httpx.codes.OK, json=new_resource_data)
+
+    with respx.mock:
+        mock_route = respx.post("https://api.example.com/api/v1/test").mock(
+            return_value=create_response
+        )
+
+        created_resource = await async_dummy_service.create(resource_data)
+
+    assert created_resource.to_dict() == new_resource_data
+    assert mock_route.call_count == 1
+    request = mock_route.calls[0].request
+    assert request.method == "POST"
+    assert request.url == "https://api.example.com/api/v1/test"
+    assert json.loads(request.content.decode()) == resource_data
+
+
+async def test_async_delete_mixin(async_dummy_service):  # noqa: WPS210
+    delete_response = httpx.Response(httpx.codes.NO_CONTENT, json=None)
+
+    with respx.mock:
+        mock_route = respx.delete("https://api.example.com/api/v1/test/RES-123").mock(
+            return_value=delete_response
+        )
+
+        await async_dummy_service.delete("RES-123")
+
+    assert mock_route.call_count == 1
+
+
 async def test_async_fetch_one_success(async_dummy_service, single_result_response):
     with respx.mock:
         mock_route = respx.get("https://api.example.com/api/v1/test").mock(
@@ -244,39 +277,6 @@ async def test_async_iterate_lazy_evaluation(async_dummy_service):
         assert mock_route.call_count == 1
 
 
-async def test_async_create_resource(async_dummy_service):  # noqa: WPS210
-    resource_data = {"name": "Test Resource", "status": "active"}
-    new_resource_data = {"id": "new-resource-id", "name": "Test Resource", "status": "active"}
-    create_response = httpx.Response(httpx.codes.OK, json=new_resource_data)
-
-    with respx.mock:
-        mock_route = respx.post("https://api.example.com/api/v1/test").mock(
-            return_value=create_response
-        )
-
-        created_resource = await async_dummy_service.create(resource_data)
-
-    assert created_resource.to_dict() == new_resource_data
-    assert mock_route.call_count == 1
-    request = mock_route.calls[0].request
-    assert request.method == "POST"
-    assert request.url == "https://api.example.com/api/v1/test"
-    assert json.loads(request.content.decode()) == resource_data
-
-
-async def test_async_delete_resource(async_dummy_service):  # noqa: WPS210
-    delete_response = httpx.Response(httpx.codes.NO_CONTENT, json=None)
-
-    with respx.mock:
-        mock_route = respx.delete("https://api.example.com/api/v1/test/RES-123").mock(
-            return_value=delete_response
-        )
-
-        await async_dummy_service.delete("RES-123")
-
-    assert mock_route.call_count == 1
-
-
 async def test_async_update_resource(async_dummy_service):  # noqa: WPS210
     resource_data = {"name": "Test Resource", "status": "active"}
     update_response = httpx.Response(httpx.codes.OK, json=resource_data)

tests/http/test_service.py

@@ -9,6 +9,38 @@
 from tests.http.conftest import DummyService
 
 
+def test_sync_create_mixin(dummy_service):  # noqa: WPS210
+    resource_data = {"name": "Test Resource", "status": "active"}
+    new_resource_data = {"id": "new-resource-id", "name": "Test Resource", "status": "active"}
+    create_response = httpx.Response(httpx.codes.OK, json=new_resource_data)
+
+    with respx.mock:
+        mock_route = respx.post("https://api.example.com/api/v1/test").mock(
+            return_value=create_response
+        )
+
+        created_resource = dummy_service.create(resource_data)
+
+    assert created_resource.to_dict() == new_resource_data
+    assert mock_route.call_count == 1
+    request = mock_route.calls[0].request
+    assert request.method == "POST"
+    assert request.url == "https://api.example.com/api/v1/test"
+    assert json.loads(request.content.decode()) == resource_data
+
+
+def test_sync_delete_mixin(dummy_service):
+    delete_response = httpx.Response(httpx.codes.NO_CONTENT, json=None)
+    with respx.mock:
+        mock_route = respx.delete("https://api.example.com/api/v1/test/RES-123").mock(
+            return_value=delete_response
+        )
+
+        dummy_service.delete("RES-123")
+
+    assert mock_route.call_count == 1
+
+
 def test_sync_fetch_one_success(dummy_service, single_result_response):
     with respx.mock:
         mock_route = respx.get("https://api.example.com/api/v1/test").mock(
@@ -266,38 +298,6 @@ def test_sync_iterate_handles_api_errors(dummy_service):
             list(iterator)
 
 
-def test_sync_create_resource(dummy_service):  # noqa: WPS210
-    resource_data = {"name": "Test Resource", "status": "active"}
-    new_resource_data = {"id": "new-resource-id", "name": "Test Resource", "status": "active"}
-    create_response = httpx.Response(httpx.codes.OK, json=new_resource_data)
-
-    with respx.mock:
-        mock_route = respx.post("https://api.example.com/api/v1/test").mock(
-            return_value=create_response
-        )
-
-        created_resource = dummy_service.create(resource_data)
-
-    assert created_resource.to_dict() == new_resource_data
-    assert mock_route.call_count == 1
-    request = mock_route.calls[0].request
-    assert request.method == "POST"
-    assert request.url == "https://api.example.com/api/v1/test"
-    assert json.loads(request.content.decode()) == resource_data
-
-
-def test_sync_delete_resource(dummy_service):
-    delete_response = httpx.Response(httpx.codes.NO_CONTENT, json=None)
-    with respx.mock:
-        mock_route = respx.delete("https://api.example.com/api/v1/test/RES-123").mock(
-            return_value=delete_response
-        )
-
-        dummy_service.delete("RES-123")
-
-    assert mock_route.call_count == 1
-
-
 def test_sync_update_resource(dummy_service):
     resource_data = {"name": "Test Resource", "status": "active"}
     update_response = httpx.Response(httpx.codes.OK, json=resource_data)