place-integration-api 0.2.6__tar.gz → 0.2.7__tar.gz

{place_integration_api-0.2.6/src/place_integration_api.egg-info → place_integration_api-0.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: place-integration-api
-Version: 0.2.6
+Version: 0.2.7
 Summary: Python APIs for Cognito-authenticated MQTT flows and Home Assistant discovery for Gentex Place.
 Author-email: Nicholas Aelick <niaexa@syntronic.com>, Andrew Tran <andrew.tran@gentex.com>
 Project-URL: Homepage, https://placehomesolutions.com

{place_integration_api-0.2.6 → place_integration_api-0.2.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "place-integration-api"
-version = "0.2.6"
+version = "0.2.7"
 description = "Python APIs for Cognito-authenticated MQTT flows and Home Assistant discovery for Gentex Place."
 readme = "README.md"
 requires-python = ">=3.11"

{place_integration_api-0.2.6 → place_integration_api-0.2.7}/src/place/errors.py

@@ -7,3 +7,7 @@ class PlaceApiError(Exception):
 
 class PlaceFulfillmentError(PlaceApiError):
     """Raised when the fulfillment API reports a business-logic failure."""
+
+
+class PlaceMqttConnectionError(PlaceApiError):
+    """Raised when the MQTT broker rejects or fails to establish a connection."""

{place_integration_api-0.2.6 → place_integration_api-0.2.7}/src/place/mqtt_client.py

@@ -2,14 +2,17 @@ from __future__ import annotations
 
 import hashlib
 import hmac
+import threading
 import uuid
 from datetime import datetime, timezone
 from typing import Callable
 from urllib.parse import quote
 
 import paho.mqtt.client as mqtt
+from paho.mqtt.reasoncodes import ReasonCode
 
 from .config import ALGORITHM, EXPIRE_SEC, KEEP_ALIVE_SEC, PATH, REGION, SCHEME, SERVICE
+from .errors import PlaceMqttConnectionError
 from .models import Credentials
 
 
@@ -92,12 +95,17 @@ class MqttClient:
         self.endpoint = endpoint
         self.credentials = credentials
         self._client: mqtt.Client | None = None
+        self._connected_event = threading.Event()
+        self._connect_error: ReasonCode | None = None
 
     def connect(
         self,
         on_message: Callable[[str, bytes], None] | None = None,
         on_connect: Callable[[], None] | None = None,
     ) -> None:
+        self._connected_event.clear()
+        self._connect_error = None
+
         signed_uri = get_signed_uri(
             access_key_id=self.credentials.access_key_id,
             secret_access_key=self.credentials.secret_access_key,
@@ -119,8 +127,12 @@ class MqttClient:
         def _on_connect(_client, _userdata, _flags, reason_code, _properties):
             if reason_code.is_failure:
                 print(f"Connect failed: {reason_code}")
+                self._connect_error = reason_code
+                self._connected_event.set()
                 return
             print("Connected")
+            self._connect_error = None
+            self._connected_event.set()
             if on_connect:
                 try:
                     on_connect()
@@ -149,6 +161,23 @@ class MqttClient:
         if self._client:
             self._client.loop_stop()
 
+    def wait_for_connection(self, timeout: float = 10.0) -> None:
+        """Block until the initial CONNACK is received.
+
+        Raises PlaceMqttConnectionError if the broker rejects the connection
+        or none arrives within timeout, tearing down the client in that case.
+        """
+        if not self._connected_event.wait(timeout):
+            self.disconnect()
+            self.loop_stop()
+            raise PlaceMqttConnectionError("Timed out waiting for MQTT CONNACK")
+        if self._connect_error is not None:
+            self.disconnect()
+            self.loop_stop()
+            raise PlaceMqttConnectionError(
+                f"MQTT connection rejected: {self._connect_error}"
+            )
+
     def subscribe(self, topic: str, qos: int = 1) -> None:
         assert self._client is not None
         self._client.subscribe(topic, qos=qos)

{place_integration_api-0.2.6 → place_integration_api-0.2.7/src/place_integration_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: place-integration-api
-Version: 0.2.6
+Version: 0.2.7
 Summary: Python APIs for Cognito-authenticated MQTT flows and Home Assistant discovery for Gentex Place.
 Author-email: Nicholas Aelick <niaexa@syntronic.com>, Andrew Tran <andrew.tran@gentex.com>
 Project-URL: Homepage, https://placehomesolutions.com

place_integration_api-0.2.7/tests/test_mqtt_client.py

@@ -0,0 +1,138 @@
+from __future__ import annotations
+
+from unittest.mock import MagicMock, patch
+
+from paho.mqtt.packettypes import PacketTypes
+from paho.mqtt.reasoncodes import ReasonCode
+import pytest
+
+from place.errors import PlaceMqttConnectionError
+from place.models import Credentials
+from place.mqtt_client import get_signed_uri, MqttClient
+
+
+def test_get_signed_uri_includes_host_and_token() -> None:
+    uri = get_signed_uri(
+        access_key_id="AKIA...",
+        secret_access_key="secret",
+        session_token="token123",
+        host="example.iot.amazonaws.com",
+    )
+    assert uri.startswith("wss://example.iot.amazonaws.com/mqtt?")
+    assert "X-Amz-Algorithm=" in uri
+    assert "X-Amz-Signature=" in uri
+    assert "X-Amz-Security-Token=token123" in uri
+
+
+@patch("place.mqtt_client.mqtt.Client")
+@patch("place.mqtt_client.get_signed_uri")
+def test_mqtt_client_connect_sets_up_client(
+    mock_get_signed_uri: MagicMock,
+    mock_client_cls: MagicMock,
+) -> None:
+    mock_get_signed_uri.return_value = "wss://example.iot.amazonaws.com/mqtt?x=1"
+    client = MagicMock()
+    mock_client_cls.return_value = client
+
+    creds = Credentials(
+        access_key_id="AKIA...",
+        secret_access_key="secret",
+        session_token="token",
+        identity_id="identity-123",
+    )
+
+    mqtt_client = MqttClient(
+        endpoint="example.iot.amazonaws.com",
+        credentials=creds,
+    )
+    mqtt_client.connect()
+
+    mock_get_signed_uri.assert_called_once()
+    client.ws_set_options.assert_called()
+    client.tls_set.assert_called_once()
+    client.connect.assert_called_once()
+
+
+@patch("place.mqtt_client.mqtt.Client")
+@patch("place.mqtt_client.get_signed_uri")
+def test_wait_for_connection_succeeds_on_connack_success(
+    mock_get_signed_uri: MagicMock,
+    mock_client_cls: MagicMock,
+) -> None:
+    mock_get_signed_uri.return_value = "wss://example.iot.amazonaws.com/mqtt?x=1"
+    client = MagicMock()
+    mock_client_cls.return_value = client
+
+    creds = Credentials(
+        access_key_id="AKIA...",
+        secret_access_key="secret",
+        session_token="token",
+        identity_id="identity-123",
+    )
+    mqtt_client = MqttClient(endpoint="example.iot.amazonaws.com", credentials=creds)
+    mqtt_client.connect()
+
+    client.on_connect(
+        client, None, None, ReasonCode(PacketTypes.CONNACK, identifier=0), None
+    )
+
+    mqtt_client.wait_for_connection(timeout=1)
+
+    client.disconnect.assert_not_called()
+    client.loop_stop.assert_not_called()
+
+
+@patch("place.mqtt_client.mqtt.Client")
+@patch("place.mqtt_client.get_signed_uri")
+def test_wait_for_connection_raises_on_connack_rejection(
+    mock_get_signed_uri: MagicMock,
+    mock_client_cls: MagicMock,
+) -> None:
+    mock_get_signed_uri.return_value = "wss://example.iot.amazonaws.com/mqtt?x=1"
+    client = MagicMock()
+    mock_client_cls.return_value = client
+
+    creds = Credentials(
+        access_key_id="AKIA...",
+        secret_access_key="secret",
+        session_token="token",
+        identity_id="identity-123",
+    )
+    mqtt_client = MqttClient(endpoint="example.iot.amazonaws.com", credentials=creds)
+    mqtt_client.connect()
+
+    client.on_connect(
+        client, None, None, ReasonCode(PacketTypes.CONNACK, identifier=135), None
+    )
+
+    with pytest.raises(PlaceMqttConnectionError, match="rejected"):
+        mqtt_client.wait_for_connection(timeout=1)
+
+    client.disconnect.assert_called_once()
+    client.loop_stop.assert_called_once()
+
+
+@patch("place.mqtt_client.mqtt.Client")
+@patch("place.mqtt_client.get_signed_uri")
+def test_wait_for_connection_raises_on_timeout(
+    mock_get_signed_uri: MagicMock,
+    mock_client_cls: MagicMock,
+) -> None:
+    mock_get_signed_uri.return_value = "wss://example.iot.amazonaws.com/mqtt?x=1"
+    client = MagicMock()
+    mock_client_cls.return_value = client
+
+    creds = Credentials(
+        access_key_id="AKIA...",
+        secret_access_key="secret",
+        session_token="token",
+        identity_id="identity-123",
+    )
+    mqtt_client = MqttClient(endpoint="example.iot.amazonaws.com", credentials=creds)
+    mqtt_client.connect()
+
+    with pytest.raises(PlaceMqttConnectionError, match="Timed out"):
+        mqtt_client.wait_for_connection(timeout=0.05)
+
+    client.disconnect.assert_called_once()
+    client.loop_stop.assert_called_once()

place_integration_api-0.2.6/tests/test_mqtt_client.py

@@ -1,48 +0,0 @@
-from __future__ import annotations
-
-from unittest.mock import MagicMock, patch
-
-from place.models import Credentials
-from place.mqtt_client import get_signed_uri, MqttClient
-
-
-def test_get_signed_uri_includes_host_and_token() -> None:
-    uri = get_signed_uri(
-        access_key_id="AKIA...",
-        secret_access_key="secret",
-        session_token="token123",
-        host="example.iot.amazonaws.com",
-    )
-    assert uri.startswith("wss://example.iot.amazonaws.com/mqtt?")
-    assert "X-Amz-Algorithm=" in uri
-    assert "X-Amz-Signature=" in uri
-    assert "X-Amz-Security-Token=token123" in uri
-
-
-@patch("place.mqtt_client.mqtt.Client")
-@patch("place.mqtt_client.get_signed_uri")
-def test_mqtt_client_connect_sets_up_client(
-    mock_get_signed_uri: MagicMock,
-    mock_client_cls: MagicMock,
-) -> None:
-    mock_get_signed_uri.return_value = "wss://example.iot.amazonaws.com/mqtt?x=1"
-    client = MagicMock()
-    mock_client_cls.return_value = client
-
-    creds = Credentials(
-        access_key_id="AKIA...",
-        secret_access_key="secret",
-        session_token="token",
-        identity_id="identity-123",
-    )
-
-    mqtt_client = MqttClient(
-        endpoint="example.iot.amazonaws.com",
-        credentials=creds,
-    )
-    mqtt_client.connect()
-
-    mock_get_signed_uri.assert_called_once()
-    client.ws_set_options.assert_called()
-    client.tls_set.assert_called_once()
-    client.connect.assert_called_once()