steam-condenser 1.2.1 → 1.3.0

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    steam-condenser (1.2.0)
+    steam-condenser (1.3.0)
       bzip2-ruby (~> 0.2.7)
-      multi_json (~> 1.3.1)
+      multi_json (~> 1.5.0)
       multi_xml (~> 0.5.1)
 
 GEM
@@ -11,20 +11,20 @@ GEM
   specs:
     bzip2-ruby (0.2.7)
     metaclass (0.0.1)
-    mocha (0.12.0)
+    mocha (0.13.1)
       metaclass (~> 0.0.1)
-    multi_json (1.3.6)
+    multi_json (1.5.0)
     multi_xml (0.5.1)
-    rake (0.9.2.2)
-    shoulda-context (1.0.0)
-    yard (0.8.2.1)
+    rake (10.0.3)
+    shoulda-context (1.0.2)
+    yard (0.8.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  mocha (~> 0.12.0)
-  rake (~> 0.9.2)
+  mocha (~> 0.13.0)
+  rake (~> 10.0.1)
   shoulda-context (~> 1.0.0)
   steam-condenser!
   yard (~> 0.8.0)

data/README.md

@@ -40,6 +40,7 @@ included LICENSE file.
 * DeFirence – defirence(at)defirence.za.net
 * Mike Połtyn – mike(at)railslove.com
 * Sam Kinard – snkinard(at)gmail.com
+* "withgod" – noname(at)withgod.jp
 
 ## See Also
 

data/Rakefile

@@ -3,7 +3,7 @@
 # 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
+# Copyright (c) 2008-2012, Sebastian Staudt
 
 require 'rake/testtask'
 require 'rubygems/package_task'
@@ -27,7 +27,7 @@ begin
   # 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.files   = [ 'lib/steam/community/cacheable.rb', 'lib/**/*.rb', 'LICENSE', 'README.md' ]
     yardoc.options = [ '--private', '--title', 'Metior — API Documentation' ]
   end
 rescue LoadError

data/lib/steam-condenser/version.rb

@@ -6,6 +6,6 @@
 module SteamCondenser
 
   # The current version of Steam Condenser
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 
 end

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

@@ -32,6 +32,7 @@ class AlienSwarmStats < GameStats
   #
   # @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'
 

data/lib/steam/community/cacheable.rb

@@ -137,7 +137,7 @@ module Cacheable
   def cache
     cache     = self.class.send :cache
     cache_ids.each do |cache_id|
-      cache[cache_id] = self
+      cache[cache_id] = self if cache_id
     end
 
     true

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

@@ -39,6 +39,7 @@ class CSSStats < GameStats
   #
   # @param [String, Fixnum] steam_id The custom URL or 64bit Steam ID of the
   #        user
+  # @macro cacheable
   def initialize(steam_id)
     super steam_id, 'cs:s'
 

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

@@ -126,6 +126,7 @@ class DefenseGridStats < GameStats
   #
   # @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, 'defensegrid:awakening')
 

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

@@ -18,6 +18,7 @@ class DoDSStats < GameStats
   #
   # @param [String, Fixnum] steam_id The custom URL or 64bit Steam ID of the
   #        user
+  # @macro cacheable
   def initialize(steam_id)
     super steam_id, 'DoD:S'
   end

data/lib/steam/community/dota2/dota2_beta_inventory.rb

@@ -11,6 +11,9 @@ require 'steam/community/game_inventory'
 # @author Sebastian Staudt
 class Dota2BetaInventory < GameInventory
 
+  # The Steam application ID of the DotA 2 beta
+  APP_ID = 205790
+
   # Creates a new inventory object for the given SteamID64 in the DotA 2 beta
   # (App ID 205790)
   #
@@ -18,7 +21,7 @@ class Dota2BetaInventory < GameInventory
   #        inventory for
   # @macro cacheable
   def initialize(steam_id64)
-    super 205790, steam_id64
+    super APP_ID, steam_id64
   end
 
   # The class representing DotA 2 items

data/lib/steam/community/dota2/dota2_inventory.rb

@@ -11,6 +11,9 @@ require 'steam/community/game_inventory'
 # @author Sebastian Staudt
 class Dota2Inventory < GameInventory
 
+  # The Steam application ID of DotA 2
+  APP_ID = 570
+
   # Creates a new inventory object for the given SteamID64 in DotA 2
   # (App ID 570)
   #
@@ -18,7 +21,7 @@ class Dota2Inventory < GameInventory
   #        inventory for
   # @macro cacheable
   def initialize(steam_id64)
-    super 570, steam_id64
+    super APP_ID, steam_id64
   end
 
   # The class representing DotA 2 items

data/lib/steam/community/game_inventory.rb

@@ -5,8 +5,19 @@
 
 require 'steam/community/cacheable'
 require 'steam/community/game_item'
+require 'steam/community/game_item_schema'
+require 'steam/community/steam_id'
 require 'steam/community/web_api'
 
+class GameInventory
+end
+
+require 'steam/community/dota2/dota2_beta_inventory'
+require 'steam/community/dota2/dota2_inventory'
+require 'steam/community/portal2/portal2_inventory'
+require 'steam/community/tf2/tf2_beta_inventory'
+require 'steam/community/tf2/tf2_inventory'
+
 # Provides basic functionality to represent an inventory of player in a game
 #
 # @author Sebastian Staudt
@@ -30,13 +41,47 @@ class GameInventory
   # @return [SteamId] The Steam ID of the owner of this inventory
   attr_reader :user
 
-  @@attribute_schema = {}
+  @@item_class = GameItem
 
-  @@item_schema = {}
+  @@schema_language = 'en'
+
+  # This is a wrapper around all subclasses of `GameInventory` so that an
+  # instance of correct subclass is returned for a given application ID. If
+  # there's no specific subclass for an application ID exists, a generic
+  # instance of `GameInventory` is created.
+  #
+  # @param [Fixnum] app_id The application ID of the game
+  # @param [Fixnum] steam_id The 64bit Steam ID or vanity URL of the user
+  # @return [GameInventory] The inventory for the given user and game
+  # @raise [SteamCondenserException] if creating the inventory fails
+  # @macro cacheable
+  def self.new(app_id, steam_id, *args)
+    args = args.unshift steam_id
+    if self != GameInventory
+      args = args.unshift app_id
+      app_id = self::APP_ID
+    end
 
-  @@qualities = {}
+    cacheable_new = Cacheable::ClassMethods.instance_method :new
+
+    case app_id
+      when Dota2BetaInventory::APP_ID
+        cacheable_new = cacheable_new.bind Dota2BetaInventory
+      when Dota2Inventory::APP_ID
+        cacheable_new = cacheable_new.bind Dota2Inventory
+      when Portal2Inventory::APP_ID
+        cacheable_new = cacheable_new.bind Portal2Inventory
+      when TF2BetaInventory::APP_ID
+        cacheable_new = cacheable_new.bind TF2BetaInventory
+      when TF2Inventory::APP_ID
+        cacheable_new = cacheable_new.bind TF2Inventory
+      else
+        cacheable_new = cacheable_new.bind GameInventory
+        return cacheable_new.call app_id, *args
+    end
 
-  @@schema_language = 'en'
+    cacheable_new.call *args
+  end
 
   # Sets the language the schema should be fetched in (default is: `'en'`)
   #
@@ -54,7 +99,13 @@ class GameInventory
   #        inventory for
   # @macro cacheable
   def initialize(app_id, steam_id64)
+    unless steam_id64.is_a? Fixnum
+      steam_id64 = SteamId.resolve_vanity_url steam_id64.to_s
+      raise SteamCondenserError.new 'User not found' if steam_id64.nil?
+    end
+
     @app_id     = app_id
+    @items      = []
     @steam_id64 = steam_id64
     @user       = SteamId.new steam_id64, false
   end
@@ -67,22 +118,10 @@ class GameInventory
     @items[index - 1]
   end
 
-  # Returns the attribute schema
-  #
-  # The schemas are fetched first if not done already
-  #
-  # @return [Hash<String, Hash<String, Object>>] The attribute schema for the
-  #         game this inventory belongs to
-  # @see #update_schema
-  def attribute_schema
-    update_schema unless @@attribute_schema.key? app_id
-
-    @@attribute_schema[app_id]
-  end
-
-  # Updates the contents of the inventory using Steam Web API
+  # Updates the contents of the inventory using the Steam Web API
   def fetch
-    result = WebApi.json!("IEconItems_#@app_id", 'GetPlayerItems', 1, { :SteamID => @user.steam_id64 })
+    params = { :SteamID => @user.steam_id64 }
+    result = WebApi.json! "IEconItems_#@app_id", 'GetPlayerItems', 1, params
     item_class = self.class.send :class_variable_get, :@@item_class
 
     @items = []
@@ -94,29 +133,20 @@ class GameInventory
     end
   end
 
-  # Returns the item schema
-  #
-  # The schemas are fetched first if not done already
+  # Returns a short, human-readable string representation of this inventory
   #
-  # @return [Hash<Fixnum, Hash<String, Object>>] The item schema for the game
-  #         this inventory belongs to
-  # @see #upde_schema
-  def item_schema
-    update_schema unless @@item_schema.key? app_id
-
-    @@item_schema[app_id]
+  # @return [String] A string representation of this inventory
+  def inspect
+    "#<#{self.class}:#@app_id #@steam_id64 (#{size} items) - " +
+    "#{fetch_time || 'not fetched'}>"
   end
 
-  # Returns the quality schema
+  # Returns the item schema for this inventory
   #
-  # The schemas are fetched first if not done already
-  #
-  # @return [Hash<Fixnum, String>] The quality schema for this game
-  # @see #update_schema
-  def qualities
-    update_schema unless @@qualities.key? app_id
-
-    @@qualities[app_id]
+  # @return [GameItemSchema] The item schema for the game this inventory
+  #         belongs to
+  def item_schema
+    @item_schema ||= GameItemSchema.new app_id, @@schema_language
   end
 
   # Returns the number of items in the user's inventory
@@ -126,29 +156,4 @@ class GameInventory
     @items.size
   end
 
-  protected
-
-  # Updates the item schema (this includes attributes and qualities) using the
-  # `GetSchema` method of interface `IEconItems_[AppID]`
-  def update_schema
-    params = {}
-    params[:language] = @@schema_language unless @@schema_language.nil?
-    result = WebApi.json!("IEconItems_#{app_id}", 'GetSchema', 1, params)
-
-    @@attribute_schema[app_id] = {}
-    result[:attributes].each do |attribute_data|
-      @@attribute_schema[app_id][attribute_data[:name]] = attribute_data
-    end
-
-    @@item_schema[app_id] = []
-    result[:items].each do |item_data|
-      @@item_schema[app_id][item_data[:defindex]] = item_data
-    end
-
-    @@qualities[app_id] = []
-    result[:qualities].each do |quality, id|
-      @@qualities[app_id][id] = quality
-    end
-  end
-
 end

data/lib/steam/community/game_item.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.
 #
-# Copyright (c) 2011, Sebastian Staudt
+# Copyright (c) 2011-2012, Sebastian Staudt
 
 require 'steam/community/web_api'
 
@@ -13,7 +13,7 @@ module GameItem
 
   # Return the attributes of this item
   #
-  # @return [Hash<Symbol, Object>] The attributes of this item
+  # @return [Hash<Symbol, Object>, nil] The attributes of this item
   attr_reader :attributes
 
   # Returns the position of this item in the player's inventory
@@ -21,11 +21,6 @@ module GameItem
   # @return [Fixnum] The position of this item in the player's inventory
   attr_reader :backpack_position
 
-  # Returns the class of this item
-  #
-  # @return [String] The class of this item
-  attr_reader :class
-
   # Returns the number of items the player owns of this item
   #
   # @return [Fixnum] The quanitity of this item
@@ -41,6 +36,21 @@ module GameItem
   # @return [Fixnum] The ID of this item
   attr_reader :id
 
+  # Returns the inventory this items belongs to
+  #
+  # @return [GameInventory] The inventory this item belongs to
+  attr_reader :inventory
+
+  # Returns the class of this item
+  #
+  # @return [String] The class of this item
+  attr_reader :item_class
+
+  # Returns the item set this item belongs to
+  #
+  # @return [Hash<Symbol, Object>, nil] The set this item belongs to
+  attr_reader :item_set
+
   # Returns the level of this item
   #
   # @return [Fixnum] The level of this item
@@ -51,17 +61,21 @@ module GameItem
   # @return [String] The level of this item
   attr_reader :name
 
+  # Returns the origin of this item
+  #
+  # @return [String] The origin of this item
+  attr_reader :origin
+
+  # Returns the original ID of this item
+  #
+  # @return [Fixnum] The original ID of this item
+  attr_reader :original_id
+
   # Returns the quality of this item
   #
   # @return [String] The quality of this item
   attr_reader :quality
 
-  # Returns the slot where this item can be equipped in or `nil` if this item
-  # cannot be equipped
-  #
-  # @return [String] The slot where this item can be equipped in
-  attr_reader :slot
-
   # Returns the type of this item
   #
   # @return [String] The type of this item
@@ -72,23 +86,52 @@ module GameItem
   # @param [GameInventory] inventory The inventory this item is contained in
   # @param [Hash<Symbol, Object>] item_data The data representing this item
   def initialize(inventory, item_data)
+    @inventory = inventory
+
     @defindex          = item_data[:defindex]
     @backpack_position = item_data[:inventory] & 0xffff
-    @class             = inventory.item_schema[@defindex][:item_class]
     @count             = item_data[:quantity]
+    @craftable         = !!item_data[:flag_cannot_craft]
     @id                = item_data[:id]
+    @item_class        = schema_data[:item_class]
+    @item_set          = inventory.item_schema.item_sets[schema_data[:item_set]]
     @level             = item_data[:level]
-    @name              = inventory.item_schema[@defindex][:item_name]
-    @quality           = inventory.qualities[item_data[:quality]]
-    @slot              = inventory.item_schema[@defindex][:item_slot]
-    @tradeable         = !(item_data[:flag_cannot_trade] == true)
-    @type              = inventory.item_schema[@defindex][:item_type_name]
-
-    unless inventory.item_schema[@defindex][:attributes].nil?
-      @attributes = inventory.item_schema[@defindex][:attributes]
+    @name              = schema_data[:item_name]
+    @origin            = inventory.item_schema.origins[item_data[:origin]]
+    @original_id       = item_data[:original_id]
+    @quality           = inventory.item_schema.qualities[item_data[:quality]]
+    @tradeable         = !!item_data[:flag_cannot_trade]
+    @type              = schema_data[:item_type_name]
+
+    attributes_data = schema_data[:attributes] || []
+    attributes_data += item_data[:attributes] if item_data.key? :attributes
+
+    @attributes = []
+    attributes_data.each do |attribute_data|
+      attribute_key = attribute_data[:defindex]
+      attribute_key = attribute_data[:name] if attribute_key.nil?
+
+      unless attribute_key.nil?
+        schema_attribute_data = inventory.item_schema.attributes[attribute_key]
+        @attributes << attribute_data.merge(schema_attribute_data)
+      end
     end
   end
 
+  # Returns whether this item is craftable
+  #
+  # @return [Boolean] `true` if this item is craftable
+  def craftable?
+    @craftable
+  end
+
+  # Returns the data for this item that's defined in the item schema
+  #
+  # @return [Hash<Symbol, Object>] The schema data for this item
+  def schema_data
+    inventory.item_schema.items[@defindex]
+  end
+
   # Returns whether this item is tradeable
   #
   # @return [Boolean] `true` if this item is tradeable