brawlhalla-api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b0672936f9392289c88a4b6cf86774a9b7af81c8aa30afcac9f2cd99dc0f78d
-  data.tar.gz: bc7f5ccb7eb3c40c94d591bb6a97e0a804b17b2fc6eb553d3cfc781373d8825a
+  metadata.gz: 825dbd3cb6b62b94a63c9af8423dc8b036a618c5948b900080ccc6a1080195fe
+  data.tar.gz: 6cb7df461f6a2f96f73211fc1fd1dde428055f697319d20527baa60b1174850c
 SHA512:
-  metadata.gz: 0b7bb22aaddcee75c0fa889094c9245764c4ec4a7e76632e651ed7720dd9f7e301c785f09ca959483239cfd2ed4d9a50c9c6672bd401dde3c5e666e2fe3b25a7
-  data.tar.gz: 3f016cdae9736d6f5939f1321ef416f7cd734ca653c0d845a4101aaa4cf02817140ba8382e4d79898219788396a315f28ebf4304cfaf1da29d3bdf667c262e28
+  metadata.gz: 8c55b1c15581b13fe99836672a41e4e6ad52838f41aecf64da05d6f4b9ea54d50c8880750916da0d6352ae6e2e0c83f22b8e4007b93b3683886dd42e8e903499
+  data.tar.gz: 85d551b32404f87360bbf0e88962f59b18c63168839ff53e3ca051af4f2f578996aea4324f7eea4b8df7f2ff5d5a7fd47f1ff965f0ba013d079ef88accc6c891

data/README.md

@@ -20,40 +20,96 @@ Or install it yourself as:
 
 ## Usage
 
+Before using Brawlhalla::API you need to set it up with a valid API key.
+
+```ruby
+Brawlhalla::API.configure do |config|
+  config.api_key = 'YOUR_API_KEY_HERE'
+  config.debug = false # set to true for debugging
+end
+```
+
 ### Search By Steam ID
 
 A Player can be looked up by steam ID. This returns the player’s name and brawlhalla_id.
 
-_(A player’s steamid in format steamID64 (ex 76561198025185087).)_
+_(A player’s steamid in format steamID64 (ex 76561198048321884).)_
 
 ```ruby
-  bh = Brawlhalla::API::Client.new('YOUR_API_KEY_HERE')
-  bh.search('PLAYER_STEAM_ID')
+Brawlhalla::API.search('76561198048321884')
+# => #<Brawlhalla::API::PlayerSearch:0x00007fa9db937a10 @brawlhalla_id=8817417, @name="Rikas">
 ```
 
 ### Players
 
 #### Stats
 
-This endpoint retrieves all stats about a player
+This endpoint retrieves all stats about a player, given a `brawlhalla_id`. It will return a new
+`Brawlhalla::API::Player` instance with all the stats as attributes.
 
 ```ruby
-  bh = Brawlhalla::API::Client.new('YOUR_API_KEY_HERE')
-  bh.stats('PLAYER_BRAWLHALLA_ID')
+player = Brawlhalla::API::Player.find('8817417')
+# => #<Brawlhalla::API::Player:0x00007f9642b71350 ...>
+
+player.games # => 1839
+player.brawlhalla_id # => 8817417
+player.damagebomb  # => 5516
+player.kobomb # => 47
+```
+
+You also get individual stats (`Brawlhalla::API::LegendStat` instance) for each legend.
+
+```ruby
+player.legend_stats.size # => 42
+
+scarlet_stats = player.legend_stats.first
+
+scarlet_stats.damagedealt # => 4481
+scarlet_stats.damagegadgets # => 53
+scarlet_stats.games # => 45
 ```
 
 #### Ranked
 
-This endpoint retrieves ranked data about a player.
+This endpoint retrieves ranked data about a player. It receives one argument - the brawlhalla_id of
+the player.
+
+```ruby
+ranked = Ranking.find('8817417')
+ranked.wins # => 172
+ranked.region # => "EU"
+ranked.rating # => 1394
+ranked.peak_rating # => 1415
+```
+
+**Note**: You can also get the ranked data if you already have a `Brawlhalla::API::Player` instance
+by calling the `#ranking` method. Keep in mind that this will also trigger an API call:
+
+```ruby
+player = Brawlhalla::API::Player.find('8817417')
+player.ranking #=> All the ranked data like the one you get with `Brawlhalla::API::Ranked.find`
+```
+
+You can check each legend's rankings by calling the `#legend_rankings` method. This will return an
+array of `Brawlhalla::API::LegendRanking` instances:
 
 ```ruby
-  bh = Brawlhalla::API::Client.new('YOUR_API_KEY_HERE')
-  bh.ranked('PLAYER_BRAWLHALLA_ID')
+ranked = Ranking.find('8817417')
+legend_rankings = ranked.legend_rankings # Array of LegendRanking instances
+legend_rankings.size # => 10
+
+bodvar_ranking = legend_rankings.first
+bodvar_ranking.games # => 31
+bodvar_ranking.peak_rating # => 1200
+bodvar.rating # => 1199
+bodvar_ranking.tier # => "Silver 2"
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run
+the tests. You can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
 
 ## Contributing
 

data/bin/console

@@ -8,8 +8,13 @@ require 'brawlhalla/api'
 require 'dotenv'
 Dotenv.load
 
-# Uncomment this line after adding your API key to .env file to use the bh client in the console.
-bh = Brawlhalla::API::Client.new(ENV['API_KEY'])
+Brawlhalla::API.configure do |config|
+  config.api_key = ENV['API_KEY']
+  config.debug = false
+end
+
+# So we can use Player, Clan, Client, etc. without namespacing every time.
+self.send(:include, Brawlhalla::API)
 
 require 'pry'
 Pry.start

data/lib/brawlhalla/api/clan.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Brawlhalla
+  module API
+    class Clan
+      ATTRIBUTES = %i[
+        clan_name clan_id clan_xp personal_xp
+      ]
+
+      attr_accessor *ATTRIBUTES
+      alias name clan_name
+      alias id clan_id
+      alias xp clan_xp
+
+      def initialize(json)
+        ATTRIBUTES.each do |attr|
+          send("#{attr}=", json[attr])
+        end
+      end
+    end
+  end
+end

data/lib/brawlhalla/api/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Brawlhalla
+  module API
+    class Configuration
+      attr_accessor :api_key, :debug
+
+      def initialize
+        @api_key = ''
+        @debug = false
+      end
+
+      def debug?
+        @debug || false
+      end
+    end
+  end
+end

data/lib/brawlhalla/api/doubles_ranking.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Brawlhalla
+  module API
+    class DoublesRanking
+      ATTRIBUTES = %i[
+        brawlhalla_id_one brawlhalla_id_two rating peak_rating tier wins games teamname region
+        global_rank
+      ]
+
+      attr_accessor *ATTRIBUTES
+
+      def initialize(json)
+        ATTRIBUTES.each do |attr|
+          send("#{attr}=", json[attr])
+        end
+      end
+    end
+  end
+end

data/lib/brawlhalla/api/legend_ranking.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Brawlhalla
+  module API
+    class LegendRanking
+      ATTRIBUTES = %i[legend_id legend_name_key rating peak_rating tier wins games]
+
+      attr_accessor *ATTRIBUTES
+
+      def initialize(json)
+        ATTRIBUTES.each do |attr|
+          send("#{attr}=", json[attr])
+        end
+      end
+    end
+  end
+end

data/lib/brawlhalla/api/legend_stat.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Brawlhalla
+  module API
+    class LegendStat
+      ATTRIBUTES = %i[
+        legend_id legend_name_key damagedealt damagetaken kos falls suicides teamkos matchtime games
+        wins damageunarmed damagethrownitem damageweaponone damageweapontwo damagegadgets kounarmed
+        kothrownitem koweaponone koweapontwo kogadgets timeheldweaponone timeheldweapontwo xp level
+        xp_percentage
+      ]
+
+      attr_accessor *ATTRIBUTES
+
+      def initialize(json)
+        ATTRIBUTES.each do |attr|
+          value = json[attr]
+          value = value.to_i if attr.to_s.start_with?('damage')
+
+          send("#{attr}=", value)
+        end
+      end
+    end
+  end
+end

data/lib/brawlhalla/api/player.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'brawlhalla/api/legend_stat'
+require 'brawlhalla/api/clan'
+require 'brawlhalla/api/ranking'
+
+module Brawlhalla
+  module API
+    class Player
+      ATTRIBUTES = %i[
+        brawlhalla_id name xp level xp_percentage games wins damagebomb damagespikeball
+        damagesidekick hitsnowball kobomb komine kospikeball kosnowball
+      ]
+
+      attr_accessor *ATTRIBUTES
+      attr_reader :legend_stats, :clan
+
+      def self.find(brawlhalla_id)
+        stats_json = API.client.stats(brawlhalla_id)
+
+        new(stats_json)
+      end
+
+      def initialize(json)
+        ATTRIBUTES.each do |attr|
+          value = json[attr]
+          value = value.to_i if attr.to_s.start_with?('damage')
+
+          send("#{attr}=", value)
+        end
+
+        initialize_clan(json)
+        initialize_legends(json)
+      end
+
+      def ranking
+        @ranking ||= Ranking.find(brawlhalla_id)
+      end
+
+      private
+
+      # For some odd reason the damage values come as strings instead of integers.
+      def sanitalize_damage_values
+        @damagebomb = @damagebomb.to_i
+        @damagesidekick = @damagesidekick.to_i
+        @damagespikeball = @damagespikeball.to_i
+      end
+
+      def initialize_clan(json)
+        return unless json[:clan]
+
+        @clan = Clan.new(json[:clan])
+      end
+
+      def initialize_legends(json)
+        return unless json[:legends]
+
+        @legend_stats = json[:legends].map { |legend_json| LegendStat.new(legend_json) }
+      end
+    end
+  end
+end

data/lib/brawlhalla/api/player_search.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Brawlhalla
+  module API
+    class PlayerSearch
+      attr_accessor :name, :brawlhalla_id
+
+      def initialize(json)
+        @name = json[:name]
+        @brawlhalla_id = json[:brawlhalla_id]
+      end
+    end
+  end
+end

data/lib/brawlhalla/api/ranking.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'brawlhalla/api/legend_ranking'
+require 'brawlhalla/api/doubles_ranking'
+
+module Brawlhalla
+  module API
+    class Ranking
+      ATTRIBUTES = %i[
+        name brawlhalla_id rating peak_rating tier wins games region global_rank region_rank
+      ]
+
+      attr_accessor *ATTRIBUTES
+      attr_reader :legend_rankings, :doubles_rankings
+
+      def self.find(brawlhalla_id)
+        ranking_json = API.client.ranked(brawlhalla_id)
+        new(ranking_json)
+      end
+
+      def initialize(json)
+        ATTRIBUTES.each do |attr|
+          send("#{attr}=", json[attr])
+        end
+
+        @legend_rankings = json[:legends].map { |legend_json| LegendRanking.new(legend_json) }
+        @doubles_rankings = json[:"2v2"].map { |doubles_json| DoublesRanking.new(doubles_json) }
+      end
+    end
+  end
+end

data/lib/brawlhalla/api/version.rb

@@ -2,6 +2,6 @@
 
 module Brawlhalla
   module API
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/brawlhalla/api.rb

@@ -1,12 +1,35 @@
 # frozen_string_literal: true
 
 require 'brawlhalla/api/version'
+require 'brawlhalla/api/configuration'
 require 'brawlhalla/api/client'
+require 'brawlhalla/api/player'
+require 'brawlhalla/api/player_search'
+
 require 'faraday'
 require 'faraday_middleware'
 require 'addressable'
 
 module Brawlhalla
   module API
+    module_function
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def client
+      @client = Client.new(configuration.api_key, debug: configuration.debug?)
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def search(steam_id)
+      search_json = client.search(steam_id)
+
+      PlayerSearch.new(search_json)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brawlhalla-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - rikas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-29 00:00:00.000000000 Z
+date: 2018-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -198,7 +198,15 @@ files:
 - bin/setup
 - brawlhalla-api.gemspec
 - lib/brawlhalla/api.rb
+- lib/brawlhalla/api/clan.rb
 - lib/brawlhalla/api/client.rb
+- lib/brawlhalla/api/configuration.rb
+- lib/brawlhalla/api/doubles_ranking.rb
+- lib/brawlhalla/api/legend_ranking.rb
+- lib/brawlhalla/api/legend_stat.rb
+- lib/brawlhalla/api/player.rb
+- lib/brawlhalla/api/player_search.rb
+- lib/brawlhalla/api/ranking.rb
 - lib/brawlhalla/api/version.rb
 homepage: https://github.com/rikas/brawlhalla-api
 licenses: