stinger-python-utils 0.1.2__py3-none-any.whl → 0.1.7__py3-none-any.whl

stinger_python_utils/message_creator.py

@@ -2,6 +2,7 @@ from pyqttier.message import Message
 from pydantic import BaseModel
 from typing import Union, Optional
 import uuid
+from .return_codes import MethodReturnCode
 
 
 class MessageCreator:
@@ -13,6 +14,7 @@ class MessageCreator:
             payload=payload.model_dump_json(by_alias=True).encode("utf-8"),
             qos=1,
             retain=False,
+            content_type="application/json",
         )
 
     @classmethod
@@ -25,19 +27,25 @@ class MessageCreator:
             qos=1,
             retain=True,
             message_expiry_interval=expiry_seconds,
+            content_type="application/json",
         )
 
     @classmethod
     def error_response_message(
         cls,
         topic: str,
-        return_code: int,
-        correlation_id: Union[str, bytes],
+        return_code: Union[int, MethodReturnCode],
+        correlation_id: Union[str, bytes, None] = None,
         debug_info: Optional[str] = None,
     ) -> Message:
         """
         This could be used for a response to a request, but where there was an error fulfilling the request.
         """
+        rc = (
+            return_code.value
+            if isinstance(return_code, MethodReturnCode)
+            else return_code
+        )
         msg_obj = Message(
             topic=topic,
             payload=b"{}",
@@ -48,7 +56,8 @@ class MessageCreator:
                 if isinstance(correlation_id, str)
                 else correlation_id
             ),
-            user_properties={"ReturnCode": str(return_code)},
+            user_properties={"ReturnCode": str(rc)},
+            content_type="application/json",
         )
         if (
             debug_info is not None and msg_obj.user_properties is not None
@@ -60,9 +69,9 @@ class MessageCreator:
     def response_message(
         cls,
         response_topic: str,
-        response_obj: BaseModel | str | bytes,
-        return_code: int,
-        correlation_id: Union[str, bytes],
+        response_obj: Union[BaseModel, str, bytes],
+        return_code: Union[int, MethodReturnCode],
+        correlation_id: Union[str, bytes, None] = None,
     ) -> Message:
         """
         This could be used for a successful response to a request.
@@ -73,6 +82,11 @@ class MessageCreator:
             payload = response_obj.encode("utf-8")
         else:
             payload = response_obj
+        rc = (
+            return_code.value
+            if isinstance(return_code, MethodReturnCode)
+            else return_code
+        )
         msg_obj = Message(
             topic=response_topic,
             payload=payload,
@@ -83,7 +97,8 @@ class MessageCreator:
                 if isinstance(correlation_id, str)
                 else correlation_id
             ),
-            user_properties={"ReturnCode": str(return_code)},
+            user_properties={"ReturnCode": str(rc)},
+            content_type="application/json",
         )
         return msg_obj
 
@@ -99,6 +114,7 @@ class MessageCreator:
             payload=state_obj.model_dump_json(by_alias=True).encode("utf-8"),
             qos=1,
             retain=True,
+            content_type="application/json",
         )
         if state_version is not None:
             msg_obj.user_properties = {"PropertyVersion": str(state_version)}
@@ -121,6 +137,7 @@ class MessageCreator:
             payload=property_obj.model_dump_json(by_alias=True).encode("utf-8"),
             qos=1,
             retain=False,
+            content_type="application/json",
             response_topic=response_topic,
             correlation_data=(
                 correlation_id.encode("utf-8")
@@ -137,25 +154,31 @@ class MessageCreator:
         response_topic: str,
         property_obj: BaseModel,
         version: str,
-        return_code: int,
-        correlation_id: Union[str, bytes],
+        return_code: Union[int, MethodReturnCode],
+        correlation_id: Union[str, bytes, None] = None,
         debug_info: Optional[str] = None,
     ) -> Message:
         """
         Creates a message representing a response to a property update request.
         """
+        rc = (
+            return_code.value
+            if isinstance(return_code, MethodReturnCode)
+            else return_code
+        )
         msg_obj = Message(
             topic=response_topic,
             payload=property_obj.model_dump_json(by_alias=True).encode("utf-8"),
             qos=1,
             retain=False,
+            content_type="application/json",
             correlation_data=(
                 correlation_id.encode("utf-8")
                 if isinstance(correlation_id, str)
                 else correlation_id
             ),
             user_properties={
-                "ReturnCode": str(return_code),
+                "ReturnCode": str(rc),
                 "PropertyVersion": str(version),
             },
         )
@@ -181,6 +204,7 @@ class MessageCreator:
             qos=1,
             retain=False,
             response_topic=response_topic,
+            content_type="application/json",
             correlation_data=(
                 correlation_id.encode("utf-8")
                 if isinstance(correlation_id, str)

stinger_python_utils-0.1.7.dist-info/METADATA

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: stinger-python-utils
+Version: 0.1.7
+Summary: Common utilities for Stinger Python services.
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.7
+Requires-Dist: pydantic>=2.5.3
+Requires-Dist: pyqttier>=0.2.0
+Description-Content-Type: text/markdown
+
+# stinger-python-utils
+
+Shared utilities for Stinger Python services, providing convenient message creation for MQTT communication.
+
+
+
+## Installation
+
+```bash
+uv add stinger-python-utils
+```
+
+## MessageCreator
+
+`MessageCreator` is a utility class for creating MQTT messages with standardized properties and payloads.
+
+### Basic Usage
+
+```python
+from pydantic import BaseModel
+from stinger_python_utils.message_creator import MessageCreator
+
+class MyPayload(BaseModel):
+    name: str
+    value: int
+
+payload = MyPayload(name="test", value=42)
+message = MessageCreator.signal_message("my/topic", payload)
+```
+
+### Methods
+
+| Method | Purpose | Return Code |
+|--------|---------|-------------|
+| `signal_message(topic, payload)` | Send a signal with one-time delivery | QoS 1, no retain |
+| `status_message(topic, payload, expiry_seconds)` | Send status that expires | QoS 1, retained, with expiry |
+| `error_response_message(topic, return_code, correlation_id, debug_info)` | Error response to a request | QoS 1, user properties: `ReturnCode` |
+| `response_message(topic, payload, return_code, correlation_id)` | Successful response to a request | QoS 1, user properties: `ReturnCode` |
+| `property_state_message(topic, payload, state_version)` | Publish property state | QoS 1, retained, JSON content type |
+| `property_update_request_message(topic, payload, version, response_topic, correlation_id)` | Request property update | QoS 1, user property: `PropertyVersion` |
+| `property_response_message(topic, payload, version, return_code, correlation_id, debug_info)` | Respond to property update | QoS 1, user properties: `ReturnCode`, `PropertyVersion` |
+| `request_message(topic, payload, response_topic, correlation_id)` | Send a request (auto-generates UUID if no correlation_id) | QoS 1, auto correlation ID |
+
+### Example: Request/Response Pattern
+
+```python
+from pydantic import BaseModel
+from stinger_python_utils.message_creator import MessageCreator
+
+class Request(BaseModel):
+    action: str
+
+request = Request(action="start")
+msg = MessageCreator.request_message(
+    "devices/cmd",
+    request,
+    response_topic="devices/response"
+)
+# Returns a Message with auto-generated correlation ID
+```
+
+### Example: Error Response
+
+```python
+msg = MessageCreator.error_response_message(
+    "devices/response",
+    return_code=500,
+    correlation_id="req-123",
+    debug_info="Device not found"
+)
+# User properties include: ReturnCode=500, DebugInfo=Device not found
+```
+

stinger_python_utils-0.1.7.dist-info/RECORD

@@ -0,0 +1,7 @@
+stinger_python_utils/__init__.py,sha256=IjHRV0k2DNwvFrEHebmsXiBvmITE8nQUnsR07h9tVkU,7
+stinger_python_utils/message_creator.py,sha256=M_SRo0gakRdXdiG54O2wrIaQOUw29Nl8kQLy3MhBRaE,6989
+stinger_python_utils/return_codes.py,sha256=AAwshvHu3SBoctwMX35k3j666J4a7DQ3V8AnR7QBjC8,5114
+stinger_python_utils-0.1.7.dist-info/METADATA,sha256=UDzGKsRLcKE0oxFbflKOGdA8cUskWCTuotCtuXMSq-Y,2769
+stinger_python_utils-0.1.7.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+stinger_python_utils-0.1.7.dist-info/licenses/LICENSE,sha256=_T-8ExmblJbhv-1AxC6XDVEHg1JdJA-126NvRiMqS-I,1070
+stinger_python_utils-0.1.7.dist-info/RECORD,,

stinger_python_utils-0.1.2.dist-info/METADATA

@@ -1,13 +0,0 @@
-Metadata-Version: 2.4
-Name: stinger-python-utils
-Version: 0.1.2
-Summary: Common utilities for Stinger Python services.
-License-Expression: MIT
-License-File: LICENSE
-Requires-Python: >=3.7
-Requires-Dist: pydantic>=2.5.3
-Requires-Dist: pyqttier>=0.2.0
-Description-Content-Type: text/markdown
-
-# stinger-python-utils
-Common code needed for stinger python generations

stinger_python_utils-0.1.2.dist-info/RECORD

@@ -1,7 +0,0 @@
-stinger_python_utils/__init__.py,sha256=IjHRV0k2DNwvFrEHebmsXiBvmITE8nQUnsR07h9tVkU,7
-stinger_python_utils/message_creator.py,sha256=ZR4FOhkmJ5R_X5QS-c-QAIpcN-7htIOiHtO40QUS35Y,6071
-stinger_python_utils/return_codes.py,sha256=AAwshvHu3SBoctwMX35k3j666J4a7DQ3V8AnR7QBjC8,5114
-stinger_python_utils-0.1.2.dist-info/METADATA,sha256=LxgDU_LYLjt9F5FMBkIsiK_XR61DL1tOEVOxI0glX78,364
-stinger_python_utils-0.1.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-stinger_python_utils-0.1.2.dist-info/licenses/LICENSE,sha256=_T-8ExmblJbhv-1AxC6XDVEHg1JdJA-126NvRiMqS-I,1070
-stinger_python_utils-0.1.2.dist-info/RECORD,,