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

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

@@ -1,9 +1,11 @@
 Metadata-Version: 2.4
 Name: place-integration-api
-Version: 0.2.4
+Version: 0.2.6
 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/
+Project-URL: Homepage, https://placehomesolutions.com
+Project-URL: Issues, https://placehomesolutions.com/support
+Project-URL: Repository, https://github.com/Gentex-Corporation/place-integration-api
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -25,3 +27,15 @@ Dynamic: license-file
 # Place integration API
 
 This project contains a python API to connect MQTT data from Place devices to Place's Home Assistant integration
+
+## Setup
+
+This repo utilizes VS Code [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) so you don't need to alter your global python environment.
+
+## Installing dependencies
+
+Use `pip` to install required dependencies by running `pip install -r requirements.txt` from the project root.
+
+## Updating dependencies
+
+During the course of development, if new packages are added, it's recommended to update [`requirements.txt`](./requirements.txt) by running `pip freeze > requirements.txt`.

place_integration_api-0.2.6/README.md

@@ -0,0 +1,15 @@
+# Place integration API
+
+This project contains a python API to connect MQTT data from Place devices to Place's Home Assistant integration
+
+## Setup
+
+This repo utilizes VS Code [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) so you don't need to alter your global python environment.
+
+## Installing dependencies
+
+Use `pip` to install required dependencies by running `pip install -r requirements.txt` from the project root.
+
+## Updating dependencies
+
+During the course of development, if new packages are added, it's recommended to update [`requirements.txt`](./requirements.txt) by running `pip freeze > requirements.txt`.

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "place-integration-api"
-version = "0.2.4"
+version = "0.2.6"
 description = "Python APIs for Cognito-authenticated MQTT flows and Home Assistant discovery for Gentex Place."
 readme = "README.md"
 requires-python = ">=3.11"
@@ -34,7 +34,9 @@ dev = [
 ]
 
 [project.urls]
-Homepage = "https://pypi.org/project/place-integration-api/"
+Homepage = "https://placehomesolutions.com"
+Issues = "https://placehomesolutions.com/support"
+Repository = "https://github.com/Gentex-Corporation/place-integration-api"
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]

{place_integration_api-0.2.4 → place_integration_api-0.2.6}/src/place/auth/abstract_auth.py

@@ -25,9 +25,11 @@ class AbstractAuth(ABC):
         access_token = await self.async_get_access_token()
         headers["authorization"] = f"Bearer {access_token}"
 
-        return await self.websession.request(
+        resp = await self.websession.request(
             method,
             url,
             **kwargs,
             headers=headers,
         )
+        resp.raise_for_status()
+        return resp

place_integration_api-0.2.6/src/place/errors.py

@@ -0,0 +1,9 @@
+"""Errors for the Place API."""
+
+
+class PlaceApiError(Exception):
+    """Base error for Place API failures."""
+
+
+class PlaceFulfillmentError(PlaceApiError):
+    """Raised when the fulfillment API reports a business-logic failure."""

place_integration_api-0.2.6/src/place/provider.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from typing import Any
+
+from aiohttp import ContentTypeError
+
+from .auth.abstract_auth import AbstractAuth
+from .errors import PlaceFulfillmentError
+from .models.discover_device import DiscoverDevice
+from .config import FULFILLMENT_URL
+
+
+async def _send_command(authorized_session: AbstractAuth, command: str) -> dict[str, Any]:
+    """Send a fulfillment command and return the parsed response body."""
+    body = {"command": command, "data": {}}
+    resp = await authorized_session.request("POST", FULFILLMENT_URL, json=body)
+    try:
+        data = await resp.json()
+    except (ContentTypeError, ValueError) as err:
+        raise PlaceFulfillmentError(
+            f"Invalid response from fulfillment API: {err}"
+        ) from err
+    if not isinstance(data, dict):
+        raise PlaceFulfillmentError(f"Invalid response from fulfillment API: {data!r}")
+    if not data.get("success", True):
+        raise PlaceFulfillmentError(f"Home Assistant error: {data.get('message', data)}")
+    return data
+
+
+class Provider:
+    def __init__(self, authorized_session: AbstractAuth) -> None:
+        self.authorized_session = authorized_session
+
+    async def discover(self) -> list[DiscoverDevice]:
+        data = await _send_command(self.authorized_session, "DISCOVER")
+        devices_raw = (data.get("data") or {}).get("devices") or []
+        return [DiscoverDevice.from_dict(raw) for raw in devices_raw]
+
+    async def enable(self):
+        return await _send_command(self.authorized_session, "ENABLE")
+
+    async def disable(self):
+        return await _send_command(self.authorized_session, "DISABLE")

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

@@ -1,9 +1,11 @@
 Metadata-Version: 2.4
 Name: place-integration-api
-Version: 0.2.4
+Version: 0.2.6
 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/
+Project-URL: Homepage, https://placehomesolutions.com
+Project-URL: Issues, https://placehomesolutions.com/support
+Project-URL: Repository, https://github.com/Gentex-Corporation/place-integration-api
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -25,3 +27,15 @@ Dynamic: license-file
 # Place integration API
 
 This project contains a python API to connect MQTT data from Place devices to Place's Home Assistant integration
+
+## Setup
+
+This repo utilizes VS Code [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) so you don't need to alter your global python environment.
+
+## Installing dependencies
+
+Use `pip` to install required dependencies by running `pip install -r requirements.txt` from the project root.
+
+## Updating dependencies
+
+During the course of development, if new packages are added, it's recommended to update [`requirements.txt`](./requirements.txt) by running `pip freeze > requirements.txt`.

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

@@ -2,6 +2,7 @@ LICENSE
 README.md
 pyproject.toml
 src/place/config.py
+src/place/errors.py
 src/place/messages.py
 src/place/mqtt_client.py
 src/place/provider.py

place_integration_api-0.2.6/tests/test_auth.py

@@ -0,0 +1,70 @@
+from __future__ import annotations
+
+import asyncio
+from unittest.mock import AsyncMock, MagicMock, patch
+
+import pytest
+from aiohttp import ClientResponseError
+
+from place.auth import get_iot_credentials
+from place.auth.abstract_auth import AbstractAuth
+
+
+class _FakeAuth(AbstractAuth):
+    async def async_get_access_token(self) -> str:
+        return "token"
+
+
+@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
+
+    identity_client.get_id.return_value = {"IdentityId": "identity-123"}
+    identity_client.get_credentials_for_identity.return_value = {
+        "Credentials": {
+            "AccessKeyId": "AKIA...",
+            "SecretKey": "secret",
+            "SessionToken": "session",
+        }
+    }
+
+
+    creds = get_iot_credentials(
+        id_token="id-token",
+        access_token="access-token",
+    )
+
+    assert creds.access_key_id == "AKIA..."
+    assert creds.secret_access_key == "secret"
+    assert creds.session_token == "session"
+    assert creds.identity_id == "identity-123"
+    assert creds.access_token == "access-token"
+
+
+def test_request_raises_for_non_2xx_status() -> None:
+    response = MagicMock()
+    response.raise_for_status.side_effect = ClientResponseError(
+        request_info=MagicMock(), history=(), status=401
+    )
+    websession = MagicMock()
+    websession.request = AsyncMock(return_value=response)
+
+    auth = _FakeAuth(websession)
+
+    with pytest.raises(ClientResponseError):
+        asyncio.run(auth.request("POST", "https://example.com"))
+
+
+def test_request_returns_response_for_2xx_status() -> None:
+    response = MagicMock()
+    response.raise_for_status.return_value = None
+    websession = MagicMock()
+    websession.request = AsyncMock(return_value=response)
+
+    auth = _FakeAuth(websession)
+
+    result = asyncio.run(auth.request("POST", "https://example.com"))
+
+    assert result is response
+    response.raise_for_status.assert_called_once()

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

@@ -2,8 +2,11 @@ from __future__ import annotations
 
 import asyncio
 
+import pytest
+
 from place.auth.abstract_auth import AbstractAuth
 from place.config import FULFILLMENT_URL
+from place.errors import PlaceFulfillmentError
 from place.provider import Provider
 
 
@@ -101,3 +104,79 @@ def test_provider_disable_sends_disable_command() -> None:
 
     assert auth.calls == [("POST", FULFILLMENT_URL, {"json": {"command": "DISABLE", "data": {}}})]
     assert result == payload
+
+
+def test_provider_discover_raises_on_success_false() -> None:
+    payload = {"success": False, "message": "not authorized"}
+
+    class DummyAuth(AbstractAuth):
+        async def async_get_access_token(self) -> str:
+            return "token"
+
+        async def request(self, method, url, **kwargs):
+            class DummyResponse:
+                async def json(self_inner):
+                    return payload
+
+            return DummyResponse()
+
+    provider = Provider(DummyAuth(None))
+
+    with pytest.raises(PlaceFulfillmentError):
+        asyncio.run(provider.discover())
+
+
+def test_provider_enable_raises_on_success_false() -> None:
+    payload = {"success": False, "message": "not authorized"}
+
+    class DummyAuth(AbstractAuth):
+        async def async_get_access_token(self) -> str:
+            return "token"
+
+        async def request(self, method, url, **kwargs):
+            class DummyResponse:
+                async def json(self_inner):
+                    return payload
+
+            return DummyResponse()
+
+    provider = Provider(DummyAuth(None))
+
+    with pytest.raises(PlaceFulfillmentError):
+        asyncio.run(provider.enable())
+
+
+def test_provider_raises_on_non_dict_response() -> None:
+    class DummyAuth(AbstractAuth):
+        async def async_get_access_token(self) -> str:
+            return "token"
+
+        async def request(self, method, url, **kwargs):
+            class DummyResponse:
+                async def json(self_inner):
+                    return None
+
+            return DummyResponse()
+
+    provider = Provider(DummyAuth(None))
+
+    with pytest.raises(PlaceFulfillmentError):
+        asyncio.run(provider.discover())
+
+
+def test_provider_raises_on_invalid_json_body() -> None:
+    class DummyAuth(AbstractAuth):
+        async def async_get_access_token(self) -> str:
+            return "token"
+
+        async def request(self, method, url, **kwargs):
+            class DummyResponse:
+                async def json(self_inner):
+                    raise ValueError("Expecting value: line 1 column 1 (char 0)")
+
+            return DummyResponse()
+
+    provider = Provider(DummyAuth(None))
+
+    with pytest.raises(PlaceFulfillmentError):
+        asyncio.run(provider.discover())

place_integration_api-0.2.4/README.md

@@ -1,3 +0,0 @@
-# Place integration API
-
-This project contains a python API to connect MQTT data from Place devices to Place's Home Assistant integration

place_integration_api-0.2.4/src/place/provider.py

@@ -1,38 +0,0 @@
-from __future__ import annotations
-
-from .auth.abstract_auth import AbstractAuth
-from .models.discover_device import DiscoverDevice
-from .config import FULFILLMENT_URL
-
-class Provider:
-    def __init__(self, authorized_session: AbstractAuth) -> None:
-        self.authorized_session = authorized_session
-
-
-    async def discover(self) -> list[DiscoverDevice]:
-        body = {"command": "DISCOVER", "data": {}}
-        resp = await self.authorized_session.request("POST", FULFILLMENT_URL, json=body)
-        data = await resp.json()
-        if not data.get("success", True):
-            raise RuntimeError(f"Home Assistant error: {data.get('message', data)}")
-        devices_raw = (data.get("data") or {}).get("devices") or []
-        devices: list[DiscoverDevice] = []
-        for raw in devices_raw:
-            devices.append(DiscoverDevice.from_dict(raw))
-        return devices
-
-    async def enable(self):
-        body = {"command": "ENABLE", "data": {}}
-        resp = await self.authorized_session.request("POST", FULFILLMENT_URL, json=body)
-        data = await resp.json()
-        if not data.get("success", True):
-            raise RuntimeError(f"Home Assistant error: {data.get('message', data)}")
-        return data
-    
-    async def disable(self):
-        body = {"command": "DISABLE", "data": {}}
-        resp = await self.authorized_session.request("POST", FULFILLMENT_URL, json=body)
-        data = await resp.json()
-        if not data.get("success", True):
-            raise RuntimeError(f"Home Assistant error: {data.get('message', data)}")
-        return data

place_integration_api-0.2.4/tests/test_auth.py

@@ -1,31 +0,0 @@
-from __future__ import annotations
-
-from unittest.mock import MagicMock, patch
-from place.auth import get_iot_credentials
-
-
-@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
-
-    identity_client.get_id.return_value = {"IdentityId": "identity-123"}
-    identity_client.get_credentials_for_identity.return_value = {
-        "Credentials": {
-            "AccessKeyId": "AKIA...",
-            "SecretKey": "secret",
-            "SessionToken": "session",
-        }
-    }
-
-
-    creds = get_iot_credentials(
-        id_token="id-token",
-        access_token="access-token",
-    )
-
-    assert creds.access_key_id == "AKIA..."
-    assert creds.secret_access_key == "secret"
-    assert creds.session_token == "session"
-    assert creds.identity_id == "identity-123"
-    assert creds.access_token == "access-token"