mpt-extension-sdk 4.0.6__tar.gz → 4.1.1__tar.gz

{mpt_extension_sdk-4.0.6 → mpt_extension_sdk-4.1.1}/PKG-INFO

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

{mpt_extension_sdk-4.0.6 → mpt_extension_sdk-4.1.1}/mpt_extension_sdk/key_vault/base.py

@@ -74,7 +74,7 @@ class KeyVault(Session):
             )
             return None
 
-    def _get_key_vault_url(self, key_vault_name: str):
+    def _get_key_vault_url(self, key_vault_name: str):  # pragma: no cover
         """
         Construct the Key Vault URL using the provided Key Vault name.
 
@@ -88,7 +88,7 @@ class KeyVault(Session):
         # Construct the Key Vault URL
         return f"https://{key_vault_name}.vault.azure.net/"
 
-    def _get_key_vault_client(self, key_vault_name: str):
+    def _get_key_vault_client(self, key_vault_name: str):  # pragma: no cover
         """
         Create a Key Vault client using the provided Key Vault URL and secret name.
 

{mpt_extension_sdk-4.0.6 → mpt_extension_sdk-4.1.1}/mpt_extension_sdk/mpt_http/mpt.py

@@ -1,13 +1,18 @@
 import logging
 from datetime import date
+from enum import Enum
 from functools import cache
+from itertools import batched
 
 from django.conf import settings
 
+from mpt_extension_sdk.mpt_http.base import MPTClient
 from mpt_extension_sdk.mpt_http.wrap_http_error import wrap_mpt_http_error
 
 logger = logging.getLogger(__name__)
 
+NotifyCategories = Enum("NotifyCategories", settings.MPT_NOTIFY_CATEGORIES)
+
 
 def _has_more_pages(page):
     if not page:
@@ -16,10 +21,9 @@ def _has_more_pages(page):
     return pagination["total"] > pagination["limit"] + pagination["offset"]
 
 
-def _paginated(mpt_client, url):
+def _paginated(mpt_client, url, limit=10):
     items = []
     page = None
-    limit = 10
     offset = 0
     while _has_more_pages(page):
         response = mpt_client.get(f"{url}&limit={limit}&offset={offset}")
@@ -374,3 +378,56 @@ def get_buyer(mpt_client, buyer_id):
     response = mpt_client.get(f"/accounts/buyers/{buyer_id}")
     response.raise_for_status()
     return response.json()
+
+
+@wrap_mpt_http_error
+def notify(
+    mpt_client: MPTClient,
+    category_id: str,
+    account_id: str,
+    buyer_id: str,
+    subject: str,
+    message_body: str,
+    limit: int = 1000,
+):
+    """
+    Sends notifications to multiple recipients in batches for a specific buyer and
+    category through the MPTClient service. The function retrieves recipients,
+    groups them into manageable batches, and sends notifications using the provided
+    message details.
+
+    Args:
+        mpt_client (MPTClient): Client object for interacting with MPT service.
+        category_id (str): Identifier for the category of recipients or messages.
+        account_id (str): Identifier for the associated account.
+        buyer_id (str): Identifier for the buyer related to the notification.
+        subject (str): Subject/title of the notification to be sent.
+        message_body (str): Content/body of the notification message.
+        limit (int): Maximum number of recipients to process per batch. Defaults
+            to 1000.
+
+    Returns:
+        None
+    """
+    recipients = _paginated(
+        mpt_client,
+        url=(
+            f"notifications/accounts/{account_id}/categories/{category_id}/contacts?"
+            f"select=id,-email,-name,-status,-user&"
+            f"filter(group.buyers.id,{buyer_id})"
+        ),
+        limit=limit,
+    )
+
+    for contacts in batched(recipients, limit):
+        response = mpt_client.post(
+            "notifications/batches",
+            json={
+                "category": {"id": category_id},
+                "subject": subject,
+                "body": message_body,
+                "contacts": contacts,
+                "buyer": {"id": buyer_id},
+            },
+        )
+        response.raise_for_status()

{mpt_extension_sdk-4.0.6 → mpt_extension_sdk-4.1.1}/mpt_extension_sdk/runtime/djapp/conf/default.py

@@ -10,6 +10,7 @@ For the full list of settings and their values, see
 https://docs.djangoproject.com/en/4.2/ref/settings/
 """
 
+import json
 import os
 from pathlib import Path
 
@@ -25,12 +26,6 @@ BASE_DIR = Path(__file__).resolve().parent.parent
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
 
-# SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = os.getenv(
-    "MPT_DJANGO_SECRET_KEY",
-    "django-insecure-6r_%9ku+bg0=@xw1ah$wh+liwbsyhwpn#6alt*ppjn8t_uyp-u",
-)
-
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
 
@@ -213,6 +208,11 @@ MPT_ORDERS_API_POLLING_INTERVAL_SECS = int(
     os.getenv("MPT_ORDERS_API_POLLING_INTERVAL_SECS", "120")
 )
 
+# TODO: Should be synced with the initializer.py::initialize function
+MPT_NOTIFY_CATEGORIES = json.loads(
+    os.getenv("MPT_NOTIFY_CATEGORIES", '{"ORDERS": "NTC-0000-0006"}')
+)
+
 EXTENSION_CONFIG = {
     "DUE_DATE_DAYS": "30",
 }

{mpt_extension_sdk-4.0.6 → mpt_extension_sdk-4.1.1}/mpt_extension_sdk/runtime/djapp/management/commands/consume_events.py

@@ -8,7 +8,7 @@ from mpt_extension_sdk.runtime.events.dispatcher import Dispatcher
 from mpt_extension_sdk.runtime.events.producers import OrderEventProducer
 
 
-class Command(BaseCommand):
+class Command(BaseCommand):  # pragma: no cover
     help = CONSUME_EVENTS_HELP_TEXT
     producer_classes = [
         OrderEventProducer,

{mpt_extension_sdk-4.0.6 → mpt_extension_sdk-4.1.1}/mpt_extension_sdk/runtime/djapp/middleware.py

@@ -5,7 +5,7 @@ from mpt_extension_sdk.mpt_http.base import MPTClient
 _CLIENT = None
 
 
-class MPTClientMiddleware:
+class MPTClientMiddleware:  # pragma: no cover
     def __init__(self, get_response):
         self.get_response = get_response
 

{mpt_extension_sdk-4.0.6 → mpt_extension_sdk-4.1.1}/mpt_extension_sdk/runtime/events/producers.py

@@ -32,7 +32,7 @@ class EventProducer(ABC):
         self.producer.join()
 
     @contextmanager
-    def sleep(self, secs, interval=0.5):
+    def sleep(self, secs, interval=0.5):  # pragma: no cover
         yield
         sleeped = 0
         while sleeped < secs and self.running_event.is_set():
@@ -61,7 +61,7 @@ class OrderEventProducer(EventProducer):
                 for order in orders:
                     self.dispatcher.dispatch_event(Event(order["id"], "orders", order))
 
-    def produce_events_with_context(self):
+    def produce_events_with_context(self):  # pragma: no cover
         while self.running:
             with self.sleep(settings.MPT_ORDERS_API_POLLING_INTERVAL_SECS):
                 orders = self.get_processing_orders()
@@ -89,7 +89,6 @@ class OrderEventProducer(EventProducer):
             except requests.RequestException:
                 logger.exception("Cannot retrieve orders")
                 return []
-
             if response.status_code == 200:
                 page = response.json()
                 orders.extend(page["data"])

{mpt_extension_sdk-4.0.6 → mpt_extension_sdk-4.1.1}/mpt_extension_sdk/runtime/master.py

@@ -79,7 +79,7 @@ class Master:
         self.workers[worker_type] = p
         logger.info(f"{worker_type.capitalize()} worker pid: {p.pid}")
 
-    def monitor_processes(self):
+    def monitor_processes(self):  # pragma: no cover
         while self.monitor_event.is_set():
             exited_workers = []
             for worker_type, p in self.workers.items():
@@ -112,16 +112,16 @@ class Master:
         self.stop()
         self.start()
 
-    def __iter__(self):
+    def __iter__(self):  # pragma: no cover
         return self
 
-    def __next__(self):
+    def __next__(self):  # pragma: no cover
         changes = next(self.watcher)
         if changes:
             return list({Path(c[1]) for c in changes})
         return None
 
-    def run(self):
+    def run(self):  # pragma: no cover
         self.start()
         if self.options.get("reload"):
             for files_changed in self:

{mpt_extension_sdk-4.0.6 → mpt_extension_sdk-4.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mpt-extension-sdk"
-version = "4.0.6"
+version = "4.1.1"
 description = "Extensions SDK for SoftwareONE Marketplace Platform"
 authors = ["SoftwareOne AG"]
 readme = "README.md"