dota 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ff7c49731de8c4814a4135dff2de240853f733f
-  data.tar.gz: 90c8a81064bde49c0e540f9b001ab1c571fbd126
+  metadata.gz: d96a945aaf9d39392aa65f1bc19051304bbdd143
+  data.tar.gz: d7ac4845c2627e16fa887f91404ca1dc1886caaa
 SHA512:
-  metadata.gz: ba9aa6924b85bd9bcca501f3b9c2ab7140a4f5c3cf12ac5a9bed7c802c061f4bd569311b66cfbc1387a139b2a8e9b9718b63fa6a9ae05ec12db980325e38e861
-  data.tar.gz: 1d307e7401ac6b70b3ddf1f1f1d7d7d04742148fa7d40beec0475f557c97d422747090a4f35615f5d2c929ab2575163eac8b5cd0b33e9e75d3611d7ba7457b79
+  metadata.gz: d49d7105f8d74f307580dc5f2a162ffa5c6fdd61130783603ecfeed8a222ca5b27b2c43fb97d1446ced0f30f6dc4104c6a19e0a7dd87d68ef676e5d904769267
+  data.tar.gz: 4e52f0ed5b26aa31f2fc8ef2ce943305b26b82ca0fe3a0b0a670404ef5a8ccf72711b085529e86e427b0f384cda4997a634bafca83d87753756ebe91c400b98d

data/README.md

@@ -42,6 +42,9 @@ Get your Steam API key [here](http://steamcommunity.com/dev/apikey) and make sur
 ```ruby
 Dota.configure do |config|
   config.api_key = ENV.fetch("STEAM_API_KEY")
+
+  # Set API version (defaults to "v1")
+  # config.api_version = "v1"
 end
 ```
 
@@ -74,7 +77,7 @@ api.matches(789645621)           # => A single match - "Newbee vs Vici Gaming"
 api.matches                      # => A list of matches
 api.matches(hero_id: 43)         #    Allowed options:
                                  #
-                                 #    :hero_id     - Integer, With this hero. See Dota::API::Hero::MAPPING
+                                 #    :hero_id     - Integer, With this hero. See Dota::API::Hero.mapping
                                  #    :after       - Integer, With match IDs equal or greater than this
                                  #    :player_id   - Integer, With this player (32-bit Steam ID)
                                  #    :league_id   - Integer, In this league. Use Dota.leagues to get a list of leagues
@@ -109,6 +112,12 @@ For the unsupported endpoints, you can use `api.get`. For example, the following
 api.get("IDOTA2Match_570", "GetMatchDetails", match_id: 789645621)
 ```
 
+Setting `api_version` here also overrides the current configuration:
+
+```ruby
+api.get("IDOTA2Match_570", "GetMatchDetails", match_id: 789645621, api_version: "v1")
+```
+
 ### API Objects
 
 #### Heroes
@@ -185,7 +194,7 @@ match.drafts         # Array[Dota::API::Match::Draft], Picks and bans in the mat
 draft.order          # Integer, 1-20
 draft.pick?          # Boolean, true if the draft is a pick, and not a ban
 draft.team           # Symbol, :radiant or :dire
-draft.hero           # Dota::API::Hero, Picked or banned hero
+draft.hero           # Dota::API::Hero || Dota::API::MissingHero, Picked or banned hero
 ```
 
 #### Live Matches
@@ -239,7 +248,7 @@ radiant.series_wins # Integer, Number of wins in the series so far
 
 ```ruby
 player.id                # Integer, 32-bit Steam ID
-player.hero              # Dota::API::Hero, Player's hero
+player.hero              # Dota::API::Hero || Dota::API::MissingHero, Player's hero
 player.items             # Array[Dota::API::Item], Player's inventory (6 items)
 player.slot              # Integer, (1-5)
 player.level             # Integer, The player's level at match end

data/lib/dota.rb

@@ -27,6 +27,7 @@ require 'dota/api/match/player'
 require 'dota/api/match/side'
 require 'dota/api/match/unit'
 require 'dota/api/match/ability_upgrade'
+require 'dota/api/missing_hero'
 require 'dota/api/scheduled_match'
 require 'dota/api/team'
 require 'dota/api/ability'

data/lib/dota/api/basic_player.rb

@@ -25,7 +25,7 @@ module Dota
       end
 
       def hero
-        Hero.new(raw["hero_id"])
+        Hero.find(raw["hero_id"])
       end
 
       def level

data/lib/dota/api/client.rb

@@ -13,7 +13,7 @@ module Dota
       end
 
       def heroes(id = nil)
-        id ? Hero.new(id) : Hero.all
+        id ? Hero.find(id) : Hero.all
       end
 
       def items(id = nil)
@@ -100,13 +100,14 @@ module Dota
         end
       end
 
-      def get(interface, method, params = {}, *args)
-        do_request(method, params, interface, *args)
+      def get(interface, method, params = {})
+        do_request(method, params, interface)
       end
 
       private
 
-      def do_request(method, params, interface = "IDOTA2Match_570", method_version = "V001")
+      def do_request(method, params, interface = "IDOTA2Match_570")
+        method_version = params.delete(:api_version) || configuration.api_version
         url = "https://api.steampowered.com/#{interface}/#{method}/#{method_version}/"
 
         @faraday = Faraday.new(url) do |faraday|

data/lib/dota/api/hero.rb

@@ -5,6 +5,11 @@ module Dota
 
       attr_reader :id, :name
 
+      def self.find(id)
+        hero = mapping[id]
+        hero ? new(id) : Dota::API::MissingHero.new(id)
+      end
+
       def initialize(id)
         @id = id
         @internal_name = mapping[id][0]

data/lib/dota/api/match.rb

@@ -62,7 +62,7 @@ module Dota
       end
 
       def drafts
-        @drafts ||= raw["picks_bans"].map do |raw_draft|
+        @drafts ||= (raw["picks_bans"] || []).map do |raw_draft|
           Draft.new(raw_draft)
         end
       end

data/lib/dota/api/match/player.rb

@@ -36,11 +36,15 @@ module Dota
         end
 
         def additional_units
-          raw["additional_units"].map { |unit| Unit.new(unit["unitname"], extract_items_from(unit)) }
+          raw["additional_units"] ?
+            raw["additional_units"].map { |unit| Unit.new(unit["unitname"], extract_items_from(unit)) } :
+            []
         end
 
         def ability_upgrades
-          raw["ability_upgrades"].map { |ability_upgrade| AbilityUpgrade.new(ability_upgrade) }
+          raw["ability_upgrades"] ?
+            raw["ability_upgrades"].map { |ability_upgrade| AbilityUpgrade.new(ability_upgrade) } :
+            []
         end
 
         def items

data/lib/dota/api/missing_hero.rb

@@ -0,0 +1,13 @@
+module Dota
+  module API
+    class MissingHero
+      attr_reader :id, :name
+
+      def initialize(id = nil)
+      end
+
+      def image_url(type = nil)
+      end
+    end
+  end
+end

data/lib/dota/configuration.rb

@@ -1,7 +1,12 @@
 module Dota
   class Configuration
-    OPTIONS = [:api_key].freeze
+    DEFAULT_API_VERSION = "v1"
+    OPTIONS = [:api_key, :api_version].freeze
 
-    attr_accessor :api_key
+    attr_accessor :api_key, :api_version
+
+    def initialize
+      @api_version = DEFAULT_API_VERSION
+    end
   end
 end

data/lib/dota/version.rb

@@ -1,3 +1,3 @@
 module Dota
-  VERSION = "0.0.18"
+  VERSION = "0.0.19"
 end

data/spec/dota/api/hero_spec.rb

@@ -7,6 +7,12 @@ RSpec.describe Dota::API::Hero do
     expect(heroes.count).to eq 110
   end
 
+  specify ".find" do
+    expect(described_class.find(69)).to be_a Dota::API::Hero
+    expect(described_class.find(nil)).to be_a Dota::API::MissingHero
+    expect(described_class.find("abc")).to be_a Dota::API::MissingHero
+  end
+
   specify "#id" do
     expect(hero.id).to eq 69
   end

data/spec/dota/api/live_match/player_spec.rb

@@ -17,6 +17,7 @@ RSpec.describe Dota::API::LiveMatch::Player do
   end
 
   specify "#hero" do
+    expect(Dota::API::Hero).to receive(:find).and_call_original
     expect(player.hero).to be_a Dota::API::Hero
   end
 

data/spec/dota/api/match/player_spec.rb

@@ -11,6 +11,7 @@ RSpec.describe Dota::API::Match::Player do
   end
 
   specify "#hero" do
+    expect(Dota::API::Hero).to receive(:find).and_call_original
     expect(player.hero).to be_a Dota::API::Hero
   end
 

data/spec/dota/api/match_spec.rb

@@ -29,10 +29,17 @@ RSpec.describe Dota::API::Match do
     expect(match.mode_id).to eq 2
   end
 
-  specify "#drafts" do
-    drafts = match.drafts
-    expect(drafts.count).to eq 20
-    expect(drafts.first).to be_a Dota::API::Match::Draft
+  describe "#drafts" do
+    specify "match with drafts" do
+      drafts = match.drafts
+      expect(drafts.count).to eq 20
+      expect(drafts.first).to be_a Dota::API::Match::Draft
+    end
+
+    specify "match without drafts" do
+      expect(match.raw).to receive(:[]).with("picks_bans") { nil }
+      expect(match.drafts).to eq []
+    end
   end
 
   specify "#sequence" do

data/spec/dota/api/missing_hero_spec.rb

@@ -0,0 +1,16 @@
+RSpec.describe Dota::API::MissingHero do
+  let(:hero) { described_class.new(nil) }
+
+  specify "#id" do
+    expect(hero.id).to eq nil
+  end
+
+  specify "#name" do
+    expect(hero.name).to eq nil
+  end
+
+  specify "#image_url" do
+    expect(hero.image_url).to eq nil
+    expect(hero.image_url(:something)).to eq nil
+  end
+end

data/spec/dota_spec.rb

@@ -1,12 +1,22 @@
 RSpec.describe Dota do
   describe "configuration" do
     it "accepts an api key" do
-      random_string = SecureRandom.hex
+      api_key = SecureRandom.hex
       Dota.configure do |config|
-        config.api_key = random_string
+        config.api_key = api_key
       end
 
-      expect(Dota.configuration.api_key).to eq random_string
+      expect(Dota.configuration.api_key).to eq api_key
+    end
+
+    it "accepts an api version" do
+      expect(Dota.configuration.api_version).to eq "v1"
+
+      Dota.configure do |config|
+        config.api_version = "v2"
+      end
+
+      expect(Dota.configuration.api_version).to eq "v2"
     end
   end
 
@@ -207,7 +217,11 @@ RSpec.describe Dota do
     describe "#get" do
       it "allows custom API requests" do
         VCR.use_cassette("GetRarities") do
-          response = api.get("IEconDOTA2_570", "GetRarities", language: "en")
+          # Expect api_version override to work
+          api.configuration.api_version = "v99999"
+          expect(Faraday).to receive(:new).with(/\/v1/).and_call_original
+
+          response = api.get("IEconDOTA2_570", "GetRarities", { api_version: "v1", language: "en" })
           expect(response["result"]["count"]).to eq 8
         end
       end

data/spec/fixtures/vcr_cassettes/GetFriendList.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.steampowered.com/ISteamUser/GetFriendList/V001/?key=<STEAM_API_KEY>&steamid=76561198052976237
+    uri: https://api.steampowered.com/ISteamUser/GetFriendList/v1/?key=<STEAM_API_KEY>&steamid=76561198052976237
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/vcr_cassettes/GetLeagueListing.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.steampowered.com/IDOTA2Match_570/GetLeagueListing/V001/?key=<STEAM_API_KEY>&language=en
+    uri: https://api.steampowered.com/IDOTA2Match_570/GetLeagueListing/v1/?key=<STEAM_API_KEY>&language=en
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/vcr_cassettes/GetLiveLeagueGames.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.steampowered.com/IDOTA2Match_570/GetLiveLeagueGames/V001/?key=<STEAM_API_KEY>
+    uri: https://api.steampowered.com/IDOTA2Match_570/GetLiveLeagueGames/v1/?key=<STEAM_API_KEY>
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/vcr_cassettes/GetMatchDetails.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.steampowered.com/IDOTA2Match_570/GetMatchDetails/V001/?key=<STEAM_API_KEY>&match_id=1430857330
+    uri: https://api.steampowered.com/IDOTA2Match_570/GetMatchDetails/v1/?key=<STEAM_API_KEY>&match_id=1430857330
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/vcr_cassettes/GetMatchHistory.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.steampowered.com/IDOTA2Match_570/GetMatchHistory/V001/?key=<STEAM_API_KEY>
+    uri: https://api.steampowered.com/IDOTA2Match_570/GetMatchHistory/v1/?key=<STEAM_API_KEY>
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/vcr_cassettes/GetRarities.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.steampowered.com/IEconDOTA2_570/GetRarities/V001/?key=<STEAM_API_KEY>&language=en
+    uri: https://api.steampowered.com/IEconDOTA2_570/GetRarities/v1/?key=<STEAM_API_KEY>&language=en
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/vcr_cassettes/GetScheduledLeagueGames.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.steampowered.com/IDOTA2Match_570/GetScheduledLeagueGames/V001/?key=<STEAM_API_KEY>
+    uri: https://api.steampowered.com/IDOTA2Match_570/GetScheduledLeagueGames/v1/?key=<STEAM_API_KEY>
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/vcr_cassettes/GetTeamInfoByTeamID.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.steampowered.com/IDOTA2Match_570/GetTeamInfoByTeamID/V001/?key=<STEAM_API_KEY>&start_at_team_id=1375614&teams_requested=1
+    uri: https://api.steampowered.com/IDOTA2Match_570/GetTeamInfoByTeamID/v1/?key=<STEAM_API_KEY>&start_at_team_id=1375614&teams_requested=1
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/vcr_cassettes/GetTeamInfoByTeamID_many.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.steampowered.com/IDOTA2Match_570/GetTeamInfoByTeamID/V001/?key=<STEAM_API_KEY>
+    uri: https://api.steampowered.com/IDOTA2Match_570/GetTeamInfoByTeamID/v1/?key=<STEAM_API_KEY>
     body:
       encoding: US-ASCII
       string: ''

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dota
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Vinni Carlo Caños
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-17 00:00:00.000000000 Z
+date: 2015-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -205,6 +205,7 @@ files:
 - lib/dota/api/match/player.rb
 - lib/dota/api/match/side.rb
 - lib/dota/api/match/unit.rb
+- lib/dota/api/missing_hero.rb
 - lib/dota/api/scheduled_match.rb
 - lib/dota/api/team.rb
 - lib/dota/configuration.rb
@@ -226,6 +227,7 @@ files:
 - spec/dota/api/match/side_spec.rb
 - spec/dota/api/match/unit_spec.rb
 - spec/dota/api/match_spec.rb
+- spec/dota/api/missing_hero_spec.rb
 - spec/dota/api/scheduled_match_spec.rb
 - spec/dota/api/team_spec.rb
 - spec/dota_spec.rb
@@ -280,6 +282,7 @@ test_files:
 - spec/dota/api/match/side_spec.rb
 - spec/dota/api/match/unit_spec.rb
 - spec/dota/api/match_spec.rb
+- spec/dota/api/missing_hero_spec.rb
 - spec/dota/api/scheduled_match_spec.rb
 - spec/dota/api/team_spec.rb
 - spec/dota_spec.rb