garen 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39fddb3f1c0addcedcbef8edd8068d27a61c1b9b
-  data.tar.gz: b1a9e540999519ed79670342ea8565650c89da36
+  metadata.gz: f59a6c5d0369a061e432e64a881c953565f8f067
+  data.tar.gz: 99219811f49f116d5c3fbc48f5a1ed57b658a903
 SHA512:
-  metadata.gz: af59fe401beac0b72708736c0ea8274e4d0b51d3b27beb0cb1674793b0d3f4a0c04a16ea7ac3feee528bc9a2548b46084e83bd4b7ebca54278c7613873d73e44
-  data.tar.gz: 982075cebe8de740f369b3e67063850c632a2914e4417bd9a502627a3de8e9de1c0550667ae755c93cb1f90730f8437ba1c9b32b73590638d647c4d90c26ee07
+  metadata.gz: 25e0a3874864c4451b042eec3768348abc92ee3fbf403b983da868dbffe405ca2ecda6208cc2014f8d6f563b5b7d193ac925ef13b00b9fc486a6516478353abe
+  data.tar.gz: 6cbc7a7434df88c950e12feee97fcc25b6d96ecd912a6aeae4647a4bf9557810f570fc60bb3847b780bc6e198240b29945dde6459cf7aa95917374340bac07af

data/README.md

@@ -24,6 +24,26 @@ Or install it yourself as:
 
 ## Usage
 
+# Latest Updates
+
+I have updated the way that rate limits are returned in the response.  If you pass in the parameter 'return_rate_limits' and set it to true, it will return both the app and method limit counts.  The response back from your API call will include a response hash of the api response from riot, and a rate_limit hash with the app and method counts included in.
+
+See below:
+
+```ruby
+summoner = garen.summoner.by_name('Beasley', return_rate_limits: true)
+# returns
+"#<Hashie::Mash rate_limit=#<Hashie::Mash app_count=\"3:120,3:1\" method_count=\"1:10,1:600\"> response=#<Hashie::Rash account_id=36072798 id=22332661 name=\"Beasley\" profile_icon_id=20
+95 revision_date=1503543762000 summoner_level=30>>"
+# so you could call for example:
+summoner.response.name
+# this will give you 'Beasley' from the example above.
+summoner.rate_limit.app_count
+# this will give you '3:120,3:1' from the example above.
+```
+
+# How to Use:
+
 You can begin by adding a config block to your application to set your Riot API-Key, instead of having to pass it through every call as a parameter.
 However, if you'd rather pass it through as a parameter each time, that is also fine.
 
@@ -59,14 +79,6 @@ f2p_champs = garen.champion.all(freeToPlay: true)
 
 Just look at the documentation on Riot's API - https://developer.riotgames.com/api-methods/ - for all the different query arguments you can pass in.
 
-In addition, if you pass in the parameter 'headers' and set it to true, it will return both the app and method limit counts as party of the response body.
-
-```ruby
-summoner = garen.summoner.by_name('Beasley', headers: true)
-# returns
-<Hashie::Rash ... app_count="1:120,1:1" method_count="1:10,1:600" ...>
-```
-
 ## Endpoints
 
 The endpoints currently supported and their corresponding methods are:

data/lib/garen/base.rb

@@ -1,12 +1,16 @@
 class Garen::Base
   def make_request(conn, endpoint, options)
     @request = conn.get endpoint, options
-    attach_rate_limits if options[:headers].present?
+    return attach_rate_limits if options[:return_rate_limits].present?
     @request.body
   end
 
   def attach_rate_limits
-    @request.body['app_count'] = @request.headers['x-app-rate-limit-count']
-    @request.body['method_count'] = @request.headers['x-method-rate-limit-count']
+    body = {}
+    body[:response] = @request.body
+    body[:rate_limit] = {}
+    body[:rate_limit][:app_count] = @request.headers['x-app-rate-limit-count'].to_s
+    body[:rate_limit][:method_count] = @request.headers['x-method-rate-limit-count'].to_s
+    Hashie::Mash.new body
   end
 end

data/lib/garen/version.rb

@@ -1,3 +1,3 @@
 module Garen
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: garen
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Daniel Baugh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-03 00:00:00.000000000 Z
+date: 2017-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport