steam-condenser 1.1.0 → 1.2.0

data/lib/steam/community/css/css_weapon.rb

@@ -32,16 +32,16 @@ class CSSWeapon
   # given XML data
   #
   # @param [String] weapon_name The name of the weapon
-  # @param [REXML::Element] weapons_data The XML data of all weapons
+  # @param [Hash<String, Object>] weapons_data The XML data of all weapons
   def initialize(weapon_name, weapons_data)
     @name     = weapon_name
 
-    @favorite = (weapons_data.elements['favorite'].text == @name)
-    @kills    = weapons_data.elements["#{@name}_kills"].text.to_i
+    @favorite = (weapons_data['favorite'] == @name)
+    @kills    = weapons_data["#{@name}_kills"].to_i
 
     if @name != 'grenade' && @name != 'knife'
-      @hits     = weapons_data.elements["#{@name}_hits"].text.to_i
-      @shots    = weapons_data.elements["#{@name}_shots"].text.to_i
+      @hits     = weapons_data["#{@name}_hits"].to_i
+      @shots    = weapons_data["#{@name}_shots"].to_i
     end
   end
 

data/lib/steam/community/defense_grid/defense_grid_stats.rb

@@ -130,30 +130,30 @@ class DefenseGridStats < GameStats
     super(steam_id, 'defensegrid:awakening')
 
     if public?
-      general_data = @xml_data.elements['stats/general']
-
-      @bronze_medals           = general_data.elements['bronze_medals_won/value'].text.to_i
-      @silver_medals           = general_data.elements['silver_medals_won/value'].text.to_i
-      @gold_medals             = general_data.elements['gold_medals_won/value'].text.to_i
-      @levels_played           = general_data.elements['levels_played_total/value'].text.to_i
-      @levels_played_campaign  = general_data.elements['levels_played_campaign/value'].text.to_i
-      @levels_played_challenge = general_data.elements['levels_played_challenge/value'].text.to_i
-      @levels_won              = general_data.elements['levels_won_total/value'].text.to_i
-      @levels_won_campaign     = general_data.elements['levels_won_campaign/value'].text.to_i
-      @levels_won_challenge    = general_data.elements['levels_won_challenge/value'].text.to_i
-      @encountered             = general_data.elements['total_aliens_encountered/value'].text.to_i
-      @killed                  = general_data.elements['total_aliens_killed/value'].text.to_i
-      @killed_campaign         = general_data.elements['total_aliens_killed_campaign/value'].text.to_i
-      @killed_challenge        = general_data.elements['total_aliens_killed_challenge/value'].text.to_i
-      @resources               = general_data.elements['resources_recovered/value'].text.to_i
-      @heat_damage             = general_data.elements['heatdamage/value'].text.to_f
-      @time_played             = general_data.elements['time_played/value'].text.to_f
-      @interest                = general_data.elements['interest_gained/value'].text.to_f
-      @damage_done             = general_data.elements['tower_damage_total/value'].text.to_f
-      @damage_campaign         = general_data.elements['tower_damage_total_campaign/value'].text.to_f
-      @damage_challenge        = general_data.elements['tower_damage_total_challenge/value'].text.to_f
-      @orbital_laser_fired     = @xml_data.elements['stats/orbitallaser/fired/value'].text.to_i
-      @orbital_laser_damage    = @xml_data.elements['stats/orbitallaser/damage/value'].text.to_f
+      general_data = @xml_data['stats']['general']
+
+      @bronze_medals           = general_data['bronze_medals_won']['value'].to_i
+      @silver_medals           = general_data['silver_medals_won']['value'].to_i
+      @gold_medals             = general_data['gold_medals_won']['value'].to_i
+      @levels_played           = general_data['levels_played_total']['value'].to_i
+      @levels_played_campaign  = general_data['levels_played_campaign']['value'].to_i
+      @levels_played_challenge = general_data['levels_played_challenge']['value'].to_i
+      @levels_won              = general_data['levels_won_total']['value'].to_i
+      @levels_won_campaign     = general_data['levels_won_campaign']['value'].to_i
+      @levels_won_challenge    = general_data['levels_won_challenge']['value'].to_i
+      @encountered             = general_data['total_aliens_encountered']['value'].to_i
+      @killed                  = general_data['total_aliens_killed']['value'].to_i
+      @killed_campaign         = general_data['total_aliens_killed_campaign']['value'].to_i
+      @killed_challenge        = general_data['total_aliens_killed_challenge']['value'].to_i
+      @resources               = general_data['resources_recovered']['value'].to_i
+      @heat_damage             = general_data['heatdamage']['value'].to_f
+      @time_played             = general_data['time_played']['value'].to_f
+      @interest                = general_data['interest_gained']['value'].to_f
+      @damage_done             = general_data['tower_damage_total']['value'].to_f
+      @damage_campaign         = general_data['tower_damage_total_campaign']['value'].to_f
+      @damage_challenge        = general_data['tower_damage_total_challenge']['value'].to_f
+      @orbital_laser_fired     = @xml_data['stats']['orbitallaser']['fired']['value'].to_i
+      @orbital_laser_damage    = @xml_data['stats']['orbitallaser']['damage']['value'].to_f
     end
   end
 
@@ -168,15 +168,15 @@ class DefenseGridStats < GameStats
     return unless public?
 
     if @alien_stats.nil?
-      alien_data = @xml_data.elements['stats/aliens']
+      alien_data = @xml_data['stats']['aliens']
       @alien_stats = {}
       aliens = %w{swarmer juggernaut crasher spire grunt bulwark drone manta dart
                   decoy rumbler seeker turtle walker racer stealth}
 
       aliens.each do |alien|
         @alien_stats[alien] = [
-          alien_data.elements["#{alien}/encountered/value"].text.to_i,
-          alien_data.elements["#{alien}/killed/value"].text.to_i
+          alien_data[alien]['encountered']['value'].to_i,
+          alien_data[alien]['killed']['value'].to_i
         ]
       end
     end
@@ -200,33 +200,34 @@ class DefenseGridStats < GameStats
     return unless public?
 
     if @tower_stats.nil?
-      tower_data = @xml_data.elements['stats/towers']
+      tower_data = @xml_data['stats']['towers']
       @tower_stats = {}
       towers = %w{cannon flak gun inferno laser meteor missile tesla}
 
       towers.each do |tower|
         @tower_stats[tower] = {}
         (1..3).each do |i|
+          tower_level = tower_data[tower].detect { |t| t['level'].to_i == i }
           @tower_stats[tower][i] = [
-            tower_data.elements["#{tower}[@level=#{i}]/built/value"].text.to_i,
-            tower_data.elements["#{tower}[@level=#{i}]/damage/value"].text.to_f
+            tower_level['built']['value'].to_i,
+            tower_level['damage']['value'].to_f
           ]
         end
       end
 
       @tower_stats['command'] = {}
       (1..3).each do |i|
+        tower_level = tower_data['command'].detect { |t| t['level'].to_i == i }
         @tower_stats['command'][i] = [
-          tower_data.elements["command[@level=#{i}]/built/value"].text.to_i,
-          tower_data.elements["command[@level=#{i}]/resource/value"].text.to_f
+          tower_level['built']['value'].to_i,
+          tower_level['resource']['value'].to_f
         ]
       end
 
       @tower_stats['temporal'] = {}
       (1..3).each do |i|
-        @tower_stats['temporal'][i] = [
-          tower_data.elements["temporal[@level=#{i}]/built/value"].text.to_i,
-        ]
+        tower_level = tower_data['temporal'].detect { |t| t['level'].to_i == i }
+        @tower_stats['temporal'][i] = [ tower_level['built']['value'].to_i ]
       end
     end
 

data/lib/steam/community/dods/dods_class.rb

@@ -70,21 +70,21 @@ class DoDSClass
   # Creates a new instance of a Day of Defeat: Source class based on the given
   # XML data
   #
-  # @param [REXML::Element] class_data The XML data of the class
+  # @param [Hash<String, Object>] class_data The XML data of the class
   def initialize(class_data)
-    @blocks        = class_data.elements['blocks'].text.to_i
-    @bombs_defused = class_data.elements['bombsdefused'].text.to_i
-    @bombs_planted = class_data.elements['bombsplanted'].text.to_i
-    @captures      = class_data.elements['captures'].text.to_i
-    @deaths        = class_data.elements['deaths'].text.to_i
-    @dominations   = class_data.elements['dominations'].text.to_i
-    @key           = class_data.attributes['key']
-    @kills         = class_data.elements['kills'].text.to_i
-    @name          = class_data.elements['name'].text
-    @play_time     = class_data.elements['playtime'].text.to_i
-    @rounds_lost   = class_data.elements['roundslost'].text.to_i
-    @rounds_won    = class_data.elements['roundswon'].text.to_i
-    @revenges      = class_data.elements['revenges'].text.to_i
+    @blocks        = class_data['blocks'].to_i
+    @bombs_defused = class_data['bombsdefused'].to_i
+    @bombs_planted = class_data['bombsplanted'].to_i
+    @captures      = class_data['captures'].to_i
+    @deaths        = class_data['deaths'].to_i
+    @dominations   = class_data['dominations'].to_i
+    @key           = class_data['key']
+    @kills         = class_data['kills'].to_i
+    @name          = class_data['name']
+    @play_time     = class_data['playtime'].to_i
+    @rounds_lost   = class_data['roundslost'].to_i
+    @rounds_won    = class_data['roundswon'].to_i
+    @revenges      = class_data['revenges'].to_i
   end
 
 end

data/lib/steam/community/dods/dods_stats.rb

@@ -3,6 +3,7 @@
 #
 # Copyright (c) 2009-2011, Sebastian Staudt
 
+require 'steam/community/dods/dods_class'
 require 'steam/community/dods/dods_weapon'
 require 'steam/community/game_stats'
 
@@ -31,8 +32,8 @@ class DoDSStats < GameStats
 
     if @class_stats.nil?
       @class_stats = {}
-      @xml_data.elements.each('stats/classes/class') do |class_data|
-        @class_stats[class_data.attributes['key']] = DoDSClass.new class_data
+      @xml_data['stats']['classes']['class'].each do |class_data|
+        @class_stats[class_data['key']] = DoDSClass.new class_data
       end
     end
 
@@ -49,8 +50,8 @@ class DoDSStats < GameStats
 
     if @weapon_stats.nil?
       @weapon_stats = {}
-      @xml_data.elements.each('stats/weapons/weapon') do |weapon_data|
-        @weapon_stats[weapon_data.attributes['key']] = DoDSWeapon.new(weapon_data)
+      @xml_data['stats']['weapons']['weapon'].each do |weapon_data|
+        @weapon_stats[weapon_data['key']] = DoDSWeapon.new weapon_data
       end
     end
 

data/lib/steam/community/dods/dods_weapon.rb

@@ -30,15 +30,15 @@ class DoDSWeapon
   # Creates a new instance of a Day of Defeat: Source weapon based on the
   # given XML data
   #
-  # @param [REXML::Element] weapon_data The XML data of the class
+  # @param [Hash<String, Object>] weapon_data The XML data of the class
   def initialize(weapon_data)
     super weapon_data
 
-    @headshots = weapon_data.elements['headshots'].text.to_i
-    @id        = weapon_data.attributes['key']
-    @name      = weapon_data.elements['name'].text
-    @shots     = weapon_data.elements['shotsfired'].text.to_i
-    @hits      = weapon_data.elements['shotshit'].text.to_i
+    @headshots = weapon_data['headshots'].to_i
+    @id        = weapon_data['key']
+    @name      = weapon_data['name']
+    @shots     = weapon_data['shotsfired'].to_i
+    @hits      = weapon_data['shotshit'].to_i
   end
 
   # Returns the average number of hits needed for a kill with this weapon

data/lib/steam/community/game_achievement.rb

@@ -1,7 +1,7 @@
 # This code is free software; you can redistribute it and/or modify it under
 # the terms of the new BSD License.
 #
-# Copyright (c) 2008-2011, Sebastian Staudt
+# Copyright (c) 2008-2012, Sebastian Staudt
 
 require 'multi_json'
 
@@ -21,32 +21,41 @@ class GameAchievement
   # @return [String] The API name of this achievement
   attr_reader :api_name
 
-  # Return the unique Steam Application ID of the  game this achievement
-  # belongs to
-  #
-  # @return [Fixnum] The Steam Application ID of this achievement's game
-  attr_reader :app_id
-
   # Returns the description of this achievement
   #
   # @return [String] The description of this achievement
   attr_reader :description
 
+  # Return the game this achievement belongs to
+  #
+  # @return [Steam] The game this achievement belongs to
+  attr_reader :game
+
+  # Returns the url for the closed icon of this achievement
+  #
+  # @return [String] The url of the closed achievement icon
+  attr_reader :icon_closed_url
+
+  # Returns the url for the open icon of this achievement
+  #
+  # @return [String] The url of the open achievement icon
+  attr_reader :icon_open_url
+
   # Returns the name of this achievement
   #
   # @return [String] The name of this achievement
   attr_reader :name
 
-  # Returns the 64bit SteamID of the user who owns this achievement
-  #
-  # @return [Fixnum] The 64bit SteamID of this achievement's owner
-  attr_reader :steam_id64
-
   # Returns the time this achievement has been unlocked by its owner
   #
   # @return [Time] The time this achievement has been unlocked
   attr_reader :timestamp
 
+  # Returns the SteamID of the user who owns this achievement
+  #
+  # @return [Fixnum] The SteamID of this achievement's owner
+  attr_reader :user
+
   # Loads the global unlock percentages of all achievements for the game with
   # the given Steam Application ID
   #
@@ -61,7 +70,7 @@ class GameAchievement
     percentages = {}
 
     data = WebApi.json('ISteamUserStats', 'GetGlobalAchievementPercentagesForApp', 2, { :gameid => app_id })
-    MultiJson.decode(data, { :symbolize_keys => true })[:achievementpercentages][:achievements].each do |percentage|
+    MultiJson.load(data, { :symbolize_keys => true })[:achievementpercentages][:achievements].each do |percentage|
       percentages[percentage[:name].to_sym] = percentage[:percent]
     end
 
@@ -71,24 +80,22 @@ class GameAchievement
   # Creates the achievement with the given name for the given user and game
   # and achievement data
   #
-  # @param [Fixnum] steam_id64 The 64bit SteamID of the player this achievement
-  #        belongs to
-  # @param [Fixnum] app_id The unique Steam Application ID of the game (e.g.
-  #        `440` for Team Fortress 2). See
-  #        http://developer.valvesoftware.com/wiki/Steam_Application_IDs for
-  #        all application IDs
-  # @param [REXML::Element] achievement_data The achievement data extracted
-  #        from XML
-  def initialize(steam_id64, app_id, achievement_data)
-    @api_name    = achievement_data.elements['apiname'].text
-    @app_id      = app_id
-    @description = achievement_data.elements['description'].text
-    @name        = achievement_data.elements['name'].text
-    @steam_id64  = steam_id64
-    @unlocked    = (achievement_data.attributes['closed'].to_i == 1)
-
-    if @unlocked && !achievement_data.elements['unlockTimestamp'].nil?
-      @timestamp  = Time.at(achievement_data.elements['unlockTimestamp'].text.to_i)
+  # @param [SteamId] user The SteamID of the player this achievement belongs to
+  # @param [SteamGame] game The game this achievement belongs to
+  # @param [Hash<String, Object>] achievement_data The achievement data
+  #        extracted from XML
+  def initialize(user, game, achievement_data)
+    @api_name        = achievement_data['apiname']
+    @description     = achievement_data['description']
+    @game            = game
+    @icon_closed_url = achievement_data['iconClosed']
+    @icon_open_url   = achievement_data['iconOpen']
+    @name            = achievement_data['name']
+    @unlocked        = (achievement_data['closed'].to_i == 1)
+    @user            = user
+
+    if @unlocked && !achievement_data['unlockTimestamp'].nil?
+      @timestamp  = Time.at(achievement_data['unlockTimestamp'].to_i)
     end
   end
 

data/lib/steam/community/game_inventory.rb

@@ -1,7 +1,7 @@
 # This code is free software; you can redistribute it and/or modify it under
 # the terms of the new BSD License.
 #
-# Copyright (c) 2011, Sebastian Staudt
+# Copyright (c) 2011-2012, Sebastian Staudt
 
 require 'steam/community/cacheable'
 require 'steam/community/game_item'
@@ -17,10 +17,10 @@ module GameInventory
   # @return [Array<GameItem>] All items in the backpack
   attr_reader :items
 
-  # Returns the 64bit SteamID of the player owning this inventory
+  # Returns the Steam ID of the player owning this inventory
   #
-  # @return [String] The 64bit SteamID
-  attr_reader :steam_id64
+  # @return [SteamId] The Steam ID of the owner of this inventory
+  attr_reader :user
 
   @@attribute_schema = {}
 
@@ -45,7 +45,7 @@ module GameInventory
   #        inventory for
   # @param [Boolean] fetch_now if `true` the data will be fetched immediately
   def initialize(steam_id64, fetch_now = true)
-    @steam_id64 = steam_id64
+    @user = SteamId.new steam_id64, false
 
     super fetch_now
   end
@@ -80,7 +80,7 @@ module GameInventory
 
   # Updates the contents of the inventory using Steam Web API
   def fetch
-    result = WebApi.json!("IEconItems_#{app_id}", 'GetPlayerItems', 1, { :SteamID => @steam_id64 })
+    result = WebApi.json!("IEconItems_#{app_id}", 'GetPlayerItems', 1, { :SteamID => @user.steam_id64 })
     item_class = self.class.send :class_variable_get, :@@item_class
 
     @items = []

data/lib/steam/community/game_leaderboard.rb

@@ -1,10 +1,12 @@
 # This code is free software; you can redistribute it and/or modify it under
 # the terms of the new BSD License.
 #
-# Copyright (c) 2011, Sebastian Staudt
+# Copyright (c) 2011-2012, Sebastian Staudt
 
-require 'steam/community/game_leaderboard_entry';
-require 'steam/community/steam_id';
+require 'multi_xml'
+
+require 'steam/community/game_leaderboard_entry'
+require 'steam/community/steam_id'
 
 # The GameLeaderboard class represents a single leaderboard for a specific game
 #
@@ -84,14 +86,14 @@ class GameLeaderboard
   def entry_for_steam_id(steam_id)
     steam_id = steam_id.steam_id64 if steam_id.is_a? SteamId
 
-    url = "#{@url}&steamid=#{steam_id}"
-    xml = REXML::Document.new(open(url, {:proxy => true}).read).root
+    url = "#@url&steamid=#{steam_id}"
+    xml_data = MultiXml.parse(open(url, {:proxy => true})).values.first
 
-    error = @xml_data.elements['error']
-    raise SteamCondenserError, error.text unless error.nil?
+    error = xml_data['error']
+    raise SteamCondenserError, error unless error.nil?
 
-    boards_data.elements.each('entries/entry') do |entry_data|
-      if entry_data.elements['steamid'].text.to_i == steam_id
+    xml_data['entries']['entry'].each do |entry_data|
+      if entry_data['steamid'].to_i == steam_id
         return GameLeaderboardEntry.new entry_data, self
       end
     end
@@ -111,15 +113,15 @@ class GameLeaderboard
   def entry_for_steam_id_friends(steam_id)
     steam_id = steam_id.steam_id64 if steam_id.is_a? SteamId
 
-    url = "#{@url}&steamid=#{steam_id}"
-    xml = REXML::Document.new(open(url, {:proxy => true}).read).root
+    url = "#@url&steamid=#{steam_id}"
+    xml_data = MultiXml.parse(open(url, {:proxy => true})).values.first
 
-    error = @xml_data.elements['error']
-    raise SteamCondenserError, error.text unless error.nil?
+    error = xml_data['error']
+    raise SteamCondenserError, error unless error.nil?
 
     entries = []
-    boards_data.elements.each('entries/entry') do |entry_data|
-      rank = entry_data.elements['rank'].text.to_i
+    xml_data['entries']['entry'].each do |entry_data|
+      rank = entry_data['rank'].to_i
       entries[rank] = GameLeaderboardEntry.new entry_data, self
     end
 
@@ -148,15 +150,15 @@ class GameLeaderboard
         'Leaderboard entry lookup is currently limited to a maximum of 5001 entries per request.'
     end
 
-    url = "#{@url}&start=#{first}&end=#{last}"
-    xml = REXML::Document.new(open(url, {:proxy => true}).read).root
+    url = "#@url&start=#{first}&end=#{last}"
+    xml_data = MultiXml.parse(open(url, {:proxy => true})).values.first
 
-    error = @xml_data.elements['error']
-    raise SteamCondenserError, error.text unless error.nil?
+    error = xml_data['error']
+    raise SteamCondenserError, error unless error.nil?
 
     entries = []
-    boards_data.elements.each('entries/entry') do |entry_data|
-      rank = entry_data.elements['rank'].text.to_i
+    xml_data['entries']['entry'].each do |entry_data|
+      rank = entry_data['rank'].to_i
       entries[rank] = GameLeaderboardEntry.new entry_data, self
     end
 
@@ -167,14 +169,14 @@ class GameLeaderboard
 
   # Creates a new leaderboard instance with the given XML data
   #
-  # @param [REXML::Element] board_data The XML data of the leaderboard
+  # @param [Hash<String, Object>] board_data The XML data of the leaderboard
   def initialize(board_data)
-    @url          = board_data.elements['url'].text
-    @id           = board_data.elements['lbid'].text.to_i
-    @name         = board_data.elements['name'].text
-    @entry_count  = board_data.elements['entries'].text.to_i
-    @sort_method  = board_data.elements['sortmethod'].text.to_i
-    @display_type = board_data.elements['displaytype'].text.to_i
+    @url          = board_data['url']
+    @id           = board_data['lbid'].to_i
+    @name         = board_data['name']
+    @entry_count  = board_data['entries'].to_i
+    @sort_method  = board_data['sortmethod'].to_i
+    @display_type = board_data['displaytype'].to_i
   end
 
   # Loads the leaderboards of the specified games into the cache
@@ -184,13 +186,13 @@ class GameLeaderboard
   #         leaderboards
   def self.load_leaderboards(game_name)
     url = "http://steamcommunity.com/stats/#{game_name}/leaderboards/?xml=1"
-    boards_data = REXML::Document.new(open(url, {:proxy => true}).read).root
+    boards_data = MultiXml.parse(open(url, {:proxy => true})).values.first
 
-    error = boards_data.elements['error']
-    raise SteamCondenserError, error.text unless error.nil?
+    error = boards_data['error']
+    raise SteamCondenserError, error unless error.nil?
 
     @@leaderboards[game_name] = []
-    boards_data.elements.each('leaderboard') do |board_data|
+    boards_data['leaderboard'].each do |board_data|
       leaderboard = GameLeaderboard.new board_data
       @@leaderboards[game_name][leaderboard.id] = leaderboard
     end