twitchrb 0.1.1 → 0.2.0

data/lib/twitch.rb

@@ -1,43 +1,91 @@
-require "time"
-require "httparty"
+require "faraday"
+require "faraday_middleware"
 require "json"
+require "twitch/version"
 
 require "twitch/version"
 
-require "twitch/client"
-require "twitch/initializable"
+# require "twitch/client"
+# require "twitch/initializable"
 
-# Helix API
-require "twitch/channels"
-require "twitch/emotes"
-require "twitch/badges"
-require "twitch/games"
+# # Models
+# require "twitch/models/channel"
+# require "twitch/models/badge"
+# require "twitch/models/game"
+# require "twitch/models/emote"
+# require "twitch/models/poll"
+# require "twitch/models/poll_choice"
 
-# Kraken (v5) API
-require "twitch/kraken/user"
-require "twitch/kraken/users"
-require "twitch/kraken/channels"
-require "twitch/kraken/clips"
+# # Helix API
+# require "twitch/channels"
+# require "twitch/emotes"
+# require "twitch/badges"
+# require "twitch/games"
+# require "twitch/polls"
 
 module Twitch
 
-  class << self
-    attr_reader :client
-
-    def access_details(client_id, access_token=nil)
-      @client = Client.new(client_id, access_token)
-      # @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 :Client, "twitch/client"
+  autoload :Collection, "twitch/collection"
+  autoload :Error, "twitch/error"
+  autoload :Resource, "twitch/resource"
+  autoload :Object, "twitch/object"
+
+
+  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

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: twitchrb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dean Perry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-20 00:00:00.000000000 Z
+date: 2021-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: 
 email:
 - dean@deanpcmad.com
@@ -31,6 +45,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -41,16 +57,63 @@ files:
 - bin/console
 - bin/setup
 - lib/twitch.rb
-- lib/twitch/badges.rb
-- lib/twitch/channels.rb
 - lib/twitch/client.rb
-- lib/twitch/emotes.rb
-- lib/twitch/games.rb
-- lib/twitch/initializable.rb
-- lib/twitch/kraken/channels.rb
-- lib/twitch/kraken/clips.rb
-- lib/twitch/kraken/user.rb
-- lib/twitch/kraken/users.rb
+- lib/twitch/collection.rb
+- lib/twitch/error.rb
+- lib/twitch/object.rb
+- lib/twitch/objects/badge.rb
+- lib/twitch/objects/banned_event.rb
+- lib/twitch/objects/banned_user.rb
+- lib/twitch/objects/blocked_user.rb
+- lib/twitch/objects/channel.rb
+- lib/twitch/objects/channel_editor.rb
+- lib/twitch/objects/clip.rb
+- lib/twitch/objects/custom_reward.rb
+- lib/twitch/objects/custom_reward_redemption.rb
+- lib/twitch/objects/emote.rb
+- lib/twitch/objects/event_sub_subscription.rb
+- lib/twitch/objects/followed_user.rb
+- lib/twitch/objects/game.rb
+- lib/twitch/objects/goal.rb
+- lib/twitch/objects/hype_train_event.rb
+- lib/twitch/objects/moderator.rb
+- lib/twitch/objects/moderator_event.rb
+- lib/twitch/objects/poll.rb
+- lib/twitch/objects/prediction.rb
+- lib/twitch/objects/search_result.rb
+- lib/twitch/objects/stream.rb
+- lib/twitch/objects/stream_marker.rb
+- lib/twitch/objects/stream_schedule.rb
+- lib/twitch/objects/subscription.rb
+- lib/twitch/objects/subscription_count.rb
+- lib/twitch/objects/tag.rb
+- lib/twitch/objects/user.rb
+- lib/twitch/objects/video.rb
+- lib/twitch/resource.rb
+- lib/twitch/resources/badges.rb
+- lib/twitch/resources/banned_events.rb
+- lib/twitch/resources/banned_users.rb
+- lib/twitch/resources/channels.rb
+- lib/twitch/resources/clips.rb
+- lib/twitch/resources/custom_reward_redemptions.rb
+- lib/twitch/resources/custom_rewards.rb
+- lib/twitch/resources/emotes.rb
+- lib/twitch/resources/event_sub_subscriptions.rb
+- lib/twitch/resources/games.rb
+- lib/twitch/resources/goals.rb
+- lib/twitch/resources/hype_train_events.rb
+- lib/twitch/resources/moderator_events.rb
+- lib/twitch/resources/moderators.rb
+- lib/twitch/resources/polls.rb
+- lib/twitch/resources/predictions.rb
+- lib/twitch/resources/search.rb
+- lib/twitch/resources/stream_markers.rb
+- lib/twitch/resources/stream_schedule.rb
+- lib/twitch/resources/streams.rb
+- lib/twitch/resources/subscriptions.rb
+- lib/twitch/resources/tags.rb
+- lib/twitch/resources/users.rb
+- lib/twitch/resources/videos.rb
 - lib/twitch/version.rb
 - twitchrb.gemspec
 homepage: https://twitchrb.com
@@ -74,8 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: A Ruby library for interacting with the Twitch API
+summary: A Ruby library for interacting with the Twitch Helix API
 test_files: []

data/lib/twitch/badges.rb

@@ -1,39 +0,0 @@
-module Twitch
-  class Badges
-
-    include Initializable
-
-    attr_accessor :id, :image_url_1x, :image_url_2x, :image_url_4x
-
-    class << self
-
-      # Gets Badges for a channel ID
-      def get_channel(id)
-        response = Twitch.client.get(:helix, "chat/badges?broadcaster_id=#{id}")
-
-        badge_array(response["data"])
-      end
-
-      # Gets Global Badges
-      def get_global
-        response = Twitch.client.get(:helix, "chat/badges/global")
-
-        badge_array(response["data"])
-      end
-
-      private
-
-      def badge_array(data)
-        badges = []
-
-        data.each do |e|
-          badges << {set_id: e["set_id"], versions: e["versions"].map {|v| new(v)} }
-        end
-
-        badges
-      end
-
-    end
-
-  end
-end

data/lib/twitch/channels.rb

@@ -1,25 +0,0 @@
-module Twitch
-  class Channels
-
-    include Initializable
-
-    attr_accessor :broadcaster_id, :broadcaster_name, :game_name, :game_id, :broadcaster_language, :title, :delay
-
-    class << self
-
-      # Gets a specified channel object
-      def get(id)
-        response = Twitch.client.get(:helix, "channels?broadcaster_id=#{id}")
-
-        new(response["data"][0])
-      end
-
-      # Update a channel
-      def update(id, params={})
-        Twitch.client.patch(:helix, "channels?broadcaster_id=#{id}", params)
-      end
-
-    end
-
-  end
-end

data/lib/twitch/emotes.rb

@@ -1,58 +0,0 @@
-module Twitch
-  class Emotes
-
-    include Initializable
-
-    attr_accessor :id, :name, :images, :tier, :emote_type, :emote_set_id, :owner_id
-
-    def url_1x
-      images["url_1x"]
-    end
-
-    def url_2x
-      images["url_2x"]
-    end
-
-    def url_4x
-      images["url_4x"]
-    end
-
-    class << self
-
-      # Gets Emotes for a channel ID
-      def get_channel(id)
-        response = Twitch.client.get(:helix, "chat/emotes?broadcaster_id=#{id}")
-
-        emote_array(response["data"])
-      end
-
-      # Gets Global Emotes
-      def get_global
-        response = Twitch.client.get(:helix, "chat/emotes/global")
-
-        emote_array(response["data"])
-      end
-
-      # Gets Emotes for an Emote Set ID
-      def get_emote_set(id)
-        response = Twitch.client.get(:helix, "chat/emotes/set?emote_set_id=#{id}")
-
-        emote_array(response["data"])
-      end
-
-      private
-
-      def emote_array(data)
-        emotes = []
-
-        data.each do |e|
-          emotes << new(e)
-        end
-
-        emotes
-      end
-
-    end
-
-  end
-end

data/lib/twitch/games.rb

@@ -1,49 +0,0 @@
-module Twitch
-  class Games
-
-    include Initializable
-
-    attr_accessor :id, :name, :box_art_url
-
-    def box_art_380
-      box_art_url.gsub("{width}", "285").gsub("{height}", "380")
-    end
-
-    class << self
-
-      # Gets Badges for a channel ID
-      def get_by_name(name)
-        response = Twitch.client.get(:helix, "games?name=#{name}")
-
-        new(response["data"][0])
-      end
-
-      def get_by_id(id)
-        response = Twitch.client.get(:helix, "games?id=#{id}")
-
-        new(response["data"][0])
-      end
-
-      # Gets Top Games
-      def get_top
-        response = Twitch.client.get(:helix, "games/top")
-
-        game_array(response["data"])
-      end
-
-      private
-
-      def game_array(data)
-        games = []
-
-        data.each do |g|
-          games << new(g)
-        end
-
-        games
-      end
-
-    end
-
-  end
-end

data/lib/twitch/initializable.rb

@@ -1,16 +0,0 @@
-module Twitch
-  module Initializable
-
-    def initialize(params = {})
-      params.each do |key, value|
-        if key == "_id"
-          key = "id"
-        end
-
-        setter = "#{key}="
-        send(setter, value) if respond_to?(setter.to_sym, false)
-      end
-
-    end
-  end
-end

data/lib/twitch/kraken/channels.rb

@@ -1,22 +0,0 @@
-module Twitch
-  module Kraken
-    class Channels
-
-      include Initializable
-
-      attr_accessor :id, :name, :display_name, :broadcaster_language, :followers, :game, :language, :logo, :mature, :partner, :profile_banner, :profile_banner_background_colour, :status, :url, :video_banner, :views, :created_at, :updated_at
-
-      class << self
-
-        # Gets a specified channel object
-        def get_channel_by_id(id)
-          response = Twitch.client.get(:kraken, "channels/#{id}")
-
-          new(response)
-        end
-
-      end
-
-    end
-  end
-end

data/lib/twitch/kraken/clips.rb

@@ -1,22 +0,0 @@
-module Twitch
-  module Kraken
-    class Clips
-
-      include Initializable
-
-      attr_accessor :id, :title, :slug, :url, :embed_url, :game, :views, :duration, :language, :broadcaster, :curator, :vod, :created_at, :updated_at
-
-      class << self
-
-        # Gets details about a specified clip
-        def get(slug)
-          response = Twitch.client.get(:kraken, "clips/#{slug}")
-
-          new(response)
-        end
-
-      end
-
-    end
-  end
-end

data/lib/twitch/kraken/user.rb

@@ -1,23 +0,0 @@
-module Twitch
-  module Kraken
-    class User
-
-      include Initializable
-
-      attr_accessor :id, :name, :display_name, :email, :email_verified, :partnered, :type, :bio, :logo, :created_at, :updated_at
-
-      class << self
-
-        # Gets a user object based on the OAuth token provided
-        # Scopes required: user_read
-        def get
-          response = Twitch.client.get("user")
-
-          new(response)
-        end
-
-      end
-
-    end
-  end
-end

data/lib/twitch/kraken/users.rb

@@ -1,33 +0,0 @@
-module Twitch
-  module Kraken
-    class Users
-
-      include Initializable
-
-      attr_accessor :id, :name, :display_name, :type, :bio, :logo, :created_at, :updated_at
-
-      class << self
-
-        # Gets a specified user object
-        def get_user_by_id(id)
-          response = Twitch.client.get(:kraken, "users/#{id}")
-
-          new(response)
-        end
-
-        # Gets the user objects for the specified Twitch login names
-        def get_users(username)
-          response = Twitch.client.get(:kraken, "users?login=#{username}")
-
-          if response["users"].count >= 1
-            new(response["users"].first)
-          else
-            raise Twitch::Errors::NotFound
-          end
-        end
-
-      end
-
-    end
-  end
-end