twitchrb 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6d24ae98033340c3a32007d15326393e2eb630d9bf617a22dcd86c3bd96205b
-  data.tar.gz: 4099ce7790604f9d77dfb4e7e5c22252573ef6adcfde1806b99ea8b966d984cf
+  metadata.gz: 30b0eac63e649a017a1c4938b034886f1934da667145ca984f7d2898220d9c91
+  data.tar.gz: 97883516313836adc1a003649904b532c66ce5f14568981d5f82b21b807f489b
 SHA512:
-  metadata.gz: 63a0c047cd6803daf0e094bdf88e0fb6ac73fa1959beb84f43c38634190bb5a53ce2e2242993ead65b8361ca4673a601a608a7769eac4026c320b83f9e57a3cc
-  data.tar.gz: c04701b41259897d3a871df91037b801fb6c36f3e15f8bb764863dc96435b1da5671a97611570e11f5244d94dc851275f1f7cf0b4a69dcd929822548d2061157
+  metadata.gz: 5337a58e97212f82d77208f41a0af2b2b0f5b36c3652b7905c51af117e67767affe6a1388e647ed8e4f8ed307488084ee91989cc1a21494265dd5abba9055eea
+  data.tar.gz: 4a95c514a5d1addd4eebd265ba04ba79ae945913042ee4245d07a563e69bf37d365a49d31078130c425a5b545128886058211db96cc3444ff32bd56ebaa31490

data/.env.example

@@ -0,0 +1,3 @@
+TWITCH_CLIENT_ID=
+TWITCH_CLIENT_SECRET=
+TWITCH_ACCESS_TOKEN=

data/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: deanpcmad
+custom: https://www.buymeacoffee.com/deanpcmad

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.env

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
+gem "dotenv"

data/Gemfile.lock

@@ -1,26 +1,45 @@
 PATH
   remote: .
   specs:
-    twitchrb (0.1.0)
-      httparty (~> 0.18.1)
+    twitchrb (0.2.2)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    httparty (0.18.1)
-      mime-types (~> 3.0)
-      multi_xml (>= 0.5.2)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
+    dotenv (2.7.6)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
     minitest (5.14.1)
-    multi_xml (0.6.0)
+    multipart-post (2.1.1)
     rake (12.3.3)
+    ruby2_keywords (0.0.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  dotenv
   minitest (~> 5.0)
   rake (~> 12.0)
   twitchrb!

data/README.md

@@ -2,9 +2,9 @@
 
 **This library is a work in progress**
 
-This RubyGem is a library for intereacting with the Twitch API.
+TwitchRB is a Ruby library for intereacting with the Twitch API.
 
-It will allow you to easily interact with both the Kraken and Helix APIs.
+It only supports the Helix API as v5 is deprecated.
 
 ## Installation
 
@@ -14,15 +14,55 @@ Add this line to your application's Gemfile:
 gem "twitchrb", require: "twitch"
 ```
 
-And then execute:
+## Usage
 
-    $ bundle install
+### Set Client Details
 
+Firstly you'll need to set a Client ID, Secret Key and an Access Token.
 
-## Contributing
+An access token is required because the Helix API requires authentication.
+
+```ruby
+@client = Twitch::Client.new(client_id: "", secret_key: "", access_token: "")
+```
+
+### Users
+
+```ruby
+@client.users.get_by_id(user_id: 141981764)
+@client.users.get_by_username(username: "twitchdev")
+```
+
+### Channels
+
+```ruby
+@client.channels.get(broadcaster_id: 141981764)
+```
+
+### Videos
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/twitchrb.
+```ruby
+@client.videos.get(user_id: 141981764)
+```
+
+### Emotes
+
+```ruby
+@client.emotes.global
+@client.emotes.channel(broadcaster_id: 141981764)
+@client.emotes.sets(emote_set_id: 301590448)
+```
+
+### Badges
+
+```ruby
+@client.badges.global
+@client.badges.channel(broadcaster_id: 141981764)
+```
+
+## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/twitchrb/twitchrb.
 
 ## License
 

data/bin/console

@@ -3,6 +3,9 @@
 require "bundler/setup"
 require "twitch"
 
+# Load environment variables from .env file
+require 'dotenv/load'
+
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
@@ -10,5 +13,7 @@ require "twitch"
 # require "pry"
 # Pry.start
 
+@client = Twitch::Client.new(client_id: ENV["TWITCH_CLIENT_ID"], client_secret: ENV["TWITCH_CLIENT_SECRET"], access_token: ENV["TWITCH_ACCESS_TOKEN"])
+
 require "irb"
 IRB.start(__FILE__)

data/lib/twitch/client.rb

@@ -1,89 +1,127 @@
-require "httparty"
-
 module Twitch
   class Client
+    BASE_URL = "https://api.twitch.tv/helix"
 
-    # def initialize(client_id, client_secret, access_token=nil)
-    def initialize(client_id)
-      puts "initialize"
+    attr_reader :client_id, :client_secret, :access_token, :adapter
 
+    def initialize(client_id:, client_secret:, access_token:, adapter: Faraday.default_adapter, stubs: nil)
       @client_id = client_id
+      @client_secret = client_secret
+      @access_token = access_token
+      @adapter = adapter
 
-      # if client_id && client_secret
-      #   @client_id = client_id
-      #   @client_secret = client_secret
-      #   @access_token = access_token
-      # else
-      #   raise Twitch::ClientError.new('Client ID or Client Secret not set')
-      # end
-
-    end
-
-
-    def get(kind, url, params={})
-      # puts url
-      # puts params
-      # puts @client_id
-      response = HTTParty.get("https://api.twitch.tv/#{kind}/#{url}", {
-        headers: {
-          "Client-ID" => @client_id,
-          "Accept" => "application/vnd.twitchtv.v5+json",
-          # "Authorization" => "OAuth #{@access_token}"
-        }
-      })
-      # puts response
-
-      # JSON.parse(response.body)
-
-      success = case response.code
-      when 200
-        JSON.parse(response.body)
-      when 400
-        json = JSON.parse(response.body)
-        raise Twitch::Errors::NotFound, json['error']
-      when 503
-        raise Twitch::Errors::ServiceUnavailable
-      when 401, 403
-        puts response.body.inspect
-        raise Twitch::Errors::AccessDenied, "Access Denied for '#{@client_id}'"
-      when 400
-        json = JSON.parse(response.body)
-        raise Twitch::Errors::ValidationError, json['errors'].to_s
-      else
-        raise Twitch::Errors::CommunicationError, response.body
-      end
+      # Test stubs for requests
+      @stubs = stubs
+    end
+
+    def users
+      UsersResource.new(self)
+    end
+
+    def channels
+      ChannelsResource.new(self)
+    end
+
+    def emotes
+      EmotesResource.new(self)
+    end
+
+    def badges
+      BadgesResource.new(self)
+    end
+
+    def games
+      GamesResource.new(self)
+    end
+
+    def videos
+      VideosResource.new(self)
+    end
+    
+    def clips
+      ClipsResource.new(self)
+    end
+
+    def eventsub_subscriptions
+      EventSubSubscriptionsResource.new(self)
+    end
+
+    def banned_events
+      BannedEventsResource.new(self)
+    end
 
+    def banned_users
+      BannedUsersResource.new(self)
+    end
+
+    def moderators
+      ModeratorsResource.new(self)
+    end
+
+    def moderator_events
+      ModeratorEventsResource.new(self)
+    end
 
-      # if response.code == 200
-      #   JSON.parse(response.body)
-      # elsif response.code == 404
-      #   Twitch::NotFoundError.new(response.body)
-      # elsif response.code == 500
-      #   Twitch::ServerError.new(response.body)
-      # end
+    def polls
+      PollsResource.new(self)
+    end
+
+    def predictions
+      PredictionsResource.new(self)
+    end
+
+    def stream_schedule
+      StreamScheduleResource.new(self)
+    end
 
+    def search
+      SearchResource.new(self)
+    end
 
+    def streams
+      StreamsResource.new(self)
+    end
 
-      # when Net::HTTPClientError
-      #   json = JSON.parse(http_result.body)
-      #   raise Twitch::Errors::ValidationError, json['errors'].to_s
-      # else
-      #   raise Twitch::Errors::CommunicationError, http_result.body
-      # end
+    def stream_markers
+      StreamMarkersResource.new(self)
+    end
 
+    def subscriptions
+      SubscriptionsResource.new(self)
+    end
 
+    def tags
+      TagsResource.new(self)
     end
 
+    def custom_rewards
+      CustomRewardsResource.new(self)
+    end
 
-    # private
+    def custom_reward_redemptions
+      CustomRewardRedemptionsResource.new(self)
+    end
 
-    # def request(method, path, options={})
-    #   # if @access_token
+    def goals
+      GoalsResource.new(self)
+    end
 
+    def hype_train_events
+      HypeTrainEventsResource.new(self)
+    end
 
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.request :authorization, :Bearer, access_token
+        conn.headers = { "Client-ID": client_id }
+        conn.request :json
 
-    # end
+        conn.response :dates
+        conn.response :json, content_type: "application/json"
 
+        conn.adapter adapter, @stubs
+      end
+    end
 
   end
 end

data/lib/twitch/collection.rb

@@ -0,0 +1,21 @@
+module Twitch
+  class Collection
+    attr_reader :data, :total, :cursor
+
+    def self.from_response(response, type:)
+      body = response.body
+
+      new(
+        data: body["data"].map { |attrs| type.new(attrs) },
+        total: body["data"].count,
+        cursor: body.dig("pagination", "cursor")
+      )
+    end
+
+    def initialize(data:, total:, cursor:)
+      @data = data
+      @total = total
+      @cursor = cursor.nil? ? nil : cursor
+    end
+  end
+end

data/lib/twitch/error.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class Error < StandardError
+  end
+end

data/lib/twitch/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module Twitch
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/twitch/objects/badge.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class Badge < Object
+  end
+end

data/lib/twitch/objects/banned_event.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class BannedEvent < Object
+  end
+end

data/lib/twitch/objects/banned_user.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class BannedUser < Object
+  end
+end

data/lib/twitch/objects/blocked_user.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class BlockedUser < Object
+  end
+end

data/lib/twitch/objects/channel.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class Channel < Object
+  end
+end

data/lib/twitch/objects/channel_editor.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class ChannelEditor < Object
+  end
+end

data/lib/twitch/objects/clip.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class Clip < Object
+  end
+end

data/lib/twitch/objects/custom_reward.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class CustomReward < Object
+  end
+end

data/lib/twitch/objects/custom_reward_redemption.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class CustomRewardRedemption < Object
+  end
+end

data/lib/twitch/objects/emote.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class Emote < Object
+  end
+end

data/lib/twitch/objects/event_sub_subscription.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class EventSubSubscription < Object
+  end
+end

data/lib/twitch/objects/followed_user.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class FollowedUser < Object
+  end
+end

data/lib/twitch/objects/game.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class Game < Object
+  end
+end

data/lib/twitch/objects/goal.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class Goal < Object
+  end
+end

data/lib/twitch/objects/hype_train_event.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class HypeTrainEvent < Object
+  end
+end

data/lib/twitch/objects/moderator.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class Moderator < Object
+  end
+end

data/lib/twitch/objects/moderator_event.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class ModeratorEvent < Object
+  end
+end

data/lib/twitch/objects/poll.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class Poll < Object
+  end
+end

data/lib/twitch/objects/prediction.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class Prediction < Object
+  end
+end

data/lib/twitch/objects/search_result.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class SearchResult < Object
+  end
+end

data/lib/twitch/objects/stream.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class Stream < Object
+  end
+end

data/lib/twitch/objects/stream_marker.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class StreamMarker < Object
+  end
+end

data/lib/twitch/objects/stream_schedule.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class StreamSchedule < Object
+  end
+end

data/lib/twitch/objects/subscription.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class Subscription < Object
+  end
+end

data/lib/twitch/objects/subscription_count.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class SubscriptionCount < Object
+  end
+end

data/lib/twitch/objects/tag.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class Tag < Object
+  end
+end

data/lib/twitch/objects/user.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class User < Object
+  end
+end

data/lib/twitch/objects/video.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class Video < Object
+  end
+end

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