steam-condenser 0.9.0 → 0.10.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008, Sebastian Staudt
+Copyright (c) 2008-2009, Sebastian Staudt
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/README.md

@@ -28,3 +28,5 @@ file.
 * [GitHub project page](http://github.com/koraktor/steam-condenser)
 * [Google group](http://groups.google.com/group/steam-condenser)
 * [Ohloh profile](http://www.ohloh.net/projects/steam-condenser)
+
+Follow Steam Condenser on Twitter [@steamcondenser](http://twitter.com/steamcondenser).

data/Rakefile

@@ -23,8 +23,6 @@ Jeweler::Tasks.new do |s|
 
   s.files = %w(README.md Rakefile LICENSE VERSION.yml) + src_files + test_files
   s.rdoc_options = ["--all", "--inline-source", "--line-numbers", "--charset=utf-8", "--webcvs=http://github.com/koraktor/steam-condenser/source/blob/master/ruby/%s"]
-
-  s.add_dependency('hpricot', '>= 0.6')
 end
 
 # Create a rake task +:rdoc+ to build the documentation

data/VERSION.yml

@@ -1,4 +1,4 @@
 ---
 :major: 0
-:minor: 9
+:minor: 10 
 :patch: 0

data/lib/abstract_class.rb

@@ -1,9 +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, Sebastian Staudt
-#
-# $Id$
+# Copyright (c) 2008-2009, Sebastian Staudt
 
 # This module is used to mimic the behavior of abstract classes known from other
 # object-oriented programming languages

data/lib/exceptions/buffer_underflow_exception.rb

@@ -1,9 +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, Sebastian Staudt
-#
-# $Id$
+# Copyright (c) 2008-2009, Sebastian Staudt
 
 class BufferUnderflowException < Exception
   

data/lib/exceptions/packet_format_exception.rb

@@ -1,9 +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, Sebastian Staudt
-#
-# $Id$
+# Copyright (c) 2008-2009, Sebastian Staudt
 
 require "exceptions/steam_condenser_exception"
 

data/lib/exceptions/rcon_no_auth_exception.rb

@@ -1,9 +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, Sebastian Staudt
-#
-# $Id$
+# Copyright (c) 2008-2009, Sebastian Staudt
 
 class RCONNoAuthException < Exception
   

data/lib/exceptions/timeout_exception.rb

@@ -2,8 +2,6 @@
 # terms of the new BSD License.
 #
 # Copyright (c) 2008-2009, Sebastian Staudt
-#
-# $Id$
 
 class TimeoutException < StandardError
   

data/lib/steam/community/game_stats.rb

@@ -14,6 +14,7 @@ end
 require 'steam/community/defense_grid/defense_grid_stats'
 require "steam/community/dods/dods_stats"
 require "steam/community/l4d/l4d_stats"
+require "steam/community/l4d/l4d2_stats"
 require "steam/community/tf2/tf2_stats"
 
 # The GameStats class represents the game statistics for a single user and a
@@ -35,6 +36,8 @@ class GameStats
         DoDSStats.new(steam_id)
       when 'l4d'
         L4DStats.new(steam_id)
+      when 'l4d2'
+        L4D2Stats.new(steam_id)
       when 'tf2'
         TF2Stats.new(steam_id)
       else
@@ -42,8 +45,8 @@ class GameStats
     end
   end
 
-  # Creates a GameStats object and fetchs data from Steam Community for the
-  # given user and game
+  # Creates a GameStats object and fetches data from the Steam Community for
+  # the given user and game
   def initialize(id, game_name)
     if id.is_a? Numeric
       @steam_id64 = id
@@ -58,7 +61,6 @@ class GameStats
     @privacy_state = @xml_data.elements['privacyState'].text
     if public?
       @app_id             = @xml_data.elements['game/gameLink'].text.match(/http:\/\/store.steampowered.com\/app\/([1-9][0-9]+)/)[1]
-      @game_friendly_name = @xml_data.elements['game/gameFriendlyName'].text
       @game_name          = @xml_data.elements['game/gameName'].text
       @hours_played       = @xml_data.elements['stats/hoursPlayed'].text
     end

data/lib/steam/community/l4d/abstract_l4d_stats.rb

@@ -0,0 +1,143 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2009, Sebastian Staudt
+
+require 'abstract_class'
+require 'steam/community/game_stats'
+
+# AbstractL4DStats is an abstract base class for statistics for Left4Dead and
+# Left4Dead 2. As both games have more or less the same statistics available in
+# the Steam Community the code for both is pretty much the same.
+class AbstractL4DStats < GameStats
+
+  include AbstractClass
+
+  SPECIAL_INFECTED = %w(boomer hunter smoker tank)
+
+  def initialize(steam_id, game_name)
+    super steam_id, game_name
+
+    if public?
+      @most_recent_game = {}
+      if @xml_data.elements['stats/mostrecentgame'].has_elements?
+        @most_recent_game['difficulty']  = @xml_data.elements['stats/mostrecentgame/difficulty'].text
+        @most_recent_game['escaped']     = (@xml_data.elements['stats/mostrecentgame/bEscaped'].text == 1)
+        @most_recent_game['movie']       = @xml_data.elements['stats/mostrecentgame/movie'].text
+        @most_recent_game['time_played'] = @xml_data.elements['stats/mostrecentgame/time'].text
+      end
+    end
+  end
+
+  # Returns a Hash of favorites for this user like weapons and character.
+  # If the favorites haven't been parsed already, parsing is done now.
+  def favorites
+    return unless public?
+
+    if @favorites.nil?
+      @favorites = {}
+      @favorites['campaign']                 = @xml_data.elements['stats/favorites/campaign'].text
+      @favorites['campaign_percentage']      = @xml_data.elements['stats/favorites/campaignpct'].text.to_i
+      @favorites['character']                = @xml_data.elements['stats/favorites/character'].text
+      @favorites['character_percentage']     = @xml_data.elements['stats/favorites/characterpct'].text.to_i
+      @favorites['level1_weapon']            = @xml_data.elements['stats/favorites/weapon1'].text
+      @favorites['level1_weapon_percentage'] = @xml_data.elements['stats/favorites/weapon1pct'].text.to_i
+      @favorites['level2_weapon']            = @xml_data.elements['stats/favorites/weapon2'].text
+      @favorites['level2_weapon_percentage'] = @xml_data.elements['stats/favorites/weapon2pct'].text.to_i
+    end
+
+    @favorites
+  end
+
+  # Returns a Hash of lifetime statistics for this user like the time played.
+  # If the lifetime statistics haven't been parsed already, parsing is done now.
+  def lifetime_stats
+    return unless public?
+
+    if @lifetime_stats.nil?
+      @lifetime_stats = {}
+      @lifetime_stats['finales_survived'] = @xml_data.elements['stats/lifetime/finales'].text.to_i
+      @lifetime_stats['games_played']     = @xml_data.elements['stats/lifetime/gamesplayed'].text.to_i
+      @lifetime_stats['finales_survived_percentage'] = @lifetime_stats['finales_survived'].to_f / @lifetime_stats['games_played']
+      @lifetime_stats['infected_killed']  = @xml_data.elements['stats/lifetime/infectedkilled'].text.to_i
+      @lifetime_stats['kills_per_hour']   = @xml_data.elements['stats/lifetime/killsperhour'].text.to_f
+      @lifetime_stats['avg_kits_shared']  = @xml_data.elements['stats/lifetime/kitsshared'].text.to_f
+      @lifetime_stats['avg_kits_used']    = @xml_data.elements['stats/lifetime/kitsused'].text.to_f
+      @lifetime_stats['avg_pills_shared'] = @xml_data.elements['stats/lifetime/pillsshared'].text.to_f
+      @lifetime_stats['avg_pills_used']   = @xml_data.elements['stats/lifetime/pillsused'].text.to_f
+      @lifetime_stats['time_played']      = @xml_data.elements['stats/lifetime/timeplayed'].text
+    end
+
+    @lifetime_stats
+  end
+
+  # Returns a Hash of Survival statistics for this user like revived teammates.
+  # If the Survival statistics haven't been parsed already, parsing is done now.
+  def survival_stats
+    return unless public?
+
+    if @survival_stats.nil?
+      @survival_stats = {}
+      @survival_stats['gold_medals']   = @xml_data.elements['stats/survival/goldmedals'].text.to_i
+      @survival_stats['silver_medals'] = @xml_data.elements['stats/survival/silvermedals'].text.to_i
+      @survival_stats['bronze_medals'] = @xml_data.elements['stats/survival/bronzemedals'].text.to_i
+      @survival_stats['rounds_played'] = @xml_data.elements['stats/survival/roundsplayed'].text.to_i
+      @survival_stats['best_time']     = @xml_data.elements['stats/survival/besttime'].text.to_f
+    end
+
+    @survival_stats
+  end
+
+  # Returns a Hash of teamplay statistics for this user like revived teammates.
+  # If the teamplay statistics haven't been parsed already, parsing is done now.
+  def teamplay_stats
+    return unless public?
+
+    if @teamplay_stats.nil?
+      @teamplay_stats = {}
+      @teamplay_stats['revived']                       = @xml_data.elements['stats/teamplay/revived'].text.to_i
+      @teamplay_stats['most_revived_difficulty']       = @xml_data.elements['stats/teamplay/reviveddiff'].text
+      @teamplay_stats['avg_revived']                   = @xml_data.elements['stats/teamplay/revivedavg'].text.to_f
+      @teamplay_stats['avg_was_revived']               = @xml_data.elements['stats/teamplay/wasrevivedavg'].text.to_f
+      @teamplay_stats['protected']                     = @xml_data.elements['stats/teamplay/protected'].text.to_i
+      @teamplay_stats['most_protected_difficulty']     = @xml_data.elements['stats/teamplay/protecteddiff'].text
+      @teamplay_stats['avg_protected']                 = @xml_data.elements['stats/teamplay/protectedavg'].text.to_f
+      @teamplay_stats['avg_was_protected']             = @xml_data.elements['stats/teamplay/wasprotectedavg'].text.to_f
+      @teamplay_stats['friendly_fire_damage']          = @xml_data.elements['stats/teamplay/ffdamage'].text.to_i
+      @teamplay_stats['most_friendly_fire_difficulty'] = @xml_data.elements['stats/teamplay/ffdamagediff'].text
+      @teamplay_stats['avg_friendly_fire_damage']      = @xml_data.elements['stats/teamplay/ffdamageavg'].text.to_f
+    end
+
+    @teamplay_stats
+  end
+
+  # Returns a Hash of Versus statistics for this user like percentage of rounds
+  # won.
+  # If the Versus statistics haven't been parsed already, parsing is done now.
+  def versus_stats
+    return unless public?
+
+    if @versus_stats.nil?
+      @versus_stats = {}
+      @versus_stats['games_played']                = @xml_data.elements['stats/versus/gamesplayed'].text.to_i
+      @versus_stats['games_completed']             = @xml_data.elements['stats/versus/gamescompleted'].text.to_i
+      @versus_stats['finales_survived']            = @xml_data.elements['stats/versus/finales'].text.to_i
+      @versus_stats['finales_survived_percentage'] = @versus_stats['finales_survived'].to_f / @versus_stats['games_played']
+      @versus_stats['points']                      = @xml_data.elements['stats/versus/points'].text.to_i
+      @versus_stats['most_points_infected']        = @xml_data.elements['stats/versus/pointsas'].text
+      @versus_stats['games_won']                   = @xml_data.elements['stats/versus/gameswon'].text.to_i
+      @versus_stats['games_lost']                  = @xml_data.elements['stats/versus/gameslost'].text.to_i
+      @versus_stats['highest_survivor_score']      = @xml_data.elements['stats/versus/survivorscore'].text.to_i
+
+      self.class.const_get(:SPECIAL_INFECTED).each do |infected|
+        @versus_stats[infected] = {}
+        @versus_stats[infected]['special_attacks'] = @xml_data.elements["stats/versus/#{infected}special"].text.to_i
+        @versus_stats[infected]['most_damage']     = @xml_data.elements["stats/versus/#{infected}dmg"].text.to_i
+        @versus_stats[infected]['avg_lifespan']    = @xml_data.elements["stats/versus/#{infected}lifespan"].text.to_i
+      end
+    end
+
+    @versus_stats
+  end
+
+end

data/lib/steam/community/l4d/abstract_l4d_weapon.rb

@@ -0,0 +1,26 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2009-2010, Sebastian Staudt
+
+require 'abstract_class'
+require 'steam/community/game_weapon'
+
+class AbstractL4DWeapon < GameWeapon
+
+  include AbstractClass
+
+  attr_reader :accuracy, :headshots_percentage, :kill_percentage
+
+  # Abstract base constructor which parses common data for both, L4DWeapon and
+  # L4D2Weapon
+  def initialize(weapon_data)
+    super weapon_data
+
+    @accuracy             = weapon_data.elements['accuracy'].text
+    @headshots_percentage = weapon_data.elements['headshots'].text
+    @id                   = weapon_data.name
+    @shots                = weapon_data.elements['shots'].text.to_i
+  end
+
+end

data/lib/steam/community/l4d/l4d2_map.rb

@@ -0,0 +1,65 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2009-2010, Sebastian Staudt
+
+require 'steam/community/steam_id'
+require 'steam/community/l4d/l4d_map'
+
+# L4D2Map holds statistical information about maps played by a player in
+# Survival mode of Left4Dead 2. The basic information provided is more or less
+# the same for Left4Dead and Left4Dead 2, but parsing has to be done
+# differently.
+class L4D2Map < L4DMap
+
+  attr_reader :items, :kills, :teammates
+
+  INFECTED = %w{boomer charger common hunter jockey smoker spitter tank}
+  ITEMS    = %w{adrenaline defibs medkits pills}
+
+  # Creates a new instance of L4D2Map based on the assigned XML data
+  #
+  # The map statistics for the Survival mode of Left4Dead 2 hold much more
+  # information than those for Left4Dead, e.g. the teammates and items are
+  # listed.
+  def initialize(map_data)
+    @id        = map_data.elements['img'].text.match(/http:\/\/steamcommunity\.com\/public\/images\/gamestats\/550\/(.*).jpg/)[1]
+    @name      = map_data.elements['name'].text
+    @played    = (map_data.elements['hasPlayed'].text.to_i == 1)
+
+    if @played
+      @best_time = map_data.elements['besttimemilliseconds'].text.to_f / 1000
+
+      @teammates = []
+      map_data.elements.each('teammates/steamID64') do |teammate|
+        @teammates << SteamId.new(teammate.text, false)
+      end
+
+      @items = {}
+      ITEMS.each do |item|
+        @items[item] = map_data.elements["items_#{item}"].text.to_i
+      end
+
+      @kills = {}
+      INFECTED.each do |infected|
+        @kills[infected] = map_data.elements["kills_#{infected}"].text.to_i
+      end
+
+      case map_data.elements['medal'].text
+        when 'gold'
+          @medal = L4D2Map::GOLD
+        when 'silver'
+          @medal = L4D2Map::SILVER
+        when 'bronze'
+          @medal = L4D2Map::BRONZE
+        else
+          @medal = L4D2Map::NONE
+      end
+    end
+  end
+
+  def played?
+    @played
+  end
+
+end

data/lib/steam/community/l4d/l4d2_stats.rb

@@ -0,0 +1,125 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2009-2010, Sebastian Staudt
+
+require 'steam/community/l4d/abstract_l4d_stats'
+require 'steam/community/l4d/l4d2_map'
+require 'steam/community/l4d/l4d2_weapon'
+
+class L4D2Stats < AbstractL4DStats
+
+  SPECIAL_INFECTED = SPECIAL_INFECTED + %w{charger jockey spitter}
+
+  # Creates a L4D2Stats object by calling the super constructor with the game
+  # name "l4d2"
+  def initialize(steam_id)
+    super steam_id, 'l4d2'
+  end
+
+  # Returns a Hash of lifetime statistics for this user like the time played.
+  # If the lifetime statistics haven't been parsed already, parsing is done now.
+  #
+  # There are only a few additional lifetime statistics for Left4Dead 2 which
+  # are not generated for Left4Dead, so this calls
+  # AbstractL4DStats#lifetime_stats first and adds some additional stats.
+  def lifetime_stats
+    return unless public?
+
+    if @lifetime_stats.nil?
+      super
+      @lifetime_stats['avg_adrenaline_shared']   = @xml_data.elements['stats/lifetime/adrenalineshared'].text.to_f
+      @lifetime_stats['avg_adrenaline_used']     = @xml_data.elements['stats/lifetime/adrenalineused'].text.to_f
+      @lifetime_stats['avg_defibrillators_used'] = @xml_data.elements['stats/lifetime/defibrillatorsused'].text.to_f
+    end
+
+    @lifetime_stats
+  end
+
+  # Returns a Hash of Scavenge statistics for this user like the number of
+  # Scavenge rounds played.
+  # If the Scavenge statistics haven't been parsed already, parsing is done now.
+  def scavenge_stats
+    return unless public?
+
+    if @scavenge_stats.nil?
+      @scavenge_stats = {}
+      @scavenge_stats['avg_cans_per_round'] = @xml_data.elements['stats/scavenge/avgcansperround'].text.to_f
+      @scavenge_stats['perfect_rounds']     = @xml_data.elements['stats/scavenge/perfect16canrounds'].text.to_i
+      @scavenge_stats['rounds_lost']        = @xml_data.elements['stats/scavenge/roundslost'].text.to_i
+      @scavenge_stats['rounds_played']      = @xml_data.elements['stats/scavenge/roundsplayed'].text.to_i
+      @scavenge_stats['rounds_won']         = @xml_data.elements['stats/scavenge/roundswon'].text.to_i
+      @scavenge_stats['total_cans']         = @xml_data.elements['stats/scavenge/totalcans'].text.to_i
+
+      @scavenge_stats['maps'] = {}
+      @xml_data.elements.each('stats/scavenge/mapstats/map') do |map_data|
+        map_id = map_data.elements['name'].text
+        @scavenge_stats['maps'][map_id] = {}
+        @scavenge_stats['maps'][map_id]['avg_round_score']     = map_data.elements['avgscoreperround'].text.to_i
+        @scavenge_stats['maps'][map_id]['highest_game_score']  = map_data.elements['highgamescore'].text.to_i
+        @scavenge_stats['maps'][map_id]['highest_round_score'] = map_data.elements['highroundscore'].text.to_i
+        @scavenge_stats['maps'][map_id]['name']                = map_data.elements['fullname'].text
+        @scavenge_stats['maps'][map_id]['rounds_played']       = map_data.elements['roundsplayed'].text.to_i
+        @scavenge_stats['maps'][map_id]['rounds_won']          = map_data.elements['roundswon'].text.to_i
+      end
+
+      @scavenge_stats['infected'] = {}
+      @xml_data.elements.each('stats/scavenge/infectedstats/special') do |infected_data|
+        infected_id = infected_data.elements['name'].text
+        @scavenge_stats['infected'][infected_id] = {}
+        @scavenge_stats['infected'][infected_id]['max_damage_per_life']   = infected_data.elements['maxdmg1life'].text.to_i
+        @scavenge_stats['infected'][infected_id]['max_pours_interrupted'] = infected_data.elements['maxpoursinterrupted'].text.to_i
+        @scavenge_stats['infected'][infected_id]['special_attacks']       = infected_data.elements['specialattacks'].text.to_i
+      end
+    end
+
+    @scavenge_stats
+  end
+
+  # Returns a Hash of Survival statistics for this user like revived teammates.
+  # If the Survival statistics haven't been parsed already, parsing is done now.
+  #
+  # The XML layout for the Survival statistics for Left4Dead 2 differs a bit
+  # from Left4Dead's Survival statistics. So we have to use a different way of
+  # parsing for the maps and we use a different map class (L4D2Map) which holds
+  # the additional information provided in Left4Dead 2's statistics.
+  def survival_stats
+    return unless public?
+
+    if @survival_stats.nil?
+      super
+      @survival_stats['maps'] = {}
+      @xml_data.elements.each('stats/survival/maps/map') do |map_data|
+        map = L4D2Map.new(map_data)
+        @survival_stats['maps'][map.id] = map
+      end
+    end
+
+    @survival_stats
+  end
+
+  # Returns a Hash of L4D2Weapon for this user containing all Left4Dead 2
+  # weapons.
+  # If the weapons haven't been parsed already, parsing is done now.
+  def weapon_stats
+    return unless public?
+
+    if @weapon_stats.nil?
+      @weapon_stats = {}
+      @xml_data.elements.each('stats/weapons/*') do |weapon_data|
+        next unless weapon_data.has_elements?
+
+        unless %w{bilejars molotov pipes}.include? weapon_data.name
+          weapon = L4D2Weapon.new(weapon_data)
+        else
+          weapon = L4DExplosive.new(weapon_data)
+        end
+
+        @weapon_stats[weapon_data.name] = weapon
+      end
+    end
+
+    @weapon_stats
+  end
+
+end

data/lib/steam/community/l4d/l4d2_weapon.rb

@@ -0,0 +1,21 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2009, Sebastian Staudt
+
+require 'steam/community/l4d/abstract_l4d_weapon'
+
+class L4D2Weapon < AbstractL4DWeapon
+
+  attr_reader :damage, :weapon_group
+
+  # Creates a new instance of L4D2Weapon based on the assigned XML data
+  def initialize(weapon_data)
+    super weapon_data
+
+    @damage          = weapon_data.elements['damage'].text.to_i
+    @kill_percentage = weapon_data.elements['pctkills'].text
+    @weapon_group    = weapon_data.attribute('group')
+  end
+
+end

data/lib/steam/community/l4d/l4d_map.rb

@@ -3,6 +3,8 @@
 #
 # Copyright (c) 2009, Sebastian Staudt
 
+# L4DMap holds statistical information about maps played by a player in
+# Survival mode of Left4Dead.
 class L4DMap
 
   attr_reader :best_time, :id, :medal, :name, :times_played