steam-condenser 1.3.5 → 1.3.6

data/pkg/steam-condenser-1.3.5/lib/steam/community/dods/dods_class.rb

@@ -0,0 +1,90 @@
+# 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_class'
+
+# Represents the stats for a Day of Defeat: Source class for a specific user
+#
+# @author Sebastian Staudt
+class DoDSClass
+
+  include GameClass
+
+  # Returns the blocks achieved by the player with this class
+  #
+  # @return [Fixnum] The blocks achieved by the player
+  attr_reader :blocks
+
+  # Returns the bombs defused by the player with this class
+  #
+  # @return [Fixnum] The bombs defused by the player
+  attr_reader :bombs_defused
+
+  # Returns the bombs planted by the player with this class
+  #
+  # @return [Fixnum] the bombs planted by the player
+  attr_reader :bombs_planted
+
+  # Returns the number of points captured by the player with this class
+  #
+  # @return [Fixnum] The number of points captured by the player
+  attr_reader :captures
+
+  # Returns the number of times the player died with this class
+  #
+  # @return [Fixnum] The number of deaths by the player
+  attr_reader :deaths
+
+  # Returns the dominations achieved by the player with this class
+  #
+  # @return [Fixnum] The dominations achieved by the player
+  attr_reader :dominations
+
+  # Returns the ID of this class
+  #
+  # @return [String] The ID of this class
+  attr_reader :key
+
+  # Returns the number of enemies killed by the player with this class
+  #
+  # @return [Fixnum] The number of enemies killed by the player
+  attr_reader :kills
+
+  # Returns the number of rounds lost with this class
+  #
+  # @return [Fixnum] The number of rounds lost with this class
+  attr_reader :rounds_lost
+
+  # Returns the revenges achieved by the player with this class
+  #
+  # @return [Fixnum] The revenges achieved by the player
+  attr_reader :revenges
+
+  # Returns the number of rounds won with this class
+  #
+  # @return [Fixnum] The number of rounds won with this class
+  attr_reader :rounds_won
+
+  # Creates a new instance of a Day of Defeat: Source class based on the given
+  # XML data
+  #
+  # @param [Hash<String, Object>] class_data The XML data of the class
+  def initialize(class_data)
+    @blocks        = class_data['blocks'].to_i
+    @bombs_defused = class_data['bombsdefused'].to_i
+    @bombs_planted = class_data['bombsplanted'].to_i
+    @captures      = class_data['captures'].to_i
+    @deaths        = class_data['deaths'].to_i
+    @dominations   = class_data['dominations'].to_i
+    @key           = class_data['key']
+    @kills         = class_data['kills'].to_i
+    @name          = class_data['name']
+    @play_time     = class_data['playtime'].to_i
+    @rounds_lost   = class_data['roundslost'].to_i
+    @rounds_won    = class_data['roundswon'].to_i
+    @revenges      = class_data['revenges'].to_i
+  end
+
+end

data/pkg/steam-condenser-1.3.5/lib/steam/community/dods/dods_stats.rb

@@ -0,0 +1,62 @@
+# 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/dods/dods_class'
+require 'steam/community/dods/dods_weapon'
+require 'steam/community/game_stats'
+
+# The is class represents the game statistics for a single user in Day of
+# Defeat: Source
+#
+# @author Sebastian Staudt
+class DoDSStats < GameStats
+
+  # Creates a `DoDSStats` instance by calling the super constructor with the
+  # game name `'DoD: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, 'DoD:S'
+  end
+
+  # Returns a hash of `DoDSClass` for this user containing all DoD:S classes.
+  #
+  # If the classes haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<String, DoDSClass>] The class statistics for this user
+  def class_stats
+    return unless public?
+
+    if @class_stats.nil?
+      @class_stats = {}
+      @xml_data['stats']['classes']['class'].each do |class_data|
+        @class_stats[class_data['key']] = DoDSClass.new class_data
+      end
+    end
+
+    @class_stats
+  end
+
+  # Returns a Hash of `DoDSWeapon` for this user containing all DoD:S weapons.
+  #
+  # If the weapons haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<String, DoDSWeapon>] The weapon statistics for this user
+  def weapon_stats
+    return unless public?
+
+    if @weapon_stats.nil?
+      @weapon_stats = {}
+      @xml_data['stats']['weapons']['weapon'].each do |weapon_data|
+        @weapon_stats[weapon_data['key']] = DoDSWeapon.new weapon_data
+      end
+    end
+
+    @weapon_stats
+  end
+
+end

data/pkg/steam-condenser-1.3.5/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.3.5/lib/steam/community/dota2/dota2_beta_inventory.rb

@@ -0,0 +1,30 @@
+# 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.5/lib/steam/community/dota2/dota2_inventory.rb

@@ -0,0 +1,30 @@
+# 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.5/lib/steam/community/dota2/dota2_item.rb

@@ -0,0 +1,33 @@
+# 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.5/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.3.5/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