pubg-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '09270cd3e31642d535e00bdeade6d59326e0770b'
+  data.tar.gz: 94e8c6f555f0f3232787811ca8d3b68bd942a134
+SHA512:
+  metadata.gz: 818fafdcabc1037b97397b769be87bd71b2092b35e98d5b3fa865c1ddf6a29fe2a040956aae87c345d2f09c43c673c09b50d494b9474555b030ca0d31f393a28
+  data.tar.gz: 07bd16008f09ad566e2f8611b0095f063166e2a0e51b7315338e1501bdb71005438a89f0b1b79545e871e0da3058119bf138837e926b027adeb2f006e0b3f857

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.rspec_status

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pubg-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    pubg-ruby (0.1.0)
+      sawyer (~> 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    faraday (0.15.1)
+      multipart-post (>= 1.2, < 3)
+    method_source (0.9.0)
+    multipart-post (2.0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry (~> 0.11)
+  pubg-ruby!
+  rake (~> 10.0)
+  rspec (~> 3.7)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Marcelo Alves
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# PUBG-Ruby
+
+API wrapper for the official [PUBG API](https://developer.playbattlegrounds.com/)
+
+_Currently in active development. Gem could be wildly unstable_
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pubg-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pubg-ruby
+
+## Getting Started
+
+### Setup
+
+```ruby
+require 'pubg'
+
+client = PUBG::Client.new(access_token: '123.456789', region: 'xbox-na')
+```
+
+### Usage
+
+```ruby
+# Find Single Match
+client.match('967f6581-31e2-4402-9661-8f020c68d87b')
+
+# Find player by ID
+client.player('account.6782798d64c64886a80dda0c4b22fc2a')
+
+# Search players by name
+client.players('user1,user2')
+
+# Search players by ID
+client.players('account.6782798d64c64886a80dda0c4b22fc2a,befd8e5b2f9d4b438ae83126bfd5de61')
+
+# Match telemetry
+client.telemetry('https://telemetry-cdn.playbattlegrounds.com/bluehole-pubg/xbox-na/2018/05/18/09/27/b6cb61e0-5a7d-11e8-a5e4-0a58647ff40d-telemetry.json')
+
+# List seasons
+client.seasons
+
+# API status
+client.status
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marceloalves/pubg-ruby.
+
+Some areas that need improvement:
+
+* Tests
+* Clean up response json (camel_case keys, remove unnecessary info)
+* Include [PUBG Assets](https://github.com/pubg/api-assets)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => :spec
+task :test => :spec
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--color', '-f progress', '-r ./spec/spec_helper.rb']
+  t.pattern = 'spec/**/*_spec.rb'
+  t.fail_on_error = true
+end

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pubg'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pubg.rb

@@ -0,0 +1,16 @@
+require 'pubg/client'
+require 'pubg/default'
+
+# Ruby gem for the PUBG API
+module PUBG
+  class << self
+    include PUBG::Configurable
+
+    def client
+      return @client if defined?(@client)
+      @client = PUBG::Client.new(options)
+    end
+  end
+end
+
+PUBG.reset!

data/lib/pubg/client.rb

@@ -0,0 +1,27 @@
+require 'sawyer'
+require 'pubg/connection'
+require 'pubg/configurable'
+require 'pubg/client/match'
+require 'pubg/client/player'
+require 'pubg/client/seasons'
+require 'pubg/client/status'
+require 'pubg/client/telemetry'
+
+module PUBG
+  # Client for PUBG API
+  class Client
+    include PUBG::Configurable
+    include PUBG::Connection
+    include PUBG::Client::Match
+    include PUBG::Client::Player
+    include PUBG::Client::Seasons
+    include PUBG::Client::Status
+    include PUBG::Client::Telemetry
+
+    def initialize(options = {})
+      PUBG::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || PUBG.instance_variable_get(:"@#{key}"))
+      end
+    end
+  end
+end

data/lib/pubg/client/match.rb

@@ -0,0 +1,19 @@
+module PUBG
+  class Client
+    # Methods for Match API
+    #
+    # @see https://documentation.playbattlegrounds.com/en/matches-endpoint.html
+    module Match
+      # Find a single match by ID
+      #
+      # @param id [String] Match ID
+      # @example Find match
+      #   client.match('967f6581-31e2-4402-9661-8f020c68d87b')
+      # @see https://documentation.playbattlegrounds.com/en/matches-endpoint.html
+      def match(id)
+        path = ['shards', @region, 'matches', id].join('/')
+        get(path)
+      end
+    end
+  end
+end

data/lib/pubg/client/player.rb

@@ -0,0 +1,33 @@
+module PUBG
+  class Client
+    # Methods for Player API
+    #
+    # @see https://documentation.playbattlegrounds.com/en/players-endpoint.html
+    module Player
+      # Find multiple players by name or ID
+      #
+      # @param items [String] Comma-separated player names or account IDs
+      # @example Find players
+      #   client.players('user1,user2')
+      #   client.players('account.6782798d64c64886a80dda0c4b22fc2a,befd8e5b2f9d4b438ae83126bfd5de61')
+      # @see https://documentation.playbattlegrounds.com/en/players-endpoint.html#/Players/get_players
+      def players(items)
+        filter_type = items.include?('account.') ? 'playerIds' : 'playerNames'
+        path = ['shards', @region, 'players'].join('/')
+        options = { query: { "filter[#{filter_type}]" => items } }
+        get(path, options)
+      end
+
+      # Find a single player by ID
+      #
+      # @param player_id [String] Player account ID
+      # @example Find player by ID
+      #    client.player('account.6782798d64c64886a80dda0c4b22fc2a')
+      # @see https://documentation.playbattlegrounds.com/en/players-endpoint.html#/Players/get_players__id_
+      def player(player_id)
+        path = ['shards', @region, 'players', player_id].join('/')
+        get(path)
+      end
+    end
+  end
+end

data/lib/pubg/client/seasons.rb

@@ -0,0 +1,16 @@
+module PUBG
+  class Client
+    # Methods for Seasons API
+    module Seasons
+      # List all sessions for region
+      #
+      # @example List Seasons
+      #   client.seasons
+      # @see https://documentation.playbattlegrounds.com/en/players-endpoint.html#/Seasons/get_seasons
+      def seasons
+        path = ['shards', @region, 'seasons'].join('/')
+        get(path)
+      end
+    end
+  end
+end

data/lib/pubg/client/status.rb

@@ -0,0 +1,17 @@
+module PUBG
+  class Client
+    # Methods for Status API
+    #
+    # @see https://documentation.playbattlegrounds.com/en/status-endpoint.html
+    module Status
+      # Get the current API Status
+      #
+      # @example Get Status
+      #   client.status
+      # @see https://documentation.playbattlegrounds.com/en/status-endpoint.html#/Status/get_status
+      def status
+        get('status')
+      end
+    end
+  end
+end

data/lib/pubg/client/telemetry.rb

@@ -0,0 +1,18 @@
+module PUBG
+  class Client
+    # Methods for Telemetry API
+    #
+    # @see https://documentation.playbattlegrounds.com/en/telemetry.html
+    module Telemetry
+      # Fetch telemetry by URL
+      #
+      # @param url [String] Telemetry URL
+      # @example Fetch Telemetry
+      #   client.telemetry('https://telemetry-cdn.playbattlegrounds.com/bluehole-pubg/xbox-na/2018/05/18/09/27/b6cb61e0-5a7d-11e8-a5e4-0a58647ff40d-telemetry.json')
+      # @see https://documentation.playbattlegrounds.com/en/telemetry.html#to-retrieve-telemetry-data
+      def telemetry(url)
+        Sawyer::Agent.call(:get, url).data
+      end
+    end
+  end
+end

data/lib/pubg/configurable.rb

@@ -0,0 +1,30 @@
+module PUBG
+  # Configuration options for {Client}
+  module Configurable
+    attr_accessor :access_token, :region
+    attr_reader   :connection_options, :api_endpoint
+
+    class << self
+      def keys
+        @keys || %i[access_token region connection_options api_endpoint]
+      end
+    end
+
+    def configure
+      yield self
+    end
+
+    def reset!
+      PUBG::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", PUBG::Default.options[key])
+      end
+      self
+    end
+
+    private
+
+    def options
+      Hash[PUBG::Configurable.keys.map { |key| [key, instance_variable_get(:"@#{key}")] }]
+    end
+  end
+end

data/lib/pubg/connection.rb

@@ -0,0 +1,29 @@
+module PUBG
+  # Network layer
+  module Connection
+    def get(url, options = {})
+      request :get, url, options
+    end
+
+    def agent
+      @agent || Sawyer::Agent.new(api_endpoint, sawyer_options) do |http|
+        http.headers[:accept] = @connection_options[:headers][:accept]
+        http.authorization 'Bearer', @access_token
+      end
+    end
+
+    private
+
+    def request(method, path, options = {})
+      @last_response = response = agent.call(method, Addressable::URI.parse(path.to_s), nil, options)
+      response.data
+    end
+
+    def sawyer_options
+      {
+        links_parser: Sawyer::LinkParsers::Simple.new,
+        faraday: Faraday.new(@connection_options)
+      }
+    end
+  end
+end

data/lib/pubg/default.rb

@@ -0,0 +1,39 @@
+module PUBG
+  # DEfault configuration options for {Client}
+  module Default
+    # Default API Endpoint
+    API_ENDPOINT = 'https://api.playbattlegrounds.com'.freeze
+
+    # Default region
+    REGION = 'xbox-na'.freeze
+
+    # Default media type
+    DEFAULT_MEDIA_TYPE = 'application/vnd.api+json'.freeze
+
+    class << self
+      def options
+        Hash[PUBG::Configurable.keys.map { |key| [key, send(key)] }]
+      end
+
+      def api_endpoint
+        API_ENDPOINT
+      end
+
+      def access_token
+        ENV['PUBG_ACCESS_TOKEN']
+      end
+
+      def region
+        ENV['PUBG_REGION'] || REGION
+      end
+
+      def connection_options
+        {
+          headers: {
+            accept: DEFAULT_MEDIA_TYPE
+          }
+        }
+      end
+    end
+  end
+end

data/lib/pubg/version.rb

@@ -0,0 +1,3 @@
+module PUBG
+  VERSION = '0.1.0'.freeze
+end

data/pubg-ruby.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pubg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pubg-ruby'
+  spec.version       = PUBG::VERSION
+  spec.authors       = ['Marcelo Alves']
+  spec.email         = ['selfmadecelo@gmail.com']
+
+  spec.summary       = 'Ruby wrapper of the PUBG API.'
+  spec.description   = 'Ruby wrapper of the PUBG API.'
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'sawyer', '~> 0.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: pubg-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcelo Alves
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sawyer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Ruby wrapper of the PUBG API.
+email:
+- selfmadecelo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pubg.rb
+- lib/pubg/client.rb
+- lib/pubg/client/match.rb
+- lib/pubg/client/player.rb
+- lib/pubg/client/seasons.rb
+- lib/pubg/client/status.rb
+- lib/pubg/client/telemetry.rb
+- lib/pubg/configurable.rb
+- lib/pubg/connection.rb
+- lib/pubg/default.rb
+- lib/pubg/version.rb
+- pubg-ruby.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper of the PUBG API.
+test_files: []