Merge pull request #43 from anxdpanic/dev

add helix clips, games, videos and update streams

Author: anxdpanic

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

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+# https://dev.twitch.tv/docs/api/reference
+
+from twitch import keys, methods
+from twitch.queries import HelixQuery as Qry
+from twitch.queries import query
+
+
+# required scope: none
+@query
+def get_clip(clip_id, use_app_token=False):
+    q = Qry('clips', use_app_token=use_app_token)
+    q.add_param(keys.ID, clip_id, '')
+
+    return q
+
+
+# required scope: clips:edit
+@query
+def create_clip(broadcaster_id, use_app_token=False):
+    q = Qry('clips', use_app_token=use_app_token, method=methods.POST)
+    q.add_param(keys.BROADCASTER_ID, broadcaster_id, '')
+
+    return q

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

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+# https://dev.twitch.tv/docs/api/reference
+
+from twitch import keys
+from twitch.api.parameters import Cursor
+from twitch.queries import HelixQuery as Qry
+from twitch.queries import query
+
+
+# required scope: none
+@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())
+    return q
+
+
+# required scope: none
+@query
+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)
+
+    return q

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

@@ -2,24 +2,25 @@
 # https://dev.twitch.tv/docs/api/reference
 
 from twitch import keys
-from twitch.api.parameters import Cursor, Language, StreamTypes
+from twitch.api.parameters import Cursor, Language, StreamTypeHelix
 from twitch.queries import HelixQuery as Qry
 from twitch.queries import query
 
 
 # required scope: none
 @query
 def get_streams(community_id=list(), game_id=list(), user_id=list(),
-                user_login=list(), stream_type=StreamTypes.ALL, language=list(),
-                after='MA==', first=20, use_app_token=False):
+                user_login=list(), stream_type=StreamTypeHelix.ALL, 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, StreamTypes.validate(stream_type), StreamTypes.ALL)
+    q.add_param(keys.TYPE, StreamTypeHelix.validate(stream_type), StreamTypeHelix.ALL)
     if isinstance(language, list):
         _language = [lang for lang in language if lang in Language.valid()]
         q.add_param(keys.LANGUAGE, _language, list())
@@ -32,16 +33,17 @@ 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=StreamTypes.ALL, language=list(),
-                 after='MA==', first=20, use_app_token=False):
+                 user_login=list(), stream_type=StreamTypeHelix.ALL, 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, StreamTypes.validate(stream_type), StreamTypes.ALL)
+    q.add_param(keys.TYPE, StreamTypeHelix.validate(stream_type), StreamTypeHelix.ALL)
     if isinstance(language, list):
         _language = [lang for lang in language if lang in Language.valid()]
         q.add_param(keys.LANGUAGE, _language, list())

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

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+# https://dev.twitch.tv/docs/api/reference
+
+from twitch import keys
+from twitch.api.parameters import Cursor, Language, BroadcastTypeHelix, VideoSortHelix, PeriodHelix
+from twitch.queries import HelixQuery as Qry
+from twitch.queries import query
+
+
+# required scope: none
+@query
+def get_videos(video_id=list(), game_id=list(), user_id=list(),
+               broadcast_type=BroadcastTypeHelix.ALL, language='',
+               after='MA==', before='MA==', first=20,
+               sort_order=VideoSortHelix.TIME, period=PeriodHelix.ALL, use_app_token=False):
+    q = Qry('videos', use_app_token=use_app_token)
+    if not video_id:
+        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.GAME_ID, game_id, list())
+        q.add_param(keys.USER_ID, user_id, list())
+        q.add_param(keys.TYPE, BroadcastTypeHelix.validate(broadcast_type), BroadcastTypeHelix.ALL)
+        q.add_param(keys.SORT, VideoSortHelix.validate(sort_order), VideoSortHelix.TIME)
+        q.add_param(keys.PERIOD, PeriodHelix.validate(period), PeriodHelix.ALL)
+        if language:
+            q.add_param(keys.LANGUAGE, Language.validate(language), '')
+    else:
+        q.add_param(keys.ID, video_id, list())
+
+    return q

resources/lib/twitch/api/parameters.py

@@ -23,6 +23,14 @@ class Period(_Parameter):
     _valid = [WEEK, MONTH, ALL]
 
 
+class PeriodHelix(_Parameter):
+    DAY = 'day'
+    WEEK = 'week'
+    MONTH = 'month'
+    ALL = 'all'
+    _valid = [DAY, WEEK, MONTH, ALL]
+
+
 class ClipPeriod(_Parameter):
     DAY = 'day'
     WEEK = 'week'
@@ -60,6 +68,14 @@ class VideoSort(_Parameter):
     _valid = [VIEWS, TIME]
 
 
+class VideoSortHelix(_Parameter):
+    VIEWS = 'views'
+    TIME = 'time'
+    TRENDING = 'trending'
+
+    _valid = [VIEWS, TIME, TRENDING]
+
+
 class BroadcastType(_Parameter):
     ARCHIVE = 'archive'
     HIGHLIGHT = 'highlight'
@@ -76,6 +92,23 @@ def validate(cls, value):
         return value
 
 
+class BroadcastTypeHelix(_Parameter):
+    ARCHIVE = 'archive'
+    HIGHLIGHT = 'highlight'
+    UPLOAD = 'upload'
+    ALL = 'all'
+
+    _valid = [ALL, ARCHIVE, HIGHLIGHT, UPLOAD]
+
+    @classmethod
+    def validate(cls, value):
+        split_values = value.split(',')
+        for val in split_values:
+            if val not in cls._valid:
+                raise ValueError(value)
+        return value
+
+
 class StreamType(_Parameter):
     LIVE = 'live'
     PLAYLIST = 'playlist'
@@ -84,7 +117,7 @@ class StreamType(_Parameter):
     _valid = [LIVE, PLAYLIST, ALL]
 
 
-class StreamTypes(_Parameter):
+class StreamTypeHelix(_Parameter):
     LIVE = 'live'
     VODCAST = 'vodcast'
     ALL = 'all'

resources/lib/twitch/keys.py

@@ -12,6 +12,7 @@
 AVATAR_IMAGE = 'avatar_image'
 BEFORE = 'before'
 BROADCAST_TYPE = 'broadcast_type'
+BROADCASTER_ID = 'broadcaster_id'
 BROADCASTER_LANGUAGE = 'broadcaster_language'
 BROADCASTS = 'broadcasts'
 CHANNEL = 'channel'