Merge pull request #66 from anxdpanic/dev

2.0.9

Author: anxdpanic

addon.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<addon id="script.module.python.twitch" name="python-twitch for Kodi" version="2.0.8" provider-name="A Talented Community">
+<addon id="script.module.python.twitch" name="python-twitch for Kodi" version="2.0.9" provider-name="A Talented Community">
     <requires>
         <import addon="xbmc.python" version="2.20.0"/>
         <import addon="script.module.six" version="1.11.0"/>
@@ -9,7 +9,9 @@
     <extension point="xbmc.addon.metadata">
         <platform>all</platform>
         <news>
-[upd] Mark communities endpoints and queries as deprecated
+[upd] allow overriding headers for usher and hidden api calls
+[fix] decode byte responses in scraper
+[fix] usher/parser error handling
         </news>
         <assets>
             <icon>icon.png</icon>

changelog.txt

@@ -1,3 +1,8 @@
+2.0.9
+[upd] allow overriding headers for usher and hidden api calls
+[fix] decode byte responses in scraper
+[fix] usher/parser error handling
+
 2.0.8
 [upd] Mark communities endpoints and queries as deprecated
 

resources/lib/twitch/api/usher.py

@@ -30,8 +30,8 @@ def valid_video_id(video_id):
 
 
 @query
-def channel_token(channel, platform=keys.WEB):
-    q = HiddenApiQuery('channels/{channel}/access_token')
+def channel_token(channel, platform=keys.WEB, headers={}):
+    q = HiddenApiQuery('channels/{channel}/access_token', headers=headers)
     q.add_urlkw(keys.CHANNEL, channel)
     q.add_param(keys.NEED_HTTPS, Boolean.TRUE)
     q.add_param(keys.PLATFORM, platform)
@@ -40,8 +40,8 @@ def channel_token(channel, platform=keys.WEB):
 
 
 @query
-def vod_token(video_id, platform=keys.WEB):
-    q = HiddenApiQuery('vods/{vod}/access_token')
+def vod_token(video_id, platform=keys.WEB, headers={}):
+    q = HiddenApiQuery('vods/{vod}/access_token', headers=headers)
     q.add_urlkw(keys.VOD, video_id)
     q.add_param(keys.NEED_HTTPS, Boolean.TRUE)
     q.add_param(keys.PLATFORM, platform)
@@ -56,12 +56,12 @@ def _legacy_video(video_id):
     return q
 
 
-def live_request(channel, platform=keys.WEB):
-    token = channel_token(channel, platform=platform)
+def live_request(channel, platform=keys.WEB, headers={}):
+    token = channel_token(channel, platform=platform, headers=headers)
     if keys.ERROR in token:
         return token
     else:
-        q = UsherQuery('api/channel/hls/{channel}.m3u8')
+        q = UsherQuery('api/channel/hls/{channel}.m3u8', headers=headers)
         q.add_urlkw(keys.CHANNEL, channel)
         q.add_param(keys.SIG, token[keys.SIG].encode('utf-8'))
         q.add_param(keys.TOKEN, token[keys.TOKEN].encode('utf-8'))
@@ -81,8 +81,8 @@ def live_request(channel, platform=keys.WEB):
 
 
 @query
-def _live(channel, token):
-    q = UsherQuery('api/channel/hls/{channel}.m3u8')
+def _live(channel, token, headers={}):
+    q = UsherQuery('api/channel/hls/{channel}.m3u8', headers=headers)
     q.add_urlkw(keys.CHANNEL, channel)
     q.add_param(keys.SIG, token[keys.SIG].encode('utf-8'))
     q.add_param(keys.TOKEN, token[keys.TOKEN].encode('utf-8'))
@@ -99,22 +99,22 @@ def _live(channel, token):
 
 
 @m3u8
-def live(channel, platform=keys.WEB):
-    token = channel_token(channel, platform=platform)
+def live(channel, platform=keys.WEB, headers={}):
+    token = channel_token(channel, platform=platform, headers=headers)
     if keys.ERROR in token:
         return token
     else:
-        return _live(channel, token)
+        return _live(channel, token, headers=headers)
 
 
-def video_request(video_id, platform=keys.WEB):
+def video_request(video_id, platform=keys.WEB, headers={}):
     video_id = valid_video_id(video_id)
     if video_id:
-        token = vod_token(video_id, platform=platform)
+        token = vod_token(video_id, platform=platform, headers=headers)
         if keys.ERROR in token:
             return token
         else:
-            q = UsherQuery('vod/{id}')
+            q = UsherQuery('vod/{id}', headers=headers)
             q.add_urlkw(keys.ID, video_id)
             q.add_param(keys.NAUTHSIG, token[keys.SIG].encode('utf-8'))
             q.add_param(keys.NAUTH, token[keys.TOKEN].encode('utf-8'))
@@ -137,8 +137,8 @@ def video_request(video_id, platform=keys.WEB):
 
 
 @query
-def _vod(video_id, token):
-    q = UsherQuery('vod/{id}')
+def _vod(video_id, token, headers={}):
+    q = UsherQuery('vod/{id}', headers=headers)
     q.add_urlkw(keys.ID, video_id)
     q.add_param(keys.NAUTHSIG, token[keys.SIG].encode('utf-8'))
     q.add_param(keys.NAUTH, token[keys.TOKEN].encode('utf-8'))
@@ -156,14 +156,14 @@ def _vod(video_id, token):
 
 
 @m3u8
-def video(video_id, platform=keys.WEB):
+def video(video_id, platform=keys.WEB, headers={}):
     video_id = valid_video_id(video_id)
     if video_id:
-        token = vod_token(video_id, platform=platform)
+        token = vod_token(video_id, platform=platform, headers=headers)
         if keys.ERROR in token:
             return token
         else:
-            return _vod(video_id, token)
+            return _vod(video_id, token, headers=headers)
     else:
         raise NotImplementedError('Unknown Video Type')
 

resources/lib/twitch/parser.py

@@ -48,7 +48,10 @@ def _find_frame_rate(group_id, group_name):
 def m3u8(f):
     def m3u8_wrapper(*args, **kwargs):
         results = f(*args, **kwargs)
-        results = results.decode('utf-8')
+        try:
+            results = results.decode('utf-8')
+        except AttributeError:
+            pass
         if keys.ERROR in results:
             if isinstance(results, dict):
                 return results

resources/lib/twitch/queries.py

@@ -10,6 +10,8 @@
     See LICENSES/GPL-3.0-only for more information.
 """
 
+from copy import deepcopy
+
 from six.moves.urllib.parse import urljoin
 
 from . import CLIENT_ID, OAUTH_TOKEN, APP_TOKEN
@@ -122,21 +124,23 @@ def execute(self):
 
 class ApiQuery(JsonQuery):
     def __init__(self, path, headers={}, data={}, use_token=True, method=methods.GET):
-        headers.setdefault('Client-ID', CLIENT_ID)
+        _headers = deepcopy(headers)
+        _headers.setdefault('Client-ID', CLIENT_ID)
         if use_token and OAUTH_TOKEN:
-            headers.setdefault('Authorization', 'OAuth {access_token}'.format(access_token=OAUTH_TOKEN))
-        super(ApiQuery, self).__init__(_kraken_baseurl, headers, data, method)
+            _headers.setdefault('Authorization', 'OAuth {access_token}'.format(access_token=OAUTH_TOKEN))
+        super(ApiQuery, self).__init__(_kraken_baseurl, _headers, data, method)
         self.add_path(path)
 
 
 class HelixApiQuery(HelixJsonQuery):
     def __init__(self, path, headers={}, data={}, use_app_token=False, method=methods.GET):
-        headers.setdefault('Client-ID', CLIENT_ID)
+        _headers = deepcopy(headers)
+        _headers.setdefault('Client-ID', CLIENT_ID)
         if use_app_token and APP_TOKEN:
-            headers.setdefault('Authorization', 'Bearer {access_token}'.format(access_token=APP_TOKEN))
+            _headers.setdefault('Authorization', 'Bearer {access_token}'.format(access_token=APP_TOKEN))
         elif OAUTH_TOKEN:
-            headers.setdefault('Authorization', 'Bearer {access_token}'.format(access_token=OAUTH_TOKEN))
-        super(HelixApiQuery, self).__init__(_helix_baseurl, headers, data, method)
+            _headers.setdefault('Authorization', 'Bearer {access_token}'.format(access_token=OAUTH_TOKEN))
+        super(HelixApiQuery, self).__init__(_helix_baseurl, _headers, data, method)
         self._params = list()
         self.add_path(path)
 
@@ -154,37 +158,54 @@ def add_param(self, key, value, default=None):
 
 class HiddenApiQuery(JsonQuery):
     def __init__(self, path, headers={}, data={}, use_token=True, method=methods.GET):
-        headers.setdefault('Client-ID', CLIENT_ID)
-        if use_token and OAUTH_TOKEN:
-            headers.setdefault('Authorization', 'OAuth {access_token}'.format(access_token=OAUTH_TOKEN))
-        super(HiddenApiQuery, self).__init__(_hidden_baseurl, headers, data, method)
+        _headers = deepcopy(headers)
+        if 'Client-ID' not in _headers:
+            _headers.setdefault('Client-ID', CLIENT_ID)
+        if 'Client-ID' in _headers and not _headers.get('Client-ID'):
+            del _headers['Client-ID']
+        if 'Authorization' not in _headers:
+            if use_token and OAUTH_TOKEN:
+                _headers.setdefault('Authorization', 'OAuth {access_token}'.format(access_token=OAUTH_TOKEN))
+        if 'Authorization' in _headers and not _headers.get('Authorization'):
+            del _headers['Authorization']
+        super(HiddenApiQuery, self).__init__(_hidden_baseurl, _headers, data, method)
         self.add_path(path)
 
 
 class UsherQuery(DownloadQuery):
     def __init__(self, path, headers={}, data={}, method=methods.GET):
-        headers.setdefault('Client-ID', CLIENT_ID)
-        if OAUTH_TOKEN:
-            headers.setdefault('Authorization', 'OAuth {access_token}'.format(access_token=OAUTH_TOKEN))
-        super(UsherQuery, self).__init__(_usher_baseurl, headers, data, method)
+        _headers = deepcopy(headers)
+        if 'Client-ID' not in _headers:
+            _headers.setdefault('Client-ID', CLIENT_ID)
+        if 'Client-ID' in _headers and not _headers.get('Client-ID'):
+            del _headers['Client-ID']
+        if 'Authorization' not in _headers:
+            if OAUTH_TOKEN:
+                _headers.setdefault('Authorization', 'OAuth {access_token}'.format(access_token=OAUTH_TOKEN))
+        if 'Authorization' in _headers and not _headers.get('Authorization'):
+            del _headers['Authorization']
+        super(UsherQuery, self).__init__(_usher_baseurl, _headers, data, method)
         self.add_path(path)
 
 
 class OAuthQuery(JsonQuery):
     def __init__(self, path, headers={}, data={}, method=methods.GET):
-        super(JsonQuery, self).__init__(_oauth_baseurl, headers, data, method)
+        _headers = deepcopy(headers)
+        super(JsonQuery, self).__init__(_oauth_baseurl, _headers, data, method)
         self.add_path(path)
 
 
 class ClipsQuery(DownloadQuery):
     def __init__(self, path, headers={}, data={}, method=methods.GET):
-        super(ClipsQuery, self).__init__(_clips_baseurl, headers, data, method)
+        _headers = deepcopy(headers)
+        super(ClipsQuery, self).__init__(_clips_baseurl, _headers, data, method)
         self.add_path(path)
 
 
 class UploadsQuery(DownloadQuery):
     def __init__(self, path, headers={}, data={}, method=methods.PUT):
-        super(UploadsQuery, self).__init__(_uploads_baseurl, headers, data, method)
+        _headers = deepcopy(headers)
+        super(UploadsQuery, self).__init__(_uploads_baseurl, _headers, data, method)
         self.add_path(path)
 
 

resources/lib/twitch/scraper.py

@@ -108,6 +108,9 @@ def download(baseurl, parameters={}, headers={}, data={}, method=methods.GET, re
     else:
         raise ResourceUnavailableException('Max retries exceeded')
 
+    if isinstance(content, bytes):
+        content = content.decode('utf-8')
+
     if not response_headers:
         return content
     else: