rubg 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f4594ad2750bbc41e12d65aa2d1ec87313b71d601943b873d62db470cb6ca22
+  data.tar.gz: de64980fede3b8c830f9cfb3bcbe33f8cedf10818878cd63fd861c661891759e
+SHA512:
+  metadata.gz: 007f7825e3a4371be7d9b23fa98c5212d3c97a80dc0a648e81b4d8057d27ce20d66c672017d9006937b071987b2884f8f8724cf41c5b80e69a77b13366960317
+  data.tar.gz: fdcf55449a44f0ec321b40ff9274f42ebbcfc769770568da6827dca05a9dbd0d98ce0044f4f860b72cb8ad1f5696b799b07f34fc30140135ac3b7186f35fab52

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.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 rubg.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    rubg (0.1.2)
+      httparty (~> 0.16.2)
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    json (2.1.0)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rubg!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Dor
+
+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,63 @@
+# RUBG
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubg'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubg
+
+## Usage
+
+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'].
+
+Check the PUBG API status and version:
+
+```ruby
+client.status.alive? 
+client.status.version
+client.status.released_at
+```
+
+
+Only the players endpoint is functional at present, and it is only partially functional:
+
+```ruby
+options = {"shard" => "pc-na", "playerNames" => "Shroud"}
+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.
+
+Note that if neither playerIds or playerNames are included no results will be returned.
+
+
+## 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!
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubg"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/rubg.rb

@@ -0,0 +1,8 @@
+require "rubg/version"
+require "rubg/client"
+require "rubg/players"
+require "rubg/status"
+
+module RUBG
+
+end

data/lib/rubg/client.rb

@@ -0,0 +1,28 @@
+require 'httparty'
+
+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'])
+      @api_key = api_key
+      @content_type = "application/vnd.api+json"
+    end
+
+    def status
+      RUBG::Status.new(self)
+    end
+
+
+    # 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
+  end
+end

data/lib/rubg/match.rb

@@ -0,0 +1,5 @@
+module RUBG
+  class Match
+
+  end
+end

data/lib/rubg/matches.rb

@@ -0,0 +1,5 @@
+module RUBG
+  class Matches
+
+  end
+end

data/lib/rubg/player.rb

@@ -0,0 +1,8 @@
+module RUBG
+  class Player
+
+  end
+end
+
+
+# response["data"][0]["relationships"]["matches"]["data"][0]["id"]

data/lib/rubg/players.rb

@@ -0,0 +1,59 @@
+module RUBG 
+  class Players
+    attr_reader :errors, :data, :raw_response, :uri, :headers, :query
+
+
+    def initialize(client, options)
+      players = players_endpoint(client, options)
+
+      @errors       = players["errors"]
+      @data         = players["data"]
+      @raw_response = players
+    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 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
+
+      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
+
+
+# response["data"][0]["relationships"]["matches"]["data"][0]["id"]

data/lib/rubg/status.rb

@@ -0,0 +1,18 @@
+module RUBG
+  class Status
+    attr_reader :released_at, :version
+    
+    def initialize(client)
+      response = client.class.get("/status")
+      status = response.parsed_response
+
+      @alive = ((response.response.class == Net::HTTPOK) ? true : false)
+      @released_at = status["data"]["attributes"]["releasedAt"]
+      @version = status["data"]["attributes"]["version"]
+    end
+
+    def alive?
+      @alive ? true : false
+    end
+  end
+end

data/lib/rubg/version.rb

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

data/rubg.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rubg/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubg"
+  spec.version       = RUBG::VERSION
+  spec.authors       = ["Dor"]
+  spec.email         = ["dor.edras@gmail.com"]
+
+  spec.summary       = %q{Unofficial PUBG API wrapper gem for Ruby.}
+  spec.description   = %q{Unofficial PUBG API wrapper gem for Ruby.}
+  spec.homepage      = "https://github.com/dor-edras/rubg"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "httparty", "~> 0.16.2"
+  spec.add_dependency "json"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: rubg
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Dor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-04 00:00:00.000000000 Z
+dependencies:
+- !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: 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Unofficial PUBG API wrapper gem for Ruby.
+email:
+- dor.edras@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rubg.rb
+- lib/rubg/client.rb
+- lib/rubg/match.rb
+- lib/rubg/matches.rb
+- lib/rubg/player.rb
+- lib/rubg/players.rb
+- lib/rubg/status.rb
+- lib/rubg/version.rb
+- rubg.gemspec
+homepage: https://github.com/dor-edras/rubg
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Unofficial PUBG API wrapper gem for Ruby.
+test_files: []