gamelocker_api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 418b843e6557d9e7fd0b973050fa2c03b064f53a
-  data.tar.gz: b8634c8c6add7675aacb95fb210b0439e4a5d05b
+  metadata.gz: d0f07d4ead2eb25d125e496142a7b7b0c57761bb
+  data.tar.gz: eb651db6e2386a71048f92ee35d3a5ee6c905265
 SHA512:
-  metadata.gz: d7a596d17608a48881db6fdeac5e236825b49f032e985c1fad1b8d002bf834aa75463827e9f2c8ada6bbbe72f4b956181dfcb6d136a08ae8c6e31eb5b8fcf576
-  data.tar.gz: d7ef28ffd8772cdf118cbe8c9bf2d7e03cebf6fda1890424087031e62ae980cd56db39901437edf5627b4cdd6ba09b1dba17797d3ed76502ce94ca92d136e439
+  metadata.gz: ed5baee98622eb312d264499ca5393a87531182980ec4420d3ffc221555f4b864656d9306648814c30936b147fcf7f5519b018350811a10f02892e197b451a5e
+  data.tar.gz: a5441298514266ece5c5a585ba433787a267fca8f2210af0d6f249697448fd09179d87ee265216f2c69d91ea79ae4499b56e68a50b203ae752cb837e7b1a0beb

data/README.md

@@ -19,14 +19,46 @@ Or install it yourself as:
     $ gem install gamelocker_api
 
 ## Usage
-
-TODO: Write usage instructions here
+Get player(s) by In-game name
 ```ruby
   # Api Key and Region
   api = GameLockerAPI.new("API_KEY", "na")
-  response = api.players("Cyberarm")
+  response = api.players("Cyberarm") # method :players always returns an Array
+  p response.first # => GameLockerAPI::Player
+```
+Get player by UUID
+```ruby
+  response = api.player("6168b9ca-e7c8-11e6-812b-06388a2f2ea7")
   p response # => GameLockerAPI::Player
 ```
+Get matches
+```ruby
+  response = api.matches
+  p response # => [GameLockerAPI::Match, GameLockerAPI::Match]
+```
+Get matches with players that have In-game names
+```ruby
+  response = api.matches({"filter[playerNames]" => "Cyberarm"}) # Note: Will only return the last 3 hours of matches by default, see https://developer.vainglorygame.com/docs#get-a-collection-of-matches
+  p response # => [GameLockerAPI::Match, GameLockerAPI::Match]
+```
+Get a match
+```ruby
+  match = api.match("0bf53e9a-268f-11e7-9456-063bc004098b")
+  p match # => GameLockerAPI::Match
+```
+Get telemetry
+```ruby
+  response = api.telemetry(match.telemetry_url)
+  p response # => [GameLockerAPI::Telemetry::Event, GameLockerAPI::Telemetry::Event]
+```
+Check if you're being rate limited
+```ruby
+  response.headers[:x_ratelimit_remaining] # => 9
+```
+## Supports
+  * Telemetry
+  * Player(s)
+  * Match(s)
 
 ## Development
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/lib/gamelocker_api/telemetry.rb

@@ -6,11 +6,13 @@ class GameLockerAPI
       @events  = []
       response = RestClient.get(telemetry_url)
       parse(response.body)
+
+      return self
     end
 
     def parse(json)
       Oj.load(json).each do |event|
-        @events << Event.new(event['time'], event['type'], event['payload'])
+        @events << Event.new(Time.parse(event['time']), event['type'], event['payload'])
       end
     end
   end

data/lib/gamelocker_api/version.rb

@@ -1,3 +1,3 @@
 class GameLockerAPI
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/gamelocker_api.rb

@@ -37,6 +37,10 @@ class GameLockerAPI
     request("matches", match_params)
   end
 
+  def telemetry(telemetry_url)
+    Telemetry.new(telemetry_url)
+  end
+
   # def samples(samples_params = {})
   #   request("samples", samples_params)
   # end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamelocker_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Cyberarm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-20 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client