Enhancement: Adds additional audio urls (#58)

* Adds support for additionalAudioUrl for station.getPlaylist
* Fixes broken tests
* Reworks use of iterables for additional audio urls and adds associated tests
* Moves parsing additional url response into a syntethic field
* Adds tests for additional urls field

2 files changed, 100 insertions, 1 deletions

diff --git a/tests/test_pandora/test_client.py b/tests/test_pandora/test_client.py
index 6c61355..d24ea28 100644
--- a/tests/test_pandora/test_client.py
+++ b/tests/test_pandora/test_client.py
@@ -1,7 +1,7 @@
 from unittest import TestCase
 
 from pandora import errors
-from pandora.models.pandora import AdItem
+from pandora.models.pandora import AdItem, AdditionalAudioUrl
 from pandora.client import APIClient, BaseAPIClient
 from pandora.py2compat import Mock, call, patch
 from tests.test_pandora.test_models import TestAdItem
@@ -87,6 +87,7 @@ class TestCallingAPIClient(TestCase):
             client.get_playlist('token_mock')
 
             playlist_mock.assert_has_calls([call("station.getPlaylist",
+                                                 additionalAudioUrl='',
                                                  audioAdPodCapable=True,
                                                  includeTrackLength=True,
                                                  stationToken='token_mock',
@@ -186,3 +187,68 @@ class TestCreatingGenreStation(TestCase):
             client = APIClient(Mock(), None, None, None, None)
             station = client.get_genre_stations()
             self.assertEqual(station.checksum, "foo")
+
+
+class TestAdditionalUrls(TestCase):
+
+    def test_non_iterable_string(self):
+        with self.assertRaises(TypeError):
+            transport = Mock(side_effect=[errors.InvalidAuthToken(), None])
+
+            client = APIClient(transport, None, None, None, None)
+            client._authenticate = Mock()
+
+            client.get_playlist('token_mock', additional_urls='')
+
+    def test_non_iterable_other(self):
+        with self.assertRaises(TypeError):
+            transport = Mock(side_effect=[errors.InvalidAuthToken(), None])
+
+            client = APIClient(transport, None, None, None, None)
+            client._authenticate = Mock()
+
+            client.get_playlist('token_mock',
+                                additional_urls=AdditionalAudioUrl.HTTP_32_WMA)
+
+    def test_without_enum(self):
+        with patch.object(APIClient, '__call__') as playlist_mock:
+            transport = Mock(side_effect=[errors.InvalidAuthToken(), None])
+
+            client = APIClient(transport, None, None, None, None)
+            client._authenticate = Mock()
+
+            urls = ['HTTP_128_MP3',
+                    'HTTP_24_AACPLUS_ADTS']
+
+            desired = 'HTTP_128_MP3,HTTP_24_AACPLUS_ADTS'
+
+            client.get_playlist('token_mock', additional_urls=urls)
+
+            playlist_mock.assert_has_calls([call("station.getPlaylist",
+                                                 additionalAudioUrl=desired,
+                                                 audioAdPodCapable=True,
+                                                 includeTrackLength=True,
+                                                 stationToken='token_mock',
+                                                 xplatformAdCapable=True)])
+
+
+    def test_with_enum(self):
+        with patch.object(APIClient, '__call__') as playlist_mock:
+            transport = Mock(side_effect=[errors.InvalidAuthToken(), None])
+
+            client = APIClient(transport, None, None, None, None)
+            client._authenticate = Mock()
+
+            urls = [AdditionalAudioUrl.HTTP_128_MP3,
+                    AdditionalAudioUrl.HTTP_24_AACPLUS_ADTS]
+
+            desired = 'HTTP_128_MP3,HTTP_24_AACPLUS_ADTS'
+
+            client.get_playlist('token_mock', additional_urls=urls)
+
+            playlist_mock.assert_has_calls([call("station.getPlaylist",
+                                                 additionalAudioUrl=desired,
+                                                 audioAdPodCapable=True,
+                                                 includeTrackLength=True,
+                                                 stationToken='token_mock',
+                                                 xplatformAdCapable=True)])
diff --git a/tests/test_pandora/test_models.py b/tests/test_pandora/test_models.py
index ce71ef8..410b0de 100644
--- a/tests/test_pandora/test_models.py
+++ b/tests/test_pandora/test_models.py
@@ -52,6 +52,39 @@ class TestDateField(TestCase):
         self.assertEqual(expected, model.date_field.replace(microsecond=0))
 
 
+class TestAdditionalUrlField(TestCase):
+
+    def test_single_url(self):
+        dummy_data = {
+                '_paramAdditionalUrls': ['foo']
+                }
+
+        field = pm.AdditionalUrlField("additionalAudioUrl")
+
+        ret = field.formatter(None, dummy_data, 'test')
+
+        self.assertEqual(ret, {'foo': 'test'})
+
+    def test_multiple_urls(self):
+        dummy_data = {
+                '_paramAdditionalUrls': [
+                    'abc',
+                    'def',
+                    ]
+                }
+
+        field = pm.AdditionalUrlField("additionalAudioUrl")
+
+        ret = field.formatter(None, dummy_data, ['foo', 'bar'])
+
+        expected = {
+                'abc': 'foo',
+                'def': 'bar',
+                }
+
+        self.assertEqual(ret, expected)
+
+
 class TestPandoraModel(TestCase):
 
     JSON_DATA = {