PlayerDB 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ba8dc3f225d8cf5f8917d7a1c7f09e4e9a9b5e0af2476b67edf47f0921187ca1
+  data.tar.gz: 61056f1ee574c7ce1e3cc0dbd4f77b95c023f7ff59648d23e75e4b8c70e2ca23
+SHA512:
+  metadata.gz: 030ebb3807962d344a7489b61ec4dea01b512479b580f485169e394f43e44f34239b84cab5c4eeb031066f5f9d2f4dedfbb77f6e5f9edc2349b603913f33ee15
+  data.tar.gz: a2bff72dbfa0c9cbefed04cd031a786c2f2e8e588b30a3effe32340d9dd98185709c0f5c6f20d2cc3018690149771a990f5b826e211a6134b94ae99b26765b04

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+bin/
+test.rb

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+platform: :jruby
+install: gem install httparty

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in PlayerDB.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem 'httparty', '~> 0.18.0'

data/LICENSE.md

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/PlayerDB.gemspec

@@ -0,0 +1,26 @@
+require_relative "./lib/PlayerDB"
+
+Gem::Specification.new do |spec|
+  spec.name          = "PlayerDB"
+  spec.version       = PlayerDB::VERSION
+  spec.authors       = ["Jinzulen"]
+  spec.email         = ["Jinzulen@tuta.io"]
+  spec.license       = "Apache-2.0"
+
+  spec.summary       = %q{Unofficial Ruby Client to interface with the NodeCraft PlayerDB API.}
+  spec.description   = %q{Unofficial Ruby Client to interface with the NodeCraft PlayerDB API.}
+  spec.homepage      = "https://github.com/Jinzulen/PlayerDB"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Jinzulen/PlayerDB"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

data/README.md

@@ -0,0 +1,143 @@
+# PlayerDB
+### Powerful, but simple, unofficial client to interface with the PlayerDB API.
+![https://api.travis-ci.org/Jinzulen/PlayerDB.svg?branch=master](https://api.travis-ci.org/Jinzulen/PlayerDB.svg?branch=master) [![Maintainability](https://api.codeclimate.com/v1/badges/ce7f5b3cd9f3690180ea/maintainability)](https://codeclimate.com/github/Jinzulen/PlayerDB/maintainability) [![Gem Version](https://badge.fury.io/rb/PlayerDB.svg)](https://badge.fury.io/rb/PlayerDB) ![https://rubygems.org/gems/PlayerDB](https://img.shields.io/gem/dtv/PlayerDB)
+
+# 1. Installation
+*Please note that the gem name is case sensitive.*
+```
+gem install PlayerDB
+```
+
+# 2. Usage Guides
+Firstly, require and initialize the library like so:
+```ruby
+require "playerdb"
+
+@Player = PlayerDB::Client.new
+```
+
+- Grab a Minecraft profile
+```ruby
+# Always catch exceptions!
+begin
+    @Minecraft = @Player.Minecraft("jinzulen")
+
+    # General profile information
+    puts "# General profile information:"
+    puts "# ID: #{@Minecraft["id"]}"
+    puts "# Raw ID: #{@Minecraft["raw_id"]}"
+    puts "# Username: #{@Minecraft["username"]}"
+    puts "# Avatar: #{@Minecraft["avatar"]}\n\n"
+
+    # Name change history
+    @History = @Minecraft["meta"]["name_history"]
+
+    if @History.length > 1
+        puts "# Name change history:"
+
+        @History.each do |n|
+            puts "# #{n["name"]} <= Changed at: #{n["changedToAt"]}"
+        end
+    end
+rescue StandardError => e
+    puts "#{e}"
+end
+
+# General profile information:
+# ID: f0e60cbe-8f68-4e88-9d46-c60884101cde
+# Raw ID: f0e60cbe8f684e889d46c60884101cde
+# Username: Jinzulen
+# Avatar: https://crafatar.com/avatars/f0e60cbe8f684e889d46c60884101cde
+
+# Name change history:
+# AKBAT <= Changed at: N/A (Original username)
+# KhalilGr <= Changed at: 30/04/15 08:51 PM
+# KhalilG <= Changed at: 23/01/16 01:11 PM
+# Jinzulen <= Changed at: 10/10/17 08:24 AM
+```
+
+- Grab a Steam profile
+> profilestate: The visibility status of the user's profile.
+
+> personatestate: The user's current online status.
+```ruby
+# Always catch exceptions!
+begin
+    @Steam = @Player.Steam("jinzulen")
+
+    # Profile
+    puts "# Profile:"
+    puts "# ID: #{@Steam["id"]}"
+    puts "# Username: #{@Steam["username"]}"
+    puts "# Avatar: #{@Steam["avatar"]}\n\n"
+
+    # Misc
+    puts "# Miscellaneous:"
+    @Steam["meta"].each { |m| puts "# #{m[0]}: #{m[1]}"}
+rescue StandardError => e
+    puts "#{e}"
+end
+
+# Profile:
+# ID: 76561198262601540
+# Username: Jin
+# Avatar: https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/ff/ffec106a4a3b7dccce217e9c6553b73ce785b90f_full.jpg
+
+# Miscellaneous:
+# steam2id: STEAM_0:0:151167906
+# steam2id_new: STEAM_1:0:151167906
+# steam3id: [U:1:302335812]
+# steam64id: 76561198262601540
+# steamid: 76561198262601540
+# communityvisibilitystate: 1
+# profilestate: Private
+# personaname: Jin
+# profileurl: https://steamcommunity.com/id/jinzulen/
+# avatar: https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/ff/ffec106a4a3b7dccce217e9c6553b73ce785b90f.jpg
+# avatarmedium: https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/ff/ffec106a4a3b7dccce217e9c6553b73ce785b90f_medium.jpg
+# avatarfull: https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/ff/ffec106a4a3b7dccce217e9c6553b73ce785b90f_full.jpg
+# personastate: Offline
+```
+
+- Grab an Xbox profile
+```ruby
+# Always catch exceptions!
+begin
+    @Xbox = @Player.Xbox("Stallion83")
+
+    puts "# Profile:"
+    puts "# ID: #{@Xbox["id"]}"
+    puts "# Username: #{@Xbox["username"]}"
+    puts "# Avatar: #{@Xbox["avatar"]}"
+    puts "# Gamer score: #{@Xbox["meta"]["gamerscore"]}"
+    puts "# Account tier: #{@Xbox["meta"]["accountTier"]}"
+    puts "# Xbox One Rep: #{@Xbox["meta"]["xboxOneRep"]}"
+    puts "# Preferred color: #{@Xbox["meta"]["preferredColor"]}"
+    puts "# Real name: #{@Xbox["meta"]["realName"]}"
+    puts "# Bio: #{@Xbox["meta"]["bio"]}"
+    puts "# Tenure level: #{@Xbox["meta"]["tenureLevel"]}"
+    puts "# Watermarks: #{@Xbox["meta"]["watermarks"]}"
+    puts "# Location: #{@Xbox["meta"]["location"]}"
+    puts "# Show user as avatar: #{@Xbox["meta"]["showUserAsAvatar"]}"
+rescue StandardError => e
+    puts "#{e}"
+end
+
+# Profile:
+# ID: 2745051201447500
+# Username: Stallion83
+# Avatar: https://avatar-ssl.xboxlive.com/avatar/Stallion83/avatarpic-l.png
+# Gamer score: 2126345
+# Account tier: Gold
+# Xbox One Rep: Superstar
+# Preferred color: https://dlassets-ssl.xboxlive.com/public/content/ppl/colors/00009.json
+# Real name: Ray Cox
+# Bio: 1st to 1M & 2M Gamerscore. Mixer Partner Mixer.com/Stallion83
+# Tenure level: 16
+# Watermarks:
+# Location: Knoxville, TN
+# Show user as avatar: 1
+```
+
+# 3. License
+This library is published under the [Apache 2.0](https://github.com/Jinzulen/PlayerDB/blob/master/LICENSE.md) license.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :install

data/lib/Modules/minecraft.rb

@@ -0,0 +1,35 @@
+module PlayerDB
+    class Minecraft < PlayerDB::Client
+        def initialize; end
+
+        def Profile(id)
+            if !id.empty?
+                begin
+                    @Data = contact_api("minecraft", id.downcase)
+
+                    # Does this player exist?
+                    if !@Data["success"] then raise "# [PlayerDB:Minecraft] Mojang API lookup failed; no such player <#{id}> exists." end
+                    
+                    # Perform some magic to correct the Unix timestamp
+                    @History = @Data["data"]["player"]["meta"]["name_history"]
+
+                    if @History.length > 1
+                        @History.each do |n|
+                            if n["changedToAt"]
+                                n["changedToAt"] = n["changedToAt"].to_s.delete_suffix!('000')
+                                n["changedToAt"] = Time.at(n["changedToAt"].to_i).strftime("%d/%m/%y %I:%M %p")
+                            else
+                                n["changedToAt"] = "N/A (Original username)"
+                            end
+                        end
+                    end
+
+                    # Return the player data
+                    @Data["data"]["player"]
+                rescue StandardError => e
+                    puts "# [PlayerDB:Minecraft] Error occurred while contacting API: #{e}"
+                end
+            else raise "# [PlayerDB:Minecraft] Please input an ID to continue." end
+        end
+    end
+end

data/lib/Modules/steam.rb

@@ -0,0 +1,28 @@
+module PlayerDB
+    class Steam < PlayerDB::Client
+        def initialize; end
+
+        def Profile(id)
+            @Status  = ["Offline", "Online", "Busy", "Away", "Snooze", "Looking to trade", "Looking to play"]
+            @Profile = [nil, "Private", nil, "Public"]
+
+            if !id.empty?
+                begin
+                    @Data = contact_api("steam", id.downcase)
+
+                    # Does this player exist?
+                    if !@Data["success"] then raise "# [PlayerDB:Steam] Steam API lookup failed; no such user <#{id}> exists." end
+
+                    # Make the profile and online status suitable for humans
+                    @Data["data"]["player"]["meta"]["profilestate"] = @Profile[@Data["data"]["player"]["meta"]["profilestate"]]
+                    @Data["data"]["player"]["meta"]["personastate"] = @Status[@Data["data"]["player"]["meta"]["personastate"]]
+
+                    # Return data
+                    @Data["data"]["player"]
+                rescue StandardError => e
+                    puts "# [PlayerDB:Steam] Error occurred while contacting API: #{e}"
+                end
+            else raise "# [PlayerDB:Steam] Please input an ID to continue." end
+        end
+    end
+end

data/lib/Modules/xbox.rb

@@ -0,0 +1,21 @@
+module PlayerDB
+    class Xbox < PlayerDB::Client
+        def initialize; end
+
+        def Profile(id)
+            if !id.empty?
+                begin
+                    @Data = contact_api("xbox", id.downcase)
+
+                    # Does this player exist?
+                    if !@Data["success"] then raise "# [PlayerDB:Xbox] Xbox API lookup failed; no such player <#{id}> exists." end
+
+                    # Return the player data
+                    @Data["data"]["player"]
+                rescue StandardError => e
+                    puts "# [PlayerDB:Xbox] Error occurred while contacting API: #{e}"
+                end
+            else raise "# [PlayerDB:Xbox] Please input an ID to continue." end
+        end
+    end
+end

data/lib/PlayerDB.rb

@@ -0,0 +1,29 @@
+require "httparty"
+
+module PlayerDB
+    VERSION = "0.0.2"
+
+    class Client
+        def initialize; end
+
+        def Xbox(id); PlayerDB::Xbox.new.Profile(id) end
+        def Steam(id); PlayerDB::Steam.new.Profile(id) end
+        def Minecraft(id); PlayerDB::Minecraft.new.Profile(id) end
+
+        def contact_api(resource, key)
+            begin
+                response = HTTParty.get("https://playerdb.co/api/player/#{resource}/#{key}")
+
+                response.parsed_response
+            rescue HTTParty::Error => e
+                raise "# [PlayerDB] Failed to retrieve resource: #{e}"
+            rescue StandardError => e
+                raise "# [PlayerDB] Error occurred: #{e}"
+            end
+        end
+    end
+end
+
+require "#{File.expand_path('..', __FILE__)}/Modules/xbox"
+require "#{File.expand_path('..', __FILE__)}/Modules/steam"
+require "#{File.expand_path('..', __FILE__)}/Modules/minecraft"

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: PlayerDB
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jinzulen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-06 00:00:00.000000000 Z
+dependencies: []
+description: Unofficial Ruby Client to interface with the NodeCraft PlayerDB API.
+email:
+- Jinzulen@tuta.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- PlayerDB.gemspec
+- README.md
+- Rakefile
+- lib/Modules/minecraft.rb
+- lib/Modules/steam.rb
+- lib/Modules/xbox.rb
+- lib/PlayerDB.rb
+homepage: https://github.com/Jinzulen/PlayerDB
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/Jinzulen/PlayerDB
+  source_code_uri: https://github.com/Jinzulen/PlayerDB
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Unofficial Ruby Client to interface with the NodeCraft PlayerDB API.
+test_files: []