rubg 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f4594ad2750bbc41e12d65aa2d1ec87313b71d601943b873d62db470cb6ca22
-  data.tar.gz: de64980fede3b8c830f9cfb3bcbe33f8cedf10818878cd63fd861c661891759e
+  metadata.gz: 30c5fa847dde8f815c0bc0e5acef0586886a7eec299c6dd75f04b60878553616
+  data.tar.gz: 9228f84e1d438a246eb680057ef98646f4e31a3a8988c71fd2ffe9aad715ac2b
 SHA512:
-  metadata.gz: 007f7825e3a4371be7d9b23fa98c5212d3c97a80dc0a648e81b4d8057d27ce20d66c672017d9006937b071987b2884f8f8724cf41c5b80e69a77b13366960317
-  data.tar.gz: fdcf55449a44f0ec321b40ff9274f42ebbcfc769770568da6827dca05a9dbd0d98ce0044f4f860b72cb8ad1f5696b799b07f34fc30140135ac3b7186f35fab52
+  metadata.gz: de0897838c786655f77303ea177870f652423ce5c3ff24ca22becd74affe3de512f1cffc3aad28e9260d55b997de1a333b920274b3a75e2b1084a791b34ced4e
+  data.tar.gz: d0315f45b876e5a6aa5ebca73fc7ed130b55dc3d7b30a2ead9294f9404015afa88e7e1b697f2e62b20b0a0ae00ff7ea491867457731b4e359c5d428fa4643115

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubg (0.1.2)
+    rubg (0.1.3)
       httparty (~> 0.16.2)
       json
 

data/README.md

@@ -1,8 +1,24 @@
 # RUBG
 
-RUBG is an unofficial Ruby pUBG API wrapper.
+RUBG is an unofficial Ruby PUBG API wrapper.
 
-It is also a project I am using to build my own development skills. As such, it is likely this gem will not remain up to date with API changes, and updates will be slow. Given that I am using this as a teaching tool for myself I will not be accepting contributions. That said, feel free to use the gem as-is in your own application if it is useful, or to fork the repository and update it yourself as you'd like.
+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. 
+
+## Status
+
+Development is very much in-progress.
+
+#### Working:
+- The /status endpoint is fully functional.
+- The /players endpoint is partially functional. Queries may be performed, but the response is raw JSON only.
+
+#### To-do
+1. Finish /players endpoint, converting players to Player objects and matches to Match objects in response
+2. Add /player endpoint to retrieve a single player
+3. Add /matches endpoint to retrieve a single match, including objects for Rosters, etc.
+4. Telemetry
+
+At some point in there I need to get testing coverage up to date.
 
 ## Installation
 
@@ -22,40 +38,53 @@ Or install it yourself as:
 
 ## Usage
 
+#### Create a Client
 First, create a client and provide your API key:
 ```ruby
 client = RUBG::Client.new("your-api-key-here")
 ```
     
-If no key is added the gem will try and find it at ENV['PUBG_API_KEY'].
+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'].
+
+#### /status Endpoint
 
 Check the PUBG API status and version:
 
 ```ruby
-client.status.alive? 
-client.status.version
-client.status.released_at
+client.status.alive?         # true/false
+client.status.version        # "v8.1.2"
+client.status.released_at    # "2018-04-01T18:00:20Z"
 ```
 
+#### /players Endpoint
+/players is currently only partially functional. Queries may be performed, but the response is JSON only. You can obtain match IDs to look up manually, however, until I implement /matches.
+
+.players requires an 'options' argument, which should be a hash containing:
 
-Only the players endpoint is functional at present, and it is only partially functional:
+- "shard" - Specify the [shard](https://documentation.playbattlegrounds.com/en/making-requests.html#regions) to retreieve data from. If none is specified, "pc-na" will be used as default.
+- "playerNames" - Comma-separated list of players to search for. Names are case-sensitive.
+- "playerIds" - Comma-separated list of player IDs to search for.
+
+Note: If neither playerIds nor playerNames are included in options no results will be returned - at least one name or Id must be present.
 
 ```ruby
-options = {"shard" => "pc-na", "playerNames" => "Shroud"}
-client.players(options)
+options = {"shard" => "pc-na", "playerNames" => "Shroud,JoshOG,PlayerUnknown"}
+players = client.players(options)
 ```
 
-options variable should be a hash of:
-- "shard" - Specify the shard to retreieve data from. If none is specified pc-na will be used.
-- "playerNames" - Comma-separated list of players to search for, case-sensitive
-- "playerIds" - Comma-separated list of player IDs to search for.
+The response will contain a top level object called 'errors' or 'data' depending on if the query failed or succeeded.
 
-Note that if neither playerIds or playerNames are included no results will be returned.
+```ruby
+players.errors .    # [{"title"=>"Not Found", "detail"=>"No players found matching criteria"}]
+```
 
+```ruby
+players.data        # Returns retrieved player data.
+```
 
 ## Contributing
 
-Bug reports are welcome on GitHub at https://github.com/dor-edras/rubg. As mentioned above, I am not accepting contributions to this project but you are welcome to fork it!
+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.
 
 ## License
 

data/lib/rubg.rb

@@ -1,8 +1,10 @@
 require "rubg/version"
 require "rubg/client"
+require "rubg/rubg_endpoint"
 require "rubg/players"
 require "rubg/status"
 
-module RUBG
 
+module RUBG
+  $RUBG_DEFAULT_SHARD = ENV['RUBG_DEFAULT_SHARD'] || "pc-na"
 end

data/lib/rubg/client.rb

@@ -4,25 +4,43 @@ module RUBG
   class Client
     include HTTParty
     base_uri 'https://api.playbattlegrounds.com'
-    attr_accessor :api_key, :content_type
-    
-    def initialize(api_key = ENV['PUBG_API_KEY'])
+    attr_accessor :api_key, :content_type, :gzip
+
+    def initialize(api_key=ENV['PUBG_API_KEY'],gzip=false)
       @api_key = api_key
       @content_type = "application/vnd.api+json"
+      @gzip = gzip
     end
 
+
     def status
-      RUBG::Status.new(self)
+      RUBG::Status.fetch(self)
+    end
+
+
+    def players(shard=$RUBG_DEFAULT_SHARD,query_options={})
+      RUBG::Players.fetch(self, shard, query_options)
     end
 
+  
+    def player
+    
+    end
+
+
+    def matches
 
-    # options variable is a hash of:
-    # "shard" - Specify the shard to retreieve data from. If none is specified pc-na will be used.
-    # "playerNames" - Comma-separated list of players to search for, case-sensitive
-    # "playerIds" - Comma-separated list of player IDs to search for.
-    # Note that if neither playerIds or playerNames is included no results will be returned.
-    def players(options)
-      RUBG::Players.new(self, options)
     end
+
+
+    def match
+
+    end
+
+
+    def telemetry
+
+    end
+
   end
 end

data/lib/rubg/players.rb

@@ -1,57 +1,20 @@
 module RUBG 
-  class Players
-    attr_reader :errors, :data, :raw_response, :uri, :headers, :query
+  class Players < RubgEndpoint
 
-
-    def initialize(client, options)
-      players = players_endpoint(client, options)
-
-      @errors       = players["errors"]
-      @data         = players["data"]
-      @raw_response = players
+    def initialize(client,response)
+      super
     end
 
 
-    private
-      def players_endpoint(client, options)
-        @uri    = assemble_uri(options)
-        @headers = assemble_headers(client)
-        if options["playerIds"] || options["playerNames"]
-          @query   = assemble_query(client,options)
-        else
-          @query = ""
-        end
-
-        response = client.class.get(@uri,{headers: @headers,
-                                        query:    @query})
-
-        return response.parsed_response
-      end
-
+    def self.fetch(client,shard,query_options)
+      endpoint = "players"
+      query_options["filter[playerNames]"] = query_options.delete("playerNames")
+      query_options["filter[playerIds]"] = query_options.delete("playerIds")
+      super(client,endpoint,shard,query_options)
 
-      def assemble_uri(options)
-        shard = options["shard"] || "pc-na"
-        uri = "/shards/#{shard}/players"
-
-        return uri
-      end
-
-      def assemble_headers(client)
-        headers = {
-                  "Authorization"   => client.api_key, 
-                  "Accept"          => client.content_type
-                }
-
-        return headers
-      end
+      RUBG::Players.new(client,@response)
+    end
 
-      def assemble_query(client, options)
-        query = {}
-        query["filter[playerIds]"] = options["playerIds"].delete(' ') if options["playerIds"]
-        query["filter[playerNames]"] = options["playerNames"].delete(' ') if options["playerNames"]
-        query["page[limit]"] = 1
-        return query
-      end
   end
 end
 

data/lib/rubg/rubg_endpoint.rb

@@ -0,0 +1,63 @@
+module RUBG
+  class RubgEndpoint
+    attr_reader :errors, :data, :response_ts, :ratelimit, :ratelimit_remaining, :raw_response
+
+    def initialize(client,response)
+      @errors               = response["errors"]
+      @data                 = response["data"]
+      @response_ts          = Time.parse(response.headers['date']) if response.headers['date']
+      @ratelimit            = response.headers['x-ratelimit-limit']
+      @ratelimit_remaining  = response.headers['x-ratelimit-remaining']
+      @raw_response         = response
+    end
+
+
+    def self.fetch(client,endpoint,shard={},query_options={})
+      @uri      = assemble_uri(shard,endpoint)
+      @headers  = assemble_headers(client)
+      @query    = assemble_query(client,query_options)
+
+      @response = client.class.get(@uri,{headers: @headers,
+                                        query:    @query})
+
+      return @response
+    end
+
+
+
+    private
+      def self.assemble_uri(shard,endpoint)
+        if endpoint == 'status'
+          uri = '/status'
+        else
+          uri = "/shards/#{shard}/#{endpoint}"
+        end
+
+        return uri
+      end
+
+
+      def self.assemble_headers(client)
+        headers = { "Accept" => client.content_type }
+        
+        headers["Authorization"]    = client.api_key  if client.api_key
+        headers["Accept-Encoding"]  = "gzip"          if client.gzip
+
+        return headers
+      end
+
+
+      def self.assemble_query(client, query_options)
+        query_options.each do |key,value|
+          remove_spaces(value) if value
+        end
+        query = query_options
+        
+        return query
+      end
+
+      def self.remove_spaces(string)
+        string.gsub!(/((?<=,)\s+)|(\s+(?=,))/,"") if string
+      end
+  end
+end

data/lib/rubg/status.rb

@@ -1,14 +1,20 @@
 module RUBG
-  class Status
+  class Status < RubgEndpoint
     attr_reader :released_at, :version
     
-    def initialize(client)
-      response = client.class.get("/status")
-      status = response.parsed_response
-
+    def initialize(client,response)
       @alive = ((response.response.class == Net::HTTPOK) ? true : false)
-      @released_at = status["data"]["attributes"]["releasedAt"]
-      @version = status["data"]["attributes"]["version"]
+      @released_at = Time.parse(response["data"]["attributes"]["releasedAt"])
+      @version = response["data"]["attributes"]["version"]
+      super
+    end
+
+
+    def self.fetch(client)
+      endpoint = "status"
+      super(client,endpoint)
+
+      RUBG::Status.new(client, @response)
     end
 
     def alive?

data/lib/rubg/version.rb

@@ -1,3 +1,3 @@
 module RUBG
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubg
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Dor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,6 +102,7 @@ files:
 - lib/rubg/matches.rb
 - lib/rubg/player.rb
 - lib/rubg/players.rb
+- lib/rubg/rubg_endpoint.rb
 - lib/rubg/status.rb
 - lib/rubg/version.rb
 - rubg.gemspec