steam-condenser 0.8.0

data/lib/steam-condenser.rb

@@ -0,0 +1,3 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+

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

@@ -0,0 +1,32 @@
+# 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/game_class'
+
+# Represents the stats for a DoD:S class for a specific user
+class DoDSClass < GameClass
+
+  attr_reader :blocks, :bombs_defused, :bombs_planted, :captures, :deaths,
+              :dominations, :key, :kills, :name, :rounds_lost, :rounds_won,
+              :revenges
+
+  # Creates a new instance of DoDSClass based on the assigned XML data
+  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
+  end
+
+end

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

@@ -0,0 +1,47 @@
+# 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/dods/dods_weapon'
+require 'steam/community/game_stats'
+
+class DoDSStats < GameStats
+
+  # Creates a DoDSStats object by calling the super constructor with the game
+  # name "DoD:S"
+  def initialize(steam_id)
+    super steam_id, 'DoD:S'
+  end
+
+  # Returns a Hash of DoDSClass for this user containing all DoD:S classes.
+  # If the classes haven't been parsed already, parsing is done now.
+  def class_stats
+    return unless public?
+
+    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
+      end
+    end
+
+    @class_stats
+  end
+
+  # Returns a Hash of DoDSWeapon for this user containing all DoD:S 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/weapon') do |weapon_data|
+        @weapon_stats[weapon_data.attributes['key']] = DoDSWeapon.new(weapon_data)
+      end
+    end
+
+    @weapon_stats
+  end
+  
+end

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

@@ -0,0 +1,54 @@
+# 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/game_weapon'
+
+# Represents the stats for a Day of Defeat: Source weapon for a specific user
+class DoDSWeapon < GameWeapon
+
+  attr_reader :headshots, :name, :hits
+
+  # Creates a new instance of DoDSWeapon based on the assigned XML data
+  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
+  end
+
+  # Returns the average number of hits needed for a kill with this weapon.
+  # Calculates the value if needed.
+  def avg_hits_per_kill
+    if @avg_hits_per_kill.nil?
+      @avg_hits_per_kill = @hits.to_f / @kills
+    end
+
+    @avg_hits_per_kill
+  end
+
+  # Returns the percentage of headshots relative to the shots hit with this
+  # weapon. Calculates the value if needed.
+  def headshot_percentage
+    if @headshot_percentage.nil?
+      @headshot_percentage = @headshots.to_f / @hits
+    end
+
+    @headshot_percentage
+  end
+
+  # Returns the percentage of hits relative to the shots fired with this
+  # weapon. Calculates the value if needed.
+  def hit_percentage
+    if @hit_percentage.nil?
+      @hit_percentage = @hits.to_f / @shots
+    end
+
+    @hit_percentage
+  end
+
+end

data/lib/steam/community/game_achievement.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) 2008-2009, Sebastian Staudt
+
+# The GameAchievement class represents a specific achievement for a single game
+# and for a single user
+class GameAchievement
+
+  attr_reader :app_id, :name, :steam_id
+  
+  # Creates the achievement with the given name for the given user and game and
+  # marks it as already done if set to true
+  def initialize(steam_id, app_id, name, done)
+    @app_id   = app_id
+    @done     = done
+    @name     = name
+    @steam_id = steam_id
+  end
+  
+  # Returns whether this achievement has been done by its owner
+  def done?
+    @done
+  end
+  
+end

data/lib/steam/community/game_class.rb

@@ -0,0 +1,15 @@
+# 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'
+
+# Super class for classes representing player classes
+class GameClass
+
+  include AbstractClass
+
+  attr_reader :name, :play_time
+
+end

data/lib/steam/community/game_stats.rb

@@ -0,0 +1,92 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2008-2009, Sebastian Staudt
+
+require "open-uri"
+require "rexml/document"
+
+require "steam/community/game_achievement"
+
+class GameStats
+end
+
+require "steam/community/l4d/l4d_stats"
+require "steam/community/dods/dods_stats"
+require "steam/community/tf2/tf2_stats"
+
+# The GameStats class represents the game statistics for a single user and a
+# specific game
+class GameStats
+  
+  protected :initialize
+
+  attr_reader :app_id, :game_friendly_name, :game_name, :hours_played,
+              :privacy_state, :steam_id
+
+  # Creates a GameStats (or one of its subclasses) object for the given user
+  # depending on the game selected
+  def self.create_game_stats(steam_id, game_name)
+    case game_name
+      when "DoD:S":
+        DoDSStats.new(steam_id)
+      when "L4D":
+        L4DStats.new(steam_id)
+      when "TF2":
+        TF2Stats.new(steam_id)
+      else
+        new(steam_id, game_name)
+    end
+  end
+  
+  # Creates a GameStats object and fetchs data from Steam Community for the
+  # given user and game
+  def initialize(steam_id, game_name)
+    @steam_id = steam_id
+    
+    @xml_data = REXML::Document.new(open("http://www.steamcommunity.com/id/#{@steam_id}/stats/#{game_name}?xml=1", {:proxy => true}).read).elements["playerstats"]
+    
+    @privacy_state = @xml_data.elements["privacyState"].text
+    if public?
+      @app_id             = @xml_data.elements["game"].elements["gameLink"].text.match("http://store.steampowered.com/app/([1-9][0-9]+)")[1]
+      @game_friendly_name = @xml_data.elements["game"].elements["gameFriendlyName"].text
+      @game_name          = @xml_data.elements["game"].elements["gameName"].text
+      @hours_played       = @xml_data.elements["stats"].elements["hoursPlayed"].text
+    end
+  end
+  
+  # Returns the achievements for this stats' user and game. If the achievements
+  # haven't been parsed already, parsing is done now.
+  def achievements
+    return unless public?
+
+    if @achievements.nil?
+      @achievements = Array.new
+      @xml_data.elements["achievements"].elements.each("achievement") do |achievement|
+        @achievements << GameAchievement.new(@steam_id, @app_id, achievement.elements["name"].text, (achievement.attributes["closed"].to_i == 1))
+      end
+
+      @achievements_done = @achievements.reject{ |a| !a.done? }.size
+    end
+    
+    return @achievements
+  end
+  
+  # Returns the count of achievements done by this player. If achievements
+  # haven't been parsed yet, parsing is done now.
+  def achievements_done
+    achievements if @achievements_done.nil?
+    @achievements_done
+  end
+
+  # Returns a float value representing the percentage of achievements done by
+  # this player.
+  def achievements_percentage
+    achievements_done.to_f / @achievements.size
+  end
+
+  def public?
+    @privacy_state == 'public'
+  end
+  
+end

data/lib/steam/community/game_weapon.rb

@@ -0,0 +1,29 @@
+# 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'
+
+# Super class for classes representing game weapons
+class GameWeapon
+  
+  include AbstractClass
+
+  attr_reader :kills, :id, :shots
+
+  def initialize(weapon_data)
+    @kills     = weapon_data.elements['kills'].text.to_i
+  end
+
+  # Returns the average number of shots needed for a kill with this weapon.
+  # Calculates the value if needed.
+  def avg_shots_per_kill
+    if @avg_shots_per_kill.nil?
+      @avg_shots_per_kill = @shots.to_f / @kills
+    end
+
+    @avg_shots_per_kill
+  end
+
+end

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

@@ -0,0 +1,23 @@
+# 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/game_weapon'
+
+class L4DExplosive < GameWeapon
+
+  # Creates a new instance of L4DExplosive based on the assigned XML data
+  def initialize(weapon_data)
+    super weapon_data
+
+    @id                   = weapon_data.name
+    @shots                = weapon_data.elements['thrown'].text.to_i
+  end
+
+  # Returns the average number of kills for one shot of this explosive.
+  def avg_kills_per_shot
+    1 / avg_shots_per_kill
+  end
+
+end

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

@@ -0,0 +1,34 @@
+# 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
+
+class L4DMap
+
+  attr_reader :best_time, :id, :medal, :name, :times_played
+
+  GOLD   = 1
+  SILVER = 2
+  BRONZE = 3
+  NONE   = 0
+
+  # Creates a new instance of L4DMap based on the assigned XML data
+  def initialize(map_data)
+    @best_time = map_data.elements['besttimeseconds'].text.to_f
+    @id = map_data.name
+    @name = map_data.elements['name'].text
+    @times_played = map_data.elements['timesplayed'].text.to_i
+
+    case map_data.elements['medal'].text
+      when 'gold':
+        @medal = L4DMap::GOLD
+      when 'silver':
+        @medal = L4DMap::SILVER
+      when 'bronze':
+        @medal = L4DMap::BRONZE
+      else
+        @medal = L4DMap::NONE
+    end
+  end
+
+end

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

@@ -0,0 +1,166 @@
+# 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/game_stats'
+require 'steam/community/l4d/l4d_explosive'
+require 'steam/community/l4d/l4d_map'
+require 'steam/community/l4d/l4d_weapon'
+
+class L4DStats < GameStats
+
+  attr_reader :xml_data
+
+  # Creates a L4DStats object by calling the super constructor with the game
+  # name "l4d"
+  def initialize(steam_id)
+    super steam_id, 'l4d'
+
+    if public?
+      @most_recent_game = {}
+      @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
+
+  # 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
+
+      @survival_stats['maps'] = {}
+      @xml_data.elements.each('stats/survival/maps/*') do |map_data|
+        @survival_stats['maps'][map_data.name] = L4DMap.new(map_data)
+      end
+    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
+
+      %w(boomer hunter smoker tank).each do |infected|
+        @versus_stats[infected] = {}
+        @versus_stats[infected]['special']      = @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
+
+  # Returns a Hash of L4DWeapon for this user containing all Left4Dead 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|
+        unless weapon_data.name == 'molotov' or weapon_data.name == 'pipes'
+          weapon = L4DWeapon.new(weapon_data)
+        else
+          weapon = L4DExplosive.new(weapon_data)
+        end
+
+        @weapon_stats[weapon_data.name] = weapon
+      end
+    end
+
+    @weapon_stats
+  end
+
+end