steam-condenser 0.14.0 → 1.0.1

data/lib/steam/community/tf2/tf2_class.rb

@@ -1,20 +1,79 @@
-# 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) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/community/game_class'
 
 # Represents the stats for a Team Fortress 2 class for a specific user
+#
+# @author Sebastian Staudt
 module TF2Class
 
   include GameClass
 
-  attr_reader :max_buildings_destroyed, :max_captures, :max_damage,
-              :max_defenses, :max_dominations, :max_kill_assists, :max_kills,
-              :max_revenges, :max_score, :max_time_alive
+  # Returns the maximum number of buildings the player has destroyed in a
+  # single life with this class
+  #
+  # @return [Fixnum] Maximum number of buildings destroyed
+  attr_reader :max_buildings_destroyed
+
+  # Returns the maximum number of points captured by the player in a single
+  # life with this class
+  #
+  # @return [Fixnum] Maximum number of points captured
+  attr_reader :max_captures
+
+  # Returns the maximum damage dealt by the player in a single life with this
+  # class
+  #
+  # @return [Fixnum] Maximum damage dealt
+  attr_reader :max_damage
+
+  # Returns the maximum number of defenses by the player in a single life with
+  # this class
+  #
+  # @return [Fixnum] Maximum number of defenses
+  attr_reader :max_defenses
+
+  # Returns the maximum number of dominations by the player in a single life
+  # with this class
+  #
+  # @return [Fixnum] Maximum number of dominations
+  attr_reader :max_dominations
+
+  # Returns the maximum number of times the the player assisted a teammate with
+  # killing an enemy in a single life with this class
+  #
+  # @return [Fixnum] Maximum number of kill assists
+  attr_reader :max_kill_assists
+
+  # Returns the maximum number of enemies killed by the player in a single life
+  # with this class
+  #
+  # @return [Fixnum] Maximum number of kills
+  attr_reader :max_kills
+
+  # Returns the maximum number of revenges by the player in a single life with
+  # this class
+  #
+  # @return [Fixnum] Maximum number of revenges
+  attr_reader :max_revenges
+
+  # Returns the maximum number score achieved by the player in a single life
+  # with this class
+  #
+  # @return [Fixnum] Maximum score
+  attr_reader :max_score
+
+  # Returns the maximum lifetime by the player in a single life with this class
+  #
+  # @return [Fixnum] Maximum lifetime
+  attr_reader :max_time_alive
 
-  # Creates a new instance of TF2Class based on the assigned XML data
+  # Creates a new TF2 class instance based on the assigned XML data
+  #
+  # @param [REXML::Element] class_data The XML data for this class
   def initialize(class_data)
     @name                    = class_data.elements['className'].text
     @max_buildings_destroyed = class_data.elements['ibuildingsdestroyed'].text.to_i

data/lib/steam/community/tf2/tf2_class_factory.rb

@@ -1,7 +1,7 @@
-# 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) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/community/tf2/tf2_class'
 require 'steam/community/tf2/tf2_engineer'
@@ -9,12 +9,19 @@ require 'steam/community/tf2/tf2_medic'
 require 'steam/community/tf2/tf2_sniper'
 require 'steam/community/tf2/tf2_spy'
 
-# The TF2ClassFactory is used to created instances of TF2Class based on the XML
-# input data
+# The `TF2ClassFactory` is used to created instances of `TF2Class` based on the
+# XML input data
+#
+# @author Sebastian Staudt
 module TF2ClassFactory
 
-  # Creates a new instance of TF2Class storing the statistics for a Team
-  # Fortress 2 class with the assigned XML data
+  # Creates a new instance of a TF2 class instance based on the given XML data
+  #
+  # This returns an instance of `TF2Class` or its subclasses `TF2Engineer`,
+  # `TF2Medic`, `TF2Sniper` or `TF2Spy` depending on the given XML data.
+  #
+  # @param [REXML::Element] class_data The XML data for the class
+  # @return [TF2Class] The statistics for the given class data
   def self.tf2_class(class_data)
     case class_data.elements['className'].text
       when 'Engineer' then

data/lib/steam/community/tf2/tf2_engineer.rb

@@ -1,19 +1,39 @@
-# 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) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/community/tf2/tf2_class'
 
-# Represents the stats for the Team Fortress 2 engineer class for a specific
+# Represents the stats for the Team Fortress 2 Engineer class for a specific
 # user
+#
+# @author Sebastian Staudt
 class TF2Engineer
 
   include TF2Class
 
-  attr_reader :max_buildings_built, :max_teleports, :max_sentry_kills
+  # Returns the maximum number of buildings built by the player in a single
+  # life as an Engineer
+  #
+  # @return [Fixnum] Maximum number of buildings built
+  attr_reader :max_buildings_built
+
+  # Returns the maximum number of enemies killed by sentry guns built by the
+  # player in a single life as an Engineer
+  #
+  # @return [Fixnum] Maximum number of sentry kills
+  attr_reader :max_sentry_kills
+
+  # Returns the maximum number of teammates teleported by teleporters built by
+  # the player in a single life as an Engineer
+  #
+  # @return [Fixnum] Maximum number of teleports
+  attr_reader :max_teleports
 
-  # Creates a new instance of TF2Engineer based on the assigned XML data
+  # Creates a new instance of the Engineer class based on the given XML data
+  #
+  # @param [REXML::Element] class_data The XML data for this Engineer
   def initialize(class_data)
     super class_data
 

data/lib/steam/community/tf2/tf2_golden_wrench.rb

@@ -1,28 +1,53 @@
-# 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 'multi_json'
 
-require 'json'
 require 'steam/community/steam_id'
 require 'steam/community/web_api'
 
 # Represents the special Team Fortress 2 item Golden Wrench. It includes the
-# ID of the item, the serial number of the wrench, a reference to the SteamId
+# ID of the item, the serial number of the wrench, a reference to the SteamID
 # of the owner and the date this player crafted the wrench
+#
+# @author     Sebastian Staudt
 class TF2GoldenWrench
 
-  attr_reader :date, :id, :number, :owner
+  # Returns the date this Golden Wrench has been crafted
+  #
+  # @return [Time] The crafting date of this wrench
+  attr_reader :date
+
+  # Returns the unique item ID of this Golden Wrench
+  #
+  # @return [Fixnum] The ID of this wrench
+  attr_reader :id
+
+  # Returns the serial number of this Golden Wrench
+  #
+  # @return [Fixnum] The serial of this wrench
+  attr_reader :number
+
+  # Returns the SteamID of the owner of this Golden Wrench
+  #
+  # @return [SteamId] The owner of this wrench
+  attr_reader :owner
 
   @@golden_wrenches = nil
 
-  # Returns an array of all golden wrenches (as instances of TF2GoldenWrench)
+  # Returns all Golden Wrenches
+  #
+  # @raise [SteamCondenserError] if an error occurs querying the Web API or
+  #        the Steam Community
+  # @return [Array<GoldenWrench>] All Golden Wrenches
   def self.golden_wrenches
     if @@golden_wrenches.nil?
       @@golden_wrenches = []
 
-      data = JSON.parse(WebApi.json('ITFItems_440', 'GetGoldenWrenches'), { :symbolize_names => true })
-      data[:results][:wrenches][:wrench].each do |wrench_data|
+      data = MultiJson.decode(WebApi.json('ITFItems_440', 'GetGoldenWrenches', 2), { :symbolize_keys => true })
+      data[:results][:wrenches].each do |wrench_data|
         @@golden_wrenches << TF2GoldenWrench.new(wrench_data)
       end
     end
@@ -32,7 +57,9 @@ class TF2GoldenWrench
 
   private
 
-  # Creates a new instance of TF2GoldenWrench with the given data
+  # Creates a new instance of a Golden Wrench with the given data
+  #
+  # @param [Hash<Symbol, Object>] wrench_data The JSON data for this wrench
   def initialize(wrench_data)
     @date   = Time.at(wrench_data[:timestamp])
     @id     = wrench_data[:itemID]

data/lib/steam/community/tf2/tf2_inventory.rb

@@ -7,6 +7,8 @@ require 'steam/community/game_inventory'
 require 'steam/community/tf2/tf2_item'
 
 # Represents the inventory (aka. Backpack) of a Team Fortress 2 player
+#
+# @author Sebastian Staudt
 class TF2Inventory
 
   include Cacheable
@@ -14,8 +16,10 @@ class TF2Inventory
 
   include GameInventory
 
+  # The Steam Application ID of Team Fortress 2
   @@app_id = 440
 
+  # The class representing Team Fortress 2 items
   @@item_class = TF2Item
 
 end

data/lib/steam/community/tf2/tf2_item.rb

@@ -6,13 +6,20 @@
 require 'steam/community/game_item'
 
 # Represents a Team Fortress 2 item
+#
+# @author Sebastian Staudt
 class TF2Item
 
   include GameItem
 
+  # The names of the classes available in Team Fortress 2
   CLASSES = [ :scout, :sniper, :soldier, :demoman, :medic, :heavy, :pyro, :spy ]
 
-  # Creates a new instance of a TF2Item with the given data
+  # Creates a new instance of a TF2 item with the given data
+  #
+  # @param [TF2Inventory] inventory The inventory this item is contained in
+  # @param [Hash<Symbol, Object>] item_data The data specifying this item
+  # @raise [WebApiError] on Web API errors
   def initialize(inventory, item_data)
     super
 
@@ -23,11 +30,16 @@ class TF2Item
   end
 
   # Returns the class symbols for each class this player has equipped this item
+  #
+  # @return [Array<String>] The names of the classes this player has equipped
+  #         this item
   def classes_equipped?
     @equipped.reject { |class_id, equipped| !equipped }
   end
 
   # Returns whether this item is equipped by this player at all
+  #
+  # @return [Boolean] `true` if the player has equipped this item at all
   def equipped?
     @equipped.has_value? true
   end

data/lib/steam/community/tf2/tf2_medic.rb

@@ -1,17 +1,32 @@
-# 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) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/community/tf2/tf2_class'
 
-# Represents the stats for the Team Fortress 2 medic class for a specific user
+# Represents the stats for the Team Fortress 2 Medic class for a specific user
+#
+# @author Sebastian Staudt
 class TF2Medic
 
   include TF2Class
 
-  attr_reader :max_health_healed, :max_ubercharges
+  # Returns the maximum health healed for teammates by the player in a
+  # single life as a Medic
+  #
+  # @return [Fixnum] Maximum health healed
+  attr_reader :max_health_healed
+
+  # Returns the maximum number of ÜberCharges provided by the player in a
+  # single life as a Medic
+  #
+  # @return [Fixnum] Maximum number of ÜberCharges
+  attr_reader :max_ubercharges
 
+  # Creates a new instance of the Medic class based on the given XML data
+  #
+  # @param [REXML::Element] class_data The XML data for this Medic
   def initialize(class_data)
     super class_data
 

data/lib/steam/community/tf2/tf2_sniper.rb

@@ -1,16 +1,26 @@
-# 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) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/community/tf2/tf2_class'
 
-# Represents the stats for the Team Fortress 2 sniper class for a specific user
+# Represents the stats for the Team Fortress 2 Sniper class for a specific user
+#
+# @author Sebastian Staudt
 class TF2Sniper
 
   include TF2Class
 
-  # Creates a new instance of TF2Sniper based on the assigned XML data
+  # Returns the maximum number enemies killed with a headshot by the player in
+  # a single life as a Sniper
+  #
+  # @return [Fixnum] Maximum number of headshots
+  attr_reader :max_headshots
+
+  # Creates a new instance of the Sniper class based on the given XML data
+  #
+  # @param [REXML::Element] class_data The XML data for this Sniper
   def initialize(class_data)
     super class_data
 

data/lib/steam/community/tf2/tf2_spy.rb

@@ -1,18 +1,32 @@
-# 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) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/community/tf2/tf2_class'
 
-# Represents the stats for the Team Fortress 2 spy class for a specific user
+# Represents the stats for the Team Fortress 2 Spy class for a specific user
+#
+# @author Sebastian Staudt
 class TF2Spy
 
   include TF2Class
 
-  attr_reader :max_backstabs, :max_health_leeched
+  # Returns the maximum number enemies killed with a backstab by the player in
+  # a single life as a Spy
+  #
+  # @return [Fixnum] Maximum number of buildings built
+  attr_reader :max_backstabs
+
+  # Returns the maximum health leeched from enemies by the player in a single
+  # life as a Spy
+  #
+  # @return [Fixnum] Maximum health leeched
+  attr_reader :max_health_leeched
 
-  # Creates a new instance of TF2Spy based on the assigned XML data
+  # Creates a new instance of the Spy class based on the given XML data
+  #
+  # @param [REXML::Element] class_data The XML data for this Spy
   def initialize(class_data)
     super class_data
 

data/lib/steam/community/tf2/tf2_stats.rb

@@ -7,14 +7,22 @@ require 'steam/community/game_stats'
 require 'steam/community/tf2/tf2_class_factory'
 require 'steam/community/tf2/tf2_inventory'
 
-# The TF2Stats class represents the game statistics for a single user in Team
-# Fortress 2
+# This class represents the game statistics for a single user in Team Fortress
+# 2
+#
+# @author Sebastian Staudt
 class TF2Stats < GameStats
 
+  # Returns the total points this player has achieved in his career
+  #
+  # @return [Fixnum] This player's accumulated points
   attr_reader :accumulated_points
 
-  # Creates a TF2Stats object by calling the super constructor with the game
-  # name "tf2"
+  # Creates a `TF2Stats` instance by calling the super constructor with the
+  # game name `'tf2'`
+  #
+  # @param [String, Fixnum] steam_id The custom URL or 64bit Steam ID of the
+  #        user
   def initialize(steam_id)
     super steam_id, 'tf2'
 
@@ -23,8 +31,12 @@ class TF2Stats < GameStats
     end
   end
 
-  # Returns a Hash of TF2Class for this user containing all Team Fortress 2
-  # classes. If the classes haven't been parsed already, parsing is done now.
+  # Returns the statistics for all Team Fortress 2 classes for this user
+  #
+  # If the classes haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<String, TF2Class>] A hash storing individual stats for each
+  #         Team Fortress 2 class
   def class_stats
     return unless public?
 
@@ -40,6 +52,8 @@ class TF2Stats < GameStats
 
   # Returns the current Team Fortress 2 inventory (a.k.a. backpack) of this
   # player
+  #
+  # @return [TF2Inventory] This player's TF2 backpack
   def inventory
     @inventory = TF2Inventory.new(steam_id64) if @inventory.nil?
     @inventory