python-homely 0.1.7__tar.gz → 0.1.9__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: python-homely
3
- Version: 0.1.7
3
+ Version: 0.1.9
4
4
  Summary: Async Python client for the Homely cloud API, built for Home Assistant but usable anywhere.
5
5
  Author: Ludvik Blichfeldt Rød
6
6
  License-Expression: MIT
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "python-homely"
7
- version = "0.1.7"
7
+ version = "0.1.9"
8
8
  description = "Async Python client for the Homely cloud API, built for Home Assistant but usable anywhere."
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.12"
@@ -189,6 +189,7 @@ class HomelyClient:
189
189
  payload=payload,
190
190
  invalid_reason="invalid_refresh_token",
191
191
  action="Token refresh",
192
+ extra_headers={"X-Forwarded-For": "0.0.0.0"},
192
193
  )
193
194
 
194
195
  async def fetch_refresh_token(self, refresh_token: str) -> dict[str, Any] | None:
@@ -217,12 +218,15 @@ class HomelyClient:
217
218
  payload: dict[str, Any],
218
219
  invalid_reason: TokenFailureReason,
219
220
  action: str,
221
+ extra_headers: dict[str, str] | None = None,
220
222
  ) -> TokenEndpointResult:
221
223
  """Post to a token endpoint and return a detailed typed result."""
222
224
  url = f"{self._base_url}{endpoint}"
223
225
 
224
226
  try:
225
- async with self._session.post(url, json=payload, timeout=self._timeout) as response:
227
+ async with self._session.post(
228
+ url, json=payload, headers=extra_headers, timeout=self._timeout
229
+ ) as response:
226
230
  body_preview = await self._response_text_preview(response)
227
231
  if response.status in (200, 201):
228
232
  try:
@@ -442,10 +446,18 @@ class HomelyClient:
442
446
  )
443
447
  return None, response.status
444
448
  return parsed, response.status
449
+ retry_after = response.headers.get("Retry-After")
450
+ try:
451
+ body = await response.text()
452
+ except Exception:
453
+ body = "<unreadable>"
445
454
  _LOGGER.debug(
446
- "Location data fetch failed with status=%s location_id=%s",
455
+ "Location data fetch failed with status=%s location_id=%s "
456
+ "retry_after=%s body=%s",
447
457
  response.status,
448
458
  _log_identifier(location_id),
459
+ retry_after,
460
+ body[:500] if body else None,
449
461
  )
450
462
  return None, response.status
451
463
  except (aiohttp.ClientError, TimeoutError) as err:
@@ -89,12 +89,14 @@ class HomelyWebSocket:
89
89
  status_update_callback: Callable[[str, str | None], None] | None = None,
90
90
  context_id: str | None = None,
91
91
  entry_id: str | None = None,
92
+ partner_code: int | str | None = None,
92
93
  ) -> None:
93
94
  """Initialize WebSocket client."""
94
95
  self.context_id = context_id or entry_id
95
96
  self.entry_id = self.context_id
96
97
  self.location_id = location_id
97
98
  self.token = token
99
+ self.partner_code = partner_code
98
100
  self.on_data_update = on_data_update
99
101
  self.socket: Any | None = None
100
102
  self._is_closing = False
@@ -368,10 +370,13 @@ class HomelyWebSocket:
368
370
 
369
371
  self._set_status("Connecting")
370
372
  try:
373
+ # SECURITY: never enable the engineio logger. It logs the full
374
+ # connection URL, which carries the bearer token in the query
375
+ # string (?token=Bearer <access_token>), leaking it to HA logs.
371
376
  self.socket = socketio.AsyncClient(
372
377
  reconnection=False,
373
378
  logger=False,
374
- engineio_logger=logging.getLogger("engineio.client"),
379
+ engineio_logger=False,
375
380
  )
376
381
 
377
382
  async def connect() -> None:
@@ -405,12 +410,16 @@ class HomelyWebSocket:
405
410
  self.socket.on("connect_error", connect_error)
406
411
 
407
412
  bearer_token = self._bearer_value(self.token)
408
- query = urlencode(
409
- {
410
- "locationId": str(self.location_id),
411
- "token": bearer_token,
412
- }
413
- )
413
+ query_params: dict[str, str] = {
414
+ "locationId": str(self.location_id),
415
+ "token": bearer_token,
416
+ }
417
+ # NOTE: do NOT send a "partner" query parameter. Homely's websocket
418
+ # server rejects it ("Partner <code> is not supported") and closes
419
+ # the connection immediately, causing a connect/disconnect loop.
420
+ # partner_code is accepted for API compatibility but intentionally
421
+ # unused here.
422
+ query = urlencode(query_params)
414
423
  url = f"{self.websocket_url}?{query}"
415
424
  _LOGGER.debug("WebSocket connecting %s to %s", self._ctx(), self.websocket_url)
416
425
  await asyncio.wait_for(
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: python-homely
3
- Version: 0.1.7
3
+ Version: 0.1.9
4
4
  Summary: Async Python client for the Homely cloud API, built for Home Assistant but usable anywhere.
5
5
  Author: Ludvik Blichfeldt Rød
6
6
  License-Expression: MIT
@@ -32,11 +32,13 @@ class _FakeResponse:
32
32
  json_data=None,
33
33
  text_data: str = "",
34
34
  json_exc: Exception | None = None,
35
+ headers: dict[str, str] | None = None,
35
36
  ) -> None:
36
37
  self.status = status
37
38
  self._json_data = json_data
38
39
  self._text_data = text_data
39
40
  self._json_exc = json_exc
41
+ self.headers = headers or {}
40
42
 
41
43
  async def __aenter__(self):
42
44
  return self
@@ -93,7 +95,7 @@ class _FakeAsyncCallable:
93
95
  async def test_sdk_exports_public_symbols():
94
96
  """The SDK should expose a clean public surface."""
95
97
  assert auth_header_value("token") == "Bearer token"
96
- assert __version__ == "0.1.5"
98
+ assert __version__ == "0.1.9"
97
99
 
98
100
 
99
101
  async def test_authenticate_returns_typed_token():
@@ -497,6 +499,46 @@ async def test_websocket_connection_state_uses_engineio_transport_health():
497
499
  assert state.status_mismatch is False
498
500
 
499
501
 
502
+ async def test_connect_keeps_engineio_logger_disabled(monkeypatch):
503
+ """SECURITY: the Engine.IO logger must stay off.
504
+
505
+ When enabled it logs the full connection URL, which carries the bearer
506
+ token in the query string (?token=Bearer <access_token>), leaking it to
507
+ the consuming application's logs.
508
+ """
509
+ import socketio
510
+
511
+ captured: dict[str, object] = {}
512
+ connect_args: dict[str, object] = {}
513
+
514
+ class _FakeSocket:
515
+ def __init__(self, **kwargs: object) -> None:
516
+ captured.update(kwargs)
517
+
518
+ def on(self, *args: object, **kwargs: object) -> None:
519
+ return None
520
+
521
+ async def connect(self, url: str, *args: object, **kwargs: object) -> None:
522
+ connect_args["url"] = url
523
+
524
+ # connect() does a local `import socketio`, so patch the real module.
525
+ monkeypatch.setattr(socketio, "AsyncClient", _FakeSocket)
526
+
527
+ ws = HomelyWebSocket(
528
+ location_id="loc-1",
529
+ token="super-secret-token",
530
+ on_data_update=lambda _data: None,
531
+ partner_code=1275,
532
+ )
533
+ await ws.connect()
534
+
535
+ assert captured.get("engineio_logger") is False
536
+ assert captured.get("logger") is False
537
+ # Homely rejects a "partner" query parameter and closes the connection,
538
+ # so it must never be sent even when partner_code is set.
539
+ assert "partner" not in str(connect_args.get("url"))
540
+
541
+
500
542
  async def test_websocket_sync_token_only_reconnects_when_transport_is_down():
501
543
  """Token sync should not nudge healthy sockets, but should reconnect dead ones."""
502
544
  ws = HomelyWebSocket(
File without changes
File without changes
File without changes