steam-condenser 1.3.8 → 1.3.8.1

data/pkg/steam-condenser-1.3.7/pkg/steam-condenser-1.3.6/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

data/pkg/steam-condenser-1.3.7/pkg/steam-condenser-1.3.6/lib/steam/community/game_item_schema.rb

@@ -1,131 +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/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

data/pkg/steam-condenser-1.3.7/pkg/steam-condenser-1.3.6/lib/steam/community/game_leaderboard.rb

@@ -1,212 +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 'multi_xml'
-
-require 'steam/community/game_leaderboard_entry'
-require 'steam/community/steam_id'
-require 'steam/community/xml_data'
-
-# The GameLeaderboard class represents a single leaderboard for a specific game
-#
-# @author Sebastian Staudt
-class GameLeaderboard
-
-  include XMLData
-
-  DISPLAY_TYPE_NONE         = 0
-  DISPLAY_TYPE_NUMERIC      = 1
-  DISPLAY_TYPE_SECONDS      = 2
-  DISPLAY_TYPE_MILLISECONDS = 3
-
-  SORT_METHOD_NONE = 0
-  SORT_METHOD_ASC  = 1
-  SORT_METHOD_DESC = 2
-
-  @@leaderboards = {}
-
-  # Returns the display type of the scores on this leaderboard
-  #
-  # @return [Fixnum] The display type of the scores
-  attr_reader :display_type
-
-  # Returns the number of entries on this leaderboard
-  #
-  # @return [Fixnum] The number of entries on this leaderboard
-  attr_reader :entry_count
-
-  # Returns the ID of the leaderboard
-  #
-  # @return [Fixnum] The ID of the leaderboard
-  attr_reader :id
-
-  # Returns the name of the leaderboard
-  #
-  # @return [String] The name of the leaderboard
-  attr_reader :name
-
-  # Returns the method that is used to sort the entries on the leaderboard
-  #
-  # @return [Fixnum] The sort method
-  attr_reader :sort_method
-
-  # Returns the leaderboard for the given game and leaderboard ID or name
-  #
-  # @param [String] game_name The short name of the game
-  # @param [Fixnum, String] id The ID or name of the leaderboard to return
-  # @return [GameLeaderboard] The matching leaderboard if available
-  def self.leaderboard(game_name, id)
-    leaderboards = self.leaderboards game_name
-
-    if id.is_a? Fixnum
-      leaderboards[id]
-    else
-      leaderboards.each_value do |board|
-        return board if board.name == id
-      end
-    end
-  end
-
-  # Returns an array containing all of a game's leaderboards
-  #
-  # @param [String] game_name The name of the game
-  # @return [Array<GameLeaderboard>] The leaderboards for this game
-  def self.leaderboards(game_name)
-    self.load_leaderboards game_name unless @@leaderboards.key? game_name
-
-    @@leaderboards[game_name]
-  end
-
-  # Returns the entry on this leaderboard for the user with the given SteamID
-  #
-  # @param [Fixnum, SteamId] steam_id The 64bit SteamID or the `SteamId` object
-  #        of the user
-  # @return [GameLeaderboardEntry] The entry of the user if available
-  # raise [SteamCondenserException] if an error occurs while fetching the
-  #         leaderboard
-  def entry_for_steam_id(steam_id)
-    steam_id = steam_id.steam_id64 if steam_id.is_a? SteamId
-
-    parse "#@url&steamid=#{steam_id}"
-
-    error = @xml_data['error']
-    raise SteamCondenserError, error unless error.nil?
-
-    @xml_data['entries']['entry'].each do |entry_data|
-      if entry_data['steamid'].to_i == steam_id
-        return GameLeaderboardEntry.new entry_data, self
-      end
-    end
-
-    nil
-  end
-
-  # Returns an array of entries on this leaderboard for the user with the given
-  # SteamID and his/her friends
-  #
-  # @param [Fixnum, SteamId] steam_id The 64bit SteamID or the `SteamId` object
-  #        of the user
-  # @return [Array<GameLeaderboardEntry>] The entries of the user and his/her
-  #         friends
-  # raise [SteamCondenserException] if an error occurs while fetching the
-  #         leaderboard
-  def entry_for_steam_id_friends(steam_id)
-    steam_id = steam_id.steam_id64 if steam_id.is_a? SteamId
-
-    parse "#@url&steamid=#{steam_id}"
-
-    error = @xml_data['error']
-    raise SteamCondenserError, error unless error.nil?
-
-    parse_entries
-  end
-
-  # Returns the entries on this leaderboard for a given rank range
-  #
-  # The range is inclusive and a maximum of 5001 entries can be returned in a
-  # single request.
-  #
-  # @param [Fixnum] first The first entry to return from the leaderboard
-  # @param [Fixnum] last The last entry to return from the leaderboard
-  # @return [Array<GameLeaderboardEntry>] The entries that match the given rank
-  #         range
-  # raise [SteamCondenserException] if an error occurs while fetching the
-  #         leaderboard
-  def entry_range(first, last)
-    if last < first
-      raise SteamCondenserError,
-        'First entry must be prior to last entry for leaderboard entry lookup.'
-    end
-
-    if (last - first) > 5000
-      raise SteamCondenserError,
-        'Leaderboard entry lookup is currently limited to a maximum of 5001 entries per request.'
-    end
-
-    parse "#@url&start=#{first}&end=#{last}"
-
-    error = @xml_data['error']
-    raise SteamCondenserError, error unless error.nil?
-
-    entries = []
-    @xml_data['entries']['entry'].each do |entry_data|
-      rank = entry_data['rank'].to_i
-      entries[rank] = GameLeaderboardEntry.new entry_data, self
-    end
-
-    parse_entries
-  end
-
-  private
-
-  # Creates a new leaderboard instance with the given XML data
-  #
-  # @param [Hash<String, Object>] board_data The XML data of the leaderboard
-  def initialize(board_data)
-    @url          = board_data['url']
-    @id           = board_data['lbid'].to_i
-    @name         = board_data['name']
-    @entry_count  = board_data['entries'].to_i
-    @sort_method  = board_data['sortmethod'].to_i
-    @display_type = board_data['displaytype'].to_i
-  end
-
-  # Parses all entries available in the XML data
-  #
-  # @return [Array<GameLeaderboardEntry>] All available entries
-  def parse_entries
-    entries = []
-    @xml_data['entries']['entry'].each do |entry_data|
-      entries[entry_data['rank'].to_i] =
-        GameLeaderboardEntry.new entry_data, self
-    end
-
-    entries
-  end
-
-  # Loads the leaderboards of the specified games into the cache
-  #
-  # @param [String] game_name The short name of the game
-  # @raise [SteamCondenserException] if an error occurs while fetching the
-  #         leaderboards
-  def self.load_leaderboards(game_name)
-    begin
-      url = "http://steamcommunity.com/stats/#{game_name}/leaderboards/?xml=1"
-      boards_data = MultiXml.parse(open(url, {:proxy => true})).values.first
-    rescue
-      raise SteamCondenserError.new 'XML data could not be parsed.', $!
-    end
-
-    error = boards_data['error']
-    raise SteamCondenserError, error unless error.nil?
-
-    @@leaderboards[game_name] = []
-    boards_data['leaderboard'].each do |board_data|
-      leaderboard = GameLeaderboard.new board_data
-      @@leaderboards[game_name][leaderboard.id] = leaderboard
-    end
-  end
-
-end