twitchrb 0.1.1 → 0.2.0

data/lib/twitch/resource.rb

@@ -0,0 +1,57 @@
+module Twitch
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Error 400: Your request was malformed. '#{response.body["message"]}'"
+      when 401
+        raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["error"]}'"
+      when 403
+        raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["error"]}'"
+      when 404
+        raise Error, "Error 404: No results were found for your request. '#{response.body["error"]}'"
+      when 409
+        raise Error, "Error 409: Your request was a conflict. '#{response.body["message"]}'"
+      when 429
+        raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["error"]}'"
+      when 500
+        raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["error"]}'"
+      when 503
+        raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["error"]}'"
+      when 204
+        # 204 is a response for success on Twitch's API
+        return true
+      end
+
+      response
+    end
+  end
+end

data/lib/twitch/resources/badges.rb

@@ -0,0 +1,15 @@
+module Twitch
+  class BadgesResource < Resource
+    
+    def channel(broadcaster_id:)
+      response = get_request("chat/badges?broadcaster_id=#{broadcaster_id}")
+      Collection.from_response(response, type: Badge)
+    end
+
+    def global
+      response = get_request("chat/badges/global")
+      Collection.from_response(response, type: Badge)
+    end
+
+  end
+end

data/lib/twitch/resources/banned_events.rb

@@ -0,0 +1,10 @@
+module Twitch
+  class BannedEventsResource < Resource
+    
+    def list(broadcaster_id:, **params)
+      response = get_request("moderation/banned/events", params: params.merge(broadcaster_id: broadcaster_id))
+      Collection.from_response(response, type: BannedEvent)
+    end
+
+  end
+end

data/lib/twitch/resources/banned_users.rb

@@ -0,0 +1,11 @@
+module Twitch
+  class BannedUsersResource < Resource
+    
+    # Broadcaster ID must match the user in the OAuth token
+    def list(broadcaster_id:, **params)
+      response = get_request("moderation/banned", params: params.merge(broadcaster_id: broadcaster_id))
+      Collection.from_response(response, type: BannedUser)
+    end
+
+  end
+end

data/lib/twitch/resources/channels.rb

@@ -0,0 +1,20 @@
+module Twitch
+  class ChannelsResource < Resource
+    
+    def get(broadcaster_id:)
+      User.new get_request("channels?broadcaster_id=#{broadcaster_id}").body.dig("data")[0]
+    end
+
+    # Requires scope: channel:manage:broadcast
+    def update(broadcaster_id:, **attributes)
+      patch_request("channels", body: attributes.merge(broadcaster_id: broadcaster_id))
+    end
+
+    # Requires scope: channel:read:editors
+    def editors(broadcaster_id:)
+      response = get_request("channels/editors?broadcaster_id=#{broadcaster_id}")
+      Collection.from_response(response, type: ChannelEditor)
+    end
+
+  end
+end

data/lib/twitch/resources/clips.rb

@@ -0,0 +1,19 @@
+module Twitch
+  class ClipsResource < Resource
+    
+    def list(**params)
+      raise "id, broadcaster_id or game_id is required" unless !params[:id].nil? || !params[:broadcaster_id].nil? || !params[:game_id].nil?
+
+      response = get_request("clips", params: params)
+      Collection.from_response(response, type: Clip)
+    end
+
+    # Required scope: clips:edit
+    def create(broadcaster_id:, **attributes)
+      response = post_request("clips", body: attributes.merge(broadcaster_id: broadcaster_id))
+      
+      Clip.new(response.body.dig("data")[0]) if response.success?
+    end
+
+  end
+end

data/lib/twitch/resources/custom_reward_redemptions.rb

@@ -0,0 +1,22 @@
+module Twitch
+  class CustomRewardRedemptionsResource < Resource
+    
+    # Required scope: channel:read:redemptions
+    # Broadcaster ID must match the user in the OAuth token
+    def list(broadcaster_id:, reward_id:, status:, **params)
+      attributes = {broadcaster_id: broadcaster_id, reward_id: reward_id, status: status.upcase}
+      response = get_request("channel_points/custom_rewards/redemptions", params: attributes.merge(params))
+      Collection.from_response(response, type: CustomRewardRedemption)
+    end
+
+    # Currently disabled as getting this error and can't work out why
+    # Twitch::Error (Error 400: Your request was malformed. 'The parameter "id" was malformed: the value must be greater than or equal to 1')
+    # def update(broadcaster_id:, reward_id:, redemption_id:, status:)
+    #   attributes = {broadcaster_id: broadcaster_id, reward_id: reward_id, id: redemption_id, status: status.upcase}
+    #   response = patch_request("channel_points/custom_rewards/redemptions", body: attributes)
+
+    #   CustomRewardRedemption.new(response.body.dig("data")[0]) if response.success?
+    # end
+
+  end
+end

data/lib/twitch/resources/custom_rewards.rb

@@ -0,0 +1,30 @@
+module Twitch
+  class CustomRewardsResource < Resource
+    
+    # Required scope: channel:read:redemptions
+    # Broadcaster ID must match the user in the OAuth token
+    def list(broadcaster_id:, **params)
+      response = get_request("channel_points/custom_rewards", params: params.merge(broadcaster_id: broadcaster_id))
+      Collection.from_response(response, type: CustomReward)
+    end
+
+    def create(broadcaster_id:, title:, cost:, **params)
+      attributes = {broadcaster_id: broadcaster_id, title: title, cost: cost}
+      response = post_request("channel_points/custom_rewards", body: attributes.merge(params))
+
+      CustomReward.new(response.body.dig("data")[0]) if response.success?
+    end
+
+    def update(broadcaster_id:, reward_id:, **params)
+      attributes = {broadcaster_id: broadcaster_id, id: reward_id}
+      response = patch_request("channel_points/custom_rewards", body: attributes.merge(params))
+
+      CustomReward.new(response.body.dig("data")[0]) if response.success?
+    end
+
+    def delete(broadcaster_id:, reward_id:)
+      delete_request("channel_points/custom_rewards", params: {broadcaster_id: broadcaster_id, id: reward_id})
+    end
+
+  end
+end

data/lib/twitch/resources/emotes.rb

@@ -0,0 +1,20 @@
+module Twitch
+  class EmotesResource < Resource
+    
+    def channel(broadcaster_id:)
+      response = get_request("chat/emotes?broadcaster_id=#{broadcaster_id}")
+      Collection.from_response(response, type: Emote)
+    end
+
+    def global
+      response = get_request("chat/emotes/global")
+      Collection.from_response(response, type: Emote)
+    end
+
+    def sets(emote_set_id:)
+      response = get_request("chat/emotes/set?emote_set_id=#{emote_set_id}")
+      Collection.from_response(response, type: Emote)
+    end
+
+  end
+end

data/lib/twitch/resources/event_sub_subscriptions.rb

@@ -0,0 +1,21 @@
+module Twitch
+  class EventSubSubscriptionsResource < Resource
+    
+    def list(**params)
+      response = get_request("eventsub/subscriptions", params: params)
+      Collection.from_response(response, type: EventSubSubscription)
+    end
+
+    def create(type:, version:, condition:, transport:)
+      attributes = {type: type, version: version, condition: condition, transport: transport}
+      response = post_request("eventsub/subscriptions", body: attributes)
+
+      EventSubSubscription.new(response.body.dig("data")[0]) if response.success?
+    end
+
+    def delete(id:)
+      delete_request("eventsub/subscriptions", params: {id: id})
+    end
+
+  end
+end

data/lib/twitch/resources/games.rb

@@ -0,0 +1,20 @@
+module Twitch
+  class GamesResource < Resource
+
+    def get_by_id(game_id:)
+      response = get_request("games?id=#{game_id}")
+      Collection.from_response(response, type: Game)
+    end
+
+    def get_by_name(name:)
+      response = get_request("games?name=#{name}")
+      Collection.from_response(response, type: Game)
+    end
+
+    def top(**params)
+      response = get_request("games/top", params: params)
+      Collection.from_response(response, type: Game)
+    end
+
+  end
+end

data/lib/twitch/resources/goals.rb

@@ -0,0 +1,12 @@
+module Twitch
+  class GoalsResource < Resource
+    
+    # Required scope: channel:read:goals
+    # Broadcaster ID must match the user in the OAuth token
+    def list(broadcaster_id:)
+      response = get_request("goals", params: {broadcaster_id: broadcaster_id})
+      Collection.from_response(response, type: Goal)
+    end
+
+  end
+end

data/lib/twitch/resources/hype_train_events.rb

@@ -0,0 +1,12 @@
+module Twitch
+  class HypeTrainEventsResource < Resource
+    
+    # Required scope: channel:read:hype_train
+    # Broadcaster ID must match the user in the OAuth token
+    def list(broadcaster_id:)
+      response = get_request("hypetrain/events", params: {broadcaster_id: broadcaster_id})
+      Collection.from_response(response, type: HypeTrainEvent)
+    end
+
+  end
+end

data/lib/twitch/resources/moderator_events.rb

@@ -0,0 +1,11 @@
+module Twitch
+  class ModeratorEventsResource < Resource
+    
+    # Broadcaster ID must match the user in the OAuth token
+    def list(broadcaster_id:, **params)
+      response = get_request("moderation/moderators/events", params: params.merge(broadcaster_id: broadcaster_id))
+      Collection.from_response(response, type: ModeratorEvent)
+    end
+
+  end
+end

data/lib/twitch/resources/moderators.rb

@@ -0,0 +1,11 @@
+module Twitch
+  class ModeratorsResource < Resource
+    
+    # Broadcaster ID must match the user in the OAuth token
+    def list(broadcaster_id:, **params)
+      response = get_request("moderation/moderators", params: params.merge(broadcaster_id: broadcaster_id))
+      Collection.from_response(response, type: Moderator)
+    end
+
+  end
+end

data/lib/twitch/resources/polls.rb

@@ -0,0 +1,27 @@
+module Twitch
+  class PollsResource < Resource
+    
+    # Broadcaster ID must match the user in the OAuth token
+    def list(broadcaster_id:, **params)
+      response = get_request("polls", params: params.merge(broadcaster_id: broadcaster_id))
+      Collection.from_response(response, type: Poll)
+    end
+
+    # Broadcaster ID must match the user in the OAuth token
+    def create(broadcaster_id:, title:, choices:, duration:, **params)
+      attrs = {broadcaster_id: broadcaster_id, title: title, choices: choices, duration: duration}
+      response = post_request("polls", body: attrs.merge(params))
+
+      Poll.new(response.body.dig("data")[0]) if response.success?
+    end
+
+    # Broadcaster ID must match the user in the OAuth token
+    def end(broadcaster_id:, id:, status:)
+      attrs = {broadcaster_id: broadcaster_id, id: id, status: status.upcase}
+      response = patch_request("polls", body: attrs)
+
+      Poll.new(response.body.dig("data")[0]) if response.success?
+    end
+
+  end
+end

data/lib/twitch/resources/predictions.rb

@@ -0,0 +1,32 @@
+module Twitch
+  class PredictionsResource < Resource
+    
+    # Broadcaster ID must match the user in the OAuth token
+    def list(broadcaster_id:, **params)
+      response = get_request("predictions", params: params.merge(broadcaster_id: broadcaster_id))
+
+      if response.body["data"]
+        Collection.from_response(response, type: Prediction)
+      else
+        nil
+      end
+    end
+
+    # Broadcaster ID must match the user in the OAuth token
+    def create(broadcaster_id:, title:, outcomes:, duration:, **params)
+      attrs = {broadcaster_id: broadcaster_id, title: title, outcomes: outcomes, prediction_window: duration}
+      response = post_request("predictions", body: attrs.merge(params))
+
+      Prediction.new(response.body.dig("data")[0]) if response.success?
+    end
+
+    # Broadcaster ID must match the user in the OAuth token
+    def end(broadcaster_id:, id:, status:, **params)
+      attrs = {broadcaster_id: broadcaster_id, id: id, status: status.upcase}
+      response = patch_request("predictions", body: attrs.merge(params))
+
+      Prediction.new(response.body.dig("data")[0]) if response.success?
+    end
+
+  end
+end

data/lib/twitch/resources/search.rb

@@ -0,0 +1,17 @@
+module Twitch
+  class SearchResource < Resource
+
+    def categories(query:, **params)
+      response = get_request("search/categories", params: params.merge(query: query))
+
+      Collection.from_response(response, type: SearchResult)
+    end
+
+    def channels(query:, **params)
+      response = get_request("search/channels", params: params.merge(query: query))
+
+      Collection.from_response(response, type: SearchResult)
+    end
+    
+  end
+end

data/lib/twitch/resources/stream_markers.rb

@@ -0,0 +1,19 @@
+module Twitch
+  class StreamMarkersResource < Resource
+
+    # Required scope: user:read:broadcast
+    def list(**params)
+      response = get_request("streams/markers", params: params)
+
+      Collection.from_response(response, type: StreamMarker)
+    end
+
+    # Required scope: channel:manage:broadcast
+    def create(user_id:, **params)
+      response = post_request("streams/markers", body: params.merge(user_id: user_id))
+
+      StreamMarker.new(response.body.dig("data")[0]) if response.success?
+    end
+    
+  end
+end

data/lib/twitch/resources/stream_schedule.rb

@@ -0,0 +1,47 @@
+module Twitch
+  class StreamScheduleResource < Resource
+
+    # Broadcaster ID must match the user in the OAuth token
+    def list(broadcaster_id:, **params)
+      response = get_request("schedule", params: params.merge(broadcaster_id: broadcaster_id))
+
+      StreamSchedule.new(response.body) if response.success?
+    end
+
+    # Broadcaster ID must match the user in the OAuth token
+    def icalendar(broadcaster_id:)
+      response = get_request("schedule/icalendar", params: {broadcaster_id: broadcaster_id})
+
+      response.body
+    end
+
+    # Broadcaster ID must match the user in the OAuth token
+    # TODO: Allow the user to put any date format and then convert it to RFC3339
+    def update(broadcaster_id:, **params)
+      patch_request("schedule/settings", body: params.merge(broadcaster_id: broadcaster_id))
+    end
+
+    # Broadcaster ID must match the user in the OAuth token
+    def create_segment(broadcaster_id:, start_time:, timezone:, duration:, is_recurring:, **params)
+      attrs = {broadcaster_id: broadcaster_id, start_time: start_time, duration: duration, timezone: timezone, is_recurring: is_recurring}
+      response = post_request("schedule/segment", body: attrs.merge(params))
+
+      StreamSchedule.new(response.body) if response.success?
+    end
+
+    # Broadcaster ID must match the user in the OAuth token
+    def update_segment(broadcaster_id:, id:, **params)
+      attrs = {broadcaster_id: broadcaster_id, id: id}
+      response = patch_request("schedule/segment", body: attrs.merge(params))
+
+      StreamSchedule.new(response.body) if response.success?
+    end
+
+    # Broadcaster ID must match the user in the OAuth token
+    def delete_segment(broadcaster_id:, id:)
+      attrs = {broadcaster_id: broadcaster_id, id: id}
+      delete_request("schedule/segment", params: attrs)
+    end    
+    
+  end
+end

data/lib/twitch/resources/streams.rb

@@ -0,0 +1,19 @@
+module Twitch
+  class StreamsResource < Resource
+
+    def list(**params)
+      response = get_request("streams", params: params)
+
+      Collection.from_response(response, type: Stream)
+    end
+
+    # Required scope: user:read:follows
+    # User ID must match the user in the OAuth token
+    def followed(user_id:, **params)
+      response = get_request("streams/followed", params: params.merge(user_id: user_id))
+
+      Collection.from_response(response, type: Stream)
+    end
+    
+  end
+end

data/lib/twitch/resources/subscriptions.rb

@@ -0,0 +1,73 @@
+module Twitch
+  class SubscriptionsResource < Resource
+
+    # Get all subscriptions for a broadcaster
+    # Broadcaster ID must match the user in the OAuth token
+    # Required scope: channel:read:subscriptions
+    def list(broadcaster_id:, **params)
+      response = get_request("subscriptions", params: params.merge(broadcaster_id: broadcaster_id))
+      Collection.from_response(response, type: Subscription)
+    end
+
+    # Checks if a User is subscribed to a Broadcaster
+    # If 404 then the user is not subscribed
+    # User ID must match the user in the OAuth token
+    # Required scope: user:read:subscriptions
+    def is_subscribed(broadcaster_id:, user_id:, **params)
+      attrs = {broadcaster_id: broadcaster_id, user_id: user_id}
+      response = get_request("subscriptions/user", params: attrs.merge(params))
+      Collection.from_response(response, type: Subscription)
+    end
+
+    # Calculate the number of Subscribers & Subscriber Points a broadcaster has
+    # Broadcaster ID must match the user in the OAuth token
+    # Required scope: channel:read:subscriptions
+    def calculate(broadcaster_id:, remove_count: 0, remove_points: 0)
+      calculate_subs(broadcaster_id: broadcaster_id, remove_count: remove_count, remove_points: remove_points)
+    end
+    
+    private
+
+    def get_subscriptions(broadcaster_id:)
+      subs    = []
+      cursor  = nil
+      count   = 1
+  
+      while count > 0
+        sub_response = list(broadcaster_id: broadcaster_id, first: 100, after: cursor)
+  
+        subs    += sub_response.data
+  
+        cursor  = sub_response.cursor
+        count   = sub_response.total
+      end
+  
+      return subs
+    end
+  
+    def calculate_subs(broadcaster_id:, remove_count:, remove_points:)
+      subs = get_subscriptions(broadcaster_id: broadcaster_id)
+  
+      count  = 0
+      points = 0
+  
+      if !subs.empty? && subs.count >= 1
+        subs.each do |sub|
+          # We don't want to add the broadcaster into the count
+          next if sub.user_id.to_s == broadcaster_id.to_s
+          
+          count  += 1
+          points += 1 if sub.tier == "1000"
+          points += 2 if sub.tier == "2000"
+          points += 6 if sub.tier == "3000"
+        end
+
+        count  = (count - remove_count)
+        points = (points - remove_points)
+      end
+  
+      SubscriptionCount.new(count: count, points: points)
+    end 
+
+  end
+end

data/lib/twitch/resources/tags.rb

@@ -0,0 +1,20 @@
+module Twitch
+  class TagsResource < Resource
+    
+    def list(**params)
+      response = get_request("tags/streams", params: params)
+      Collection.from_response(response, type: Tag)
+    end
+
+    def stream(broadcaster_id:, **params)
+      response = get_request("streams/tags", params: params.merge(broadcaster_id: broadcaster_id))
+      Collection.from_response(response, type: Tag)
+    end
+
+    # Required scope: channel:manage:broadcast
+    def replace(broadcaster_id:, **params)
+      put_request("streams/tags", body: params.merge(broadcaster_id: broadcaster_id))
+    end
+
+  end
+end

data/lib/twitch/resources/users.rb

@@ -0,0 +1,54 @@
+module Twitch
+  class UsersResource < Resource
+    
+    def get_by_id(user_id:)
+      User.new get_request("users/?id=#{user_id}").body.dig("data")[0]
+    end
+
+    def get_by_username(username:)
+      User.new get_request("users/?login=#{username}").body.dig("data")[0]
+    end
+
+    # Updates the current users description
+    # Required scope: user:edit
+    def update(description:)
+      response = put_request("users", body: {description: description})
+      User.new response.body.dig("data")[0]
+    end
+
+    def follows(**params)
+      raise "from_id or to_id is required" unless !params[:from_id].nil? || !params[:to_id].nil?
+
+      response = get_request("users/follows", params: params)
+      Collection.from_response(response, type: FollowedUser)
+    end
+
+    # Required scope: user:read:blocked_users
+    def blocks(broadcaster_id:, **params)
+      response = get_request("users/blocks?broadcaster_id=#{broadcaster_id}", params: params)
+      Collection.from_response(response, type: BlockedUser)
+    end
+
+    # Required scope: user:manage:blocked_users
+    def block_user(target_user_id:, **attributes)
+      put_request("users/blocks?target_user_id=#{target_user_id}", body: attributes)
+    end
+
+    # Required scope: user:manage:blocked_users
+    def unblock_user(target_user_id:)
+      delete_request("users/blocks?target_user_id=#{target_user_id}")
+    end
+
+    # A quick method to see if a user is following a channel
+    def following?(from_id:, to_id:)
+      response = get_request("users/follows", params: {from_id: from_id, to_id: to_id})
+
+      if response.body["data"].empty?
+        false
+      else
+        true
+      end
+    end
+
+  end
+end

data/lib/twitch/resources/videos.rb

@@ -0,0 +1,17 @@
+module Twitch
+  class VideosResource < Resource
+    
+    def list(**params)
+      raise "id, user_id or game_id is required" unless !params[:id].nil? || !params[:user_id].nil? || !params[:game_id].nil?
+
+      response = get_request("videos", params: params)
+      Collection.from_response(response, type: Video)
+    end
+
+    # Required scope: channel:manage:videos
+    # def delete(video_id:)
+    #   delete_request("videos?id=#{video_id}")
+    # end
+
+  end
+end

data/lib/twitch/version.rb

@@ -1,3 +1,3 @@
 module Twitch
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end