steam-condenser 1.3.10 → 1.3.11

data/pkg/steam-condenser-1.3.9/lib/steam/community/dota2/dota2_beta_inventory.rb

@@ -1,30 +0,0 @@
-# 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/dota2/dota2_item'
-require 'steam/community/game_inventory'
-
-# Represents the inventory of a player of the DotA 2 beta
-#
-# @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)
-  #
-  # @param [Fixnum] steam_id64 The 64bit SteamID of the player to get the
-  #        inventory for
-  # @macro cacheable
-  def initialize(steam_id64)
-    super APP_ID, steam_id64
-  end
-
-  # The class representing DotA 2 items
-  @@item_class = Dota2Item
-
-end

data/pkg/steam-condenser-1.3.9/lib/steam/community/dota2/dota2_inventory.rb

@@ -1,30 +0,0 @@
-# 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/dota2/dota2_item'
-require 'steam/community/game_inventory'
-
-# Represents the inventory of a DotA 2 player
-#
-# @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)
-  #
-  # @param [Fixnum] steam_id64 The 64bit SteamID of the player to get the
-  #        inventory for
-  # @macro cacheable
-  def initialize(steam_id64)
-    super APP_ID, steam_id64
-  end
-
-  # The class representing DotA 2 items
-  @@item_class = Dota2Item
-
-end

data/pkg/steam-condenser-1.3.9/lib/steam/community/dota2/dota2_item.rb

@@ -1,33 +0,0 @@
-# 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/game_item'
-
-# Represents a DotA 2 item
-#
-# @author Sebastian Staudt
-class Dota2Item
-
-  include GameItem
-
-  # Creates a new instance of a DotA 2 item with the given data
-  #
-  # @param [Dota2Inventory] 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 = !item_data[:equipped].nil?
-  end
-
-  # Returns whether this item is equipped by this player at all
-  #
-  # @return [Boolean] Whether this item is equipped by this player at all
-  def equipped?
-    @equipped
-  end
-
-end

data/pkg/steam-condenser-1.3.9/lib/steam/community/game_achievement.rb

@@ -1,109 +0,0 @@
-# This code is free software; you can redistribute it and/or modify it under
-# the terms of the new BSD License.
-#
-# Copyright (c) 2008-2012, Sebastian Staudt
-
-require 'multi_json'
-
-require 'steam/community/web_api'
-
-# The GameAchievement class represents a specific achievement for a single game
-# and for a single user
-#
-# It also provides the ability to load the global unlock percentages of all
-# achievements of a specific game.
-#
-# @author Sebastian Staudt
-class GameAchievement
-
-  # Returns the symbolic API name of this achievement
-  #
-  # @return [String] The API name of this achievement
-  attr_reader :api_name
-
-  # Returns the description of this achievement
-  #
-  # @return [String] The description of this achievement
-  attr_reader :description
-
-  # Return the game this achievement belongs to
-  #
-  # @return [Steam] The game this achievement belongs to
-  attr_reader :game
-
-  # Returns the url for the closed icon of this achievement
-  #
-  # @return [String] The url of the closed achievement icon
-  attr_reader :icon_closed_url
-
-  # Returns the url for the open icon of this achievement
-  #
-  # @return [String] The url of the open achievement icon
-  attr_reader :icon_open_url
-
-  # Returns the name of this achievement
-  #
-  # @return [String] The name of this achievement
-  attr_reader :name
-
-  # Returns the time this achievement has been unlocked by its owner
-  #
-  # @return [Time] The time this achievement has been unlocked
-  attr_reader :timestamp
-
-  # Returns the SteamID of the user who owns this achievement
-  #
-  # @return [Fixnum] The SteamID of this achievement's owner
-  attr_reader :user
-
-  # Loads the global unlock percentages of all achievements for the game with
-  # the given Steam Application ID
-  #
-  # @param [Fixnum] app_id The unique Steam Application ID of the game (e.g.
-  #        `440` for Team Fortress 2). See
-  #         http://developer.valvesoftware.com/wiki/Steam_Application_IDs for
-  #         all application IDs
-  # @raise [WebApiError] if the request to Steam's Web API fails
-  # @return [Hash<Symbol, Float>] The symbolic achievement names with their
-  #         corresponding unlock percentages
-  def self.global_percentages(app_id)
-    percentages = {}
-
-    data = WebApi.json('ISteamUserStats', 'GetGlobalAchievementPercentagesForApp', 2, { :gameid => app_id })
-    MultiJson.load(data, { :symbolize_keys => true })[:achievementpercentages][:achievements].each do |percentage|
-      percentages[percentage[:name].to_sym] = percentage[:percent]
-    end
-
-    percentages
-  end
-
-  # Creates the achievement with the given name for the given user and game
-  # and achievement data
-  #
-  # @param [SteamId] user The SteamID of the player this achievement belongs to
-  # @param [SteamGame] game The game this achievement belongs to
-  # @param [Hash<String, Object>] achievement_data The achievement data
-  #        extracted from XML
-  def initialize(user, game, achievement_data)
-    @api_name        = achievement_data['apiname']
-    @description     = achievement_data['description']
-    @game            = game
-    @icon_closed_url = achievement_data['iconClosed']
-    @icon_open_url   = achievement_data['iconOpen']
-    @name            = achievement_data['name']
-    @unlocked        = (achievement_data['closed'].to_i == 1)
-    @user            = user
-
-    if @unlocked && !achievement_data['unlockTimestamp'].nil?
-      @timestamp  = Time.at(achievement_data['unlockTimestamp'].to_i)
-    end
-  end
-
-  # Returns whether this achievement has been unlocked by its owner
-  #
-  # @return [Boolean] `true` if the achievement has been unlocked by the user
-  def unlocked?
-    @unlocked
-  end
-
-end

data/pkg/steam-condenser-1.3.9/lib/steam/community/game_class.rb

@@ -1,22 +0,0 @@
-# This code is free software; you can redistribute it and/or modify it under
-# the terms of the new BSD License.
-#
-# Copyright (c) 2009-2011, Sebastian Staudt
-
-# A module implementing basic functionality for classes representing player
-# classes
-#
-# @author Sebastian Staudt
-module GameClass
-
-  # Returns the name of this class
-  #
-  # @return [String] The name of this class
-  attr_reader :name
-
-  # Returns the time in minutes the player has played with this class
-  #
-  # @return [Fixnum] The time this class has been played
-  attr_reader :play_time
-
-end

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

@@ -1,171 +0,0 @@
-# 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.9/lib/steam/community/game_item.rb

@@ -1,155 +0,0 @@
-# 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 quantity 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_data[:name]
-
-      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