mpt-extension-sdk 4.0.1__tar.gz → 4.0.3__tar.gz

{mpt_extension_sdk-4.0.1 → mpt_extension_sdk-4.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mpt-extension-sdk
-Version: 4.0.1
+Version: 4.0.3
 Summary: Extensions SDK for SoftwareONE Marketplace Platform
 License: Apache-2.0
 Author: SoftwareOne AG

{mpt_extension_sdk-4.0.1 → mpt_extension_sdk-4.0.3}/mpt_extension_sdk/constants.py

@@ -2,5 +2,6 @@ EVENT_TYPES = "orders"
 SECURITY_ALGORITHM = "HS256"
 USER_AGENT = "swo-extensions/1.0"
 CONSUME_EVENTS_HELP_TEXT = "Consume events from the MPT platform"
-DEFAULT_APP_CONFIG_GROUP = "swo.mpt.ext"
+DEFAULT_APP_CONFIG_GROUP = "swo.mpt.sdk"
 DEFAULT_APP_CONFIG_NAME = "app_config"
+DJANGO_SETTINGS_MODULE = "mpt_extension_sdk.runtime.djapp.conf.default"

mpt_extension_sdk-4.0.3/mpt_extension_sdk/flows/context.py

@@ -0,0 +1,39 @@
+from dataclasses import asdict, dataclass
+
+ORDER_TYPE_PURCHASE = "Purchase"
+ORDER_TYPE_CHANGE = "Change"
+ORDER_TYPE_TERMINATION = "Termination"
+
+
+@dataclass
+class Context:
+    order: dict
+
+    @property
+    def order_id(self):
+        return self.order.get("id", None)
+
+    @property
+    def order_type(self):
+        return self.order.get("type", None)
+
+    @property
+    def product_id(self):
+        return self.order.get("product", {}).get("id", None)
+
+    def is_purchase_order(self):
+        return self.order["type"] == ORDER_TYPE_PURCHASE
+
+    def is_change_order(self):
+        return self.order["type"] == ORDER_TYPE_CHANGE
+
+    def is_termination_order(self):
+        return self.order["type"] == ORDER_TYPE_TERMINATION
+
+    @classmethod
+    def from_context(cls, context):
+        base_data = asdict(context)
+        return cls(**base_data)
+
+    def __str__(self):
+        return f"Context: {self.order.get("id", None)} {self.order.get("type", None)}"

mpt_extension_sdk-4.0.3/mpt_extension_sdk/flows/pipeline.py

@@ -0,0 +1,51 @@
+from abc import ABC, abstractmethod
+from typing import Callable
+
+from swo.mpt.client import MPTClient
+from swo.mpt.extensions.flows.context import Context
+
+NextStep = Callable[[MPTClient, Context], None]
+
+
+class Step(ABC):
+    @abstractmethod
+    def __call__(
+        self,
+        client: MPTClient,
+        context: Context,
+        next_step: NextStep,
+    ) -> None:
+        raise NotImplementedError()  # pragma: no cover
+
+
+def _default_error_handler(error: Exception, context: Context, next_step: NextStep):
+    raise error
+
+
+class Cursor:
+    def __init__(self, steps, error_handler):
+        self.queue = steps
+        self.error_handler = error_handler
+
+    def __call__(self, client: MPTClient, context: Context):
+        if not self.queue:
+            return
+        current_step = self.queue[0]
+        next_step = Cursor(self.queue[1:], self.error_handler)
+
+        try:
+            current_step(client, context, next_step)
+        except Exception as error:
+            self.error_handler(error, context, next_step)
+
+
+class Pipeline:
+    def __init__(self, *steps):
+        self.queue = steps
+
+    def run(self, client: MPTClient, context: Context, error_handler=None):
+        execute = Cursor(self.queue, error_handler or _default_error_handler)
+        return execute(client, context)
+
+    def __len__(self):
+        return len(self.queue)

{mpt_extension_sdk-4.0.1 → mpt_extension_sdk-4.0.3}/mpt_extension_sdk/mpt_http/mpt.py

@@ -367,3 +367,10 @@ def get_agreements_by_customer_deployments(
     url = f"/commerce/agreements?{rql_query}"
 
     return _paginated(mpt_client, url)
+
+
+@wrap_mpt_http_error
+def get_buyer(mpt_client, buyer_id):
+    response = mpt_client.get(f"/accounts/buyers/{buyer_id}")
+    response.raise_for_status()
+    return response.json()

mpt_extension_sdk-4.0.3/mpt_extension_sdk/mpt_http/utils.py

@@ -0,0 +1,2 @@
+def find_first(func, iterable, default=None):
+    return next(filter(func, iterable), default)

{mpt_extension_sdk-4.0.1 → mpt_extension_sdk-4.0.3}/mpt_extension_sdk/mpt_http/wrap_http_error.py

@@ -60,3 +60,9 @@ class ValidationError:
             "id": self.id,
             "message": self.message.format(**kwargs),
         }
+
+
+ERR_EXT_UNHANDLED_EXCEPTION = ValidationError(
+    "EXT001",
+    "Order can't be processed. Failure reason: {error}",
+)

{mpt_extension_sdk-4.0.1 → mpt_extension_sdk-4.0.3}/mpt_extension_sdk/runtime/events/producers.py

@@ -43,6 +43,10 @@ class EventProducer(ABC):
     def produce_events(self):
         pass
 
+    @abstractmethod
+    def produce_events_with_context(self):
+        pass
+
 
 class OrderEventProducer(EventProducer):
     def __init__(self, dispatcher):
@@ -57,13 +61,24 @@ class OrderEventProducer(EventProducer):
                 for order in orders:
                     self.dispatcher.dispatch_event(Event(order["id"], "orders", order))
 
+    def produce_events_with_context(self):
+        while self.running:
+            with self.sleep(settings.MPT_ORDERS_API_POLLING_INTERVAL_SECS):
+                orders = self.get_processing_orders()
+                orders, contexts = self.filter_and_enrich(self.client, orders)
+                logger.info(f"{len(orders)} orders found for processing...")
+                for order, context in zip(orders, contexts):
+                    self.dispatcher.dispatch_event(
+                        Event(order["id"], "orders", order, context)
+                    )
+
     def get_processing_orders(self):
         products = ",".join(settings.MPT_PRODUCTS_IDS)
         orders = []
         rql_query = f"and(in(agreement.product.id,({products})),eq(status,processing))"
         url = (
-            f"/commerce/orders?{rql_query}"
-            "&select=audit,parameters,lines,subscriptions,subscriptions.lines&order=audit.created.at"
+            f"/commerce/orders?{rql_query}&select=audit,parameters,lines,subscriptions,"
+            f"subscriptions.lines,agreement,buyer&order=audit.created.at"
         )
         page = None
         limit = 10

{mpt_extension_sdk-4.0.1 → mpt_extension_sdk-4.0.3}/mpt_extension_sdk/runtime/events/utils.py

@@ -12,6 +12,8 @@ from opentelemetry.instrumentation.requests import RequestsInstrumentor
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import BatchSpanProcessor
 
+from mpt_extension_sdk.flows.context import Context
+
 logger = logging.getLogger(__name__)
 
 
@@ -68,3 +70,16 @@ def wrap_for_trace(func, event_type):  # pragma: no cover
             logger.exception("Unhandled exception!")
 
     return opentelemetry_wrapper if settings.USE_APPLICATIONINSIGHTS else wrapper
+
+
+def setup_contexts(mpt_client, orders):
+    """
+    List of contexts from orders
+    Args:
+        mpt_client (MPTClient): MPT client
+        orders (list): List of orders
+
+    Returns: List of contexts
+
+    """
+    return [Context(order=order) for order in orders]

{mpt_extension_sdk-4.0.1 → mpt_extension_sdk-4.0.3}/mpt_extension_sdk/runtime/initializer.py

@@ -3,6 +3,11 @@ import os
 import rich
 from rich.theme import Theme
 
+from mpt_extension_sdk.constants import (
+    DEFAULT_APP_CONFIG_GROUP,
+    DEFAULT_APP_CONFIG_NAME,
+    DJANGO_SETTINGS_MODULE,
+)
 from mpt_extension_sdk.runtime.djapp.conf import extract_product_ids
 from mpt_extension_sdk.runtime.events.utils import instrument_logging
 from mpt_extension_sdk.runtime.utils import (
@@ -21,10 +26,12 @@ JSON_EXT_VARIABLES = {
 
 def initialize(options):
     rich.reconfigure(theme=Theme({"repr.mpt_id": "bold light_salmon3"}))
-
-    os.environ.setdefault(
-        "DJANGO_SETTINGS_MODULE", "mpt_extension_sdk.runtime.djapp.conf.default"
+    group = options.get("app_config_group", DEFAULT_APP_CONFIG_GROUP)
+    name = options.get("app_config_name", DEFAULT_APP_CONFIG_NAME)
+    django_settings_module = options.get(
+        "django_settings_module", DJANGO_SETTINGS_MODULE
     )
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", django_settings_module)
     import django
     from django.conf import settings
 
@@ -36,7 +43,7 @@ def initialize(options):
 
     logging_level = "DEBUG" if options.get("debug") else "INFO"
 
-    app_config_name = get_extension_app_config_name()
+    app_config_name = get_extension_app_config_name(group=group, name=name)
     app_root_module, _ = app_config_name.split(".", 1)
     settings.DEBUG = options.get("debug", False)
     settings.INSTALLED_APPS.append(app_config_name)

{mpt_extension_sdk-4.0.1 → mpt_extension_sdk-4.0.3}/mpt_extension_sdk/runtime/utils.py

@@ -14,17 +14,19 @@ from mpt_extension_sdk.constants import (
 )
 
 
-def get_extension_app_config_name():
+def get_extension_app_config_name(
+    group=DEFAULT_APP_CONFIG_GROUP, name=DEFAULT_APP_CONFIG_NAME
+):
     eps = entry_points()
-    (app_config_ep,) = eps.select(
-        group=DEFAULT_APP_CONFIG_GROUP, name=DEFAULT_APP_CONFIG_NAME
-    )
+    (app_config_ep,) = eps.select(group=group, name=name)
     app_config = app_config_ep.load()
     return f"{app_config.__module__}.{app_config.__name__}"
 
 
-def get_extension_app_config():
-    app_config_name = get_extension_app_config_name()
+def get_extension_app_config(
+    group=DEFAULT_APP_CONFIG_GROUP, name=DEFAULT_APP_CONFIG_NAME
+):
+    app_config_name = get_extension_app_config_name(group=group, name=name)
     return next(
         filter(
             lambda app: app_config_name
@@ -35,12 +37,12 @@ def get_extension_app_config():
     )
 
 
-def get_extension():
-    return get_extension_app_config().extension
+def get_extension(group=DEFAULT_APP_CONFIG_GROUP, name=DEFAULT_APP_CONFIG_NAME):
+    return get_extension_app_config(group=group, name=name).extension
 
 
-def get_events_registry():
-    return get_extension().events
+def get_events_registry(group=DEFAULT_APP_CONFIG_GROUP, name=DEFAULT_APP_CONFIG_NAME):
+    return get_extension(group=group, name=name).events
 
 
 def gradient(start_hex, end_hex, num_samples=10):  # pragma: no cover

{mpt_extension_sdk-4.0.1 → mpt_extension_sdk-4.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mpt-extension-sdk"
-version = "4.0.1"
+version = "4.0.3"
 description = "Extensions SDK for SoftwareONE Marketplace Platform"
 authors = ["SoftwareOne AG"]
 readme = "README.md"
@@ -58,7 +58,7 @@ types-requests = "2.31.*"
 swoext = 'mpt_extension_sdk.runtime.swoext:main'
 
 
-[tool.poetry.plugins."swo.mpt.ext"]
+[tool.poetry.plugins."swo.mpt.sdk"]
 "app_config" = "mpt_extension_sdk.runtime.djapp.apps:ExtensionConfig"