steam-condenser 1.3.5 → 1.3.6

data/pkg/steam-condenser-1.3.5/lib/steam/community/game_inventory.rb

@@ -0,0 +1,171 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011-2013, Sebastian Staudt
+
+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
+class GameInventory
+
+  include Cacheable
+  cacheable_with_ids [:app_id, :steam_id64]
+
+  # Returns the application ID of the game this inventory class belongs to
+  #
+  # @return [Fixnum] The application ID of the game
+  attr_reader :app_id
+
+  # Returns an array of all items in this players inventory.
+  #
+  # @return [Array<GameItem>] All items in the backpack
+  attr_reader :items
+
+  # Returns an array of all items that this player just found or traded
+  #
+  # @return [Array<GameItem>] All preliminary items of the inventory
+  attr_reader :preliminary_items
+
+  # Returns the Steam ID of the player owning this inventory
+  #
+  # @return [SteamId] The Steam ID of the owner of this inventory
+  attr_reader :user
+
+  @@item_class = GameItem
+
+  @@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 = nil, *args)
+    args = args.unshift steam_id unless steam_id.nil?
+    if self == GameInventory
+      raise ArgumentError, 'wrong number of arguments (1 for 2)' if args.empty?
+    else
+      args = args.unshift app_id
+      app_id = self::APP_ID
+    end
+
+    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
+
+    cacheable_new.call *args
+  end
+
+  # Sets the language the schema should be fetched in (default is: `'en'`)
+  #
+  # @param [String] language The ISO 639-1 code of the schema language
+  def self.schema_language=(language)
+    @@schema_language = language
+  end
+
+  # Creates a new inventory object for the given AppID and SteamID64. This
+  # calls update to fetch the data and create the item instances contained in
+  # this players backpack
+  #
+  # @param [Fixnum] app_id The application ID of the game
+  # @param [Fixnum] steam_id64 The 64bit SteamID of the player to get the
+  #        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
+
+  # Returns the item at the given position in the inventory. The positions
+  # range from 1 to 100 instead of the usual array indices (0 to 99).
+  #
+  # @return [GameItem] The item at the given position in the inventory
+  def [](index)
+    @items[index - 1]
+  end
+
+  # Updates the contents of the inventory using the Steam Web API
+  def fetch
+    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 = []
+    @preliminary_items = []
+    result[:items].each do |item_data|
+      unless item_data.nil?
+        item = item_class.new(self, item_data)
+        if item.preliminary?
+          @preliminary_items << item
+        else
+          @items[item.backpack_position - 1] = item
+        end
+      end
+    end
+  end
+
+  # Returns a short, human-readable string representation of this inventory
+  #
+  # @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 item schema for this inventory
+  #
+  # @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
+  #
+  # @return [Fixnum] The number of items in the inventory
+  def size
+    @items.size
+  end
+
+end

data/pkg/steam-condenser-1.3.5/lib/steam/community/game_item.rb

@@ -0,0 +1,156 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011-2013, Sebastian Staudt
+
+require 'steam/community/web_api'
+
+# A module implementing basic functionality for classes representing an item in
+# a game
+#
+# @author Sebastian Staudt
+module GameItem
+
+  # Return 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
+  #
+  # @return [Fixnum] The position of this item in the player's inventory
+  attr_reader :backpack_position
+
+  # Returns the number of items the player owns of this item
+  #
+  # @return [Fixnum] The quanitity of this item
+  attr_reader :count
+
+  # Returns the index where the item is defined in the schema
+  #
+  # @return [Fixnum] The schema index of this item
+  attr_reader :defindex
+
+  # Returns the ID of this item
+  #
+  # @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
+  attr_reader :level
+
+  # Returns the level of this item
+  #
+  # @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 type of this item
+  #
+  # @return [String] The type of this item
+  attr_reader :type
+
+  # Creates a new instance of a GameItem with the given data
+  #
+  # @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
+    @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              = schema_data[:item_name]
+    @original_id       = item_data[:original_id]
+    @preliminary       = item_data[:inventory] & 0x40000000 != 0
+    @quality           = inventory.item_schema.qualities[item_data[:quality]]
+    @tradeable         = !!item_data[:flag_cannot_trade]
+    @type              = schema_data[:item_type_name]
+
+    if item_data.key? :origin
+      @origin = inventory.item_schema.origins[item_data[:origin]]
+    end
+
+    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 whether this item is preliminary
+  #
+  # Preliminary means that this item was just found or traded and has not yet
+  # been added to the inventory
+  #
+  # @return [Boolean] `true` if this item is preliminary
+  def preliminary?
+    @preliminary
+  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
+  def tradeable?
+    @tradeable
+  end
+
+end

data/pkg/steam-condenser-1.3.5/lib/steam/community/game_item_schema.rb

@@ -0,0 +1,131 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2012, Sebastian Staudt
+
+require 'steam/community/cacheable'
+
+# Provides item definitions and related data that specify the items of a game
+#
+# @author Sebastian Staudt
+class GameItemSchema
+
+  include Cacheable
+  cacheable_with_ids [ :app_id, :language ]
+
+  # Returns the application ID of the game this item schema belongs to
+  #
+  # @return [Fixnum] The application ID of the game
+  attr_reader :app_id
+
+  # The attributes defined for this game's items
+  #
+  # @return [Hash<Symbol, Object>] This item schema's attributes
+  attr_reader :attributes
+
+  # The effects defined for this game's items
+  #
+  # @return [Hash<Symbol, Object>] This item schema's effects
+  attr_reader :effects
+
+  # The levels defined for this game's items
+  #
+  # @return [Hash<Symbol, Object>] This item schema's item levels
+  attr_reader :item_levels
+
+  # A mapping from the item name to the item's defindex
+  #
+  # @return [Hash<Symbol, Object>] The item name mapping
+  attr_reader :item_names
+
+  # The item sets defined for this game's items
+  #
+  # @return [Hash<Symbol, Object>] This item schema's item sets
+  attr_reader :item_sets
+
+  # The items defined for this game
+  #
+  # @return [Hash<Symbol, Object>] The items in this schema
+  attr_reader :items
+
+  # The language of this item schema
+  #
+  # @return [Symbol] The language of this item schema
+  attr_reader :language
+
+  # The item origins defined for this game's items
+  #
+  # @return [Array<String>] This item schema's origins
+  attr_reader :origins
+
+  # The item qualities defined for this game's items
+  #
+  # @return [Array<String>] This item schema's qualities
+  attr_reader :qualities
+
+  # Creates a new item schema for the game with the given application ID and
+  # with descriptions in the given language
+  #
+  # @param [Fixnum] app_id The application ID of the game
+  # @param [Symbol] language The language of description strings
+  # @macro cacheable
+  def initialize(app_id, language = nil)
+    @app_id   = app_id
+    @language = language
+  end
+
+  # Updates the item definitions of this schema using the Steam Web API
+  def fetch
+    params = { :language => language }
+    data = WebApi.json!("IEconItems_#{app_id}", 'GetSchema', 1, params)
+
+    @attributes = {}
+    data[:attributes].each do |attribute|
+      @attributes[attribute[:defindex]] = attribute
+      @attributes[attribute[:name]]     = attribute
+    end
+
+    @effects = {}
+    data[:attribute_controlled_attached_particles].each do |effect|
+      @effects[effect[:id]] = effect[:name]
+    end
+
+    @items = {}
+    @item_names = {}
+    data[:items].each do |item|
+      @items[item[:defindex]] = item
+      @item_names[item[:name]] = item[:defindex]
+    end
+
+    @item_levels = {}
+    data[:item_levels].each do |item_level_type|
+      @item_levels[item_level_type[:name]] = {}
+      item_level_type[:levels].each do |level|
+        @item_levels[item_level_type[:name]][level[:level]] = level[:name]
+      end
+    end if data.key? :item_levels
+
+    @item_sets = {}
+    data[:item_sets].each do |item_set|
+      @item_sets[item_set[:item_set]] = item_set
+    end
+
+    @origins = []
+    data[:originNames].each do |origin|
+      @origins[origin[:origin]] = origin[:name]
+    end
+
+    @qualities = []
+    data[:qualities].keys.each_with_index do |key, index|
+      @qualities[index] = data[:qualityNames][key] || key.to_s.capitalize
+    end
+  end
+
+  # Returns a short, human-readable string representation of this item schema
+  #
+  # @return [String] A string representation of this item schema
+  def inspect
+    "#<#{self.class}:#@app_id (#@language) - #{fetch_time || 'not fetched'}>"
+  end
+
+end