garen 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cd2b7a024fdddd9bf42b063c1afaf60358255d2
-  data.tar.gz: 3b7b8865e79831fd2620ed4aab3ad973c85cbab9
+  metadata.gz: 39fddb3f1c0addcedcbef8edd8068d27a61c1b9b
+  data.tar.gz: b1a9e540999519ed79670342ea8565650c89da36
 SHA512:
-  metadata.gz: 49566ec9385ea95fd8d0ada4a044adcb873b866fb11e98836fb01f58c1b58964a80416497ec2421d149025aa68002143efc8fe7ff9911a31701d89858d29f8a1
-  data.tar.gz: 70ef0b65cf71c2523f3cea41b9ebc0ed3719137e02105a4f2db95a64fe637ddb186041d3abe6dedcebf12674ee598044209ba28199fd0c717bb61cf3d19deb38
+  metadata.gz: af59fe401beac0b72708736c0ea8274e4d0b51d3b27beb0cb1674793b0d3f4a0c04a16ea7ac3feee528bc9a2548b46084e83bd4b7ebca54278c7613873d73e44
+  data.tar.gz: 982075cebe8de740f369b3e67063850c632a2914e4417bd9a502627a3de8e9de1c0550667ae755c93cb1f90730f8437ba1c9b32b73590638d647c4d90c26ee07

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/README.md

@@ -1,5 +1,6 @@
 [![Code Climate](https://codeclimate.com/github/b4ugh/garen/badges/gpa.svg)](https://codeclimate.com/github/b4ugh/garen)
 [![Test Coverage](https://codeclimate.com/github/b4ugh/garen/badges/coverage.svg)](https://codeclimate.com/github/b4ugh/garen/coverage)
+[![Issue Count](https://codeclimate.com/github/b4ugh/garen/badges/issue_count.svg)](https://codeclimate.com/github/b4ugh/garen)
 
 # Garen
 
@@ -23,7 +24,123 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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.
+
+```ruby
+Garen.configure do |config|
+  config.api_key = 'RGAPI-Whatever-Riot-API-Token-You-Were-Given'
+end
+```
+
+To get started, first create a Garen client
+
+```ruby
+garen = Garen::Client.new
+# If you didn't pass in your API key in a config block you would pass it in here
+garen = Garen::Client.new(api_key: 'RGAPI-Whatever-Riot-API-Token-You-Were-Given')
+# You may also pass in the service platform too - it defaults to 'na1' but feel free to change
+garen = Garen::Client.new(service_platform: 'euw1')
+# You can also pass in a debug parameter for troubleshooting issues, just pass in debug: true
+```
+
+You are now free to make API calls using the Garen::Client instance you created.  
+For example, if I wanted to retrieve summoner info for my league account 'Beasley':
+
+```ruby
+summoner_info = garen.summoner.by_name('Beasley')
+```
+
+You can also pass in optional params into the api calls.  For example, if you wanted to get a list of just the free champions this week, you could run:
+
+```ruby
+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:
+
+CHAMPION-MASTERY-V3
+
+    .champion_mastery.by_summoner_id(summoner_id)
+    .champion_mastery.by_summoner_and_champion_id(summoner_id, champion_id)
+    .champion_mastery.score_by_summoner_id(summoner_id)
+
+CHAMPION-V3
+
+    .champion.all
+    .champion.by_champion_id(champion_id)
+
+LEAGUE-V3
+
+    .league.challenger
+    .league.master
+    .league.by_summoner_id
+    .league.position_by_summoner_id
+
+LOL-STATIC-DATA-V3
+
+    .static.champions
+    .static.champions_by_id(champion_id)
+    .static.items
+    .static.items_by_id(item_id)
+    .static.language_strings
+    .static.languages
+    .static.maps
+    .static.masteries
+    .static.masteries_by_id(mastery_id)
+    .static.profile_icons
+    .static.realms
+    .static.runes
+    .static.runes_by_id(rune_id)
+    .static.summoner_spells
+    .static.summoner_spells_by_id(summoner_spell_id)
+    .static.version
+
+LOL-STATUS-V3
+
+    .status.status
+
+MASTERIES-V3
+
+    .masteries.by_summoner_id(summoner_id)
+
+MATCH-V3
+
+    .match.by_match_id(match_id)
+    .match.by_account_id(account_id)
+    .match.recent_by_account_id(account_id)
+    .match.timeline_by_match_id(match_id)
+
+RUNES-V3
+
+    .runes.by_summoner_id(summoner_id)
+
+SPECTATOR-V3
+
+    .spectator.by_summoner_id(summoner_id) - will return 404 if summoner not in a game
+    .spectator.featured_games
+
+SUMMONER-V3
+
+    .summoner.by_name(name)
+    .summoner.by_account_id(account_id)
+    .summoner.by_summoner_id(summoner_id)
+
+### Not Implemented
+
+  Tournaments endpoints.
 
 ## Development
 
@@ -33,6 +150,12 @@ After checking out the repo, you can run `rake test` to run the tests. You can a
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/b4ugh/garen.
 
+1. Fork it ( https://github.com/b4ugh/garen/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'new stuff!')
+4. Push to the branch (git push origin my-new-feature)
+5. Create a new PR (pull request)
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/garen/base.rb

@@ -1,6 +1,12 @@
 class Garen::Base
   def make_request(conn, endpoint, options)
-    request = conn.get endpoint, options
-    options[:root].present? ? request.body[options[:root]] : request.body
+    @request = conn.get endpoint, options
+    attach_rate_limits if options[:headers].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']
   end
 end

data/lib/garen/version.rb

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

metadata

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