spotifywebapiPython 1.0.170__py3-none-any.whl → 1.0.172__py3-none-any.whl

spotifywebapipython/spotifyclient.py

@@ -803,12 +803,8 @@ class SpotifyClient:
         if (not self._HasSpotifyWebPlayerCredentials):
             return result
 
-        # was the device resolved? if not, then don't bother!
-        if (not isinstance(scDevice, SpotifyConnectDevice)):
-            return result
-
-        # is the device restricted or Sonos?
-        if (scDevice.IsSonos or scDevice.IsRestricted):
+        # was a device argument passed?  if not, then just create the token.
+        if (scDevice is None):
 
             # get spotify web player access token info from spotify web player cookie credentials.
             _logsi.LogVerbose("Converting Spotify Web Player cookie credentials to an access token for loginId \"%s\"" % (self._SpotifyConnectLoginId))
@@ -817,7 +813,25 @@ class SpotifyClient:
                                             tokenStorageFile=self._TokenStorageFile)
             if tokenWP is not None:
                 result = tokenWP.HeaderValue
-                _logsi.LogVerbose("Playback will be started using Spotify Web Player authorization access token for device: %s" % (scDevice.Title))
+                _logsi.LogVerbose("Spotify Web Player authorization access token will be used")
+
+        else:
+
+            # was the device resolved? if not, then don't bother!
+            if (not isinstance(scDevice, SpotifyConnectDevice)):
+                return result
+
+            # is the device restricted or Sonos?
+            if (scDevice.IsSonos or scDevice.IsRestricted):
+
+                # get spotify web player access token info from spotify web player cookie credentials.
+                _logsi.LogVerbose("Converting Spotify Web Player cookie credentials to an access token for loginId \"%s\"" % (self._SpotifyConnectLoginId))
+                tokenWP = SpotifyWebPlayerToken(profileId=self._SpotifyConnectLoginId,
+                                                tokenStorageDir=self._TokenStorageDir,
+                                                tokenStorageFile=self._TokenStorageFile)
+                if tokenWP is not None:
+                    result = tokenWP.HeaderValue
+                    _logsi.LogVerbose("Playback will be started using Spotify Web Player authorization access token for device: %s" % (scDevice.Title))
 
         # return result to caller.
         return result
@@ -4389,8 +4403,14 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("sortResult", sortResult)
             _logsi.LogMethodParmList(SILevel.Verbose, "Get Spotify catalog information about artists similar to a given artist", apiMethodParms)
             
-            # api endpoint no longer supported by Spotify as of 2024/11/27.
-            raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_DEPRECATED_ENDPOINT % apiMethodName)
+            # are spotify web player credentials configured? if so, then we will use them to create
+            # an elevated authorization access token for the Spotify Web API endpoint call.
+            accessTokenHeaderValue:str = self._GetSpotifyWebPlayerTokenHeaderValue()
+
+            # if spotify web player credentials not configured then we are done; the Spotify Web API
+            # endpoint is no longer supported by unauthorized Spotify Developer Applications as of 2024/11/27.
+            if (accessTokenHeaderValue is None):
+                raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_DEPRECATED_ENDPOINT % apiMethodName)
 
             # validations.
             if sortResult is None: 
@@ -4406,7 +4426,7 @@ class SpotifyClient:
 
             # execute spotify web api request.
             msg:SpotifyApiMessage = SpotifyApiMessage(apiMethodName, '/artists/{id}/related-artists'.format(id=artistId))
-            msg.RequestHeaders[self.AuthToken.HeaderKey] = self.AuthToken.HeaderValue
+            msg.RequestHeaders[self.AuthToken.HeaderKey] = accessTokenHeaderValue or self.AuthToken.HeaderValue
             self.MakeRequest('GET', msg)
 
             # process results.
@@ -5831,8 +5851,14 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("sortResult", sortResult)
             _logsi.LogMethodParmList(SILevel.Verbose, "Get a list of Spotify playlists tagged with a particular category", apiMethodParms)
                 
-            # api endpoint no longer supported by Spotify as of 2024/11/27.
-            raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_DEPRECATED_ENDPOINT % apiMethodName)
+            # are spotify web player credentials configured? if so, then we will use them to create
+            # an elevated authorization access token for the Spotify Web API endpoint call.
+            accessTokenHeaderValue:str = self._GetSpotifyWebPlayerTokenHeaderValue()
+
+            # if spotify web player credentials not configured then we are done; the Spotify Web API
+            # endpoint is no longer supported by unauthorized Spotify Developer Applications as of 2024/11/27.
+            if (accessTokenHeaderValue is None):
+                raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_DEPRECATED_ENDPOINT % apiMethodName)
 
             # validations.
             if limit is None: 
@@ -5866,7 +5892,7 @@ class SpotifyClient:
 
                 # execute spotify web api request.
                 msg:SpotifyApiMessage = SpotifyApiMessage(apiMethodName, '/browse/categories/{category_id}/playlists'.format(category_id=categoryId))
-                msg.RequestHeaders[self.AuthToken.HeaderKey] = self.AuthToken.HeaderValue
+                msg.RequestHeaders[self.AuthToken.HeaderKey] = accessTokenHeaderValue or self.AuthToken.HeaderValue
                 msg.UrlParameters = urlParms
                 self.MakeRequest('GET', msg)
 
@@ -6826,8 +6852,14 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("sortResult", sortResult)
             _logsi.LogMethodParmList(SILevel.Verbose, "Get a list of Spotify featured playlists", apiMethodParms)
                 
-            # api endpoint no longer supported by Spotify as of 2024/11/27.
-            raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_DEPRECATED_ENDPOINT % apiMethodName)
+            # are spotify web player credentials configured? if so, then we will use them to create
+            # an elevated authorization access token for the Spotify Web API endpoint call.
+            accessTokenHeaderValue:str = self._GetSpotifyWebPlayerTokenHeaderValue()
+
+            # if spotify web player credentials not configured then we are done; the Spotify Web API
+            # endpoint is no longer supported by unauthorized Spotify Developer Applications as of 2024/11/27.
+            if (accessTokenHeaderValue is None):
+                raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_DEPRECATED_ENDPOINT % apiMethodName)
 
             # validations.
             if limit is None: 
@@ -6864,7 +6896,7 @@ class SpotifyClient:
 
                 # execute spotify web api request.
                 msg:SpotifyApiMessage = SpotifyApiMessage(apiMethodName, '/browse/featured-playlists')
-                msg.RequestHeaders[self.AuthToken.HeaderKey] = self.AuthToken.HeaderValue
+                msg.RequestHeaders[self.AuthToken.HeaderKey] = accessTokenHeaderValue or self.AuthToken.HeaderValue
                 msg.UrlParameters = urlParms
                 self.MakeRequest('GET', msg)
 
@@ -6975,8 +7007,14 @@ class SpotifyClient:
             _logsi.EnterMethod(SILevel.Debug, apiMethodName)
             _logsi.LogVerbose("Get a sorted list of available genres")
                 
-            # api endpoint no longer supported by Spotify as of 2024/11/27.
-            raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_DEPRECATED_ENDPOINT % apiMethodName)
+            # are spotify web player credentials configured? if so, then we will use them to create
+            # an elevated authorization access token for the Spotify Web API endpoint call.
+            accessTokenHeaderValue:str = self._GetSpotifyWebPlayerTokenHeaderValue()
+
+            # if spotify web player credentials not configured then we are done; the Spotify Web API
+            # endpoint is no longer supported by unauthorized Spotify Developer Applications as of 2024/11/27.
+            if (accessTokenHeaderValue is None):
+                raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_DEPRECATED_ENDPOINT % apiMethodName)
 
             # validations.
             if (refresh is None):
@@ -6992,7 +7030,7 @@ class SpotifyClient:
                 
                 # execute spotify web api request.
                 msg:SpotifyApiMessage = SpotifyApiMessage(apiMethodName, '/recommendations/available-genre-seeds')
-                msg.RequestHeaders[self.AuthToken.HeaderKey] = self.AuthToken.HeaderValue
+                msg.RequestHeaders[self.AuthToken.HeaderKey] = accessTokenHeaderValue or self.AuthToken.HeaderValue
                 self.MakeRequest('GET', msg)
 
                 # process results.
@@ -10204,8 +10242,14 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("trackId", trackId)
             _logsi.LogMethodParmList(SILevel.Verbose, "Get audio feature information for a single track", apiMethodParms)
                 
-            # api endpoint no longer supported by Spotify as of 2024/11/27.
-            raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_DEPRECATED_ENDPOINT % apiMethodName)
+            # are spotify web player credentials configured? if so, then we will use them to create
+            # an elevated authorization access token for the Spotify Web API endpoint call.
+            accessTokenHeaderValue:str = self._GetSpotifyWebPlayerTokenHeaderValue()
+
+            # if spotify web player credentials not configured then we are done; the Spotify Web API
+            # endpoint is no longer supported by unauthorized Spotify Developer Applications as of 2024/11/27.
+            if (accessTokenHeaderValue is None):
+                raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_DEPRECATED_ENDPOINT % apiMethodName)
 
             # if trackId not specified, then return currently playing track id value.
             if (trackId is None) or (len(trackId.strip()) == 0):
@@ -10217,7 +10261,7 @@ class SpotifyClient:
 
             # execute spotify web api request.
             msg:SpotifyApiMessage = SpotifyApiMessage(apiMethodName, '/audio-features/{id}'.format(id=trackId))
-            msg.RequestHeaders[self.AuthToken.HeaderKey] = self.AuthToken.HeaderValue
+            msg.RequestHeaders[self.AuthToken.HeaderKey] = accessTokenHeaderValue or self.AuthToken.HeaderValue
             self.MakeRequest('GET', msg)
 
             # process results.
@@ -10853,8 +10897,14 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("targetValence", targetValence)
             _logsi.LogMethodParmList(SILevel.Verbose, "Get track recommendations for specified criteria", apiMethodParms)
                 
-            # api endpoint no longer supported by Spotify as of 2024/11/27.
-            raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_DEPRECATED_ENDPOINT % apiMethodName)
+            # are spotify web player credentials configured? if so, then we will use them to create
+            # an elevated authorization access token for the Spotify Web API endpoint call.
+            accessTokenHeaderValue:str = self._GetSpotifyWebPlayerTokenHeaderValue()
+
+            # if spotify web player credentials not configured then we are done; the Spotify Web API
+            # endpoint is no longer supported by unauthorized Spotify Developer Applications as of 2024/11/27.
+            if (accessTokenHeaderValue is None):
+                raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_DEPRECATED_ENDPOINT % apiMethodName)
 
             # ensure market was either supplied or implied; default if neither.
             market = self._ValidateMarket(market)
@@ -10974,7 +11024,7 @@ class SpotifyClient:
                 
             # execute spotify web api request.
             msg:SpotifyApiMessage = SpotifyApiMessage(apiMethodName, '/recommendations')
-            msg.RequestHeaders[self.AuthToken.HeaderKey] = self.AuthToken.HeaderValue
+            msg.RequestHeaders[self.AuthToken.HeaderKey] = accessTokenHeaderValue or self.AuthToken.HeaderValue
             msg.UrlParameters = urlParms
             self.MakeRequest('GET', msg)
 

spotifywebapipython/spotifyconnect/spotifyconnectdirectorytask.py

@@ -1003,7 +1003,7 @@ class SpotifyConnectDirectoryTask(threading.Thread):
     def GetSonosPlayer(
         self, 
         device:SpotifyConnectDevice,
-        returnCoordinator:bool=True
+        returnCoordinator:bool=True,
         ) -> SoCo:
         """ 
         Returns the Sonos Controller instance for the specified Spotify Connect device.
@@ -1051,6 +1051,25 @@ class SpotifyConnectDirectoryTask(threading.Thread):
             # does caller want the group coordinator?
             if (returnCoordinator):
 
+                # TEST TODO - use to test Sonos coordinator functionality.
+                # _logsi.LogObject(SILevel.Verbose, "Sonos Controller instance for device: %s" % (device.Title), sonosPlayer, colorValue=SIColors.Red)
+                # sonosPlayer._is_coordinator = False 
+
+                # if Sonos Controller instance is the group coordinator then we are done.
+                if (sonosPlayer.is_coordinator):
+                    _logsi.LogVerbose("Sonos Controller instance is a group coordinator for device: %s" % (device.Title))
+                    _logsi.LogObject(SILevel.Verbose, "Sonos Controller instance for device: %s" % (device.Title), sonosPlayer)
+                    _logsi.LogDictionary(SILevel.Verbose, "Sonos Controller instance for device: %s (speaker_info)" % (device.Title), sonosPlayer.speaker_info)
+                    _logsi.LogObject(SILevel.Verbose, "Sonos Controller instance for device: %s (group)" % (device.Title), sonosPlayer.group)
+                    _logsi.LogObject(SILevel.Verbose, "Sonos Controller instance for device: %s (zone_group_state)" % (device.Title), sonosPlayer.zone_group_state)
+                    return sonosPlayer
+
+                # trace.
+                _logsi.LogObject(SILevel.Verbose, "Sonos Controller instance for device: %s" % (device.Title), sonosPlayer)
+                _logsi.LogDictionary(SILevel.Verbose, "Sonos Controller instance for device: %s (speaker_info)" % (device.Title), sonosPlayer.speaker_info)
+                _logsi.LogObject(SILevel.Verbose, "Sonos Controller instance for device: %s (group)" % (device.Title), sonosPlayer.group)
+                _logsi.LogObject(SILevel.Verbose, "Sonos Controller instance for device: %s (zone_group_state)" % (device.Title), sonosPlayer.zone_group_state)
+
                 # is the device part of a group? if so, then use the group coordinator.
                 if (sonosPlayer.group is not None):
                     if (sonosPlayer.group.coordinator is not None):