Added create and update with icon mixin and updated product

Author: Robert Segal

mpt_api_client/constants.py

@@ -0,0 +1 @@
+APPLICATION_JSON = "application/json"

mpt_api_client/http/mixins.py

@@ -3,6 +3,7 @@
 from typing import Self
 from urllib.parse import urljoin
 
+from mpt_api_client.constants import APPLICATION_JSON
 from mpt_api_client.http.query_state import QueryState
 from mpt_api_client.http.types import FileTypes, Response
 from mpt_api_client.models import Collection, FileModel, ResourceData
@@ -84,7 +85,7 @@ def create(
             files[data_key] = (
                 None,
                 _json_to_file_payload(resource_data),
-                "application/json",
+                APPLICATION_JSON,
             )
         response = self.http_client.request("post", self.path, files=files)  # type: ignore[attr-defined]
 
@@ -105,6 +106,77 @@ def download(self, resource_id: str) -> FileModel:
         return FileModel(response)
 
 
+class CreateWithIconMixin[Model]:
+    """Create resource with icon mixin."""
+
+    def create(
+        self,
+        resource_data: ResourceData,
+        icon: FileTypes,
+        data_key: str,
+        icon_key: str,
+    ) -> Model:
+        """Create resource with icon.
+
+        Args:
+            resource_data: Resource data.
+            data_key: Key for the resource data.
+            icon: Icon image in jpg, png, GIF, etc.
+            icon_key: Key for the icon.
+
+        Returns:
+            Created resource.
+        """
+        files: dict[str, FileTypes] = {}
+        files[data_key] = (
+            None,
+            json.dumps(resource_data),
+            APPLICATION_JSON,
+        )
+        files[icon_key] = icon
+        response = self.http_client.request("post", self.path, files=files)  # type: ignore[attr-defined]
+
+        return self._model_class.from_response(response)  # type: ignore[attr-defined, no-any-return]
+
+
+class UpdateWithIconMixin[Model]:
+    """Update resource with icon mixin."""
+
+    def update(
+        self,
+        resource_id: str,
+        resource_data: ResourceData,
+        icon: FileTypes,
+        data_key: str,
+        icon_key: str,
+    ) -> Model:
+        """Update resource with icon.
+
+        Args:
+            resource_id: Resource ID.
+            resource_data: Resource data.
+            data_key: Key for the resource data.
+            icon: Icon image in jpg, png, GIF, etc.
+            icon_key: Key for the icon.
+
+        Returns:
+            Updated resource.
+        """
+        files: dict[str, FileTypes] = {}
+        files[data_key] = (
+            None,
+            json.dumps(resource_data),
+            APPLICATION_JSON,
+        )
+        files[icon_key] = icon
+
+        url = urljoin(f"{self.path}/", resource_id)  # type: ignore[attr-defined]
+
+        response = self.http_client.request("put", url, files=files)  # type: ignore[attr-defined]
+
+        return self._model_class.from_response(response)  # type: ignore[attr-defined, no-any-return]
+
+
 class AsyncCreateMixin[Model]:
     """Create resource mixin."""
 
@@ -174,7 +246,7 @@ async def create(
             files[data_key] = (
                 None,
                 _json_to_file_payload(resource_data),
-                "application/json",
+                APPLICATION_JSON,
             )
 
         response = await self.http_client.request("post", self.path, files=files)  # type: ignore[attr-defined]
@@ -196,6 +268,77 @@ async def download(self, resource_id: str) -> FileModel:
         return FileModel(response)
 
 
+class AsyncCreateWithIconMixin[Model]:
+    """Create resource with icon mixin."""
+
+    async def create(
+        self,
+        resource_data: ResourceData,
+        icon: FileTypes,
+        data_key: str,
+        icon_key: str,
+    ) -> Model:
+        """Create resource with icon.
+
+        Args:
+            resource_data: Resource data.
+            data_key: Key for the resource data.
+            icon: Icon image in jpg, png, GIF, etc.
+            icon_key: Key for the icon.
+
+        Returns:
+            Created resource.
+        """
+        files: dict[str, FileTypes] = {}
+        files[data_key] = (
+            None,
+            json.dumps(resource_data),
+            APPLICATION_JSON,
+        )
+        files[icon_key] = icon
+        response = await self.http_client.request("post", self.path, files=files)  # type: ignore[attr-defined]
+
+        return self._model_class.from_response(response)  # type: ignore[attr-defined, no-any-return]
+
+
+class AsyncUpdateWithIconMixin[Model]:
+    """Update resource with icon mixin."""
+
+    async def update(
+        self,
+        resource_id: str,
+        resource_data: ResourceData,
+        icon: FileTypes,
+        data_key: str,
+        icon_key: str,
+    ) -> Model:
+        """Update resource with icon.
+
+        Args:
+            resource_id: Resource ID.
+            resource_data: Resource data.
+            data_key: Key for the resource data.
+            icon: Icon image in jpg, png, GIF, etc.
+            icon_key: Key for the icon.
+
+        Returns:
+            Updated resource.
+        """
+        files: dict[str, FileTypes] = {}
+        files[data_key] = (
+            None,
+            json.dumps(resource_data),
+            APPLICATION_JSON,
+        )
+        files[icon_key] = icon
+
+        url = urljoin(f"{self.path}/", resource_id)  # type: ignore[attr-defined]
+
+        response = await self.http_client.request("put", url, files=files)  # type: ignore[attr-defined]
+
+        return self._model_class.from_response(response)  # type: ignore[attr-defined, no-any-return]
+
+
 class GetMixin[Model]:
     """Get resource mixin."""
 

mpt_api_client/resources/catalog/products.py

@@ -1,11 +1,17 @@
-import json
+from typing import override
 
 from mpt_api_client.http import AsyncService, Service
 from mpt_api_client.http.mixins import (
     AsyncCollectionMixin,
-    AsyncModifiableResourceMixin,
+    AsyncCreateWithIconMixin,
+    AsyncDeleteMixin,
+    AsyncGetMixin,
+    AsyncUpdateWithIconMixin,
     CollectionMixin,
-    ModifiableResourceMixin,
+    CreateWithIconMixin,
+    DeleteMixin,
+    GetMixin,
+    UpdateWithIconMixin,
 )
 from mpt_api_client.http.types import FileTypes
 from mpt_api_client.models import Model, ResourceData
@@ -56,38 +62,71 @@ class ProductsServiceConfig:
 
 
 class ProductsService(
+    CreateWithIconMixin[Product],
+    UpdateWithIconMixin[Product],
     PublishableMixin[Product],
-    ModifiableResourceMixin[Product],
+    GetMixin[Product],
+    DeleteMixin,
     CollectionMixin[Product],
     Service[Product],
     ProductsServiceConfig,
 ):
     """Products service."""
 
+    @override
     def create(
         self,
         resource_data: ResourceData,
         icon: FileTypes,
+        data_key: str = "product",
+        icon_key: str = "icon",
     ) -> Product:
         """Create product with icon.
 
         Args:
             resource_data: Product data.
             icon: Icon image in jpg, png, GIF, etc.
+            data_key: Key for the product data.
+            icon_key: Key for the icon.
 
         Returns:
             Created resource.
         """
-        files: dict[str, FileTypes] = {}
-        files["product"] = (
-            None,
-            json.dumps(resource_data),
-            "application/json",
+        return super().create(
+            resource_data=resource_data,
+            icon=icon,
+            data_key=data_key,
+            icon_key=icon_key,
         )
-        files["icon"] = icon
-        response = self.http_client.request("post", self.path, files=files)
 
-        return self._model_class.from_response(response)
+    @override
+    def update(
+        self,
+        resource_id: str,
+        resource_data: ResourceData,
+        icon: FileTypes,
+        data_key: str = "product",
+        icon_key: str = "icon",
+    ) -> Product:
+        """Update product with icon.
+
+        Args:
+            resource_id: Product ID.
+            resource_data: Product data.
+            icon: Icon image in jpg, png, GIF, etc.
+            data_key: Key for the product data.
+            icon_key: Key for the icon.
+
+        Returns:
+            Updated resource.
+        """
+        return super().update(
+            resource_id=resource_id,
+            resource_data=resource_data,
+            icon=icon,
+            data_key=data_key,
+            icon_key=icon_key,
+        )
 
     def item_groups(self, product_id: str) -> ItemGroupsService:
         """Return item_groups service."""
@@ -135,37 +174,71 @@ def update_settings(self, product_id: str, settings: ResourceData) -> Product:
 
 
 class AsyncProductsService(
+    AsyncCreateWithIconMixin[Product],
+    AsyncUpdateWithIconMixin[Product],
     AsyncPublishableMixin[Product],
-    AsyncModifiableResourceMixin[Product],
+    AsyncGetMixin[Product],
+    AsyncDeleteMixin,
     AsyncCollectionMixin[Product],
     AsyncService[Product],
     ProductsServiceConfig,
 ):
     """Products service."""
 
+    @override
     async def create(
         self,
         resource_data: ResourceData,
         icon: FileTypes,
+        data_key: str = "product",
+        icon_key: str = "icon",
     ) -> Product:
         """Create product with icon.
 
         Args:
             resource_data: Product data.
             icon: Icon image in jpg, png, GIF, etc.
+            data_key: Key for the product data.
+            icon_key: Key for the icon.
 
         Returns:
             Created resource.
         """
-        files: dict[str, FileTypes] = {}
-        files["product"] = (
-            None,
-            json.dumps(resource_data),
-            "application/json",
-        )
-        files["icon"] = icon
-        response = await self.http_client.request("post", self.path, files=files)
-        return self._model_class.from_response(response)
+        return await super().create(
+            resource_data=resource_data,
+            data_key=data_key,
+            icon=icon,
+            icon_key=icon_key,
+        )
+
+    @override
+    async def update(
+        self,
+        resource_id: str,
+        resource_data: ResourceData,
+        icon: FileTypes,
+        data_key: str = "product",
+        icon_key: str = "icon",
+    ) -> Product:
+        """Update product with icon.
+
+        Args:
+            resource_id: Product ID.
+            resource_data: Product data.
+            icon: Icon image in jpg, png, GIF, etc.
+            data_key: Key for the product data.
+            icon_key: Key for the icon.
+
+        Returns:
+            Updated resource.
+        """
+        return await super().update(
+            resource_id=resource_id,
+            resource_data=resource_data,
+            data_key=data_key,
+            icon=icon,
+            icon_key=icon_key,
+        )
 
     def item_groups(self, product_id: str) -> AsyncItemGroupsService:
         """Return item_groups service."""

seed/catalog/product.py

@@ -48,7 +48,10 @@ async def init_product(
         logger.debug("Creating product ...")
         with pathlib.Path.open(icon, "rb") as icon_file:
             product = await mpt_vendor.catalog.products.create(
-                {"name": "E2E Seeded", "website": "https://www.example.com"}, icon=icon_file
+                {"name": "E2E Seeded", "website": "https://www.example.com"},
+                data_key="product",
+                icon=icon_file,
+                icon_key="icon",
             )
             context.set_resource(namespace, product)
             context[f"{namespace}.id"] = product.id