Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion mpt_api_client/http/__init__.py
Original file line number Diff line number Diff line change
@@ -1,16 +1,25 @@
from mpt_api_client.http.async_client import AsyncHTTPClient
from mpt_api_client.http.async_service import AsyncService
from mpt_api_client.http.client import HTTPClient
from mpt_api_client.http.mixins import AsyncCreateMixin, AsyncDeleteMixin, CreateMixin, DeleteMixin
from mpt_api_client.http.mixins import (
AsyncCreateMixin,
AsyncDeleteMixin,
AsyncUpdateMixin,
CreateMixin,
DeleteMixin,
UpdateMixin,
)
from mpt_api_client.http.service import Service

__all__ = [ # noqa: WPS410
"AsyncCreateMixin",
"AsyncDeleteMixin",
"AsyncHTTPClient",
"AsyncService",
"AsyncUpdateMixin",
"CreateMixin",
"DeleteMixin",
"HTTPClient",
"Service",
"UpdateMixin",
]
186 changes: 186 additions & 0 deletions mpt_api_client/resources/commerce/mixins.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
import httpx

from mpt_api_client.models import ResourceData


class ValidateMixin[BaseModel]:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One question... Do you really need all of the these action-based mixins here? I mean, it make sense when you are trying to share some functionality, like update/create/etc. But for specific actions for orders - what's the reason to have it as mixin per cada action?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Orders and Requests have the same actions.

Orders: "get", "create", "update", "delete", "validate", "process", "query", "complete", "fail" and "template"
Requests: "get", "create", "update", "delete", "validate", "process", "query", "complete" and "template" (missing fail)

"""Validate mixin."""

def validate(self, resource_id: str, resource_data: ResourceData | None = None) -> BaseModel:
"""Switch order to validate state.

Args:
resource_id: Order resource ID
resource_data: Order data will be updated
"""
return self._resource_action(resource_id, "POST", "validate", json=resource_data) # type: ignore[attr-defined, no-any-return]


class ProcessMixin[BaseModel]:
"""Process mixin."""

def process(self, resource_id: str, resource_data: ResourceData | None = None) -> BaseModel:
"""Switch order to process state.

Args:
resource_id: Order resource ID
resource_data: Order data will be updated
"""
return self._resource_action(resource_id, "POST", "process", json=resource_data) # type: ignore[attr-defined, no-any-return]


class QueryMixin[BaseModel]:
"""Query mixin."""

def query(self, resource_id: str, resource_data: ResourceData | None = None) -> BaseModel:
"""Switch order to query state.

Args:
resource_id: Order resource ID
resource_data: Order data will be updated
"""
return self._resource_action(resource_id, "POST", "query", json=resource_data) # type: ignore[attr-defined, no-any-return]


class CompleteMixin[BaseModel]:
"""Complete mixin."""

def complete(self, resource_id: str, resource_data: ResourceData | None = None) -> BaseModel:
"""Switch order to complete state.

Args:
resource_id: Order resource ID
resource_data: Order data will be updated
"""
return self._resource_action(resource_id, "POST", "complete", json=resource_data) # type: ignore[attr-defined, no-any-return]


class FailMixin[BaseModel]:
"""Fail mixin."""

def fail(self, resource_id: str, resource_data: ResourceData | None = None) -> BaseModel:
"""Switch order to fail state.

Args:
resource_id: Order resource ID
resource_data: Order data will be updated
"""
return self._resource_action(resource_id, "POST", "fail", json=resource_data) # type: ignore[attr-defined, no-any-return]


class TemplateMixin:
"""Template mixin."""

def template(self, resource_id: str) -> str:
"""Render order template.

Args:
resource_id: Order resource ID

Returns:
Order template text in markdown format.
"""
response: httpx.Response = self._resource_do_request(resource_id, "GET", "template") # type: ignore[attr-defined]
return response.text


class AsyncValidateMixin[BaseModel]:
"""Async Validate Mixin."""

async def validate(
self, resource_id: str, resource_data: ResourceData | None = None
) -> BaseModel:
"""Switch order to validate state.

Args:
resource_id: Order resource ID
resource_data: Order data will be updated

Returns:
Updated order resource
"""
return await self._resource_action(resource_id, "POST", "validate", json=resource_data) # type: ignore[attr-defined, no-any-return]


class AsyncProcessMixin[BaseModel]:
"""Async Process Mixin."""

async def process(
self, resource_id: str, resource_data: ResourceData | None = None
) -> BaseModel:
"""Switch order to process state.

Args:
resource_id: Order resource ID
resource_data: Order data will be updated

Returns:
Updated order resource
"""
return await self._resource_action(resource_id, "POST", "process", json=resource_data) # type: ignore[attr-defined, no-any-return]


class AsyncQueryMixin[BaseModel]:
"""Async Query Mixin."""

async def query(self, resource_id: str, resource_data: ResourceData | None = None) -> BaseModel:
"""Switch order to query state.

Args:
resource_id: Order resource ID
resource_data: Order data will be updated

Returns:
Updated order resource
"""
return await self._resource_action(resource_id, "POST", "query", json=resource_data) # type: ignore[attr-defined, no-any-return]


class AsyncCompleteMixin[BaseModel]:
"""Async Complete Mixin."""

async def complete(
self, resource_id: str, resource_data: ResourceData | None = None
) -> BaseModel:
"""Switch order to complete state.

Args:
resource_id: Order resource ID
resource_data: Order data will be updated

Returns:
Updated order resource
"""
return await self._resource_action(resource_id, "POST", "complete", json=resource_data) # type: ignore[attr-defined, no-any-return]


class AsyncFailMixin[BaseModel]:
"""Async Fail Mixin."""

async def fail(self, resource_id: str, resource_data: ResourceData | None = None) -> BaseModel:
"""Switch order to fail state.

Args:
resource_id: Order resource ID
resource_data: Order data will be updated

Returns:
Updated order resource
"""
return await self._resource_action(resource_id, "POST", "fail", json=resource_data) # type: ignore[attr-defined, no-any-return]


class AsyncTemplateMixin:
"""Async Template Mixin."""

async def template(self, resource_id: str) -> str:
"""Render order template.

Args:
resource_id: Order resource ID

Returns:
Order template text in markdown format.
"""
response: httpx.Response = await self._resource_do_request(resource_id, "GET", "template") # type: ignore[attr-defined]
return response.text
Loading