petsafe-api 3.1.2__tar.gz → 3.2.0__tar.gz

{petsafe_api-3.1.2 → petsafe_api-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: petsafe-api
-Version: 3.1.2
+Version: 3.2.0
 Summary: Provides ability to connect and control a PetSafe Smart Feed, Scoopfree, and Smart Door devices using the PetSafe API.
 Home-page: https://github.com/ThomasHFWright/petsafe-api
 Author: Jordan Stremming & Dominick Meglio & Thomas Wright
@@ -57,7 +57,7 @@ Thank you to both projects for building the API integrations for existing feeder
 If installing from source code,
 `python setup.py install`
 
-## Local SmartDoor control and provisioning (3.1.0)
+## Local SmartDoor control and provisioning (3.2.0)
 
 `LocalPetSafeClient` connects to a compatible local server using its HTTPS origin
 and API token. It does not use a PetSafe vendor login, and returns the same
@@ -77,6 +77,9 @@ async def main() -> None:
         await door.unlock()
         await door.smart_mode()
 
+        async for snapshot in client.iter_events():
+            print(snapshot["revision"], snapshot["door"])
+
 
 asyncio.run(main())
 ```

{petsafe_api-3.1.2 → petsafe_api-3.2.0}/README.md

@@ -24,7 +24,7 @@ Thank you to both projects for building the API integrations for existing feeder
 If installing from source code,
 `python setup.py install`
 
-## Local SmartDoor control and provisioning (3.1.0)
+## Local SmartDoor control and provisioning (3.2.0)
 
 `LocalPetSafeClient` connects to a compatible local server using its HTTPS origin
 and API token. It does not use a PetSafe vendor login, and returns the same
@@ -44,6 +44,9 @@ async def main() -> None:
         await door.unlock()
         await door.smart_mode()
 
+        async for snapshot in client.iter_events():
+            print(snapshot["revision"], snapshot["door"])
+
 
 asyncio.run(main())
 ```

{petsafe_api-3.1.2 → petsafe_api-3.2.0}/petsafe/local.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 
 import asyncio
 import json
+import math
 from typing import Any, Optional
 from urllib.parse import unquote, urlsplit
 
@@ -12,6 +13,7 @@ from .devices import DeviceSmartDoor
 from .setup import _TOKEN
 
 MAX_RESPONSE_BYTES = 1024 * 1024
+MAX_EVENT_BYTES = 4 * 1024 * 1024
 
 
 class LocalPetSafeClient:
@@ -97,6 +99,101 @@ class LocalPetSafeClient:
     async def api_delete(self, path: str = "") -> httpx.Response:
         return await self._request("DELETE", path)
 
+    async def iter_events(self):
+        """Yield validated full snapshots from the local server's SSE stream."""
+        request = self._client.build_request(
+            "GET", self._request_url("events"),
+            headers={"Authorization": f"Bearer {self._api_token}",
+                     "Accept": "text/event-stream"},
+            timeout=httpx.Timeout(60, read=45),
+        )
+        response = await self._client.send(request, stream=True, follow_redirects=False)
+        event_type, event_data, event_bytes = None, [], 0
+        try:
+            response.raise_for_status()
+            if response.headers.get("content-type", "").split(";", 1)[0].strip().lower() != "text/event-stream":
+                raise ValueError("Unexpected local events content type")
+            buffer = bytearray()
+            async for chunk in response.aiter_bytes():
+                buffer.extend(chunk)
+                while b"\n" in buffer:
+                    line, _, remainder = buffer.partition(b"\n")
+                    buffer = bytearray(remainder)
+                    event_bytes += len(line) + 1
+                    if event_bytes > MAX_EVENT_BYTES:
+                        raise ValueError("SSE event is too large")
+                    line = line.removesuffix(b"\r")
+                    if line:
+                        if line.startswith(b":"):
+                            continue
+                        try:
+                            field, separator, value = line.decode("UTF-8").partition(":")
+                        except UnicodeDecodeError as error:
+                            raise ValueError("Invalid UTF-8 in SSE event") from error
+                        if separator and value.startswith(" "):
+                            value = value[1:]
+                        if field == "event":
+                            event_type = value
+                        elif field == "data":
+                            event_data.append(value)
+                        continue
+                    event = self._snapshot(event_type, event_data)
+                    event_type, event_data, event_bytes = None, [], 0
+                    if event is not None:
+                        yield event
+                if event_bytes + len(buffer) > MAX_EVENT_BYTES:
+                    raise ValueError("SSE event is too large")
+            # A disconnected peer may leave a partial frame; reconnect policy belongs to the caller.
+        finally:
+            await response.aclose()
+
+    @classmethod
+    def _snapshot(cls, event_type: Optional[str], data: list[str]):
+        if event_type != "snapshot":
+            return None
+        if not data:
+            raise ValueError("Snapshot event has no data")
+        try:
+            payload = json.loads("\n".join(data), parse_constant=lambda value: (_ for _ in ()).throw(
+                ValueError("Invalid JSON number")))
+        except (TypeError, ValueError, RecursionError) as error:
+            raise ValueError("Invalid snapshot JSON") from error
+        keys = {"version", "revision", "brokerConnected", "door", "pets",
+                "links", "activity", "override"}
+        try:
+            finite = cls._finite(payload)
+        except RecursionError as error:
+            raise ValueError("Invalid snapshot schema") from error
+        if (not isinstance(payload, dict) or set(payload) != keys
+                or type(payload["version"]) is not int or payload["version"] != 1
+                or type(payload["revision"]) is not int
+                or payload["revision"] < 0
+                or type(payload["brokerConnected"]) is not bool
+                or not isinstance(payload["door"], dict)
+                or not isinstance(payload["pets"], list)
+                or any(not isinstance(item, dict) for item in payload["pets"])
+                or not isinstance(payload["links"], dict)
+                or any(not isinstance(key, str) or not isinstance(items, list)
+                       or any(not isinstance(item, dict) for item in items)
+                       for key, items in payload["links"].items())
+                or not isinstance(payload["activity"], list)
+                or any(not isinstance(item, dict) for item in payload["activity"])
+                or payload["override"] is not None and not isinstance(payload["override"], dict)
+                or not finite):
+            raise ValueError("Invalid snapshot schema")
+        return payload
+
+    @staticmethod
+    def _finite(value: Any) -> bool:
+        if isinstance(value, float):
+            return math.isfinite(value)
+        if isinstance(value, dict):
+            return all(isinstance(key, str) and LocalPetSafeClient._finite(item)
+                       for key, item in value.items())
+        if isinstance(value, list):
+            return all(LocalPetSafeClient._finite(item) for item in value)
+        return True
+
     async def get_smartdoors(self) -> list[DeviceSmartDoor]:
         response = await self.api_get("smartdoor/product/product")
         payload = json.loads(response.content.decode("UTF-8"))

{petsafe_api-3.1.2 → petsafe_api-3.2.0}/petsafe_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: petsafe-api
-Version: 3.1.2
+Version: 3.2.0
 Summary: Provides ability to connect and control a PetSafe Smart Feed, Scoopfree, and Smart Door devices using the PetSafe API.
 Home-page: https://github.com/ThomasHFWright/petsafe-api
 Author: Jordan Stremming & Dominick Meglio & Thomas Wright
@@ -57,7 +57,7 @@ Thank you to both projects for building the API integrations for existing feeder
 If installing from source code,
 `python setup.py install`
 
-## Local SmartDoor control and provisioning (3.1.0)
+## Local SmartDoor control and provisioning (3.2.0)
 
 `LocalPetSafeClient` connects to a compatible local server using its HTTPS origin
 and API token. It does not use a PetSafe vendor login, and returns the same
@@ -77,6 +77,9 @@ async def main() -> None:
         await door.unlock()
         await door.smart_mode()
 
+        async for snapshot in client.iter_events():
+            print(snapshot["revision"], snapshot["door"])
+
 
 asyncio.run(main())
 ```

{petsafe_api-3.1.2 → petsafe_api-3.2.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="petsafe-api",
-    version="3.1.2",
+    version="3.2.0",
     author="Jordan Stremming & Dominick Meglio & Thomas Wright",
     license="MIT",
     author_email="thomas.h.f.wright@gmail.com",

{petsafe_api-3.1.2 → petsafe_api-3.2.0}/tests/test_local.py

@@ -8,7 +8,7 @@ import pytest
 import petsafe
 from petsafe import pets
 from petsafe.devices import DeviceSmartDoor
-from petsafe.local import MAX_RESPONSE_BYTES
+from petsafe.local import MAX_EVENT_BYTES, MAX_RESPONSE_BYTES
 
 
 BASE = "https://local.example.test"
@@ -166,3 +166,78 @@ def test_smartdoor_collection_shape_is_validated(payload):
                 await petsafe.LocalPetSafeClient(BASE, TOKEN, client=http).get_smartdoors()
 
     run(check())
+
+
+def test_iter_events_parses_snapshots_and_closes_stream():
+    snapshot = {"version": 1, "revision": 7, "brokerConnected": True,
+                "door": {"thingName": "door-test"}, "pets": [], "links": {},
+                "activity": [], "override": None}
+
+    class Stream(httpx.AsyncByteStream):
+        closed = False
+
+        async def __aiter__(self):
+            encoded = json.dumps(snapshot)
+            split = encoded.index('"door"')
+            yield (": heartbeat\n\nevent: snapshot\nid: 7\ndata: " + encoded[:split]
+                   + "\ndata: " + encoded[split:] + "\n\n").encode()
+
+        async def aclose(self):
+            self.closed = True
+
+    stream = Stream()
+
+    async def handler(request):
+        assert request.url == BASE + "/local/events"
+        assert request.headers["authorization"] == f"Bearer {TOKEN}"
+        assert request.headers["accept"] == "text/event-stream"
+        assert request.extensions["timeout"]["read"] == 45
+        return httpx.Response(200, headers={"content-type": "text/event-stream; charset=utf-8"},
+                              stream=stream)
+
+    async def check():
+        async with httpx.AsyncClient(transport=httpx.MockTransport(handler)) as http:
+            events = petsafe.LocalPetSafeClient(BASE, TOKEN, client=http).iter_events()
+            assert await events.__anext__() == snapshot
+            await events.aclose()
+            assert stream.closed
+
+    run(check())
+
+
+@pytest.mark.parametrize("body, message", [
+    (b"event: snapshot\ndata: {}\n\n", "schema"),
+    (b"event: snapshot\ndata: {\"version\":NaN}\n\n", "JSON"),
+    (b":" + b"x" * MAX_EVENT_BYTES + b"\n", "too large"),
+])
+def test_iter_events_rejects_invalid_or_oversized_frames(body, message):
+    async def check():
+        async with httpx.AsyncClient(transport=httpx.MockTransport(
+                lambda request: httpx.Response(200, headers={"content-type": "text/event-stream"},
+                                               content=body))) as http:
+            with pytest.raises(ValueError, match=message):
+                await petsafe.LocalPetSafeClient(BASE, TOKEN, client=http).iter_events().__anext__()
+
+    run(check())
+
+
+def test_iter_events_preserves_http_status_errors():
+    async def check():
+        async with httpx.AsyncClient(transport=httpx.MockTransport(
+                lambda request: httpx.Response(401))) as http:
+            with pytest.raises(httpx.HTTPStatusError) as raised:
+                await petsafe.LocalPetSafeClient(BASE, TOKEN, client=http).iter_events().__anext__()
+            assert raised.value.response.status_code == 401
+
+    run(check())
+
+
+def test_iter_events_sanitizes_deep_schema_recursion():
+    nested = "[]"
+    for _ in range(500):
+        nested = "[" + nested + "]"
+    payload = ('{"version":1,"revision":0,"brokerConnected":true,'
+               '"door":{"nested":' + nested
+               + '},"pets":[],"links":{},"activity":[],"override":null}')
+    with pytest.raises(ValueError, match="snapshot schema"):
+        petsafe.LocalPetSafeClient._snapshot("snapshot", [payload])