twitchrb 0.1.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f783023c0544d6ff69ae55aef0c2af9b1b179d438e435b1195dfe0895b686eb
-  data.tar.gz: 2072fb3ec4460387493e2ad33745bcd0028770a9a1f91a0cbe2576c75b519822
+  metadata.gz: daefb5be94569e5fc14f586f740c4d469f4e76b60fc2b066870f2f55748b678f
+  data.tar.gz: e3ad55b7bc2fd6b9fa8d0453136b69b9ce25612cdd945114173a0b03a4026285
 SHA512:
-  metadata.gz: 8dce1c0ff0bcd6dd7fa506f7bb0c090a883966e9d13a050593bed74b309dfb89dd9ddc6aff2f5ce80aa9c86fb1e5b01b739b7468ec1ea7ba9976212d59fa8b06
-  data.tar.gz: e64c64c6a844131c553a71721dfd540dcb4cb0a40adf4b8f0f58a93543164587651f6d914540647fea5a2997ea8ae6198db16815ac7cb853ce2b33c4641f26a4
+  metadata.gz: 6d0c1fc6409e6878d840b75b502310a22891a7bb3e0ebf0de74362f9996cd6703624f0e4a280024b4659a1c6c8b0e45c6d7d70fab09d6d82ccdff6963d1a93ed
+  data.tar.gz: a1218538954e97ee5c06115dcc3925312f705e5b835074a0f536806eff4822f7b6e08c1739ddf9be18a01420b6511bbbb794f298b2fb734d207c8d58d929695c

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.1)
-      httparty (~> 0.18.1)
+    twitchrb (0.2.3)
+      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.2021.0225)
+    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,27 +2,67 @@
 
 **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
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "twitchrb", require: "twitch"
+gem "twitchrb"
 ```
 
-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: "", client_secret: "", 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,90 +1,125 @@
-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, access_token=nil)
-      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 headers(kind)
-      if kind == :helix
-        {
-          "Client-ID" => @client_id,
-          "Accept" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
-        }
-      else
-        {
-          "Client-ID" => @client_id,
-          "Accept" => "application/vnd.twitchtv.v5+json",
-          # "Authorization" => "OAuth #{@access_token}"
-        }
-      end
+      # Test stubs for requests
+      @stubs = stubs
     end
 
+    def users
+      UsersResource.new(self)
+    end
 
-    def get(kind, url)
-      response = HTTParty.get("https://api.twitch.tv/#{kind}/#{url}", {
-        headers: headers(kind)
-      })
-
-      # Force encoding as the reponse may have emojis
-      body = response.body.force_encoding('UTF-8')
-
-      success = case response.code
-      when 200
-        JSON.parse(body)
-      when 400
-        json = JSON.parse(body)
-        raise Twitch::Errors::NotFound, json['error']
-      when 503
-        raise Twitch::Errors::ServiceUnavailable
-      when 401, 403
-        puts body.inspect
-        raise Twitch::Errors::AccessDenied, "Access Denied for '#{@client_id}'"
-      when 400
-        json = JSON.parse(body)
-        raise Twitch::Errors::ValidationError, json['errors'].to_s
-      else
-        raise Twitch::Errors::CommunicationError, body
-      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
+
+    def polls
+      PollsResource.new(self)
     end
 
-    def patch(kind, url, params={})
-      response = HTTParty.patch("https://api.twitch.tv/#{kind}/#{url}", {
-        headers: headers(kind),
-        body: params
-      })
-
-      success = case response.code
-      when 204
-        return true
-      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
+    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
+
+    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
+
+    def custom_reward_redemptions
+      CustomRewardRedemptionsResource.new(self)
+    end
+
+    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
+
+        conn.response :dates
+        conn.response :json, content_type: "application/json"
+
+        conn.adapter adapter, @stubs
       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,27 @@
+module Twitch
+  class Video < Object
+
+    def initialize(options = {})
+      super options
+
+      self.thumbnail_url_large = generate_thumbnail_url_large
+      self.animated_url = generate_animated_url
+    end
+
+
+    # Generates the Large Thumbnail image URL
+    def generate_thumbnail_url_large
+      thumbnail_url.gsub("%{width}", "640").gsub("%{height}", "360")
+    end
+  
+    # Generates a Storyboard/Animated image URL
+    def generate_animated_url
+      thumb = thumbnail_url.dup
+      thumb.gsub!("https://static-cdn.jtvnw.net/cf_vods/", "").gsub!("/thumb/thumb0-%{width}x%{height}.jpg", "storyboards/#{id}-strip-0.jpg")
+      split = thumb.split("/")
+  
+      "https://#{split[0]}.cloudfront.net/#{split[1..].join("/")}"
+    end
+
+  end
+end