Merge pull request #47 from anxdpanic/dev

2.0.2

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.1" provider-name="A Talented Community">
+<addon id="script.module.python.twitch" name="python-twitch for Kodi" version="2.0.2" provider-name="A Talented Community">
     <requires>
         <import addon="xbmc.python" version="2.20.0"/>
         <import addon="script.module.six" version="1.9.0"/>
@@ -9,16 +9,16 @@
     <extension point="xbmc.addon.metadata">
         <platform>all</platform>
         <news>
-[fix] clips usher
-[chg] to relative imports
-[upd] deprecation/removal dates
+[fix] Python 3 compat.
+[add] fast_bread param to usher
+[add/upd] helix endpoints
         </news>
         <assets>
             <icon>icon.png</icon>
         </assets>
         <platform>all</platform>
-        <summary lang="en">Module for interaction with the Twitch.tv API</summary>
-        <description lang="en">python-twitch for Kodi is module for interaction with the Twitch.tv API based on python-twitch by ingwinlu.</description>
+        <summary lang="en_GB">Module for interaction with the Twitch.tv API</summary>
+        <description lang="en_GB">python-twitch for Kodi is module for interaction with the Twitch.tv API based on python-twitch by ingwinlu.</description>
         <license>GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007</license>
         <forum> </forum>
         <source>https://github.com/MrSprigster/script.module.python.twitch</source>

changelog.txt

@@ -1,3 +1,8 @@
+2.0.2
+[fix] Python 3 compat.
+[add] fast_bread param to usher
+[add/upd] helix endpoints
+
 2.0.1
 [fix] clips usher
 [chg] to relative imports

resources/lib/twitch/api/__init__.py

@@ -2,7 +2,7 @@
 
 __all__ = ['v5', 'default', 'helix', 'parameters', 'usher']
 
-from . import v5  # V5 is deprecated and will be removed entirely on 12/31/18
+from . import v5  # V5 is deprecated and will be removed entirely on TBD
 from . import v5 as default
 from . import helix
 from . import parameters

resources/lib/twitch/api/helix/__init__.py

@@ -1,10 +1,14 @@
 # -*- encoding: utf-8 -*-
 # https://dev.twitch.tv/docs/
 
-__all__ = ['clips', 'games', 'streams', 'users', 'videos']
+__all__ = ['analytics', 'bits', 'clips', 'entitlements', 'games', 'streams', 'users', 'videos', 'webhooks']
 
+from . import analytics  # NOQA
+from . import bits  # NOQA
 from . import clips  # NOQA
+from . import entitlements  # NOQA
 from . import games  # NOQA
 from . import streams  # NOQA
 from . import users  # NOQA
 from . import videos  # NOQA
+from . import webhooks  # NOQA

resources/lib/twitch/api/helix/analytics.py

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+# https://dev.twitch.tv/docs/api/reference
+
+from ..parameters import IntRange, Cursor, ReportType
+from ... import keys
+from ...queries import HelixQuery as Qry
+from ...queries import query
+
+
+# required scope: analytics:read:extensions
+@query
+def extensions(started_at='', ended_at='', extension_id='', report_type='', after='MA==', first=20, use_app_token=False):
+    q = Qry('analytics/extensions', use_app_token=use_app_token)
+    q.add_param(keys.STARTED_AT, started_at, '')
+    q.add_param(keys.ENDED_AT, ended_at, '')
+    q.add_param(keys.EXTENSION_ID, extension_id, '')
+    if report_type:
+        q.add_param(keys.TYPE, ReportType.validate(report_type))
+    if not extension_id:
+        q.add_param(keys.AFTER, Cursor.validate(after), 'MA==')
+    q.add_param(keys.FIRST, IntRange(1, 100).validate(first), 20)
+
+    return q
+
+
+# required scope: analytics:read:games
+@query
+def games(started_at='', ended_at='', game_id='', report_type='', after='MA==', first=20, use_app_token=False):
+    q = Qry('analytics/games', use_app_token=use_app_token)
+    q.add_param(keys.STARTED_AT, started_at, '')
+    q.add_param(keys.ENDED_AT, ended_at, '')
+    q.add_param(keys.GAME_ID, game_id, '')
+    if report_type:
+        q.add_param(keys.TYPE, ReportType.validate(report_type))
+    if not game_id:
+        q.add_param(keys.AFTER, Cursor.validate(after), 'MA==')
+    q.add_param(keys.FIRST, IntRange(1, 100).validate(first), 20)
+
+    return q

resources/lib/twitch/api/helix/bits.py

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+# https://dev.twitch.tv/docs/api/reference
+
+from ..parameters import PeriodHelix, IntRange
+from ... import keys
+from ...queries import HelixQuery as Qry
+from ...queries import query
+
+
+# required scope: bits:read
+@query
+def get_bits_leaderboard(count=10, period=PeriodHelix.ALL, started_at='', user_id='', use_app_token=False):
+    q = Qry('bits/leaderboard', use_app_token=use_app_token)
+    q.add_param(keys.COUNT, IntRange(1, 100).validate(count), 10)
+    q.add_param(keys.PERIOD, PeriodHelix.validate(period), PeriodHelix.ALL)
+    if period != PeriodHelix.ALL:
+        q.add_param(keys.STARTED_AT, started_at, '')
+    q.add_param(keys.USER_ID, user_id, '')
+
+    return q

resources/lib/twitch/api/helix/clips.py

@@ -1,24 +1,32 @@
 # -*- encoding: utf-8 -*-
 # https://dev.twitch.tv/docs/api/reference
 
+from ..parameters import Boolean, Cursor, IntRange, ItemCount
 from ... import keys, methods
 from ...queries import HelixQuery as Qry
 from ...queries import query
 
 
 # required scope: none
 @query
-def get_clip(clip_id, use_app_token=False):
+def get_clip(broadcaster_id='', game_id='', clip_id=list(),
+             after='MA==', before='MA==', first=20, use_app_token=False):
     q = Qry('clips', use_app_token=use_app_token)
-    q.add_param(keys.ID, clip_id, '')
+    q.add_param(keys.AFTER, Cursor.validate(after), 'MA==')
+    q.add_param(keys.BEFORE, Cursor.validate(before), 'MA==')
+    q.add_param(keys.FIRST, IntRange(1, 100).validate(first), 20)
+    q.add_param(keys.BROADCASTER_ID, broadcaster_id, '')
+    q.add_param(keys.GAME_ID, game_id, '')
+    q.add_param(keys.ID, ItemCount().validate(clip_id), list())
 
     return q
 
 
 # required scope: clips:edit
 @query
-def create_clip(broadcaster_id, use_app_token=False):
+def create_clip(broadcaster_id, has_delay=Boolean.FALSE, use_app_token=False):
     q = Qry('clips', use_app_token=use_app_token, method=methods.POST)
     q.add_param(keys.BROADCASTER_ID, broadcaster_id, '')
+    q.add_param(keys.HAS_DELAY, Boolean.validate(has_delay), Boolean.FALSE)
 
     return q

resources/lib/twitch/api/helix/entitlements.py

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+# https://dev.twitch.tv/docs/api/reference
+
+from ..parameters import EntitlementType
+from ... import keys
+from ...queries import HelixQuery as Qry
+from ...queries import query
+
+
+# required scope: none
+# requires app access token
+@query
+def upload(manifest_id, entitlement_type=EntitlementType.BULK_DROPS_GRANT):
+    q = Qry('entitlements/upload', use_app_token=True)
+    q.add_param(keys.MANIFEST_ID, manifest_id)
+    q.add_param(keys.TYPE, EntitlementType.validate(entitlement_type))
+
+    return q

resources/lib/twitch/api/helix/games.py

@@ -2,7 +2,7 @@
 # https://dev.twitch.tv/docs/api/reference
 
 from ... import keys
-from ...api.parameters import Cursor
+from ...api.parameters import Cursor, IntRange, ItemCount
 from ...queries import HelixQuery as Qry
 from ...queries import query
 
@@ -11,8 +11,9 @@
 @query
 def get_games(game_id=list(), game_name=list(), use_app_token=False):
     q = Qry('games', use_app_token=use_app_token)
-    q.add_param(keys.ID, game_id, list())
-    q.add_param(keys.NAME, game_name, list())
+    q.add_param(keys.ID, ItemCount().validate(game_id), list())
+    q.add_param(keys.NAME, ItemCount().validate(game_name), list())
+
     return q
 
 
@@ -22,6 +23,6 @@ def get_top(after='MA==', before='MA==', first=20, use_app_token=False):
     q = Qry('games/top', use_app_token=use_app_token)
     q.add_param(keys.AFTER, Cursor.validate(after), 'MA==')
     q.add_param(keys.BEFORE, Cursor.validate(before), 'MA==')
-    q.add_param(keys.FIRST, first, 20)
+    q.add_param(keys.FIRST, IntRange(1, 100).validate(first), 20)
 
     return q

resources/lib/twitch/api/helix/streams.py

@@ -2,28 +2,27 @@
 # https://dev.twitch.tv/docs/api/reference
 
 from ... import keys
-from ...api.parameters import Cursor, Language, StreamTypeHelix
+from ...api.parameters import Cursor, Language, IntRange, ItemCount
 from ...queries import HelixQuery as Qry
 from ...queries import query
 
 
 # required scope: none
 @query
 def get_streams(community_id=list(), game_id=list(), user_id=list(),
-                user_login=list(), stream_type=StreamTypeHelix.ALL, language=list(),
-                after='MA==', before='MA==', first=20, use_app_token=False):
+                user_login=list(), language=list(), after='MA==',
+                before='MA==', first=20, use_app_token=False):
     q = Qry('streams', use_app_token=use_app_token)
     q.add_param(keys.AFTER, Cursor.validate(after), 'MA==')
     q.add_param(keys.BEFORE, Cursor.validate(before), 'MA==')
-    q.add_param(keys.FIRST, first, 20)
-    q.add_param(keys.COMMUNITY_ID, community_id, list())
-    q.add_param(keys.GAME_ID, game_id, list())
-    q.add_param(keys.USER_ID, user_id, list())
-    q.add_param(keys.USER_LOGIN, user_login, list())
-    q.add_param(keys.TYPE, StreamTypeHelix.validate(stream_type), StreamTypeHelix.ALL)
+    q.add_param(keys.FIRST, IntRange(1, 100).validate(first), 20)
+    q.add_param(keys.COMMUNITY_ID, ItemCount().validate(community_id), list())
+    q.add_param(keys.GAME_ID, ItemCount().validate(game_id), list())
+    q.add_param(keys.USER_ID, ItemCount().validate(user_id), list())
+    q.add_param(keys.USER_LOGIN, ItemCount().validate(user_login), list())
     if isinstance(language, list):
         _language = [lang for lang in language if lang in Language.valid()]
-        q.add_param(keys.LANGUAGE, _language, list())
+        q.add_param(keys.LANGUAGE, ItemCount().validate(_language), list())
     else:
         q.add_param(keys.LANGUAGE, Language.validate(language), '')
 
@@ -33,20 +32,19 @@ def get_streams(community_id=list(), game_id=list(), user_id=list(),
 # required scope: none
 @query
 def get_metadata(community_id=list(), game_id=list(), user_id=list(),
-                 user_login=list(), stream_type=StreamTypeHelix.ALL, language=list(),
-                 after='MA==', before='MA==', first=20, use_app_token=False):
+                 user_login=list(), language=list(), after='MA==',
+                 before='MA==', first=20, use_app_token=False):
     q = Qry('streams/metadata', use_app_token=use_app_token)
     q.add_param(keys.AFTER, Cursor.validate(after), 'MA==')
     q.add_param(keys.BEFORE, Cursor.validate(before), 'MA==')
-    q.add_param(keys.FIRST, first, 20)
-    q.add_param(keys.COMMUNITY_ID, community_id, list())
-    q.add_param(keys.GAME_ID, game_id, list())
-    q.add_param(keys.USER_ID, user_id, list())
-    q.add_param(keys.USER_LOGIN, user_login, list())
-    q.add_param(keys.TYPE, StreamTypeHelix.validate(stream_type), StreamTypeHelix.ALL)
+    q.add_param(keys.FIRST, IntRange(1, 100).validate(first), 20)
+    q.add_param(keys.COMMUNITY_ID, ItemCount().validate(community_id), list())
+    q.add_param(keys.GAME_ID, ItemCount().validate(game_id), list())
+    q.add_param(keys.USER_ID, ItemCount().validate(user_id), list())
+    q.add_param(keys.USER_LOGIN, ItemCount().validate(user_login), list())
     if isinstance(language, list):
         _language = [lang for lang in language if lang in Language.valid()]
-        q.add_param(keys.LANGUAGE, _language, list())
+        q.add_param(keys.LANGUAGE, ItemCount().validate(_language), list())
     else:
         q.add_param(keys.LANGUAGE, Language.validate(language), '')