rubg 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7eacf7a25a81f8c8b29ea2640cd5203a2a79c1c58aa324866232d15c8b01e3b
-  data.tar.gz: dca5a0f63fb95340bc6a173d9752929e88f862d3764e95eb77df5d93f4b8a69f
+  metadata.gz: c40ff2c000d618a71fb0cba213d4fe44c3d7b9f958af6f219b3b52255590b970
+  data.tar.gz: d8b32768bb46d7e196e8dedabb25098316bf0bd0e44a9be9b46a23c5f440a3f4
 SHA512:
-  metadata.gz: ddaf0f56aef66e343780fcd2a3578d7a225f99d03bf5ee381e010e22ea0fa8a5491549a3b0f23358e0ece986d0841eb4d843f419cf9cd646ea41289103e30f25
-  data.tar.gz: 860f40ee986728f1fabc5125bf20edc3ffb3099746cd689cb755d3366556f6b5b892364c70c25b716e17c76d5b11f13837e0a8cb404e17c5bfca9afe6dbc620c
+  metadata.gz: 1cf1631cc78707beb6d8bf0c0375c39a4a737f2d06554de2ab22939bd96d6dcf4cd868d9c6f26248fe7f135b7bd703a80a77c410007bda74fd19eb7c868b05a3
+  data.tar.gz: 4ce9d3142a2d56b8c4dd49d5a683c37da1cc0fd1bf86b03832d7d9c3f8db24536b854ec434fa648a08fad49f4066abcf9c5da3140453b63f2723f8afed407bf7

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    rubg (0.2.1)
+    rubg (0.2.2)
       httparty (~> 0.16.2)
-      json
+      json (~> 2.1.0)
+      zlib (~> 1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -14,6 +15,7 @@ GEM
     minitest (5.11.3)
     multi_xml (0.6.0)
     rake (10.5.0)
+    zlib (1.0.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -2,7 +2,7 @@
 
 RUBG is an unofficial Ruby PUBG API wrapper.
 
-It is also a side project I am using to build my own Ruby skills. As such, updates may be slow and this gem may not remain up to date with API changes. Please feel free to leave enhancement requests as issues, I may use that to help prioritize. 
+RUBG attempts to be fairly comprehensive and provide abstraction from the PUBG API while remaining consistent enough that the [offical PUBG API documentation](https://documentation.playbattlegrounds.com/en/introduction.html) is still useful.
 
 
 
@@ -16,9 +16,8 @@ Development is very much in-progress. Note that breaking changes with new releas
 - The /matches endpoint is fully funtional. Match, roster, and participant data and stats are available with getter methods.
 
 #### To-do
-1. cross-object lookup convenience methods (ie. player.matches.fetch_latest or similar)
-2. gzip support
-3. Telemetry
+1. Telemetry
+2. cross-object lookup convenience methods (ie. player.matches.fetch_latest or similar)
 
 At some point in there I need to get testing coverage up to date.
 
@@ -51,6 +50,13 @@ Or install it yourself as:
 Most lookup methods take a hash as argument.
 
 
+#### Base Class
+
+```ruby
+RUBG.new        # Convenience alias for RUBG::Client.new
+RUBG.shards     # Reference for available PUBG platform/region shards
+```
+
 #### Create a Client
 First, create a client and provide your API key:
 ```ruby
@@ -59,6 +65,8 @@ client = RUBG::Client.new({:api_key =>"your-api-key-here"})
     
 The client object is used to make requests. If no key is added the gem will try and find it at ENV['PUBG_API_KEY'].
 
+All responses are gzip that is parsed to json on receipt for faster transmission. At this timne this is not configurable, but should be transparent.
+
 The response will contain either a top level object called 'errors' if unsuccessful.
 
 ```ruby
@@ -187,7 +195,7 @@ match.player_count                  # Count of players in the match.
 match.roster_count                  # Count of teams in the match.
 match.names                         # List of names for all players in the match.
 match.survived                      # Collection of RUBG::Participant objects for players alive at the end.
-match.dbnos                         # Total non-lethal knockdowns. (down but not outs)
+match.dbnos                         # Total non-lethal knockdowns. (down but not outs) Alias: .knocks
 match.assists                       # Total assists.
 match.boosts                        # Total boosts used.
 match.damage_dealt                  # Total damage dealt.
@@ -222,7 +230,7 @@ match.rosters[0].participants                  # Collection of RUBG::Participant
 
 match.rosters[0].names                         # List of names for all players on the roster.
 match.rosters[0].survived                      # Collection of RUBG::Participant objects roster members alive at the end.
-match.rosters[0].downed                        # Times roster members downed.
+match.rosters[0].dbnos                         # Total non-lethal knockdowns. (down but not outs) Alias: .knocks
 match.rosters[0].assists                       # Total assists by roster.
 match.rosters[0].boosts                        # Total boosts used by roster.
 match.rosters[0].damage_dealt                  # Total damage dealt by roster.
@@ -252,7 +260,7 @@ Retrieved from .match and available in .participants or .rosters[].participants
 match.participants[0].participant_id                # Unique participant ID
 match.participants[0].shard                         # Shard the match was played on
 
-match.participants[0].downed                        # Times participant downed.
+match.participants[0].dbnos                         # Total non-lethal knockdowns. (down but not outs) Alias: .knocks
 match.participants[0].assists                       # Total assists by participant.
 match.participants[0].boosts                        # Total boosts used by participant.
 match.participants[0].damage_dealt                  # Total damage dealt by participant.
@@ -288,11 +296,14 @@ match.participants[0].overall_ranking_gained........# Overall ranking gained.
 ## Resources
 [Offical PUBG API Documentation](https://documentation.playbattlegrounds.com/en/introduction.html)
 
+[Official PUBG API Developer Resources](https://github.com/pubg/api-assets)
+
 [Official PUBG API Discord](https://discord.gg/FcsT7t3)
 
 [Unofficial PUBG Developer Wiki](http://www.pubgwiki.org/Main_Page)
 
 
+
 ## Contributing
 
 Bug reports are welcome on GitHub at https://github.com/dor-edras/rubg. Given that I am using this as a teaching tool for myself I will not be accepting contributions for the time being - this may change in future. That said, feel free to fork the repository and update it yourself as you'd like.

data/lib/rubg/client.rb

@@ -4,7 +4,10 @@ module RUBG
   class Client
     include HTTParty
     base_uri 'https://api.playbattlegrounds.com'
-    attr_accessor :api_key, :content_type, :gzip
+    format :json
+    parser RUBG::JsonGzipParser
+    attr_reader :gzip
+    attr_accessor :api_key, :content_type
 
     def initialize( args={} )
       args          = self.class.defaults.merge(args)
@@ -54,7 +57,7 @@ module RUBG
       {
         :api_key      => ENV['PUBG_API_KEY'],
         :content_type => "application/vnd.api+json",
-        :gzip         => false
+        :gzip         => true
       }
     end
 

data/lib/rubg/json_gzip_parser.rb

@@ -0,0 +1,8 @@
+module RUBG
+  class JsonGzipParser < HTTParty::Parser
+    def json
+      resp = Zlib::GzipReader.new(StringIO.new(body)).read
+      JSON.parse(resp, :quirks_mode => true, :allow_nan => true)
+    end
+  end
+end

data/lib/rubg/match.rb

@@ -1,4 +1,4 @@
-module RUBG 
+module RUBG  
   class Match < RubgEndpoint
     attr_reader :match_id, :created, :duration, :mode, :map, :patch_version, :shard, :stats,
       :tags, :title_id, :telemetry_id, :rounds, :spectators, :link, :telemetry_link,
@@ -9,6 +9,7 @@ module RUBG
 
     attr_accessor   :rosters, :participants
     alias_method    :winner,  :winners
+    alias_method    :knocks,  :dbnos
 
     def initialize( args )
       args                  = self.class.defaults.merge(args)

data/lib/rubg/participant.rb

@@ -1,4 +1,4 @@
-module RUBG 
+module RUBG  
   class Participant
     attr_reader :participant_id, :actor, :shard, :dbnos, :assists, :boosts, :damage_dealt, 
     :death_type, :headshot_kills, :heals, :kill_place, :kill_ranking_before, :kill_ranking_gained, 
@@ -7,7 +7,7 @@ module RUBG
     :vehicle_destroys, :walk_distance, :weapons_acquired, :win_place, :win_ranking_before,  
     :win_ranking_gained, :overall_ranking_gained, :stats
 
-    alias_method :downed, :dbnos
+    alias_method :knocks, :dbnos
 
     def initialize( args )
 

data/lib/rubg/player.rb

@@ -1,6 +1,6 @@
 module RUBG 
   class Player < RubgEndpoint
-    attr_reader :player_id, :name, :created, :updated, :patch_version, :shard_id, :stats,
+    attr_reader :player_id, :name, :created, :updated, :patch_version, :shard, :stats,
       :title_id, :assets, :match_ids, :link
 
     attr_accessor :matches

data/lib/rubg/roster.rb

@@ -1,4 +1,4 @@
-module RUBG 
+module RUBG  
   class Roster
     attr_reader :roster_id, :shard, :team_id, :team, :rank, :won, :participant_ids, :size,
     :names, :survived, :dbnos, :assists, :boosts, :damage_dealt, :damage_dealt_avg, :death_types, :headshot_kills,
@@ -7,7 +7,7 @@ module RUBG
 
     attr_accessor :participants
     alias_method :player_count, :size
-    alias_method :downed, :dbnos
+    alias_method :knocks, :dbnos
 
     def initialize( args )
 

data/lib/rubg/version.rb

@@ -1,3 +1,3 @@
 module RUBG
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/rubg.rb

@@ -1,3 +1,7 @@
+require 'httparty'
+require 'zlib'
+
+require "rubg/json_gzip_parser"
 require "rubg/version"
 require "rubg/client"
 require "rubg/rubg_endpoint"
@@ -13,4 +17,29 @@ require "rubg/status"
 
 module RUBG
   $RUBG_DEFAULT_SHARD = ENV['RUBG_DEFAULT_SHARD'] || "pc-na"
+
+  def self.new(args={})
+    RUBG::Client.new(args)
+  end
+
+  # This doesn't serve a huge purpose, but is a reminder of the currently defined shards as published by Bluehole.
+  # https://developer.playbattlegrounds.com/docs/en/making-requests.html#regions
+  # Updated: 3/14/2018 @ 1:57PM EST
+  def self.shards
+    {
+      "pc-na"     => "PC - North Amaerica",
+      "pc-eu"     => "PC - Europe",
+      "pc-krjp"   => "PC - Korea/Japan",
+      "pc-oc"     => "PC - Oceania",
+      "pc-kakao"  => "PC - Kakao",
+      "pc-sea"    => "PC - South East Asia",
+      "pc-sa"     => "PC - South America",
+      "pc-as"     => "PC - Asia",
+      "xbox-na"   => "XBOX - North America",
+      "xbox-eu"   => "XBOX - Europe",
+      "xbox-as"   => "XBOX - Asia",
+      "xbox-oc"   => "XBOX - Oceania"
+    }
+  end
+
 end

data/rubg.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.0"
 
   spec.add_dependency "httparty", "~> 0.16.2"
-  spec.add_dependency "json"
+  spec.add_dependency "json", "~> 2.1.0"
+  spec.add_dependency "zlib", "~> 1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubg
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Dor
@@ -70,16 +70,30 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: zlib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 description: RUBG is a Ruby wrapper for the official PUBG API.
 email:
 - dor.edras@gmail.com
@@ -98,6 +112,7 @@ files:
 - bin/setup
 - lib/rubg.rb
 - lib/rubg/client.rb
+- lib/rubg/json_gzip_parser.rb
 - lib/rubg/match.rb
 - lib/rubg/match_collection.rb
 - lib/rubg/participant.rb