ruby-lol 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7473a66c2ba969476e7a30e8fe148e4c974dc70b
-  data.tar.gz: c50df90099feec488dca9afd5c17ba85624ca915
+  metadata.gz: f57d825feb79e42f3ebd252a9925ff247c6fd13d
+  data.tar.gz: 58acfbbf4839d94e1bfeaccb4161f0ddd9df2016
 SHA512:
-  metadata.gz: a7efd709d007876b0c9e8972cc4b8af6d91c0956a4c1c695f2c5ae69c8652097539526d3bd3c33bfd4c5ea00046b2139981cd3bc0a3f9b90922ac8ca9dd2e996
-  data.tar.gz: 5d27adae5e92111f5ec95bcc74a1b7f44f176509576773c3ee8cf59e0953c10acfaf291c93ac58ef575c5952f1e4eb80d594697135647f2e2a4aa2c0dd02f812
+  metadata.gz: a693d189f419894e304e744b9ddafcddf9dedee2dd5adf35daa4047621d113520b17f018aa4fcb7890f80625ce64270a89995b3ef5c66c40964fe20b82b2804a
+  data.tar.gz: b7a9734744ba482d66ae9e7c4e1b78e1fc722f1c18a307cede2563267436a5520b8241b1f0c60b52f7b44ec42b126d078b1af7a5d73ca7ef867182655a579a5a

data/Guardfile

@@ -1,7 +1,7 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard :rspec do
+guard :rspec, cmd: "bundle exec rspec" do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
@@ -21,4 +21,3 @@ guard :rspec do
   watch(%r{^spec/acceptance/(.+)\.feature$})
   watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
 end
-

data/README.md

@@ -27,12 +27,15 @@ Or install it yourself as:
 ```ruby
 require 'lol'
 
-client = Lol::Client.new "my_api_key", {region: "euw"}
+client = Lol::Client.new "my_api_key", region: "euw"
 # => <Lol::Client:0x000000020c0b28 @api_key="my_api_key", @region="euw", @cached=false>
 
-# NEW! You can cache requests using Redis now
+# You can cache requests using Redis now
 # ttl defaults to 900
-client = Lol::Client.new "my_api_key", {region: "euw", redis: "redis://localhost:6379", ttl: 900}
+client = Lol::Client.new "my_api_key", region: "euw", redis: "redis://localhost:6379", ttl: 900
+
+# You can specify your rate limits so that the library will throttle requests to avoid errors
+client = Lol::Client.new "new_api_key", region: "euw", rate_limit_requests: 1, rate_limit_seconds: 10
 
 # Available Requests
 client.champion

data/lib/lol.rb

@@ -2,6 +2,7 @@ require 'active_support/core_ext/string/inflections'
 require 'httparty'
 require 'uri'
 require 'redis'
+require 'glutton_ratelimit'
 
 module Lol
   # Takes a hash and returns a copy of it with the keys that have been underscored

data/lib/lol/client.rb

@@ -13,69 +13,73 @@ module Lol
     # @return [Integer] the ttl on cached requests
     attr_reader :ttl
 
+    # @!attribute[r] rate_limiter
+    # @return [Object] the rate limiter, if one exists (else nil)
+    attr_reader :rate_limiter
+
     # @return [ChampionRequest]
     def champion
-      @champion_request ||= ChampionRequest.new(api_key, region, cache_store)
+      @champion_request ||= ChampionRequest.new(api_key, region, cache_store, rate_limiter)
     end
 
     # @return [ChampionMasteryRequest]
     def champion_mastery
-      @champion_mastery_request ||= ChampionMasteryRequest.new(api_key, region, cache_store)
+      @champion_mastery_request ||= ChampionMasteryRequest.new(api_key, region, cache_store, rate_limiter)
     end
 
     # @return [MatchRequest]
     def match
-      @match_request ||= MatchRequest.new(api_key, region, cache_store)
+      @match_request ||= MatchRequest.new(api_key, region, cache_store, rate_limiter)
     end
 
     # @return [LeagueRequest]
     def league
-      @league_request ||= LeagueRequest.new(api_key, region, cache_store)
+      @league_request ||= LeagueRequest.new(api_key, region, cache_store, rate_limiter)
     end
 
     # @return [RunesRequest]
     def runes
-      @runes_request ||= RunesRequest.new(api_key, region, cache_store)
+      @runes_request ||= RunesRequest.new(api_key, region, cache_store, rate_limiter)
     end
 
     # @return [MasteriesRequest]
     def masteries
-      @masteries_request ||= MasteriesRequest.new(api_key, region, cache_store)
+      @masteries_request ||= MasteriesRequest.new(api_key, region, cache_store, rate_limiter)
     end
 
     # @return [SpectatorRequest]
     def spectator
-      @spectator_request ||= SpectatorRequest.new(api_key, region, cache_store)
+      @spectator_request ||= SpectatorRequest.new(api_key, region, cache_store, rate_limiter)
     end
 
     # @return [SummonerRequest]
     def summoner
-      @summoner_request ||= SummonerRequest.new(api_key, region, cache_store)
+      @summoner_request ||= SummonerRequest.new(api_key, region, cache_store, rate_limiter)
     end
 
     # @return [StaticRequest]
     def static
-      @static_request ||= StaticRequest.new(api_key, region, cache_store)
+      @static_request ||= StaticRequest.new(api_key, region, cache_store, rate_limiter)
     end
 
     # @return [LolStatusRequest]
     def lol_status
-      @lol_status ||= LolStatusRequest.new(api_key, region, cache_store)
+      @lol_status ||= LolStatusRequest.new(api_key, region, cache_store, rate_limiter)
     end
 
     # @return [CurrentGameRequest]
     def current_game
-      @current_game ||= CurrentGameRequest.new(api_key, region, cache_store)
+      @current_game ||= CurrentGameRequest.new(api_key, region, cache_store, rate_limiter)
     end
 
     # @return [FeaturedGamesRequest]
     def featured_games
-      @featured_games ||= FeaturedGamesRequest.new(api_key, region, cache_store)
+      @featured_games ||= FeaturedGamesRequest.new(api_key, region, cache_store, rate_limiter)
     end
 
     # @return [TournamentProviderRequest]
     def tournament
-      @tournament ||= TournamentRequest.new(api_key, region, cache_store)
+      @tournament ||= TournamentRequest.new(api_key, region, cache_store, rate_limiter)
     end
 
     # Initializes a Lol::Client
@@ -84,11 +88,14 @@ module Lol
     # @option options [String] :region ("EUW") The region on which the requests will be made
     # @option options [String] :redis the redis url to use for caching
     # @option options [Integer] :ttl (900) the cache ttl
+    # @option options [Fixnum] :rate_limit_requests number of requests
+    # @option options [Fixnum] :rate_limit_seconds number of seconds to limit the rate in
     # @return [Lol::Client]
     def initialize api_key, options = {}
       @api_key = api_key
       @region = options.delete(:region) || "euw"
       set_up_cache(options.delete(:redis), options.delete(:ttl))
+      set_up_rate_limiter(options.delete(:rate_limit_requests), options.delete(:rate_limit_seconds))
     end
 
     def set_up_cache(redis_url, ttl)
@@ -99,6 +106,13 @@ module Lol
       @redis = Redis.new :url => redis_url
     end
 
+    def set_up_rate_limiter(number_of_requests, number_of_seconds)
+      return @rate_limited = false unless number_of_requests
+
+      @rate_limited = true
+      @rate_limiter = GluttonRatelimit::AveragedThrottle.new number_of_requests, number_of_seconds
+    end
+
     # Returns an options hash with cache keys
     # @return [Hash]
     def cache_store
@@ -109,6 +123,11 @@ module Lol
       }
     end
 
+    # @return [Boolean] true if requests are automatically rate limited
+    def rate_limited?
+      @rate_limiter
+    end
+
     # @return [Boolean] true if requests are cached
     def cached?
       @cached

data/lib/lol/match_request.rb

@@ -10,13 +10,11 @@ module Lol
 
     # Get match by match ID.
     # @param [Integer] match_id Match ID
-    # @param [String] tournament_code Optional tournament code the match belongs to
+    # @option options [Integer] forAccountId Optional used to identify the participant to be unobfuscated
+    # @option options [Integer] forPlatformId Optional used to identify the participant to be unobfuscated (for when user have changed regions)
     # @return [DynamicModel] Match representation
-    def find match_id, tournament_code: nil
-      url = "matches/#{match_id}".tap do |u|
-        u << "/by-tournament-code/#{tournament_code}" if tournament_code
-      end
-      DynamicModel.new perform_request api_url url
+    def find options={}, match_id:
+      DynamicModel.new perform_request api_url "matches/#{match_id}", options
     end
 
     # Get match timeline by match ID.
@@ -33,6 +31,14 @@ module Lol
       perform_request api_url "matches/by-tournament-code/#{tournament_code}/ids"
     end
 
+    # Get match by match ID and tournament code.
+    # @param [Integer] match_id Match ID
+    # @param [String] tournament_code Tournament code the match belongs to
+    # @return [DynamicModel] Match representation
+    def find_by_tournament match_id, tournament_code
+      DynamicModel.new perform_request api_url "matches/#{match_id}/by-tournament-code/#{tournament_code}"
+    end
+
     # Get matchlist for ranked games played on given account ID and platform ID and filtered using given filter parameters, if any.
     # @param [Integer] account_id Account ID
     # @param [Hash] options the options to pass to the call

data/lib/lol/request.rb

@@ -24,6 +24,10 @@ module Lol
     # @return [Object] the cache_store
     attr_reader :cache_store
 
+    # @!attribute[r] rate_limiter
+    # @return [Object] the rate limiter, if one exists (else nil)
+    attr_reader :rate_limiter
+
     # Returns the supported API Version.
     # @return [String] v3
     def self.api_version
@@ -54,15 +58,16 @@ module Lol
     # @option cache_store [Boolean] :cached should the request be cached
     # @option cacche_store [Integer] :ttl ttl for cache keys
     # @return [Request]
-    def initialize api_key, region, cache_store = {}
-      @cache_store = cache_store
+    def initialize api_key, region, cache_store = {}, rate_limiter = nil
+      @cache_store  = cache_store
+      @rate_limiter = rate_limiter
       raise InvalidCacheStore if cached? && !store.is_a?(Redis)
       @api_key = api_key
-      @region = region
+      @region  = region
     end
 
     def platform
-      self.class.platforms[region.to_sym]
+      self.class.platforms[region.downcase.to_sym]
     end
 
     # Returns the supported API Version.
@@ -103,7 +108,8 @@ module Lol
       uri.to_s
     end
 
-    # Calls the API via HTTParty and handles errors
+    # Calls the API via HTTParty and handles errors caching it if a cache is
+    # enabled and rate limiting it if a rate limiter is configured
     # @param url [String] the url to call
     # @param verb [Symbol] HTTP verb to use. Defaults to :get
     # @param body [Hash] Body for POST request
@@ -115,11 +121,18 @@ module Lol
       if can_cache && result = store.get("#{clean_url(url)}#{options_id}")
         return JSON.parse(result)
       end
-      response = perform_uncached_request url, verb, body, options
+      response = perform_rate_limited_request(url, verb, body, options)
       store.setex "#{clean_url(url)}#{options_id}", ttl, response.to_json if can_cache
       response
     end
 
+    def perform_rate_limited_request url, verb = :get, body = nil, options = {}
+      return perform_uncached_request(url, verb, body, options) unless rate_limiter
+      @rate_limiter.times 1 do
+        perform_uncached_request(url, verb, body, options)
+      end
+    end
+
     def perform_uncached_request url, verb = :get, body = nil, options = {}
       options[:headers] ||= {}
       options[:headers].merge!({

data/lib/lol/tournament_request.rb

@@ -7,7 +7,7 @@ module Lol
 
     # @!visibility private
     def api_base_url
-      "https://global.api.riotgames.com"
+      "https://americas.api.riotgames.com"
     end
 
     # Creates a tournament provider and returns its ID.
@@ -26,10 +26,9 @@ module Lol
     # @param [String] name Name of the tournament
     # @return [Integer] Tournament ID
     def create_tournament provider_id:, name: nil
-      body = {
-        "providerId" => provider_id,
-        "name"       => name
-      }.compact
+      body = { "providerId" => provider_id, "name" => name }.delete_if do |k, v|
+         v.nil?
+      end
       perform_request api_url("tournaments"), :post, body
     end
 

data/lib/lol/version.rb

@@ -1,3 +1,3 @@
 module Lol
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

data/ruby-lol.gemspec

@@ -35,4 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "httparty", "0.14.0" # due to https://github.com/jnunemaker/httparty/issues/533
   spec.add_runtime_dependency "activesupport"
   spec.add_runtime_dependency "redis"
+  spec.add_runtime_dependency "glutton_ratelimit"
 end

data/spec/lol/client_spec.rb

@@ -45,6 +45,23 @@ describe Client do
         expect(champion_request.cache_store).to eq(real_redis.cache_store)
       end
     end
+
+    context "rate_limiting" do
+      let(:client) { Client.new "foo", rate_limit_requests: 10 }
+
+      it "sets rate limiting if specified in the options" do
+        expect(client.rate_limited?).to be_truthy
+      end
+
+      it "instantiates a rate limiter if it is in the options" do
+        expect(client.rate_limiter).not_to be_nil
+      end
+
+      it "passes the rate limiter to the request" do
+        champion_request = client.champion
+        expect(champion_request.rate_limiter).to eq(client.rate_limiter)
+      end
+    end
   end
 
   describe "#cached?" do
@@ -65,7 +82,7 @@ describe Client do
     end
 
     it "initializes the ChampionRequest with the current API key and region" do
-      expect(ChampionRequest).to receive(:new).with(subject.api_key, subject.region, subject.cache_store)
+      expect(ChampionRequest).to receive(:new).with(subject.api_key, subject.region, subject.cache_store, subject.rate_limiter)
 
       subject.champion
     end
@@ -77,7 +94,7 @@ describe Client do
     end
 
     it "initializes the MatchRequest with the current API key and region" do
-      expect(MatchRequest).to receive(:new).with(subject.api_key, subject.region, subject.cache_store)
+      expect(MatchRequest).to receive(:new).with(subject.api_key, subject.region, subject.cache_store, subject.rate_limiter)
 
       subject.match
     end
@@ -89,7 +106,7 @@ describe Client do
     end
 
     it "initializes the RunesRequest with the current API key and region" do
-      expect(RunesRequest).to receive(:new).with(subject.api_key, subject.region, subject.cache_store)
+      expect(RunesRequest).to receive(:new).with(subject.api_key, subject.region, subject.cache_store, subject.rate_limiter)
 
       subject.runes
     end
@@ -101,7 +118,7 @@ describe Client do
     end
 
     it "initializes the MasteriesRequest with the current API key and region" do
-      expect(MasteriesRequest).to receive(:new).with(subject.api_key, subject.region, subject.cache_store)
+      expect(MasteriesRequest).to receive(:new).with(subject.api_key, subject.region, subject.cache_store, subject.rate_limiter)
 
       subject.masteries
     end
@@ -113,7 +130,7 @@ describe Client do
     end
 
     it "initializes the LeagueRequest with the current API key and region" do
-      expect(LeagueRequest).to receive(:new).with(subject.api_key, subject.region, subject.cache_store)
+      expect(LeagueRequest).to receive(:new).with(subject.api_key, subject.region, subject.cache_store, subject.rate_limiter)
 
       subject.league
     end
@@ -125,7 +142,7 @@ describe Client do
     end
 
     it "initializes the SummonerRequest with the current API key and region" do
-      expect(SummonerRequest).to receive(:new).with(subject.api_key, subject.region, subject.cache_store)
+      expect(SummonerRequest).to receive(:new).with(subject.api_key, subject.region, subject.cache_store, subject.rate_limiter)
 
       subject.summoner
     end
@@ -137,7 +154,7 @@ describe Client do
     end
 
     it "initializes the StaticRequest with the current API key and region" do
-      expect(StaticRequest).to receive(:new).with(subject.api_key, subject.region, subject.cache_store)
+      expect(StaticRequest).to receive(:new).with(subject.api_key, subject.region, subject.cache_store, subject.rate_limiter)
 
       subject.static
     end

data/spec/lol/match_request_spec.rb

@@ -11,22 +11,9 @@ describe MatchRequest do
   end
 
   describe "#find" do
-    context "without a tournament code" do
-      let(:result) { subject.find 1 }
-      before { stub_request subject, 'match', "matches/1" }
-
-      it "returns a DynamicModel" do
-        expect(result).to be_a DynamicModel
-      end
-    end
-
-    context "with a tournament code" do
-      let(:result) { subject.find 1, tournament_code: 2 }
-      before { stub_request subject, 'match-with-tc', "matches/1/by-tournament-code/2" }
-
-      it "returns a DynamicModel" do
-        expect(result).to be_a DynamicModel
-      end
+    it "returns a DynamicModel" do
+      stub_request subject, 'match', "matches/1"
+      expect(subject.find match_id: 1).to be_a DynamicModel
     end
   end
 
@@ -42,7 +29,14 @@ describe MatchRequest do
       stub_request subject, 'ids-by-tc', "matches/by-tournament-code/1/ids"
       result = subject.ids_by_tournament_code '1'
       expect(result).to be_a Array
-      expect(result.map(&:class).uniq).to eq [Integer]
+      expect(result.map(&:class).uniq).to eq [Fixnum]
+    end
+  end
+
+  describe "#find_by_tournament" do
+    it "returns a DynamicModel" do
+      stub_request subject, 'match-with-tc', "matches/1/by-tournament-code/2"
+      expect(subject.find_by_tournament 1, 2).to be_a DynamicModel
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lol
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Giovanni Intini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-24 00:00:00.000000000 Z
+date: 2017-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -240,6 +240,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: glutton_ratelimit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby wrapper to Riot Games API. Maps results to full blown ruby objects.
 email:
 - giovanni@mikamai.com