dota 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5614a7fd9ade0b1abada4e7c16e749673e04f94d
-  data.tar.gz: 7cd313476bc49a933db85916b7beaff8445eb6b2
+  metadata.gz: 9a62df441130d34cd7256896d37e5c526200ab22
+  data.tar.gz: 5d7c27f983e4d0691a2e93d33fac19d21c41717c
 SHA512:
-  metadata.gz: df17b5190d60affd6f8bd493a9c350c6e681f572325bfe8873546b2826e38e2990fdf52ac0e59accbc95dd32817ddc2276f93db02c0d21ddaf2360f95ae7b7b4
-  data.tar.gz: a83c8bfe85de2849178501becd1f124b030ac6c3b18f3e966e2fc1ea7baf38352161ec55417cf0eebcad4c72afdfd09b7bcac33ddd8aa037cd944beff77ff4e5
+  metadata.gz: 9b13d19087f4d133e1c5ca03963bd7d4e198501bb41406435f1ee91241363a7d5309ef82c76ccd6c01dadec9ea729701bb61b147a6b5877779665c98dc1b59b5
+  data.tar.gz: 36ad9a1554a4ca7e2fa974cf1ea793863f141f87aafcc34d66e1e5bb211cf4621cbab7551e8778a8bfccb63fd5f46376067ed233ea7126ed223f3580f0819598

data/README.md

@@ -61,40 +61,40 @@ Get your Steam API key [here](http://steamcommunity.com/dev/apikey).
 ```ruby
 api = Dota.api
 
-api.heroes(43)                 # (Cached) A single hero - "Death Prophet"
-api.heroes                     # (Cached) All heroes
+api.heroes(43)                 # => (Cached) A single hero - "Death Prophet"
+api.heroes                     # => (Cached) All heroes
 
-api.items(114)                 # (Cached) A single item - "Heart of Tarrasque"
-api.items                      # (Cached) All items
+api.items(114)                 # => (Cached) A single item - "Heart of Tarrasque"
+api.items                      # => (Cached) All items
 
-api.cosmetic_rarities          # All cosmetic rarities
+api.cosmetic_rarities          # => All cosmetic rarities
 
-api.teams(1375614)             # A single team - "Newbee"
-api.teams                      # A list of teams
-api.teams(after: 1375614)      # Allowed options:
+api.teams(1375614)             # => A single team - "Newbee"
+api.teams                      # => A list of teams
+api.teams(after: 1375614)      #    Allowed options:
                                #
-                               # :after - Integer, With teams IDs equal or greater than this
-                               # :limit - Integer, Amount of teams to return (default is 100)
+                               #    :after - Integer, With team IDs equal or greater than this
+                               #    :limit - Integer, Amount of teams to return (default is 100)
 
-api.leagues                    # All leagues
+api.leagues                    # => All leagues
 
-api.matches(789645621)         # A single match - "Newbee vs Vici Gaming"
-api.matches                    # A list of matches
-api.matches(hero_id: 43)       # Allowed options:
+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
-                               # :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
-                               # :mode_id     - Integer, In this game mode. See Dota::API::Match::MODES
-                               # :skill_level - Integer, In this skill level (ignored if :player_id is provided). See Dota::API::Match::SKILL_LEVELS
-                               # :from        - Integer, Minimum timestamp
-                               # :to          - Integer, Maximum timestamp
-                               # :min_players - Integer, With at least this number of players
-                               # :league_only - Boolean, Only league matches
-                               # :limit       - Integer, Amount of matches to return (default is 100)
-
-api.friends(76561198052976237) # All friends of user
+                               #    :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
+                               #    :mode_id     - Integer, In this game mode. See Dota::API::Match::MODES
+                               #    :skill_level - Integer, In this skill level (ignored if :player_id is provided). See Dota::API::Match::SKILL_LEVELS
+                               #    :from        - Integer, Minimum timestamp
+                               #    :to          - Integer, Maximum timestamp
+                               #    :min_players - Integer, With at least this number of players
+                               #    :league_only - Boolean, Only league matches
+                               #    :limit       - Integer, Amount of matches to return (default is 100)
+
+api.friends(76561198052976237) # => All friends of user
 ```
 
 #### Custom Requests
@@ -155,51 +155,63 @@ Caveat: Getting a list of matches via `api.matches` will call [GetMatchHistory](
 When an instance method in a `Dota::API::Match` class returns `nil`, it most likely means the endpoint called doesn't provide it yet.
 
 ```ruby
-match.id                      # => 789645621
-match.league_id               # => 600
-match.type                    # => "Tournament"
-match.type_id                 # => 2
-match.mode                    # => "Captain's Mode"
-match.mode_id                 # => 2
-match.drafts                  # => [Dota::API::Match::Draft, ...]
-match.players                 # => [Dota::API::Match::Player, ...]
-match.sequence                # => 709365483
-match.starts_at               # => 2014-07-21 20:12:50 UTC
-match.duration                # => 908
-match.winner                  # => :radiant
-match.first_blood             # => 33
-match.positive_votes          # => 34701
-match.negative_votes          # => 13291
-match.season                  # => nil
-match.players_count           # => 10
-match.cluster                 # => 111
-match.radiant_tower_status    # => 2039
-match.dire_tower_status       # => 1974
-match.radiant_barracks_status # => 63
-match.dire_barracks_status    # => 63
+match.id                      # Integer, ID of the match
+match.league_id               # Integer, ID of the league this match was a part of
+match.type                    # String, See Dota::API::Match::TYPES
+match.type_id                 # Integer, See Dota::API::Match::TYPES
+match.mode                    # String, See Dota::API::Match::MODES
+match.mode_id                 # Integer, See Dota::API::Match::MODES
+match.sequence                # Integer, A 'sequence number', representing the order in which matches were recorded
+match.season                  # Integer, Season the match was played in
+match.cluster                 # Integer, Server cluster the match was played on
+match.drafts                  # Array[Dota::API::Match::Draft], Picks and bans in the match, if the game mode is "Captains Mode"
+match.players                 # Array[Dota::API::Match::Player], Players in the match
+match.players_count           # Integer, Number of players in the match
+match.starts_at               # Time, When the match started
+match.first_blood             # Integer, Seconds since the match started when first blood occured
+match.duration                # Integer, Length of the match, in seconds since the match began.
+match.winner                  # Symbol, :radiant or :dire
+match.positive_votes          # Integer, Number of thumbs-up the game has received
+match.negative_votes          # Integer, Number of thumbs-down the game has received
+
+match.radiant_id              # Integer, Radiant team's ID
+match.radiant_captain_id      # Integer, Radiant captain's ID
+match.radiant_logo_id         # Integer, Radiant logo's UGC ID
+match.radiant_name            # String, Radiant team's name
+match.radiant_complete?       # Boolean, true if the Radiant team's roster is complate
+match.radiant_tower_status    # Integer, See https://wiki.teamfortress.com/wiki/WebAPI/GetMatchDetails # Tower_Status
+match.radiant_barracks_status # Integer, See https://wiki.teamfortress.com/wiki/WebAPI/GetMatchDetails # Barracks_Status
+
+match.dire_id                 # Integer, Dire team's ID
+match.dire_captain_id         # Integer, Dire captain's ID
+match.dire_logo_id            # Integer, Dire logo's UGC ID
+match.dire_name               # String, Dire team's name
+match.dire_complete?          # Boolean, true if the Dire team's roster is complate
+match.dire_tower_status       # Integer, See https://wiki.teamfortress.com/wiki/WebAPI/GetMatchDetails # Tower_Status
+match.dire_barracks_status    # Integer, See https://wiki.teamfortress.com/wiki/WebAPI/GetMatchDetails # Barracks_Status
 ```
 
 #### Players
 
 ```ruby
-player.id           # => 98887913
-player.hero         # => Dota::API::Hero
-player.items        # => [Dota::API::Item, ...]
-player.slot         # => 0
-player.status       # => :played
-player.level        # => 11
-player.kills        # => 2
-player.deaths       # => 1
-player.assists      # => 13
-player.last_hits    # => 45
-player.denies       # => 0
-player.gold         # => 649
-player.gold_spent   # => 6670
-player.gpm          # => 437
-player.xpm          # => 460
-player.hero_damage  # => 3577
-player.tower_damage # => 153
-player.hero_healing # => 526
+player.id           # Integer, 32-bit Steam ID
+player.hero         # Dota::API::Hero, Player's hero
+player.items        # Array[Dota::API::Item], Player's inventory (6 items)
+player.slot         # Integer, See https://wiki.teamfortress.com/wiki/WebAPI/GetMatchDetails#Player_Slot
+player.status       # Symbol, :played, :left_safe, :abandoned, or :bot
+player.level        # Integer, The player's level at match end
+player.kills        # Integer, Number of kills attributed to this player
+player.deaths       # Integer, Times this player died during the match
+player.assists      # Integer, Number of assists the player got
+player.last_hits    # Integer, Number of last-hits the player got
+player.denies       # Integer, Number of denies the player got
+player.gold         # Integer, Amount of gold the player had remaining at the end of the match
+player.gold_spent   # Integer, Amount of gold the player spent
+player.gpm          # Integer, Player's overall gold/minute
+player.xpm          # Integer, Player's overall experience/minute
+player.hero_damage  # Integer, Amount of damage the player dealt to heroes
+player.tower_damage # Integer, Amount of damage the player dealt to towers
+player.hero_healing # Integer, Amount of health the player had healed on heroes
 ```
 
 #### Drafts
@@ -208,7 +220,7 @@ player.hero_healing # => 526
 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
+draft.hero  # Dota::API::Hero, Picked or banned hero
 ```
 
 #### Cosmetic Rarities
@@ -223,9 +235,9 @@ rarity.color # String, The hexadecimal RGB tuple
 #### Friends
 
 ```ruby
-friend.id           # String, 64-bit Steam ID
-friend.relationship # String, Relation to the user
-friend.made_at      # Time, When the friend was added to the list
+friend.id           # Integer, Friend's 64-bit Steam ID
+friend.relationship # String, Relation to the player
+friend.made_at      # Time, When the friend was added to the player's friend list
 ```
 
 ## Contributing

data/lib/dota/api/friend.rb

@@ -10,7 +10,7 @@ module Dota
       end
 
       def id
-        raw["steamid"]
+        raw["steamid"].to_i
       end
 
       def relationship

data/lib/dota/api/match.rb

@@ -141,6 +141,46 @@ module Dota
       def dire_barracks_status
         raw["barracks_status_dire"]
       end
+
+      def radiant_id
+        raw["radiant_team_id"]
+      end
+
+      def radiant_name
+        raw["radiant_name"]
+      end
+
+      def radiant_logo_id
+        raw["radiant_logo"]
+      end
+
+      def radiant_complete?
+        raw["radiant_team_complete"] == 1
+      end
+
+      def radiant_captain_id
+        raw["radiant_captain"]
+      end
+
+      def dire_id
+        raw["dire_team_id"]
+      end
+
+      def dire_name
+        raw["dire_name"]
+      end
+
+      def dire_logo_id
+        raw["dire_logo"]
+      end
+
+      def dire_complete?
+        raw["dire_team_complete"] == 1
+      end
+
+      def dire_captain_id
+        raw["dire_captain"]
+      end
     end
   end
 end

data/lib/dota/version.rb

@@ -1,3 +1,3 @@
 module Dota
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/spec/dota/api/friend_spec.rb

@@ -6,7 +6,7 @@ describe Dota::API::Friend do
   end
 
   specify "#id" do
-    expect(friend.id).to eq "76561197992246166"
+    expect(friend.id).to eq 76561197992246166
   end
 
   specify "#relationship" do

data/spec/dota/api/match_spec.rb

@@ -96,4 +96,44 @@ describe Dota::API::Match do
   specify "#dire_barracks_status" do
     expect(match.dire_barracks_status).to eq 63
   end
+
+  specify "#radiant_id" do
+    expect(match.radiant_id).to eq 1375614
+  end
+
+  specify "#radiant_name" do
+    expect(match.radiant_name).to eq "Newbee"
+  end
+
+  specify "#radiant_logo_id" do
+    expect(match.radiant_logo_id).to eq 794064971723724234
+  end
+
+  specify "#radiant_complete?" do
+    expect(match.radiant_complete?).to eq true
+  end
+
+  specify "#radiant_captain_id" do
+    expect(match.radiant_captain_id).to eq 98887913
+  end
+
+  specify "#dire_id" do
+    expect(match.dire_id).to eq 726228
+  end
+
+  specify "#dire_name" do
+    expect(match.dire_name).to eq "Vici Gaming"
+  end
+
+  specify "#dire_logo_id" do
+    expect(match.dire_logo_id).to eq 34096951715893495
+  end
+
+  specify "#dire_complete?" do
+    expect(match.dire_complete?).to eq true
+  end
+
+  specify "#dire_captain_id" do
+    expect(match.dire_captain_id).to eq 91698091
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dota
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Vinni Carlo Caños