steam-condenser 1.2.0 → 1.2.1

data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_beta_inventory.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) 2011, Sebastian Staudt
+
+require 'steam/community/game_inventory'
+require 'steam/community/tf2/tf2_item'
+
+# Represents the inventory (aka. Backpack) of a player of the public Team
+# Fortress 2 beta
+class TF2BetaInventory
+
+  include Cacheable
+  cacheable_with_ids :steam_id64
+
+  include GameInventory
+
+  @@app_id = 520
+
+  @@item_class = TF2Item
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_class.rb

@@ -0,0 +1,92 @@
+# 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 'steam/community/game_class'
+
+# Represents the stats for a Team Fortress 2 class for a specific user
+#
+# @author Sebastian Staudt
+class TF2Class
+
+  include GameClass
+
+  # 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 TF2 class instance based on the assigned XML data
+  #
+  # @param [Hash<String, Object>] class_data The XML data for this class
+  def initialize(class_data)
+    @name                    = class_data['className']
+    @max_buildings_destroyed = class_data['ibuildingsdestroyed'].to_i
+    @max_captures            = class_data['ipointcaptures'].to_i
+    @max_damage              = class_data['idamagedealt'].to_i
+    @max_defenses            = class_data['ipointdefenses'].to_i
+    @max_dominations         = class_data['idominations'].to_i
+    @max_kill_assists        = class_data['ikillassists'].to_i
+    @max_kills               = class_data['inumberofkills'].to_i
+    @max_revenges            = class_data['irevenge'].to_i
+    @max_score               = class_data['ipointsscored'].to_i
+    @max_time_alive          = class_data['iplaytime'].to_i
+    @play_time               = class_data['playtimeSeconds'].to_i
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_class_factory.rb

@@ -0,0 +1,40 @@
+# 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 'steam/community/tf2/tf2_class'
+require 'steam/community/tf2/tf2_engineer'
+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
+#
+# @author Sebastian Staudt
+module TF2ClassFactory
+
+  # 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 [Hash<String, Object>] 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['className']
+      when 'Engineer' then
+        return TF2Engineer.new(class_data)
+      when 'Medic' then
+        return TF2Medic.new(class_data)
+      when 'Sniper' then
+        return TF2Sniper.new(class_data)
+      when 'Spy' then
+        return TF2Spy.new(class_data)
+      else
+        return TF2Class.new(class_data)
+    end
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_engineer.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) 2008-2011, Sebastian Staudt
+
+require 'steam/community/tf2/tf2_class'
+
+# Represents the stats for the Team Fortress 2 Engineer class for a specific
+# user
+#
+# @author Sebastian Staudt
+class TF2Engineer < TF2Class
+
+  # 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 the Engineer class based on the given XML data
+  #
+  # @param [Hash<String, Object>] class_data The XML data for this Engineer
+  def initialize(class_data)
+    super class_data
+
+    @max_buildings_built = class_data['ibuildingsbuilt'].to_i
+    @max_teleports       = class_data['inumteleports'].to_i
+    @max_sentry_kills    = class_data['isentrykills'].to_i
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_golden_wrench.rb

@@ -0,0 +1,70 @@
+# 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 'multi_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
+# of the owner and the date this player crafted the wrench
+#
+# @author     Sebastian Staudt
+class TF2GoldenWrench
+
+  # 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 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 = MultiJson.load(WebApi.json('ITFItems_440', 'GetGoldenWrenches', 2), { :symbolize_keys => true })
+      data[:results][:wrenches].each do |wrench_data|
+        @@golden_wrenches << TF2GoldenWrench.new(wrench_data)
+      end
+    end
+
+    @@golden_wrenches
+  end
+
+  private
+
+  # 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]
+    @number = wrench_data[:wrenchNumber]
+    @owner  = SteamId.new(wrench_data[:steamID], false)
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_inventory.rb

@@ -0,0 +1,25 @@
+# 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/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
+  cacheable_with_ids :steam_id64
+
+  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/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_item.rb

@@ -0,0 +1,47 @@
+# 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/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 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
+
+    @equipped = {}
+    CLASSES.each_index do |class_id|
+      @equipped[CLASSES[class_id]] = (item_data[:inventory] & (1 << 16 + class_id) != 0)
+    end
+  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
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_medic.rb

@@ -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 'steam/community/tf2/tf2_class'
+
+# Represents the stats for the Team Fortress 2 Medic class for a specific user
+#
+# @author Sebastian Staudt
+class TF2Medic < TF2Class
+
+  # 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 [Hash<String, Object>] class_data The XML data for this Medic
+  def initialize(class_data)
+    super class_data
+
+    @max_health_healed = class_data['ihealthpointshealed'].to_i
+    @max_ubercharges   = class_data['inuminvulnerable'].to_i
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_sniper.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 'steam/community/tf2/tf2_class'
+
+# Represents the stats for the Team Fortress 2 Sniper class for a specific user
+#
+# @author Sebastian Staudt
+class TF2Sniper < TF2Class
+
+  # 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 [Hash<String, Object>] class_data The XML data for this Sniper
+  def initialize(class_data)
+    super class_data
+
+    @max_headshots = class_data['iheadshots'].to_i
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_spy.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) 2008-2011, Sebastian Staudt
+
+require 'steam/community/tf2/tf2_class'
+
+# Represents the stats for the Team Fortress 2 Spy class for a specific user
+#
+# @author Sebastian Staudt
+class TF2Spy < TF2Class
+
+  # 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 head shots by the player in a single life as a Spy
+  #
+  # @return [Fixnum] Maximum number of head shots
+  attr_reader :max_head_shots
+
+  # 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 the Spy class based on the given XML data
+  #
+  # @param [Hash<String, Object>] class_data The XML data for this Spy
+  def initialize(class_data)
+    super class_data
+
+    @max_backstabs      = class_data['ibackstabs'].to_i
+    @max_head_shots     = class_data['iheadshots'].to_i
+    @max_health_leeched = class_data['ihealthpointsleached'].to_i
+  end
+
+end