[v5] add missing end-points to users, descriptive function naming

Author: anxdpanic

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

@@ -1,38 +1,46 @@
 # -*- encoding: utf-8 -*-
 # https://dev.twitch.tv/docs/v5/reference/users/
 
-from twitch import keys
+from twitch import keys, methods
+from twitch.api.parameters import Boolean, Direction, SortBy
 from twitch.queries import V5Query as Qry
 from twitch.queries import query
-from twitch.api.parameters import Boolean, Direction, SortBy
-from twitch import methods
 
 
+# Needs Authentication
 @query
-def by_id(user_id):
-    q = Qry('users/{id}')
-    q.add_urlkw(keys.ID, user_id)
+def get_user():
+    q = Qry('user')
     return q
 
 
-# Needs Authentication
 @query
-def user():
-    q = Qry('user')
+def get_user_by_id(user_id):
+    q = Qry('users/{user_id}')
+    q.add_urlkw(keys.USER_ID, user_id)
+    return q
+
+
+@query
+def get_user_emotes(user_id):
+    q = Qry('users/{user_id}/emotes')
+    q.add_urlkw(keys.USER_ID, user_id)
     return q
 
 
-# Needs Authentication
 @query
-def streams():
-    raise NotImplementedError
+def check_subscription_by_channel(user_id, channel_id):
+    q = Qry('users/{user_id}/subscriptions/{channel_id}')
+    q.add_urlkw(keys.USER_ID, user_id)
+    q.add_urlkw(keys.CHANNEL_ID, channel_id)
+    return q
 
 
 @query
-def follows(user_id, limit=25, offset=0, direction=Direction.DESC,
-            sort_by=SortBy.CREATED_AT):
-    q = Qry('users/{id}/follows/channels')
-    q.add_urlkw(keys.ID, user_id)
+def get_user_follows(user_id, limit=25, offset=0, direction=Direction.DESC,
+                     sort_by=SortBy.CREATED_AT):
+    q = Qry('users/{user_id}/follows/channels')
+    q.add_urlkw(keys.USER_ID, user_id)
     q.add_param(keys.LIMIT, limit, 25)
     q.add_param(keys.OFFSET, offset, 0)
     q.add_param(keys.DIRECTION, direction, Direction.DESC)
@@ -41,61 +49,74 @@ def follows(user_id, limit=25, offset=0, direction=Direction.DESC,
 
 
 @query
-def follow_status(user_id, target_id):
-    q = Qry('users/{id}/follows/channels/{target}')
-    q.add_urlkw(keys.ID, user_id)
-    q.add_urlkw(keys.TARGET, target_id)
+def check_follows_by_channel(user_id, channel_id):
+    q = Qry('users/{user_id}/follows/channels/{channel_id}')
+    q.add_urlkw(keys.USER_ID, user_id)
+    q.add_urlkw(keys.CHANNEL_ID, channel_id)
     return q
 
 
 # Needs Authentication, needs PUT
 @query
-def follow(user_id, target_id, notification=Boolean.FALSE):
-    q = Qry('users/{id}/follows/channels/{target}', method=methods.PUT)
-    q.add_urlkw(keys.ID, user_id)
-    q.add_urlkw(keys.TARGET, target_id)
-    q.add_data(keys.NOTIFICATION, Boolean.validate(notification), Boolean.FALSE)
+def follow_channel(user_id, channel_id, notifications=Boolean.FALSE):
+    q = Qry('users/{user_id}/follows/channels/{channel_id}', method=methods.PUT)
+    q.add_urlkw(keys.USER_ID, user_id)
+    q.add_urlkw(keys.CHANNEL_ID, channel_id)
+    q.add_data(keys.NOTIFICATIONS, Boolean.validate(notifications), Boolean.FALSE)
     return q
 
 
 # Needs Authentication, needs DELETE
 @query
-def unfollow(user_id, target_id):
-    q = Qry('users/{id}/follows/channels/{target}', method=methods.DELETE)
-    q.add_urlkw(keys.ID, user_id)
-    q.add_urlkw(keys.TARGET, target_id)
+def unfollow_channel(user_id, channel_id):
+    q = Qry('users/{user_id}/follows/channels/{channel_id}', method=methods.DELETE)
+    q.add_urlkw(keys.USER_ID, user_id)
+    q.add_urlkw(keys.CHANNEL_ID, channel_id)
     return q
 
 
 # Needs Authentication
 @query
-def blocks(user_id, limit=25, offset=0):
-    q = Qry('users/{id}/blocks')
-    q.add_urlkw(keys.ID, user_id)
+def get_user_blocks(user_id, limit=25, offset=0):
+    q = Qry('users/{user_id}/blocks')
+    q.add_urlkw(keys.USER_ID, user_id)
     q.add_param(keys.LIMIT, limit, 25)
     q.add_param(keys.OFFSET, offset, 0)
     return q
 
 
 # Needs Authentication, needs PUT
 @query
-def add_block(user_id, target_id):
-    q = Qry('users/{id}/blocks/{target}', method=methods.PUT)
-    q.add_urlkw(keys.ID, user_id)
-    q.add_urlkw(keys.TARGET, target_id)
+def block_user(user_id, target_id):
+    q = Qry('users/{user_id}/blocks/{target_id}', method=methods.PUT)
+    q.add_urlkw(keys.USER_ID, user_id)
+    q.add_urlkw(keys.TARGET_ID, target_id)
     return q
 
 
 # Needs Authentication, needs DELETE
 @query
-def del_block(user_id, target_id):
-    q = Qry('users/{id}/blocks/{target}', method=methods.DELETE)
-    q.add_urlkw(keys.ID, user_id)
-    q.add_urlkw(keys.TARGET, target_id)
+def unblock_user(user_id, target_id):
+    q = Qry('users/{user_id}/blocks/{target_id}', method=methods.DELETE)
+    q.add_urlkw(keys.USER_ID, user_id)
+    q.add_urlkw(keys.TARGET_ID, target_id)
+    return q
+
+
+@query
+def create_connection_to_vhs(identifier):
+    q = Qry('user/vhs', method=methods.PUT)
+    q.add_data(keys.IDENTIFIER, identifier)
     return q
 
 
-# Needs Authentication
 @query
-def subscription_status(user_id, channel_id):
-    raise NotImplementedError
+def check_connection_to_vhs():
+    q = Qry('user/vhs')
+    return q
+
+
+@query
+def delete_connection_to_vhs():
+    q = Qry('user/vhs', method=methods.DELETE)
+    return q

resources/lib/twitch/keys.py

@@ -36,6 +36,7 @@
 GAME = 'game'
 HLS = 'hls'
 ID = 'id'
+IDENTIFIER = 'identifier'
 INCLUDE_ALL_ITEMS = 'include_all_items'
 ITEM_ID = 'item_id'
 LANGUAGE = 'language'
@@ -46,7 +47,7 @@
 NAUTH = 'nauth'
 NAUTHSIG = 'nauthsig'
 NEED_HTTPS = 'need_https'
-NOTIFICATION = 'notification'
+NOTIFICATIONS = 'notifications'
 OFFSET = 'offset'
 PERIOD = 'period'
 POSITION = 'position'
@@ -61,7 +62,7 @@
 STATUS = 'status'
 STREAM_TYPE = 'stream_type'
 SUMMARY = 'summary'
-TARGET = 'target'
+TARGET_ID = 'target_id'
 TEAM = 'team'
 TITLE = 'title'
 TOKEN = 'token'