twitch-api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 496abaceb2ef84dbd33eee192a05daf8270d9c77c373ba6beadaf915bb1cf426
-  data.tar.gz: 66a591c5e4c176fab22c198b907020a31dffd2499c7d95cada41e0cd53feb7f1
+  metadata.gz: 13fa554e6376acacd400d0aad2e651d295c613297df4476ba7c1736b6e7640aa
+  data.tar.gz: 6e180eab8e7061535821922cbc6ad4c4b35e867096314a7ddf564704ea32882c
 SHA512:
-  metadata.gz: c9a8bc3775456383bfa0162aff51fc62d35374dcd8fe355b46ec3fb0fe5733fe0164319a3fc1fd0487df2043aae49a8d5e9976f01bddc59572ea6a3e24028c9f
-  data.tar.gz: b5498b3112dfb9d61a64f04780a46d3aa895ba827b38074739f1b7c4dbdc31d9f4b1687c1c277e3b131a556f9848df65ff47193d7582f08af13fcf0f8e25b34b
+  metadata.gz: 7b45c4f07f653c77e3058579dac055efbcb2b1664fe1c68f63caf3715bfd8471a318bacc2d6ec49f072d0fee7686b7d72313c939e26c0e8a8bbd888137611e1a
+  data.tar.gz: c29bf47c2020a2b2617d1f6a54b7fda59b0544c165c5787fcbba92963dc11eeaeee2149640e8bbcaa86a4b1eca7551050d82d40ca1d6657543c8647f511f4a40

data/.travis.yml

@@ -1,5 +1,9 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.3
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+env:
+  - TWITCH_CLIENT_ID=test
 before_install: gem install bundler -v 1.16.0

data/README.md

@@ -1,3 +1,7 @@
+[![Gem](https://img.shields.io/gem/v/twitch-api.svg)](https://rubygems.org/gems/twitch-api)
+[![Downloads](https://img.shields.io/gem/dt/twitch-api.svg)](https://rubygems.org/gems/twitch-api)
+[![Travis](https://img.shields.io/travis/mauricew/ruby-twitch-api.svg)](https://travis-ci.org/mauricew/ruby-twitch-api)
+[![License](https://img.shields.io/github/license/mauricew/ruby-twitch-api.svg)]()
 # Ruby Twitch API
 
 This library is a Ruby implementation of the [Twitch Helix API](https://dev.twitch.tv/docs/api).
@@ -9,6 +13,7 @@ Guaranteed supported APIs include:
 * Helix Webhooks (coming soon)
 
 The future may bring:
+* Authentication
 * PubSub
 * TMI/chat
 
@@ -39,14 +44,17 @@ Or install it yourself as:
 ## Usage
 A client must be initialized with your client ID or bearer access token.
 ```
-client = Twitch::Client.new client_id: "YOUR_CLIENT_ID"
+client = Twitch::Client.new(client_id: "YOUR_CLIENT_ID")
 # or
-client = Twitch::Client.new access_token: "YOUR_ACCESS_TOKEN"
+client = Twitch::Client.new(access_token: "YOUR_ACCESS_TOKEN")
 ```
-The retrieval methods take in a hash equal to the parameters of the API endpoint, and return a response object containing the data and other associated request information:
+Because data may change for certain endpoints, there is also a keyword parameter called `with_raw` that returns the raw response for any request called.
+
+Retrieval methods take in a hash equal to the 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. Even if it's an array of one object, it remains the same as what comes from the API.
 * **rate_limit** and associated fields contain API request limit information. Clip creation counts for a second limit (duration currently unknown).
-* **pagination** is an hash that appears when data can be traversed, and contains one member (*cursor*) which lets you pagniate through certain requests.
+* **pagination** is a hash that appears when data can be traversed, and contains one member (*cursor*) which lets you pagniate through certain requests.
+* **raw** is the raw HTTP response data when `with_raw` is true in the client.
 ```
 # Get top live streams
 client.get_streams.data
@@ -72,7 +80,3 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mauricew/ruby-twitch-api.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/twitch/bits_leader.rb

@@ -0,0 +1,18 @@
+module Twitch
+  # A user that is a leader for bits.
+  class BitsLeader
+    # ID of the user giving bits.
+    attr_reader :user_id
+    # Ranking of the user giving bits.
+    # Reflects the parent object's date range.
+    attr_reader :rank
+    # Number of bits given in the parent object's date range.
+    attr_reader :score
+
+    def initialize(attributes = {})
+      @user_id = attributes['user_id']
+      @rank = attributes['rank']
+      @score = attributes['score']
+    end
+  end
+end

data/lib/twitch/client.rb

@@ -3,9 +3,11 @@ require "faraday_middleware"
 
 require "twitch/response"
 require "twitch/api_error"
+require "twitch/bits_leader"
 require "twitch/clip"
 require "twitch/entitlement_grant_url"
 require "twitch/game"
+require "twitch/game_analytic"
 require "twitch/stream"
 require "twitch/stream_metadata"
 require "twitch/user"
@@ -24,7 +26,9 @@ module Twitch
     # - access_token [String] An access token.
     # Used as the Authorization header in a request.
     # Any "Bearer " prefix will be stripped.
-    def initialize(client_id: nil, access_token: nil)
+    # - with_raw [Boolean] Whether to include raw HTTP response
+    # Intended for testing/checking API results
+    def initialize(client_id: nil, access_token: nil, with_raw: false)
       if client_id.nil? && access_token.nil?
         raise "An identifier token (client ID or bearer token) is required"
       elsif !!client_id && !!access_token
@@ -49,83 +53,60 @@ Unpredictable behavior may follow.})
         faraday.response :json
         faraday.adapter Faraday.default_adapter
       end
+
+      @with_raw = with_raw
     end
 
     def create_clip(options = {})
-      res = post('clips', options)
-
-      clip = res[:data].map { |c| Clip.new(c) }
-      Response.new(clip, res[:rate_limit_headers])
+      Response.new(Clip, post('clips', options))
     end
 
     def create_entitlement_grant_url(options = {})
-      res = post('entitlements/upload', options)
-
-      entitlement_grant = res[:data].map { |e| EntitlementGrantUrl.new(e) }
-      Response.new(entitlement_grant, res[:rate_limit_headers])
+      Response.new(EntitlementGrantUrl, post('entitlements/upload', options))
     end
 
     def get_clips(options = {})
-      res = get('clips', options)
+      Response.new(Clip, get('clips', options))
+    end
 
-      clips = res[:data].map { |c| Clip.new(c) }
-      Response.new(clips, res[:rate_limit_headers])
+    def get_bits_leaderboard(options = {})
+      Response.new(BitsLeader, get('bits/leaderboard', options))
     end
 
     def get_games(options = {})
-      res = get('games', options)
-
-      games = res[:data].map { |g| Game.new(g) }
-      Response.new(games, res[:rate_limit_headers])
+      Response.new(Game, get('games', options))
     end
 
     def get_top_games(options = {})
-      res = get('games/top', options)
+      Response.new(Game, get('games/top', options))
+    end
 
-      games = res[:data].map { |g| Game.new(g) }
-      Response.new(games, res[:rate_limit_headers], res[:pagination])
+    def get_game_analytics(options = {})
+      Response.new(GameAnalytic, get('analytics/games', options))
     end
 
     def get_streams(options = {})
-      res = get('streams', options)
-
-      streams = res[:data].map { |s| Stream.new(s) }
-      Response.new(streams, res[:rate_limit_headers], res[:pagination])
+      Response.new(Stream, get('streams', options))
     end
 
     def get_streams_metadata(options = {})
-      res = get('streams/metadata', options)
-
-      stream_metadata = res[:data].map { |s| StreamMetadata.new(s) }
-      Response.new(stream_metadata, res[:rate_limit_headers], res[:pagination])
+      Response.new(StreamMetadata, get('streams/metadata', options))
     end
 
     def get_users_follows(options = {})
-      res = get('users/follows', options)
-
-      users = res[:data].map { |u| UserFollow.new(u) }
-      Response.new(users, res[:rate_limit_headers], res[:pagination])
+      Response.new(UserFollow, get('users/follows', options))
     end
 
     def get_users(options = {})
-      res = get('users', options)
-
-      users = res[:data].map { |u| User.new(u) }
-      Response.new(users, res[:rate_limit_headers])
+      Response.new(User, get('users', options))
     end
 
     def update_user(options = {})
-      res = put('users', options)
-
-      user = res[:data].map { |u| User.new(u) }
-      Response.new(user, res[:rate_limit_headers])
+      Response.new(User, put('users', options))
     end
 
     def get_videos(options = {})
-      res = get('videos', options)
-
-      videos = res[:data].map { |v| Video.new(v) }
-      Response.new(videos, res[:rate_limit_headers], res[:pagination])
+      Response.new(Video, get('videos', options))
     end
 
     private
@@ -150,18 +131,9 @@ Unpredictable behavior may follow.})
           raise ApiError.new(http_res.status, http_res.body)
         end
 
-        rate_limit_headers = Hash[http_res.headers.select do |k,v|
-          k.to_s.downcase.match(/^ratelimit/)
-        end.map { |k,v| [k.gsub('ratelimit-', '').to_sym, v] }]
-
-        if http_res.body.key?('pagination')
-          pagination = http_res.body['pagination'] 
-        end
-
-        { 
-          data: http_res.body['data'],
-          pagination: pagination,
-          rate_limit_headers: rate_limit_headers
+        {
+            http_res: http_res,
+            with_raw: @with_raw
         }
       end
   end

data/lib/twitch/game_analytic.rb

@@ -0,0 +1,14 @@
+module Twitch
+  # A 
+  class GameAnalytic
+    # ID of the game requested.
+    attr_reader :game_id
+    # A link to a (CSV format) data report.
+    attr_reader :url
+
+    def initialize(attributes = {})
+      @game_id = attributes['game_id']
+      @url = attributes['URL']
+    end
+  end
+end

data/lib/twitch/response.rb

@@ -3,9 +3,17 @@ module Twitch
   class Response
     # The requested data.
     attr_reader :data
-    # A hash containing a pagination token.  
+    # A total amount of entities.
+    # Applies to select endpoints.
+    attr_reader :total
+    # A range of dates in which data is effective.
+    # Usually contains the keys start_date and end_date.
+    # Applies to select endpoints.
+    attr_reader :date_range
+    # A hash containing a pagination token. 
     # Access it with
     #    pagination['cursor']
+    # Applies to select endpoints. 
     attr_reader :pagination
     # The total amount of calls that can be used in
     # the rate limit period (one minute by default).
@@ -20,9 +28,18 @@ module Twitch
     # The remaining amount of clips that can be created in 
     # the clip rate limit period. 
     attr_reader :clip_rate_limit_remaining
+    # The HTTP raw response
+    attr_reader :raw
 
-    def initialize(data, rate_limit_headers, pagination = nil)
-      @data = data
+    def initialize(data_class, res)
+      http_res = res[:http_res]
+      @raw = http_res if res[:with_raw]
+
+      @data = http_res.body['data'].map { |d| data_class.new(d) }
+
+      rate_limit_headers = Hash[http_res.headers.select do |k,v|
+        k.to_s.downcase.match(/^ratelimit/)
+      end.map { |k,v| [k.gsub('ratelimit-', '').to_sym, v] }]
 
       @rate_limit = rate_limit_headers[:limit].to_i
       @rate_limit_remaining = rate_limit_headers[:remaining].to_i
@@ -33,7 +50,9 @@ module Twitch
         @clip_rate_limit_remaining = rate_limit_headers[:'helixclipscreation-remaining']
       end
 
-      @pagination = pagination
+      @pagination = http_res.body['pagination']
+      @total = http_res.body['total']
+      @date_range = http_res.body['date_range']
     end
   end
 end

data/lib/twitch/version.rb

@@ -1,4 +1,4 @@
 module Twitch
   # Library version.
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/twitch-api.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday", "~> 0.13"
+  spec.add_dependency "faraday", ">= 0.12.2"
   spec.add_dependency "faraday_middleware", "~> 0.12"
 
   spec.add_development_dependency "bundler", "~> 1.16"

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: twitch-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Maurice Wahba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-06 00:00:00.000000000 Z
+date: 2018-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: 0.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -126,10 +126,12 @@ files:
 - bin/setup
 - lib/twitch-api.rb
 - lib/twitch/api_error.rb
+- lib/twitch/bits_leader.rb
 - lib/twitch/client.rb
 - lib/twitch/clip.rb
 - lib/twitch/entitlement_grant_url.rb
 - lib/twitch/game.rb
+- lib/twitch/game_analytic.rb
 - lib/twitch/response.rb
 - lib/twitch/stream.rb
 - lib/twitch/stream_metadata.rb