steam-condenser 0.14.0 → 1.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    steam-condenser (1.0.0)
+      bzip2-ruby (~> 0.2.7)
+      multi_json (~> 1.0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bzip2-ruby (0.2.7)
+    multi_json (1.0.3)
+    rake (0.9.2)
+    yard (0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 0.9.2)
+  steam-condenser!
+  yard (~> 0.7.2)

data/LICENSE

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

data/README.md

@@ -10,9 +10,16 @@ Currently it is implemented in Java, PHP and Ruby.
 * Linux, MacOS X or Windows
 * Ruby 1.8.6 or newer
 
-  The following gems are required:
-  * `bzip2-ruby (for Source servers sending compressed responses)
-  * `json` (for the Web API features)
+The following gems are required:
+
+* `bzip2-ruby` (for Source servers sending compressed responses)
+* `json` (for the Web API features)
+
+## Installation
+
+To install Steam Condenser as a Ruby gem use the following command:
+
+    gem install steam-condenser
 
 ## License
 
@@ -27,9 +34,10 @@ included LICENSE file.
 
 ## See Also
 
-* [Steam Condenser home](http://koraktor.github.com/steam-condenser)
-* [Documentation](http://www.rdoc.info/projects/koraktor/steam-condenser)
-* [GitHub project page](http://github.com/koraktor/steam-condenser)
+* [Steam Condenser home](https://koraktor.de/steam-condenser)
+* [Documentation](http://rubydoc.info/gems/steam-condenser)
+* [GitHub project page](https://github.com/koraktor/steam-condenser)
+* [Wiki](https://github.com/koraktor/steam-condenser/wiki)
 * [Google group](http://groups.google.com/group/steam-condenser)
 * [Ohloh profile](http://www.ohloh.net/projects/steam-condenser)
 

data/Rakefile

@@ -0,0 +1,35 @@
+# 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 'rubygems'
+require 'rubygems/package_task'
+
+Gem::PackageTask.new Gem::Specification.load 'steam-condenser.gemspec' do |pkg|
+end
+
+# Check if YARD is installed
+begin
+  require 'yard'
+
+  # Create a rake task +:doc+ to build the documentation using YARD
+  YARD::Rake::YardocTask.new do |yardoc|
+    yardoc.name    = 'doc'
+    yardoc.files   = [ 'lib/**/*.rb', 'LICENSE', 'README.md' ]
+    yardoc.options = [ '--private', '--title', 'Metior — API Documentation' ]
+  end
+rescue LoadError
+  # Create a rake task +:doc+ to show that YARD is not installed
+  desc 'Generate YARD Documentation (not available)'
+  task :doc do
+    $stderr.puts 'You need YARD to build the documentation. Install it using `gem install yard`.'
+  end
+end
+
+# Task for cleaning documentation and package directories
+desc 'Clean documentation and package directories'
+task :clean do
+  FileUtils.rm_rf 'doc'
+  FileUtils.rm_rf 'pkg'
+end

data/lib/{stringio_additions.rb → core_ext/stringio.rb}

@@ -17,7 +17,7 @@ class StringIO
   # @param [Fixnum] size The size the new instance should have
   # @return [StringIO] A new `StringIO` instance with the given size, filled
   #         with zero-bytes
-  def self.allocate(size)
+  def self.alloc(size)
     new "\0" * size
   end
 

data/lib/{exceptions/packet_format_exception.rb → errors/packet_format_error.rb}

@@ -3,17 +3,17 @@
 #
 # Copyright (c) 2008-2011, Sebastian Staudt
 
-require 'exceptions/steam_condenser_exception'
+require 'errors/steam_condenser_error'
 
-# This exception class indicates a problem when parsing packet data from the
+# This error class indicates a problem when parsing packet data from the
 # responses received from a game or master server
 #
 # @author Sebastian Staudt
-class PacketFormatException < SteamCondenserException
+class PacketFormatError < SteamCondenserError
 
-  # Creates a new `PacketFormatException` instance
+  # Creates a new `PacketFormatError` instance
   #
-  # @param [String] message The message to attach to the exception
+  # @param [String] message The message to attach to the error
   def initialize(message)
     super message
   end

data/lib/{exceptions/rcon_ban_exception.rb → errors/rcon_ban_error.rb}

@@ -3,18 +3,18 @@
 #
 # Copyright (c) 2009-2011, Sebastian Staudt
 
-require 'exceptions/steam_condenser_exception'
+require 'errors/steam_condenser_error'
 
-# This exception class indicates that the IP address your accessing the game
-# server from has been banned by the server
+# 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 RCONBanException < SteamCondenserException
+class RCONBanError < SteamCondenserError
 
-  # Creates a new `RCONBanException` instance
+  # Creates a new `RCONBanError` instance
   def initialize
     super 'You have been banned from this server.'
   end

data/lib/{exceptions/rcon_no_auth_exception.rb → errors/rcon_no_auth_error.rb}

@@ -3,17 +3,17 @@
 #
 # Copyright (c) 2008-2011, Sebastian Staudt
 
-require 'exceptions/steam_condenser_exception'
+require 'errors/steam_condenser_error'
 
-# This exception class indicates that you have not authenticated yet with the
-# game server you're trying to send commands via RCON
+# 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 RCONNoAuthException < SteamCondenserException
+class RCONNoAuthError < SteamCondenserError
 
-  # Creates a new `RCONNoAuthException` instance
+  # Creates a new `RCONNoAuthError` instance
   def initialize
     super 'Not authenticated yet.'
   end

data/lib/{exceptions/steam_condenser_exception.rb → errors/steam_condenser_error.rb}

@@ -3,9 +3,9 @@
 #
 # Copyright (c) 2008-2011, Sebastian Staudt
 
-# This exception class is used as a base class for all exceptions related to
-# Steam Condenser's operation
+# This error class is used as a base class for all errors related to Steam
+# Condenser's operation
 #
 # @author Sebastian Staudt
-class SteamCondenserException < StandardError
+class SteamCondenserError < StandardError
 end

data/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/lib/{exceptions/web_api_exception.rb → errors/web_api_error.rb}

@@ -3,26 +3,26 @@
 #
 # Copyright (c) 2011, Sebastian Staudt
 
-require 'exceptions/steam_condenser_exception'
+require 'errors/steam_condenser_error'
 
-# This exception 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
+# 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 WebApiException < SteamCondenserException
+class WebApiError < SteamCondenserError
 
-  # Creates a new `WebApiException` with an error message according to the given
+  # 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 exception:
+  #        symbolic name for the problem which caused this error:
   #
   #        * `:http_error`: An error during the HTTP request itself will result
-  #           in an exception with this reason.
+  #           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
@@ -31,7 +31,7 @@ class WebApiException < SteamCondenserException
   #          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
+  #          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.

data/lib/steam/community/alien_swarm/alien_swarm_mission.rb

@@ -1,19 +1,94 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2010, Sebastian Staudt
+# Copyright (c) 2010-2011, Sebastian Staudt
 
-# AlienSwarmMission holds statistical information about missions played by a
-# player in Alien Swarm.
+# This class holds statistical information about missions played by a player in
+# Alien Swarm
+#
+# @author Sebastian Staudt
 class AlienSwarmMission
 
-  attr_reader :avg_damage_taken, :avg_friendly_fire, :avg_kills,
-              :best_difficulty, :damage_taken, :friendly_fire,
-              :games_successful, :img, :kills, :map_name, :name, :time,
-              :total_games, :total_games_percentage
+  # 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 instance of AlienSwarmMission based on the assigned mission
-  # name and XML data
+  # Creates a new mission instance of based on the given XML data
+  #
+  # @param [REXML::Element] mission_data The data representing this mission
   def initialize(mission_data)
     @avg_damage_taken       = mission_data.elements['damagetakenavg'].text.to_f
     @avg_friendly_fire      = mission_data.elements['friendlyfireavg'].text.to_f

data/lib/steam/community/alien_swarm/alien_swarm_stats.rb

@@ -1,19 +1,25 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2010, Sebastian Staudt
+# Copyright (c) 2010-2011, Sebastian Staudt
 
 require 'steam/community/alien_swarm/alien_swarm_mission'
 require 'steam/community/alien_swarm/alien_swarm_weapon'
 
-# The AlienSwarmStats class represents the game statistics for a single user in
-# Alien Swarm
+# 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://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',
@@ -21,8 +27,11 @@ class AlienSwarmStats < GameStats
               'Rifle', 'Rifle_Grenade', 'Sentry_Gun', 'Shotgun',
               'Tesla_Cannon', 'Vindicator', 'Vindicator_Grenade' ]
 
-  # Creates an AlienSwarmStats object by calling the super constructor with the
-  # game name "alienswarm"
+  # 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
   def initialize(steam_id)
     super steam_id, 'alienswarm'
 
@@ -54,8 +63,11 @@ class AlienSwarmStats < GameStats
     end
   end
 
-  # Returns a Hash of favorites for this user like weapons and marine.
+  # 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?
 
@@ -86,8 +98,12 @@ class AlienSwarmStats < GameStats
     @favorites
   end
 
-  # Returns a Hash of item stats for this user like ammo deployed and medkits
-  # used. If the items haven't been parsed already, parsing is done now.
+  # 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?
 
@@ -119,9 +135,12 @@ class AlienSwarmStats < GameStats
     @item_stats
   end
 
-  # Returns a Hash of AlienSwarmMission for this user containing all Alien
-  # Swarm missions. If the missions haven't been parsed already, parsing is
-  # done now.
+  # 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?
 
@@ -135,8 +154,12 @@ class AlienSwarmStats < GameStats
     @mission_stats
   end
 
-  # Returns a Hash of AlienSwarmWeapon for this user containing all Alien Swarm
-  # weapons. If the weapons haven't been parsed already, parsing is done now.
+  # 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?