giant_bomb_api 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96c196f26a23e4fc41d2dd883f939c8c83e062c7
-  data.tar.gz: 6b6739d5ce1ffb80772ad6c4a42643c9e8ae98ba
+  metadata.gz: 1c32f84cbf52676ea0e0d81a3b271cb5be3c46d8
+  data.tar.gz: 199c89944d3b30b14dfbc7a38378e445d308eade
 SHA512:
-  metadata.gz: 434798f04cdb4329fbee5ac8dd25de961865488a5d9a875973c009169255c56be6d69dfbc9f50abde08d7f0123bc530db6a2ade93e0bb6b3f706b022dcd9c58a
-  data.tar.gz: 53ed38aebfd37671baa86fd6791c1c1a0809e9a31df3ddb035d6c0d4d72f17d2b67da0901122cf3fb409148faf5ab82da2624084a5b44aa190fe94dc9d1757c5
+  metadata.gz: 05fc6f28698fb6e4edd5a71994d68a0ec4e0936328e3fe152065b2c7b9ec6f416702abb73d5b730d425f284168a4a64e56dbb49d5016ae7ec1486cf2dd654804
+  data.tar.gz: 98da2ac95e7c83ecd3a5608f7045c023a65dbf7baf4556ba510f495b071c5cdbd1be6c2d4ed4a79c7dc1089acdfba9b2df38d0eb084b8a713bc5f9091df9dbe8

data/README.md

@@ -1,6 +1,6 @@
 # Giant Bomb API
 
-An unofficial ruby wrapper for the [Giantbomb API](http://api.giantbomb.com). An API that provides structured data about videogames. You should inform yourself about the endpoints at http://www.giantbomb.com/api/documentation .
+An unofficial ruby wrapper for the [Giantbomb API](https://www.giantbomb.com/api/). An API that provides structured data about videogames. You should inform yourself about the endpoints at http://www.giantbomb.com/api/documentation .
 
 This gem aims to provide access to most endpoints on the API. You'll be able to **search**, **filter** and page throught most of them. See further below on what is supported. 
 
@@ -133,6 +133,7 @@ end
 - `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)
+- `rate_per_hour`: defaults to 200 (the standard Giant Bomb hourly request limit). Override this value if you want to send more requests per hour (not recommended) or less.
 
 Example using the optional arguments:
 

data/giant_bomb_api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name                      = "giant_bomb_api"
-  s.version                   = "0.5.2"
+  s.version                   = "0.5.3"
   s.default_executable        = "giantbomb"
 
   s.authors                   = ["Tim Adler"]

data/lib/giant_bomb_api/client.rb

@@ -8,7 +8,7 @@ module GiantBombApi
   class Client
     attr_accessor :api_key
 
-    API_URL = 'http://api.giantbomb.com'
+    API_URL = 'https://www.giantbomb.com/api/'.freeze
 
     def initialize(api_key: nil, options: {})
       @api_key = api_key
@@ -51,4 +51,4 @@ module GiantBombApi
     end
 
   end
-end
+end

data/lib/giant_bomb_api/collection_resource.rb

@@ -12,8 +12,8 @@ module GiantBombApi
       self.instance_variable_get("@collection_resource_name") || self.resource_name.pluralize
     end
 
-    def each_page(sort: {}, limit: 100, offset: 0, should_rate_limit: false)
-      rate_limit(should_rate_limit) do
+    def each_page(sort: {}, limit: 100, offset: 0, should_rate_limit: false, rate_per_hour: 200)
+      rate_limit(should_rate_limit, rate_per_hour) do
         response = where(sort: sort, limit: limit, offset: offset, tries: 5)
         yield response
         offset += limit
@@ -34,7 +34,7 @@ module GiantBombApi
       tries ||= (params[:tries] || 0)
 
       args = {}
-      args[:filter] = params.reject {|key,value| %i(sort limit offset).include?(key) }
+      args[:filter] = params.reject {|key,value| %i(sort limit offset tries).include?(key) }
       args[:sort] = sort if sort.present?
       args[:limit] = limit if limit.present?
       args[:offset] = offset if offset.present?
@@ -51,7 +51,7 @@ module GiantBombApi
 
     private
 
-    def rate_limit(should_rate_limit, &block)
+    def rate_limit(should_rate_limit, rate_per_hour, &block)
       started_at = Time.now
       num_of_requests = 0
 
@@ -69,9 +69,8 @@ module GiantBombApi
 
           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
-
+          remaining_requests = rate_per_hour - num_of_requests
+          min_time_per_request = remaining_requests.zero? ? time_to_one_hour : time_to_one_hour / remaining_requests
           sleep(min_time_per_request - request_time) if request_time < min_time_per_request
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: giant_bomb_api
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Tim Adler