fortnite_api 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cca6d1bb30e0b2a5858ef40307a0b7a0f2716eb
-  data.tar.gz: 353c9de03d6290c71a5d5ea3832ae22a16b86d22
+  metadata.gz: 8126fed6c807c55fdc434c56319ee885b061bc41
+  data.tar.gz: f4e0af71bd38c502079afbcc472464c7ce199dd9
 SHA512:
-  metadata.gz: d562344bca6b3cba21bedba5ef7820f3437bcdf0eab209dde57122e31b92293284d924ba9ea81659cd585e21ec080c4c899f383c7e6af63a1b102d655497eb96
-  data.tar.gz: 50518c28b4774e2151b3a88699e7f966e1dc619f1c05f6808edefab19a46952d002aa1c18a7bf3b589e51328c686ccbdc44c3233dde6b91a890088aa4610474b
+  metadata.gz: aaf47148440b762bd8e101b6409fda39cb4d9e10c58a2b7dab7802983a175e5e4c67fc6811da99b6ccdc40f3372592d90bbff666ed8517146f646c5019ad88eb
+  data.tar.gz: f9c9ac98792e6cb4b8e53a8706592f6f32e9100cfe0f9ba15e6eb92222e75a5c2dbdefec2d8774fb2a99a5231224c525d53f26e356df3f68f7ca5d3e3dc89131

data/README.md

@@ -1,6 +1,6 @@
 # FortniteApi [![Build Status](https://travis-ci.org/romainr88/fortnite_api.svg?branch=master)](https://travis-ci.org/romainr88/fortnite_api)
 
-fortnite_api allow you to retrieve information from Fortnite in an easy way through fortnitetracker.com API.
+fortnite_api allow you to retrieve informations from Fortnite in an easy way through fortnitetracker.com API.
 
 ## Installation
 
@@ -25,12 +25,12 @@ Initialize the API with your fortnitetracker.com API key's:
 fortnite = FortniteApi::Api.new('Enter your API Key here')
 ```
 
-Enter the player's profile and the platform which you want to retrieve the information (for the platform you have the choice between 'pc' for PC, 'xbl' for Xbox and 'psn' for Playstation):
+Enter the player's profile and the platform which you want to retrieve the informations (for the platform you have the choice between 'pc' for PC, 'xbl' for Xbox and 'psn' for Playstation):
 ```ruby
 player = fortnite.get_json('pc','Ninja')
 ```
 
-Now you have a player object with the following information:
+Now you have a player object with the following informations:
 
 **Return the username:**
 ```ruby
@@ -44,28 +44,49 @@ player.platformnamelong # return the platform as a string
 => "PC"
 ```
 
-**Return the stats (solo, duo and squad stats):**
+**Return global and current season stats (solo, duo and squad stats):**
+
+For returning stats you have the choice between ('globalsolo', 'globalduo', 'globalsquad', 'currentsolo', 'currentduo' and 'currentsquad') and after you can get the following informations ('trnrating', 'score', 'scorepermatch', 'top1', 'top10', 'top25', 'winratio', 'kills', 'kd' and 'kpg').
 ```ruby
-player.stats # return the stats as a hash
-=> {"p2"=>{"trnRating"=>{"label"=>"TRN Rating", "field"=>"TRNRating", "category"=>"Rating", "valueInt"=>4543, "value"=>"4543", "rank"=>2080,..., "value"=>"392.45", "percentile"=>0.6, "displayValue"=>"392.45"}}}
+player.globalsolo.top1 # return top 1 global solo information as a hash
+ => {"label"=>"Wins", "field"=>"Top1", "category"=>"Tops", "valueInt"=>1843, "value"=>"1843", "percentile"=>0.1, "displayValue"=>"1,843"}
 ```
-
-**Return the lifetime stats:**
 ```ruby
-player.lifetimestats # return the lifetime stats as an array
-=> [{"key"=>"Top 3", "value"=>"1518"}, {"key"=>"Top 5s", "value"=>"1318"}, {"key"=>"Top 3s", "value"=>"387"}, {"key"=>"Top 6s", "value"=>"477"},..., "value"=>"54518"}, {"key"=>"K/d", "value"=>"11.05"}]
+player.globalduo.score # return score global duo stats as a hash
+ => {"label"=>"Score", "field"=>"Score", "category"=>"General", "valueInt"=>1780621, "value"=>"1780621", "percentile"=>0.1, "displayValue"=>"1,780,621"} 
+```
+```ruby
+player.globalsquad.kills # return kills global squad stats as a hash
+ => {"label"=>"Kills", "field"=>"Kills", "category"=>"General", "valueInt"=>27656, "value"=>"27656", "percentile"=>0.1, "displayValue"=>"27,656"} 
+```
+```ruby
+player.currentsolo.winratio # return winratio current solo stats as a hash
+ => {"label"=>"Win %", "field"=>"WinRatio", "category"=>"General", "valueDec"=>25.0, "value"=>"25", "percentile"=>0.7, "displayValue"=>"25.00"} 
+```
+```ruby
+player.currentduo.kpg # return kills per match current duo stats as a hash
+ => {"label"=>"Kills Per Match", "field"=>"KPG", "category"=>"General", "valueDec"=>5.76, "value"=>"5.76", "percentile"=>0.1, "displayValue"=>"5.76"} 
+```
+```ruby
+player.currentsquad.trnrating # return TRN Rating current squad stats as a hash
+ => {"label"=>"TRN Rating", "field"=>"TRNRating", "category"=>"Rating", "valueInt"=>4868, "value"=>"4868", "percentile"=>0.1, "displayValue"=>"4,868"} 
+```
+You can also custom the informations you want to get (you can retrieve all the informations of the stats, e.g., 'player.globalsolo.custom'):
+```ruby
+player.globalsolo.custom['top5'] # return top 5 global solo information as a hash
+  => {"label"=>"Top 5", "field"=>"Top5", "category"=>"Tops", "valueInt"=>0, "value"=>"0", "displayValue"=>"0"} 
 ```
 
-**Return the recent matches:**
+**Return lifetime stats:**
 ```ruby
-player.recentmatches # return the recent matches as an array
-=> [{"id"=>210645397, "accountId"=>"4735ce91-3292-4caf-8a5b-17789b40f79c", "playlist"=>"p10", "kills"=>10, "minutesPlayed"=>0, "top1"=>1, "top5"=>1,...,  "trnRating"=>4472.8, "trnRatingChange"=>-12.857500000000005}]
+player.lifetimestats # return lifetime stats as an array
+=> [{"key"=>"Top 3", "value"=>"1518"}, {"key"=>"Top 5s", "value"=>"1318"}, {"key"=>"Top 3s", "value"=>"387"}, {"key"=>"Top 6s", "value"=>"477"},..., "value"=>"54518"}, {"key"=>"K/d", "value"=>"11.05"}]
 ```
 
-Example:
+**Return recent matches:**
 ```ruby
-player.stats['curr_p2']['top10'] # return the current solo top10 information
-=> {"label"=>"Top 10", "field"=>"Top10", "category"=>"Tops", "valueInt"=>49, "value"=>"49", "rank"=>9512, "percentile"=>0.2, "displayValue"=>"49"}
+player.recentmatches # return recent matches as an array
+=> [{"id"=>210645397, "accountId"=>"4735ce91-3292-4caf-8a5b-17789b40f79c", "playlist"=>"p10", "kills"=>10, "minutesPlayed"=>0, "top1"=>1, "top5"=>1,...,  "trnRating"=>4472.8, "trnRatingChange"=>-12.857500000000005}]
 ```
 
 ## Development

data/fortnite_api.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["romainr88"]
   spec.email         = ["romainr88dev@gmail.com"]
 
-  spec.summary       = "Retrieve information from Fortnite with fortnitetracker.com API"
-  spec.description   = "Retrieve information from Fortnite with fortnitetracker.com API"
+  spec.summary       = "Retrieve informations from Fortnite with fortnitetracker.com API"
+  spec.description   = "Retrieve informations from Fortnite with fortnitetracker.com API"
   spec.homepage      = "https://github.com/romainr88/fortnite_api"
   spec.license       = "MIT"
 

data/lib/fortnite_api.rb

@@ -3,6 +3,12 @@ require 'net/http'
 require 'uri'
 require 'json'
 require 'fortnite_api/player'
+require 'fortnite_api/global_solo'
+require 'fortnite_api/global_duo'
+require 'fortnite_api/global_squad'
+require 'fortnite_api/current_solo'
+require 'fortnite_api/current_duo'
+require 'fortnite_api/current_squad'
 
 module FortniteApi
      class Api

data/lib/fortnite_api/current_duo.rb

@@ -0,0 +1,53 @@
+module FortniteApi
+    class CurrentDuo
+        attr_reader :values
+            
+        def initialize(hash={})
+            @values = hash
+        end
+        
+        def custom
+            self.values['curr_p10']
+        end
+        
+        def trnrating
+            self.values['curr_p10']['trnRating']
+        end
+        
+        def score
+            self.values['curr_p10']['score']
+        end
+
+        def scorepermatch
+            self.values['curr_p10']['scorePerMatch']
+        end        
+        
+        def top1
+            self.values['curr_p10']['top1']
+        end
+        
+        def top10
+            self.values['curr_p10']['top10']
+        end
+        
+        def top25
+            self.values['curr_p10']['top25']
+        end
+        
+        def winratio
+            self.values['curr_p10']['winRatio']
+        end        
+        
+        def kills
+            self.values['curr_p10']['kills']
+        end
+        
+        def kd
+            self.values['curr_p10']['kd']
+        end
+        
+        def kpg
+            self.values['curr_p10']['kpg']
+        end
+    end
+end

data/lib/fortnite_api/current_solo.rb

@@ -0,0 +1,53 @@
+module FortniteApi
+    class CurrentSolo
+        attr_reader :values
+            
+        def initialize(hash={})
+            @values = hash
+        end
+        
+        def custom
+            self.values['curr_p2']
+        end
+        
+        def trnrating
+            self.values['curr_p2']['trnRating']
+        end
+        
+        def score
+            self.values['curr_p2']['score']
+        end
+
+        def scorepermatch
+            self.values['curr_p2']['scorePerMatch']
+        end        
+        
+        def top1
+            self.values['curr_p2']['top1']
+        end
+        
+        def top10
+            self.values['curr_p2']['top10']
+        end
+        
+        def top25
+            self.values['curr_p2']['top25']
+        end
+        
+        def winratio
+            self.values['curr_p2']['winRatio']
+        end        
+        
+        def kills
+            self.values['curr_p2']['kills']
+        end
+        
+        def kd
+            self.values['curr_p2']['kd']
+        end
+        
+        def kpg
+            self.values['curr_p2']['kpg']
+        end
+    end
+end

data/lib/fortnite_api/current_squad.rb

@@ -0,0 +1,53 @@
+module FortniteApi
+    class CurrentSquad
+        attr_reader :values
+            
+        def initialize(hash={})
+            @values = hash
+        end
+        
+        def custom
+            self.values['curr_p9']
+        end
+        
+        def trnrating
+            self.values['curr_p9']['trnRating']
+        end
+        
+        def score
+            self.values['curr_p9']['score']
+        end
+
+        def scorepermatch
+            self.values['curr_p9']['scorePerMatch']
+        end        
+        
+        def top1
+            self.values['curr_p9']['top1']
+        end
+        
+        def top10
+            self.values['curr_p9']['top10']
+        end
+        
+        def top25
+            self.values['curr_p9']['top25']
+        end
+        
+        def winratio
+            self.values['curr_p9']['winRatio']
+        end        
+        
+        def kills
+            self.values['curr_p9']['kills']
+        end
+        
+        def kd
+            self.values['curr_p9']['kd']
+        end
+        
+        def kpg
+            self.values['curr_p9']['kpg']
+        end
+    end
+end

data/lib/fortnite_api/global_duo.rb

@@ -0,0 +1,53 @@
+module FortniteApi
+    class GlobalDuo
+        attr_reader :values
+            
+        def initialize(hash={})
+            @values = hash
+        end
+        
+        def custom
+            self.values['p10']
+        end
+        
+        def trnrating
+            self.values['p10']['trnRating']
+        end
+        
+        def score
+            self.values['p10']['score']
+        end
+
+        def scorepermatch
+            self.values['p10']['scorePerMatch']
+        end        
+        
+        def top1
+            self.values['p10']['top1']
+        end
+        
+        def top10
+            self.values['p10']['top10']
+        end
+        
+        def top25
+            self.values['p10']['top25']
+        end
+        
+        def winratio
+            self.values['p10']['winRatio']
+        end        
+        
+        def kills
+            self.values['p10']['kills']
+        end
+        
+        def kd
+            self.values['p10']['kd']
+        end
+        
+        def kpg
+            self.values['p10']['kpg']
+        end        
+    end
+end

data/lib/fortnite_api/global_solo.rb

@@ -0,0 +1,53 @@
+module FortniteApi
+    class GlobalSolo
+        attr_reader :values
+            
+        def initialize(hash={})
+            @values = hash
+        end
+        
+        def custom
+            self.values['p2']
+        end
+        
+        def trnrating
+            self.values['p2']['trnRating']
+        end
+        
+        def score
+            self.values['p2']['score']
+        end
+
+        def scorepermatch
+            self.values['p2']['scorePerMatch']
+        end        
+        
+        def top1
+            self.values['p2']['top1']
+        end
+        
+        def top10
+            self.values['p2']['top10']
+        end
+        
+        def top25
+            self.values['p2']['top25']
+        end
+        
+        def winratio
+            self.values['p2']['winRatio']
+        end        
+        
+        def kills
+            self.values['p2']['kills']
+        end
+        
+        def kd
+            self.values['p2']['kd']
+        end
+        
+        def kpg
+            self.values['p2']['kpg']
+        end
+    end
+end

data/lib/fortnite_api/global_squad.rb

@@ -0,0 +1,53 @@
+module FortniteApi
+    class GlobalSquad
+        attr_reader :values
+            
+        def initialize(hash={})
+            @values = hash
+        end
+     
+        def custom
+            self.values['p9']
+        end
+        
+        def trnrating
+            self.values['p9']['trnRating']
+        end
+        
+        def score
+            self.values['p9']['score']
+        end
+
+        def scorepermatch
+            self.values['p9']['scorePerMatch']
+        end        
+        
+        def top1
+            self.values['p9']['top1']
+        end
+        
+        def top10
+            self.values['p9']['top10']
+        end
+        
+        def top25
+            self.values['p9']['top25']
+        end
+        
+        def winratio
+            self.values['p9']['winRatio']
+        end        
+        
+        def kills
+            self.values['p9']['kills']
+        end
+        
+        def kd
+            self.values['p9']['kd']
+        end
+        
+        def kpg
+            self.values['p9']['kpg']
+        end
+    end
+end

data/lib/fortnite_api/player.rb

@@ -1,8 +1,33 @@
 module FortniteApi
     class Player
         attr_reader :epicuserhandle, :platformnamelong, :stats, :lifetimestats, :recentmatches
+        
         def initialize(opts={})
             opts.each { |k,v| instance_variable_set("@#{k.downcase}", v) }
         end
+        
+        def globalsolo
+            GlobalSolo.new(self.stats)
+        end
+        
+        def globalduo
+            GlobalDuo.new(self.stats)
+        end
+        
+        def globalsquad
+            GlobalSquad.new(self.stats)
+        end
+        
+        def currentsolo
+            CurrentSolo.new(self.stats)
+        end
+        
+        def currentduo
+            CurrentDuo.new(self.stats)
+        end
+        
+        def currentsquad
+            CurrentSquad.new(self.stats)
+        end
     end
 end

data/lib/fortnite_api/version.rb

@@ -1,3 +1,3 @@
 module FortniteApi
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fortnite_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - romainr88
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-10 00:00:00.000000000 Z
+date: 2019-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Retrieve information from Fortnite with fortnitetracker.com API
+description: Retrieve informations from Fortnite with fortnitetracker.com API
 email:
 - romainr88dev@gmail.com
 executables: []
@@ -72,6 +72,12 @@ files:
 - bin/setup
 - fortnite_api.gemspec
 - lib/fortnite_api.rb
+- lib/fortnite_api/current_duo.rb
+- lib/fortnite_api/current_solo.rb
+- lib/fortnite_api/current_squad.rb
+- lib/fortnite_api/global_duo.rb
+- lib/fortnite_api/global_solo.rb
+- lib/fortnite_api/global_squad.rb
 - lib/fortnite_api/player.rb
 - lib/fortnite_api/version.rb
 homepage: https://github.com/romainr88/fortnite_api
@@ -97,5 +103,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Retrieve information from Fortnite with fortnitetracker.com API
+summary: Retrieve informations from Fortnite with fortnitetracker.com API
 test_files: []