Remove legacy client dependency and use local REST data models

Author: alphasixtyfive

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 0.2.0
 
 - Replace inherited network methods with one validated, bounded HTTP transport.
+- Remove the legacy pycasatunes dependency; use local REST data models and HA's shared aiohttp session.
 - Preserve zone unique IDs and native search, TTS and doorbell services.
 - Use typed runtime data and current Home Assistant service/discovery interfaces.
 - Publish complete poll snapshots and cache system/source metadata.

custom_components/casatunes/api.py

@@ -10,17 +10,20 @@
 from urllib.parse import quote, urlencode
 
 from aiohttp import ClientError, ClientSession, ClientTimeout
-from pycasatunes.const import API_PORT
-from pycasatunes.exceptions import CasaException
-from pycasatunes.objects.nowplaying import CasaTunesNowPlaying
-from pycasatunes.objects.source import CasaTunesSource
-from pycasatunes.objects.system import CasaTunesSystem
-from pycasatunes.objects.zone import CasaTunesZone
+
+from .models import (
+    CasaException,
+    CasaTunesNowPlaying,
+    CasaTunesSource,
+    CasaTunesSystem,
+    CasaTunesZone,
+)
 
 _CasaTunesObjectT = TypeVar("_CasaTunesObjectT")
 
 
 _LOGGER = logging.getLogger(__name__)
+API_PORT = 8735
 REQUEST_TIMEOUT = ClientTimeout(total=10)
 
 

custom_components/casatunes/browse_media.py

@@ -5,7 +5,8 @@
 
 from homeassistant.components.media_player import BrowseMedia, MediaClass, MediaType
 from homeassistant.components.media_player.errors import BrowseError
-from pycasatunes.exceptions import CasaException
+
+from .models import CasaException
 
 
 class UnknownMediaType(BrowseError):

custom_components/casatunes/config_flow.py

@@ -18,10 +18,10 @@
     ATTR_UPNP_FRIENDLY_NAME,
     SsdpServiceInfo,
 )
-from pycasatunes.exceptions import CasaException
 
 from .api import CasaTunesClient
 from .const import DOMAIN
+from .models import CasaException
 
 _LOGGER = logging.getLogger(__name__)
 CONNECT_ERRORS = (CasaException, ClientError, TimeoutError)

custom_components/casatunes/coordinator.py

@@ -8,10 +8,10 @@
 from homeassistant.exceptions import HomeAssistantError
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 from homeassistant.util.dt import utcnow
-from pycasatunes.exceptions import CasaException
 
 from .api import CasaTunesClient, CasaTunesData
 from .const import DOMAIN
+from .models import CasaException
 
 _LOGGER = logging.getLogger(__name__)
 

custom_components/casatunes/manifest.json

@@ -8,10 +8,7 @@
   "documentation": "https://github.com/alphasixtyfive/casatunes",
   "iot_class": "local_polling",
   "issue_tracker": "https://github.com/alphasixtyfive/casatunes/issues",
-  "requirements": [
-    "pycasatunes==0.1.3",
-    "async-timeout==5.0.1"
-  ],
+  "requirements": [],
   "ssdp": [
     {
       "deviceType": "urn:schemas-upnp-org:device:MediaRenderer:1",

custom_components/casatunes/media_player.py

@@ -21,7 +21,6 @@
 from homeassistant.exceptions import ServiceValidationError
 from homeassistant.helpers import config_validation as cv
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
-from pycasatunes.objects.zone import CasaTunesZone
 
 from .browse_media import CT_ALLOWSELECT, CT_COLLECTION, build_item_response
 from .const import (
@@ -42,6 +41,7 @@
 )
 from .coordinator import CasaTunesDataUpdateCoordinator
 from .entity import CasaTunesDeviceEntity
+from .models import CasaTunesZone
 
 _LOGGER = logging.getLogger(__name__)
 

custom_components/casatunes/models.py

@@ -0,0 +1,176 @@
+"""Small data models for the documented CasaTunes REST fields."""
+
+
+class CasaException(Exception):
+    """A transport or protocol failure."""
+
+
+class CasaTunesObject:
+    """Retain one validated JSON record without any network behavior."""
+
+    def __init__(self, client, attributes):
+        self.attributes = dict(attributes)
+
+
+class CasaTunesSystem(CasaTunesObject):
+    """Read-only accessors for System data."""
+
+    @property
+    def MACAddress(self):
+        return self.attributes.get("MACAddress", "")
+
+    @property
+    def AppName(self):
+        return self.attributes.get("AppName", "")
+
+    @property
+    def CasaTunesVersion(self):
+        return self.attributes.get("CasaTunesVersion", "")
+
+    @property
+    def RESTServicesVersion(self):
+        return self.attributes.get("RESTServicesVersion", "")
+
+
+class CasaTunesZone(CasaTunesObject):
+    """Read-only accessors for Zone data."""
+
+    @property
+    def ZoneID(self):
+        return self.attributes.get("ZoneID", None)
+
+    @property
+    def Name(self):
+        return self.attributes.get("Name", "")
+
+    @property
+    def Power(self):
+        return self.attributes.get("Power", None)
+
+    @property
+    def SourceID(self):
+        return self.attributes.get("SourceID", None)
+
+    @property
+    def Volume(self):
+        return self.attributes.get("Volume", None)
+
+    @property
+    def Mute(self):
+        return self.attributes.get("Mute", False)
+
+    @property
+    def Hidden(self):
+        return self.attributes.get("Hidden", False)
+
+    @property
+    def EnabledSources(self):
+        return self.attributes.get("EnabledSources", None)
+
+    @property
+    def FixedVolumeEnabled(self):
+        return self.attributes.get("FixedVolumeEnabled", False)
+
+    @property
+    def VolumeControlType(self):
+        return self.attributes.get("VolumeControlType", 1)
+
+    @property
+    def HidePowerControl(self):
+        return self.attributes.get("HidePowerControl", False)
+
+    @property
+    def HideSourceControl(self):
+        return self.attributes.get("HideSourceControl", False)
+
+    @property
+    def SharedRoomID(self):
+        return self.attributes.get("SharedRoomID", 0)
+
+    @property
+    def MasterMode(self):
+        return self.attributes.get("MasterMode", False)
+
+    @property
+    def SleepEnabled(self):
+        return self.attributes.get("SleepEnabled", False)
+
+    @property
+    def DND(self):
+        return self.attributes.get("DND", False)
+
+
+class CasaTunesSource(CasaTunesObject):
+    """Read-only accessors for Source data."""
+
+    @property
+    def SourceID(self):
+        return self.attributes.get("SourceID", None)
+
+    @property
+    def Name(self):
+        return self.attributes.get("Name", "")
+
+    @property
+    def Hidden(self):
+        return self.attributes.get("Hidden", False)
+
+    @property
+    def MediaTypesSupported(self):
+        return self.attributes.get("MediaTypesSupported", 0)
+
+    @property
+    def Type(self):
+        return self.attributes.get("Type", None)
+
+
+class CasaTunesNowPlaying(CasaTunesObject):
+    """Read-only accessors for NowPlaying data."""
+
+    @property
+    def SourceID(self):
+        return self.attributes.get("SourceID", None)
+
+    @property
+    def Status(self):
+        return self.attributes.get("Status", 0)
+
+    @property
+    def ShuffleMode(self):
+        return self.attributes.get("ShuffleMode", False)
+
+    @property
+    def RepeatMode(self):
+        return self.attributes.get("RepeatMode", 0)
+
+    @property
+    def CurrProgress(self):
+        return self.attributes.get("CurrProgress", None)
+
+    @property
+    def CurrSong(self):
+        return CasaTunesSong(None, self.attributes.get("CurrSong") or {})
+
+
+class CasaTunesSong(CasaTunesObject):
+    """Read-only accessors for Song data."""
+
+    @property
+    def Title(self):
+        return self.attributes.get("Title", "")
+
+    @property
+    def Artists(self):
+        return self.attributes.get("Artists", "")
+
+    @property
+    def Album(self):
+        return self.attributes.get("Album", "")
+
+    @property
+    def Duration(self):
+        return self.attributes.get("Duration", None)
+
+    @property
+    def ArtworkURI(self):
+        return self.attributes.get("ArtworkURI", "")

requirements_test.txt

@@ -1,4 +1,2 @@
 pytest-homeassistant-custom-component==0.13.364
-pycasatunes==0.1.3
-async-timeout==5.0.1
 ruff==0.16.6

tests/test_api.py

@@ -2,19 +2,23 @@
 
 import importlib.util
 import sys
+import types
 from pathlib import Path
 from unittest.mock import AsyncMock
 
 import pytest
 from aiohttp import ClientError
-from pycasatunes.exceptions import CasaException
 
+package = types.ModuleType("casatunes_transport")
+package.__path__ = [str(Path(__file__).parents[1] / "custom_components/casatunes")]
+sys.modules[package.__name__] = package
 spec = importlib.util.spec_from_file_location(
-    "casatunes_api", Path(__file__).parents[1] / "custom_components/casatunes/api.py"
+    "casatunes_transport.api", Path(package.__path__[0]) / "api.py"
 )
 api = importlib.util.module_from_spec(spec)
 sys.modules[spec.name] = api
 spec.loader.exec_module(api)
+CasaException = api.CasaException
 
 
 class Response: