steam-condenser 1.3.5 → 1.3.6

data/pkg/steam-condenser-1.3.5/lib/steam/community/alien_swarm/alien_swarm_stats.rb

@@ -0,0 +1,186 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010-2011, Sebastian Staudt
+
+require 'steam/community/alien_swarm/alien_swarm_mission'
+require 'steam/community/alien_swarm/alien_swarm_weapon'
+
+# This class represents the game statistics for a single user in Alien Swarm
+#
+# @author Sebastian Staudt
+class AlienSwarmStats < GameStats
+
+  # Returns general stats for the players
+  #
+  # @return [Hash<Symbol, Object>] The stats for the player
+  attr_reader :lifetime_stats
+
+  # The base URL for all images referenced in the stats
+  BASE_URL = 'http://cdn.steamcommunity.com/public/images/gamestats/swarm/'
+
+  # The names of all weapons in Alien Swarm
+  WEAPONS = [ 'Autogun', 'Cannon_Sentry', 'Chainsaw', 'Flamer',
+              'Grenade_Launcher', 'Hand_Grenades', 'Hornet_Barrage',
+              'Incendiary_Sentry', 'Laser_Mines', 'Marskman_Rifle', 'Minigun',
+              'Mining_Laser', 'PDW', 'Pistol', 'Prototype_Rifle', 'Rail_Rifle',
+              'Rifle', 'Rifle_Grenade', 'Sentry_Gun', 'Shotgun',
+              'Tesla_Cannon', 'Vindicator', 'Vindicator_Grenade' ]
+
+  # Creates a new `AlienSwarmStats` instance by calling the super constructor
+  # with the game name `'alienswarm'`
+  #
+  # @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'
+
+    if public?
+      lifetime_data = @xml_data['stats']['lifetime']
+
+      @hours_played = lifetime_data['timeplayed']
+
+      @lifetime_stats = {}
+      @lifetime_stats[:accuracy]            = lifetime_data['accuracy'].to_f
+      @lifetime_stats[:aliens_burned]       = lifetime_data['aliensburned'].to_i
+      @lifetime_stats[:aliens_killed]       = lifetime_data['alienskilled'].to_i
+      @lifetime_stats[:campaigns]           = lifetime_data['campaigns'].to_i
+      @lifetime_stats[:damage_taken]        = lifetime_data['damagetaken'].to_i
+      @lifetime_stats[:experience]          = lifetime_data['experience'].to_i
+      @lifetime_stats[:experience_required] = lifetime_data['xprequired'].to_i
+      @lifetime_stats[:fast_hacks]          = lifetime_data['fasthacks'].to_i
+      @lifetime_stats[:friendly_fire]       = lifetime_data['friendlyfire'].to_i
+      @lifetime_stats[:games_successful]    = lifetime_data['gamessuccess'].to_i
+      @lifetime_stats[:healing]             = lifetime_data['healing'].to_i
+      @lifetime_stats[:kills_per_hour]      = lifetime_data['killsperhour'].to_f
+      @lifetime_stats[:level]               = lifetime_data['level'].to_i
+      @lifetime_stats[:promotion]           = lifetime_data['promotion'].to_i
+      @lifetime_stats[:promotion_img]       = BASE_URL + lifetime_data['promotionpic'] if @lifetime_stats[:promotion] > 0
+      @lifetime_stats[:next_unlock]         = lifetime_data['nextunlock']
+      @lifetime_stats[:next_unlock_img]     = BASE_URL + lifetime_data['nextunlockimg']
+      @lifetime_stats[:shots_fired]         = lifetime_data['shotsfired'].to_i
+      @lifetime_stats[:total_games]         = lifetime_data['totalgames'].to_i
+
+      @lifetime_stats[:games_successful_percentage] = (@lifetime_stats[:total_games] > 0) ? @lifetime_stats[:games_successful].to_f / @lifetime_stats[:total_games] : 0;
+    end
+  end
+
+  # Returns the favorites of this user like weapons and marine
+  #
+  # If the favorites haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<Symbol, Object>] The favorites of this player
+  def favorites
+    return unless public?
+
+    if @favorites.nil?
+      favorites_data = @xml_data['stats']['favorites']
+
+      @favorites = {}
+      @favorites[:class]                       = favorites_data['class']
+      @favorites[:class_img]                   = favorites_data['classimg']
+      @favorites[:class_percentage]            = favorites_data['classpct'].to_f
+      @favorites[:difficulty]                  = favorites_data['difficulty']
+      @favorites[:difficulty_percentage]       = favorites_data['difficultypct'].to_f
+      @favorites[:extra]                       = favorites_data['extra']
+      @favorites[:extra_img]                   = favorites_data['extraimg']
+      @favorites[:extra_percentage]            = favorites_data['extrapct'].to_f
+      @favorites[:marine]                      = favorites_data['marine']
+      @favorites[:marine_img]                  = favorites_data['marineimg']
+      @favorites[:marine_percentage]           = favorites_data['marinepct'].to_f
+      @favorites[:mission]                     = favorites_data['mission']
+      @favorites[:mission_img]                 = favorites_data['missionimg']
+      @favorites[:mission_percentage]          = favorites_data['missionpct'].to_f
+      @favorites[:primary_weapon]              = favorites_data['primary']
+      @favorites[:primary_weapon_img]          = favorites_data['primaryimg']
+      @favorites[:primary_weapon_percentage]   = favorites_data['primarypct'].to_f
+      @favorites[:secondary_weapon]            = favorites_data['secondary']
+      @favorites[:secondary_weapon_img]        = favorites_data['secondaryimg']
+      @favorites[:secondary_weapon_percentage] = favorites_data['secondarypct'].to_f
+    end
+
+    @favorites
+  end
+
+  # Returns the item stats for this user like ammo deployed and medkits
+  # used
+  #
+  # If the items haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<Symbol, Object>] The item stats of this player
+  def item_stats
+    return unless public?
+
+    if @item_stats.nil?
+      weapons_data = @xml_data['stats']['weapons']
+
+      @item_stats = {}
+      @item_stats[:ammo_deployed]             = weapons_data['ammo_deployed'].to_i
+      @item_stats[:sentryguns_deployed]       = weapons_data['sentryguns_deployed'].to_i
+      @item_stats[:sentry_flamers_deployed]   = weapons_data['sentry_flamers_deployed'].to_i
+      @item_stats[:sentry_freeze_deployed]    = weapons_data['sentry_freeze_deployed'].to_i
+      @item_stats[:sentry_cannon_deployed]    = weapons_data['sentry_cannon_deployed'].to_i
+      @item_stats[:medkits_used]              = weapons_data['medkits_used'].to_i
+      @item_stats[:flares_used]               = weapons_data['flares_used'].to_i
+      @item_stats[:adrenaline_used]           = weapons_data['adrenaline_used'].to_i
+      @item_stats[:tesla_traps_deployed]      = weapons_data['tesla_traps_deployed'].to_i
+      @item_stats[:freeze_grenades_thrown]    = weapons_data['freeze_grenades_thrown'].to_i
+      @item_stats[:electric_armor_used]       = weapons_data['electric_armor_used'].to_i
+      @item_stats[:healgun_heals]             = weapons_data['healgun_heals'].to_i
+      @item_stats[:healgun_heals_self]        = weapons_data['healgun_heals_self'].to_i
+      @item_stats[:healbeacon_heals]          = weapons_data['healbeacon_heals'].to_i
+      @item_stats[:healbeacon_heals_self]     = weapons_data['healbeacon_heals_self'].to_i
+      @item_stats[:damage_amps_used]          = weapons_data['damage_amps_used'].to_i
+      @item_stats[:healbeacons_deployed]      = weapons_data['healbeacons_deployed'].to_i
+      @item_stats[:healbeacon_heals_pct]      = weapons_data['healbeacon_heals_pct'].to_f
+      @item_stats[:healgun_heals_pct]         = weapons_data['healgun_heals_pct'].to_f
+      @item_stats[:healbeacon_heals_pct_self] = weapons_data['healbeacon_heals_pct_self'].to_f
+      @item_stats[:healgun_heals_pct_self]    = weapons_data['healgun_heals_pct_self'].to_f
+    end
+
+    @item_stats
+  end
+
+  # Returns the stats for individual missions for this user containing all
+  # Alien Swarm missions
+  #
+  # If the mission stats haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<String, AlienSwarmMission>] The mission stats for this player
+  def mission_stats
+    return unless public?
+
+    if @mission_stats.nil?
+      @mission_stats = {}
+      @xml_data['stats']['missions'].each do |mission_data|
+        mission = AlienSwarmMission.new *mission_data
+        @mission_stats[mission.name] = mission
+      end
+    end
+
+    @mission_stats
+  end
+
+  # Returns the stats for individual weapons for this user containing all
+  # Alien Swarm weapons
+  #
+  # If the weapon stats haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<String, AlienSwarmWeapon>] The weapon stats for this player
+  def weapon_stats
+    return unless public?
+
+    if @weapon_stats.nil?
+      @weapon_stats = {}
+      WEAPONS.each do |weapon_node|
+        weapon_data = @xml_data['stats']['weapons'][weapon_node]
+        weapon = AlienSwarmWeapon.new(weapon_data)
+        @weapon_stats[weapon.name] = weapon
+      end
+    end
+
+    @weapon_stats
+  end
+
+end

data/pkg/steam-condenser-1.3.5/lib/steam/community/alien_swarm/alien_swarm_weapon.rb

@@ -0,0 +1,49 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010-2011, Sebastian Staudt
+
+require 'steam/community/game_weapon'
+
+# This class holds statistical information about weapons used by a player
+# in Alien Swarm
+#
+# @author Sebastian Staudt
+class AlienSwarmWeapon
+
+  include GameWeapon
+
+  # Returns the accuracy of the player with this weapon
+  #
+  # @return [Float] The accuracy of the player with this weapon
+  attr_reader :accuracy
+
+  # Returns the damage achieved with this weapon
+  #
+  # @return [Fixnum] The damage achieved with this weapon
+  attr_reader :damage
+
+  # Returns the damage dealt to team mates with this weapon
+  #
+  # @return [Fixnum] The damage dealt to team mates with this weapon
+  attr_reader :friendly_fire
+
+  # Returns the name of this weapon
+  #
+  # @return [String] The name of this weapon
+  attr_reader :name
+
+  # Creates a new weapon instance based on the assigned weapon XML data
+  #
+  # @param [Hash<String, Object>] weapon_data The data representing this weapon
+  def initialize(weapon_data)
+    super
+
+    @accuracy      = weapon_data['accuracy'].to_f
+    @damage        = weapon_data['damage'].to_i
+    @friendly_fire = weapon_data['friendlyfire'].to_i
+    @name          = weapon_data['name']
+    @shots         = weapon_data['shotsfired'].to_i
+  end
+
+end

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

@@ -0,0 +1,133 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010-2011, Sebastian Staudt
+
+require 'multi_json'
+
+require 'steam/community/web_api'
+
+# This class represents Steam news and can be used to load a list of current
+# news about specific games
+#
+# @author Sebastian Staudt
+class AppNews
+
+  # Returns the Steam Application ID of the game this news belongs to
+  #
+  # @return [Fixnum] The application ID of the game this news belongs to
+  attr_reader :app_id
+
+  # Returns the name of the author of this news
+  #
+  # @return [String] The author of this news
+  attr_reader :author
+
+  # Returns the contents of this news
+  #
+  # This might contain HTML code.
+  #
+  # @note Depending on the setting for the maximum length of a news (see
+  #       {.news_for_app}), the contents might be truncated.
+  # @return [String] The contents of this news
+  attr_reader :contents
+
+  # Returns the date this news item has been published
+  #
+  # @return [Time] The date this news has been published
+  attr_reader :date
+
+  # Returns the name of the feed this news item belongs to
+  #
+  # @return [String] The name of the feed this news belongs to
+  attr_reader :feed_label
+
+  # Returns the symbolic name of the feed this news item belongs to
+  #
+  # @return [String] The symbolic name of the feed this news belongs to
+  attr_reader :feed_name
+
+  # Returns a unique identifier for this news
+  #
+  # @return [Fixnum] A unique identifier for this news
+  attr_reader :gid
+
+  # Returns the title of this news
+  #
+  # @return [String] The title of this news
+  attr_reader :title
+
+  # Returns the URL of the original news
+  #
+  # This is a direct link to the news on the Steam website or a redirecting
+  # link to the external post.
+  #
+  # @return [String] The URL of the original news
+  attr_reader :url
+
+  # Loads the news for the given game with the given restrictions
+  #
+  # @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.
+  # @param [Fixnum] count The maximum number of news to load. There's no
+  #        reliable way to load all news. Use a really great number instead.
+  # @param [Fixnum] max_length The maximum content length of the news. If a
+  #        maximum length is defined, the content of the news will only be at
+  #        most `max_length` characters long plus an ellipsis.
+  # @return [Array<AppNews>] An array of news items for the specified game with
+  #         the given options
+  def self.news_for_app(app_id, count = 5, max_length = nil)
+    params = { :appid => app_id, :count => count, :maxlength => max_length }
+    data = WebApi.json('ISteamNews', 'GetNewsForApp', 2, params)
+
+    news_items = []
+    MultiJson.load(data, { :symbolize_keys => true })[:appnews][:newsitems].each do |news_data|
+      news_items << AppNews.new(app_id, news_data)
+    end
+
+    news_items
+  end
+
+  # Returns whether this news item originates from a source other than Steam
+  # itself (e.g. an external blog)
+  #
+  # @return [Boolean] `true` if this news item is from an external source
+  def external?
+    @external
+  end
+
+  # Returns a simple textual representation of this news item
+  #
+  # Will consist of the name of the feed this news belongs to and the title of
+  # the news.
+  #
+  # @return [String] A simple text representing this news
+  def to_s
+    "#@feed_label: #@title"
+  end
+
+  private
+
+  # Creates a new instance of an AppNews news item with the given data
+  #
+  # @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.
+  # @param [Hash<Symbol, Object>] news_data The news data extracted from JSON
+  def initialize(app_id, news_data)
+    @app_id      = app_id
+    @author      = news_data[:author]
+    @contents    = news_data[:contents].strip
+    @data        = Time.at(news_data[:date])
+    @external    = news_data[:is_external_url]
+    @feed_label  = news_data[:feedlabel]
+    @feed_name   = news_data[:feedname]
+    @gid         = news_data[:gid]
+    @title       = news_data[:title]
+    @url         = news_data[:url]
+  end
+
+end

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

@@ -0,0 +1,199 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2009-2012, Sebastian Staudt
+
+# @macro [new] cacheable
+#   @overload $0(${1--1}, fetch = true, bypass_cache = false)
+#   @param [Boolean] fetch if `true` the object's data is fetched after
+#          creation
+#   @param [Boolean] bypass_cache if `true` the object's data is fetched again
+#          even if it has been cached already
+
+# This module implements caching functionality to be used in any object class
+# having one or more unique object identifier (i.e. ID) and using a `fetch`
+# method to fetch data, e.g. using a HTTP download.
+#
+# @author Sebastian Staudt
+module Cacheable
+
+  # When this module is included in another class it is initialized to make use
+  # of caching
+  #
+  # The original `initialize` method of the including class will be wrapped,
+  # relaying all instantiations to the `new` method defined in {ClassMethods}.
+  # Additionally the class variable to save the attributes to cache (i.e. cache
+  # IDs) and the cache class variable itself are initialized.
+  #
+  # @param [Class] base The class to extend with caching functionality
+  # @see ClassMethods
+  def self.included(base)
+    base.extend ClassMethods
+    base.send :class_variable_set, :@@cache, {}
+    base.send :class_variable_set, :@@cache_ids, []
+
+    class << base
+      def method_added(name)
+        if name == :fetch && !(@@in_method_added ||= false)
+          @@in_method_added = true
+          alias_method :original_fetch, :fetch
+
+          define_method :fetch do
+            original_fetch
+            @fetch_time = Time.now
+          end
+          @@in_method_added = false
+        end
+      end
+    end
+  end
+
+  # This module implements functionality to access the cache of a class that
+  # includes the {Cacheable} module as class methods
+  #
+  # @author Sebastian Staudt
+  module ClassMethods
+
+    # Defines wich instance variables which should be used to index the cached
+    # objects
+    #
+    # @note A call to this method is needed if you want a class including this
+    #       module to really use the cache.
+    # @param [Array<Symbol, Array<Symbol>>] ids The symbolic names of the
+    #        instance variables representing a unique identifier for this
+    #        object class. Arrays of symbols are also allowed and are used as
+    #        compound IDs.
+    def cacheable_with_ids(*ids)
+      class_variable_set :@@cache_ids, ids
+    end
+
+    # Returns whether an object with the given ID is already cached
+    #
+    # @param [Object] id The ID of the desired object
+    # @return [Boolean] `true` if the object with the given ID is already
+    #         cached
+    def cached?(id)
+      id.downcase! if id.is_a? String
+      cache.key?(id)
+    end
+
+    # Clears the object cache for the class this method is called on
+    def clear_cache
+      class_variable_set :@@cache, {}
+    end
+
+    # This checks the cache for an existing object. If it exists it is
+    # returned, otherwise a new object is created.
+    # Overrides the default `new` method of the cacheable object class.
+    #
+    # @param [Array<Object>] args The parameters of the object that should be
+    #        created and if possible loaded from cache
+    # @see #cached?
+    # @see #fetch
+    def new(*args)
+      arity = self.instance_method(:initialize).arity.abs
+      args += [nil] * (arity - args.size) if args.size < arity
+      bypass_cache = args.size > arity + 1 ? !!args.pop : false
+      fetch = args.size > arity ? !!args.pop : true
+
+      object = self.allocate
+      object.send :initialize, *args
+      cached_object = object.send :cached_instance
+      object = cached_object unless cached_object.nil? || bypass_cache
+
+      if fetch && (bypass_cache || !object.fetched?)
+        object.fetch
+        object.cache
+      end
+
+      object
+    end
+
+    private
+
+    # Returns the current cache for the cacheable class
+    #
+    # @return [Hash<Object, Cacheable>] The cache for cacheable class
+    def cache
+      class_variable_get :@@cache
+    end
+
+    # Returns the list of IDs used for caching objects
+    #
+    # @return [Array<Symbol, Array<Symbol>>] The IDs used for caching objects
+    def cache_ids
+      class_variable_get :@@cache_ids
+    end
+
+  end
+
+  # Returns the time the object's data has been fetched the last time
+  #
+  # @return [Time] The time the object has been updated the last time
+  attr_reader :fetch_time
+
+  # Saves this object in the cache
+  #
+  # This will use the ID attributes selected for caching
+  def cache
+    cache     = self.class.send :cache
+    cache_ids.each do |cache_id|
+      cache[cache_id] = self if cache_id
+    end
+
+    true
+  end
+
+  # Fetches the object from some data source
+  #
+  # @note This method should be overridden in cacheable object classes and
+  #       should implement the logic to retrieve the object's data. Updating
+  #       the time is handled dynamically and does not need to be implemented
+  #       separately.
+  def fetch
+  end
+
+  # Returns whether the data for this object has already been fetched
+  #
+  # @return [Boolean] `true` if this object's data is available
+  def fetched?
+    !@fetch_time.nil?
+  end
+
+  private
+
+  # If available, returns the cached instance for the object it is called on
+  #
+  # This may be used to either replace an initial object with a completely
+  # cached instance of the same ID or to compare a modified object with the
+  # copy that was cached before.
+  #
+  # @see #cache_ids
+  def cached_instance
+    ids = cache_ids
+    cached = self.class.send(:cache).find { |id, object| ids.include? id}
+    cached.nil? ? nil : cached.last
+  end
+
+  # Returns a complete list of all values for the cache IDs of the cachable
+  # object
+  #
+  # @return [Array<Object, Array<Object>>] The values for the cache IDs
+  # @see #cache_id_value
+  def cache_ids
+    values = lambda do |id|
+      id.is_a?(Array) ? id.map(&values) : cache_id_value(id)
+    end
+
+    self.class.send(:cache_ids).map &values
+  end
+
+  # Returns the value for the ID
+  #
+  # @param [Symbol] id The name of an instance variable
+  # @return [Object] The value of the given instance variable
+  def cache_id_value(id)
+    instance_variable_get "@#{id}".to_sym
+  end
+
+end