dota 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a62df441130d34cd7256896d37e5c526200ab22
-  data.tar.gz: 5d7c27f983e4d0691a2e93d33fac19d21c41717c
+  metadata.gz: 23fc49df23488bce2c5a7ba87cddf20ba521ef67
+  data.tar.gz: 67a569a29f97b37fbfd1b79a12c5ed14ad15e406
 SHA512:
-  metadata.gz: 9b13d19087f4d133e1c5ca03963bd7d4e198501bb41406435f1ee91241363a7d5309ef82c76ccd6c01dadec9ea729701bb61b147a6b5877779665c98dc1b59b5
-  data.tar.gz: 36ad9a1554a4ca7e2fa974cf1ea793863f141f87aafcc34d66e1e5bb211cf4621cbab7551e8778a8bfccb63fd5f46376067ed233ea7126ed223f3580f0819598
+  metadata.gz: 23036186cdc6dc69a544c48d8c1470c286dc939a8b77911230d4cd683a6c9b6aff245d7fb93b8f950ae159ab7439ab2862d0bde2339a5a1e3677be933f929c80
+  data.tar.gz: c4dbd4ea60a50c1e49c1f4a6e9d5f98f41861a302780a1a0cf216090df4565a367cbcda81c8bcb8822877ea743a72d52600a8c0cfdb75b13ba2dd89773b85105

data/.env.sample

@@ -0,0 +1,2 @@
+# Get your Steam API key at http://steamcommunity.com/dev/apikey
+STEAM_API_KEY=steam_api_key

data/.gitignore

@@ -12,3 +12,5 @@
 *.o
 *.a
 mkmf.log
+.DS_Store
+.env

data/.travis.yml

@@ -1,8 +1,10 @@
 language: ruby
+
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.2
   - jruby
   - rbx
-install: "bundle install --retry=3"
+
+install: bundle install --retry=3

data/README.md

@@ -12,6 +12,7 @@ Currently supported endpoints:
 - GetGameItems
 - [GetRarities](https://wiki.teamfortress.com/wiki/WebAPI/GetRarities)
 - [GetTeamInfoByTeamID](https://wiki.teamfortress.com/wiki/WebAPI/GetTeamInfoByTeamID)
+- [GetLiveLeagueGames](https://wiki.teamfortress.com/wiki/WebAPI/GetLiveLeagueGames)
 
 Unsupported endpoints can still be queried via [custom requests](#custom-requests).
 
@@ -20,7 +21,6 @@ This gem is in alpha, keep that in mind when upgrading.
 ## TODO
 
 - Support for more endpoints
-  - [GetLiveLeagueGames](https://wiki.teamfortress.com/wiki/WebAPI/GetLiveLeagueGames)
   - [GetMatchHistoryBySequenceNum](https://wiki.teamfortress.com/wiki/WebAPI/GetMatchHistoryBySequenceNum)
   - [GetPlayerSummaries](https://wiki.teamfortress.com/wiki/WebAPI/GetPlayerSummaries)
   - [GetScheduledLeagueGames](https://wiki.teamfortress.com/wiki/WebAPI/GetScheduledLeagueGames)
@@ -52,7 +52,7 @@ Or install it yourself as:
 
 ```ruby
 Dota.configure do |config|
-  config.api_key = "YOUR_STEAM_API_KEY"
+  config.api_key = ENV.fetch("STEAM_API_KEY")
 end
 ```
 
@@ -94,6 +94,8 @@ api.matches(hero_id: 43)       #    Allowed options:
                                #    :league_only - Boolean, Only league matches
                                #    :limit       - Integer, Amount of matches to return (default is 100)
 
+api.live_matches               # => A list of live matches
+
 api.friends(76561198052976237) # => All friends of user
 ```
 
@@ -175,18 +177,18 @@ match.positive_votes          # Integer, Number of thumbs-up the game has receiv
 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_captain_id      # Integer, Radiant captain's 32-bit Steam 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_complete?       # Boolean, true if the Radiant team's roster is complete
 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_captain_id         # Integer, Dire captain's 32-bit Steam 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_complete?          # Boolean, true if the Dire team's roster is complete
 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
 ```
@@ -226,7 +228,7 @@ draft.hero  # Dota::API::Hero, Picked or banned hero
 #### Cosmetic Rarities
 
 ```ruby
-rarity.id    # Integer, ID of rarity, used for indexing
+rarity.id    # Integer, ID of the rarity, used for indexing
 rarity.order # Integer, Sorting and logical order, from most distributed to least
 rarity.name  # String, Localized display name
 rarity.color # String, The hexadecimal RGB tuple
@@ -240,6 +242,23 @@ friend.relationship # String, Relation to the player
 friend.made_at      # Time, When the friend was added to the player's friend list
 ```
 
+#### Live Matches
+```ruby
+live_matches.id                   # Integer, ID of the match
+live_matches.lobby_id             # Integer, ID of the lobby
+live_matches.spectators_count     # Integer, Number of spectators watching on DotaTV
+live_matches.league_id            # Integer, ID of the league
+live_matches.stream_delay         # Integer, Number of seconds the stream is behind actual game time
+live_matches.radiant_series_wins  # Integer, Number of wins the Radiant team has in the series
+live_matches.dire_series_wins     # Integer, Number of wins the Dire team has in the series
+live_matches.radiant              # Dota::API::LiveMatch::Side, Info about the team on the Radiant side
+live_matches.dire                 # Dota::API::LiveMatch::Side, Info about the team on the Dire side
+live_matches.series_type          # Integer, Best of X series
+live_matches.league_tier          # String, What tier the match's league is
+live_matches.players              # Array[Dota::API::LiveMatch::Players], High level info about the players in the match (some redundant info in scoreboard)
+live_matches.scoreboard           # Hash, Details of the scoreboard (to be converted soon to an object and/or integrated with our players class)
+```
+
 ## Contributing
 
 1. [Fork it!](https://github.com/vinnicc/dota/fork)

data/dota.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "dotenv"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 end

data/lib/dota.rb

@@ -9,6 +9,10 @@ require 'dota/api/friend'
 require 'dota/api/hero'
 require 'dota/api/item'
 require 'dota/api/league'
+require 'dota/api/live_match'
+require 'dota/api/live_match/player'
+require 'dota/api/live_match/side'
+require 'dota/api/live_match/scoreboard'
 require 'dota/api/match'
 require 'dota/api/match/draft'
 require 'dota/api/match/player'

data/lib/dota/api/client.rb

@@ -65,6 +65,13 @@ module Dota
         end
       end
 
+      def live_matches
+        response = get("IDOTA2Match_570", "GetLiveLeagueGames")["result"]
+        if response && (live_matches = response["games"])
+          live_matches.map { |game| LiveMatch.new(game) }
+        end
+      end
+
       def cosmetic_rarities
         response = get("IEconDOTA2_570", "GetRarities", language: "en")["result"]
         if response && (rarities = response["rarities"])

data/lib/dota/api/live_match.rb

@@ -0,0 +1,73 @@
+module Dota
+  module API
+    class LiveMatch
+      LEAGUE_TIERS = {
+        1 => "Amateur",
+        2 => "Professional",
+        3 => "Premier"
+      }
+
+      include Utilities::Inspectable
+
+      attr_reader :raw
+
+      def initialize(raw)
+        @raw = raw
+      end
+
+      def lobby_id
+        raw["lobby_id"]
+      end
+
+      def id
+        raw["match_id"]
+      end
+
+      def spectators_count
+        raw["spectators"]
+      end
+
+      def league_id
+        raw["league_id"]
+      end
+
+      def stream_delay
+        raw["stream_delay_s"]
+      end
+
+      def radiant_wins
+        raw["radiant_series_wins"]
+      end
+
+      def dire_wins
+        raw["dire_series_wins"]
+      end
+
+      def radiant
+        Side.new(raw["radiant_team"])
+      end
+
+      def dire
+        Side.new(raw["dire_team"])
+      end
+
+      def series_type
+        raw["series_type"]
+      end
+
+      def league_tier
+        LEAGUE_TIERS[raw["league_tier"]]
+      end
+
+      def players
+        raw["players"].map do |raw_player|
+          Player.new(raw_player)
+        end
+      end
+
+      def scoreboard
+        Scoreboard.new(raw["scoreboard"])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Dota
+  module API
+    class LiveMatch
+      class Player
+        include Utilities::Inspectable
+
+        attr_reader :raw
+
+        def initialize(raw)
+          @raw = raw
+        end
+
+        def id
+          raw["account_id"]
+        end
+
+        def name
+          raw["name"]
+        end
+
+        def hero
+          Hero.new(raw["hero_id"])
+        end
+
+        def team
+          case raw["team"]
+          when 0
+            :radiant
+          when 1
+            :dire
+          when 2
+            :broadcaster
+          when 4
+            :unassigned
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dota/api/live_match/scoreboard.rb

@@ -0,0 +1,31 @@
+module Dota
+  module API
+    class LiveMatch
+      class Scoreboard
+        include Utilities::Inspectable
+
+        attr_reader :raw
+
+        def initialize(raw)
+          @raw = raw
+        end
+
+        def duration
+          raw["duration"]
+        end
+
+        def roshan_timer
+          raw["roshan_respawn_timer"]
+        end
+
+        def radiant
+          raw["radiant"] # this maps out much further. for now it'll act as a hash
+        end
+
+        def dire
+          raw["dire"] # this maps out much further. for now it'll act as a hash
+        end
+      end
+    end
+  end
+end

data/lib/dota/api/live_match/side.rb

@@ -0,0 +1,31 @@
+module Dota
+  module API
+    class LiveMatch
+      class Side
+        include Utilities::Inspectable
+
+        attr_reader :raw
+
+        def initialize(raw)
+          @raw = raw
+        end
+
+        def name
+          raw["team_name"]
+        end
+
+        def id
+          raw["team_id"]
+        end
+
+        def logo_id
+          raw["team_logo"]
+        end
+
+        def complete?
+          raw["complete"]
+        end
+      end
+    end
+  end
+end

data/lib/dota/version.rb

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

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

@@ -0,0 +1,26 @@
+describe Dota::API::LiveMatch::Player do
+  let(:player) do
+    VCR.use_cassette("GetLiveLeagueGames") do
+      matches = test_client.live_matches
+      first_match = matches.first
+      players = first_match.players
+      players.first
+    end
+  end
+
+  specify "#id" do
+    expect(player.id).to eq 34145091
+  end
+
+  specify "#name" do
+    expect(player.name).to eq "Lunar Gato @ CSPL.ru"
+  end
+
+  specify "#hero" do
+    expect(player.hero).to be_a Dota::API::Hero
+  end
+
+  specify "#team" do
+    expect(player.team).to eq :radiant
+  end
+end

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

@@ -0,0 +1,25 @@
+describe Dota::API::LiveMatch::Scoreboard do
+  let(:scoreboard) do
+    VCR.use_cassette("GetLiveLeagueGames") do
+      matches = test_client.live_matches
+      first_match = matches.first
+      first_match.scoreboard
+    end
+  end
+
+  specify "#duration" do
+    expect(scoreboard.duration).to eq 2840.2998046875
+  end
+
+  specify "#roshan_timer" do
+    expect(scoreboard.roshan_timer).to eq 278
+  end
+
+  xspecify "#radiant" do
+    expect(scoreboard.radiant).to eq 
+  end
+
+  xspecify "#dire" do
+    expect(scoreboard.dire).to eq
+  end
+end

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

@@ -0,0 +1,25 @@
+describe Dota::API::LiveMatch::Side do
+  let(:side) do
+    VCR.use_cassette("GetLiveLeagueGames") do
+      matches = test_client.live_matches
+      first_match = matches.first
+      first_match.dire
+    end
+  end
+
+  specify "#id" do
+    expect(side.id).to eq 1846074
+  end
+
+  specify "#name" do
+    expect(side.name).to eq "Haunti Gaming"
+  end
+
+  specify "#logo_id" do
+    expect(side.logo_id).to eq 547513665869798854
+  end
+
+  specify "#complete?" do
+    expect(side.complete?).to eq false
+  end
+end

data/spec/dota/api/live_match_spec.rb

@@ -0,0 +1,62 @@
+describe Dota::API::LiveMatch do
+  let(:live_match) do
+    VCR.use_cassette("GetLiveLeagueGames") do
+      matches = test_client.live_matches
+      matches.first
+    end
+  end
+
+  specify "#id" do
+    expect(live_match.id).to eq 1080324763
+  end
+
+  specify "#lobby_id" do
+    expect(live_match.lobby_id).to eq 23791470898109516
+  end
+
+  specify "#spectators_count" do
+    expect(live_match.spectators_count).to eq 58
+  end
+
+  specify "#league_id" do
+    expect(live_match.league_id).to eq 2091
+  end
+
+  specify "#stream_delay" do
+    expect(live_match.stream_delay).to eq 120
+  end
+
+  specify "#radiant_wins" do
+    expect(live_match.radiant_wins).to eq 0
+  end
+
+  specify "#dire_wins" do
+    expect(live_match.dire_wins).to eq 0
+  end
+
+  specify "#radiant" do
+    expect(live_match.radiant).to be_a Dota::API::LiveMatch::Side
+  end
+
+  specify "#dire" do
+    expect(live_match.dire).to be_a Dota::API::LiveMatch::Side
+  end
+
+  specify "#series_type" do
+    expect(live_match.series_type).to eq 0
+  end
+
+  specify "#league_tier" do
+    expect(live_match.league_tier).to eq "Amateur"
+  end
+
+  specify "#players" do
+    players = live_match.players
+    expect(players.count).to eq 11
+    expect(players.first).to be_a Dota::API::LiveMatch::Player
+  end
+
+  specify "#scoreboard" do
+    expect(live_match.scoreboard).to be_a Dota::API::LiveMatch::Scoreboard
+  end
+end