place-integration-api 0.2.1__tar.gz → 0.2.4__tar.gz

{place_integration_api-0.2.1/src/place_integration_api.egg-info → place_integration_api-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: place-integration-api
-Version: 0.2.1
+Version: 0.2.4
 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://pypi.org/project/place-integration-api/
@@ -15,9 +15,11 @@ Requires-Dist: aiohttp
 Requires-Dist: paho-mqtt
 Requires-Dist: six
 Requires-Dist: python-decouple
-Requires-Dist: jwt
+Requires-Dist: PyJWT
 Provides-Extra: dev
 Requires-Dist: basedpyright; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
 Dynamic: license-file
 
 # Place integration API

{place_integration_api-0.2.1 → place_integration_api-0.2.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "place-integration-api"
-version = "0.2.1"
+version = "0.2.4"
 description = "Python APIs for Cognito-authenticated MQTT flows and Home Assistant discovery for Gentex Place."
 readme = "README.md"
 requires-python = ">=3.11"
@@ -23,16 +23,22 @@ dependencies = [
   "paho-mqtt",
   "six",
   "python-decouple",
-  "jwt"
+  "PyJWT"
 ]
 
 [project.optional-dependencies]
 dev = [
   "basedpyright",
+  "pytest",
+  "pytest-asyncio",
 ]
 
 [project.urls]
 Homepage = "https://pypi.org/project/place-integration-api/"
 
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+
 [tool.setuptools.packages.find]
 where = ["src"]

{place_integration_api-0.2.1 → place_integration_api-0.2.4}/src/place/messages.py

@@ -84,3 +84,10 @@ class PlaceMessages:
         return describe_message(topic, raw)
 
 
+    @staticmethod
+    def thing_name_from_topic(topic: str) -> str | None:
+        """Extract thing_name from an AWS IoT shadow topic ($aws/things/{name}/shadow/...)."""
+        parts = topic.split("/")
+        if len(parts) >= 3 and parts[0] == "$aws" and parts[1] == "things":
+            return parts[2]
+        return None

{place_integration_api-0.2.1 → place_integration_api-0.2.4/src/place_integration_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: place-integration-api
-Version: 0.2.1
+Version: 0.2.4
 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://pypi.org/project/place-integration-api/
@@ -15,9 +15,11 @@ Requires-Dist: aiohttp
 Requires-Dist: paho-mqtt
 Requires-Dist: six
 Requires-Dist: python-decouple
-Requires-Dist: jwt
+Requires-Dist: PyJWT
 Provides-Extra: dev
 Requires-Dist: basedpyright; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
 Dynamic: license-file
 
 # Place integration API

{place_integration_api-0.2.1 → place_integration_api-0.2.4}/src/place_integration_api.egg-info/SOURCES.txt

@@ -22,5 +22,6 @@ src/place_integration_api.egg-info/dependency_links.txt
 src/place_integration_api.egg-info/requires.txt
 src/place_integration_api.egg-info/top_level.txt
 tests/test_auth.py
+tests/test_models.py
 tests/test_mqtt_client.py
 tests/test_provider.py

{place_integration_api-0.2.1 → place_integration_api-0.2.4}/src/place_integration_api.egg-info/requires.txt

@@ -3,7 +3,9 @@ aiohttp
 paho-mqtt
 six
 python-decouple
-jwt
+PyJWT
 
 [dev]
 basedpyright
+pytest
+pytest-asyncio

{place_integration_api-0.2.1 → place_integration_api-0.2.4}/tests/test_auth.py

@@ -1,24 +1,14 @@
 from __future__ import annotations
 
 from unittest.mock import MagicMock, patch
+from place.auth import get_iot_credentials
 
-from place_integration_api.auth import get_credentials_via_cognito
 
-
-@patch("place_integration_api.auth.srp_auth.boto3")
-@patch("place_integration_api.auth.srp_auth.get_tokens_via_srp")
-def test_get_credentials_via_cognito_success(
-    mock_get_tokens_via_srp: MagicMock, mock_boto3: MagicMock
-) -> None:
+@patch("place.auth.srp_auth.boto3")
+def test_get_iot_credentials_success(mock_boto3: MagicMock) -> None:
     identity_client = MagicMock()
     mock_boto3.client.return_value = identity_client
 
-    mock_get_tokens_via_srp.return_value = {
-        "AuthenticationResult": {
-            "IdToken": "id-token",
-            "AccessToken": "access-token",
-        }
-    }
     identity_client.get_id.return_value = {"IdentityId": "identity-123"}
     identity_client.get_credentials_for_identity.return_value = {
         "Credentials": {
@@ -28,13 +18,10 @@ def test_get_credentials_via_cognito_success(
         }
     }
 
-    creds = get_credentials_via_cognito(
-        user_pool_id="pool",
-        client_id="client",
-        identity_pool_id="identity-pool",
-        username="user",
-        password="pass",
-        region="us-east-2",
+
+    creds = get_iot_credentials(
+        id_token="id-token",
+        access_token="access-token",
     )
 
     assert creds.access_key_id == "AKIA..."
@@ -42,4 +29,3 @@ def test_get_credentials_via_cognito_success(
     assert creds.session_token == "session"
     assert creds.identity_id == "identity-123"
     assert creds.access_token == "access-token"
-

place_integration_api-0.2.4/tests/test_models.py

@@ -0,0 +1,88 @@
+"""Tests for the Place device shadow data models."""
+
+from place.models.device_shadow import AlarmStatus, PlaceDeviceShadow
+
+FULL_SHADOW = {
+    "state": {
+        "reported": {
+            "deviceId": "device-001",
+            "model": "MODEL-X",
+            "fwPackageId": "fw-1.0",
+            "autoUpdate": True,
+            "secureBuild": True,
+            "coAlarmStatus": 0,
+            "heatAlarmStatus": 3,
+            "smokeAlarmStatus": 5,
+        }
+    }
+}
+
+
+def test_from_shadow_full() -> None:
+    """Test parsing a shadow payload."""
+    shadow = PlaceDeviceShadow.from_shadow(FULL_SHADOW)
+
+    # Alarm statuses
+    assert shadow.co_alarm_status is AlarmStatus.IDLE
+    assert shadow.heat_alarm_status is AlarmStatus.ALARM
+    assert shadow.smoke_alarm_status is AlarmStatus.HUSHED
+
+
+def test_from_shadow_without_state_wrapper() -> None:
+    """Test parsing a flat reported dict (no state.reported wrapper)."""
+    reported = {"coAlarmStatus": 3, "heatAlarmStatus": 0, "smokeAlarmStatus": 5}
+    shadow = PlaceDeviceShadow.from_shadow(reported)
+
+    assert shadow.co_alarm_status is AlarmStatus.ALARM
+    assert shadow.heat_alarm_status is AlarmStatus.IDLE
+    assert shadow.smoke_alarm_status is AlarmStatus.HUSHED
+
+
+def test_from_shadow_empty() -> None:
+    """Test parsing an empty shadow returns defaults."""
+    shadow = PlaceDeviceShadow.from_shadow({})
+
+    assert shadow.co_alarm_status is AlarmStatus.NOT_PRESENT
+    assert shadow.heat_alarm_status is AlarmStatus.NOT_PRESENT
+    assert shadow.smoke_alarm_status is AlarmStatus.NOT_PRESENT
+
+
+def test_from_shadow_invalid_alarm_value() -> None:
+    """Test that out-of-range alarm values default to NOT_PRESENT."""
+    shadow = PlaceDeviceShadow.from_shadow({"coAlarmStatus": 99})
+
+    assert shadow.co_alarm_status is AlarmStatus.NOT_PRESENT
+
+
+def test_from_shadow_null_alarm_value() -> None:
+    """Test that null alarm values default to NOT_PRESENT."""
+    shadow = PlaceDeviceShadow.from_shadow({"coAlarmStatus": None})
+
+    assert shadow.co_alarm_status is AlarmStatus.NOT_PRESENT
+
+
+def test_merge_sparse_update() -> None:
+    """Test that a sparse update only changes provided fields."""
+    shadow = PlaceDeviceShadow.from_shadow(FULL_SHADOW)
+
+    assert shadow.co_alarm_status is AlarmStatus.IDLE
+
+    shadow.merge({"state": {"reported": {"coAlarmStatus": 3}}})
+
+    # Updated fields
+    assert shadow.co_alarm_status is AlarmStatus.ALARM
+
+    # Unchanged fields
+    assert shadow.heat_alarm_status is AlarmStatus.ALARM
+    assert shadow.smoke_alarm_status is AlarmStatus.HUSHED
+
+
+def test_alarm_status_enum_values() -> None:
+    """Test AlarmStatus enum has correct integer mappings."""
+    assert AlarmStatus.IDLE == 0
+    assert AlarmStatus.TEST == 1
+    assert AlarmStatus.PRE_ALARM == 2
+    assert AlarmStatus.ALARM == 3
+    assert AlarmStatus.CRITICAL_ALARM == 4
+    assert AlarmStatus.HUSHED == 5
+    assert AlarmStatus.NOT_PRESENT == 6

{place_integration_api-0.2.1 → place_integration_api-0.2.4}/tests/test_mqtt_client.py

@@ -2,8 +2,8 @@ from __future__ import annotations
 
 from unittest.mock import MagicMock, patch
 
-from place_integration_api.models import Credentials
-from place_integration_api.mqtt_client import get_signed_uri, run_mqtt_flow
+from place.models import Credentials
+from place.mqtt_client import get_signed_uri, MqttClient
 
 
 def test_get_signed_uri_includes_host_and_token() -> None:
@@ -19,9 +19,9 @@ def test_get_signed_uri_includes_host_and_token() -> None:
     assert "X-Amz-Security-Token=token123" in uri
 
 
-@patch("place_integration_api.mqtt_client.mqtt.Client")
-@patch("place_integration_api.mqtt_client.get_signed_uri")
-def test_run_mqtt_flow_sets_up_client(
+@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:
@@ -36,16 +36,13 @@ def test_run_mqtt_flow_sets_up_client(
         identity_id="identity-123",
     )
 
-    run_mqtt_flow(
+    mqtt_client = MqttClient(
         endpoint="example.iot.amazonaws.com",
         credentials=creds,
-        household_ids=["hh1"],
-        thing_names=["thing1"],
     )
+    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()
-    client.loop_forever.assert_called_once()
-

{place_integration_api-0.2.1 → place_integration_api-0.2.4}/tests/test_provider.py

@@ -2,9 +2,9 @@ from __future__ import annotations
 
 import asyncio
 
-from place_integration_api.auth.abstract_auth import AbstractAuth
-from place_integration_api.config import FULFILLMENT_URL
-from place_integration_api.provider import Provider
+from place.auth.abstract_auth import AbstractAuth
+from place.config import FULFILLMENT_URL
+from place.provider import Provider
 
 
 def test_provider_discover_parses_response() -> None:
@@ -12,8 +12,8 @@ def test_provider_discover_parses_response() -> None:
         "success": True,
         "data": {
             "devices": [
-                {"householdId": "h1", "thingName": "t1", "deviceId": "d1"},
-                {"householdId": "h2", "thingName": "t2", "deviceId": "d2"},
+                {"thingName": "t1", "deviceId": "d1", "deviceName": "Device 1"},
+                {"thingName": "t2", "deviceId": "d2", "deviceName": "Device 2"},
             ]
         },
     }
@@ -40,16 +40,13 @@ def test_provider_discover_parses_response() -> None:
 
     assert auth.calls == [("POST", FULFILLMENT_URL, {"json": {"command": "DISCOVER", "data": {}}})]
 
-    household_ids = sorted(
-        {d.household_id for d in devices if d.household_id is not None}
-    )
     thing_names = sorted(
         {d.thing_name for d in devices if d.thing_name is not None}
     )
 
-    assert household_ids == ["h1", "h2"]
     assert thing_names == ["t1", "t2"]
     assert [d.device_id for d in devices] == ["d1", "d2"]
+    assert [d.device_name for d in devices] == ["Device 1", "Device 2"]
 
 
 def test_provider_enable_sends_enable_command() -> None:
@@ -90,7 +87,7 @@ def test_provider_disable_sends_disable_command() -> None:
             return "token"
 
         async def request(self, method, url, **kwargs):
-            self.calls.append((method, url, **kwargs))
+            self.calls.append((method, url, kwargs))
 
             class DummyResponse:
                 async def json(self_inner):
@@ -104,4 +101,3 @@ def test_provider_disable_sends_disable_command() -> None:
 
     assert auth.calls == [("POST", FULFILLMENT_URL, {"json": {"command": "DISABLE", "data": {}}})]
     assert result == payload
-