steam-condenser 1.3.6 → 1.3.7

data/pkg/steam-condenser-1.3.6/pkg/steam-condenser-1.3.5/lib/steam/community/game_leaderboard_entry.rb

@@ -0,0 +1,43 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011-2012, Sebastian Staudt
+
+# The GameLeaderboard class represents a single entry in a leaderboard
+#
+# @author Sebastian Staudt
+class GameLeaderboardEntry
+
+  # Returns the Steam ID of this entry's player
+  #
+  # @return [SteamId] The Steam ID of the player
+  attr_reader :steam_id
+
+  # Returns the score of this entry
+  #
+  # @return [Fixnum] The score of this player
+  attr_reader :score
+
+  # Returns the rank where this entry is listed in the leaderboard
+  #
+  # @return [Fixnum] The rank of this entry
+  attr_reader :rank
+
+  # Returns the leaderboard this entry belongs to
+  #
+  # @return [GameLeaderboard] The leaderboard of this entry
+  attr_reader :leaderboard
+
+  # Creates new entry instance for the given XML data and leaderboard
+  #
+  # @param [Hash<String, Object>] entry_data The XML data of the leaderboard of
+  #        the leaderboard entry
+  # @param [GameLeaderboard] leaderboard The leaderboard this entry belongs to
+  def initialize(entry_data, leaderboard)
+    @steam_id    = SteamId.new entry_data['steamid'].to_i, false
+    @score       = entry_data['score'].to_i
+    @rank        = entry_data['rank'].to_i
+    @leaderboard = leaderboard
+  end
+
+end

data/pkg/steam-condenser-1.3.6/pkg/steam-condenser-1.3.5/lib/steam/community/game_stats.rb

@@ -0,0 +1,175 @@
+# 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
+
+require 'steam/community/game_achievement'
+require 'steam/community/game_leaderboard'
+require 'steam/community/xml_data'
+
+# This class represents the game statistics for a single user and a specific
+# game
+#
+# It is subclassed for individual games if the games provide special statistics
+# that are unique to this game.
+#
+# @author Sebastian Staudt
+class GameStats
+
+  include XMLData
+
+  # Returns the game these stats belong to
+  #
+  # @return [SteamGame] The game object
+  attr_reader :game
+
+  # Returns the number of hours this game has been played by the player
+  #
+  # @return [String] The number of hours this game has been played
+  attr_reader :hours_played
+
+  # Returns the privacy setting of the Steam ID profile
+  #
+  # @return [String] The privacy setting of the Steam ID
+  attr_reader :privacy_state
+
+  # Returns the Steam ID of the player these stats belong to
+  #
+  # @return [SteamId] The Steam ID instance of the player
+  attr_reader :user
+
+  # Returns the base Steam Communtiy URL for the given player and game IDs
+  #
+  # @param [Fixnum, String] user_id The 64bit SteamID or custom URL of the user
+  # @param [Fixnum, String] game_id The application ID or short name of the
+  #        game
+  # @return The base URL used for the given stats IDs
+  def self.base_url(user_id, game_id)
+    game_url = game_id.is_a?(Fixnum) ? "appid/#{game_id}" : game_id
+
+    if user_id.is_a? Fixnum
+      "http://steamcommunity.com/profiles/#{user_id}/stats/#{game_url}"
+    else
+      "http://steamcommunity.com/id/#{user_id}/stats/#{game_url}"
+    end
+  end
+
+  # Creates a `GameStats` (or one of its subclasses) instance for the given
+  # user and game
+  #
+  # @param [String, Fixnum] steam_id The custom URL or the 64bit Steam ID of
+  #        the user
+  # @param [String] game_name The friendly name of the game
+  # @return [GameStats] The game stats object for the given user and game
+  def self.create_game_stats(steam_id, game_name)
+    case game_name
+      when 'alienswarm'
+        require 'steam/community/alien_swarm/alien_swarm_stats'
+        AlienSwarmStats.new(steam_id)
+      when 'cs:s'
+        require 'steam/community/css/css_stats'
+        CSSStats.new(steam_id)
+      when 'defensegrid:awakening'
+        require 'steam/community/defense_grid/defense_grid_stats'
+        DefenseGridStats.new(steam_id)
+      when 'dod:s'
+        require 'steam/community/dods/dods_stats'
+        DoDSStats.new(steam_id)
+      when 'l4d'
+        require 'steam/community/l4d/l4d_stats'
+        L4DStats.new(steam_id)
+      when 'l4d2'
+        require 'steam/community/l4d/l4d2_stats'
+        L4D2Stats.new(steam_id)
+      when 'portal2'
+        require 'steam/community/portal2/portal2_stats'
+        Portal2Stats.new steam_id
+      when 'tf2'
+        require 'steam/community/tf2/tf2_stats'
+        TF2Stats.new(steam_id)
+      else
+        new(steam_id, game_name)
+    end
+  end
+
+  # Creates a `GameStats` object and fetches data from the Steam Community for
+  # the given user and game
+  #
+  # @param [String, Fixnum] user_id The custom URL or the 64bit Steam ID of the
+  #        user
+  # @param [String] game_id The application ID or friendly name of the game
+  # @raise [SteamCondenserError] if the stats cannot be fetched
+  def initialize(user_id, game_id)
+    parse "#{self.class.base_url(user_id, game_id)}?xml=all"
+
+    @user = SteamId.new user_id, false
+
+    error = @xml_data['error']
+    raise SteamCondenserError, error unless error.nil?
+
+    @privacy_state = @xml_data['privacyState']
+    if public?
+      app_id        = @xml_data['game']['gameLink'].match(/http:\/\/steamcommunity\.com\/+app\/+([1-9][0-9]*)/)[1].to_i
+      @game         = SteamGame.new app_id, @xml_data['game']
+      @hours_played = @xml_data['stats']['hoursPlayed'] unless @xml_data['stats']['hoursPlayed'].nil?
+    end
+  end
+
+  # Returns the achievements for this stats' user and game
+  #
+  # If the achievements' data hasn't been parsed yet, parsing is done now.
+  #
+  # @return [Array<GameAchievement>] All achievements belonging to this game
+  def achievements
+    return unless public?
+
+    if @achievements.nil?
+      @achievements = Array.new
+      @xml_data['achievements']['achievement'].each do |achievement|
+        @achievements << GameAchievement.new(@user, @game, achievement)
+      end
+
+      @achievements_done = @achievements.reject{ |a| !a.unlocked? }.size
+    end
+
+    @achievements
+  end
+
+  # Returns the number of achievements done by this player
+  #
+  # If achievements haven't been parsed yet for this player and this game,
+  # parsing is done now.
+  #
+  # @return [Fixnum] The number of achievements completed
+  # @see #achievements
+  def achievements_done
+    achievements if @achievements_done.nil?
+    @achievements_done
+  end
+
+  # Returns the percentage of achievements done by this player
+  #
+  # If achievements haven't been parsed yet for this player and this game,
+  # parsing is done now.
+  #
+  # @return [Float] The percentage of achievements completed
+  # @see #achievements_done
+  def achievements_percentage
+    achievements_done.to_f / @achievements.size
+  end
+
+  # Returns the base Steam Communtiy URL for the stats contained in this object
+  #
+  # @return [String] The base URL used for queries on these stats
+  def base_url
+    self.class.base_url @user.id, @game.id
+  end
+
+  # Returns whether this Steam ID is publicly accessible
+  #
+  # @return [Boolean] `true` if this Steam ID is publicly accessible
+  def public?
+    @privacy_state == 'public'
+  end
+
+end

data/pkg/steam-condenser-1.3.6/pkg/steam-condenser-1.3.5/lib/steam/community/game_weapon.rb

@@ -0,0 +1,41 @@
+# 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
+
+# A module implementing basic functionality for classes representing game
+# weapons
+#
+# @author Sebastian Staudt
+module GameWeapon
+
+  # Returns the number of kills achieved with this weapon
+  #
+  # @return [Fixnum] The number of kills achieved
+  attr_reader :kills
+
+  # Returns the unique identifier for this weapon
+  #
+  # @return [String] The identifier of this weapon
+  attr_reader :id
+
+  # Returns the number of shots fired with this weapon
+  #
+  # @return [Fixnum] The number of shots fired
+  attr_reader :shots
+
+  # Creates a new game weapon instance with the data provided
+  #
+  # @param [Hash<String, Object>] weapon_data The data representing this weapon
+  def initialize(weapon_data)
+    @kills = weapon_data['kills'].to_i
+  end
+
+  # Returns the average number of shots needed for a kill with this weapon
+  #
+  # @return [Float] The average number of shots needed for a kill
+  def avg_shots_per_kill
+    @shots.to_f / @kills
+  end
+
+end

data/pkg/steam-condenser-1.3.6/pkg/steam-condenser-1.3.5/lib/steam/community/l4d/abstract_l4d_stats.rb

@@ -0,0 +1,185 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2009-2013, Sebastian Staudt
+
+require 'steam/community/game_stats'
+
+# This module is a base 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.
+#
+# @author Sebastian Staudt
+module AbstractL4DStats
+
+  # The names of the special infected in Left4Dead
+  SPECIAL_INFECTED = %w(boomer hunter smoker tank)
+
+  # Returns a hash of statistics for this user's most recently played game
+  #
+  # @return [Hash<String, Object>] The most recent statistics for this user
+  attr_reader :most_recent_game
+
+  # Creates a new instance of statistics for both, Left4Dead and Left4Dead 2
+  # parsing basic common data
+  #
+  # @param [String] steam_id The custom URL or 64bit Steam ID of the user
+  # @param [String] game_name The name of the game
+  def initialize(steam_id, game_name)
+    super steam_id, game_name
+
+    if public?
+      most_recent_game_data = @xml_data['stats']['mostrecentgame']
+
+      @most_recent_game = {}
+      unless most_recent_game_data.nil?
+        @most_recent_game[:difficulty]  = most_recent_game_data['difficulty']
+        @most_recent_game[:escaped]     = (most_recent_game_data['bEscaped'] == 1)
+        @most_recent_game[:movie]       = most_recent_game_data['movie']
+        @most_recent_game[:time_played] = most_recent_game_data['time']
+      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.
+  #
+  # @return [Hash<String, Object>] The favorites of this user
+  def favorites
+    return unless public?
+
+    if @favorites.nil?
+      favorites_data = @xml_data['stats']['favorites']
+
+      @favorites = {}
+      @favorites[:campaign]                 = favorites_data['campaign']
+      @favorites[:campaign_percentage]      = favorites_data['campaignpct'].to_i
+      @favorites[:character]                = favorites_data['character']
+      @favorites[:character_percentage]     = favorites_data['characterpct'].to_i
+      @favorites[:level1_weapon]            = favorites_data['weapon1']
+      @favorites[:level1_weapon_percentage] = favorites_data['weapon1pct'].to_i
+      @favorites[:level2_weapon]            = favorites_data['weapon2']
+      @favorites[:level2_weapon_percentage] = favorites_data['weapon2pct'].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.
+  #
+  # @return [Hash<String, Object>] The lifetime statistics for this user
+  def lifetime_stats
+    return unless public?
+
+    if @lifetime_stats.nil?
+      lifetime_data = @xml_data['stats']['lifetime']
+
+      @lifetime_stats = {}
+      @lifetime_stats[:finales_survived] = lifetime_data['finales'].to_i
+      @lifetime_stats[:games_played]     = lifetime_data['gamesplayed'].to_i
+      @lifetime_stats[:infected_killed]  = lifetime_data['infectedkilled'].to_i
+      @lifetime_stats[:kills_per_hour]   = lifetime_data['killsperhour'].to_f
+      @lifetime_stats[:avg_kits_shared]  = lifetime_data['kitsshared'].to_f
+      @lifetime_stats[:avg_kits_used]    = lifetime_data['kitsused'].to_f
+      @lifetime_stats[:avg_pills_shared] = lifetime_data['pillsshared'].to_f
+      @lifetime_stats[:avg_pills_used]   = lifetime_data['pillsused'].to_f
+      @lifetime_stats[:time_played]      = lifetime_data['timeplayed']
+
+      @lifetime_stats[:finales_survived_percentage] = @lifetime_stats[:finales_survived].to_f / @lifetime_stats[:games_played]
+    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.
+  #
+  # @return [Hash<String, Object>] The Survival statistics for this user
+  def survival_stats
+    return unless public?
+
+    if @survival_stats.nil?
+      survival_data = @xml_data['stats']['survival']
+
+      @survival_stats = {}
+      @survival_stats[:gold_medals]   = survival_data['goldmedals'].to_i
+      @survival_stats[:silver_medals] = survival_data['silvermedals'].to_i
+      @survival_stats[:bronze_medals] = survival_data['bronzemedals'].to_i
+      @survival_stats[:rounds_played] = survival_data['roundsplayed'].to_i
+      @survival_stats[:best_time]     = survival_data['besttime'].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.
+  #
+  # @return [Hash<String, Object>] The teamplay statistics for this
+  def teamplay_stats
+    return unless public?
+
+    if @teamplay_stats.nil?
+      teamplay_data = @xml_data['stats']['teamplay']
+
+      @teamplay_stats = {}
+      @teamplay_stats[:revived]                       = teamplay_data['revived'].to_i
+      @teamplay_stats[:most_revived_difficulty]       = teamplay_data['reviveddiff']
+      @teamplay_stats[:avg_revived]                   = teamplay_data['revivedavg'].to_f
+      @teamplay_stats[:avg_was_revived]               = teamplay_data['wasrevivedavg'].to_f
+      @teamplay_stats[:protected]                     = teamplay_data['protected'].to_i
+      @teamplay_stats[:most_protected_difficulty]     = teamplay_data['protecteddiff']
+      @teamplay_stats[:avg_protected]                 = teamplay_data['protectedavg'].to_f
+      @teamplay_stats[:avg_was_protected]             = teamplay_data['wasprotectedavg'].to_f
+      @teamplay_stats[:friendly_fire_damage]          = teamplay_data['ffdamage'].to_i
+      @teamplay_stats[:most_friendly_fire_difficulty] = teamplay_data['ffdamagediff']
+      @teamplay_stats[:avg_friendly_fire_damage]      = teamplay_data['ffdamageavg'].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.
+  #
+  # @return [Hash<String, Object>] The Versus statistics for this user
+  def versus_stats
+    return unless public?
+
+    if @versus_stats.nil?
+      versus_data = @xml_data['stats']['versus']
+
+      @versus_stats = {}
+      @versus_stats[:games_played]                = versus_data['gamesplayed'].to_i
+      @versus_stats[:games_completed]             = versus_data['gamescompleted'].to_i
+      @versus_stats[:finales_survived]            = versus_data['finales'].to_i
+      @versus_stats[:points]                      = versus_data['points'].to_i
+      @versus_stats[:most_points_infected]        = versus_data['pointsas']
+      @versus_stats[:games_won]                   = versus_data['gameswon'].to_i
+      @versus_stats[:games_lost]                  = versus_data['gameslost'].to_i
+      @versus_stats[:highest_survivor_score]      = versus_data['survivorscore'].to_i
+
+      @versus_stats[:finales_survived_percentage] = @versus_stats[:finales_survived].to_f / @versus_stats[:games_played]
+
+      self.class.const_get(:SPECIAL_INFECTED).each do |infected|
+        @versus_stats[infected] = {}
+        @versus_stats[infected][:special_attacks] = versus_data["#{infected}special"].to_i
+        @versus_stats[infected][:most_damage]     = versus_data["#{infected}dmg"].to_i
+        @versus_stats[infected]['avg_lifespan']    = versus_data["#{infected}lifespan"].to_i
+      end
+    end
+
+    @versus_stats
+  end
+
+end

data/pkg/steam-condenser-1.3.6/pkg/steam-condenser-1.3.5/lib/steam/community/l4d/abstract_l4d_weapon.rb

@@ -0,0 +1,56 @@
+# 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
+
+require 'steam/community/game_weapon'
+
+# This abstract class is a base class for weapons in Left4Dead and Left4Dead 2
+# as the weapon stats for both games are very similar
+#
+# @author Sebastian Staudt
+module AbstractL4DWeapon
+
+  include GameWeapon
+
+  # Returns the overall accuracy of the player with this weapon
+  #
+  # @return [String] The accuracy of the player with this weapon
+  attr_reader :accuracy
+
+  # Returns the percentage of kills with this weapon that have been headshots
+  #
+  # @return [String] The percentage of headshots with this weapon
+  attr_reader :headshots_percentage
+
+  # Returns the ID of the weapon
+  #
+  # @return [String] The ID of the weapon
+  attr_reader :id
+
+  # Returns the percentage of overall kills of the player that have been
+  # achieved with this weapon
+  #
+  # @return [String] The percentage of kills with this weapon
+  attr_reader :kill_percentage
+
+  # Returns the number of shots the player has fired with this weapon
+  #
+  # @return [Fixnum] The number of shots with this weapon
+  attr_reader :shots
+
+  # Creates a new instance of weapon from the given XML data and parses common
+  # data for both, `L4DWeapon` and `L4D2Weapon`
+  #
+  # @param [String] weapon_name The name of this weapon
+  # @param [Hash<String, Object>] weapon_data The XML data for this weapon
+  def initialize(weapon_name, weapon_data)
+    super weapon_data
+
+    @accuracy             = weapon_data['accuracy'].to_f * 0.01
+    @headshots_percentage = weapon_data['headshots'].to_f * 0.01
+    @id                   = weapon_name
+    @shots                = weapon_data['shots'].to_i
+  end
+
+end