Merge pull request #4 from anxdpanic/dev-v5

update v5, implicit auth basics, follow/unfollow, communities, m3u_pattern

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="1.0.0~alpha1" provider-name="A Talented Community">
+<addon id="script.module.python.twitch" name="python-twitch for Kodi" version="1.0.0~alpha2" provider-name="A Talented Community">
     <requires>
         <import addon="xbmc.python" version="2.1.0"/>
         <import addon="script.module.six" version="1.9.0"/>
@@ -18,6 +18,11 @@
 - update usher to allow_source
 - videos.by_channel from broadcasts bool to broadcast_type: 'archive', 'highlight', 'upload'
 - update m3u_pattern
+- add initial v5 (wip)
+- add support for additional methods in queries (PUT/DELETE/POST)
+- v5 add communities, update follow/unfollow
+- add basics for implicit oauth2
+- update usher base url
         </news>
         <assets>
             <icon>icon.png</icon>

changelog.txt

@@ -8,3 +8,8 @@
 - update usher to allow_source
 - videos.by_channel from broadcasts bool to broadcast_type: 'archive', 'highlight', 'upload'
 - update m3u_pattern
+- add initial v5 (wip)
+- add support for additional methods in queries (PUT/DELETE/POST)
+- v5 add communities, update follow/unfollow
+- add basics for implicit oauth2
+- update usher base url

resources/__init__.py

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 
-from twitch.api import v3
-from twitch.api import v3 as default
+from twitch.api import v5
+from twitch.api import v5 as default
 
-__all__ = ['v3', 'default']
+__all__ = ['v5', 'default']

resources/lib/__init__.py

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+# https://github.com/justintv/Twitch-API/blob/master/v3_resources/
+
+from twitch.api.v5 import blocks  # NOQA
+from twitch.api.v5 import channels  # NOQA
+from twitch.api.v5 import follows  # NOQA
+from twitch.api.v5 import games  # NOQA
+from twitch.api.v5 import ingests  # NOQA
+from twitch.api.v5 import search  # NOQA
+from twitch.api.v5 import streams  # NOQA
+from twitch.api.v5 import subscriptions  # NOQA
+from twitch.api.v5 import teams  # NOQA
+from twitch.api.v5 import users  # NOQA
+from twitch.api.v5 import videos  # NOQA
+from twitch.api.v5 import communities  # NOQA
+from twitch.api.v5.root import root  # NOQA

resources/lib/twitch/api/__init__.py

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+# https://github.com/justintv/Twitch-API/blob/master/v3_resources/blocks.md
+
+from twitch.queries import query
+
+
+# Needs Authentification
+@query
+def by_name(user):
+    raise NotImplementedError
+
+
+# Needs Authentification, needs PUT
+@query
+def add_block(user, target):
+    raise NotImplementedError
+
+
+# Needs Authentification, needs DELETE
+@query
+def del_block(user, target):
+    raise NotImplementedError

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

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+# https://github.com/justintv/Twitch-API/blob/master/v3_resources/channels.md
+
+from twitch import keys
+from twitch.queries import V5Query as Qry
+from twitch.queries import query
+
+from .videos import by_channel
+
+
+@query
+def by_name(name):
+    q = Qry('channels/{channel}')
+    q.add_urlkw(keys.CHANNEL, name)
+    return q
+
+
+@query
+def channel():
+    raise NotImplementedError
+
+
+def get_videos(name, **kwargs):
+    return by_channel(name, **kwargs)
+
+
+@query
+def editors(name):
+    raise NotImplementedError
+
+
+# TODO needs authentification and put requests
+@query
+def update(name, status=None, game=None, delay=0):
+    raise NotImplementedError
+
+
+# TODO needs auth
+@query
+def delete(name):
+    raise NotImplementedError
+
+
+# TODO needs auth, needs POST request
+@query
+def commercial(name, length=30):
+    raise NotImplementedError
+
+
+@query
+def teams(name):
+    q = Qry('channels/{channel}/teams')
+    q.add_urlkw('channel', name)
+    return q

resources/lib/twitch/api/v5/blocks.py

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+from twitch import keys
+from twitch.queries import V5Query as Qry
+from twitch.queries import query
+
+
+@query
+def top(limit=10, cursor=0):
+    q = Qry('communities/top')
+    q.add_param(keys.LIMIT, limit, 10)
+    q.add_param(keys.CURSOR, cursor, 0)
+    return q
+
+
+@query
+def by_name(name):
+    q = Qry('communities')
+    q.add_param(keys.NAME, name)
+    return q
+
+
+@query
+def by_id(identification):
+    q = Qry('communities/{id}')
+    q.add_urlkw(keys.ID, identification)
+    return q

resources/lib/twitch/api/v5/channels.py

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+# https://github.com/justintv/Twitch-API/blob/master/v3_resources/follows.md
+
+from twitch import keys
+from twitch.api.parameters import Direction, SortBy
+from twitch.queries import V5Query as Qry
+from twitch.queries import query
+from twitch.api.parameters import Boolean
+
+
+@query
+def by_channel(name, limit=25, offset=0, direction=Direction.DESC):
+    q = Qry('channels/{channel}/follows')
+    q.add_urlkw(keys.CHANNEL, name)
+    q.add_param(keys.LIMIT, limit, 25)
+    q.add_param(keys.OFFSET, offset, 0)
+    q.add_param(keys.DIRECTION, direction, Direction.DESC)
+    return q
+
+
+@query
+def by_id(identification, limit=25, offset=0, direction=Direction.DESC,
+            sort_by=SortBy.CREATED_AT):
+    q = Qry('users/{id}/follows/channels')
+    q.add_urlkw(keys.ID, identification)
+    q.add_param(keys.LIMIT, limit, 25)
+    q.add_param(keys.OFFSET, offset, 0)
+    q.add_param(keys.DIRECTION, direction, Direction.DESC)
+    q.add_param(keys.SORT_BY, sort_by, SortBy.CREATED_AT)
+    return q
+
+
+@query
+def status(identification, target):
+    q = Qry('users/{id}/follows/channels/{target}')
+    q.add_urlkw(keys.ID, identification)
+    q.add_urlkw(keys.TARGET, target)
+    return q
+
+
+# Needs Auth, needs PUT
+@query
+def follow(identification, target, notification=Boolean.FALSE):
+    q = Qry('users/{id}/follows/channels/{target}', method='PUT')
+    q.add_urlkw(keys.ID, identification)
+    q.add_urlkw(keys.TARGET, target)
+    q.add_data('notification', notification)
+    return q
+
+
+# Needs Auth, needs DELETE
+@query
+def unfollow(identification, target):
+    q = Qry('users/{id}/follows/channels/{target}', method='DELETE')
+    q.add_urlkw(keys.ID, identification)
+    q.add_urlkw(keys.TARGET, target)
+    return q
+
+# Needs Auth
+@query
+def streams():
+    raise NotImplementedError