steam-condenser 1.3.9 → 1.3.10

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

data/pkg/steam-condenser-1.3.9/lib/steam/community/css/css_map.rb

@@ -0,0 +1,61 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010-2013, Sebastian Staudt
+
+# Represents the stats for a Counter-Strike: Source map for a specific user
+#
+# @author Sebastian Staudt
+class CSSMap
+
+  # Returns the name of this map
+  #
+  # @return [String] The name of this map
+  attr_reader :name
+
+  # Returns the number of rounds the player has lost on this map
+  #
+  # @return [Fixnum] The number of rounds lost
+  attr_reader :rounds_lost
+
+  # Returns the number of rounds the player has played on this map
+  #
+  # @return [Fixnum] The number of rounds played
+  attr_reader :rounds_played
+
+  # Returns the number of rounds the player has won on this map
+  #
+  # @return [Fixnum] The number of rounds won
+  attr_reader :rounds_won
+
+  # Creates a new instance of a Counter-Strike: Source class based on the
+  # given XML data
+  #
+  # @param [String] map_name The name of the map
+  # @param [Hash<String, Object>] maps_data The XML data of all maps
+  def initialize(map_name, maps_data)
+    @name = map_name
+
+    @favorite      = (maps_data['favorite'] == @name)
+    @rounds_played = maps_data["#{@name}_rounds"].to_i
+    @rounds_won    = maps_data["#{@name}_wins"].to_i
+
+    @rounds_lost = @rounds_played - @rounds_won
+    @rounds_won_percentage = (@rounds_played > 0) ? @rounds_won.to_f / @rounds_played : 0
+  end
+
+  # Returns whether this map is the favorite map of this player
+  #
+  # @return [Boolean] `true` if this is the favorite map
+  def favorite?
+    @favorite
+  end
+
+  # Returns the percentage of rounds the player has won on this map
+  #
+  # @return [Float] The percentage of rounds won
+  def rounds_won_percentage
+    (@rounds_played > 0) ? @rounds_won.to_f / @rounds_played : 0
+  end
+
+end

data/pkg/steam-condenser-1.3.9/lib/steam/community/css/css_stats.rb

@@ -0,0 +1,140 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010-2013, Sebastian Staudt
+
+require 'steam/community/css/css_map'
+require 'steam/community/css/css_weapon'
+
+# The is class represents the game statistics for a single user in
+# Counter-Strike: Source
+#
+# @author Sebastian Staudt
+class CSSStats < GameStats
+
+  # The names of the maps in Counter-Strike: Source
+  MAPS = %w(cs_assault cs_compound cs_havana cs_italy cs_militia cs_office
+            de_aztec de_cbble de_chateau de_dust de_dust2 de_inferno de_nuke
+            de_piranesi de_port de_prodigy de_tides de_train)
+
+  # The names of the weapons in Counter-Strike: Source
+  WEAPONS = %w(deagle usp glock p228 elite fiveseven awp ak47 m4a1 aug sg552
+               sg550 galil famas scout g3sg1 p90 mp5navy tmp mac10 ump45 m3
+               xm1014 m249 knife grenade)
+
+  # Returns statistics about the last match the player played
+  #
+  # @return [Hash<Symbol, Object>] The stats of the last match
+  attr_reader :last_match_stats
+
+  # Returns overall statistics of this player
+  #
+  # @return [Hash<Symbol, Object>] The overall statistics
+  attr_reader :total_stats
+
+  # Creates a `CSSStats` instance by calling the super constructor
+  # with the game name `'cs:s'`
+  #
+  # @param [String, Fixnum] steam_id The custom URL or 64bit Steam ID of the
+  #        user
+  # @macro cacheable
+  def initialize(steam_id)
+    super steam_id, 'cs:s'
+
+    if public?
+      last_match_data = @xml_data['stats']['lastmatch']
+      lifetime_data = @xml_data['stats']['lifetime']
+      summary_data = @xml_data['stats']['summary']
+
+      @last_match_stats = {
+        :cost_per_kill      => last_match_data['costkill'].to_f,
+        :ct_wins            => last_match_data['ct_wins'].to_i,
+        :damage             => last_match_data['dmg'].to_i,
+        :deaths             => last_match_data['deaths'].to_i,
+        :dominations        => last_match_data['dominations'].to_i,
+        :favorite_weapon_id => last_match_data['favwpnid'].to_i,
+        :kills              => last_match_data['kills'].to_i,
+        :max_players        => last_match_data['max_players'].to_i,
+        :money              => last_match_data['money'].to_i,
+        :revenges           => last_match_data['revenges'].to_i,
+        :stars              => last_match_data['stars'].to_i,
+        :t_wins             => last_match_data['t_wins'].to_i,
+        :wins               => last_match_data['wins'].to_i,
+      }
+
+      @total_stats = {
+        :blind_kills          => lifetime_data['blindkills'].to_i,
+        :bombs_defused        => lifetime_data['bombsdefused'].to_i,
+        :bombs_planted        => lifetime_data['bombsplanted'].to_i,
+        :damage               => lifetime_data['dmg'].to_i,
+        :deaths               => summary_data['deaths'].to_i,
+        :domination_overkills => lifetime_data['dominationoverkills'].to_i,
+        :dominations          => lifetime_data['dominations'].to_i,
+        :earned_money         => lifetime_data['money'].to_i,
+        :enemy_weapon_kills   => lifetime_data['enemywpnkills'].to_i,
+        :headshots            => lifetime_data['headshots'].to_i,
+        :hits                 => summary_data['shotshit'].to_i,
+        :hostages_rescued     => lifetime_data['hostagesrescued'].to_i,
+        :kills                => summary_data['kills'].to_i,
+        :knife_kills          => lifetime_data['knifekills'].to_i,
+        :logos_sprayed        => lifetime_data['decals'].to_i,
+        :nightvision_damage   => lifetime_data['nvgdmg'].to_i,
+        :pistol_rounds_won    => lifetime_data['pistolrounds'].to_i,
+        :revenges             => lifetime_data['revenges'].to_i,
+        :rounds_played        => summary_data['rounds'].to_i,
+        :rounds_won           => summary_data['wins'].to_i,
+        :seconds_played       => summary_data['timeplayed'].to_i,
+        :shots                => summary_data['shots'].to_i,
+        :stars                => summary_data['stars'].to_i,
+        :weapons_donated      => lifetime_data['wpndonated'].to_i,
+        :windows_broken       => lifetime_data['winbroken'].to_i,
+        :zoomed_sniper_kills  => lifetime_data['zsniperkills'].to_i,
+        :kdratio              => (@total_stats[:deaths] > 0) ? @last_match_stats[:kills].to_f / @last_match_stats[:deaths] : 0,
+        :accuracy             => (@total_stats[:shots] > 0) ? @total_stats[:hits].to_f / @total_stats[:shots] : 0,
+        :kdratio              => (@total_stats[:deaths] > 0) ? @total_stats[:kills].to_f / @total_stats[:deaths] : 0,
+        :rounds_lost          => @total_stats[:rounds_played] - @total_stats[:rounds_won]
+      }
+    end
+  end
+
+  # Returns a map of `CSSMap` for this user containing all CS:S maps.
+  #
+  # If the maps haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<String, Object>] The map statistics for this user
+  def map_stats
+    return unless public?
+
+    if @map_stats.nil?
+      @map_stats = {}
+      maps_data = @xml_data['stats']['maps']
+
+      MAPS.each do |map_name|
+        @map_stats[map_name] = CSSMap.new(map_name, maps_data)
+      end
+    end
+
+    @map_stats
+  end
+
+  # Returns a map of `CSSWeapon` for this user containing all CS:S weapons.
+  #
+  # If the weapons haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<String, Object>] The weapon statistics for this user
+  def weapon_stats
+    return unless public?
+
+    if @weapon_stats.nil?
+      @weapon_stats = {}
+      weapons_data = @xml_data['stats']['weapons']
+
+      WEAPONS.each do |weapon_name|
+        @weapon_stats[weapon_name] = CSSWeapon.new(weapon_name, weapons_data)
+      end
+    end
+
+    @weapon_stats
+  end
+
+end

data/pkg/steam-condenser-1.3.9/lib/steam/community/css/css_weapon.rb

@@ -0,0 +1,69 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010-2013, Sebastian Staudt
+
+# Represents the stats for a Counter-Strike: Source weapon for a specific user
+#
+# @author Sebastian Staudt
+class CSSWeapon
+
+  # Returns the number of hits achieved with this weapon
+  #
+  # @return [Fixnum] The number of hits achieved
+  attr_reader :hits
+
+  # Returns the name of this weapon
+  #
+  # @return [String] The name of this weapon
+  attr_reader :name
+
+  # Returns the number of kills achieved with this weapon
+  #
+  # @return [Fixnum] The number of kills achieved
+  attr_reader :kills
+
+  # Returns the number of shots fired with this weapon
+  #
+  # @return [Fixnum] The number of shots fired
+  attr_reader :shots
+
+  # Creates a new instance of a Counter-Strike: Source weapon based on the
+  # given XML data
+  #
+  # @param [String] weapon_name The name of the weapon
+  # @param [Hash<String, Object>] weapons_data The XML data of all weapons
+  def initialize(weapon_name, weapons_data)
+    @name = weapon_name
+
+    @favorite = (weapons_data['favorite'] == @name)
+    @kills    = weapons_data["#{@name}_kills"].to_i
+
+    if @name != 'grenade' && @name != 'knife'
+      @hits  = weapons_data["#{@name}_hits"].to_i
+      @shots = weapons_data["#{@name}_shots"].to_i
+    end
+  end
+
+  # Returns the accuracy of this player with this weapon
+  #
+  # @return [Float] The accuracy with this weapon
+  def accuracy
+    (@shots > 0) ? @hits.to_f / @shots : 0
+  end
+
+  # Returns whether this weapon is the favorite weapon of this player
+  #
+  # @return [Boolean] `true` if this is the favorite weapon
+  def favorite?
+    @favorite
+  end
+
+  # Returns the kill-shot-ratio of this player with this weapon
+  #
+  # @return [Float] The kill-shot-ratio
+  def ksratio
+    (@shots > 0) ? @kills.to_f / @shots : 0
+  end
+
+end