giant_bomb_api 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fd8d486158ad9852607a5d5449d7c178231d240
-  data.tar.gz: 6db2a32b7bb1b96b9c0b2558f049f777aba75347
+  metadata.gz: 96c196f26a23e4fc41d2dd883f939c8c83e062c7
+  data.tar.gz: 6b6739d5ce1ffb80772ad6c4a42643c9e8ae98ba
 SHA512:
-  metadata.gz: e4c734f8103a813df3ed478f91066c14639282e48d3229b6274c01ad594e990455bfcb14b546d30f02095c6eeb06fe417b1373a7feaaf3245e53e557347e21fc
-  data.tar.gz: 148e746b6817d37b70cd31511c2a9419169dec0d18c781198ef5015a984fd6bdb92907da0c725e9a7a1e7bcad9ef830e6f907dcdfa9fab73c0558a564d78ee26
+  metadata.gz: 434798f04cdb4329fbee5ac8dd25de961865488a5d9a875973c009169255c56be6d69dfbc9f50abde08d7f0123bc530db6a2ade93e0bb6b3f706b022dcd9c58a
+  data.tar.gz: 53ed38aebfd37671baa86fd6791c1c1a0809e9a31df3ddb035d6c0d4d72f17d2b67da0901122cf3fb409148faf5ab82da2624084a5b44aa190fe94dc9d1757c5

data/.gitignore

@@ -1,3 +1,4 @@
 bin
 coverage
-*.gem
+*.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+ - 2.2.2
+script: "bundle exec rspec && bundle exec codeclimate-test-reporter"

data/README.md

@@ -6,12 +6,14 @@ This gem aims to provide access to most endpoints on the API. You'll be able to
 
 **Contributors are welcome**. Please contact [@toadle](https://github.com/toadle).
 
+[![Gem Version](https://badge.fury.io/rb/giant_bomb_api.svg)](http://badge.fury.io/rb/giant_bomb_api)
 [![Code Climate](https://codeclimate.com/github/toadle/giant_bomb_api/badges/gpa.svg)](https://codeclimate.com/github/toadle/giant_bomb_api)
 [![Test Coverage](https://codeclimate.com/github/toadle/giant_bomb_api/badges/coverage.svg)](https://codeclimate.com/github/toadle/giant_bomb_api/coverage)
-[![Circle CI](https://circleci.com/gh/toadle/giant_bomb_api/tree/dev.svg?style=svg)](https://circleci.com/gh/toadle/giant_bomb_api/tree/dev)
+[![Travis CI](https://travis-ci.org/toadle/giant_bomb_api.svg?branch=dev)](https://travis-ci.org/toadle/giant_bomb_api)
 
 ## Changelog
-* **2015-09-19**: Initial release as 0.5
+* **2017-06-30**: `each_page`-iterator instead of `all`, which supports rate-limiting. Thanks to @naiyt
+* **2015-09-19**: Initial release as 0.5.1
 
 # Installation
 
@@ -24,7 +26,7 @@ gem install giant_bomb_api
 or in your `Gemfile`
 
 ```
-gem giant_bomb_api
+gem 'giant_bomb_api'
 ```
 
 # How to use
@@ -116,16 +118,28 @@ You can also directly query a resource that has a collection-endpoint.
 
 This is available for all resources that the [Giantbomb API](http://www.giantbomb.com/api/documentation) offers a 'collection' for. e.g. `game` and `games`or `character` and `characters`.
 
-e.g. all:
+Use the `each_page` method to iterate through each page of a collection. `each_page` will accept a block and pass it the current page of results.
 
-```
-GiantBombApi::Resource::Game.all
+```ruby
+GiantBombApi::Resource::Game.each_page do |page|
+  names = page.results.map(&:name)
+  puts names
+end
 ```
 
-this call supports optional sorting, e.g.:
+`each_page` accepts the following optional keyword arguments:
 
-```
-GiantBombApi::Resource::Game.all(sort: { name: :desc })
+- `sort`: a sort option for the results
+- `limit`: the number of results to return per page. Defaults to 100 (the max allowed through the Giant Bomb API)
+- `offset`: defaults to 0
+- `should_rate_limit`: pass this in as true if you want to ensure that you are rate limiting your requests to under the required 200 per resource per hour (which is important if you're trying to iterate through every page of a resource)
+
+Example using the optional arguments:
+
+```ruby
+GiantBombApi::Resource::Game.each_page(sort: { name: :desc }, limit: 50, should_rate_limit: true) do |page|
+  # do something with the page
+end
 ```
 
 if you want to get more detailed your can do: 

data/giant_bomb_api.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name                      = "giant_bomb_api"
-  s.version                   = "0.5.1"
+  s.version                   = "0.5.2"
   s.default_executable        = "giantbomb"
 
   s.authors                   = ["Tim Adler"]
-  s.date                      = %q{2015-09-19}
+  s.date                      = %q{2017-06-30}
   s.description               = %q{An unofficial ruby wrapper for the Giantbomb API (http://api.giantbomb.com). An API that provides structured data about videogames.}
   s.summary                   = s.description
   s.email                     = %q{mail (at) toadle (dot) me}
@@ -25,7 +25,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'pry-byebug'
   s.add_development_dependency 'timecop'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'rubocop'
   s.add_development_dependency 'codeclimate-test-reporter'
 
 end
-

data/lib/giant_bomb_api/collection_resource.rb

@@ -12,8 +12,13 @@ module GiantBombApi
       self.instance_variable_get("@collection_resource_name") || self.resource_name.pluralize
     end
 
-    def all(sort = {})
-      where(sort: sort)
+    def each_page(sort: {}, limit: 100, offset: 0, should_rate_limit: false)
+      rate_limit(should_rate_limit) do
+        response = where(sort: sort, limit: limit, offset: offset, tries: 5)
+        yield response
+        offset += limit
+        break unless response.has_more_results?
+      end
     end
 
     def find(id, params = {})
@@ -26,6 +31,7 @@ module GiantBombApi
       sort = params[:sort]
       limit = params[:limit]
       offset = params[:offset]
+      tries ||= (params[:tries] || 0)
 
       args = {}
       args[:filter] = params.reject {|key,value| %i(sort limit offset).include?(key) }
@@ -34,7 +40,42 @@ module GiantBombApi
       args[:offset] = offset if offset.present?
 
       GiantBombApi.client.send_request(Request::Collection.new(self, args))
+    rescue Faraday::ConnectionFailed, Faraday::TimeoutError => e
+      if (tries -= 1) > 0
+        sleep 5
+        retry
+      end
+
+      raise e
+    end
+
+    private
+
+    def rate_limit(should_rate_limit, &block)
+      started_at = Time.now
+      num_of_requests = 0
+
+      loop do
+        t1 = Time.now
+        block.call
+        num_of_requests += 1
+        t2 = Time.now
+
+        if should_rate_limit
+          if t2 - started_at >= 1.hour
+            started_at = Time.now
+            num_of_requests = 0
+          end
+
+          request_time = t2 - t1
+          time_to_one_hour = (started_at + 1.hour) - t2
+          remaining_requests = 200 - num_of_requests
+          min_time_per_request = time_to_one_hour / remaining_requests
+
+          sleep(min_time_per_request - request_time) if request_time < min_time_per_request
+        end
+      end
     end
 
   end
-end
+end

data/spec/lib/collection_resource_spec.rb

@@ -34,43 +34,70 @@ describe GiantBombApi::CollectionResource do
 
   end
 
-  describe '#where' do
+  describe 'query methods' do
     let(:client) { double("GiantBombApi::Client") }
-    before do 
+    let(:dummy_collection_request) { double("DummyCollectionRequest") }
+    let(:response) { double("GiantBombApi::Response") }
+
+    before do
       allow(GiantBombApi).to receive(:client).and_return(client)
     end
 
-    context "when given NO additional attributes" do
-      let(:dummy_collection_request) { double("DummyCollectionRequest") }
-      let(:response) { double("GiantBombApi::Response") }
+    describe '#where' do
+      context "when given NO additional attributes" do
+        it 'will send a blank collection-request for itself' do
+          expect(GiantBombApi::Request::Collection).to receive(:new).with(DummyCollection).and_return(dummy_collection_request)
+          expect(client).to receive(:send_request).with(dummy_collection_request).and_return(response)
+          expect(DummyCollection.where).to eq response
+        end
+      end
 
-      it 'will send a blank collection-request for itself' do
-        expect(GiantBombApi::Request::Collection).to receive(:new).with(DummyCollection).and_return(dummy_collection_request)
-        expect(client).to receive(:send_request).with(dummy_collection_request).and_return(response)
-        expect(DummyCollection.where).to eq response
+      context "when given a hash that does not contain :sort, :offset or :limit" do
+        it 'will send a collection-request with the given has as a filter' do
+          expect(GiantBombApi::Request::Collection).to receive(:new).with(DummyCollection, filter: { name: "something", aliases: "other" }).and_return(dummy_collection_request)
+          expect(client).to receive(:send_request).with(dummy_collection_request).and_return(response)
+          expect(DummyCollection.where(name: "something", aliases: "other")).to eq response
+        end
       end
-    end
-    context "when given a hash that does not contain :sort, :offset or :limit" do
-      let(:dummy_collection_request) { double("DummyCollectionRequest") }
-      let(:response) { double("GiantBombApi::Response") }
-
-      it 'will send a collection-request with the given has as a filter' do
-        expect(GiantBombApi::Request::Collection).to receive(:new).with(DummyCollection, filter: { name: "something", aliases: "other" }).and_return(dummy_collection_request)
-        expect(client).to receive(:send_request).with(dummy_collection_request).and_return(response)
-        expect(DummyCollection.where(name: "something", aliases: "other")).to eq response
+
+      context "when given a hash that contains :sort, :offset and :limit" do
+        it 'will send a collection-request with the the parameters assorted correctly' do
+          expect(GiantBombApi::Request::Collection).to receive(:new).with(DummyCollection, filter: { name: "something", aliases: "other" }, sort: {something: :desc}, limit: 10, offset: 1).and_return(dummy_collection_request)
+          expect(client).to receive(:send_request).with(dummy_collection_request).and_return(response)
+          expect(DummyCollection.where(name: "something", aliases: "other", sort: {something: :desc}, limit: 10, offset: 1)).to eq response
+        end
       end
     end
 
-    context "when given a hash that contains :sort, :offset and :limit" do
-      let(:dummy_collection_request) { double("DummyCollectionRequest") }
-      let(:response) { double("GiantBombApi::Response") }
+    describe '#each_page' do
+      it 'will continually retrieve the next page until there are no more results' do
+        expect(DummyCollection).to receive(:where).and_return(dummy_collection_request).exactly(5).times
+        allow(dummy_collection_request).to receive(:has_more_results?).and_return(true)
+
+        times = 0
+        DummyCollection.each_page do |page|
+          times += 1
+          if times == 5
+            allow(dummy_collection_request).to receive(:has_more_results?).and_return(false)
+          end
+        end
+      end
 
-      it 'will send a collection-request with the the parameters assorted correctly' do
-        expect(GiantBombApi::Request::Collection).to receive(:new).with(DummyCollection, filter: { name: "something", aliases: "other" }, sort: {something: :desc}, limit: 10, offset: 1).and_return(dummy_collection_request)
-        expect(client).to receive(:send_request).with(dummy_collection_request).and_return(response)
-        expect(DummyCollection.where(name: "something", aliases: "other", sort: {something: :desc}, limit: 10, offset: 1)).to eq response
+      context 'with should_rate_limit set to true' do
+        it 'will rate limit the calls so that there are not more than 200 per hour' do
+          expect(DummyCollection).to receive(:where).and_return(dummy_collection_request).exactly(3).times
+          allow(dummy_collection_request).to receive(:has_more_results?).and_return(true)
+          expect(DummyCollection).to receive(:sleep).twice
+
+          times = 0
+          DummyCollection.each_page(should_rate_limit: true) do |page|
+            times += 1
+            if times == 3
+              allow(dummy_collection_request).to receive(:has_more_results?).and_return(false)
+            end
+          end
+        end
       end
     end
   end
-
 end

data/spec/spec_helper.rb

@@ -1,10 +1,9 @@
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
-
 require 'giant_bomb_api'
 require 'rspec'
 require 'timecop'
 require 'pry-byebug'
+require 'simplecov'
+SimpleCov.start
 
 RSpec.configure do |config|
 
@@ -12,4 +11,4 @@ RSpec.configure do |config|
     Timecop.return
   end
 
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: giant_bomb_api
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Tim Adler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-19 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -122,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -148,12 +176,11 @@ files:
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- circle.yml
 - giant_bomb_api.gemspec
 - lib/giant_bomb_api.rb
 - lib/giant_bomb_api/client.rb
@@ -222,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: An unofficial ruby wrapper for the Giantbomb API (http://api.giantbomb.com).

data/Gemfile.lock

@@ -1,81 +0,0 @@
-PATH
-  remote: .
-  specs:
-    giant_bomb_api (0.1)
-      activesupport
-      faraday
-      faraday_middleware
-      require_all
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (4.2.4)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    byebug (3.5.1)
-      columnize (~> 0.8)
-      debugger-linecache (~> 1.2)
-      slop (~> 3.6)
-    codeclimate-test-reporter (0.4.5)
-      simplecov (>= 0.7.1, < 1.0.0)
-    coderay (1.1.0)
-    columnize (0.9.0)
-    debugger-linecache (1.2.0)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    faraday (0.9.1)
-      multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.10.0)
-      faraday (>= 0.7.4, < 0.10)
-    i18n (0.7.0)
-    json (1.8.3)
-    method_source (0.8.2)
-    minitest (5.8.0)
-    multi_json (1.10.1)
-    multipart-post (2.0.0)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry-byebug (3.0.1)
-      byebug (~> 3.4)
-      pry (~> 0.10)
-    rake (10.1.1)
-    require_all (1.3.2)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
-    simplecov (0.9.1)
-      docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    slop (3.6.0)
-    thread_safe (0.3.5)
-    timecop (0.7.1)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  codeclimate-test-reporter
-  giant_bomb_api!
-  pry-byebug
-  rake (~> 10.1.0)
-  rspec (~> 3.0)
-  timecop

data/circle.yml

@@ -1,6 +0,0 @@
-machine:
-  environment:
-    CODECLIMATE_REPO_TOKEN: "1fdcaf004abc7657d5aeb234af9f3da6419b07aaad7b78ea5d837bc9da2b78b9"
-  timezone: "Europe/Berlin"
-  ruby:
-    version: "2.2.2"