ul-uspd-middleware-sdk 1.0.1__tar.gz

ul_uspd_middleware_sdk-1.0.1/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: ul_uspd_middleware_sdk
+Version: 1.0.1
+Summary: USPD middleware sdk
+Author: Unic-lab
+License: MIT
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.32.0
+Requires-Dist: ul-api-utils>=10.0.14
+Requires-Dist: ul-db-utils>=6.0.3
+Requires-Dist: ul-py-tool>=3.0.3
+Requires-Dist: ul-data-aggregator-sdk>=11.0.4
+Requires-Dist: loguru>=0.7.2
+Requires-Dist: tenacity>=9.0.0
+Provides-Extra: dev
+Requires-Dist: uv-script>=0.1.9; extra == "dev"
+
+# USPD Middleware SDK
+
+HTTP client and shared contracts for uspd-middleware integration.

ul_uspd_middleware_sdk-1.0.1/pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["setuptools>=80", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ul_uspd_middleware_sdk"
+version = "1.0.1"
+description = "USPD middleware sdk"
+readme = "uspd_middleware_sdk/README.md"
+license = { text = "MIT" }
+authors = [{ name = "Unic-lab" }]
+requires-python = ">=3.14"
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "requests>=2.32.0",
+    "ul-api-utils>=10.0.14",
+    "ul-db-utils>=6.0.3",
+    "ul-py-tool>=3.0.3",
+    "ul-data-aggregator-sdk>=11.0.4",
+    "loguru>=0.7.2",
+    "tenacity>=9.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "uv-script>=0.1.9",
+]
+
+[tool.setuptools.packages.find]
+include = ["uspd_middleware_sdk*"]
+
+[tool.setuptools.package-data]
+"*" = ["*.yml"]
+"uspd_middleware_sdk" = ["py.typed", "dag.yml"]
+
+[[tool.uv.index]]
+url = "https://pip-cache.dev-unic-lab.by/repository/pip-cache/simple"
+default = true
+
+[tool.uvs.scripts]
+prepare = "python3 -m build"
+lint = "ulpytool lint --ignore-setup-packages ul-unipipeline --exclude-import flask requests --py-files-ignore **/migrations/**/*.py --helmtemplatefiles-ignore .helm/**"
+test = "ulpytool test"
+setup = "uv sync --frozen --extra dev"
+setup-dev = "uv sync --frozen --extra dev && ulpytool install"
+version-major = "ulpytool major"
+version-minor = "ulpytool minor"
+version-patch = "ulpytool patch"

ul_uspd_middleware_sdk-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ul_uspd_middleware_sdk-1.0.1/ul_uspd_middleware_sdk.egg-info/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: ul_uspd_middleware_sdk
+Version: 1.0.1
+Summary: USPD middleware sdk
+Author: Unic-lab
+License: MIT
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.32.0
+Requires-Dist: ul-api-utils>=10.0.14
+Requires-Dist: ul-db-utils>=6.0.3
+Requires-Dist: ul-py-tool>=3.0.3
+Requires-Dist: ul-data-aggregator-sdk>=11.0.4
+Requires-Dist: loguru>=0.7.2
+Requires-Dist: tenacity>=9.0.0
+Provides-Extra: dev
+Requires-Dist: uv-script>=0.1.9; extra == "dev"
+
+# USPD Middleware SDK
+
+HTTP client and shared contracts for uspd-middleware integration.

ul_uspd_middleware_sdk-1.0.1/ul_uspd_middleware_sdk.egg-info/SOURCES.txt

@@ -0,0 +1,34 @@
+README.md
+pyproject.toml
+ul_uspd_middleware_sdk.egg-info/PKG-INFO
+ul_uspd_middleware_sdk.egg-info/SOURCES.txt
+ul_uspd_middleware_sdk.egg-info/dependency_links.txt
+ul_uspd_middleware_sdk.egg-info/requires.txt
+ul_uspd_middleware_sdk.egg-info/top_level.txt
+uspd_middleware_sdk/README.md
+uspd_middleware_sdk/__init__.py
+uspd_middleware_sdk/dag.yml
+uspd_middleware_sdk/errors.py
+uspd_middleware_sdk/lib.py
+uspd_middleware_sdk/py.typed
+uspd_middleware_sdk/runtime_conf.py
+uspd_middleware_sdk/uspd_middleware_api_sdk.py
+uspd_middleware_sdk/uspd_middleware_api_sdk_config.py
+uspd_middleware_sdk/uspd_middleware_sdk.py
+uspd_middleware_sdk/uspd_middleware_sdk_config.py
+uspd_middleware_sdk/__tests__/__init__.py
+uspd_middleware_sdk/__tests__/test_mac.py
+uspd_middleware_sdk/__tests__/test_uspd_middleware_sdk.py
+uspd_middleware_sdk/brokers/__init__.py
+uspd_middleware_sdk/brokers/shared_amqp_broker.py
+uspd_middleware_sdk/constants/__init__.py
+uspd_middleware_sdk/constants/enums.py
+uspd_middleware_sdk/constants/env.py
+uspd_middleware_sdk/constants/names.py
+uspd_middleware_sdk/messages/__init__.py
+uspd_middleware_sdk/messages/manual_polling_status_message.py
+uspd_middleware_sdk/types/__init__.py
+uspd_middleware_sdk/types/manual_polling.py
+uspd_middleware_sdk/utils/__init__.py
+uspd_middleware_sdk/utils/internal_api_error_handler.py
+uspd_middleware_sdk/utils/mac.py

ul_uspd_middleware_sdk-1.0.1/ul_uspd_middleware_sdk.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ul_uspd_middleware_sdk-1.0.1/ul_uspd_middleware_sdk.egg-info/requires.txt

@@ -0,0 +1,10 @@
+requests>=2.32.0
+ul-api-utils>=10.0.14
+ul-db-utils>=6.0.3
+ul-py-tool>=3.0.3
+ul-data-aggregator-sdk>=11.0.4
+loguru>=0.7.2
+tenacity>=9.0.0
+
+[dev]
+uv-script>=0.1.9

ul_uspd_middleware_sdk-1.0.1/ul_uspd_middleware_sdk.egg-info/top_level.txt

@@ -0,0 +1 @@
+uspd_middleware_sdk

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/README.md

@@ -0,0 +1,3 @@
+# USPD Middleware SDK
+
+HTTP client and shared contracts for uspd-middleware integration.

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/__tests__/test_mac.py

@@ -0,0 +1,15 @@
+import unittest
+
+from uspd_middleware_sdk.utils.mac import normalize_mac
+
+
+class TestNormalizeMac(unittest.TestCase):
+    def test_normalizes_string_mac(self) -> None:
+        self.assertEqual(normalize_mac('aa:bb:cc'), 'AA:BB:CC')
+
+    def test_normalizes_int_mac(self) -> None:
+        self.assertEqual(normalize_mac(123456), '123456')
+
+
+if __name__ == '__main__':
+    unittest.main()

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/__tests__/test_uspd_middleware_sdk.py

@@ -0,0 +1,39 @@
+import unittest
+from datetime import datetime, timezone
+from unittest.mock import MagicMock, patch
+from uuid import uuid4
+
+from uspd_middleware_sdk.constants.enums import ManualPollingStatusEnum
+from uspd_middleware_sdk.messages.manual_polling_status_message import ManualPollingStatusV0Message
+from uspd_middleware_sdk.uspd_middleware_sdk import UspdMiddlewareSdk
+from uspd_middleware_sdk.uspd_middleware_sdk_config import UspdMiddlewareSdkConfig
+
+
+class TestUspdMiddlewareSdk(unittest.TestCase):
+    def test_publish_skips_when_broker_uri_missing(self) -> None:
+        sdk = UspdMiddlewareSdk(UspdMiddlewareSdkConfig(shared_broker_url=''))
+        with patch.object(sdk, '_uni') as uni_mock:
+            sdk.publish_manual_polling_status(
+                ManualPollingStatusV0Message(
+                    task_id=uuid4(),
+                    status=ManualPollingStatusEnum.queued,
+                    timestamp=datetime.now(tz=timezone.utc),
+                ),
+            )
+            uni_mock.send_to.assert_not_called()
+
+    def test_publish_sends_to_manual_polling_status_worker(self) -> None:
+        sdk = UspdMiddlewareSdk(UspdMiddlewareSdkConfig(shared_broker_url='amqp://admin:admin@localhost:5672'))
+        sdk._producer_initialized = True
+        sdk._uni = MagicMock()
+        message = ManualPollingStatusV0Message(
+            task_id=uuid4(),
+            status=ManualPollingStatusEnum.queued,
+            timestamp=datetime.now(tz=timezone.utc),
+        )
+        sdk.publish_manual_polling_status(message)
+        sdk._uni.send_to.assert_called_once_with('manual_polling_status', message)
+
+
+if __name__ == '__main__':
+    unittest.main()

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/brokers/shared_amqp_broker.py

@@ -0,0 +1,10 @@
+from ul_unipipeline.brokers.uni_amqp_py_broker import UniAmqpPyBroker
+
+from uspd_middleware_sdk.runtime_conf import get_shared_broker_uri
+
+
+class SharedAmqpBroker(UniAmqpPyBroker):
+
+    @classmethod
+    def get_connection_uri(cls) -> str:
+        return get_shared_broker_uri()

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/constants/enums.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+class ManualPollingStatusEnum(str, Enum):
+    queued = 'queued'
+    in_progress = 'in_progress'
+    success = 'success'
+    error = 'error'

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/constants/env.py

@@ -0,0 +1,11 @@
+import os
+
+ENV_USPD_MIDDLEWARE__SHARED_AMQP_BROKER__URI = 'USPD_MIDDLEWARE__SHARED_AMQP_BROKER__URI'
+
+
+def get_shared_broker_uri_from_env() -> str:
+    return os.environ.get(ENV_USPD_MIDDLEWARE__SHARED_AMQP_BROKER__URI, '')
+
+
+def is_shared_amqp_broker_configured() -> bool:
+    return bool(get_shared_broker_uri_from_env())

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/constants/names.py

@@ -0,0 +1 @@
+MANUAL_POLLING_STATUS_WORKER_NAME = 'manual_polling_status'

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/dag.yml

@@ -0,0 +1,24 @@
+---
+
+service:
+  name: "uspd_middleware"
+  echo_colors: true
+  echo_level: debug
+
+external:
+  manual_polling_status: {}
+
+brokers:
+  shared_amqp_broker:
+    import_template: "uspd_middleware_sdk.brokers.shared_amqp_broker:SharedAmqpBroker"
+
+messages:
+  manual_polling_status:
+    import_template: "uspd_middleware_sdk.messages.manual_polling_status_message:ManualPollingStatusV0Message"
+
+workers:
+  manual_polling_status:
+    broker: shared_amqp_broker
+    input_message: manual_polling_status
+    external: manual_polling_status
+    topic: "manual_polling_status"

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/errors.py

@@ -0,0 +1,15 @@
+class UspdMiddlewareAbstractError(Exception):
+    def __init__(self, message: str, error: Exception, status_code: int) -> None:
+        assert isinstance(message, str), f'message must be str. "{type(message).__name__}" was given'
+        assert isinstance(error, Exception), f'error must be Exception. "{type(error).__name__}" was given'
+        super().__init__(f'{message} :: {str(error)} :: {status_code})')
+        self.status_code = status_code
+        self.error = error
+
+
+class UspdMiddlewareRequestError(UspdMiddlewareAbstractError):
+    pass
+
+
+class UspdMiddlewareResponseError(UspdMiddlewareAbstractError):
+    pass

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/lib.py

@@ -0,0 +1,7 @@
+import os
+
+from ul_unipipeline.modules.uni import Uni
+
+CONFIG_FILE = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'dag.yml')
+
+uni = Uni(CONFIG_FILE)

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/messages/manual_polling_status_message.py

@@ -0,0 +1,15 @@
+from datetime import datetime
+from typing import Optional
+from uuid import UUID
+
+from ul_unipipeline.message.uni_message import UniMessage
+
+from uspd_middleware_sdk.constants.enums import ManualPollingStatusEnum
+
+
+class ManualPollingStatusV0Message(UniMessage):
+    task_id: UUID
+    status: ManualPollingStatusEnum
+    timestamp: datetime
+    error_message: Optional[str] = None
+    not_found_devices: list[str] = []

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/runtime_conf.py

@@ -0,0 +1,10 @@
+broker_uri = ''
+
+
+def set_shared_broker_uri(uri: str) -> None:
+    global broker_uri
+    broker_uri = uri
+
+
+def get_shared_broker_uri() -> str:
+    return broker_uri

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/types/manual_polling.py

@@ -0,0 +1,16 @@
+from typing import List
+from uuid import UUID
+
+from pydantic import BaseModel, Field
+from ul_api_utils.api_resource.api_response import JsonApiResponsePayload
+
+from uspd_middleware_sdk.constants.enums import ManualPollingStatusEnum
+
+
+class ApiManualPollingRequest(BaseModel):
+    macs: List[str] = Field(title='MACs', description='list of device MAC addresses to poll')
+
+
+class ApiManualPollingResponse(JsonApiResponsePayload):
+    task_id: UUID = Field(title='Task ID', description='manual polling task identifier')
+    status: ManualPollingStatusEnum = Field(title='Status', description='initial task status')

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/uspd_middleware_api_sdk.py

@@ -0,0 +1,24 @@
+from typing import List
+
+from ul_api_utils.internal_api.internal_api import InternalApi
+
+from uspd_middleware_sdk.types.manual_polling import ApiManualPollingResponse
+from uspd_middleware_sdk.uspd_middleware_api_sdk_config import UspdMiddlewareApiSdkConfig
+from uspd_middleware_sdk.utils.internal_api_error_handler import internal_api_error_handler
+
+
+class UspdMiddlewareApiSdk:
+    def __init__(self, config: UspdMiddlewareApiSdkConfig) -> None:
+        self._config = config
+        self._api = InternalApi(
+            self._config.api_url,
+            default_auth_token=self._config.api_token,
+        )
+
+    @internal_api_error_handler
+    def post_manual_polling(self, macs: List[str]) -> ApiManualPollingResponse:
+        '''used in services: iot-account-application-backend'''
+        return self._api.request_post(
+            '/manual-polling',
+            json={'macs': macs},
+        ).typed(ApiManualPollingResponse).check().payload

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/uspd_middleware_api_sdk_config.py

@@ -0,0 +1,6 @@
+from typing import NamedTuple
+
+
+class UspdMiddlewareApiSdkConfig(NamedTuple):
+    api_url: str
+    api_token: str

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/uspd_middleware_sdk.py

@@ -0,0 +1,42 @@
+import logging
+
+from ul_unipipeline.modules.uni import Uni
+
+from uspd_middleware_sdk.constants.names import MANUAL_POLLING_STATUS_WORKER_NAME
+from uspd_middleware_sdk.lib import CONFIG_FILE
+from uspd_middleware_sdk.messages.manual_polling_status_message import ManualPollingStatusV0Message
+from uspd_middleware_sdk.runtime_conf import get_shared_broker_uri, set_shared_broker_uri
+from uspd_middleware_sdk.uspd_middleware_sdk_config import UspdMiddlewareSdkConfig
+
+logger = logging.getLogger(__name__)
+
+
+class UspdMiddlewareSdk:
+
+    def __init__(self, config: UspdMiddlewareSdkConfig) -> None:
+        self._config = config
+        self._uni = Uni(CONFIG_FILE)
+        set_shared_broker_uri(self._config.shared_broker_url)
+        self._producer_initialized = False
+
+    def init_producer_worker(self) -> None:
+        if not get_shared_broker_uri():
+            logger.info(
+                'Shared AMQP broker URI is not configured; manual polling status publisher stub mode',
+            )
+            return
+        self._uni.init_producer_worker(MANUAL_POLLING_STATUS_WORKER_NAME)
+        self._uni.initialize()
+        self._producer_initialized = True
+
+    def publish_manual_polling_status(self, message: ManualPollingStatusV0Message) -> None:
+        if not get_shared_broker_uri():
+            logger.info(
+                'Shared AMQP broker URI is not configured; skip manual polling status publish',
+            )
+            return
+        if not self._producer_initialized:
+            self.init_producer_worker()
+        if not self._producer_initialized:
+            return
+        self._uni.send_to(MANUAL_POLLING_STATUS_WORKER_NAME, message)

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/uspd_middleware_sdk_config.py

@@ -0,0 +1,5 @@
+from typing import NamedTuple
+
+
+class UspdMiddlewareSdkConfig(NamedTuple):
+    shared_broker_url: str

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/utils/internal_api_error_handler.py

@@ -0,0 +1,32 @@
+from functools import wraps
+from typing import Any, Callable, Dict, List, TypeVar, cast
+
+from ul_api_utils.errors import (
+    Client4XXInternalApiError,
+    NotFinishedRequestInternalApiError,
+    ResponseJsonInternalApiError,
+    Server5XXInternalApiError,
+)
+
+from uspd_middleware_sdk.errors import UspdMiddlewareRequestError, UspdMiddlewareResponseError
+
+TKwargs = TypeVar('TKwargs', bound=Dict[str, Any])
+STDResp = TypeVar('STDResp', bound=Dict[str, Any] | List[Dict[str, Any]])
+TFn = TypeVar('TFn', bound=Callable)  # type: ignore
+
+
+def internal_api_error_handler(api_method_fn: TFn) -> TFn:
+    @wraps(api_method_fn)
+    def error_handler_wrapper(*args: Any, **kwargs: TKwargs) -> TFn:
+        try:
+            return api_method_fn(*args, **kwargs)
+        except Client4XXInternalApiError as e:
+            raise UspdMiddlewareRequestError(str(e), e, e.status_code)
+        except Server5XXInternalApiError as e:
+            raise UspdMiddlewareResponseError(str(e), e, e.status_code)
+        except ResponseJsonInternalApiError as e:
+            raise UspdMiddlewareResponseError(str(e), e, 500)
+        except NotFinishedRequestInternalApiError as e:
+            raise UspdMiddlewareResponseError("SERVICE TEMPORARY UNAVAIBLE", e, 503)
+
+    return cast(TFn, error_handler_wrapper)

ul_uspd_middleware_sdk-1.0.1/uspd_middleware_sdk/utils/mac.py

@@ -0,0 +1,2 @@
+def normalize_mac(mac: str | int) -> str:
+    return str(mac).strip().upper()