twitchrb 0.1.0 → 0.2.2

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,23 @@
+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
+
+    def retrieve(id:)
+      Clip.new get_request("clips?id=#{id}").body.dig("data")[0]
+    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,32 @@
+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
+
+    # Grabs the number of Subscribers and Subscriber Points a broadcaster has
+    # Broadcaster ID must match the user in the OAuth token
+    # Required scope: channel:read:subscriptions
+    def counts(broadcaster_id:)
+      response = get_request("subscriptions", params: {broadcaster_id: broadcaster_id})
+
+      SubscriptionCount.new(count: response.body["total"], points: response.body["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.0"
+  VERSION = "0.2.2"
 end

data/lib/twitch.rb

@@ -1,37 +1,71 @@
-require "time"
-require "httparty"
+require "faraday"
+require "faraday_middleware"
 require "json"
-
 require "twitch/version"
 
-require "twitch/client"
-require "twitch/initializable"
+module Twitch
 
-# Kraken (v5) API
-require "twitch/kraken/user"
-require "twitch/kraken/users"
-require "twitch/kraken/channels"
-require "twitch/kraken/clips"
+  autoload :Client, "twitch/client"
+  autoload :Collection, "twitch/collection"
+  autoload :Error, "twitch/error"
+  autoload :Resource, "twitch/resource"
+  autoload :Object, "twitch/object"
 
-module Twitch
 
-  class << self
-    attr_reader :client
-
-    def access_details(client_id)
-      @client = Client.new(client_id)
-      # @client.access_token = access_token if access_token
-    end
-  end
-
-  # Error classes to raise
-  class Error < StandardError; end
-  module Errors
-    class ServiceUnavailable < Error; end
-    class AccessDenied < Error; end
-    class NotFound < Error; end
-    class CommunicationError < Error; end
-    class ValidationError < Error; end
-  end
+  autoload :UsersResource, "twitch/resources/users"
+  autoload :ChannelsResource, "twitch/resources/channels"
+  autoload :EmotesResource, "twitch/resources/emotes"
+  autoload :BadgesResource, "twitch/resources/badges"
+  autoload :GamesResource, "twitch/resources/games"
+  autoload :VideosResource, "twitch/resources/videos"
+  autoload :ClipsResource, "twitch/resources/clips"
+  autoload :EventSubSubscriptionsResource, "twitch/resources/event_sub_subscriptions"
+  autoload :BannedEventsResource, "twitch/resources/banned_events"
+  autoload :BannedUsersResource, "twitch/resources/banned_users"
+  autoload :ModeratorsResource, "twitch/resources/moderators"
+  autoload :ModeratorEventsResource, "twitch/resources/moderator_events"
+  autoload :PollsResource, "twitch/resources/polls"
+  autoload :PredictionsResource, "twitch/resources/predictions"
+  autoload :StreamScheduleResource, "twitch/resources/stream_schedule"
+  autoload :SearchResource, "twitch/resources/search"
+  autoload :StreamsResource, "twitch/resources/streams"
+  autoload :StreamMarkersResource, "twitch/resources/stream_markers"
+  autoload :SubscriptionsResource, "twitch/resources/subscriptions"
+  autoload :TagsResource, "twitch/resources/tags"
+  autoload :CustomRewardsResource, "twitch/resources/custom_rewards"
+  autoload :CustomRewardRedemptionsResource, "twitch/resources/custom_reward_redemptions"
+  autoload :GoalsResource, "twitch/resources/goals"
+  autoload :HypeTrainEventsResource, "twitch/resources/hype_train_events"
+
+
+  autoload :User, "twitch/objects/user"
+  autoload :FollowedUser, "twitch/objects/followed_user"
+  autoload :BlockedUser, "twitch/objects/blocked_user"
+
+  autoload :Channel, "twitch/objects/channel"
+  autoload :ChannelEditor, "twitch/objects/channel_editor"
+  autoload :Emote, "twitch/objects/emote"
+  autoload :Badge, "twitch/objects/badge"
+  autoload :Game, "twitch/objects/game"
+  autoload :Video, "twitch/objects/video"
+  autoload :Clip, "twitch/objects/clip"
+  autoload :EventSubSubscription, "twitch/objects/event_sub_subscription"
+  autoload :BannedEvent, "twitch/objects/banned_event"
+  autoload :BannedUser, "twitch/objects/banned_user"
+  autoload :Moderator, "twitch/objects/moderator"
+  autoload :ModeratorEvent, "twitch/objects/moderator_event"
+  autoload :Poll, "twitch/objects/poll"
+  autoload :Prediction, "twitch/objects/prediction"
+  autoload :StreamSchedule, "twitch/objects/stream_schedule"
+  autoload :SearchResult, "twitch/objects/search_result"
+  autoload :Stream, "twitch/objects/stream"
+  autoload :StreamMarker, "twitch/objects/stream_marker"
+  autoload :Subscription, "twitch/objects/subscription"
+  autoload :SubscriptionCount, "twitch/objects/subscription_count"
+  autoload :Tag, "twitch/objects/tag"
+  autoload :CustomReward, "twitch/objects/custom_reward"
+  autoload :CustomRewardRedemption, "twitch/objects/custom_reward_redemption"
+  autoload :Goal, "twitch/objects/goal"
+  autoload :HypeTrainEvent, "twitch/objects/hype_train_event"
 
 end

data/twitchrb.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Dean Perry"]
   spec.email         = ["dean@deanpcmad.com"]
 
-  spec.summary       = "A Ruby library for interacting with the Twitch API"
+  spec.summary       = "A Ruby library for interacting with the Twitch Helix API"
   spec.homepage      = "https://twitchrb.com"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
@@ -24,5 +24,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "httparty", "~> 0.18.1"
+  spec.add_dependency "faraday", "~> 1.7"
+  spec.add_dependency "faraday_middleware", "~> 1.1"
 end