dota 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad118a276cb0f8883e5072b9c41cc0a98767dc93
-  data.tar.gz: 5ccf4337d2d9c333d92fa58508e4f80dcdf7a9b2
+  metadata.gz: 13969c4e3573f338e6b8b08a86f69c8c2809ff8a
+  data.tar.gz: 2d53b80d2477534ebfd99822000a43cf38761da4
 SHA512:
-  metadata.gz: f63a7ae4e6cd23a9f6489a2e1d92ae312565ca05edce17465265c842a8747d0b6a06bced04929987077470371948e0acef9e24be947a39351c38f6fbbc2377b8
-  data.tar.gz: c3107344c0616c4c39f9abcac67fd86325411f4c79e684853149dc863e12ce3dd2afcf10a792f8572b41dfcdd641c7abee19431e91063d3c861a96ab71cbf535
+  metadata.gz: f0810e4563f659467a8c7392c66f1cd5f17fc71f9ef67b8424522ec3b77abd23e5f75759fe5ab68ad04015629c57ed47158cf09dcdc59701fc09c1bd07e201b0
+  data.tar.gz: 1a0de2076dbe4f5cce57d52ee1a3dc2dc88f6ee19c3a12baa1e1bb697ed671ff370ed9cd02a00c8e7cf5548f2595bfcd5ad1a2f3931eb1cd7ea189a272d364e0

data/README.md

@@ -1,6 +1,8 @@
 # Dota
 
-The Dota gem can be used integration with the Dota 2 WebAPI.
+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.
+
+This gem is in alpha, keep that in mind when upgrading. Documentation is also still lacking. In the meantime, you can do `SomeClass.instance_methods(false)` to see what methods are exposed. See [Core Classes](#core-classes) for more info.
 
 ## Installation
 
@@ -22,13 +24,57 @@ Or install it yourself as:
 
 ```ruby
 Dota.configure do |config|
-  config.api_key = "STEAM_API_KEY"
+  config.api_key = "YOUR_STEAM_API_KEY"
 end
+
+api = Dota.api
+```
+
+Get your Steam API key [here](http://steamcommunity.com/dev/apikey). What follows is a list of API methods supported by the gem:
+
+#### Get a single match
+
+Returns an instance of `Dota::API::Match`.
+
+```ruby
+api.match(MATCH_ID)
+```
+
+## API Objects
+
+Only for reference. You won't need to instantiate on these classes directly and it's not advisable to do so as the API might change anytime. Using `Dota.api` alone should be enough in most cases.
+
+### Dota::API::Item
+
+```ruby
+item.id        # => 114
+item.name      # => "Heart of Tarrasque"
+item.image_url # => "http://cdn.dota2.com/apps/dota2/images/items/heart_lg.png"
+```
+
+### Dota::API::Hero
+
+```ruby
+hero.id        # => 43
+hero.name      # => "Death Prophet"
+hero.image_url # => "http://cdn.dota2.com/apps/dota2/images/heroes/death_prophet_full.png"
+```
+
+### Dota::API::Match
+
+```ruby
+XXX: TODO
+```
+
+###Dota::API::Match::Player
+
+```ruby
+XXX: TODO
 ```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/dota/fork )
+1. [Fork It](https://github.com/vinnicc/dota/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/dota.rb

@@ -4,6 +4,7 @@ require 'dota/version'
 require 'dota/utils/inspect'
 
 require 'dota/api/client'
+require 'dota/api/hero'
 require 'dota/api/item'
 require 'dota/api/match'
 require 'dota/api/match/player'

data/lib/dota/api/hero.rb

@@ -0,0 +1,132 @@
+module Dota
+  module API
+    class Hero
+      MAPPING = {
+        1 => ["antimage", "Anti-Mage"],
+        2 => ["axe", "Axe"],
+        3 => ["bane", "Bane"],
+        4 => ["bloodseeker", "Bloodseeker"],
+        5 => ["crystal_maiden", "Crystal Maiden"],
+        6 => ["drow_ranger", "Drow Ranger"],
+        7 => ["earthshaker", "Earthshaker"],
+        8 => ["juggernaut", "Juggernaut"],
+        9 => ["mirana", "Mirana"],
+        10 => ["morphling", "Morphling"],
+        11 => ["nevermore", "Shadow Fiend"],
+        12 => ["phantom_lancer", "Phantom Lancer"],
+        13 => ["puck", "Puck"],
+        14 => ["pudge", "Pudge"],
+        15 => ["razor", "Razor"],
+        16 => ["sand_king", "Sand King"],
+        17 => ["storm_spirit", "Storm Spirit"],
+        18 => ["sven", "Sven"],
+        19 => ["tiny", "Tiny"],
+        20 => ["vengefulspirit", "Vengeful Spirit"],
+        21 => ["windrunner", "Windranger"],
+        22 => ["zuus", "Zeus"],
+        23 => ["kunkka", "Kunkka"],
+        25 => ["lina", "Lina"],
+        26 => ["lion", "Lion"],
+        27 => ["shadow_shaman", "Shadow Shaman"],
+        28 => ["slardar", "Slardar"],
+        29 => ["tidehunter", "Tidehunter"],
+        30 => ["witch_doctor", "Witch Doctor"],
+        31 => ["lich", "Lich"],
+        32 => ["riki", "Riki"],
+        33 => ["enigma", "Enigma"],
+        34 => ["tinker", "Tinker"],
+        35 => ["sniper", "Sniper"],
+        36 => ["necrolyte", "Necrophos"],
+        37 => ["warlock", "Warlock"],
+        38 => ["beastmaster", "Beastmaster"],
+        39 => ["queenofpain", "Queen of Pain"],
+        40 => ["venomancer", "Venomancer"],
+        41 => ["faceless_void", "Faceless Void"],
+        42 => ["skeleton_king", "Wraith King"],
+        43 => ["death_prophet", "Death Prophet"],
+        44 => ["phantom_assassin", "Phantom Assassin"],
+        45 => ["pugna", "Pugna"],
+        46 => ["templar_assassin", "Templar Assassin"],
+        47 => ["viper", "Viper"],
+        48 => ["luna", "Luna"],
+        49 => ["dragon_knight", "Dragon Knight"],
+        50 => ["dazzle", "Dazzle"],
+        51 => ["rattletrap", "Clockwerk"],
+        52 => ["leshrac", "Leshrac"],
+        53 => ["furion", "Nature's Prophet"],
+        54 => ["life_stealer", "Lifestealer"],
+        55 => ["dark_seer", "Dark Seer"],
+        56 => ["clinkz", "Clinkz"],
+        57 => ["omniknight", "Omniknight"],
+        58 => ["enchantress", "Enchantress"],
+        59 => ["huskar", "Huskar"],
+        60 => ["night_stalker", "Night Stalker"],
+        61 => ["broodmother", "Broodmother"],
+        62 => ["bounty_hunter", "Bounty Hunter"],
+        63 => ["weaver", "Weaver"],
+        64 => ["jakiro", "Jakiro"],
+        65 => ["batrider", "Batrider"],
+        66 => ["chen", "Chen"],
+        67 => ["spectre", "Spectre"],
+        68 => ["ancient_apparition", "Ancient Apparition"],
+        69 => ["doom_bringer", "Doom"],
+        70 => ["ursa", "Ursa"],
+        71 => ["spirit_breaker", "Spirit Breaker"],
+        72 => ["gyrocopter", "Gyrocopter"],
+        73 => ["alchemist", "Alchemist"],
+        74 => ["invoker", "Invoker"],
+        75 => ["silencer", "Silencer"],
+        76 => ["obsidian_destroyer", "Outworld Devourer"],
+        77 => ["lycan", "Lycan"],
+        78 => ["brewmaster", "Brewmaster"],
+        79 => ["shadow_demon", "Shadow Demon"],
+        80 => ["lone_druid", "Lone Druid"],
+        81 => ["chaos_knight", "Chaos Knight"],
+        82 => ["meepo", "Meepo"],
+        83 => ["treant", "Treant Protector"],
+        84 => ["ogre_magi", "Ogre Magi"],
+        85 => ["undying", "Undying"],
+        86 => ["rubick", "Rubick"],
+        87 => ["disruptor", "Disruptor"],
+        88 => ["nyx_assassin", "Nyx Assassin"],
+        89 => ["naga_siren", "Naga Siren"],
+        90 => ["keeper_of_the_light", "Keeper of the Light"],
+        91 => ["wisp", "Io"],
+        92 => ["visage", "Visage"],
+        93 => ["slark", "Slark"],
+        94 => ["medusa", "Medusa"],
+        95 => ["troll_warlord", "Troll Warlord"],
+        96 => ["centaur", "Centaur Warrunner"],
+        97 => ["magnataur", "Magnus"],
+        98 => ["shredder", "Timbersaw"],
+        99 => ["bristleback", "Bristleback"],
+        100 => ["tusk", "Tusk"],
+        101 => ["skywrath_mage", "Skywrath Mage"],
+        102 => ["abaddon", "Abaddon"],
+        103 => ["elder_titan", "Elder Titan"],
+        104 => ["legion_commander", "Legion Commander"],
+        105 => ["techies", "Techies"],
+        106 => ["ember_spirit", "Ember Spirit"],
+        107 => ["earth_spirit", "Earth Spirit"],
+        109 => ["terrorblade", "Terrorblade"],
+        110 => ["phoenix", "Phoenix"]
+      }.freeze
+
+      attr_reader :id, :name
+
+      def initialize(id)
+        @id = id
+        @internal_name = MAPPING[id][0]
+        @name = MAPPING[id][1]
+      end
+
+      def image_url(type = :full)
+        "http://cdn.dota2.com/apps/dota2/images/heroes/#{internal_name}_#{type}.png"
+      end
+
+      private
+
+      attr_reader :internal_name
+    end
+  end
+end

data/lib/dota/api/item.rb

@@ -247,6 +247,10 @@ module Dota
         @id = id
         @name = MAPPING[id]
       end
+
+      def image_url(type = :lg)
+        "http://cdn.dota2.com/apps/dota2/images/items/#{name}_#{type}.png"
+      end
     end
   end
 end

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

@@ -27,6 +27,10 @@ module Dota
           end
         end
 
+        def hero
+          Hero.new(raw["hero_id"])
+        end
+
         def level
           raw["level"]
         end

data/lib/dota/version.rb

@@ -1,3 +1,3 @@
 module Dota
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/dota/api/hero_spec.rb

@@ -0,0 +1,19 @@
+describe Dota::API::Hero do
+  let(:item) do
+    VCR.use_cassette("GetMatchDetails") do
+      test_client.match(sample_match_id).players.first.hero
+    end
+  end
+
+  specify "#id" do
+    expect(item.id).to eq 69
+  end
+
+  specify "#name" do
+    expect(item.name).to eq "Doom"
+  end
+
+  specify "#image_url" do
+    expect(item.image_url).to eq "http://cdn.dota2.com/apps/dota2/images/heroes/doom_bringer_full.png"
+  end
+end

data/spec/dota/api/item_spec.rb

@@ -12,4 +12,8 @@ describe Dota::API::Item do
   specify "#name" do
     expect(item.name).to eq "blink"
   end
+
+  specify "#image_url" do
+    expect(item.image_url).to eq "http://cdn.dota2.com/apps/dota2/images/items/blink_lg.png"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dota
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Vinni Carlo Caños
@@ -153,12 +153,14 @@ files:
 - dota.gemspec
 - lib/dota.rb
 - lib/dota/api/client.rb
+- lib/dota/api/hero.rb
 - lib/dota/api/item.rb
 - lib/dota/api/match.rb
 - lib/dota/api/match/player.rb
 - lib/dota/configuration.rb
 - lib/dota/utils/inspect.rb
 - lib/dota/version.rb
+- spec/dota/api/hero_spec.rb
 - spec/dota/api/item_spec.rb
 - spec/dota/api/match/player_spec.rb
 - spec/dota/api/match_spec.rb
@@ -191,6 +193,7 @@ signing_key:
 specification_version: 4
 summary: Ruby client for the Dota 2 WebAPI
 test_files:
+- spec/dota/api/hero_spec.rb
 - spec/dota/api/item_spec.rb
 - spec/dota/api/match/player_spec.rb
 - spec/dota/api/match_spec.rb