spotifywebapiPython 1.0.59__py3-none-any.whl → 1.0.61__py3-none-any.whl

spotifywebapipython/spotifydiscovery.py

@@ -94,9 +94,9 @@ class SpotifyDiscovery:
         """
         A dictionary of discovered device names that were detected by the discovery process.
         
-        Dictionary keys will be in the form of "address:port", where "address" is the device
-        ipv4 address and the "port" is the ipv4 port number the Spotify Connect device
-        is listening on.
+        Dictionary keys will be in the form of "'name' (address:port)", where "name" is the
+        device name, "address" is the device server address and the "port" is the ipv4 port 
+        number the Spotify Connect device is listening on.
         
         Dictionary values will be the device names (e.g. "Web Player (Chrome)", etc.).  This SHOULD
         match the name of the device as displayed in the Spotify App, but is not guaranteed.
@@ -152,60 +152,56 @@ class SpotifyDiscovery:
             if (ipAddressList is None):
                 return
             
-            # create device instances for each ipv4 address found.
-            for deviceIpAddress in ipAddressList:
+            # create new result instance.
+            result:ZeroconfDiscoveryResult = ZeroconfDiscoveryResult()
+            result.DeviceName = deviceName
+            result.Domain = '.local'
+            for item in ipAddressList:
+                result.HostIpAddresses.append(item)
+            result.HostIpPort = serviceInfo.port
+            result.HostTTL = serviceInfo.host_ttl
+            result.Key = serviceInfo.key
+            result.Name = serviceInfo.name
+            result.OtherTTL = serviceInfo.other_ttl
+            result.Priority = serviceInfo.priority
+            result.Server = serviceInfo.server
+            result.ServerKey = serviceInfo.server_key
+            result.ServiceInfo = serviceInfo
+            result.ServiceType = serviceType
+            result.Weight = serviceInfo.weight
                 
-                # create new result instance.
-                result:ZeroconfDiscoveryResult = ZeroconfDiscoveryResult()
-                result.DeviceName = deviceName
-                result.Domain = '.local'
-                result.HostIpv4Address = deviceIpAddress
-                result.HostIpPort = serviceInfo.port
-                result.HostTTL = serviceInfo.host_ttl
-                result.Key = serviceInfo.key
-                result.Name = serviceInfo.name
-                result.OtherTTL = serviceInfo.other_ttl
-                result.Priority = serviceInfo.priority
-                result.Server = serviceInfo.server
-                result.ServerKey = serviceInfo.server_key
-                result.ServiceInfo = serviceInfo
-                result.ServiceType = serviceType
-                result.Weight = serviceInfo.weight
+            # formulate a unique key for this device.
+            deviceKey:str = "'%s' (%s:%i)" % (deviceName, result.HostIpAddress, result.HostIpPort)
+            _logsi.LogVerbose("Discovered Spotify Connect device: %s %s" % (deviceKey, result.HostIpAddresses))
+            if (self._PrintToConsole == True):
+                print("Discovered Spotify Connect device: %s [%s]" % (deviceKey, result.HostIpAddresses))
+            _logsi.LogObject(SILevel.Verbose, "Discovered Spotify Connect device ServiceInfo: %s" % (deviceKey), serviceInfo) 
                 
-                devicePort:int = serviceInfo.port
-                deviceKey:str = '%s:%i' % (deviceIpAddress, devicePort)
-                _logsi.LogVerbose("Discovered Spotify Connect device: %s - %s" % (deviceKey, deviceName))
-                if (self._PrintToConsole == True):
-                    print("Discovered Spotify Connect device: %s - %s" % (deviceKey, deviceName))
-                _logsi.LogObject(SILevel.Verbose, "Discovered Spotify Connect device ServiceInfo: %s - %s" % (deviceKey, deviceName), serviceInfo) 
-                
-                # process service info propertys.
-                # note that the property keys and values must first be decoded to utf-8 encoding.
-                if serviceInfo.properties is not None:
-                    dspProperties:dict = {}
-                    for key, value in serviceInfo.properties.items():
-                        keyStr = key.decode('utf-8')
-                        valueStr = value.decode('utf-8')
-                        result.Properties.append(ZeroconfProperty(keyStr, valueStr)) 
-                        dspProperties[keyStr] = valueStr
-                        # check for Spotify Connect common properties.
-                        if keyStr.lower() == 'cpath':
-                            result.SpotifyConnectCPath = valueStr
-                        elif keyStr.lower() == 'version':
-                            result.SpotifyConnectVersion = valueStr
-                    _logsi.LogDictionary(SILevel.Verbose, "Discovered Spotify Connect device ServiceInfo.Properties: '%s' (%s:%i)" % (deviceName, deviceIpAddress, devicePort), dspProperties)                        
-
-                # add the device name to the list (if not already added) using its 
-                # ipv4 address and port number as the key.
-                if deviceKey not in self._DiscoveredDeviceNames.keys():
-                    self._DiscoveredDeviceNames[deviceKey] = deviceName
-
-                # add the device result to the list.
-                self._DiscoveryResults.append(result)
-
-                # trace.
-                _logsi.LogObject(SILevel.Verbose, "Discovered Spotify Connect device result: '%s' (%s:%i)" % (deviceName, deviceIpAddress, devicePort), result, excludeNonPublic=True)                        
-                #_logsi.LogArray(SILevel.Verbose, "Discovered Spotify Connect device result.Properties: '%s' (%s:%i)" % (deviceName, deviceIpAddress, devicePort), result.Properties)                        
+            # process service info propertys.
+            # note that the property keys and values must first be decoded to utf-8 encoding.
+            if serviceInfo.properties is not None:
+                dspProperties:dict = {}
+                for key, value in serviceInfo.properties.items():
+                    keyStr = key.decode('utf-8')
+                    valueStr = value.decode('utf-8')
+                    result.Properties.append(ZeroconfProperty(keyStr, valueStr)) 
+                    dspProperties[keyStr] = valueStr
+                    # check for Spotify Connect common properties.
+                    if keyStr.lower() == 'cpath':
+                        result.SpotifyConnectCPath = valueStr
+                    elif keyStr.lower() == 'version':
+                        result.SpotifyConnectVersion = valueStr
+                _logsi.LogDictionary(SILevel.Verbose, "Discovered Spotify Connect device ServiceInfo.Properties: %s" % (deviceKey), dspProperties)                        
+
+            # add the device name to the list (if not already added).
+            if deviceKey not in self._DiscoveredDeviceNames.keys():
+                self._DiscoveredDeviceNames[deviceKey] = deviceName
+
+            # add the device result to the list.
+            self._DiscoveryResults.append(result)
+
+            # trace.
+            _logsi.LogObject(SILevel.Verbose, "Discovered Spotify Connect device result: %s" % (deviceKey), result, excludeNonPublic=True)                        
 
         elif (serviceStateChange is ServiceStateChange.Removed):
             _logsi.LogVerbose("Discovered Spotify Connect device removal (ignored): '%s' (%s:%s)", serviceName, serviceType, serviceStateChange)
@@ -272,6 +268,6 @@ class SpotifyDiscovery:
         if includeItems == True:
             
             for key, deviceName in self._DiscoveredDeviceNames.items():
-                msg = "%s\n- %s - %s" % (msg, key, deviceName)
+                msg = "%s\n- %s" % (msg, key)
             
         return msg

spotifywebapipython/zeroconfapi/zeroconfconnect.py

@@ -14,6 +14,7 @@ from .zeroconfgetinfo import ZeroconfGetInfo
 from ..saappmessages import SAAppMessages
 from ..sautils import export, validateDelay
 from ..spotifyapierror import SpotifyApiError
+from ..spotifywebapierror import SpotifyWebApiError
 from ..const import (
     TRACE_MSG_DELAY_DEVICE,
 )
@@ -41,8 +42,8 @@ class ZeroconfConnect:
     """
     
     def __init__(self, 
-                 hostIpv4Address:str,
-                 hostIpPort:str,
+                 hostIpAddress:str,
+                 hostIpPort:int,
                  cpath:str,
                  version:str='1.0',
                  useSSL:bool=False
@@ -51,9 +52,9 @@ class ZeroconfConnect:
         Initializes a new instance of the class.
         
         Args:
-            hostIpv4Address (str):
-                IPV4 address (as a string) at which the Spotify Connect Zeroconf API can be reached
-                on the Spotify Connect device (e.g. "192.168.1.81").
+            hostIpAddress (str):
+                IP address or alias at which the Spotify Connect Zeroconf API can be reached
+                on the Spotify Connect device (e.g. "192.168.1.81", "Bose-SM2-341513fbeeae.local.", etc).
             hostIpPort (int):
                 Port number (as an integer) at which the Spotify Connect Zeroconf API can be reached
                 on the Spotify Connect device (e.g. "8200").
@@ -80,7 +81,7 @@ class ZeroconfConnect:
         # initialize storage.
         self._CPath:str = cpath
         self._HostIpPort:int = hostIpPort
-        self._HostIpv4Address:str = hostIpv4Address
+        self._HostIpAddress:str = hostIpAddress
         self._UseSSL:bool = useSSL
         self._Version:str = version
 
@@ -97,12 +98,12 @@ class ZeroconfConnect:
 
 
     @property
-    def HostIpv4Address(self) -> str:
+    def HostIpAddress(self) -> str:
         """ 
-        IPV4 address (as a string) at which the Spotify Connect Zeroconf API can be reached
-        on the Spotify Connect device (e.g. "192.168.1.81").
+        IP address or alias at which the Spotify Connect Zeroconf API can be reached
+        on the Spotify Connect device (e.g. "192.168.1.81", "Bose-SM2-341513fbeeae.local.", etc).
         """
-        return self._HostIpv4Address
+        return self._HostIpAddress
     
 
     @property
@@ -191,43 +192,30 @@ class ZeroconfConnect:
                 if (response.headers):
                     _logsi.LogCollection(SILevel.Debug, "ZeroconfConnect http response [%s-%s]: '%s' (headers)" % (response.status_code, response.reason, responseUrl), response.headers.items())
 
-            if response.content is not None:
+            # do we have response data?
+            if (response.content is not None) and (len(response.content) > 0):
                 
-                # do response headers contain a content-type value?
-                # if so, we will use it to determine how to convert the response data.
-                if response.headers:
-                    if 'content-type' in response.headers:
-                        contentType = response.headers['content-type']
-
-                # do we have response data?
-                if len(response.content) == 0:
-                    
-                    # some requests will not return a response, which is ok.
-                    responseData = None
-                    _logsi.LogVerbose("ZeroconfConnect http response [%s-%s]: '%s' (no data)" % (response.status_code, response.reason, responseUrl))
-
-                elif (contentType is not None) and (contentType.find('json') > -1):
-                    
-                    # response is json.
-                    # do not use the "response.json()" method to parse JSON responses, as it is unreliable!
-                    data = response.content.decode('utf-8')
-                    responseData = json.loads(data)
-                    
-                    if _logsi.IsOn(SILevel.Verbose):
-                        if isinstance(responseData, dict):
-                            _logsi.LogDictionary(SILevel.Verbose, "ZeroconfConnect http response [%s-%s]: '%s' (json dict)" % (response.status_code, response.reason, responseUrl), responseData)
-                        elif isinstance(responseData, list):
-                            _logsi.LogArray(SILevel.Verbose, "ZeroconfConnect http response [%s-%s]: '%s' (json array)" % (response.status_code, response.reason, responseUrl), responseData)
-                        else:
-                            _logsi.LogObject(SILevel.Verbose, "ZeroconfConnect http response [%s-%s]: '%s' (json object)" % (response.status_code, response.reason, responseUrl), responseData)
-                    
-                else:
+                # convert response to JSON object.
+                # ALL Spotify Connect Zeroconf API responses SHOULD be JSON format!
+                # do not use the "response.json()" method to parse JSON responses, as it is unreliable!
+                data = response.content.decode('utf-8')
+                responseData = json.loads(data)
                     
-                    # no - treat it as utf-8 encoded data.
-                    responseUTF8 = response.content.decode('utf-8')
-                    _logsi.LogText(SILevel.Error, "ZeroconfConnect http response [%s-%s]: '%s' (utf-8)" % (response.status_code, response.reason, responseUrl), responseUTF8)
-                    responseData = responseUTF8
-
+                if _logsi.IsOn(SILevel.Verbose):
+                    if isinstance(responseData, dict):
+                        _logsi.LogDictionary(SILevel.Verbose, "ZeroconfConnect http response [%s-%s]: '%s' (json dict)" % (response.status_code, response.reason, responseUrl), responseData)
+                    elif isinstance(responseData, list):
+                        _logsi.LogArray(SILevel.Verbose, "ZeroconfConnect http response [%s-%s]: '%s' (json array)" % (response.status_code, response.reason, responseUrl), responseData)
+                    else:
+                        _logsi.LogObject(SILevel.Verbose, "ZeroconfConnect http response [%s-%s]: '%s' (json object)" % (response.status_code, response.reason, responseUrl), responseData)
+                pass
+                
+            else:
+                
+                # raise an exception, as we are expecting a JSON-formatted response!
+                errMessage = response.content.decode('utf-8')                       
+                raise SpotifyWebApiError(response.status_code, errMessage, methodName, response.reason, _logsi)
+                
         except SpotifyZeroconfApiError: raise  # pass handled exceptions on thru
         except SpotifyApiError: raise  # pass handled exceptions on thru
         except Exception as ex:
@@ -325,7 +313,7 @@ class ZeroconfConnect:
             
             # trace.
             apiMethodParms = _logsi.EnterMethodParmList(SILevel.Debug, apiMethodName)
-            apiMethodParms.AppendKeyValue("HostIpv4Address", self._HostIpv4Address)
+            apiMethodParms.AppendKeyValue("HostIpAddress", self._HostIpAddress)
             apiMethodParms.AppendKeyValue("HostIpPort", self._HostIpPort)
             apiMethodParms.AppendKeyValue("CPath", self._CPath)
             apiMethodParms.AppendKeyValue("Version", self._Version)
@@ -440,7 +428,7 @@ class ZeroconfConnect:
             
             # trace.
             apiMethodParms = _logsi.EnterMethodParmList(SILevel.Debug, apiMethodName)
-            apiMethodParms.AppendKeyValue("HostIpv4Address", self._HostIpv4Address)
+            apiMethodParms.AppendKeyValue("HostIpAddress", self._HostIpAddress)
             apiMethodParms.AppendKeyValue("HostIpPort", self._HostIpPort)
             apiMethodParms.AppendKeyValue("CPath", self._CPath)
             apiMethodParms.AppendKeyValue("Version", self._Version)
@@ -512,7 +500,7 @@ class ZeroconfConnect:
             
         return "{protocol}://{ip}:{port}{cpath}".format(
             protocol=protocol,
-            ip=self._HostIpv4Address, 
+            ip=self._HostIpAddress, 
             port=self._HostIpPort, 
             cpath=self._CPath, 
             )
@@ -546,7 +534,7 @@ class ZeroconfConnect:
             
             # trace.
             apiMethodParms = _logsi.EnterMethodParmList(SILevel.Debug, apiMethodName)
-            apiMethodParms.AppendKeyValue("HostIpv4Address", self._HostIpv4Address)
+            apiMethodParms.AppendKeyValue("HostIpAddress", self._HostIpAddress)
             apiMethodParms.AppendKeyValue("HostIpPort", self._HostIpPort)
             apiMethodParms.AppendKeyValue("CPath", self._CPath)
             apiMethodParms.AppendKeyValue("Version", self._Version)
@@ -573,7 +561,7 @@ class ZeroconfConnect:
             result = ZeroconfGetInfo(root=responseData)
 
             # trace.
-            _logsi.LogObject(SILevel.Verbose, '%s result - type="%s"' % (apiMethodName, type(result).__name__), result, excludeNonPublic=True)
+            _logsi.LogObject(SILevel.Verbose, '%s result (%s) - "%s" (%s)' % (apiMethodName, type(result).__name__, result.RemoteName, result.DeviceId), result, excludeNonPublic=True)
             return result
 
         except SpotifyZeroconfApiError: raise  # pass handled exceptions on thru

spotifywebapipython/zeroconfapi/zeroconfgetinfo.py

@@ -47,6 +47,9 @@ class ZeroconfGetInfo(ZeroconfResponse):
         self._Version:str = None
         self._VoiceSupport:str = None
         
+        # non-Spotify properties.
+        self._IsInDeviceList:bool = None
+        
         if (root is None):
 
             pass
@@ -343,6 +346,27 @@ class ZeroconfGetInfo(ZeroconfResponse):
         return self._VoiceSupport
 
 
+    # non-Spotify properties.
+
+    @property
+    def IsInDeviceList(self) -> bool:
+        """ 
+        Returns the status of active device list verification:  
+        * None - device list verification has not been performed for this device.  
+        * True - device is a member of the active device list.  
+        * False - device is NOT a member of the active device list.  
+        """
+        return self._IsInDeviceList
+    
+    @IsInDeviceList.setter
+    def IsInDeviceList(self, value:bool):
+        """ 
+        Sets the IsInDeviceList property value.
+        """
+        if isinstance(value, bool):
+            self._IsInDeviceList = value
+
+
     def ToDictionary(self) -> dict:
         """
         Returns a dictionary representation of the class.
@@ -374,6 +398,7 @@ class ZeroconfGetInfo(ZeroconfResponse):
             'TokenType': self._TokenType,
             'Version': self._Version,
             'VoiceSupport': self._VoiceSupport,
+            'IsInDeviceList': self._IsInDeviceList,
         }
         
         # combine base class results with these results.
@@ -420,4 +445,5 @@ class ZeroconfGetInfo(ZeroconfResponse):
         if self._TokenType is not None: msg = '%s\n TokenType="%s"' % (msg, str(self._TokenType))
         if self._Version is not None: msg = '%s\n Version="%s"' % (msg, str(self._Version))
         if self._VoiceSupport is not None: msg = '%s\n VoiceSupport="%s"' % (msg, str(self._VoiceSupport))
+        if self._IsInDeviceList is not None: msg = '%s\n IsInDeviceList="%s"' % (msg, str(self._IsInDeviceList))
         return msg