def call(self, method, args=None):
http_headers = {
'Accept-Encoding': 'gzip, deflate',
'User-Agent': 'Linux UPnP/1.0 Sonos/26.99-12345'
}
message = SoapMessage(endpoint=self.endpoint,
method=method,
parameters=[] if args is None else args,
http_headers=http_headers,
soap_action="http://www.sonos.com/Services/1"
".1#{0}".format(method),
soap_header=self.get_soap_header(),
namespace='http://www.sonos.com/Services/1.1',
timeout=self.timeout)
try:
result_elt = message.call()
except SoapFault as exc:
raise MusicServiceException(exc.faultstring, exc.faultcode)
result = list(
parse(XML.tostring(result_elt),
process_namespaces=True,
namespaces={
'http://www.sonos.com/Services/1.1': None
}).values())[0]
return result if result is not None else {}
def test_call():
""" Calling a command should result in an http request"""
s = SoapMessage(
endpoint='http://endpoint.example.com',
method='getData',
parameters=[('one', '1')],
http_headers={'user-agent': 'sonos'},
soap_action='ACTION',
soap_header="<a_header>data</a_header>",
namespace="http://namespace.com",
other_arg=4)
response = mock.MagicMock()
response.headers = {}
response.status_code = 200
response.content = DUMMY_VALID_RESPONSE
with mock.patch('requests.post', return_value=response) as fake_post:
result = s.call()
assert XML.tostring(result)
fake_post.assert_called_once_with(
'http://endpoint.example.com',
headers={'SOAPACTION': '"ACTION"',
'Content-Type': 'text/xml; charset="utf-8"', 'user-agent':
'sonos'},
data=mock.ANY, other_arg=4)
def test_call():
"""Calling a command should result in an http request."""
s = SoapMessage(
endpoint="http://endpoint.example.com",
method="getData",
parameters=[("one", "1")],
http_headers={"user-agent": "sonos"},
soap_action="ACTION",
soap_header="<a_header>data</a_header>",
namespace="http://namespace.com",
other_arg=4,
)
response = mock.MagicMock()
response.headers = {}
response.status_code = 200
response.content = DUMMY_VALID_RESPONSE
with mock.patch("requests.post", return_value=response) as fake_post:
result = s.call()
assert XML.tostring(result)
fake_post.assert_called_once_with(
"http://endpoint.example.com",
headers={
"SOAPACTION": '"ACTION"',
"Content-Type": 'text/xml; charset="utf-8"',
"user-agent": "sonos",
},
data=mock.ANY,
other_arg=4,
)
def test_call():
"""Calling a command should result in an http request."""
s = SoapMessage(
endpoint="http://endpoint.example.com",
method="getData",
parameters=[("one", "1")],
http_headers={"user-agent": "sonos"},
soap_action="ACTION",
soap_header="<a_header>data</a_header>",
namespace="http://namespace.com",
other_arg=4,
)
response = mock.MagicMock()
response.headers = {}
response.status_code = 200
response.content = DUMMY_VALID_RESPONSE
with mock.patch("requests.post", return_value=response) as fake_post:
result = s.call()
assert XML.tostring(result)
fake_post.assert_called_once_with(
"http://endpoint.example.com",
headers={"SOAPACTION": '"ACTION"', "Content-Type": 'text/xml; charset="utf-8"', "user-agent": "sonos"},
data=mock.ANY,
other_arg=4,
)
def test_call():
"""Calling a command should result in an http request."""
s = SoapMessage(
endpoint='http://endpoint.example.com',
method='getData',
parameters=[('one', '1')],
http_headers={'user-agent': 'sonos'},
soap_action='ACTION',
soap_header="<a_header>data</a_header>",
namespace="http://namespace.com",
other_arg=4)
response = mock.MagicMock()
response.headers = {}
response.status_code = 200
response.content = DUMMY_VALID_RESPONSE
with mock.patch('requests.post', return_value=response) as fake_post:
result = s.call()
assert XML.tostring(result)
fake_post.assert_called_once_with(
'http://endpoint.example.com',
headers={'SOAPACTION': '"ACTION"',
'Content-Type': 'text/xml; charset="utf-8"', 'user-agent':
'sonos'},
data=mock.ANY, other_arg=4)
def call(self, method, args=None):
""" Call a method on the server
Args:
method (str): The name of the method to call.
args (list): A list of (parameter, value) pairs representing
the parameters of the method. Default None.
Returns:
(OrderedDict): An OrderedDict representing the response
Raises:
MusicServiceException
"""
message = SoapMessage(
endpoint=self.endpoint,
method=method,
parameters=[] if args is None else args,
http_headers=self.http_headers,
soap_action="http://www.sonos.com/Services/1"
".1#{0}".format(method),
soap_header=self.get_soap_header(),
namespace=self.namespace,
timeout=self.timeout)
try:
result_elt = message.call()
except SoapFault as exc:
if 'Client.TokenRefreshRequired' in exc.faultcode:
log.debug('Token refresh required. Trying again')
# Remove any cached value for the SOAP header
self._cached_soap_header = None
# <detail>
# <refreshAuthTokenResult>
# <authToken>xxxxxxx</authToken>
# <privateKey>zzzzzz</privateKey>
# </refreshAuthTokenResult>
# </detail>
auth_token = exc.detail.findtext('.//authToken')
private_key = exc.detail.findtext('.//privateKey')
# We have new details - update the account
self.music_service.account.oa_device_id = auth_token
self.music_service.account.key = private_key
message = SoapMessage(
endpoint=self.endpoint,
method=method,
parameters=args,
http_headers=self.http_headers,
soap_action="http://www.sonos.com/Services/1"
".1#{0}".format(method),
soap_header=self.get_soap_header(),
namespace=self.namespace,
timeout=self.timeout)
result_elt = message.call()
else:
raise MusicServiceException(exc.faultstring, exc.faultcode)
# The top key in the OrderedDict will be the methodResult. Its
# value may be None if no results were returned.
result = parse(
XML.tostring(result_elt), process_namespaces=True,
namespaces={'http://www.sonos.com/Services/1.1': None}
).values()[0]
return result if result is not None else {}
def call(self, method, args=None):
""" Call a method on the server
Args:
method (str): The name of the method to call.
args (list): A list of (parameter, value) pairs representing
the parameters of the method. Default None.
Returns:
(OrderedDict): An OrderedDict representing the response
Raises:
MusicServiceException
"""
message = SoapMessage(endpoint=self.endpoint,
method=method,
parameters=[] if args is None else args,
http_headers=self.http_headers,
soap_action="http://www.sonos.com/Services/1"
".1#{0}".format(method),
soap_header=self.get_soap_header(),
namespace=self.namespace,
timeout=self.timeout)
try:
result_elt = message.call()
except SoapFault as exc:
if 'Client.TokenRefreshRequired' in exc.faultcode:
log.debug('Token refresh required. Trying again')
# Remove any cached value for the SOAP header
self._cached_soap_header = None
# <detail>
# <refreshAuthTokenResult>
# <authToken>xxxxxxx</authToken>
# <privateKey>zzzzzz</privateKey>
# </refreshAuthTokenResult>
# </detail>
auth_token = exc.detail.findtext('.//authToken')
private_key = exc.detail.findtext('.//privateKey')
# We have new details - update the account
self.music_service.account.oa_device_id = auth_token
self.music_service.account.key = private_key
message = SoapMessage(
endpoint=self.endpoint,
method=method,
parameters=args,
http_headers=self.http_headers,
soap_action="http://www.sonos.com/Services/1"
".1#{0}".format(method),
soap_header=self.get_soap_header(),
namespace=self.namespace,
timeout=self.timeout)
result_elt = message.call()
else:
raise MusicServiceException(exc.faultstring, exc.faultcode)
# The top key in the OrderedDict will be the methodResult. Its
# value may be None if no results were returned.
result = parse(XML.tostring(result_elt),
process_namespaces=True,
namespaces={
'http://www.sonos.com/Services/1.1': None
}).values()[0]
return result if result is not None else {}
