twitch-api 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac33cdb4eea079d0b42b33b7eabe032559a53a491e31ea89c0631820f1e0fcd4
-  data.tar.gz: e3dac26f11d2560eaed250cac580be1c4a9c260d2a2d2cd8fbd3db011eae1fba
+  metadata.gz: eb54134c100870a945316675e056f7c32c0cd67ea354d19bfba277d7a1660fb1
+  data.tar.gz: 4fa7aff219b7993eb679d7444e7ebd35d309923d3ffcc52daa5d3130ec2ce6b7
 SHA512:
-  metadata.gz: dbcfd386114ef19bd142faa9d768acff1dfe83adaa21fec029e7c3cc517ed664d7f24f7bcd112449ebf8eb9b2306f6727200a344064026ffabbda154ee848a6a
-  data.tar.gz: e40a2a3c7635ce58ab7b05a96b682b34e46549135e9874ec4ac7ad97088157acecfe18939b80c11ecaf9effe95179bef5b066e6154a7cfc8e42813c9bfcc28ba
+  metadata.gz: 8a8429635b999c142b06996ed11ff36d35b10dac4ed68d255bd6eefd9341e3360f13e3d8c1b8ce8ac303efccde1ff48fdba9f613396971ffeef7129b28af8680
+  data.tar.gz: 51b75f09e9df2d67045e0c9b8e32f707425156641066789b6544e8384cc2b20cc532a274c698a30b5e2ae5e49f2269f5b920b67e58676642fdbf6705db9a2488

data/README.md

@@ -3,6 +3,7 @@
 This library is a Ruby implementation of the [Twitch Helix API](https://dev.twitch.tv/docs/api).
 
 ## Installation
+Ruby 2.1 or later is required.
 
 Add this line to your application's Gemfile:
 
@@ -19,21 +20,22 @@ Or install it yourself as:
     $ gem install twitch-api
 
 ## Usage
-NOTE: **These procedures are subject to change** while both the API and this library are in an early state.
-
 A client must be initialized with your client ID, and optionally an OAuth access token.
 ```
 client = Twitch::Client.new client_id: "YOUR_CLIENT_ID"
 ```
-The retrieval methods take in a hash equal to the GET parameters of the API endpoint, and return an typed array of the items requested.
+The retrieval methods take in a hash equal to the GET parameters of the API endpoint, and return a response object containing the data and other associated request information:
+* **data** is the data you would get back
+* **rate_limit** contains the number of API requests that can be made in total within a 60-second window. See **rate_limit_remaining** and  **rate_limit_resets_at** to determine the current allowed rate.
+* **pagination** (optional) is an hash that usually contains one member (*cursor*) which lets you pagniate through certain requests.
 ```
 # Get top live streams
-client.get_streams
+client.get_streams.data
 # Get a single user
-client.get_users({login: "disguisedtoasths"}).first
+client.get_users({login: "disguisedtoasths"}).data.first
 # Find some games
 # (use an array for up to 100 of most queryable resources)
-client.get_games({name: ["Heroes of the Storm", "Super Mario Odyssey"]})
+client.get_games({name: ["Heroes of the Storm", "Super Mario Odyssey"]}).data
 ```
 
 ## Development
@@ -44,7 +46,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Upon reaching version 0.1.0, bug reports and pull requests will be welcome on GitHub at https://github.com/mauricew/ruby-twitch-api.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mauricew/ruby-twitch-api.
 
 ## License
 

data/lib/twitch/api_error.rb

@@ -0,0 +1,13 @@
+module Twitch
+  class ApiError < StandardError
+    attr_reader :status_code, :body
+
+    def initialize(status_code, body)
+      @status_code = status_code
+      @body = body
+
+      msg = "The server returned error #{status_code}"
+      super(msg)
+    end
+  end
+end

data/lib/twitch/client.rb

@@ -1,8 +1,12 @@
 require "faraday"
 require "faraday_middleware"
 
+require "twitch/response"
+require "twitch/api_error"
 require "twitch/stream"
+require "twitch/stream_metadata"
 require "twitch/user"
+require "twitch/user_follow"
 require "twitch/game"
 require "twitch/video"
 
@@ -10,7 +14,9 @@ module Twitch
   class Client
     API_ENDPOINT = "https://api.twitch.tv/helix".freeze
 
-    def initialize(client_id:, access_token: nil)
+    def initialize(client_id: nil, access_token: nil)
+      raise "Client ID is required" if client_id.nil?
+      
       headers = {
         "Client-ID": client_id,
         "User-Agent": "twitch-api ruby client #{Twitch::VERSION}"
@@ -25,44 +31,69 @@ module Twitch
       end
     end
 
+
+    def get_games(options = {})
+      res = get('games', options)
+
+      games = res[:data].map { |g| Game.new(g) }
+      Response.new(games, res[:rate_limit_headers])
+    end
+
     def get_streams(options = {})
       res = get('streams', options)
 
-      streams = res.body['data'].map { |s| Stream.new(s) }
+      streams = res[:data].map { |s| Stream.new(s) }
+      Response.new(streams, res[:rate_limit_headers], res[:pagination])
     end
 
-    def get_users(options = {})
-      res = get('users', options)
+    def get_streams_metadata(options = {})
+      res = get('streams/metadata', options)
 
-      users = res.body['data'].map { |u| User.new(u) }
+      stream_metadata = res[:data].map { |s| StreamMetadata.new(s) }
+      Response.new(stream_metadata, res[:rate_limit_headers], res[:pagination])
     end
 
-    def get_games(options = {})
-      res = get('games', options)
+    def get_users_follows(options = {})
+      res = get('users/follows', options)
 
-      games = res.body['data'].map { |g| Game.new(g) }
+      users = res[:data].map { |u| UserFollow.new(u) }
+      Response.new(users, res[:rate_limit_headers], res[:pagination])
+    end
+
+    def get_users(options = {})
+      res = get('users', options)
+
+      users = res[:data].map { |u| User.new(u) }
+      Response.new(users, res[:rate_limit_headers])
     end
 
     def get_videos(options = {})
       res = get('videos', options)
 
-      videos = res.body['data'].map { |v| Video.new(v) }
+      videos = res[:data].map { |v| Video.new(v) }
+      Response.new(videos, res[:rate_limit_headers], res[:pagination])
     end
 
     private
 
       def get(resource, params)
-        res = @conn.get(resource, params)
-
-        unless res.status == 200
-          msg= %Q{The server returned an error.
-#{res.body["error"]}: #{res.body["message"]}
-Status: #{res.body["status"]}}
+        http_res = @conn.get(resource, params)
 
-          raise Exception.new(msg)
+        unless http_res.success?
+          raise ApiError.new(http_res.status, http_res.body)
         end
 
-        res
+        rate_limit_headers = Hash[http_res.headers.select { |k,v|
+          k.to_s.downcase.match(/^ratelimit/)
+        }.map { |k,v| [k.gsub('ratelimit-', '').to_sym, v] }]
+
+        pagination = http_res.body['pagination'] if http_res.body.key?('pagination')
+
+        { 
+          data: http_res.body['data'],
+          pagination: pagination,
+          rate_limit_headers: rate_limit_headers
+        }
       end
   end
 end

data/lib/twitch/game.rb

@@ -3,9 +3,9 @@ module Twitch
     attr_reader :id, :name, :box_art_url
 
     def initialize(attributes = {})
-      attributes.each do |k, v|
-        instance_variable_set("@#{k}", v)
-      end
+      @id = attributes['id']
+      @name = attributes['name']
+      @box_art_url = attributes['name']
     end
   end
 end

data/lib/twitch/response.rb

@@ -0,0 +1,15 @@
+module Twitch
+  class Response
+    attr_reader :data, :pagination,  :rate_limit, :rate_limit_remaining, :rate_limit_resets_at
+
+    def initialize(data, rate_limit_headers, pagination = nil)
+      @data = data
+
+      @rate_limit = rate_limit_headers[:limit].to_i
+      @rate_limit_remaining = rate_limit_headers[:remaining].to_i
+      @rate_limit_resets_at = Time.at(rate_limit_headers[:reset].to_i)
+
+      @pagination = pagination
+    end
+  end
+end

data/lib/twitch/stream_metadata.rb

@@ -0,0 +1,19 @@
+module Twitch
+  class StreamMetadata
+    attr_reader :user_id, :game_id
+
+    def initialize(attributes = {})
+      @user_id = attributes['user_id']
+      @game_id = attributes['game_id']
+
+      # Since more games can be supported in the future, this will ensure
+      # they will all be available.
+      attributes.each do |k, v|
+        unless instance_variables.include?("@#{k}".to_sym)
+          self.class.send(:attr_reader, k.to_sym)
+          instance_variable_set("@#{k}", v)
+        end
+      end
+    end
+  end
+end

data/lib/twitch/user_follow.rb

@@ -0,0 +1,11 @@
+module Twitch
+  class UserFollow
+    attr_reader :from_id, :to_id, :followed_at
+
+    def initialize(attributes = {})
+      @from_id = attributes['from_id']
+      @to_id = attributes['to_id']
+      @followed_at = Time.iso8601(attributes['followed_at'])
+    end
+  end
+end

data/lib/twitch/version.rb

@@ -1,3 +1,3 @@
 module Twitch
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/twitch/video.rb

@@ -4,7 +4,8 @@ module Twitch
   class Video
     DATE_ATTRIBUTES = [:created_at, :published_at]
 
-    attr_reader :id, :title, :description, :language, :view_count, :created_at, :published_at, :thumbnail_url
+    attr_reader :id, :title, :description, :language, :view_count, :created_at, 
+      :published_at, :thumbnail_url, :type, :url, :user_id, :viewable, :duration
 
     def initialize(attributes = {})
       attributes.each do |k, v|

data/twitch-api.gemspec

@@ -27,4 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.1"
+  spec.add_development_dependency "vcr", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitch-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Maurice Wahba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 
 email:
 - maurice.wahba@gmail.com
@@ -97,10 +125,14 @@ files:
 - bin/console
 - bin/setup
 - lib/twitch-api.rb
+- lib/twitch/api_error.rb
 - lib/twitch/client.rb
 - lib/twitch/game.rb
+- lib/twitch/response.rb
 - lib/twitch/stream.rb
+- lib/twitch/stream_metadata.rb
 - lib/twitch/user.rb
+- lib/twitch/user_follow.rb
 - lib/twitch/version.rb
 - lib/twitch/video.rb
 - twitch-api.gemspec