Merge pull request #29 from anxdpanic/dev

anxdpanic · web-flow · commit 3ccc4ad411e3 · 2017-08-29T10:41:25.000-04:00
[fix] omit oauth token for queries with 'required scope: none'
diff --git a/addon.xml b/addon.xml
@@ -9,8 +9,7 @@
     <extension point="xbmc.addon.metadata">
         <platform>all</platform>
         <news>
-[fix] omit oauth token for collections 'by_id' queries
-[fix] omit oauth token for collections 'get_collections' queries
+[fix] omit oauth token for queries with 'required scope: none'
         </news>
         <assets>
             <icon>icon.png</icon>
diff --git a/changelog.txt b/changelog.txt
@@ -1,6 +1,5 @@
 1.0.2
-[fix] omit oauth token for collections 'by_id' queries
-[fix] omit oauth token for collections 'get_collections' queries
+[fix] omit oauth token for queries with 'required scope: none'
 
 1.0.1
 [fix/upd] offset, limit to games _get_followed
diff --git a/resources/lib/twitch/api/v5/bits.py b/resources/lib/twitch/api/v5/bits.py
@@ -9,6 +9,6 @@
 # required scope: None
 @query
 def get_cheermotes(channel_id=None):
-    q = Qry('bits/actions')
+    q = Qry('bits/actions', use_token=False)
     q.add_param(keys.CHANNEL_ID, channel_id, None)
     return q
diff --git a/resources/lib/twitch/api/v5/channels.py b/resources/lib/twitch/api/v5/channels.py
@@ -17,7 +17,7 @@ def channel():
 # required scope: none
 @query
 def by_id(channel_id):
-    q = Qry('channels/{channel_id}')
+    q = Qry('channels/{channel_id}', use_token=False)
     q.add_urlkw(keys.CHANNEL_ID, channel_id)
     return q
 
@@ -51,7 +51,7 @@ def get_editors(channel_id):
 # required scope: none
 @query
 def get_followers(channel_id, limit=25, offset=0, cursor='MA==', direction=Direction.DESC):
-    q = Qry('channels/{channel_id}/follows')
+    q = Qry('channels/{channel_id}/follows', use_token=False)
     q.add_urlkw(keys.CHANNEL_ID, channel_id)
     q.add_param(keys.LIMIT, limit, 25)
     q.add_param(keys.OFFSET, offset, 0)
@@ -63,7 +63,7 @@ def get_followers(channel_id, limit=25, offset=0, cursor='MA==', direction=Direc
 # required scope: none
 @query
 def get_teams(channel_id):
-    q = Qry('channels/{channel_id}/teams')
+    q = Qry('channels/{channel_id}/teams', use_token=False)
     q.add_urlkw(keys.CHANNEL_ID, channel_id)
     return q
 
@@ -94,7 +94,7 @@ def get_videos(channel_id, limit=10, offset=0,
                broadcast_type=BroadcastType.HIGHLIGHT,
                hls=Boolean.FALSE, sort_by=VideoSort.TIME,
                language=Language.ALL):
-    q = Qry('channels/{id}/videos')
+    q = Qry('channels/{id}/videos', use_token=False)
     q.add_urlkw(keys.ID, channel_id)
     q.add_param(keys.LIMIT, limit, 10)
     q.add_param(keys.OFFSET, offset, 0)
diff --git a/resources/lib/twitch/api/v5/chat.py b/resources/lib/twitch/api/v5/chat.py
@@ -9,21 +9,21 @@
 # required scope: none
 @query
 def get_emoticons_by_set(emotesets=None):
-    q = Qry('chat/emoticon_images')
+    q = Qry('chat/emoticon_images', use_token=False)
     q.add_param(keys.EMOTESETS, emotesets, None)
     return q
 
 
 # required scope: none
 @query
 def get_badges(channel_id):
-    q = Qry('chat/{channel_id}/badges')
+    q = Qry('chat/{channel_id}/badges', use_token=False)
     q.add_urlkw(keys.CHANNEL_ID, channel_id)
     return q
 
 
 # required scope: none
 @query
 def get_emoticons():
-    q = Qry('chat/emoticons')
+    q = Qry('chat/emoticons', use_token=False)
     return q
diff --git a/resources/lib/twitch/api/v5/clips.py b/resources/lib/twitch/api/v5/clips.py
@@ -10,7 +10,7 @@
 # required scope: None
 @query
 def by_slug(slug):
-    q = Qry('clips/{slug}')
+    q = Qry('clips/{slug}', use_token=False)
     q.add_urlkw(keys.SLUG, slug)
     return q
 
@@ -19,7 +19,7 @@ def by_slug(slug):
 @query
 def get_top(channels=None, games=None, period=ClipPeriod.WEEK, trending=Boolean.FALSE,
             language=Language.ALL, cursor='MA==', limit=10):
-    q = Qry('clips/top')
+    q = Qry('clips/top', use_token=False)
     q.add_param(keys.CHANNEL, channels, None)
     q.add_param(keys.GAME, games, None)
     q.add_param(keys.PERIOD, ClipPeriod.validate(period), ClipPeriod.WEEK)
diff --git a/resources/lib/twitch/api/v5/collections.py b/resources/lib/twitch/api/v5/collections.py
@@ -10,7 +10,7 @@
 # required scope: none
 @query
 def get_metadata(collection_id):
-    q = Qry('collections/{collection_id}')
+    q = Qry('collections/{collection_id}', use_token=False)
     q.add_urlkw(keys.COLLECTION_ID, collection_id)
     return q
 
diff --git a/resources/lib/twitch/api/v5/communities.py b/resources/lib/twitch/api/v5/communities.py
@@ -10,15 +10,15 @@
 # required scope: none
 @query
 def by_name(name):
-    q = Qry('communities')
+    q = Qry('communities', use_token=False)
     q.add_param(keys.NAME, name)
     return q
 
 
 # required scope: none
 @query
 def by_id(community_id):
-    q = Qry('communities/{community_id}')
+    q = Qry('communities/{community_id}', use_token=False)
     q.add_urlkw(keys.COMMUNITY_ID, community_id)
     return q
 
@@ -39,7 +39,7 @@ def update(community_id, summary=None, description=None,
 # required scope: none
 @query
 def get_top(limit=10, cursor='MA=='):
-    q = Qry('communities/top')
+    q = Qry('communities/top', use_token=False)
     q.add_param(keys.LIMIT, limit, 10)
     q.add_param(keys.CURSOR, Cursor.validate(cursor), 'MA==')
     return q
@@ -144,7 +144,7 @@ def get_permissions(community_id):
 # required scope: none
 @query
 def report_violation(community_id, channel_id):
-    q = Qry('communities/{community_id}/report_channel', method=methods.POST)
+    q = Qry('communities/{community_id}/report_channel', use_token=False, method=methods.POST)
     q.add_urlkw(keys.COMMUNITY_ID, community_id)
     q.add_data(keys.CHANNEL_ID, channel_id)
     return q
diff --git a/resources/lib/twitch/api/v5/games.py b/resources/lib/twitch/api/v5/games.py
@@ -10,7 +10,7 @@
 # required scope: none
 @query
 def get_top(limit=10, offset=0):
-    q = Qry('games/top')
+    q = Qry('games/top', use_token=False)
     q.add_param(keys.LIMIT, limit, 10)
     q.add_param(keys.OFFSET, offset, 0)
     return q
@@ -20,7 +20,7 @@ def get_top(limit=10, offset=0):
 # undocumented / unsupported
 @query
 def _check_follows(username, name):
-    q = HQry('users/{username}/follows/games/isFollowing')
+    q = HQry('users/{username}/follows/games/isFollowing', use_token=False)
     q.add_urlkw(keys.USERNAME, username)
     q.add_param(keys.NAME, name)
     return q
@@ -30,7 +30,7 @@ def _check_follows(username, name):
 # undocumented / unsupported
 @query
 def _get_followed(username, limit=25, offset=0):
-    q = HQry('users/{username}/follows/games')
+    q = HQry('users/{username}/follows/games', use_token=False)
     q.add_urlkw(keys.USERNAME, username)
     q.add_param(keys.LIMIT, limit, 25)
     q.add_param(keys.OFFSET, offset, 0)
diff --git a/resources/lib/twitch/api/v5/ingests.py b/resources/lib/twitch/api/v5/ingests.py
@@ -8,5 +8,5 @@
 # required scope: none
 @query
 def ingests():
-    q = Qry('ingests')
+    q = Qry('ingests', use_token=False)
     return q
diff --git a/resources/lib/twitch/api/v5/search.py b/resources/lib/twitch/api/v5/search.py
@@ -10,7 +10,7 @@
 # required scope: none
 @query
 def channels(search_query, limit=25, offset=0):
-    q = Qry('search/channels')
+    q = Qry('search/channels', use_token=False)
     q.add_param(keys.QUERY, search_query)
     q.add_param(keys.LIMIT, limit, 25)
     q.add_param(keys.OFFSET, offset, 0)
@@ -20,7 +20,7 @@ def channels(search_query, limit=25, offset=0):
 # required scope: none
 @query
 def games(search_query, live=Boolean.FALSE):
-    q = Qry('search/games')
+    q = Qry('search/games', use_token=False)
     q.add_param(keys.QUERY, search_query)
     q.add_param(keys.TYPE, 'suggest')  # 'type' can currently only be suggest, so it is hardcoded
 
@@ -31,7 +31,7 @@ def games(search_query, live=Boolean.FALSE):
 # required scope: none
 @query
 def streams(search_query, limit=25, offset=0, hls=Boolean.FALSE):
-    q = Qry('search/streams')
+    q = Qry('search/streams', use_token=False)
     q.add_param(keys.QUERY, search_query)
     q.add_param(keys.LIMIT, limit, 25)
     q.add_param(keys.OFFSET, offset, 0)
diff --git a/resources/lib/twitch/api/v5/streams.py b/resources/lib/twitch/api/v5/streams.py
@@ -10,7 +10,7 @@
 # required scope: none
 @query
 def by_id(channel_id, stream_type=StreamType.LIVE):
-    q = Qry('streams/{channel_id}')
+    q = Qry('streams/{channel_id}', use_token=False)
     q.add_urlkw(keys.CHANNEL_ID, channel_id)
     q.add_param(keys.STREAM_TYPE, StreamType.validate(stream_type), StreamType.LIVE)
     return q
@@ -21,7 +21,7 @@ def by_id(channel_id, stream_type=StreamType.LIVE):
 @query
 def get_all(game=None, channel_ids=None, community_id=None, language=Language.ALL,
             stream_type=StreamType.LIVE, platform=Platform.ALL, limit=25, offset=0):
-    q = Qry('streams')
+    q = Qry('streams', use_token=False)
     q.add_param(keys.GAME, game)
     q.add_param(keys.CHANNEL, channel_ids)
     q.add_param(keys.COMMUNITY_ID, community_id)
@@ -40,15 +40,15 @@ def get_all(game=None, channel_ids=None, community_id=None, language=Language.AL
 # required scope: none
 @query
 def get_summary(game=None):
-    q = Qry('streams/summary')
+    q = Qry('streams/summary', use_token=False)
     q.add_param(keys.GAME, game)
     return q
 
 
 # required scope: none
 @query
 def get_featured(limit=25, offset=0):
-    q = Qry('streams/featured')
+    q = Qry('streams/featured', use_token=False)
     q.add_param(keys.LIMIT, limit, 25)
     q.add_param(keys.OFFSET, offset, 0)
     return q
diff --git a/resources/lib/twitch/api/v5/teams.py b/resources/lib/twitch/api/v5/teams.py
@@ -9,7 +9,7 @@
 # required scope: none
 @query
 def get_active(limit=25, offset=0):
-    q = Qry('teams')
+    q = Qry('teams', use_token=False)
     q.add_param(keys.LIMIT, limit, 25)
     q.add_param(keys.OFFSET, offset, 0)
     return q
@@ -18,6 +18,6 @@ def get_active(limit=25, offset=0):
 # required scope: none
 @query
 def by_name(name):
-    q = Qry('teams/{team}')
+    q = Qry('teams/{team}', use_token=False)
     q.add_urlkw(keys.TEAM, name)
     return q
diff --git a/resources/lib/twitch/api/v5/users.py b/resources/lib/twitch/api/v5/users.py
@@ -17,7 +17,7 @@ def user():
 # required scope: none
 @query
 def by_id(user_id):
-    q = Qry('users/{user_id}')
+    q = Qry('users/{user_id}', use_token=False)
     q.add_urlkw(keys.USER_ID, user_id)
     return q
 
@@ -43,7 +43,7 @@ def check_subscription(user_id, channel_id):
 @query
 def get_follows(user_id, limit=25, offset=0, direction=Direction.DESC,
                 sort_by=SortBy.CREATED_AT):
-    q = Qry('users/{user_id}/follows/channels')
+    q = Qry('users/{user_id}/follows/channels', use_token=False)
     q.add_urlkw(keys.USER_ID, user_id)
     q.add_param(keys.LIMIT, limit, 25)
     q.add_param(keys.OFFSET, offset, 0)
@@ -55,7 +55,7 @@ def get_follows(user_id, limit=25, offset=0, direction=Direction.DESC,
 # required scope: none
 @query
 def check_follows(user_id, channel_id):
-    q = Qry('users/{user_id}/follows/channels/{channel_id}')
+    q = Qry('users/{user_id}/follows/channels/{channel_id}', use_token=False)
     q.add_urlkw(keys.USER_ID, user_id)
     q.add_urlkw(keys.CHANNEL_ID, channel_id)
     return q
diff --git a/resources/lib/twitch/api/v5/videos.py b/resources/lib/twitch/api/v5/videos.py
@@ -20,7 +20,7 @@ def by_id(video_id):
 # required scope: none
 @query
 def get_top(limit=10, offset=0, game=None, period=Period.WEEK, broadcast_type=BroadcastType.HIGHLIGHT):
-    q = Qry('videos/top')
+    q = Qry('videos/top', use_token=False)
     q.add_param(keys.LIMIT, limit, 10)
     q.add_param(keys.OFFSET, offset, 0)
     q.add_param(keys.GAME, game)
@@ -100,6 +100,6 @@ def complete_upload(video_id, upload_token):
 # undocumented / unsupported
 @query
 def _by_id(video_id):
-    q = HQry('videos/{video_id}')
+    q = HQry('videos/{video_id}', use_token=False)
     q.add_urlkw(keys.VIDEO_ID, video_id)
     return q
diff --git a/resources/lib/twitch/queries.py b/resources/lib/twitch/queries.py
@@ -114,9 +114,9 @@ def __init__(self, path, headers={}, data={}, use_token=True, method=methods.GET
 
 
 class HiddenApiQuery(JsonQuery):
-    def __init__(self, path, headers={}, data={}, method=methods.GET):
+    def __init__(self, path, headers={}, data={}, use_token=True, method=methods.GET):
         headers.setdefault('Client-ID', CLIENT_ID)
-        if OAUTH_TOKEN:
+        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)
         self.add_path(path)
