steam-condenser 1.1.0 → 1.2.0

data/lib/steam/community/steam_id.rb

@@ -1,17 +1,16 @@
 # 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 'cgi'
-require 'open-uri'
-require 'rexml/document'
 
 require 'errors/steam_condenser_error'
 require 'steam/community/cacheable'
 require 'steam/community/game_stats'
 require 'steam/community/steam_game'
 require 'steam/community/steam_group'
+require 'steam/community/xml_data'
 
 # The SteamId class represents a Steam Community profile (also called Steam ID)
 #
@@ -21,6 +20,8 @@ class SteamId
   include Cacheable
   cacheable_with_ids :custom_url, :steam_id64
 
+  include XMLData
+
   # Returns the custom URL of this Steam ID
   #
   # The custom URL is a user specified unique string that can be used instead
@@ -126,6 +127,11 @@ class SteamId
   # @return [String] This user's summary
   attr_reader :summary
 
+  # Returns this user's ban state in Steam's trading system
+  #
+  # @return [String] This user's trading ban state
+  attr_reader :trade_ban_state
+
   # Returns the visibility state of this Steam ID
   #
   # @return [Fixnum] This Steam ID's visibility State
@@ -138,7 +144,7 @@ class SteamId
   #        Community
   # @raise [SteamCondenserError] if the community ID is to small
   # @return [String] The converted SteamID, like `STEAM_0:0:12345`
-  def self.convert_community_id_to_steam_id(community_id)
+  def self.community_id_to_steam_id(community_id)
     steam_id1 = community_id % 2
     steam_id2 = community_id - 76561197960265728
 
@@ -159,7 +165,7 @@ class SteamId
   # @raise [SteamCondenserError] if the SteamID doesn't have the correct
   #        format
   # @return [Fixnum] The converted 64bit numeric SteamID
-  def self.convert_steam_id_to_community_id(steam_id)
+  def self.steam_id_to_community_id(steam_id)
     if steam_id == 'STEAM_ID_LAN' || steam_id == 'BOT'
       raise SteamCondenserError, "Cannot convert SteamID \"#{steam_id}\" to a community ID."
     elsif steam_id.match(/^STEAM_[0-1]:[0-1]:[0-9]+$/).nil?
@@ -171,6 +177,11 @@ class SteamId
     steam_id[1] + steam_id[2] * 2 + 76561197960265728
   end
 
+  class << self
+    alias_method :convert_community_id_to_steam_id, :community_id_to_steam_id
+    alias_method :convert_steam_id_to_community_id, :steam_id_to_community_id
+  end
+
   # Creates a new `SteamId` instance using a SteamID as used on servers
   #
   # The SteamID from the server is converted into a 64bit numeric SteamID first
@@ -192,19 +203,23 @@ class SteamId
   # @param [Boolean] fetch if `true` the Steam ID's data is loaded into the
   #        object
   def initialize(id, fetch = true)
-    begin
-      if id.is_a? Numeric
-        @steam_id64 = id
-      else
-        @custom_url = id.downcase
-      end
-
-      super(fetch)
-    rescue REXML::ParseException
-      raise SteamCondenserError, 'SteamID could not be loaded.'
+    if id.is_a? Numeric
+      @steam_id64 = id
+    else
+      @custom_url = id.downcase
     end
+
+    super fetch
   end
 
+  # Returns whether the owner of this SteamID is VAC banned
+  #
+  # @return [Boolean] `true` if the user has been banned by VAC
+  def banned?
+    @vac_banned
+  end
+  alias_method :is_banned?, :banned?
+
   # Returns the base URL for this Steam ID
   #
   # This URL is different for Steam IDs having a custom URL.
@@ -212,9 +227,9 @@ class SteamId
   # @return [String] The base URL for this SteamID
   def base_url
     if @custom_url.nil?
-      "http://steamcommunity.com/profiles/#{@steam_id64}"
+      "http://steamcommunity.com/profiles/#@steam_id64"
     else
-      "http://steamcommunity.com/id/#{@custom_url}"
+      "http://steamcommunity.com/id/#@custom_url"
     end
   end
 
@@ -225,68 +240,70 @@ class SteamId
   #        when it is private
   # @see Cacheable#fetch
   def fetch
-    profile_url = open(base_url + '?xml=1', {:proxy => true})
-    profile = REXML::Document.new(profile_url.read).root
+    begin
+      profile = parse "#{base_url}?xml=1"
 
-    unless REXML::XPath.first(profile, 'error').nil?
-      raise SteamCondenserError, profile.elements['error'].text
-    end
+      if profile.key? 'error'
+        raise SteamCondenserError, profile['error']
+      end
 
-    unless REXML::XPath.first(profile, 'privacyMessage').nil?
-      raise SteamCondenserError, profile.elements['privacyMessage'].text
-    end
-    
-    begin
-      @nickname         = CGI.unescapeHTML profile.elements['steamID'].text
-      @steam_id64       = profile.elements['steamID64'].text.to_i
-      @vac_banned       = (profile.elements['vacBanned'].text == 1)
-
-      @image_url        = profile.elements['avatarIcon'].text[0..-5]
-      @online_state     = profile.elements['onlineState'].text
-      @privacy_state    = profile.elements['privacyState'].text
-      @state_message    = profile.elements['stateMessage'].text
-      @visibility_state = profile.elements['visibilityState'].text.to_i
-
-      if @privacy_state == 'public'
-        @custom_url                       = profile.elements['customURL'].text.downcase
-        @custom_url                       = nil if @custom_url.empty?
-
-        unless REXML::XPath.first(profile, 'favoriteGame').nil?
-          @favorite_game                  = profile.elements['favoriteGame/name'].text
-          @favorite_game_hours_played     = profile.elements['favoriteGame/hoursPlayed2wk'].text
+      if profile.key? 'privacyMessage'
+        raise SteamCondenserError, profile['privacyMessage']
+      end
+
+      @nickname         = CGI.unescapeHTML profile['steamID']
+      @steam_id64       = profile['steamID64'].to_i
+      @limited          = (profile['isLimitedAccount'].to_i == 1)
+      @trade_ban_state  = profile['tradeBanState']
+      @vac_banned       = (profile['vacBanned'].to_i == 1)
+
+      @image_url        = profile['avatarIcon'][0..-5]
+      @online_state     = profile['onlineState']
+      @privacy_state    = profile['privacyState']
+      @state_message    = profile['stateMessage']
+      @visibility_state = profile['visibilityState'].to_i
+
+      if public?
+        @custom_url = profile['customURL'].downcase
+        @custom_url = nil if @custom_url.empty?
+
+        if profile.key? 'favoriteGame'
+          @favorite_game              = profile['favoriteGame']['name']
+          @favorite_game_hours_played = profile['favoriteGame']['hoursPlayed2wk']
         end
 
-        @head_line    = CGI.unescapeHTML profile.elements['headline'].text
-        @hours_played = profile.elements['hoursPlayed2Wk'].text.to_f
-        @location     = profile.elements['location'].text
-        @member_since = Time.parse(profile.elements['memberSince'].text)
-        @real_name    = CGI.unescapeHTML profile.elements['realname'].text
-        @steam_rating = profile.elements['steamRating'].text.to_f
-        @summary      = CGI.unescapeHTML profile.elements['summary'].text
+        @head_line    = CGI.unescapeHTML profile['headline'] || ''
+        @hours_played = profile['hoursPlayed2Wk'].to_f
+        @location     = profile['location']
+        @member_since = Time.parse profile['memberSince']
+        @real_name    = CGI.unescapeHTML profile['realname'] || ''
+        @steam_rating = profile['steamRating'].to_f
+        @summary      = CGI.unescapeHTML profile['summary'] || ''
 
         @most_played_games = {}
-        unless REXML::XPath.first(profile, 'mostPlayedGames').nil?
-          profile.elements.each('mostPlayedGames/mostPlayedGame') do |most_played_game|
-            @most_played_games[most_played_game.elements['gameName'].text] = most_played_game.elements['hoursPlayed'].text.to_f
+        if profile.key? 'mostPlayedGames'
+          [profile['mostPlayedGames']['mostPlayedGame']].flatten.each do |most_played_game|
+            @most_played_games[most_played_game['gameName']] = most_played_game['hoursPlayed'].to_f
           end
         end
 
         @groups = []
-        unless REXML::XPath.first(profile, 'groups').nil?
-          profile.elements.each('groups/group') do |group|
-            @groups << SteamGroup.new(group.elements['groupID64'].text.to_i, false)
+        if profile.key? 'groups'
+          [profile['groups']['group']].flatten.each do |group|
+            @groups << SteamGroup.new(group['groupID64'].to_i, false)
           end
         end
 
         @links = {}
-        unless REXML::XPath.first(profile, 'weblinks').nil?
-          profile.elements.each('weblinks/weblink') do |link|
-            @links[CGI.unescapeHTML link.elements['title'].text] = link.elements['link'].text
+        if profile.key? 'weblinks'
+          [profile['weblinks']['weblink']].flatten.each do |link|
+            @links[CGI.unescapeHTML link['title']] = link['link']
           end
         end
       end
     rescue
-      raise SteamCondenserError, 'XML data could not be parsed.'
+      raise $! if $!.is_a? SteamCondenserError
+      raise SteamCondenserError, 'XML data could not be parsed.', $!.backtrace
     end
 
     super
@@ -300,12 +317,10 @@ class SteamId
   # @see #friends
   # @see #initialize
   def fetch_friends
-    url = "#{base_url}/friends?xml=1"
-
     @friends = []
-    friends_data = REXML::Document.new(open(url, {:proxy => true}).read).root
-    friends_data.elements.each('friends/friend') do |friend|
-      @friends << SteamId.new(friend.text.to_i, false)
+    friends_data = parse "#{base_url}/friends?xml=1"
+    friends_data['friends']['friend'].each do |friend|
+      @friends << SteamId.new(friend.to_i, false)
     end
   end
 
@@ -317,22 +332,21 @@ class SteamId
   #
   # @see #games
   def fetch_games
-    url = "#{base_url}/games?xml=1"
-
     @games     = {}
     @playtimes = {}
-    games_data = REXML::Document.new(open(url, {:proxy => true}).read).root
-    games_data.elements.each('games/game') do |game_data|
-      game = SteamGame.new(game_data)
-      @games[game.app_id] = game
+    games_data = parse "#{base_url}/games?xml=1"
+    [games_data['games']['game']].flatten.each do |game_data|
+      app_id = game_data['appID'].to_i
+      game = SteamGame.new app_id, game_data
+      @games[app_id] = game
       recent = total = 0
-      unless game_data.elements['hoursLast2Weeks'].nil?
-        recent = game_data.elements['hoursLast2Weeks'].text.to_f
+      if game_data.key? 'hoursLast2Weeks'
+        recent = game_data['hoursLast2Weeks'].to_f
       end
-      unless game_data.elements['hoursOnRecord'].nil?
-        total = game_data.elements['hoursOnRecord'].text.to_f
+      if game_data.key? 'hoursOnRecord'
+        total = game_data['hoursOnRecord'].to_f
       end
-      @playtimes[game.app_id] = [(recent * 60).to_i, (total * 60).to_i]
+      @playtimes[app_id] = [(recent * 60).to_i, (total * 60).to_i]
     end
 
     true
@@ -393,28 +407,31 @@ class SteamId
   #
   # @return [String] The URL of the icon-sized avatar
   def icon_url
-    "#{@image_url}.jpg"
+    "#@image_url.jpg"
   end
 
-  # Returns whether the owner of this SteamID is VAC banned
+  # Returns a unique identifier for this Steam ID
   #
-  # @return [Boolean] `true` if the user has been banned by VAC
-  def is_banned?
-    @vac_banned
+  # This is either the 64bit numeric SteamID or custom URL
+  #
+  # @return [Fixnum, String] The 64bit numeric SteamID or the custom URL
+  def id
+    @custom_url.nil? ? @steam_id64 : @custom_url
   end
 
   # Returns whether the owner of this SteamId is playing a game
   #
   # @return [Boolean] `true` if the user is in-game
-  def is_in_game?
+  def in_game?
     @online_state == 'in-game'
   end
+  alias_method :is_in_game?, :in_game?
 
-  # Returns whether the owner of this SteamID is currently logged into Steam
+  # Returns whether this Steam account is limited
   #
-  # @return [Boolean] `true` if the user is online
-  def is_online?
-    @online_state != 'offline'
+  # @return [Boolean] `true` if this account is limited
+  def limited?
+    @limited
   end
 
   # Returns the URL of the medium-sized version of this user's avatar
@@ -424,6 +441,21 @@ class SteamId
     "#{@image_url}_medium.jpg"
   end
 
+  # Returns whether the owner of this SteamID is currently logged into Steam
+  #
+  # @return [Boolean] `true` if the user is online
+  def online?
+    @online_state != 'offline'
+  end
+  alias_method :is_online?, :online?
+
+  # Returns whether this Steam ID is publicly accessible
+  #
+  # @return [Boolean] `true` if this Steam ID is public
+  def public?
+    @privacy_state == 'public'
+  end
+
   # Returns the time in minutes this user has played this game in the last two
   # weeks
   #

data/lib/steam/community/tf2/tf2_class.rb

@@ -8,7 +8,7 @@ require 'steam/community/game_class'
 # Represents the stats for a Team Fortress 2 class for a specific user
 #
 # @author Sebastian Staudt
-module TF2Class
+class TF2Class
 
   include GameClass
 
@@ -73,20 +73,20 @@ module TF2Class
 
   # Creates a new TF2 class instance based on the assigned XML data
   #
-  # @param [REXML::Element] class_data The XML data for this class
+  # @param [Hash<String, Object>] class_data The XML data for this class
   def initialize(class_data)
-    @name                    = class_data.elements['className'].text
-    @max_buildings_destroyed = class_data.elements['ibuildingsdestroyed'].text.to_i
-    @max_captures            = class_data.elements['ipointcaptures'].text.to_i
-    @max_damage              = class_data.elements['idamagedealt'].text.to_i
-    @max_defenses            = class_data.elements['ipointdefenses'].text.to_i
-    @max_dominations         = class_data.elements['idominations'].text.to_i
-    @max_kill_assists        = class_data.elements['ikillassists'].text.to_i
-    @max_kills               = class_data.elements['inumberofkills'].text.to_i
-    @max_revenges            = class_data.elements['irevenge'].text.to_i
-    @max_score               = class_data.elements['ipointsscored'].text.to_i
-    @max_time_alive          = class_data.elements['iplaytime'].text.to_i
-    @play_time               = class_data.elements['playtimeSeconds'].text.to_i
+    @name                    = class_data['className']
+    @max_buildings_destroyed = class_data['ibuildingsdestroyed'].to_i
+    @max_captures            = class_data['ipointcaptures'].to_i
+    @max_damage              = class_data['idamagedealt'].to_i
+    @max_defenses            = class_data['ipointdefenses'].to_i
+    @max_dominations         = class_data['idominations'].to_i
+    @max_kill_assists        = class_data['ikillassists'].to_i
+    @max_kills               = class_data['inumberofkills'].to_i
+    @max_revenges            = class_data['irevenge'].to_i
+    @max_score               = class_data['ipointsscored'].to_i
+    @max_time_alive          = class_data['iplaytime'].to_i
+    @play_time               = class_data['playtimeSeconds'].to_i
   end
 
 end

data/lib/steam/community/tf2/tf2_class_factory.rb

@@ -20,10 +20,10 @@ module TF2ClassFactory
   # This returns an instance of `TF2Class` or its subclasses `TF2Engineer`,
   # `TF2Medic`, `TF2Sniper` or `TF2Spy` depending on the given XML data.
   #
-  # @param [REXML::Element] class_data The XML data for the class
+  # @param [Hash<String, Object>] class_data The XML data for the class
   # @return [TF2Class] The statistics for the given class data
   def self.tf2_class(class_data)
-    case class_data.elements['className'].text
+    case class_data['className']
       when 'Engineer' then
         return TF2Engineer.new(class_data)
       when 'Medic' then

data/lib/steam/community/tf2/tf2_engineer.rb

@@ -9,9 +9,7 @@ require 'steam/community/tf2/tf2_class'
 # user
 #
 # @author Sebastian Staudt
-class TF2Engineer
-
-  include TF2Class
+class TF2Engineer < TF2Class
 
   # Returns the maximum number of buildings built by the player in a single
   # life as an Engineer
@@ -33,13 +31,13 @@ class TF2Engineer
 
   # Creates a new instance of the Engineer class based on the given XML data
   #
-  # @param [REXML::Element] class_data The XML data for this Engineer
+  # @param [Hash<String, Object>] class_data The XML data for this Engineer
   def initialize(class_data)
     super class_data
 
-    @max_buildings_built = class_data.elements['ibuildingsbuilt'].text.to_i
-    @max_teleports       = class_data.elements['inumteleports'].text.to_i
-    @max_sentry_kills    = class_data.elements['isentrykills'].text.to_i
+    @max_buildings_built = class_data['ibuildingsbuilt'].to_i
+    @max_teleports       = class_data['inumteleports'].to_i
+    @max_sentry_kills    = class_data['isentrykills'].to_i
   end
 
 end

data/lib/steam/community/tf2/tf2_golden_wrench.rb

@@ -46,7 +46,7 @@ class TF2GoldenWrench
     if @@golden_wrenches.nil?
       @@golden_wrenches = []
 
-      data = MultiJson.decode(WebApi.json('ITFItems_440', 'GetGoldenWrenches', 2), { :symbolize_keys => true })
+      data = MultiJson.load(WebApi.json('ITFItems_440', 'GetGoldenWrenches', 2), { :symbolize_keys => true })
       data[:results][:wrenches].each do |wrench_data|
         @@golden_wrenches << TF2GoldenWrench.new(wrench_data)
       end

data/lib/steam/community/tf2/tf2_medic.rb

@@ -8,9 +8,7 @@ require 'steam/community/tf2/tf2_class'
 # Represents the stats for the Team Fortress 2 Medic class for a specific user
 #
 # @author Sebastian Staudt
-class TF2Medic
-
-  include TF2Class
+class TF2Medic < TF2Class
 
   # Returns the maximum health healed for teammates by the player in a
   # single life as a Medic
@@ -26,12 +24,12 @@ class TF2Medic
 
   # Creates a new instance of the Medic class based on the given XML data
   #
-  # @param [REXML::Element] class_data The XML data for this Medic
+  # @param [Hash<String, Object>] class_data The XML data for this Medic
   def initialize(class_data)
     super class_data
 
-    @max_health_healed = class_data.elements['ihealthpointshealed'].text.to_i
-    @max_ubercharges   = class_data.elements['inuminvulnerable'].text.to_i
+    @max_health_healed = class_data['ihealthpointshealed'].to_i
+    @max_ubercharges   = class_data['inuminvulnerable'].to_i
   end
 
 end