dota 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c5d56cb8f9252cf51783dfa66983cb27e028043
-  data.tar.gz: c4be90c14fc988fe1de4362769e9ea861b42e7a7
+  metadata.gz: 75461cf111d77eeb914651d773cd93d245302b3d
+  data.tar.gz: 55187c81f399c51cad995c0dee7720ccf79bf394
 SHA512:
-  metadata.gz: 3cb95cd2e0deae0750644fd242a3a123ea282f7dff217b379b0b0e388575c92586d85f60dc6dbaa2057c474cb052e52ac16df5b26b21644a8c205596eec92385
-  data.tar.gz: 9321418620eeca973a8d3984e8f927764bbc3534b71400bbcf767207a6f2a8e441b0106e8bcb25bd38c1a12fcda88e1316059255c9598e016375b026a1dcb438
+  metadata.gz: e3496ade2cde5f857dcd476cca08db4855fcc6b482faeb62e30c105141a2fb11bafc8c258283eaf87ac83667faccc3ece7096712da2448503c8339544ff7fc15
+  data.tar.gz: a3d2fe97b094882165ff0136498bd0a5fc6a65faed9a2504daa9729a9a6c5effd136e55c9de22ac9a339304114c4bf4c47600304d5c5e44531507caae6a5f650

data/README.md

@@ -1,9 +1,23 @@
 # Dota [![Gem Version](https://badge.fury.io/rb/dota.svg)](http://badge.fury.io/rb/dota) [![Build Status](https://travis-ci.org/vinnicc/dota.svg?branch=master)](https://travis-ci.org/vinnicc/dota)
 
-`dota` is a Ruby client for the [Dota 2 WebAPI](https://wiki.teamfortress.com/wiki/WebAPI#Dota_2). It provides an easy way to access matches, players, heroes, items, and other public Dota 2 objects in an opinionated manner.
+`dota` is a Ruby client for the [Dota 2 WebAPI](https://wiki.teamfortress.com/wiki/WebAPI#Dota_2). It provides an easy way to access matches, players, heroes, items, and other public Dota 2 objects in an opinionated manner.  Check out their [documentation](https://wiki.teamfortress.com/wiki/WebAPI#Dota_2) or [this post](http://dev.dota2.com/showthread.php?t=58317) to learn more.
+
+Currently supported endpoints:
+
+- [GetMatchDetails](https://wiki.teamfortress.com/wiki/WebAPI/GetMatchDetails)
+- [GetMatchHistory](https://wiki.teamfortress.com/wiki/WebAPI/GetMatchHistory)
 
 This gem is in alpha, keep that in mind when upgrading.
 
+## TODO
+
+- Support for more endpoints
+- Validations and error classes
+- More configuration options
+- Move API documentation to [readthedocs.org](https://readthedocs.org/) or somewhere else
+- Better search filters
+- Computed attributes such as win rates, hero usage, etc.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,20 +42,22 @@ Dota.configure do |config|
 end
 ```
 
-Get your Steam API key [here](http://steamcommunity.com/dev/apikey). What follows is a list of API methods currently available:
+Get your Steam API key [here](http://steamcommunity.com/dev/apikey).
 
 ```ruby
 api = Dota.api
 
-api.heroes(43)           # A single hero (Death Prophet)
-api.heroes               # All heroes
+api.heroes(43)           # (Cached) A single hero - Death Prophet
+api.heroes               # (Cached) All heroes
 
-api.items(114)           # A single item (Heart of Tarrasque)
-api.items                # All items
+api.items(114)           # (Cached) A single item - Heart of Tarrasque
+api.items                # (Cached) All items
+
+api.cosmetic_rarities    # All cosmetic rarities
 
 api.leagues              # All leagues
 
-api.matches(789645621)   # A single match (Newbee vs Vici Gaming)
+api.matches(789645621)   # A single match - Newbee vs Vici Gaming
 api.matches              # A list of matches
 api.matches(hero_id: 43) # Allowed options:
                          #
@@ -58,11 +74,7 @@ api.matches(hero_id: 43) # Allowed options:
                          #   :limit       - Integer, Amount of matches to return (default is 100)
 ```
 
-### API Objects
-
-You won't need to instantiate on these classes directly and it's not advisable to do so as the API might change anytime. Starting with the call to `Dota.api` should be enough in most cases.
-
-#### Dota::API::Hero
+#### Heroes
 
 ```ruby
 hero.id        # => 43
@@ -70,7 +82,7 @@ hero.name      # => "Death Prophet"
 hero.image_url # => "http://cdn.dota2.com/apps/dota2/images/heroes/death_prophet_full.png"
 ```
 
-#### Dota::API::Item
+#### Items
 
 ```ruby
 item.id        # => 114
@@ -78,7 +90,20 @@ item.name      # => "Heart of Tarrasque"
 item.image_url # => "http://cdn.dota2.com/apps/dota2/images/items/heart_lg.png"
 ```
 
-#### Dota::API::Match
+#### Leagues
+
+```ruby
+league.id          # => 600
+league.name        # => "The International 2014"
+league.description # => "The Aegis of Champions hangs in the balance. See the world's top teams battle in the International."
+league.url         # => "http://www.dota2.com/international/overview/"
+```
+
+#### Matches
+
+Caveat: Getting a list of matches via `api.matches` will call [GetMatchHistory](https://wiki.teamfortress.com/wiki/WebAPI/GetMatchHistory) which has very few attributes for the matches returned (obviously for performance reasons), as opposed to getting info about a particular match via `api.matches(id)` which will instead call [GetMatchDetails](https://wiki.teamfortress.com/wiki/WebAPI/GetMatchDetails). In both cases, the matches returned will be instances of `Dota::API::Match`. In the future, there will be subclasses to distinguish the two.
+
+When an instance method in a `Dota::API::Match` class returns `nil`, it most likely means the endpoint called doesn't support the value required yet.
 
 ```ruby
 match.id                      # => 789645621
@@ -97,7 +122,7 @@ match.first_blood             # => 33
 match.positive_votes          # => 34701
 match.negative_votes          # => 13291
 match.season                  # => nil
-match.human_players           # => 10
+match.players_count           # => 10
 match.cluster                 # => 111
 match.radiant_tower_status    # => 2039
 match.dire_tower_status       # => 1974
@@ -105,7 +130,7 @@ match.radiant_barracks_status # => 63
 match.dire_barracks_status    # => 63
 ```
 
-#### Dota::API::Match::Player
+#### Players
 
 ```ruby
 player.id           # => 98887913
@@ -128,32 +153,24 @@ player.tower_damage # => 153
 player.hero_healing # => 526
 ```
 
-#### Dota::API::Match::Draft
+#### Drafts
 
 ```ruby
-draft.hero  # => Dota::API::Hero
 draft.order # => 1
 draft.pick? # => true
+draft.team  # => :radiant
+draft.hero  # => Dota::API::Hero
 ```
 
-#### Dota::API::League
+#### Cosmetic Rarities
 
 ```ruby
-league.id          # => 600
-league.name        # => "The International 2014"
-league.description # => "The Aegis of Champions hangs in the balance. See the world's top teams battle in the International."
-league.url         # => "http://www.dota2.com/international/overview/"
+rarity.id    # => 1
+rarity.order # => 0
+rarity.color # => "#e4ae39"
+rarity.name  # => "Immortal"
 ```
 
-## TODO
-
-- Validations and error classes
-- More configuration options
-- Move API documentation to [readthedocs.org](https://readthedocs.org/) or somewhere else
-- Implement all Dota 2 WebAPI methods
-- Better search filters
-- Computed attributes such as win rates, hero usage, etc.
-
 ## Contributing
 
 1. [Fork it!](https://github.com/vinnicc/dota/fork)

data/lib/dota.rb

@@ -4,12 +4,13 @@ require 'dota/version'
 require 'dota/utils/inspect'
 
 require 'dota/api/client'
+require 'dota/api/cosmetic/rarity'
 require 'dota/api/hero'
 require 'dota/api/item'
 require 'dota/api/league'
 require 'dota/api/match'
-require 'dota/api/match/player'
 require 'dota/api/match/draft'
+require 'dota/api/match/player'
 
 module Dota
   class << self

data/lib/dota/api/client.rb

@@ -49,6 +49,13 @@ module Dota
         end
       end
 
+      def cosmetic_rarities
+        response = do_request("GetRarities", { language: "en" }, "IEconDOTA2_570")["result"]
+        if response && (rarities = response["rarities"])
+          rarities.map { |rarity| Cosmetic::Rarity.new(rarity) }
+        end
+      end
+
       private
 
       def do_request(method, params = {}, interface = "IDOTA2Match_570", method_version = "V001")

data/lib/dota/api/cosmetic/rarity.rb

@@ -0,0 +1,31 @@
+module Dota
+  module API
+    class Cosmetic
+      class Rarity
+        def initialize(raw)
+          @raw = raw
+        end
+
+        def id
+          raw["id"]
+        end
+
+        def order
+          raw["order"]
+        end
+
+        def color
+          raw["color"]
+        end
+
+        def name
+          raw["localized_name"]
+        end
+
+        private
+
+        attr_reader :raw
+      end
+    end
+  end
+end

data/lib/dota/api/match.rb

@@ -112,7 +112,7 @@ module Dota
         raw["leagueid"]
       end
 
-      def human_players
+      def players_count
         raw["human_players"]
       end
 

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

@@ -14,6 +14,10 @@ module Dota
           raw["is_pick"]
         end
 
+        def team
+          raw["team"] == 0 ? :radiant : :dire
+        end
+
         def hero
           Hero.new(raw["hero_id"])
         end

data/lib/dota/version.rb

@@ -1,3 +1,3 @@
 module Dota
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/dota/api/cosmetic/rarity_spec.rb

@@ -0,0 +1,12 @@
+describe Dota::API::Cosmetic::Rarity do
+  let(:rarity) do
+    VCR.use_cassette("GetRarities") do
+      test_client.cosmetic_rarities.last
+    end
+  end
+
+  specify("#id")    { expect(rarity.id).to    eq 7 }
+  specify("#order") { expect(rarity.order).to eq 6 }
+  specify("#color") { expect(rarity.color).to eq "#e4ae39" }
+  specify("#name")  { expect(rarity.name).to  eq "Immortal" }
+end

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

@@ -9,6 +9,10 @@ describe Dota::API::Match::Draft do
     expect(draft.pick?).to eq true
   end
 
+  specify "#team" do
+    expect(draft.team).to eq :radiant
+  end
+
   specify "#order" do
     expect(draft.order).to eq 20
   end

data/spec/dota/api/match_spec.rb

@@ -73,8 +73,8 @@ describe Dota::API::Match do
     expect(match.season).to be_nil
   end
 
-  specify "#human_players" do
-    expect(match.human_players).to eq 10
+  specify "#players_count" do
+    expect(match.players_count).to eq 10
   end
 
   specify "#cluster" do

data/spec/dota_spec.rb

@@ -93,5 +93,12 @@ describe Dota do
         expect(league).to be_a Dota::API::League
       end
     end
+
+    specify "#cosmetic_rarities" do
+      VCR.use_cassette("GetRarities") do
+        rarities = api.cosmetic_rarities
+	expect(rarities.first).to be_a Dota::API::Cosmetic::Rarity
+      end
+    end
   end
 end

data/spec/fixtures/vcr_cassettes/GetRarities.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.steampowered.com/IEconDOTA2_570/GetRarities/V001/?key=2FBBA83745F494FAE688AFB8463CD4FC&language=en
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Expires:
+      - Thu, 20 Nov 2014 21:13:59 GMT
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '907'
+      Date:
+      - Thu, 20 Nov 2014 21:13:59 GMT
+    body:
+      encoding: UTF-8
+      string: "{\n\t\"result\": {\n\t\t\"count\": 8,\n\t\t\"rarities\": [\n\t\t\t{\n\t\t\t\t\"name\":
+        \"common\",\n\t\t\t\t\"id\": 1,\n\t\t\t\t\"order\": 0,\n\t\t\t\t\"color\":
+        \"#b0c3d9\",\n\t\t\t\t\"localized_name\": \"Common\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"name\":
+        \"uncommon\",\n\t\t\t\t\"id\": 2,\n\t\t\t\t\"order\": 1,\n\t\t\t\t\"color\":
+        \"#5e98d9\",\n\t\t\t\t\"localized_name\": \"Uncommon\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"name\":
+        \"rare\",\n\t\t\t\t\"id\": 3,\n\t\t\t\t\"order\": 2,\n\t\t\t\t\"color\": \"#4b69ff\",\n\t\t\t\t\"localized_name\":
+        \"Rare\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"name\": \"mythical\",\n\t\t\t\t\"id\":
+        4,\n\t\t\t\t\"order\": 3,\n\t\t\t\t\"color\": \"#8847ff\",\n\t\t\t\t\"localized_name\":
+        \"Mythical\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"name\": \"legendary\",\n\t\t\t\t\"id\":
+        5,\n\t\t\t\t\"order\": 4,\n\t\t\t\t\"color\": \"#d32ce6\",\n\t\t\t\t\"localized_name\":
+        \"Legendary\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"name\": \"ancient\",\n\t\t\t\t\"id\":
+        6,\n\t\t\t\t\"order\": 5,\n\t\t\t\t\"color\": \"#eb4b4b\",\n\t\t\t\t\"localized_name\":
+        \"Ancient\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"name\": \"immortal\",\n\t\t\t\t\"id\":
+        7,\n\t\t\t\t\"order\": 6,\n\t\t\t\t\"color\": \"#e4ae39\",\n\t\t\t\t\"localized_name\":
+        \"Immortal\"\n\t\t\t}\n\t\t]\n\t\t,\n\t\t\"status\": 200\n\t}\n}"
+    http_version: 
+  recorded_at: Thu, 20 Nov 2014 21:13:59 GMT
+recorded_with: VCR 2.9.3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dota
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Vinni Carlo Caños
@@ -140,6 +140,7 @@ files:
 - dota.gemspec
 - lib/dota.rb
 - lib/dota/api/client.rb
+- lib/dota/api/cosmetic/rarity.rb
 - lib/dota/api/hero.rb
 - lib/dota/api/item.rb
 - lib/dota/api/league.rb
@@ -149,6 +150,7 @@ files:
 - lib/dota/configuration.rb
 - lib/dota/utils/inspect.rb
 - lib/dota/version.rb
+- spec/dota/api/cosmetic/rarity_spec.rb
 - spec/dota/api/hero_spec.rb
 - spec/dota/api/item_spec.rb
 - spec/dota/api/league_spec.rb
@@ -159,6 +161,7 @@ files:
 - spec/fixtures/vcr_cassettes/GetLeagueListing.yml
 - spec/fixtures/vcr_cassettes/GetMatchDetails.yml
 - spec/fixtures/vcr_cassettes/GetMatchHistory.yml
+- spec/fixtures/vcr_cassettes/GetRarities.yml
 - spec/spec_helper.rb
 - spec/support/vcr.rb
 homepage: http://github.com/vinnicc/dota
@@ -186,6 +189,7 @@ signing_key:
 specification_version: 4
 summary: Ruby client for the Dota 2 WebAPI
 test_files:
+- spec/dota/api/cosmetic/rarity_spec.rb
 - spec/dota/api/hero_spec.rb
 - spec/dota/api/item_spec.rb
 - spec/dota/api/league_spec.rb
@@ -196,5 +200,6 @@ test_files:
 - spec/fixtures/vcr_cassettes/GetLeagueListing.yml
 - spec/fixtures/vcr_cassettes/GetMatchDetails.yml
 - spec/fixtures/vcr_cassettes/GetMatchHistory.yml
+- spec/fixtures/vcr_cassettes/GetRarities.yml
 - spec/spec_helper.rb
 - spec/support/vcr.rb