steam-condenser 1.3.2 → 1.3.3

data/lib/steam/community/l4d/l4d2_stats.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) 2009-2011, Sebastian Staudt
+# Copyright (c) 2009-2013, Sebastian Staudt
 
 require 'steam/community/l4d/abstract_l4d_stats'
 require 'steam/community/l4d/l4d2_map'
@@ -34,11 +34,13 @@ class L4D2Stats < GameStats
   def initialize(steam_id)
     super steam_id, 'l4d2'
 
+    weapons_data = @xml_data['stats']['weapons']
+
     @damage_percentages = {
-      :melee    => @xml_data['stats']['weapons']['meleepctdmg'].to_f,
-      :pistols  => @xml_data['stats']['weapons']['pistolspctdmg'].to_f,
-      :rifles   => @xml_data['stats']['weapons']['bulletspctdmg'].to_f,
-      :shotguns => @xml_data['stats']['weapons']['shellspctdmg'].to_f
+      :melee    => weapons_data['meleepctdmg'].to_f,
+      :pistols  => weapons_data['pistolspctdmg'].to_f,
+      :rifles   => weapons_data['bulletspctdmg'].to_f,
+      :shotguns => weapons_data['shellspctdmg'].to_f
     }
   end
 
@@ -58,9 +60,11 @@ class L4D2Stats < GameStats
 
     if @lifetime_stats.nil?
       super
-      @lifetime_stats[:avg_adrenaline_shared]   = @xml_data['stats']['lifetime']['adrenalineshared'].to_f
-      @lifetime_stats[:avg_adrenaline_used]     = @xml_data['stats']['lifetime']['adrenalineused'].to_f
-      @lifetime_stats[:avg_defibrillators_used] = @xml_data['stats']['lifetime']['defibrillatorsused'].to_f
+
+      lifetime_data = @xml_data['stats']['lifetime']
+      @lifetime_stats[:avg_adrenaline_shared]   = lifetime_data['adrenalineshared'].to_f
+      @lifetime_stats[:avg_adrenaline_used]     = lifetime_data['adrenalineused'].to_f
+      @lifetime_stats[:avg_defibrillators_used] = lifetime_data['defibrillatorsused'].to_f
     end
 
     @lifetime_stats
@@ -77,33 +81,36 @@ class L4D2Stats < GameStats
     return unless public?
 
     if @scavenge_stats.nil?
+      scavange_data = @xml_data['stats']['scavenge']
+
       @scavenge_stats = {}
-      @scavenge_stats[:avg_cans_per_round] = @xml_data['stats']['scavenge']['avgcansperround'].to_f
-      @scavenge_stats[:perfect_rounds]     = @xml_data['stats']['scavenge']['perfect16canrounds'].to_i
-      @scavenge_stats[:rounds_lost]        = @xml_data['stats']['scavenge']['roundslost'].to_i
-      @scavenge_stats[:rounds_played]      = @xml_data['stats']['scavenge']['roundsplayed'].to_i
-      @scavenge_stats[:rounds_won]         = @xml_data['stats']['scavenge']['roundswon'].to_i
-      @scavenge_stats[:total_cans]         = @xml_data['stats']['scavenge']['totalcans'].to_i
+      @scavenge_stats[:avg_cans_per_round] = scavange_data['avgcansperround'].to_f
+      @scavenge_stats[:perfect_rounds]     = scavange_data['perfect16canrounds'].to_i
+      @scavenge_stats[:rounds_lost]        = scavange_data['roundslost'].to_i
+      @scavenge_stats[:rounds_played]      = scavange_data['roundsplayed'].to_i
+      @scavenge_stats[:rounds_won]         = scavange_data['roundswon'].to_i
+      @scavenge_stats[:total_cans]         = scavange_data['totalcans'].to_i
 
       @scavenge_stats[:maps] = {}
-      @xml_data['stats']['scavenge']['mapstats']['map'].each do |map_data|
-        map_id = map_data['name']
-        @scavenge_stats[:maps][map_id] = {}
-        @scavenge_stats[:maps][map_id]['avg_round_score']     = map_data['avgscoreperround'].to_i
-        @scavenge_stats[:maps][map_id]['highest_game_score']  = map_data['highgamescore'].to_i
-        @scavenge_stats[:maps][map_id]['highest_round_score'] = map_data['highroundscore'].to_i
-        @scavenge_stats[:maps][map_id]['name']                = map_data['fullname']
-        @scavenge_stats[:maps][map_id]['rounds_played']       = map_data['roundsplayed'].to_i
-        @scavenge_stats[:maps][map_id]['rounds_won']          = map_data['roundswon'].to_i
+      scavange_data['mapstats']['map'].each do |map_data|
+        map_stats = {}
+        map_stats['avg_round_score']     = map_data['avgscoreperround'].to_i
+        map_stats['highest_game_score']  = map_data['highgamescore'].to_i
+        map_stats['highest_round_score'] = map_data['highroundscore'].to_i
+        map_stats['name']                = map_data['fullname']
+        map_stats['rounds_played']       = map_data['roundsplayed'].to_i
+        map_stats['rounds_won']          = map_data['roundswon'].to_i
+        @scavenge_stats[:maps][map_data['name']] = map_stats
+
       end
 
       @scavenge_stats[:infected] = {}
-      @xml_data['stats']['scavenge']['infectedstats']['special'].each do |infected_data|
-        infected_id = infected_data['name']
-        @scavenge_stats[:infected][infected_id] = {}
-        @scavenge_stats[:infected][infected_id]['max_damage_per_life']   = infected_data['maxdmg1life'].to_i
-        @scavenge_stats[:infected][infected_id]['max_pours_interrupted'] = infected_data['maxpoursinterrupted'].to_i
-        @scavenge_stats[:infected][infected_id]['special_attacks']       = infected_data['specialattacks'].to_i
+      scavange_data['infectedstats']['special'].each do |infected_data|
+        infected_stats = {}
+        infected_stats['max_damage_per_life']   = infected_data['maxdmg1life'].to_i
+        infected_stats['max_pours_interrupted'] = infected_data['maxpoursinterrupted'].to_i
+        infected_stats['special_attacks']       = infected_data['specialattacks'].to_i
+        @scavenge_stats[:infected][infected_data['name']] = infected_stats
       end
     end
 

data/lib/steam/community/steam_group.rb

@@ -112,19 +112,17 @@ class SteamGroup
   def fetch_page(page)
     member_data = parse "#{base_url}/memberslistxml?p=#{page}"
 
-    begin
-      @group_id64   = member_data['groupID64'].to_i if page == 1
-      @member_count = member_data['memberCount'].to_i
-      total_pages   = member_data['totalPages'].to_i
-
-      member_data['members']['steamID64'].each do |member|
-        @members << SteamId.new(member.to_i, false)
-      end
-    rescue
-      raise SteamCondenserError, 'XML data could not be parsed.', $!.backtrace
+    @group_id64   = member_data['groupID64'].to_i if page == 1
+    @member_count = member_data['memberCount'].to_i
+    total_pages   = member_data['totalPages'].to_i
+
+    member_data['members']['steamID64'].each do |member|
+      @members << SteamId.new(member.to_i, false)
     end
 
     total_pages
+  rescue
+    raise SteamCondenserError, 'XML data could not be parsed.'
   end
 
 end

data/lib/steam/community/steam_id.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-2012, Sebastian Staudt
+# Copyright (c) 2008-2013, Sebastian Staudt
 
 require 'cgi'
 
@@ -244,64 +244,55 @@ class SteamId
   #        when it is private
   # @see Cacheable#fetch
   def fetch
-    begin
-      profile = parse "#{base_url}?xml=1"
+    profile = parse "#{base_url}?xml=1"
 
-      raise SteamCondenserError, profile['error'] unless profile['error'].nil?
+    raise SteamCondenserError, profile['error'] unless profile['error'].nil?
 
-      unless profile['privacyMessage'].nil?
-        raise SteamCondenserError, profile['privacyMessage']
+    unless profile['privacyMessage'].nil?
+      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?
+
+      @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 = {}
+      [(profile['mostPlayedGames'] || {})['mostPlayedGame']].compact.flatten.each do |most_played_game|
+        @most_played_games[most_played_game['gameName']] = most_played_game['hoursPlayed'].to_f
+      end
+
+      @groups = []
+      [(profile['groups'] || {})['group']].compact.flatten.each do |group|
+        @groups << SteamGroup.new(group['groupID64'].to_i, false)
       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 rescue ''
-        @custom_url = nil if @custom_url.empty?
-
-        @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 profile['mostPlayedGames'].to_s.strip.empty?
-          [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 profile['groups'].to_s.strip.empty?
-          [profile['groups']['group']].flatten.each do |group|
-            @groups << SteamGroup.new(group['groupID64'].to_i, false)
-          end
-        end
-
-        @links = {}
-        unless profile['weblinks'].to_s.strip.empty?
-          [profile['weblinks']['weblink']].flatten.each do |link|
-            @links[CGI.unescapeHTML link['title']] = link['link']
-          end
-        end
+      @links = {}
+      [(profile['weblinks'] || {})['weblink']].compact.flatten.each do |link|
+        @links[CGI.unescapeHTML link['title']] = link['link']
       end
-    rescue
-      raise $! if $!.is_a? SteamCondenserError
-      raise SteamCondenserError, 'XML data could not be parsed.', $!.backtrace
     end
+  rescue
+    raise SteamCondenserError, 'XML data could not be parsed.'
   end
 
   # Fetches the friends of this user
@@ -328,17 +319,18 @@ class SteamId
   # @see #games
   def fetch_games
     games_data = parse "#{base_url}/games?xml=1"
-    @games     = {}
-    @playtimes = {}
+    @games            = {}
+    @recent_playtimes = {}
+    @total_playtimes  = {}
     games_data['games']['game'].each do |game_data|
       app_id = game_data['appID'].to_i
-      game = SteamGame.new app_id, game_data
-      @games[app_id] = game
+      @games[app_id] = SteamGame.new app_id, game_data
 
       recent = game_data['hoursLast2Weeks'].to_f
       total = (game_data['hoursOnRecord'] || '').delete(',').to_f
 
-      @playtimes[app_id] = [(recent * 60).to_i, (total * 60).to_i]
+      @recent_playtimes[app_id] = (recent * 60).to_i
+      @total_playtimes[app_id]  = (total * 60).to_i
     end
 
     true
@@ -408,7 +400,7 @@ class SteamId
   #
   # @return [Fixnum, String] The 64bit numeric SteamID or the custom URL
   def id
-    @custom_url.nil? ? @steam_id64 : @custom_url
+    @custom_url || @steam_id64
   end
 
   # Returns whether the owner of this SteamId is playing a game
@@ -457,7 +449,7 @@ class SteamId
   #         the last two weeks
   def recent_playtime(id)
     game = find_game id
-    @playtimes[game.app_id][0]
+    @recent_playtimes[game.app_id]
   end
 
   # Returns the total time in minutes this user has played this game
@@ -468,7 +460,7 @@ class SteamId
   #         game
   def total_playtime(id)
     game = find_game id
-    @playtimes[game.app_id][1]
+    @total_playtimes[game.app_id]
   end
 
   private

data/lib/steam/community/xml_data.rb

@@ -16,9 +16,12 @@ module XMLData
   #
   # @param [String] url The URL to parse
   # @return [Hash<String, Object>] The data parsed from the XML document
+  # @raise [SteamCondenserError] if an error occurs while parsing the XML data
   def parse(url)
     data = open(url, { :proxy => true })
     @xml_data = MultiXml.parse(data).values.first
+  rescue
+    raise SteamCondenserError.new "XML data could not be parsed: #{$!.message}", $!
   end
 
 end

data/lib/steam/packets/s2a_info2_packet.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-2013, Sebastian Staudt
 
 require 'steam/packets/s2a_info_base_packet'
 
@@ -17,6 +17,12 @@ class S2A_INFO2_Packet
 
   include S2A_INFO_BasePacket
 
+  EDF_GAME_ID     = 0x01
+  EDF_GAME_PORT   = 0x80
+  EDF_SERVER_ID   = 0x10
+  EDF_SERVER_TAGS = 0x20
+  EDF_SOURCE_TV   = 0x40
+
   # Creates a new S2A_INFO2 response object based on the given data
   #
   # @param [String] data The raw packet data replied from the server
@@ -24,39 +30,45 @@ class S2A_INFO2_Packet
   def initialize(data)
     super S2A_INFO2_HEADER, data
 
-    @protocol_version = @content_data.byte
-    @server_name = @content_data.cstring
-    @map_name = @content_data.cstring
-    @game_directory = @content_data.cstring
-    @game_description = @content_data.cstring
-    @app_id = @content_data.short
-    @number_of_players = @content_data.byte
-    @max_players = @content_data.byte
-    @number_of_bots = @content_data.byte
-    @dedicated = @content_data.byte.chr
-    @operating_system = @content_data.byte.chr
-    @password_needed = @content_data.byte == 1
-    @secure = @content_data.byte == 1
-    @game_version = @content_data.cstring
+    info[:protocol_version] = @content_data.byte
+    info[:server_name] = @content_data.cstring
+    info[:map_name] = @content_data.cstring
+    info[:game_directory] = @content_data.cstring
+    info[:game_description] = @content_data.cstring
+    info[:app_id] = @content_data.short
+    info[:number_of_players] = @content_data.byte
+    info[:max_players] = @content_data.byte
+    info[:number_of_bots] = @content_data.byte
+    info[:dedicated] = @content_data.byte.chr
+    info[:operating_system] = @content_data.byte.chr
+    info[:password_needed] = @content_data.byte == 1
+    info[:secure] = @content_data.byte == 1
+    info[:game_version] = @content_data.cstring
 
     if @content_data.remaining > 0
       extra_data_flag = @content_data.byte
 
-      @server_port = @content_data.short unless extra_data_flag & 0x80 == 0
+      if extra_data_flag & EDF_GAME_PORT != 0
+        info[:server_port] = @content_data.short
+      end
 
-      unless extra_data_flag & 0x10 == 0
-        @server_id =  @content_data.long | (@content_data.long << 32)
+      if extra_data_flag & EDF_SERVER_ID != 0
+        info[:server_id] = @content_data.long | (@content_data.long << 32)
       end
 
-      unless extra_data_flag & 0x40 == 0
-        @tv_port = @content_data.short
-        @tv_name = @content_data.cstring
+      if extra_data_flag & EDF_SOURCE_TV != 0
+        info[:tv_port] = @content_data.short
+        info[:tv_name] = @content_data.cstring
       end
 
-      @server_tags = @content_data.cstring unless extra_data_flag & 0x20 == 0
-    end
+      if extra_data_flag & EDF_SERVER_TAGS != 0
+        info[:server_tags] = @content_data.cstring
+      end
 
-    generate_info_hash
+      if extra_data_flag & EDF_GAME_ID != 0
+        info[:game_id] = @content_data.long | (@content_data.long << 32)
+      end
+    end
   end
 
 end

data/lib/steam/packets/s2a_info_base_packet.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-2013, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
@@ -18,18 +18,8 @@ module S2A_INFO_BasePacket
   # Returns the information provided by the server
   #
   # @return [Hash<String, Object>] The information provided by the server
-  attr_reader :info_hash
-
-  protected
-
-  # Generates a hash of server properties from the instance variables of the
-  # including packet object
-  def generate_info_hash
-    @info_hash = Hash[
-      *instance_variables.map { |var|
-        [var[1..-1].to_sym, instance_variable_get(var)] if var != '@content_data' && var != '@header_data'
-      }.compact.flatten
-    ]
+  def info
+    @info ||= {}
   end
 
 end

data/lib/steam/packets/s2a_info_detailed_packet.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-2013, Sebastian Staudt
 
 require 'steam/packets/s2a_info_base_packet'
 
@@ -24,38 +24,36 @@ class S2A_INFO_DETAILED_Packet
   def initialize(data)
     super S2A_INFO_DETAILED_HEADER, data
 
-    @game_ip = @content_data.cstring
-    @server_name = @content_data.cstring
-    @map_name = @content_data.cstring
-    @game_directory = @content_data.cstring
-    @game_description = @content_data.cstring
-    @number_of_players = @content_data.byte
-    @max_players = @content_data.byte
-    @network_version = @content_data.byte
-    @dedicated = @content_data.byte.chr
-    @operating_system = @content_data.byte.chr
-    @password_needed = @content_data.byte == 1
-    @is_mod = @content_data.byte == 1
-
-    if @is_mod
-      @mod_info = {}
-      @mod_info[:url_info] = @content_data.cstring
-      @mod_info[:url_dl] = @content_data.cstring
+    info[:game_ip] = @content_data.cstring
+    info[:server_name] = @content_data.cstring
+    info[:map_name] = @content_data.cstring
+    info[:game_directory] = @content_data.cstring
+    info[:game_description] = @content_data.cstring
+    info[:number_of_players] = @content_data.byte
+    info[:max_players] = @content_data.byte
+    info[:network_version] = @content_data.byte
+    info[:dedicated] = @content_data.byte.chr
+    info[:operating_system] = @content_data.byte.chr
+    info[:password_needed] = @content_data.byte == 1
+    info[:is_mod] = @content_data.byte == 1
+
+    if info[:is_mod]
+      info[:mod_info] = {}
+      info[:mod_info][:url_info] = @content_data.cstring
+      info[:mod_info][:url_dl] = @content_data.cstring
       @content_data.byte
       if @content_data.remaining == 12
-        @mod_info[:mod_version] = @content_data.long
-        @mod_info[:mod_size] = @content_data.long
-        @mod_info[:sv_only] = @content_data.byte == 1
-        @mod_info[:cl_dll] = @content_data.byte == 1
-        @secure = @content_data.byte == 1
-        @number_of_bots = @content_data.byte
+        info[:mod_info][:mod_version] = @content_data.long
+        info[:mod_info][:mod_size] = @content_data.long
+        info[:mod_info][:sv_only] = @content_data.byte == 1
+        info[:mod_info][:cl_dll] = @content_data.byte == 1
+        info[:secure] = @content_data.byte == 1
+        info[:number_of_bots] = @content_data.byte
       end
     else
-      @secure = @content_data.byte == 1
-      @number_of_bots = @content_data.byte
+      info[:secure] = @content_data.byte == 1
+      info[:number_of_bots] = @content_data.byte
     end
-
-    generate_info_hash
   end
 
 end