dota 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adb79effd365cfddfeccab6653bc8ebeaa17b448
-  data.tar.gz: 866ea82ef3fb0f8e44e053c6bbcb4b4912d226c2
+  metadata.gz: 6c0e4caa6d634db5ba4d35b82acb4582384ce963
+  data.tar.gz: c1a00ca1d4afc08dfc37b2ab80e5fa18695720f8
 SHA512:
-  metadata.gz: 1628d277437c89febddd92971c60284e4617eb04eb3a9cc50f9f235fe7b5572b7ab96ff996a0c11967e91eb3888c3fc673e5b18fe9d35c07801f4d2c2fc34738
-  data.tar.gz: f0d9529ab46fa3adc765faa8df0c455857c910d3d3867c60110c5bcd11247370514d847a6d6fdad7b5d7bd0c3f4e87720c1b2994cb60acb7bb8b52107e69daf1
+  metadata.gz: 91426673b41ecbebdb84a66d640b9d46debf98206d4b6686080717a67678d6eeca155cd26e39aab9d0042cd484bcbadd8ca6cd1111ed294ddbefb073dad0beb2
+  data.tar.gz: aa2c2e18dea696d7be459fb45ab89fd0ec3182c54bf18812ef1d0b57196a2c58fce9ce9662a773c68cab751b5800ca0e7ed482b3129a9c6c5a8486dffbf03536

data/README.md

@@ -1,36 +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).
 
-Currently supported endpoints:
+## Requests
 
-- [GetLeagueListing](https://wiki.teamfortress.com/wiki/WebAPI/GetLeagueListing)
-- [GetMatchDetails](https://wiki.teamfortress.com/wiki/WebAPI/GetMatchDetails)
-- [GetMatchHistory](https://wiki.teamfortress.com/wiki/WebAPI/GetMatchHistory)
-- [GetFriendList](https://wiki.teamfortress.com/wiki/WebAPI/GetFriendList)
-- [GetHeroes](https://wiki.teamfortress.com/wiki/WebAPI/GetHeroes)
-- 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)
-- [GetScheduledLeagueGames](https://wiki.teamfortress.com/wiki/WebAPI/GetScheduledLeagueGames)
-
-Unsupported endpoints can still be queried via [custom requests](#custom-requests).
+Valve provides a `GetSupportedAPIList` endpoint that returns all the available endpoints in their API you can use, along with the parameters they accept. The following are supported by `dota`:
 
-This gem is in alpha, keep that in mind when upgrading.
-
-## TODO
+- GetLeagueListing
+- GetMatchDetails
+- GetMatchHistory
+- GetFriendList
+- GetHeroes
+- GetGameItems
+- GetRarities
+- GetTeamInfoByTeamID
+- GetLiveLeagueGames
+- GetScheduledLeagueGames
 
-- Support for more endpoints
-  - [GetMatchHistoryBySequenceNum](https://wiki.teamfortress.com/wiki/WebAPI/GetMatchHistoryBySequenceNum)
-  - [GetPlayerSummaries](https://wiki.teamfortress.com/wiki/WebAPI/GetPlayerSummaries)
-  - [GetTournamentPlayerStats](https://wiki.teamfortress.com/wiki/WebAPI/GetTournamentPlayerStats)
-  - [GetTournamentPrizePool](https://wiki.teamfortress.com/wiki/WebAPI/GetTournamentPrizePool)
-- 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.
+Unsupported endpoints (including `GetSupportedAPIList`) can still be queried via [custom requests](#custom-requests) using `Dota.api.get`.
 
 ## Installation
 
@@ -50,13 +37,15 @@ Or install it yourself as:
 
 ## Usage
 
+Get your Steam API key [here](http://steamcommunity.com/dev/apikey) and make sure the gem is configured to use it. If you're using Rails, this might go in an initializer like `config/initializers/dota.rb`.
+
 ```ruby
 Dota.configure do |config|
   config.api_key = ENV.fetch("STEAM_API_KEY")
 end
 ```
 
-Get your Steam API key [here](http://steamcommunity.com/dev/apikey).
+Then use the client:
 
 ```ruby
 api = Dota.api
@@ -216,7 +205,7 @@ live_match.roshan_timer     # Integer, Seconds until Roshan respawns
 #### Scheduled Matches
 
 ```ruby
-scheduled_match.league_id   # Integer, ID of the league 
+scheduled_match.league_id   # Integer, ID of the league
 scheduled_match.game_id     # Integer, ID of the game
 scheduled_match.teams       # Array[Dota::API::Team], List of teams who are playing each other
 scheduled_match.starts_at   # Time, When the match is scheduled to start
@@ -292,10 +281,14 @@ friend.relationship # String, Relation to the player
 friend.made_at      # Time, When the friend was added to the player's friend list
 ```
 
-## Contributing
+## Resources
+
+- [Dota 2 WebAPI Wiki](https://wiki.teamfortress.com/wiki/WebAPI#Dota_2) (wiki.teamfortress.com)
+- [Dota 2 WebAPI Forums](http://dev.dota2.com/forumdisplay.php?f=411) (dev.dota2.com)
+- [MuppetMaster42's "Things You Should Know Before Starting API Development"](http://dev.dota2.com/showthread.php?t=58317) (dev.dota2.com)
+
+## License
+
+Copyright © Vinni Carlo Caños
 
-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`)
-5. Create a new Pull Request
+Distributed under the [MIT License](http://www.opensource.org/licenses/MIT).

data/data/{heroes.yml → hero.yml}

@@ -325,3 +325,6 @@
 111:
   - oracle
   - Oracle
+112:
+  - winter_wyvern
+  - Winter Wyvern

data/lib/dota.rb

@@ -3,7 +3,8 @@ require 'yaml'
 require 'dota/configuration'
 require 'dota/version'
 
-require 'dota/utils/inspect'
+require 'dota/utils/mapped'
+require 'dota/utils/inspectable'
 
 require 'dota/api/entity'
 
@@ -40,5 +41,9 @@ module Dota
     def configuration
       api.configuration
     end
+
+    def root
+      Gem::Specification.find_by_name("dota").gem_dir
+    end
   end
 end

data/lib/dota/api/hero.rb

@@ -1,18 +1,14 @@
 module Dota
   module API
     class Hero
-      MAPPING = YAML.load_file("data/heroes.yml").freeze
+      include Utilities::Mapped
 
       attr_reader :id, :name
 
-      def self.all
-        @all ||= MAPPING.keys.map { |id| new(id) }
-      end
-
       def initialize(id)
         @id = id
-        @internal_name = MAPPING[id][0]
-        @name = MAPPING[id][1]
+        @internal_name = mapping[id][0]
+        @name = mapping[id][1]
       end
 
       def image_url(type = :full)

data/lib/dota/api/item.rb

@@ -1,18 +1,14 @@
 module Dota
   module API
     class Item
-      MAPPING = YAML.load_file("data/items.yml").freeze
+      include Utilities::Mapped
 
       attr_reader :id, :name
 
-      def self.all
-        MAPPING.keys.map { |id| new(id) }
-      end
-
       def initialize(id)
         @id = id
-        @internal_name = MAPPING[id][0]
-        @name = MAPPING[id][1]
+        @internal_name = mapping[id][0]
+        @name = mapping[id][1]
       end
 
       def image_url(type = :lg)

data/lib/dota/utils/mapped.rb

@@ -0,0 +1,29 @@
+module Dota
+  module Utilities
+    module Mapped
+      def self.included(base)
+        base.extend ClassMethods
+
+        base.class_eval do
+          def mapping
+            self.class.mapping
+          end
+        end
+      end
+
+      module ClassMethods
+        def mapping
+          @mapping ||= begin
+            filename = "#{name.split("::").last.downcase}.yml"
+            path = File.join(Dota.root, "data", filename)
+            YAML.load_file(path).freeze
+          end
+        end
+
+        def all
+          @all ||= mapping.keys.map { |id| new(id) }
+        end
+      end
+    end
+  end
+end

data/lib/dota/version.rb

@@ -1,3 +1,3 @@
 module Dota
-  VERSION = "0.0.14"
+  VERSION = "0.0.15"
 end

data/spec/dota/api/hero_spec.rb

@@ -4,7 +4,7 @@ describe Dota::API::Hero do
   specify ".all" do
     heroes = described_class.all
     expect(heroes.first).to be_a described_class
-    expect(heroes.count).to eq 109
+    expect(heroes.count).to eq 110
   end
 
   specify "#id" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dota
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Vinni Carlo Caños
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-12 00:00:00.000000000 Z
+date: 2015-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -152,8 +152,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- data/heroes.yml
-- data/items.yml
+- data/hero.yml
+- data/item.yml
 - dota.gemspec
 - lib/dota.rb
 - lib/dota/api/basic_match.rb
@@ -175,7 +175,8 @@ files:
 - lib/dota/api/scheduled_match.rb
 - lib/dota/api/team.rb
 - lib/dota/configuration.rb
-- lib/dota/utils/inspect.rb
+- lib/dota/utils/inspectable.rb
+- lib/dota/utils/mapped.rb
 - lib/dota/version.rb
 - spec/dota/api/cosmetic/rarity_spec.rb
 - spec/dota/api/friend_spec.rb
@@ -223,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby client for the Dota 2 WebAPI