Add the ability to list videos and get urls. Resolves #15

Also adds tests for videos and urls.
Adds a new config option to set video quality.

Author: morguldir

tests/test_api.py

@@ -50,6 +50,10 @@ def test_get_artist_albums_other(session):
     albums = session.get_artist_albums_other(16147)
     assert any([a.name == 'Dance History 1.0' for a in albums])
 
+def test_get_artist_videos(session):
+    videos = session.get_artist_videos(3502112)
+    assert any([v.name == 'Call on Me' for v in videos])
+
 def test_album(session):
     album_id = 17927863
     album = session.get_album(album_id)
@@ -66,11 +70,35 @@ def test_get_album_tracks(session):
     assert tracks[0].name == 'Take-Off'
     assert tracks[0].track_num == 1
     assert tracks[0].duration == 56
+    assert tracks[0].artist.name == 'Lasgo'
+    assert tracks[0].album.name == 'Smile'
     assert tracks[-1].name == 'Gone'
     assert tracks[-1].track_num == 13
     assert tracks[-1].duration == 210
-    assert tracks[0].artist.name == 'Lasgo'
-    assert tracks[0].album.name == 'Smile'
+
+
+def test_get_album_videos(session):
+    videos = session.get_album_videos(108046179)
+    assert videos[0].name == 'Formation (Choreography Version)'
+    assert videos[0].track_num == 14
+    assert videos[0].duration == 262
+    assert videos[0].artist.name == 'Beyoncé'
+    assert videos[0].album.name == 'Lemonade'
+    assert videos[1].name == 'Lemonade Film'
+    assert videos[1].track_num == 15
+    assert videos[1].duration == 3955
+
+def test_get_album_items(session):
+    items = session.get_album_items(108046179)
+    assert items[0].name == 'Pray You Catch Me'
+    assert items[0].track_num == 1
+    assert items[0].duration == 196
+    assert items[0].artist.name == 'Beyoncé'
+    assert items[0].album.name == 'Lemonade'
+    assert items[-1].name == 'Lemonade Film'
+    assert items[-1].track_num == 15
+    assert items[-1].duration == 3955
+    assert items[-1].type == 'Music Video'
 
 def test_artist_radio(session):
     tracks = session.get_artist_radio(16147)
@@ -91,3 +119,11 @@ def test_album_image(session):
 def test_playlist_image(session):
     playlist = session.get_playlist('33136f5a-d93a-4469-9353-8365897aaf94')
     assert requests.get(playlist.image).status_code == 200
+
+def test_get_track_url(session):
+    track = session.get_track(108043415)
+    newurl = session.get_track_url(track.id)
+
+def test_get_video_url(session):
+    video = session.get_video(108046194)
+    newurl =  session.get_video_url(video.id)

tidalapi/__init__.py

@@ -22,7 +22,7 @@
 import logging
 import requests
 from collections import namedtuple
-from .models import Artist, Album, Track, Playlist, SearchResult, Category, Role
+from .models import Artist, Album, Track, Video, Playlist, SearchResult, Category, Role
 try:
     from urlparse import urljoin
 except ImportError:
@@ -39,10 +39,15 @@ class Quality(object):
     high = 'HIGH'
     low = 'LOW'
 
+class videoQuality(object):
+    high = 'HIGH'
+    medium = 'MEDIUM'
+    low = 'LOW'
 
 class Config(object):
-    def __init__(self, quality=Quality.high):
+    def __init__(self, quality=Quality.high, videoQuality=videoQuality.high):
         self.quality = quality
+        self.videoQuality = videoQuality
         self.api_location = 'https://api.tidalhifi.com/v1/'
         self.api_token = 'BI218mwp9ERZ3PFI' if self.quality == \
             Quality.lossless else '4zx46pyr9o8qZNRw',
@@ -112,12 +117,25 @@ def get_playlist(self, playlist_id):
     def get_playlist_tracks(self, playlist_id):
         return self._map_request('playlists/%s/tracks' % playlist_id, ret='tracks')
 
+    def get_playlist_videos(self, playlist_id):
+        return self._map_request('playlists/%s/items' % playlist_id, ret='video')
+
+    def get_playlist_items(self, playlist_id):
+        return self._get_items('playlists/%s/items' % playlist_id, ret='items')
+
     def get_album(self, album_id):
         return self._map_request('albums/%s' % album_id, ret='album')
 
     def get_album_tracks(self, album_id):
         return self._map_request('albums/%s/tracks' % album_id, ret='tracks')
 
+    def get_album_videos(self, album_id):
+        items = self._get_items('albums/%s/items' % album_id, ret='videos')
+        return [item for item in items if isinstance(item, Video)]
+
+    def get_album_items(self, album_id):
+        return self._get_items('albums/%s/items' % album_id, ret='items')
+
     def get_artist(self, artist_id):
         return self._map_request('artists/%s' % artist_id, ret='artist')
 
@@ -135,6 +153,9 @@ def get_artist_albums_other(self, artist_id):
     def get_artist_top_tracks(self, artist_id):
         return self._map_request('artists/%s/toptracks' % artist_id, ret='tracks')
 
+    def get_artist_videos(self, artist_id):
+        return self._map_request('artists/%s/videos' % artist_id, ret='videos')
+
     def get_artist_bio(self, artist_id):
         return self.request('GET', 'artists/%s/bio' % artist_id).json()['text']
 
@@ -169,6 +190,9 @@ def get_track_radio(self, track_id):
     def get_track(self, track_id):
         return self._map_request('tracks/%s' % track_id, ret='track')
 
+    def get_video(self, video_id):
+        return self._map_request('videos/%s' % video_id, ret = 'video')
+
     def _map_request(self, url, params=None, ret=None):
         json_obj = self.request('GET', url, params).json()
         parse = None
@@ -177,9 +201,13 @@ def _map_request(self, url, params=None, ret=None):
         elif ret.startswith('album'):
             parse = _parse_album
         elif ret.startswith('track'):
-            parse = _parse_track
+            parse = _parse_media
         elif ret.startswith('user'):
             raise NotImplementedError()
+        elif ret.startswith('video'):
+            parse = _parse_media
+        elif ret.startswith('item'):
+            parse = _parse_media
         elif ret.startswith('playlist'):
             parse = _parse_playlist
 
@@ -191,11 +219,31 @@ def _map_request(self, url, params=None, ret=None):
         else:
             return list(map(parse, items))
 
+    def _get_items(self, url, ret=None):
+        remaining = 100
+        offset = 0
+        while remaining is 100:
+            items = self._map_request(url, params={'offset': offset, 'limit': 100}, ret=ret)
+            remaining = len(items)
+        return items
+
     def get_media_url(self, track_id):
         params = {'soundQuality': self._config.quality}
         r = self.request('GET', 'tracks/%s/streamUrl' % track_id, params)
         return r.json()['url']
 
+    def get_track_url(self, track_id):
+        self.get_media_url(track_id)
+
+    def get_video_url(self, video_id):
+        params = {
+            'urlusagemode': 'STREAM',
+            'videoquality': self._config.videoQuality,
+            'assetpresentation': 'FULL'
+        }
+        r = self.request('GET', 'videos/%s/urlpostpaywall' % video_id, params)
+        return r.json()['urls'][0]
+
     def search(self, field, value):
         params = {
             'query': value,
@@ -265,11 +313,13 @@ def _parse_playlist(json_obj):
     }
     return Playlist(**kwargs)
 
-
-def _parse_track(json_obj):
+def _parse_media(json_obj):
     artist = _parse_artist(json_obj['artist'])
     artists = _parse_artists(json_obj['artists'])
-    album = _parse_album(json_obj['album'], artist, artists)
+    album = None
+    if (json_obj['album']):
+        album = _parse_album(json_obj['album'], artist, artists)
+
     kwargs = {
         'id': json_obj['id'],
         'name': json_obj['title'],
@@ -281,9 +331,13 @@ def _parse_track(json_obj):
         'artists': artists,
         'album': album,
         'available': bool(json_obj['streamReady']),
+        'type': json_obj.get('type'),
     }
-    return Track(**kwargs)
 
+    if kwargs['type'] == 'Music Video':
+        return Video(**kwargs)
+    else:
+        return Track(**kwargs)
 
 def _parse_genres(json_obj):
     image = "http://resources.wimpmusic.com/images/%s/460x306.jpg" \
@@ -332,7 +386,7 @@ def playlists(self):
 
     def tracks(self):
         r = self._session.request('GET', self._base_url + '/tracks')
-        return [_parse_track(item['item']) for item in r.json()['items']]
+        return [_parse_media(item['item']) for item in r.json()['items']]
 
 
 class User(object):

tidalapi/models.py

@@ -65,8 +65,7 @@ class Playlist(Model):
     def image(self, width=512, height=512):
         return IMG_URL.format(width=width, height=height, id=self.id, id_type='uuid')
 
-
-class Track(Model):
+class Media(Model):
     duration = -1
     track_num = -1
     disc_num = 1
@@ -76,6 +75,11 @@ class Track(Model):
     album = None
     available = True
 
+class Track(Media):
+    pass
+
+class Video(Media):
+    type = None
 
 class SearchResult(Model):
     artists = []

tox.ini

@@ -4,4 +4,4 @@ envlist = py27,py34,py36,py37,pypy,pypy3
 [testenv]
 passenv = TIDAL_PASSWORD TIDAL_USERNAME
 deps = pytest
-commands = pytest tests
+commands = pytest {posargs}