dota_api_wrapper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f788517f93d09fac1b53caf832e09c5deccda09e
-  data.tar.gz: 55d1ae53567bf03693d912e44e7c61122bc17d5d
+  metadata.gz: 4f5b3571fc32ce22d011e8822aa52318e5204ec5
+  data.tar.gz: 26825239df53069c99b5004270666f93aed04497
 SHA512:
-  metadata.gz: a6a10073798c17e9be4445b3f8a2eb212b1869eb2150efd81a7c7c271df9510cd1fda0db0537e8d50150601213cd104b28c31af954064d38c2aa72512f3261a8
-  data.tar.gz: 92d2f65b6dd277d32eb86310c5946902d5a7574d9720a780a89f89fb487060d1df9930afa19db942cabb32fe2705d17eedd17e3d05e84697d2cd1d0d46ffa783
+  metadata.gz: 00e287952b9f15cba499a43b5d969cb2d9f868810aaed1298d67da9280d19dfe5c920d2695dd24d35ab0d1b0b1f7093fb0282ceffae5812b7fdf74bd26cd4934
+  data.tar.gz: 588f8098d0bdc5985afd939ce9d84ea46136dbe4137e1db6c41d9ad09dbd9d5551710a458720a073854b5fe5affe4bc54d55968836541da2d1967b8c521c0201

data/README.md

@@ -36,6 +36,68 @@ This gem will read your key from an environment variable, so once you have it yo
 
 `heroes.find_by_id(25) => {"name"=>"npc_dota_hero_lina", "id"=>25, "localized_name"=>"Lina"}`
 
+### Items
+
+`items = DotaApiWrapper::Item.new`
+
+`items.find_by_id(25) => {"id"=>25, "name"=>"item_gloves", "cost"=>500, "secret_shop"=>0, "side_shop"=>1, "recipe"=>0, "localized_name"=>"Gloves of Haste"}`
+
+### Steam User's Summary
+
+To get all the information of a player you need its 64bits account ID.
+
+`player = DotaApiWrapper::Player.new(76561197997499174)`
+
+Then the first time you access one of its attributes, all the information of the player will be fetched from the API.
+
+Player object has the following information available:
+
+    {
+      "steamid"=>"76561197997499174",
+      "communityvisibilitystate"=>3,
+      "profilestate"=>1,
+      "personaname"=>"Kazooie",
+      "lastlogoff"=>1458409407,
+      "commentpermission"=>1,
+      "profileurl"=>"http://steamcommunity.com/id/fdzatone/",
+      "avatar"=>"https://steamcdn-a.akamaihd.net/steamcommunity/public/ima  ges/avatars/fa/fa3c7d96ba6f8dc9d7b0820befcd83d53bb3208a.jpg",
+      "avatarmedium"=>"https://steamcdn-a.akamaihd.net/steamcommunity/publ  ic/images/avatars/fa/fa3c7d96ba6f8dc9d7b0820befcd83d53bb3208a_medium  .jpg",
+      "avatarfull"=>"https://steamcdn-a.akamaihd.net/steamcommunity/public  /images/avatars/fa/fa3c7d96ba6f8dc9d7b0820befcd83d53bb3208a_full.jpg  ",
+      "personastate"=>0,
+      "primaryclanid"=>"103582791431066484",
+      "timecreated"=>1206223343,
+      "personastateflags"=>0,
+      "loccountrycode"=>"ES",
+      "locstatecode"=>"51"
+    }
+
+You can access every attribute method-like, for example:
+
+    player.personaname => 'Kazooie'
+
+### Matches
+
+You can query the API in search of the collection of matches you need. For that purpose you can use the method `get_matches` of `DotaApiWrapper::Match` class.
+
+    api_result = DotaApiWrapper::Match.get_matches
+
+`get_matches` Accepts the following options:
+
+    hero_id=<id>                   # Matches with a specific hero
+    game_mode=<mode>               # Matches of a given mode
+    skill=<skill>                  # 0 for any, 1 for normal, 2 for high, 3 for very high skill (default is 0)
+    min_players=<count>            # Minimum number of player
+    account_id=<id>                # Search matches of the given ID (32-bit or 64-bit steam ID)
+    league_id=<id>                 # Matches of a league
+    start_at_match_id=<id>         # Start the search at the indicated match id, descending
+    matches_requested=<n>          # Maximum is 25 matches (default is 100)
+    tournament_games_only=<string> # Set to only show tournament games
+
+Once you have your collection of matches you can instantiate a `Match` object to work with it.
+
+    match = DotaApiWrapper::Match.new(api_result['matches'].first)
+    match.radiant_win => true
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests. You can also run `rake console` for an interactive prompt that will allow you to experiment.

data/lib/dota_api_wrapper/base.rb

@@ -8,5 +8,10 @@ module DotaApiWrapper
     def get(uri, options)
       self.class.get(uri, options)
     end
+
+    def self.retrieve_info(action, options = {})
+      query_params = { 'key' => API_KEY }.merge(options)
+      get(action, query: query_params, headers: {})
+    end
   end
 end

data/lib/dota_api_wrapper/match.rb

@@ -0,0 +1,43 @@
+require_relative 'base'
+
+module DotaApiWrapper
+  class Match < Base
+    base_uri(BASE_URI + '/IDOTA2Match_570')
+
+    attr_accessor :match_info
+    attr_accessor :match_details
+
+    def initialize(match_info)
+      match_info.delete('players')
+      @match_info = match_info
+    end
+
+    # If the parameter name exists in the hash, it will be returned
+    # In other case in will raise an exception 'NoMethodError'
+    def method_missing(name, *args, &block)
+      if match_info.key?(name.to_s)
+        match_info[name.to_s]
+      elsif match_details.key?(name.to_s)
+        match_details[name.to_s]
+      else
+        super
+      end
+    end
+
+    def match_details
+      @match_details ||= retrieve_details
+    end
+
+    def self.get_matches(options = {})
+      api_result = retrieve_info('/GetMatchHistory/V001', options)
+      return api_result['result'] unless api_result.empty?
+    end
+
+    private
+
+    def retrieve_details
+      api_result = self.class.retrieve_info('/GetMatchDetails/V001', match_id: match_id)
+      return api_result['result'] unless api_result.empty?
+    end
+  end
+end

data/lib/dota_api_wrapper/version.rb

@@ -1,3 +1,3 @@
 module DotaApiWrapper
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dota_api_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Eloy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-13 00:00:00.000000000 Z
+date: 2016-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -144,6 +144,7 @@ files:
 - lib/dota_api_wrapper/econ.rb
 - lib/dota_api_wrapper/hero.rb
 - lib/dota_api_wrapper/item.rb
+- lib/dota_api_wrapper/match.rb
 - lib/dota_api_wrapper/player.rb
 - lib/dota_api_wrapper/version.rb
 homepage: ''
@@ -166,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: Wrapper for Valve's DOTA 2 API.