steam-condenser 0.14.0 → 1.0.1

data/lib/steam/community/css/css_weapon.rb

@@ -1,16 +1,38 @@
-# 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
 
-# CSSWeapon holds statistical information about weapons used by a player in
-# Counter-Strike: Source.
+# Represents the stats for a Counter-Strike: Source weapon for a specific user
+#
+# @author Sebastian Staudt
 class CSSWeapon
 
-  attr_reader :accuracy, :hits, :name, :kills, :ksratio, :shots
+  # Returns the number of hits achieved with this weapon
+  #
+  # @return [Fixnum] The number of hits achieved
+  attr_reader :hits
+
+  # Returns the name of this weapon
+  #
+  # @return [String] The name of this weapon
+  attr_reader :name
+
+  # Returns the number of kills achieved with this weapon
+  #
+  # @return [Fixnum] The number of kills achieved
+  attr_reader :kills
+
+  # Returns the number of shots fired with this weapon
+  #
+  # @return [Fixnum] The number of shots fired
+  attr_reader :shots
 
-  # Creates a new instance of CSSWeapon based on the assigned weapon name and
-  # XML data
+  # Creates a new instance of a Counter-Strike: Source weapon based on the
+  # given XML data
+  #
+  # @param [String] weapon_name The name of the weapon
+  # @param [REXML::Element] weapons_data The XML data of all weapons
   def initialize(weapon_name, weapons_data)
     @name     = weapon_name
 
@@ -20,14 +42,28 @@ class CSSWeapon
     if @name != 'grenade' && @name != 'knife'
       @hits     = weapons_data.elements["#{@name}_hits"].text.to_i
       @shots    = weapons_data.elements["#{@name}_shots"].text.to_i
-      @accuracy = (@shots > 0) ? @hits.to_f / @shots : 0
-      @ksratio  = (@shots > 0) ? @kills.to_f / @shots : 0
     end
   end
 
+  # Returns the accuracy of this player with this weapon
+  #
+  # @return [Float] The accuracy with this weapon
+  def accuracy
+    (@shots > 0) ? @hits.to_f / @shots : 0
+  end
+
   # Returns whether this weapon is the favorite weapon of this player
+  #
+  # @return [Boolean] `true` if this is the favorite weapon
   def favorite?
     @favorite
   end
 
+  # Returns the kill-shot-ratio of this player with this weapon
+  #
+  # @return [Float] The kill-shot-ratio
+  def ksratio
+    (@shots > 0) ? @kills.to_f / @shots : 0
+  end
+
 end

data/lib/steam/community/defense_grid/defense_grid_stats.rb

@@ -1,23 +1,131 @@
-# 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) 2009-2010, Sebastian Staudt
+# Copyright (c) 2009-2011, Sebastian Staudt
 
 require 'steam/community/game_stats'
 
-# The DefenseGridStats class represents the game statistics for a single user in
-# Defense Grid: The Awakening
+# This class represents the game statistics for a single user in Defense Grid:
+# The Awakening
+#
+# @author Sebastian Staudt
 class DefenseGridStats < GameStats
 
-  attr_reader :bronze_medals, :damage_done, :damage_campaign, :damage_challenge,
-              :encountered, :gold_medals, :heat_damage, :interest, :killed,
-              :killed_campaign, :killed_challenge,  :levels_played,
-              :levels_played_campaign, :levels_played_challenge, :levels_won,
-              :levels_won_campaign, :levels_won_challenge, :orbital_laser_fired,
-              :orbital_laser_damage, :resources, :silver_medals, :time_played
+  # Returns the bronze medals won by this player
+  #
+  # @return [Fixnum] Bronze medals won
+  attr_reader :bronze_medals
+
+  # Returns the damage done by this player
+  #
+  # @return [Float] Damage done
+  attr_reader :damage_done
+
+  # Returns the damage done during the campaign by this player
+  #
+  # @return [Float] Damage done during the campaign
+  attr_reader :damage_campaign
+
+  # Returns the damage done during challenges by this player
+  #
+  # @return [Float] Damage done during challenges
+  attr_reader :damage_challenge
+
+  # Returns the aliens encountered by this player
+  #
+  # @return [Fixnum] Aliens encountered
+  attr_reader :encountered
+
+  # Returns the gold medals won by this player
+  #
+  # @return [Fixnum] Gold medals won
+  attr_reader :gold_medals
+
+  # Returns the heat damage done by this player
+  #
+  # @return [Float] Heat damage done
+  attr_reader :heat_damage
+
+  # Returns the interest gained by the player
+  #
+  # @return [Fixnum] Interest gained
+  attr_reader :interest
+
+  # Returns the aliens killed by the player
+  #
+  # @return [Fixnum] Aliens killed
+  attr_reader :killed
+
+  # Returns the aliens killed during the campaign by the player
+  #
+  # @return [Fixnum] Aliens killed during the campaign
+  attr_reader :killed_campaign
+
+  # Returns the aliens killed during challenges by the player
+  #
+  # @return [Fixnum] Aliens killed during challenges
+  attr_reader :killed_challenge
+
+  # Returns the number of levels played by the player
+  #
+  # @return [Fixnum] Number of levels played
+  attr_reader :levels_played
 
-  # Creates a DefenseGridStats object by calling the super constructor with the
-  # game name "defensegrid:awakening"
+  # Returns the number of levels played during the campaign by the player
+  #
+  # @return [Fixnum] Number of levels played during the campaign
+  attr_reader :levels_played_campaign
+
+  # Returns the number of levels played during challenges by the player
+  #
+  # @return [Fixnum] Number of levels played during challenges
+  attr_reader :levels_played_challenge
+
+  # Returns the number of levels won by the player
+  #
+  # @return [Fixnum] Number of levels won
+  attr_reader :levels_won
+
+  # Returns the number of levels won during the campaign by the player
+  #
+  # @return [Fixnum] Number of levels during the campaign won
+  attr_reader :levels_won_campaign
+
+  # Returns the number of levels won during challenges by the player
+  #
+  # @return [Fixnum] Number of levels during challenges won
+  attr_reader :levels_won_challenge
+
+  # Returns the damage dealt by the orbital laser
+  #
+  # @return [Float] Damage dealt by the orbital laser
+  attr_reader :orbital_laser_fired
+
+  # Returns the number of times the orbital lasers has been fired by the player
+  #
+  # @return [Fixnum] Number of times the orbital laser has been fired
+  attr_reader :orbital_laser_damage
+
+  # Returns the amount of resources harvested by the player
+  #
+  # @return [Fixnum] Resources harvested by the player
+  attr_reader :resources
+
+  # Returns the silver medals won by this player
+  #
+  # @return [Fixnum] Silver medals won
+  attr_reader :silver_medals
+
+  # Returns the time played in seconds by the player
+  #
+  # @return [Float] Time played
+  attr_reader :time_played
+
+  # Creates a `DefenseGridStats` instance by calling the super constructor with
+  # the game name `'defensegrid:awakening'`
+  #
+  # @param [String, Fixnum] steam_id The custom URL or the 64bit Steam ID of
+  #        the user
   def initialize(steam_id)
     super(steam_id, 'defensegrid:awakening')
 
@@ -28,7 +136,7 @@ class DefenseGridStats < GameStats
       @silver_medals           = general_data.elements['silver_medals_won/value'].text.to_i
       @gold_medals             = general_data.elements['gold_medals_won/value'].text.to_i
       @levels_played           = general_data.elements['levels_played_total/value'].text.to_i
-      @levels_played_campagin  = general_data.elements['levels_played_campaign/value'].text.to_i
+      @levels_played_campaign  = general_data.elements['levels_played_campaign/value'].text.to_i
       @levels_played_challenge = general_data.elements['levels_played_challenge/value'].text.to_i
       @levels_won              = general_data.elements['levels_won_total/value'].text.to_i
       @levels_won_campaign     = general_data.elements['levels_won_campaign/value'].text.to_i
@@ -41,7 +149,7 @@ class DefenseGridStats < GameStats
       @heat_damage             = general_data.elements['heatdamage/value'].text.to_f
       @time_played             = general_data.elements['time_played/value'].text.to_f
       @interest                = general_data.elements['interest_gained/value'].text.to_f
-      @damage                  = general_data.elements['tower_damage_total/value'].text.to_f
+      @damage_done             = general_data.elements['tower_damage_total/value'].text.to_f
       @damage_campaign         = general_data.elements['tower_damage_total_campaign/value'].text.to_f
       @damage_challenge        = general_data.elements['tower_damage_total_challenge/value'].text.to_f
       @orbital_laser_fired     = @xml_data.elements['stats/orbitallaser/fired/value'].text.to_i
@@ -49,11 +157,13 @@ class DefenseGridStats < GameStats
     end
   end
 
-  # Returns stats about the towers built
+  # Returns stats about the aliens encountered by the player
   #
   # The Hash returned uses the names of the aliens as keys. Every value of the
   # Hash is an Array containing the number of aliens encountered as the first
   # element and the number of aliens killed as the second element.
+  #
+  # @return [Hash<String, Array<Fixnum>>] Stats about the aliens encountered
   def alien_stats
     return unless public?
 
@@ -74,7 +184,7 @@ class DefenseGridStats < GameStats
     @alien_stats
   end
 
-  # Returns stats about the towers built
+  # Returns stats about the towers built by the player
   #
   # The Hash returned uses the names of the towers as keys. Every value of
   # the Hash is another Hash using the keys 1 to 3 for different tower levels.
@@ -84,6 +194,8 @@ class DefenseGridStats < GameStats
   #
   # The Command tower uses the resources gained as second element.
   # The Temporal tower doesn't have a second element.
+  #
+  # @return [Hash<String, Array<Fixnum>>] Stats about the towers built
   def tower_stats
     return unless public?
 

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

@@ -1,20 +1,76 @@
-# 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) 2009-2010, Sebastian Staudt
+# Copyright (c) 2009-2011, Sebastian Staudt
 
 require 'steam/community/game_class'
 
-# Represents the stats for a DoD:S class for a specific user
+# Represents the stats for a Day of Defeat: Source class for a specific user
+#
+# @author Sebastian Staudt
 class DoDSClass
 
   include GameClass
 
-  attr_reader :blocks, :bombs_defused, :bombs_planted, :captures, :deaths,
-              :dominations, :key, :kills, :name, :rounds_lost, :rounds_won,
-              :revenges
+  # Returns the blocks achieved by the player with this class
+  #
+  # @return [Fixnum] The blocks achieved by the player
+  attr_reader :blocks
+
+  # Returns the bombs defused by the player with this class
+  #
+  # @return [Fixnum] The bombs defused by the player
+  attr_reader :bombs_defused
+
+  # Returns the bombs planted by the player with this class
+  #
+  # @return [Fixnum] the bombs planted by the player
+  attr_reader :bombs_planted
+
+  # Returns the number of points captured by the player with this class
+  #
+  # @return [Fixnum] The number of points captured by the player
+  attr_reader :captures
+
+  # Returns the number of times the player died with this class
+  #
+  # @return [Fixnum] The number of deaths by the player
+  attr_reader :deaths
+
+  # Returns the dominations achieved by the player with this class
+  #
+  # @return [Fixnum] The dominations achieved by the player
+  attr_reader :dominations
+
+  # Returns the ID of this class
+  #
+  # @return [String] The ID of this class
+  attr_reader :key
+
+  # Returns the number of enemies killed by the player with this class
+  #
+  # @return [Fixnum] The number of enemies killed by the player
+  attr_reader :kills
+
+  # Returns the number of rounds lost with this class
+  #
+  # @return [Fixnum] The number of rounds lost with this class
+  attr_reader :rounds_lost
+
+  # Returns the revenges achieved by the player with this class
+  #
+  # @return [Fixnum] The revenges achieved by the player
+  attr_reader :revenges
+
+  # Returns the number of rounds won with this class
+  #
+  # @return [Fixnum] The number of rounds won with this class
+  attr_reader :rounds_won
 
-  # Creates a new instance of DoDSClass based on the assigned XML data
+  # Creates a new instance of a Day of Defeat: Source class based on the given
+  # XML data
+  #
+  # @param [REXML::Element] class_data The XML data of the class
   def initialize(class_data)
     @blocks        = class_data.elements['blocks'].text.to_i
     @bombs_defused = class_data.elements['bombsdefused'].text.to_i
@@ -24,8 +80,8 @@ class DoDSClass
     @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
+    @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

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

@@ -1,21 +1,31 @@
-# 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) 2009-2010, Sebastian Staudt
+# Copyright (c) 2009-2011, Sebastian Staudt
 
 require 'steam/community/dods/dods_weapon'
 require 'steam/community/game_stats'
 
+# The is class represents the game statistics for a single user in Day of
+# Defeat: Source
+#
+# @author Sebastian Staudt
 class DoDSStats < GameStats
 
-  # Creates a DoDSStats object by calling the super constructor with the game
-  # name "DoD:S"
+  # Creates a `DoDSStats` instance by calling the super constructor with the
+  # game name `'DoD:S'`
+  #
+  # @param [String, Fixnum] steam_id The custom URL or 64bit Steam ID of the
+  #        user
   def initialize(steam_id)
     super steam_id, 'DoD:S'
   end
 
-  # Returns a Hash of DoDSClass for this user containing all DoD:S classes.
+  # 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.
+  #
+  # @return [Hash<String, DoDSClass>] The class statistics for this user
   def class_stats
     return unless public?
 
@@ -29,8 +39,11 @@ class DoDSStats < GameStats
     @class_stats
   end
 
-  # Returns a Hash of DoDSWeapon for this user containing all DoD:S weapons.
+  # 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.
+  #
+  # @return [Hash<String, DoDSWeapon>] The weapon statistics for this user
   def weapon_stats
     return unless public?
 

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

@@ -1,18 +1,36 @@
-# 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) 2009-2010, Sebastian Staudt
+# Copyright (c) 2009-2011, Sebastian Staudt
 
 require 'steam/community/game_weapon'
 
 # Represents the stats for a Day of Defeat: Source weapon for a specific user
+#
+# @author Sebastian Staudt
 class DoDSWeapon
 
   include GameWeapon
 
-  attr_reader :headshots, :name, :hits
+  # Returns the number of headshots achieved with this weapon
+  #
+  # @return [Fixnum] The number of headshots achieved
+  attr_reader :headshots
+
+  # Returns the name of this weapon
+  #
+  # @return [String] The name of this weapon
+  attr_reader :name
+
+  # Returns the number of hits achieved with this weapon
+  #
+  # @return [Fixnum] The number of hits achieved
+  attr_reader :hits
 
-  # Creates a new instance of DoDSWeapon based on the assigned XML data
+  # Creates a new instance of a Day of Defeat: Source weapon based on the
+  # given XML data
+  #
+  # @param [REXML::Element] weapon_data The XML data of the class
   def initialize(weapon_data)
     super weapon_data
 
@@ -23,34 +41,27 @@ class DoDSWeapon
     @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.
+  # Returns the average number of hits needed for a kill with this weapon
+  #
+  # @return [Float] The average number of hits needed for a kill
   def avg_hits_per_kill
-    if @avg_hits_per_kill.nil?
-      @avg_hits_per_kill = @hits.to_f / @kills
-    end
-
-    @avg_hits_per_kill
+    @hits.to_f / @kill
   end
 
   # Returns the percentage of headshots relative to the shots hit with this
-  # weapon. Calculates the value if needed.
+  # weapon
+  #
+  # @return [Float] The percentage of headshots
   def headshot_percentage
-    if @headshot_percentage.nil?
-      @headshot_percentage = @headshots.to_f / @hits
-    end
-
-    @headshot_percentage
+    @headshots.to_f / @hits
   end
 
   # Returns the percentage of hits relative to the shots fired with this
-  # weapon. Calculates the value if needed.
+  # weapon
+  #
+  # @return [Float] The percentage of hits
   def hit_percentage
-    if @hit_percentage.nil?
-      @hit_percentage = @hits.to_f / @shots
-    end
-
-    @hit_percentage
+    @hits.to_f / @shots
   end
 
 end