Spotify: Play owned/starred playlists by name/by frontend

homeassistant/components/media_player/spotify.py

@@ -6,6 +6,8 @@
 """
 import logging
 from datetime import timedelta
+import json
+import os
 
 import voluptuous as vol
 
@@ -20,9 +22,8 @@
     CONF_NAME, STATE_PLAYING, STATE_PAUSED, STATE_IDLE, STATE_UNKNOWN)
 import homeassistant.helpers.config_validation as cv
 
-COMMIT = '544614f4b1d508201d363e84e871f86c90aa26b2'
-REQUIREMENTS = ['https://github.com/happyleavesaoc/spotipy/'
-                'archive/%s.zip#spotipy==2.4.4' % COMMIT]
+REQUIREMENTS = ['https://github.com/plamere/spotipy/'
+                'archive/master.zip#spotipy==2.4.4']
 
 DEPENDENCIES = ['http']
 
@@ -32,7 +33,8 @@
     SUPPORT_NEXT_TRACK | SUPPORT_PREVIOUS_TRACK | SUPPORT_SELECT_SOURCE |\
     SUPPORT_PLAY_MEDIA | SUPPORT_SHUFFLE_SET
 
-SCOPE = 'user-read-playback-state user-modify-playback-state user-read-private'
+SCOPE = 'user-read-playback-state user-modify-playback-state \
+            user-read-private playlist-read-private'
 DEFAULT_CACHE_PATH = '.spotify-token-cache'
 AUTH_CALLBACK_PATH = '/api/spotify'
 AUTH_CALLBACK_NAME = 'api:spotify'
@@ -57,6 +59,7 @@
 })
 
 SCAN_INTERVAL = timedelta(seconds=30)
+PERSISTENCE = '.spotify_playlists.json'
 
 
 def request_configuration(hass, config, add_devices, oauth):
@@ -90,8 +93,10 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
         configurator = hass.components.configurator
         configurator.request_done(hass.data.get(DOMAIN))
         del hass.data[DOMAIN]
+    playlistdata = hass.data[DOMAIN] = PlaylistData(hass)
+    hass.http.register_view(SpotifyPlaylistView)
     player = SpotifyMediaPlayer(oauth, config.get(CONF_NAME, DEFAULT_NAME),
-                                config[CONF_ALIASES])
+                                config[CONF_ALIASES], playlistdata)
     add_devices([player], True)
 
 
@@ -119,7 +124,7 @@ def get(self, request):
 class SpotifyMediaPlayer(MediaPlayerDevice):
     """Representation of a Spotify controller."""
 
-    def __init__(self, oauth, name, aliases):
+    def __init__(self, oauth, name, aliases, playlistdata):
         """Initialize."""
         self._name = name
         self._oauth = oauth
@@ -137,6 +142,7 @@ def __init__(self, oauth, name, aliases):
         self._user = None
         self._aliases = aliases
         self._token_info = self._oauth.get_cached_token()
+        self._playlistdata = playlistdata
 
     def refresh_spotify_instance(self):
         """Fetch a new spotify instance."""
@@ -210,6 +216,37 @@ def update(self):
                 self._volume = device.get('volume_percent') / 100
             if device.get('name'):
                 self._current_device = device.get('name')
+        # Discover playlists
+        discovered_playlists = self._player.current_user_playlists()
+        if discovered_playlists is not None:
+            new_playlists = {}
+            for discovered_playlist in discovered_playlists['items']:
+                playlist = {
+                    'name': discovered_playlist['name'],
+                    'id': discovered_playlist['id'],
+                    'collaborative': discovered_playlist['collaborative'],
+                    'public': discovered_playlist['public'],
+                    'owner': discovered_playlist['owner']['id'],
+                    'uri': discovered_playlist['uri'],
+                    'snapshot_id': discovered_playlist['snapshot_id'],
+                    'images': discovered_playlist['images']
+                }
+                new_playlists[discovered_playlist['id']] = playlist
+                if not (discovered_playlist['id']
+                        in self._playlistdata.playlists):
+                    self._playlistdata.update(playlist)
+                    _LOGGER.info("New playlist discovered: %s (%s)",
+                                 discovered_playlist['name'],
+                                 discovered_playlist['uri'])
+            playlist_diff = set(self._playlistdata.playlists.keys()) - \
+                set(new_playlists.keys())
+        if playlist_diff is not None:
+            for removed_playlist in playlist_diff:
+                _LOGGER.info("Playlist removed: %s (%s)",
+                             removed_playlist['name'],
+                             removed_playlist['uri'])
+                del self._playlistdata.playlists[removed_playlist]
+                self._playlistdata.update()
 
     def set_volume_level(self, volume):
         """Set the volume level."""
@@ -247,12 +284,15 @@ def play_media(self, media_type, media_id, **kwargs):
         if media_type == MEDIA_TYPE_MUSIC:
             kwargs['uris'] = [media_id]
         elif media_type == MEDIA_TYPE_PLAYLIST:
+            for playlist in self._playlistdata.playlists.values():
+                if media_id in str(playlist):
+                    media_id = playlist["uri"]
             kwargs['context_uri'] = media_id
         else:
             _LOGGER.error("media type %s is not supported", media_type)
             return
         if not media_id.startswith('spotify:'):
-            _LOGGER.error("media id must be spotify uri")
+            _LOGGER.error("media id %s is not a valid spotify uri", media_id)
             return
         self._player.start_playback(**kwargs)
 
@@ -328,3 +368,43 @@ def supported_features(self):
     def media_content_type(self):
         """Return the media type."""
         return MEDIA_TYPE_MUSIC
+
+
+class SpotifyPlaylistView(HomeAssistantView):
+    """View to retrieve Spotify Playlists."""
+
+    url = '/api/spotify/playlists'
+    name = "api:spotify/playlists"
+
+    @callback
+    def get(self, request):
+        """Retrieve playlists."""
+        return self.json(request.app['hass'].data[DOMAIN].playlists)
+
+
+class PlaylistData:
+    """Class to hold Spotify playlist data."""
+
+    def __init__(self, hass):
+        """Initialize the Spotify playlist store list."""
+        self.hass = hass
+        self.playlists = self.load()
+
+    def update(self, playlist=None):
+        """Add a playlist."""
+        if playlist is not None:
+            self.playlists[playlist['id']] = playlist
+        self.save()
+
+    def load(self):
+        """Load the playlists."""
+        path = self.hass.config.path(PERSISTENCE)
+        if not os.path.isfile(path):
+            return {}
+        with open(path) as p_file:
+            return json.loads(p_file)
+
+    def save(self):
+        """Save playlists."""
+        with open(self.hass.config.path(PERSISTENCE), 'wt') as p_file:
+            json.dump(self.playlist, yp_file)

requirements_all.txt

@@ -351,9 +351,6 @@ httplib2==0.10.3
 # homeassistant.components.media_player.braviatv
 https://github.com/aparraga/braviarc/archive/0.3.7.zip#braviarc==0.3.7
 
-# homeassistant.components.media_player.spotify
-https://github.com/happyleavesaoc/spotipy/archive/544614f4b1d508201d363e84e871f86c90aa26b2.zip#spotipy==2.4.4
-
 # homeassistant.components.netatmo
 https://github.com/jabesq/netatmo-api-python/archive/v0.9.2.1.zip#lnetatmo==0.9.2.1
 
@@ -366,6 +363,9 @@ https://github.com/jamespcole/home-assistant-nzb-clients/archive/616cad591540925
 # homeassistant.components.switch.anel_pwrctrl
 https://github.com/mweinelt/anel-pwrctrl/archive/ed26e8830e28a2bfa4260a9002db23ce3e7e63d7.zip#anel_pwrctrl==0.0.1
 
+# homeassistant.components.media_player.spotify
+https://github.com/plamere/spotipy/archive/master.zip#spotipy==2.4.4
+
 # homeassistant.components.switch.edimax
 https://github.com/rkabadi/pyedimax/archive/365301ce3ff26129a7910c501ead09ea625f3700.zip#pyedimax==0.1