shopware-api-client 1.0.0__tar.gz

shopware_api_client-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 GWS Gesellschaft für Warenwirtschafts-Systeme mbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

shopware_api_client-1.0.0/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.1
+Name: shopware-api-client
+Version: 1.0.0
+Summary:  An api client for the Shopware API
+Home-page: https://github.com/GWS-mbH
+License: MIT
+Keywords: shopware,api,client
+Author: GWS Gesellschaft für Warenwirtschafts-Systeme mbH
+Author-email: ebusiness@gws.ms
+Requires-Python: >=3.12,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: httpx (>=0.26,<0.27)
+Requires-Dist: httpx-auth (>=0.21,<0.22)
+Requires-Dist: pydantic (>=2.6,<3.0)
+Requires-Dist: pytest-random-order (>=1.1.1,<2.0.0)
+Project-URL: Bugtracker, https://github.com/GWS-mbH/shopware-api-client/issues
+Project-URL: Changelog, https://github.com/GWS-mbH/shopware-api-client
+Project-URL: Documentation, https://github.com/GWS-mbH/shopware-api-client/wiki
+Project-URL: Repository, https://github.com/GWS-mbH/shopware-api-client
+Description-Content-Type: text/markdown
+
+# Shopware API Client
+
+An api client for the Shopware API
+

shopware_api_client-1.0.0/README.md

@@ -0,0 +1,3 @@
+# Shopware API Client
+
+An api client for the Shopware API

shopware_api_client-1.0.0/pyproject.toml

@@ -0,0 +1,60 @@
+[tool.poetry]
+name = "shopware-api-client"
+description = " An api client for the Shopware API"
+version = "1.0.0"
+license = "MIT"
+authors = ["GWS Gesellschaft für Warenwirtschafts-Systeme mbH <ebusiness@gws.ms>"]
+readme = "README.md"
+homepage = "https://github.com/GWS-mbH"
+repository = "https://github.com/GWS-mbH/shopware-api-client"
+documentation = "https://github.com/GWS-mbH/shopware-api-client/wiki"
+keywords = ["shopware", "api", "client"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[tool.poetry.urls]
+Changelog = "https://github.com/GWS-mbH/shopware-api-client"
+Bugtracker = "https://github.com/GWS-mbH/shopware-api-client/issues"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+httpx = "^0.26"
+httpx-auth = "^0.21"
+pydantic = "^2.6"
+pytest-random-order = "^1.1.1"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "^1.8.0"
+pytest = "^8.0.2"
+coverage = "^7.4.0"
+pytest-cov = "^4.1.0"
+ruff = "^0.2.0"
+pytest-asyncio = "^0.23.3"
+pytest-recording = "^0.13.1"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.mypy]
+python_version = "3.12"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+strict_optional = true
+
+[tool.pytest.ini_options]
+python_files = ["test_*.py", "*_test.py"]
+filterwarnings = ["ignore::DeprecationWarning"]
+asyncio_mode = "auto"
+addopts = [
+    "--rootdir=./test",
+    "--cov-branch",
+    "--cov=src",
+    "--cov-report=xml",
+    "--import-mode=importlib",
+    "--random-order",
+]

shopware_api_client-1.0.0/src/shopware_api_client/base.py

@@ -0,0 +1,464 @@
+import json
+from typing import Any, AsyncGenerator, Generic, Self, Type, TypeVar, overload
+
+import httpx
+from pydantic import BaseModel
+
+from .endpoints.base_fields import IdField
+from .exceptions import SWAPIError, SWFilterException, SWNoClientProvided
+from .logging import logger
+
+EndpointClass = TypeVar("EndpointClass", bound="EndpointBase[Any]")
+ModelClass = TypeVar("ModelClass", bound="ApiModelBase[Any]")
+
+
+class ConfigBase:
+    def __init__(self, url: str):
+        self.url = url.rstrip("/")
+
+
+class ClientBase:
+    api_url: str
+    raw: bool
+
+    def __init__(self, config: ConfigBase, raw: bool = False):
+        self.api_url = config.url
+        self.raw = raw
+
+    async def __aenter__(self) -> "Self":
+        self._get_client()
+        return self
+
+    async def __aexit__(self, *args: Any) -> None:
+        await self._get_client().aclose()
+
+    async def log_request(self, request: httpx.Request) -> None:
+        logger.debug(f"Request: {request.method} {request.url} - {request.content!r} <headers: {request.headers}>")
+
+    async def log_response(self, response: httpx.Response) -> None:
+        await response.aread()
+        logger.debug(
+            f"Response: {response.status_code} - {response.status_code} - {response.content!r} "
+            f"<headers: {response.headers}>"
+        )
+
+    def _get_client(self) -> httpx.AsyncClient:
+        raise NotImplementedError()
+
+    @staticmethod
+    def _get_headers() -> dict[str, str]:
+        return {"Content-Type": "application/json", "Accept": "application/vnd.api+json"}
+
+    async def _make_request(self, method: str, relative_url: str, **kwargs: Any) -> httpx.Response:
+        if relative_url.startswith("http://") or relative_url.startswith("https://"):
+            url = relative_url
+        else:
+            url = f"{self.api_url}{relative_url}"
+        client = self._get_client()
+
+        headers = self._get_headers()
+        headers.update(kwargs.pop("headers", {}))
+
+        response = await client.request(method, url, headers=headers, **kwargs)
+
+        if response.status_code >= 400:
+            try:
+                raise SWAPIError(response.json().get("errors"))
+            except json.JSONDecodeError:
+                raise SWAPIError(f"Status: {response.status_code}: {response.text}")
+
+        return response
+
+    async def get(self, relative_url: str, **kwargs: Any) -> httpx.Response:
+        return await self._make_request(method="GET", relative_url=relative_url, **kwargs)
+
+    async def post(self, relative_url: str, **kwargs: Any) -> httpx.Response:
+        # we need to set a response type, otherwise we don't get one
+        relative_url += "?_response=basic"
+        return await self._make_request(method="POST", relative_url=relative_url, **kwargs)
+
+    async def patch(self, relative_url: str, **kwargs: Any) -> httpx.Response:
+        # we need to set a reponse type, otherwise we don't get one
+        relative_url += "?_response=basic"
+        return await self._make_request(method="PATCH", relative_url=relative_url, **kwargs)
+
+    async def delete(self, relative_url: str, **kwargs: Any) -> httpx.Response:
+        return await self._make_request(method="DELETE", relative_url=relative_url, **kwargs)
+
+    async def close(self) -> None:
+        await self._get_client().aclose()
+
+
+class ApiModelBase(BaseModel, Generic[EndpointClass]):
+    _identifier: str
+
+    id: IdField | None
+
+    def __init__(self, client: ClientBase | None = None, **kwargs: dict[str, Any]) -> None:
+        super().__init__(**kwargs)
+        self._client = client
+
+    @classmethod
+    def using(cls: type[Self], client: ClientBase) -> EndpointClass:
+        # we want a fresh endpoint
+        endpoint: EndpointClass = getattr(client, cls._identifier.get_default()).__class__(client)  # type: ignore
+        return endpoint
+
+    def _get_client(self) -> ClientBase:
+        if self._client is None:
+            raise SWNoClientProvided("Model has no api client set. Use `using` to set a client.")
+        return self._client
+
+    def _get_endpoint(self) -> EndpointClass:
+        # we want a fresh endpoint
+        endpoint: EndpointClass = getattr(self._get_client(), self._identifier).__class__(self._get_client())  # type: ignore
+        return endpoint
+
+    async def save(self) -> Self | dict:
+        endpoint = self._get_endpoint()
+
+        if self.id is None:
+            result = await endpoint.create(obj=self)
+        else:
+            result = await endpoint.update(pk=self.id, obj=self)
+
+        return result
+
+    async def delete(self) -> bool:
+        endpoint = self._get_endpoint()
+
+        # without id we can't delete
+        if self.id is None:
+            return False
+
+        return await endpoint.delete(pk=self.id)
+
+
+class EndpointBase(Generic[ModelClass]):
+    name: str
+    path: str
+    model_class: Type[ModelClass]
+    raw: bool
+
+    def __init__(self, client: ClientBase):
+        self.client = client
+        self.raw = client.raw
+        self._filter: list[dict[str, Any]] = []
+        self._limit: int | None = None
+        self._sort: list[dict[str, Any]] = []
+
+    def _is_search_query(self) -> bool:
+        return len(self._filter) > 0 or len(self._sort) > 0
+
+    def _get_data_dict(self) -> dict[str, Any]:
+        data: dict[str, Any] = {}
+
+        if len(self._filter) > 0:
+            data["filter"] = self._filter
+
+        if len(self._sort) > 0:
+            data["sort"] = self._sort
+
+        if self._limit is not None:
+            data["limit"] = self._limit
+
+        return data
+
+    def _reset_endpoint(self) -> None:
+        self._filter = []
+        self._limit = None
+        self._sort = []
+
+    @overload
+    def _parse_response(self, data: list[dict[str, Any]]) -> list[ModelClass]:
+        pass
+
+    @overload
+    def _parse_response(self, data: dict[str, Any]) -> ModelClass:
+        pass
+
+    def _parse_response(self, data: list[dict[str, Any]] | dict[str, Any]) -> list[ModelClass] | ModelClass:
+        single = False
+
+        if isinstance(data, dict):
+            single = True
+            data = [data]
+
+        result_list: list[ModelClass] = []
+
+        for entry in data:
+            api_type = entry.get("type", None)
+
+            if api_type is None:
+                model_class = self.model_class
+            else:
+                model_class = getattr(self.client, api_type).model_class
+
+            if "attributes" in entry:
+                obj = model_class(client=self.client, id=entry["id"], **entry["attributes"])
+            else:
+                obj = model_class(client=self.client, **entry)
+
+            result_list.append(obj)
+
+        if single:
+            return result_list[0]
+
+        return result_list
+
+    def _parse_data(self, response_dict: dict[str, Any]) -> list[dict[str, Any]]:
+        if "data" in response_dict:
+            key = "data"
+        elif "elements" in response_dict:
+            key = "elements"
+        else:
+            key = None
+
+        data: list[dict[str, Any]] | dict[str, Any] = response_dict[key] if key else response_dict
+
+        if isinstance(data, dict):
+            return [data]
+
+        return data
+
+    def _prase_data_single(self, reponse_dict: dict[str, Any]) -> dict[str, Any]:
+        return self._parse_data(reponse_dict)[0]
+
+    async def all(self) -> list[ModelClass] | list[dict[str, Any]]:
+        data = self._get_data_dict()
+
+        if self._is_search_query():
+            result = await self.client.post(f"/search{self.path}", json=data)
+        else:
+            result = await self.client.get(f"{self.path}", params=data)
+
+        result_data: list[dict[str, Any]] = self._parse_data(result.json())
+
+        self._reset_endpoint()
+
+        if self.raw:
+            return result_data
+
+        return self._parse_response(result_data)
+
+    async def get(self, pk: str) -> ModelClass | dict[str, Any]:
+        result = await self.client.get(f"{self.path}/{pk}")
+        result_data: dict[str, Any] = self._prase_data_single(result.json())
+
+        if self.raw:
+            return result_data
+
+        return self._parse_response(result_data)
+
+    async def update(self, pk: str, obj: ModelClass | dict[str, Any]) -> ModelClass | dict[str, Any]:
+        if isinstance(obj, ApiModelBase):
+            data = obj.model_dump_json(by_alias=True)
+        else:
+            data = json.dumps(obj)
+
+        result = await self.client.patch(f"{self.path}/{pk}", data=data)
+        result_data: dict[str, Any] = self._prase_data_single(result.json())
+
+        if self.raw:
+            return result_data
+
+        return self._parse_response(result_data)
+
+    async def first(self) -> ModelClass | dict[str, Any] | None:
+        self._limit = 1
+        result = await self.all()
+
+        self._reset_endpoint()
+
+        # return None instead of an KeyError, if result is empty
+        if len(result) == 0:
+            return None
+
+        return result[0]
+
+    async def create(self, obj: ModelClass | dict[str, Any]) -> ModelClass | dict[str, Any]:
+        if isinstance(obj, ApiModelBase):
+            data = obj.model_dump_json(by_alias=True)
+        else:
+            data = json.dumps(obj)
+
+        result = await self.client.post(f"{self.path}", data=data)
+        result_data: dict[str, Any] = self._prase_data_single(result.json())
+
+        if self.raw:
+            return result_data
+
+        return self._parse_response(result_data)
+
+    async def delete(self, pk: str) -> bool:
+        response = await self.client.delete(f"{self.path}/{pk}")
+
+        if response.status_code == 204:
+            return True
+
+        return False
+
+    async def get_related(self, parent: ModelClass, relation: str) -> list[ModelClass] | list[dict[str, Any]]:
+        parent_endpoint = parent._get_endpoint()
+        result = await self.client.get(f"{parent_endpoint.path}/{parent.id}/{relation}")
+        result_data: list[dict[str, Any]] = self._parse_data(result.json())
+
+        if self.raw:
+            return result_data
+
+        return self._parse_response(result_data)
+
+    def filter(self, **kwargs: str) -> Self:
+        for key, value in kwargs.items():
+            filter_term = ""
+            filter_type = "equals"
+
+            field_parts = key.split("__")
+
+            if len(field_parts) > 1:
+                filter_term = field_parts[-1]
+
+                match filter_term:
+                    case "in":
+                        filter_type = "equalsAny"
+                    case "contains":
+                        filter_type = "contains"
+                    case "gt":
+                        filter_type = "range"
+                    case "gte":
+                        filter_type = "range"
+                    case "lt":
+                        filter_type = "range"
+                    case "lte":
+                        filter_type = "range"
+                    case "range":
+                        filter_type = "range"
+                    case "startswith":
+                        filter_type = "prefix"
+                    case "endswith":
+                        filter_type = "suffix"
+                    case _:
+                        filter_term = ""
+
+            if field_parts[0] not in self.model_class.model_fields:
+                raise SWFilterException(
+                    f"Unknown Field: {field_parts[0]}. Available fields: {self.model_class.model_fields.keys()}"
+                )
+
+            if filter_term != "":
+                field_parts = field_parts[:-1]
+
+            # Todo: Maybe add filter over related attributes
+            if len(field_parts) >= 2:
+                field = "%s.%s" % (
+                    self.model_class.model_fields[field_parts[0]].alias or field_parts[0],
+                    ".".join(field_parts[1:]),
+                )
+            else:
+                field = self.model_class.model_fields[field_parts[0]].alias or field_parts[0]
+
+            parameters = {}
+
+            # range has additional parameters
+            if filter_type == "range":
+                if filter_term == "range":
+                    parameters = {"gte": value[0], "lte": value[1]}
+                else:
+                    parameters = {filter_term: value}
+
+            self._filter.append({"type": filter_type, "field": field, "value": value, "parameters": parameters})
+
+        return self
+
+    async def bulk_upsert(
+        self, objs: list[ModelClass] | list[dict[str, Any]], **request_kwargs: dict[str, Any]
+    ) -> dict[str, Any] | None:
+        obj_list: list[dict] = []
+
+        for obj in objs:
+            if isinstance(obj, ApiModelBase):
+                obj_list.append(obj.model_dump(by_alias=True, mode="json"))
+            else:
+                obj_list.append(obj)
+
+        data = {f"write-{self.name}": {"entity": self.name, "action": "upsert", "payload": obj_list}}
+
+        response = await self.client.post("/_action/sync", json=data, timeout=600, **request_kwargs)
+        result: dict[str, Any] = response.json()
+
+        return result
+
+    async def bulk_delete(
+        self, objs: list[ModelClass] | list[dict[str, Any]], **request_kwargs: dict[str, Any]
+    ) -> dict[str, Any]:
+        obj_list: list[dict] = []
+
+        for obj in objs:
+            if isinstance(obj, ApiModelBase):
+                obj_list.append(obj.model_dump(by_alias=True, mode="json"))
+            else:
+                obj_list.append(obj)
+
+        data = {f"delete-{self.name}": {"entity": self.name, "action": "delete", "payload": obj_list}}
+
+        response = await self.client.post("/_action/sync", json=data, timeout=600, **request_kwargs)
+        result: dict[str, Any] = response.json()
+
+        return result
+
+    def limit(self, count: int | None) -> "Self":
+        self._limit = count
+        return self
+
+    def order_by(self, fields: str | tuple[str]) -> "Self":
+        if isinstance(fields, str):
+            fields = (fields,)
+
+        for field in fields:
+            if field.startswith("-"):
+                field = field[1:]
+                order = "DESC"
+            else:
+                order = "ASC"
+
+            if field not in self.model_class.model_fields:
+                raise SWFilterException(
+                    f"Unknown Field: {field}. Available fields: " f"{self.model_class.model_fields.keys()}"
+                )
+            else:
+                field = self.model_class.model_fields[field].alias or field
+
+            self._sort.append({"field": field, "order": order})
+
+        return self
+
+    async def iter(self, batch_size: int = 100) -> AsyncGenerator[ModelClass | dict[str, Any], None]:
+        self._limit = batch_size
+        data = self._get_data_dict()
+        page = 1
+
+        if self._is_search_query():
+            url = f"/search{self.path}"
+        else:
+            url = self.path
+
+        while True:
+            data["page"] = page
+            if self._is_search_query():
+                result = await self.client.post(url, json=data)
+            else:
+                result = await self.client.get(url, params=data)
+
+            result_dict: dict[str, Any] = result.json()
+            result_data: list[dict[str, Any]] = self._parse_data(result_dict)
+
+            for entry in result_data:
+                if self.raw:
+                    yield entry
+                else:
+                    yield self._parse_response(entry)
+
+            if "next" in result_dict.get("links", {}) and len(result_data) > 0:
+                page += 1
+            else:
+                break

shopware_api_client-1.0.0/src/shopware_api_client/client.py

@@ -0,0 +1,103 @@
+import httpx
+from httpx_auth import OAuth2ClientCredentials, OAuth2ResourceOwnerPasswordCredentials
+
+from .base import ApiModelBase, ClientBase, EndpointBase
+from .config import AdminConfig, StoreConfig
+from .exceptions import SWAPIConfigException
+
+
+class AdminClient(ClientBase):
+    def __init__(self, config: AdminConfig, raw: bool = False):
+        super().__init__(config, raw=raw)
+        self.config = config
+        self.api_url = f"{config.url}/api"
+        self._client: httpx.AsyncClient | None = None
+        registry.add_admin_endpoints(self)
+
+    def _get_client(self) -> httpx.AsyncClient:
+        if self._client is None:
+            self._client = httpx.AsyncClient(
+                event_hooks={"request": [self.log_request], "response": [self.log_response]}
+            )
+
+            auth_url = f"{self.api_url}/oauth/token"
+
+            if self.config.grant_type == "client_credentials":
+                if self.config.client_id is not None and self.config.client_secret is not None:
+                    self._client.auth = OAuth2ClientCredentials(
+                        token_url=auth_url, client_id=self.config.client_id, client_secret=self.config.client_secret
+                    )
+                else:
+                    raise SWAPIConfigException("Missing Client Credentials.")
+            elif self.config.grant_type == "password":
+                if self.config.username is not None and self.config.password is not None:
+                    self._client.auth = OAuth2ResourceOwnerPasswordCredentials(
+                        token_url=auth_url, username=self.config.username, password=self.config.password
+                    )
+                else:
+                    raise SWAPIConfigException("Missing Client Credentials.")
+            else:
+                raise SWAPIConfigException("Invalid grant_type for AdminClient.")
+
+        return self._client
+
+
+class StoreClient(ClientBase):
+    def __init__(self, config: StoreConfig, raw: bool = False):
+        super().__init__(config, raw=raw)
+        self.config = config
+        self.api_url = f"{config.url}/store-api"
+        self._client: httpx.AsyncClient | None = None
+        registry.add_store_endpoints(self)
+
+    def _get_client(self) -> httpx.AsyncClient:
+        if self._client is None:
+            self._client = httpx.AsyncClient(
+                event_hooks={"request": [self.log_request], "response": [self.log_response]},
+            )
+
+            headers = {
+                "sw-access-key": self.config.access_key,
+                "Accept": "application/json",
+                "Content-Type": "application/json",
+            }
+
+            if self.config.context_token is not None:
+                headers["sw-context-token"] = self.config.context_token
+
+            self._client.headers = httpx.Headers(headers)
+
+        return self._client
+
+
+class EndpointRegistry:
+    def __init__(self) -> None:
+        self.admin_endpoints: dict[str, type[EndpointBase]] = {}
+        self.store_endpoints: dict[str, type[EndpointBase]] = {}
+        self.admin_models: dict[str, type[ApiModelBase]] = {}
+        self.store_models: dict[str, type[ApiModelBase]] = {}
+
+    def register_admin(self, endpoint_class: type[EndpointBase]) -> None:
+        self.admin_endpoints[endpoint_class.name] = endpoint_class
+        self.admin_models[endpoint_class.model_class.__name__] = endpoint_class.model_class
+
+    def register_store(self, endpoint_class: type[EndpointBase]) -> None:
+        self.store_endpoints[endpoint_class.name] = endpoint_class
+        self.store_models[endpoint_class.model_class.__name__] = endpoint_class.model_class
+
+    def add_admin_endpoints(self, client: AdminClient) -> None:
+        for name, cls in self.admin_endpoints.items():
+            setattr(client, name, cls(client))
+
+    def get_admin_model(self, name: str) -> type[ApiModelBase]:
+        return self.admin_models[name]
+
+    def add_store_endpoints(self, client: StoreClient) -> None:
+        for name, cls in self.store_endpoints.items():
+            setattr(client, name, cls(client))
+
+    def get_store_model(self, name: str) -> type[ApiModelBase]:
+        return self.store_models[name]
+
+
+registry = EndpointRegistry()