ruby-lol 0.9.9 → 0.9.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5299caf56619ad787d30d86f076a8fd100005036
-  data.tar.gz: 7201902288c4e3c4d8a6c22f0721f30b6edbf835
+  metadata.gz: 4bcac1b72dd226f3ef709a14ae8be712cd5fedcb
+  data.tar.gz: cd08d35b7dc9e8b5c1df996bb08d515dee4ad1f0
 SHA512:
-  metadata.gz: 7bdcb6a21e9c493969974df3ebac981e839a89fbe864d5ed60572a74eedfe5fad0e2007c787f6f7e73126162090283b95c67c411fbc24efb5ca05fa6a64bf13e
-  data.tar.gz: 24edf369c35e6a4732f95575d7b51a5acb740c67b8392e102d8a83fdb72933488b91b42acc40ed29561d77e2f97a303c62c64668d828c6923084c6e80b780025
+  metadata.gz: 636209f1b3f0e8aa9f9e14321296245b56ba7cec490b42ab729a23bb3a608d63c0da62784e28fbf6e2e051be0e1f213f95b9ac69a9e4db63f62a049ede78d978
+  data.tar.gz: 40cb048f2ab8c666badc91cd6a8c9d2f0a83c7d888d75cf4de99f16b9f920c3644758b0d34bab180049df93ffa70807f767fccc6107994b11efd84f638c529a9

data/README.md

@@ -77,6 +77,39 @@ client.team.get(summoner_id)
 # => Array
 ```
 
+# Making Static Requests
+The Riot API has a [section](http://developer.riotgames.com/api/methods#!/378) carved out for static-data. These requests don't count against your rate limit. The mechanism for using them is similar to the standard requests above.
+
+Each static endpoint has two possible requests: `get` and `get(id)`. `get` returns an array of OpenStructs representing the data from Riot's API, and `get(id)` returns an OpenStruct with a single record. Here are some examples:
+
+```ruby
+client.static
+# => Lol::StaticRequest
+**NOTE**: StaticRequest is not meant to be used directly, but can be!
+
+client.static.champion
+# => Lol::StaticRequest (for endpoint /static-data/champion)
+
+client.static.champion.get
+# => [OpenStruct] (with keys from http://developer.riotgames.com/api/methods#!/378/1349)
+
+client.static.champion.get(id)
+# => OpenStruct (with keys from http://developer.riotgames.com/api/methods#!/378/1349)
+```
+
+You can also pass query parameters as listed in the Riot API documentation. For example:
+
+```ruby
+
+# returns all attributes
+client.static.champion.get(champData: 'all')
+
+# returns only lore information
+client.static.champion.get(champData: 'lore')
+```
+
+**NOTE**: The realm endpoint is not implemented. Let us know if you need it, but it seemed somewhat unnecessary.
+
 ## Contributing
 
 1. Fork it

data/lib/lol/client.rb

@@ -39,6 +39,11 @@ module Lol
       @summoner_request ||= SummonerRequest.new(api_key, region)
     end
 
+    # @return [StaticRequest]
+    def static
+      @static_request ||= StaticRequest.new(api_key, region)
+    end
+
     # Initializes a Lol::Client
     # @param api_key [String]
     # @param options [Hash]

data/lib/lol/league_request.rb

@@ -6,7 +6,7 @@ module Lol
       "v2.3"
     end
 
-    # Retrieves leagues data for summoner, including leagues for all of summoner's teams, v2.1
+    # Retrieves leagues data for summoner, including leagues for all of summoner's teams
     # @param [String]
     # @return [Array]
     def get summoner_id

data/lib/lol/request.rb

@@ -27,9 +27,8 @@ module Lol
     # @param path [String] API path to call
     # @return [String] full fledged url
     def api_url path, params = {}
-      lol = self.class.api_version == "v2.1" ? "" : "lol"
       query_string = URI.encode_www_form params.merge api_key: api_key
-      File.join "http://prod.api.pvp.net/api/", lol, "/#{region}/#{self.class.api_version}/", "#{path}?#{query_string}"
+      File.join "http://prod.api.pvp.net/api/lol/#{region}/#{self.class.api_version}/", "#{path}?#{query_string}"
     end
 
     # Calls the API via HTTParty and handles errors

data/lib/lol/static_request.rb

@@ -0,0 +1,66 @@
+module Lol
+  class StaticRequest < Request
+    STANDARD_ENDPOINTS = %w(champion item mastery rune summoner_spell)
+
+    def self.api_version
+      "v1"
+    end
+
+    # Returns a full url for an API call
+    # Overrides api_url from Request
+    # @param path [String] API path to call
+    # @return [String] full fledged url
+    def api_url path, params = {}
+      query_string = URI.encode_www_form params.merge api_key: api_key
+      File.join "http://prod.api.pvp.net/api/lol/static-data/#{region}/#{self.class.api_version}/", "#{path}?#{query_string}"
+    end
+
+    STANDARD_ENDPOINTS.each do |endpoint|
+      define_method(endpoint) { Proxy.new self, endpoint }
+    end
+    def realm
+      Proxy.new self, 'realm'
+    end
+
+    def get(endpoint, id=nil, params={})
+      id ? find(endpoint, id, params) : all(endpoint, params)
+    end
+
+    private
+
+    def find(endpoint, id, params={})
+      model_class(endpoint).new \
+        perform_request(api_url("#{endpoint.dasherize}/#{id}", params)).to_hash
+    end
+
+    def all(endpoint, params={})
+      if endpoint == "realm"
+        model_class(endpoint).new perform_request(api_url(endpoint.dasherize, params)).to_hash
+      else
+        perform_request(api_url(endpoint.dasherize, params))["data"].map do |id, values|
+          model_class(endpoint).new(values.merge(id: id))
+        end
+      end
+    end
+
+    def model_class(endpoint)
+      OpenStruct
+    end
+
+    class Proxy
+      def initialize(request, endpoint)
+        @request = request
+        @endpoint = endpoint
+      end
+
+      def get(id=nil, params={})
+        if id.is_a?(Hash)
+          params = id
+          id = nil
+        end
+
+        @request.get @endpoint, id, params
+      end
+    end
+  end
+end

data/lib/lol/version.rb

@@ -1,3 +1,3 @@
 module Lol
-  VERSION = "0.9.9"
+  VERSION = "0.9.10"
 end