steam-condenser 1.2.0 → 1.2.1

data/pkg/steam-condenser-1.2.0/lib/steam/community/dods/dods_weapon.rb

@@ -0,0 +1,67 @@
+# 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
+
+require 'steam/community/game_weapon'
+
+# Represents the stats for a Day of Defeat: Source weapon for a specific user
+#
+# @author Sebastian Staudt
+class DoDSWeapon
+
+  include GameWeapon
+
+  # Returns the number of headshots achieved with this weapon
+  #
+  # @return [Fixnum] The number of headshots achieved
+  attr_reader :headshots
+
+  # Returns the name of this weapon
+  #
+  # @return [String] The name of this weapon
+  attr_reader :name
+
+  # Returns the number of hits achieved with this weapon
+  #
+  # @return [Fixnum] The number of hits achieved
+  attr_reader :hits
+
+  # Creates a new instance of a Day of Defeat: Source weapon based on the
+  # given XML data
+  #
+  # @param [Hash<String, Object>] weapon_data The XML data of the class
+  def initialize(weapon_data)
+    super weapon_data
+
+    @headshots = weapon_data['headshots'].to_i
+    @id        = weapon_data['key']
+    @name      = weapon_data['name']
+    @shots     = weapon_data['shotsfired'].to_i
+    @hits      = weapon_data['shotshit'].to_i
+  end
+
+  # Returns the average number of hits needed for a kill with this weapon
+  #
+  # @return [Float] The average number of hits needed for a kill
+  def avg_hits_per_kill
+    @hits.to_f / @kill
+  end
+
+  # Returns the percentage of headshots relative to the shots hit with this
+  # weapon
+  #
+  # @return [Float] The percentage of headshots
+  def headshot_percentage
+    @headshots.to_f / @hits
+  end
+
+  # Returns the percentage of hits relative to the shots fired with this
+  # weapon
+  #
+  # @return [Float] The percentage of hits
+  def hit_percentage
+    @hits.to_f / @shots
+  end
+
+end

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

@@ -0,0 +1,109 @@
+# 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.2.0/lib/steam/community/game_class.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) 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.2.0/lib/steam/community/game_inventory.rb

@@ -0,0 +1,152 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011-2012, Sebastian Staudt
+
+require 'steam/community/cacheable'
+require 'steam/community/game_item'
+require 'steam/community/web_api'
+
+# Provides basic functionality to represent an inventory of player in a game
+#
+# @author Sebastian Staudt
+module GameInventory
+
+  # Returns an array of all items in this players inventory.
+  #
+  # @return [Array<GameItem>] All items in the backpack
+  attr_reader :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
+
+  @@attribute_schema = {}
+
+  @@item_schema = {}
+
+  @@qualities = {}
+
+  @@schema_language = 'en'
+
+  # Sets the language the schema should be fetched in (default is: `'en'`)
+  #
+  # @param [String] 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] steam_id64 The 64bit SteamID of the player to get the
+  #        inventory for
+  # @param [Boolean] fetch_now if `true` the data will be fetched immediately
+  def initialize(steam_id64, fetch_now = true)
+    @user = SteamId.new steam_id64, false
+
+    super fetch_now
+  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
+
+  # Returns the application ID of the game this inventory class belongs to
+  #
+  # @return [Fixnum] The application ID of the game
+  def app_id
+    self.class.send :class_variable_get, :@@app_id
+  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
+  def fetch
+    result = WebApi.json!("IEconItems_#{app_id}", 'GetPlayerItems', 1, { :SteamID => @user.steam_id64 })
+    item_class = self.class.send :class_variable_get, :@@item_class
+
+    @items = []
+    result[:items].each do |item_data|
+      unless item_data.nil?
+        item = item_class.new(self, item_data)
+        @items[item.backpack_position - 1] = item
+      end
+    end
+  end
+
+  # Returns the item schema
+  #
+  # The schemas are fetched first if not done already
+  #
+  # @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]
+  end
+
+  # Returns the quality schema
+  #
+  # 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]
+  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
+
+  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/pkg/steam-condenser-1.2.0/lib/steam/community/game_item.rb

@@ -0,0 +1,99 @@
+# 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/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>] 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 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
+  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 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 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
+  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)
+    @defindex          = item_data[:defindex]
+    @backpack_position = item_data[:inventory] & 0xffff
+    @class             = inventory.item_schema[@defindex][:item_class]
+    @count             = item_data[:quantity]
+    @id                = item_data[:id]
+    @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]
+    end
+  end
+
+  # Returns whether this item is tradeable
+  #
+  # @return [Boolean] `true` if this item is tradeable
+  def tradeable?
+    @tradeable
+  end
+
+end