steam-condenser 1.3.6 → 1.3.7

data/pkg/steam-condenser-1.3.6/pkg/steam-condenser-1.3.5/lib/errors/packet_format_error.rb

@@ -0,0 +1,13 @@
+# 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
+
+require 'errors/steam_condenser_error'
+
+# This error class indicates a problem when parsing packet data from the
+# responses received from a game or master server
+#
+# @author Sebastian Staudt
+class PacketFormatError < SteamCondenserError
+end

data/pkg/steam-condenser-1.3.6/pkg/steam-condenser-1.3.5/lib/errors/rcon_ban_error.rb

@@ -0,0 +1,22 @@
+# 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 'errors/steam_condenser_error'
+
+# This error class indicates that the IP address your accessing the game server
+# from has been banned by the server
+#
+# You or the server operator will have to unban your IP address on the server.
+#
+# @author Sebastian Staudt
+# @see GameServer#rcon_auth
+class RCONBanError < SteamCondenserError
+
+  # Creates a new `RCONBanError` instance
+  def initialize
+    super 'You have been banned from this server.'
+  end
+
+end

data/pkg/steam-condenser-1.3.6/pkg/steam-condenser-1.3.5/lib/errors/rcon_no_auth_error.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) 2008-2011, Sebastian Staudt
+
+require 'errors/steam_condenser_error'
+
+# This error class indicates that you have not authenticated yet with the game
+# server you're trying to send commands via RCON
+#
+# @author Sebastian Staudt
+# @see GameServer#rcon_auth
+# @see GameServer#rcon_exec
+class RCONNoAuthError < SteamCondenserError
+
+  # Creates a new `RCONNoAuthError` instance
+  def initialize
+    super 'Not authenticated yet.'
+  end
+
+end

data/pkg/steam-condenser-1.3.6/pkg/steam-condenser-1.3.5/lib/errors/steam_condenser_error.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-2013, Sebastian Staudt
+
+# This error class is used as a base class for all errors related to Steam
+# Condenser's operation
+#
+# @author Sebastian Staudt
+class SteamCondenserError < StandardError
+
+  # Returns the exception that caused this error
+  #
+  # @return [Exception] The exception that caused this error
+  attr_reader :cause
+
+  # Creates a new `SteamCondenserError` instance
+  #
+  # @param [String] message The message to attach to the error
+  # @param [Exception] cause The exception that caused this error
+  def initialize(message, cause = nil)
+    super message
+    @cause = cause
+  end
+
+end

data/pkg/steam-condenser-1.3.6/pkg/steam-condenser-1.3.5/lib/errors/timeout_error.rb

@@ -0,0 +1,28 @@
+# 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
+
+require 'errors/steam_condenser_error'
+
+module SteamCondenser
+
+  # This error class indicates that an operation could not be finished within a
+  # reasonable amount of time
+  #
+  # This usually indicates that a server could not be contacted because of
+  # network problems.
+  #
+  # @author Sebastian Staudt
+  # @note {SteamSocket.timeout=} allows to set a custom timeout for socket
+  #       operations
+  class TimeoutError < SteamCondenserError
+
+    # Creates a new `TimeoutError` instance
+    def initialize
+      super 'The operation timed out.'
+    end
+
+  end
+
+end

data/pkg/steam-condenser-1.3.6/pkg/steam-condenser-1.3.5/lib/errors/web_api_error.rb

@@ -0,0 +1,57 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'errors/steam_condenser_error'
+
+# This error is raised when a Steam Web API request or a related action fails.
+# This can have various reasons like an invalid Web API key or a broken
+# request.
+#
+# @author Sebastian Staudt
+# @see WebApi
+class WebApiError < SteamCondenserError
+
+  # Creates a new `WebApiError` with an error message according to the given
+  # `cause`. If this cause is `:status_bad` (which will origin from the Web API
+  # itself) or `:http_error` the details about this failed request will be
+  # taken from `status_code` and `status_message`.
+  #
+  # @param [:http_error, :invalid_key, :status_bad, :unauthorized] cause A
+  #        symbolic name for the problem which caused this error:
+  #
+  #        * `:http_error`: An error during the HTTP request itself will result
+  #           in an error with this reason.
+  #        * `:invalid_key`: This occurs when trying to set a Web API key that
+  #           isn't valid, i.e. a 128 bit integer in a hexadecimal string.
+  #        * `:status_bad`: This is caused by a successful request that fails
+  #          for some Web API internal reason (e.g. an invalid argument).
+  #          Details about this failed request will be taken from `status_code`
+  #          and `status_message`.
+  #        * `:unauthorized`: This happens when a Steam Web API request is
+  #          rejected as unauthorized. This most likely means that you did not
+  #          specify a valid Web API key using {WebApi.api_key=}. A Web API key
+  #          can be obtained from http://steamcommunity.com/dev/apikey.
+  #
+  #        Other undefined reasons will cause a generic error message.
+  # @param [Fixnum] status_code The HTTP status code returned by the Web API
+  # @param [String] status_message The status message returned in the response
+  def initialize(cause, status_code = nil, status_message = '')
+    case cause
+      when :http_error then
+        message = "The Web API request has failed due to an HTTP error: #{status_message} (status code: #{status_code})."
+      when :invalid_key then
+        message = 'This is not a valid Steam Web API key.'
+      when :status_bad then
+        message = "The Web API request failed with the following error: #{status_message} (status code: #{status_code})."
+      when :unauthorized then
+        message = 'Your Web API request has been rejected. You most likely did not specify a valid Web API key.'
+      else
+        message = 'An unexpected error occured while executing a Web API request.'
+    end
+
+    super message
+  end
+
+end

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

@@ -0,0 +1,119 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010-2011, Sebastian Staudt
+
+# This class holds statistical information about missions played by a player in
+# Alien Swarm
+#
+# @author Sebastian Staudt
+class AlienSwarmMission
+
+  # Returns the avarage damage taken by the player while playing a round in
+  # this mission
+  #
+  # @return [Float] The average damage taken by the player
+  attr_reader :avg_damage_taken
+
+  # Returns the avarage damage dealt by the player to team mates while playing
+  # a round in this mission
+  #
+  # @return [Float] The average damage dealt by the player to team mates
+  attr_reader :avg_friendly_fire
+
+  # Returns the avarage number of aliens killed by the player while playing a
+  # round in this mission
+  #
+  # @return [Float] The avarage number of aliens killed by the player
+  attr_reader :avg_kills
+
+  # Returns the highest difficulty the player has beat this mission in
+  #
+  # @return [String] The highest difficulty the player has beat this mission in
+  attr_reader :best_difficulty
+
+  # Returns the total damage taken by the player in this mission
+  #
+  # @return [Fixnum] The total damage taken by the player
+  attr_reader :damage_taken
+
+  # Returns the total damage dealt by the player to team mates in this mission
+  #
+  # @return [Fixnum] The total damage dealt by the player to team mates
+  attr_reader :friendly_fire
+
+  # Returns the number of successful rounds the player played in this mission
+  #
+  # @return [Fixnum] The number of successful rounds of this mission
+  attr_reader :games_successful
+
+  # Returns the URL to a image displaying the mission
+  #
+  # @return [String] The URL of the mission's image
+  attr_reader :img
+
+  # Returns the total number of aliens killed by the player in this mission
+  #
+  # @return [Fixnum] The total number of aliens killed by the player
+  attr_reader :kills
+
+  # Returns the file name of the mission's map
+  #
+  # @return [String] The file name of the mission's map
+  attr_reader :map_name
+
+  # Returns the name of the mission
+  #
+  # @return [String] The name of the mission
+  attr_reader :name
+
+  # Returns various statistics about the times needed to accomplish this
+  # mission
+  #
+  # This includes the best times for each difficulty, the average time and the
+  # total time spent in this mission.
+  #
+  # @return [Hash<Symbol, String>] Various time statistics about this mission
+  attr_reader :time
+
+  # Returns the number of games played in this mission
+  #
+  # @return [Fixnum] The number of games played in this mission
+  attr_reader :total_games
+
+  # Returns the percentage of successful games played in this mission
+  #
+  # @return [Float] The percentage of successful games played in this mission
+  attr_reader :total_games_percentage
+
+  # Creates a new mission instance of based on the given XML data
+  #
+  # @param [String] map_name The name of the mission's map
+  # @param [Hash<String, Object>] mission_data The data representing this
+  #        mission
+  def initialize(map_name, mission_data)
+    @avg_damage_taken       = mission_data['damagetakenavg'].to_f
+    @avg_friendly_fire      = mission_data['friendlyfireavg'].to_f
+    @avg_kills              = mission_data['killsavg'].to_f
+    @best_difficulty        = mission_data['bestdifficulty']
+    @damage_taken           = mission_data['damagetaken'].to_i
+    @friendly_fire          = mission_data['friendlyfire'].to_i
+    @games_successful       = mission_data['gamessuccess'].to_i
+    @img                    = AlienSwarmStats::BASE_URL + mission_data['image']
+    @kills                  = mission_data['kills'].to_i
+    @map_name               = map_name
+    @name                   = mission_data['name']
+    @total_games            = mission_data['gamestotal'].to_i
+    @total_games_percentage = mission_data['gamestotalpct'].to_f
+
+    @time = {}
+    @time[:average] = mission_data['avgtime']
+    @time[:brutal]  = mission_data['brutaltime']
+    @time[:easy]    = mission_data['easytime']
+    @time[:hard]    = mission_data['hardtime']
+    @time[:insane]  = mission_data['insanetime']
+    @time[:normal]  = mission_data['normaltime']
+    @time[:total]   = mission_data['totaltime']
+  end
+
+end

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

@@ -0,0 +1,186 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010-2011, Sebastian Staudt
+
+require 'steam/community/alien_swarm/alien_swarm_mission'
+require 'steam/community/alien_swarm/alien_swarm_weapon'
+
+# This class represents the game statistics for a single user in Alien Swarm
+#
+# @author Sebastian Staudt
+class AlienSwarmStats < GameStats
+
+  # Returns general stats for the players
+  #
+  # @return [Hash<Symbol, Object>] The stats for the player
+  attr_reader :lifetime_stats
+
+  # The base URL for all images referenced in the stats
+  BASE_URL = 'http://cdn.steamcommunity.com/public/images/gamestats/swarm/'
+
+  # The names of all weapons in Alien Swarm
+  WEAPONS = [ 'Autogun', 'Cannon_Sentry', 'Chainsaw', 'Flamer',
+              'Grenade_Launcher', 'Hand_Grenades', 'Hornet_Barrage',
+              'Incendiary_Sentry', 'Laser_Mines', 'Marskman_Rifle', 'Minigun',
+              'Mining_Laser', 'PDW', 'Pistol', 'Prototype_Rifle', 'Rail_Rifle',
+              'Rifle', 'Rifle_Grenade', 'Sentry_Gun', 'Shotgun',
+              'Tesla_Cannon', 'Vindicator', 'Vindicator_Grenade' ]
+
+  # Creates a new `AlienSwarmStats` instance by calling the super constructor
+  # with the game name `'alienswarm'`
+  #
+  # @param [String, Fixnum] steam_id The custom URL or the 64bit Steam ID of
+  #        the user
+  # @macro cacheable
+  def initialize(steam_id)
+    super steam_id, 'alienswarm'
+
+    if public?
+      lifetime_data = @xml_data['stats']['lifetime']
+
+      @hours_played = lifetime_data['timeplayed']
+
+      @lifetime_stats = {}
+      @lifetime_stats[:accuracy]            = lifetime_data['accuracy'].to_f
+      @lifetime_stats[:aliens_burned]       = lifetime_data['aliensburned'].to_i
+      @lifetime_stats[:aliens_killed]       = lifetime_data['alienskilled'].to_i
+      @lifetime_stats[:campaigns]           = lifetime_data['campaigns'].to_i
+      @lifetime_stats[:damage_taken]        = lifetime_data['damagetaken'].to_i
+      @lifetime_stats[:experience]          = lifetime_data['experience'].to_i
+      @lifetime_stats[:experience_required] = lifetime_data['xprequired'].to_i
+      @lifetime_stats[:fast_hacks]          = lifetime_data['fasthacks'].to_i
+      @lifetime_stats[:friendly_fire]       = lifetime_data['friendlyfire'].to_i
+      @lifetime_stats[:games_successful]    = lifetime_data['gamessuccess'].to_i
+      @lifetime_stats[:healing]             = lifetime_data['healing'].to_i
+      @lifetime_stats[:kills_per_hour]      = lifetime_data['killsperhour'].to_f
+      @lifetime_stats[:level]               = lifetime_data['level'].to_i
+      @lifetime_stats[:promotion]           = lifetime_data['promotion'].to_i
+      @lifetime_stats[:promotion_img]       = BASE_URL + lifetime_data['promotionpic'] if @lifetime_stats[:promotion] > 0
+      @lifetime_stats[:next_unlock]         = lifetime_data['nextunlock']
+      @lifetime_stats[:next_unlock_img]     = BASE_URL + lifetime_data['nextunlockimg']
+      @lifetime_stats[:shots_fired]         = lifetime_data['shotsfired'].to_i
+      @lifetime_stats[:total_games]         = lifetime_data['totalgames'].to_i
+
+      @lifetime_stats[:games_successful_percentage] = (@lifetime_stats[:total_games] > 0) ? @lifetime_stats[:games_successful].to_f / @lifetime_stats[:total_games] : 0;
+    end
+  end
+
+  # Returns the favorites of this user like weapons and marine
+  #
+  # If the favorites haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<Symbol, Object>] The favorites of this player
+  def favorites
+    return unless public?
+
+    if @favorites.nil?
+      favorites_data = @xml_data['stats']['favorites']
+
+      @favorites = {}
+      @favorites[:class]                       = favorites_data['class']
+      @favorites[:class_img]                   = favorites_data['classimg']
+      @favorites[:class_percentage]            = favorites_data['classpct'].to_f
+      @favorites[:difficulty]                  = favorites_data['difficulty']
+      @favorites[:difficulty_percentage]       = favorites_data['difficultypct'].to_f
+      @favorites[:extra]                       = favorites_data['extra']
+      @favorites[:extra_img]                   = favorites_data['extraimg']
+      @favorites[:extra_percentage]            = favorites_data['extrapct'].to_f
+      @favorites[:marine]                      = favorites_data['marine']
+      @favorites[:marine_img]                  = favorites_data['marineimg']
+      @favorites[:marine_percentage]           = favorites_data['marinepct'].to_f
+      @favorites[:mission]                     = favorites_data['mission']
+      @favorites[:mission_img]                 = favorites_data['missionimg']
+      @favorites[:mission_percentage]          = favorites_data['missionpct'].to_f
+      @favorites[:primary_weapon]              = favorites_data['primary']
+      @favorites[:primary_weapon_img]          = favorites_data['primaryimg']
+      @favorites[:primary_weapon_percentage]   = favorites_data['primarypct'].to_f
+      @favorites[:secondary_weapon]            = favorites_data['secondary']
+      @favorites[:secondary_weapon_img]        = favorites_data['secondaryimg']
+      @favorites[:secondary_weapon_percentage] = favorites_data['secondarypct'].to_f
+    end
+
+    @favorites
+  end
+
+  # Returns the item stats for this user like ammo deployed and medkits
+  # used
+  #
+  # If the items haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<Symbol, Object>] The item stats of this player
+  def item_stats
+    return unless public?
+
+    if @item_stats.nil?
+      weapons_data = @xml_data['stats']['weapons']
+
+      @item_stats = {}
+      @item_stats[:ammo_deployed]             = weapons_data['ammo_deployed'].to_i
+      @item_stats[:sentryguns_deployed]       = weapons_data['sentryguns_deployed'].to_i
+      @item_stats[:sentry_flamers_deployed]   = weapons_data['sentry_flamers_deployed'].to_i
+      @item_stats[:sentry_freeze_deployed]    = weapons_data['sentry_freeze_deployed'].to_i
+      @item_stats[:sentry_cannon_deployed]    = weapons_data['sentry_cannon_deployed'].to_i
+      @item_stats[:medkits_used]              = weapons_data['medkits_used'].to_i
+      @item_stats[:flares_used]               = weapons_data['flares_used'].to_i
+      @item_stats[:adrenaline_used]           = weapons_data['adrenaline_used'].to_i
+      @item_stats[:tesla_traps_deployed]      = weapons_data['tesla_traps_deployed'].to_i
+      @item_stats[:freeze_grenades_thrown]    = weapons_data['freeze_grenades_thrown'].to_i
+      @item_stats[:electric_armor_used]       = weapons_data['electric_armor_used'].to_i
+      @item_stats[:healgun_heals]             = weapons_data['healgun_heals'].to_i
+      @item_stats[:healgun_heals_self]        = weapons_data['healgun_heals_self'].to_i
+      @item_stats[:healbeacon_heals]          = weapons_data['healbeacon_heals'].to_i
+      @item_stats[:healbeacon_heals_self]     = weapons_data['healbeacon_heals_self'].to_i
+      @item_stats[:damage_amps_used]          = weapons_data['damage_amps_used'].to_i
+      @item_stats[:healbeacons_deployed]      = weapons_data['healbeacons_deployed'].to_i
+      @item_stats[:healbeacon_heals_pct]      = weapons_data['healbeacon_heals_pct'].to_f
+      @item_stats[:healgun_heals_pct]         = weapons_data['healgun_heals_pct'].to_f
+      @item_stats[:healbeacon_heals_pct_self] = weapons_data['healbeacon_heals_pct_self'].to_f
+      @item_stats[:healgun_heals_pct_self]    = weapons_data['healgun_heals_pct_self'].to_f
+    end
+
+    @item_stats
+  end
+
+  # Returns the stats for individual missions for this user containing all
+  # Alien Swarm missions
+  #
+  # If the mission stats haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<String, AlienSwarmMission>] The mission stats for this player
+  def mission_stats
+    return unless public?
+
+    if @mission_stats.nil?
+      @mission_stats = {}
+      @xml_data['stats']['missions'].each do |mission_data|
+        mission = AlienSwarmMission.new *mission_data
+        @mission_stats[mission.name] = mission
+      end
+    end
+
+    @mission_stats
+  end
+
+  # Returns the stats for individual weapons for this user containing all
+  # Alien Swarm weapons
+  #
+  # If the weapon stats haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<String, AlienSwarmWeapon>] The weapon stats for this player
+  def weapon_stats
+    return unless public?
+
+    if @weapon_stats.nil?
+      @weapon_stats = {}
+      WEAPONS.each do |weapon_node|
+        weapon_data = @xml_data['stats']['weapons'][weapon_node]
+        weapon = AlienSwarmWeapon.new(weapon_data)
+        @weapon_stats[weapon.name] = weapon
+      end
+    end
+
+    @weapon_stats
+  end
+
+end