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

Author: anxdpanic

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

@@ -1,29 +1,161 @@
 # -*- encoding: utf-8 -*-
 # https://dev.twitch.tv/docs/v5/reference/communities/
 
-from twitch import keys
+from twitch import keys, methods
 from twitch.api.parameters import Cursor
 from twitch.queries import V5Query as Qry
 from twitch.queries import query
 
 
 @query
-def top(limit=10, cursor='MA=='):
+def get_community_by_name(name):
+    q = Qry('communities')
+    q.add_param(keys.NAME, name)
+    return q
+
+
+@query
+def get_community_by_id(community_id):
+    q = Qry('communities/{community_id}')
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    return q
+
+
+@query
+def update_community(community_id, summary=None, description=None,
+                     rules=None, email=None):
+    q = Qry('communities/{community_id}', method=methods.PUT)
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    q.add_data(keys.SUMMARY, summary)
+    q.add_data(keys.DESCRIPTION, description)
+    q.add_data(keys.RULES, rules)
+    q.add_data(keys.EMAIL, email)
+    return q
+
+
+@query
+def get_top_communities(limit=10, cursor='MA=='):
     q = Qry('communities/top')
     q.add_param(keys.LIMIT, limit, 10)
     q.add_param(keys.CURSOR, Cursor.validate(cursor), 'MA==')
     return q
 
 
 @query
-def by_name(name):
-    q = Qry('communities')
-    q.add_param(keys.NAME, name)
+def get_community_bans(community_id, limit=10, cursor='MA=='):
+    q = Qry('communities/{community_id}/bans')
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    q.add_param(keys.LIMIT, limit, 10)
+    q.add_param(keys.CURSOR, Cursor.validate(cursor), 'MA==')
+    return q
+
+
+@query
+def ban_community_user(community_id, user_id):
+    q = Qry('communities/{community_id}/bans/{user_id}', method=methods.PUT)
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    q.add_urlkw(keys.USER_ID, user_id)
+    return q
+
+
+@query
+def unban_community_user(community_id, user_id):
+    q = Qry('communities/{community_id}/bans/{user_id}', method=methods.DELETE)
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    q.add_urlkw(keys.USER_ID, user_id)
+    return q
+
+
+@query
+def create_community_avatar(community_id, avatar_image):
+    q = Qry('communities/{community_id}/images/avatar', method=methods.POST)
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    q.add_urlkw(keys.AVATAR_IMAGE, avatar_image)
+    return q
+
+
+@query
+def delete_community_avatar(community_id):
+    q = Qry('communities/{community_id}/images/avatar', method=methods.DELETE)
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    return q
+
+
+@query
+def create_community_cover(community_id, cover_image):
+    q = Qry('communities/{community_id}/images/cover', method=methods.POST)
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    q.add_urlkw(keys.COVER_IMAGE, cover_image)
+    return q
+
+
+@query
+def delete_community_cover(community_id):
+    q = Qry('communities/{community_id}/images/cover', method=methods.DELETE)
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    return q
+
+
+@query
+def get_community_moderators(community_id):
+    q = Qry('communities/{community_id}/moderators')
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    return q
+
+
+@query
+def add_community_moderator(community_id, user_id):
+    q = Qry('communities/{community_id}/moderators/{user_id}', method=methods.PUT)
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    q.add_urlkw(keys.USER_ID, user_id)
+    return q
+
+
+@query
+def delete_community_moderator(community_id, user_id):
+    q = Qry('communities/{community_id}/moderators/{user_id}', method=methods.DELETE)
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    q.add_urlkw(keys.USER_ID, user_id)
+    return q
+
+
+@query
+def get_community_permissions(community_id):
+    q = Qry('communities/{community_id}/permissions')
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    return q
+
+
+@query
+def report_community_violation(community_id, channel_id):
+    q = Qry('communities/{community_id}/report_channel', method=methods.POST)
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    q.add_data(keys.CHANNEL_ID, channel_id)
+    return q
+
+
+@query
+def get_community_timeouts(community_id, limit=10, cursor='MA=='):
+    q = Qry('communities/{community_id}/timeouts')
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    q.add_param(keys.LIMIT, limit, 10)
+    q.add_param(keys.CURSOR, Cursor.validate(cursor), 'MA==')
+    return q
+
+
+@query
+def add_community_timeout(community_id, user_id, duration=1, reason=None):
+    q = Qry('communities/{community_id}/timeouts/{user_id}', method=methods.PUT)
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    q.add_urlkw(keys.USER_ID, user_id)
+    q.add_data(keys.DURATION, duration)
+    q.add_data(keys.REASON, reason)
     return q
 
 
 @query
-def by_id(community_id):
-    q = Qry('communities/{id}')
-    q.add_urlkw(keys.ID, community_id)
+def delete_community_timeout(community_id, user_id):
+    q = Qry('communities/{community_id}/timeouts/{user_id}', method=methods.DELETE)
+    q.add_urlkw(keys.COMMUNITY_ID, community_id)
+    q.add_urlkw(keys.USER_ID, user_id)
     return q

resources/lib/twitch/keys.py

@@ -7,6 +7,7 @@
 
 ALLOW_SOURCE = 'allow_source'
 ALLOW_SPECTRE = 'allow_spectre'
+AVATAR_IMAGE = 'avatar_image'
 BROADCAST_TYPE = 'broadcast_type'
 BROADCASTS = 'broadcasts'
 CHANNEL = 'channel'
@@ -19,11 +20,14 @@
 COMMUNITY_ID = 'community_id'
 CONTAINING_ITEM = 'containing_item'
 CONTENT = 'content'
+COVER_IMAGE = 'cover_image'
 CURSOR = 'cursor'
 CLIENT_ID = 'client_id'
 DELAY = 'delay'
+DESCRIPTION = 'description'
 DIRECTION = 'direction'
 DURATION = 'duration'
+EMAIL = 'email'
 EMOTE_ID = 'emote_id'
 EMOTESETS = 'emotesets'
 ERROR = 'error'
@@ -48,12 +52,15 @@
 POSITION = 'position'
 POST_ID = 'post_id'
 QUERY = 'query'
+REASON = 'reason'
+RULES = 'rules'
 SHARE = 'share'
 SIG = 'sig'
 SORT = 'sort'
 SORT_BY = 'sortby'
 STATUS = 'status'
 STREAM_TYPE = 'stream_type'
+SUMMARY = 'summary'
 TARGET = 'target'
 TEAM = 'team'
 TITLE = 'title'