mpt-extension-sdk 4.0.2__py3-none-any.whl → 4.0.3__py3-none-any.whl

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/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/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/mpt_http/utils.py

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

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/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/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/runtime/initializer.py

@@ -28,10 +28,10 @@ def initialize(options):
     rich.reconfigure(theme=Theme({"repr.mpt_id": "bold light_salmon3"}))
     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
+    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
 

mpt_extension_sdk/runtime/utils.py

@@ -15,8 +15,7 @@ from mpt_extension_sdk.constants import (
 
 
 def get_extension_app_config_name(
-    group=DEFAULT_APP_CONFIG_GROUP,
-    name=DEFAULT_APP_CONFIG_NAME
+    group=DEFAULT_APP_CONFIG_GROUP, name=DEFAULT_APP_CONFIG_NAME
 ):
     eps = entry_points()
     (app_config_ep,) = eps.select(group=group, name=name)
@@ -25,8 +24,7 @@ def get_extension_app_config_name(
 
 
 def get_extension_app_config(
-    group=DEFAULT_APP_CONFIG_GROUP,
-    name=DEFAULT_APP_CONFIG_NAME
+    group=DEFAULT_APP_CONFIG_GROUP, name=DEFAULT_APP_CONFIG_NAME
 ):
     app_config_name = get_extension_app_config_name(group=group, name=name)
     return next(
@@ -39,17 +37,11 @@ def get_extension_app_config(
     )
 
 
-def get_extension(
-    group=DEFAULT_APP_CONFIG_GROUP,
-    name=DEFAULT_APP_CONFIG_NAME
-):
+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(
-    group=DEFAULT_APP_CONFIG_GROUP,
-    name=DEFAULT_APP_CONFIG_NAME
-):
+def get_events_registry(group=DEFAULT_APP_CONFIG_GROUP, name=DEFAULT_APP_CONFIG_NAME):
     return get_extension(group=group, name=name).events
 
 

{mpt_extension_sdk-4.0.2.dist-info → mpt_extension_sdk-4.0.3.dist-info}/METADATA

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

{mpt_extension_sdk-4.0.2.dist-info → mpt_extension_sdk-4.0.3.dist-info}/RECORD

@@ -8,10 +8,14 @@ mpt_extension_sdk/core/events/registry.py,sha256=RbiAem_FZk4W137xTILm0hRav46pII1
 mpt_extension_sdk/core/extension.py,sha256=s0QE2s99RMywfKQRZrYqOdWxELQvlFFVZMwm0xo2hhw,266
 mpt_extension_sdk/core/security.py,sha256=0eCed1cmaNK1rCpgnsN9zw6wzr4m_Qb9aKxscO0uyYk,1419
 mpt_extension_sdk/core/utils.py,sha256=LsvciwlVBJCBbd7L1rIWrTo_8Fi-W_SkL6IEezKUb4s,362
+mpt_extension_sdk/flows/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mpt_extension_sdk/flows/context.py,sha256=J_U9nTtY89mUvrcOqdgpk-21F8f6YENSmjxgpVK6XWs,964
+mpt_extension_sdk/flows/pipeline.py,sha256=XOzxl2vRYr7TL3-XVuGvhOpQAvIC-9snsiseaaFHldc,1358
 mpt_extension_sdk/mpt_http/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mpt_extension_sdk/mpt_http/base.py,sha256=3qgo9BW-uTRAbex26urMvLZU0fwnYnBprDRIJCHvTOk,1284
-mpt_extension_sdk/mpt_http/mpt.py,sha256=m5lHhNFaMtx65FO8vnxucGPE-19QUl4SFLi8YjdckmE,10399
-mpt_extension_sdk/mpt_http/wrap_http_error.py,sha256=3VHYkyxmufaApWDuY0Sm9qAiXbJb3VWG4ZaR2yuguQQ,1679
+mpt_extension_sdk/mpt_http/mpt.py,sha256=FatFnbAgyV42N2hJ14n09-WE3V1ioL-lYxuid6vd4Wo,10580
+mpt_extension_sdk/mpt_http/utils.py,sha256=3wJTT84CXYGjZw6FksNDX8tIHijkL3Wcmld9r6Iz0xc,95
+mpt_extension_sdk/mpt_http/wrap_http_error.py,sha256=j8K6Ddx7NiM-FPRMQi25vuULAW8LXxzZ4EwuIJufxis,1801
 mpt_extension_sdk/runtime/__init__.py,sha256=PQSAz9qvXHbxrn4KvuXSHB8y-A4Jpgbm6ZV-wPiNPyw,194
 mpt_extension_sdk/runtime/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mpt_extension_sdk/runtime/commands/django.py,sha256=VHszc3KctzSkhewAqbQMkRBG7cuMPWxzn7dHrRGm8y8,892
@@ -26,16 +30,16 @@ mpt_extension_sdk/runtime/djapp/management/commands/consume_events.py,sha256=r5a
 mpt_extension_sdk/runtime/djapp/middleware.py,sha256=MES6-bK64pX1B1XGXC3nGPzPSld6xrQfmF1vYQv2Eeg,535
 mpt_extension_sdk/runtime/events/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mpt_extension_sdk/runtime/events/dispatcher.py,sha256=GYICBuA9bO38TgDk0FKS_Z9D-8YB-tmNf4O_pUxuomc,2801
-mpt_extension_sdk/runtime/events/producers.py,sha256=8nCbw2hZVkxdabpmSorYqskuYEuZuRzdHYjTb0cHuwc,2895
-mpt_extension_sdk/runtime/events/utils.py,sha256=L2g3iiSJY1uNwuwLNWtuYHUjSBj4nArZIdr4DCNWHVU,2342
-mpt_extension_sdk/runtime/initializer.py,sha256=ICqmenLmrBnn39AVQNJ0IOzIpcXch1eh1wItCbv5-I8,2229
+mpt_extension_sdk/runtime/events/producers.py,sha256=EiR3MgwEw6Z5cwMh4xBo9JBsd4oSEYi0U1iNYNxK7P4,3551
+mpt_extension_sdk/runtime/events/utils.py,sha256=bxFo-iQUqEJDqcIotC88Ty3Xt0K2FyYjA9UMWFEyMKI,2663
+mpt_extension_sdk/runtime/initializer.py,sha256=3gX9OAeTp2lsgsP0h3HVzkEUvCTa9fBIsBGVo7E6JFY,2229
 mpt_extension_sdk/runtime/logging.py,sha256=wJ6KyvnuvMZELI1Hd0fYbuHr7YiP3GIXFBvvSdmd7nQ,885
 mpt_extension_sdk/runtime/master.py,sha256=oBI3WHpf2YkTRsRyT1SFIyvCM7gGQpbtXvI1lYe6-jg,4390
 mpt_extension_sdk/runtime/swoext.py,sha256=LS0YZXwQsHDaYjalDGfYQi5cAL3aKQhphf3chrNmNBk,1665
-mpt_extension_sdk/runtime/utils.py,sha256=-AoA9I51FLiy3HlrFhVFv1pWnb7RTCOVlarXYPFvhsg,3393
+mpt_extension_sdk/runtime/utils.py,sha256=ZnRWIBwYzOerx30KFmBXLUe19qzwE4JFNkNMGVqjuyk,3365
 mpt_extension_sdk/runtime/workers.py,sha256=k25jFlh-NdHVqeMV2AgoC6IHIlbRHcDoRB5xqWwMPFg,2411
-mpt_extension_sdk-4.0.2.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-mpt_extension_sdk-4.0.2.dist-info/METADATA,sha256=7Ss3RyL_nENYcUfIrHIRtJv0dUIpgRsSDVpjWT7v9vo,1563
-mpt_extension_sdk-4.0.2.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-mpt_extension_sdk-4.0.2.dist-info/entry_points.txt,sha256=8uZQihFseK4Kp5XWHl9EDYneg-CLS8BFO-ygp0h34nc,143
-mpt_extension_sdk-4.0.2.dist-info/RECORD,,
+mpt_extension_sdk-4.0.3.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+mpt_extension_sdk-4.0.3.dist-info/METADATA,sha256=nM1_7QslDTSmFMecQxaJG4S1Ygvy3qg1VddDQnz4PSI,1563
+mpt_extension_sdk-4.0.3.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+mpt_extension_sdk-4.0.3.dist-info/entry_points.txt,sha256=8uZQihFseK4Kp5XWHl9EDYneg-CLS8BFO-ygp0h34nc,143
+mpt_extension_sdk-4.0.3.dist-info/RECORD,,