Search, view tracks websocket endpoints, service to like media.

custom_components/spotcast/spotify/account.py

@@ -34,6 +34,7 @@
     TokenError,
 )
 
+
 LOGGER = getLogger(__name__)
 
 
@@ -51,7 +52,7 @@ class SpotifyAccount:
 
     Properties:
         - id(str): the identifier of the account
-        - name(str): the dusplay name for the account
+        - name(str): the display name for the account
         - profile(dict): the full profile dictionary of the account
         - country(str): the country code where the account currently
             is.
@@ -86,6 +87,7 @@ class SpotifyAccount:
         - async_liked_songs
         - async_repeat
         - async_set_volume
+        - async_view
 
     Functions:
         - async_from_config_entry
@@ -885,7 +887,7 @@ async def async_categories(
     async def async_category_playlists(
             self,
             category_id: str,
-            limit: int = None,
+            limit: int,
     ) -> list[str]:
         """Fetches the playlist associated with a browse category
 
@@ -914,6 +916,47 @@ async def async_category_playlists(
 
         return playlists
 
+    async def async_view(
+        self,
+        url: str,
+        limit: int,
+        locale: str,
+    ) -> list:
+        """Fetches a view based on url.
+
+        Args:
+            - url(str): The url of the view to fetch (e.g., 'made-for-x').
+            - limit(int): The maximum number of playlists to retrieve.
+            - locale(str): The locale for the request (optional).
+
+        Returns:
+            - list: A list of playlists.
+        """
+
+        # Internal method, so that the _get method can be called
+        # As the pager parameters do not allign with the _get parameters
+        # Spotipy _get is defined as: def _get(self, url, args=None, payload=None, **kwargs)
+        def fetch_page(limit, offset):
+            params = {
+                "content_limit": limit,
+                "locale": locale,
+                "platform": "web",
+                "types": "album,playlist,artist,show,station",
+                "limit": limit,
+                "offset": offset,
+            }
+
+            return self._internal_cont._get(url, None, **params)
+
+        await self.async_ensure_tokens_valid()
+
+        return await self._async_pager(
+            function=fetch_page,
+            limit=25,  # This is the max amount per call
+            max_items=limit,
+            sub_layer="content",
+        )
+
     async def _async_get_count(
             self,
             function: callable,

custom_components/spotcast/websocket/__init__.py

@@ -13,6 +13,8 @@
     player_handler,
     cast_devices_handler,
     categories_handler,
+    view_handler,
+    search_handler
 )
 
 WEBSOCKET_ENDPOINTS = MappingProxyType({
@@ -40,6 +42,14 @@
         "handler": categories_handler.async_get_categories,
         "schema": categories_handler.SCHEMA,
     },
+    view_handler.ENDPOINT: {
+        "handler": view_handler.async_view_handler,
+        "schema": view_handler.SCHEMA,
+    },
+    search_handler.ENDPOINT: {
+        "handler": search_handler.async_search_handler,
+        "schema": search_handler.SCHEMA,
+    },
 })
 
 

custom_components/spotcast/websocket/search_handler.py

@@ -0,0 +1,76 @@
+import voluptuous as vol
+from custom_components.spotcast.spotify.search_query import SearchQuery
+from homeassistant.helpers import config_validation as cv
+from homeassistant.core import HomeAssistant
+from homeassistant.components.websocket_api import ActiveConnection
+
+from custom_components.spotcast.utils import get_account_entry, search_account
+from custom_components.spotcast.spotify.account import SpotifyAccount
+from custom_components.spotcast.websocket.utils import websocket_wrapper
+from custom_components.spotcast.spotify.utils import select_image_url
+
+ENDPOINT = "spotcast/search"
+SCHEMA = vol.Schema(
+    {
+        vol.Required("id"): cv.positive_int,
+        vol.Required("type"): ENDPOINT,
+        vol.Required("query"): cv.string,
+        vol.Optional("searchType"): cv.string,  # Playlist or song, default playlist
+        vol.Optional("limit"): cv.positive_int,
+        vol.Optional("account"): cv.string,
+    }
+)
+
+
+@websocket_wrapper
+async def async_search_handler(
+    hass: HomeAssistant, connection: ActiveConnection, msg: dict
+):
+    """Searches for playlists or tracks.
+
+    Args:
+        - hass (HomeAssistant): The Home Assistant instance.
+        - connection (ActiveConnection): The active WebSocket connection.
+        - msg (dict): The message received through the WebSocket API.
+    """
+    account_id = msg.get("account")
+    query = msg.get("query")
+    searchType = msg.get("searchType", "playlist")
+    limit = msg.get("limit", 10)
+
+    account: SpotifyAccount
+
+    if account_id is None:
+        entry = get_account_entry(hass)
+        account_id = entry.entry_id
+        account = await SpotifyAccount.async_from_config_entry(hass, entry)
+    else:
+        account = search_account(hass, account_id)
+
+    query = SearchQuery(search=query, item_type=searchType)
+
+    results = await account.async_search(
+        query,
+        limit,
+    )
+
+    formatted_results = [
+        {
+            "id": result.get("id", None),
+            "name": result["name"],
+            "href": result["href"],
+            "icon": result["images"][0]["url"]
+            if "images" in result and len(result["images"]) > 0
+            else None,
+        }
+        for result in results
+    ]
+
+    connection.send_result(
+        msg["id"],
+        {
+            "total": len(formatted_results),
+            "account": account_id,
+            f"{searchType}s": formatted_results,
+        },
+    )

custom_components/spotcast/websocket/view_handler.py

@@ -0,0 +1,79 @@
+import voluptuous as vol
+from homeassistant.helpers import config_validation as cv
+from homeassistant.core import HomeAssistant
+from homeassistant.components.websocket_api import ActiveConnection
+
+from custom_components.spotcast.utils import get_account_entry, search_account
+from custom_components.spotcast.spotify.account import SpotifyAccount
+from custom_components.spotcast.websocket.utils import websocket_wrapper
+from custom_components.spotcast.spotify.utils import select_image_url
+
+ENDPOINT = "spotcast/view"
+SCHEMA = vol.Schema(
+    {
+        vol.Required("id"): cv.positive_int,
+        vol.Required("type"): ENDPOINT,
+        vol.Required("url"): cv.string,
+        vol.Optional("limit"): cv.positive_int,
+        vol.Optional("locale"): cv.string,
+        vol.Optional("platform"): cv.string,
+        vol.Optional("types"): cv.string,
+        vol.Optional("account"): cv.string,
+    }
+)
+
+
+@websocket_wrapper
+async def async_view_handler(
+    hass: HomeAssistant, connection: ActiveConnection, msg: dict
+):
+    """Gets a list of playlists from a specified account.
+
+    Args:
+        - hass (HomeAssistant): The Home Assistant instance.
+        - connection (ActiveConnection): The active WebSocket connection.
+        - msg (dict): The message received through the WebSocket API.
+    """
+    account_id = msg.get("account")
+    url = msg.get("url")
+    limit = msg.get("limit", 10)
+    locale = msg.get("locale", "en_US")
+
+    account: SpotifyAccount
+
+    if account_id is None:
+        entry = get_account_entry(hass)
+        account_id = entry.entry_id
+        account = await SpotifyAccount.async_from_config_entry(hass, entry)
+    else:
+        account = search_account(hass, account_id)
+
+    # prepend views/ to the url
+    url = f"views/{url}"
+
+    raw_playlists = await account.async_view(
+        url=url,
+        limit=limit,
+        locale=locale,
+    )
+
+    formatted_playlists = [
+        {
+            "id": playlist.get("id", None),
+            "name": playlist["name"],
+            "href": playlist["href"],
+            "icon": playlist["images"][0]["url"]
+            if "images" in playlist and len(playlist["images"]) > 0
+            else None,
+        }
+        for playlist in raw_playlists
+    ]
+
+    connection.send_result(
+        msg["id"],
+        {
+            "total": len(formatted_playlists),
+            "account": account_id,
+            "playlists": formatted_playlists,
+        },
+    )