steam-condenser 1.3.6 → 1.3.7

data/pkg/steam-condenser-1.3.6/lib/steam/community/alien_swarm/alien_swarm_mission.rb

@@ -0,0 +1,120 @@
+# 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
+
+# This class holds statistical information about missions played by a player in
+# Alien Swarm
+#
+# @author Sebastian Staudt
+class AlienSwarmMission
+
+  # Returns the avarage damage taken by the player while playing a round in
+  # this mission
+  #
+  # @return [Float] The average damage taken by the player
+  attr_reader :avg_damage_taken
+
+  # Returns the avarage damage dealt by the player to team mates while playing
+  # a round in this mission
+  #
+  # @return [Float] The average damage dealt by the player to team mates
+  attr_reader :avg_friendly_fire
+
+  # Returns the avarage number of aliens killed by the player while playing a
+  # round in this mission
+  #
+  # @return [Float] The avarage number of aliens killed by the player
+  attr_reader :avg_kills
+
+  # Returns the highest difficulty the player has beat this mission in
+  #
+  # @return [String] The highest difficulty the player has beat this mission in
+  attr_reader :best_difficulty
+
+  # Returns the total damage taken by the player in this mission
+  #
+  # @return [Fixnum] The total damage taken by the player
+  attr_reader :damage_taken
+
+  # Returns the total damage dealt by the player to team mates in this mission
+  #
+  # @return [Fixnum] The total damage dealt by the player to team mates
+  attr_reader :friendly_fire
+
+  # Returns the number of successful rounds the player played in this mission
+  #
+  # @return [Fixnum] The number of successful rounds of this mission
+  attr_reader :games_successful
+
+  # Returns the URL to a image displaying the mission
+  #
+  # @return [String] The URL of the mission's image
+  attr_reader :img
+
+  # Returns the total number of aliens killed by the player in this mission
+  #
+  # @return [Fixnum] The total number of aliens killed by the player
+  attr_reader :kills
+
+  # Returns the file name of the mission's map
+  #
+  # @return [String] The file name of the mission's map
+  attr_reader :map_name
+
+  # Returns the name of the mission
+  #
+  # @return [String] The name of the mission
+  attr_reader :name
+
+  # Returns various statistics about the times needed to accomplish this
+  # mission
+  #
+  # This includes the best times for each difficulty, the average time and the
+  # total time spent in this mission.
+  #
+  # @return [Hash<Symbol, String>] Various time statistics about this mission
+  attr_reader :time
+
+  # Returns the number of games played in this mission
+  #
+  # @return [Fixnum] The number of games played in this mission
+  attr_reader :total_games
+
+  # Returns the percentage of successful games played in this mission
+  #
+  # @return [Float] The percentage of successful games played in this mission
+  attr_reader :total_games_percentage
+
+  # Creates a new mission instance of based on the given XML data
+  #
+  # @param [String] map_name The name of the mission's map
+  # @param [Hash<String, Object>] mission_data The data representing this
+  #        mission
+  def initialize(map_name, mission_data)
+    @avg_damage_taken       = mission_data['damagetakenavg'].to_f
+    @avg_friendly_fire      = mission_data['friendlyfireavg'].to_f
+    @avg_kills              = mission_data['killsavg'].to_f
+    @best_difficulty        = mission_data['bestdifficulty']
+    @damage_taken           = mission_data['damagetaken'].to_i
+    @friendly_fire          = mission_data['friendlyfire'].to_i
+    @games_successful       = mission_data['gamessuccess'].to_i
+    @img                    = AlienSwarmStats::BASE_URL + mission_data['image']
+    @kills                  = mission_data['kills'].to_i
+    @map_name               = map_name
+    @name                   = mission_data['name']
+    @total_games            = mission_data['gamestotal'].to_i
+    @total_games_percentage = mission_data['gamestotalpct'].to_f
+
+    @time = {
+      :average => mission_data['avgtime'],
+      :brutal  => mission_data['brutaltime'],
+      :easy    => mission_data['easytime'],
+      :hard    => mission_data['hardtime'],
+      :insane  => mission_data['insanetime'],
+      :normal  => mission_data['normaltime'],
+      :total   => mission_data['totaltime']
+    }
+  end
+
+end

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

@@ -0,0 +1,188 @@
+# 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/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 = %w(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 = {
+        :accuracy                    => lifetime_data['accuracy'].to_f,
+        :aliens_burned               => lifetime_data['aliensburned'].to_i,
+        :aliens_killed               => lifetime_data['alienskilled'].to_i,
+        :campaigns                   => lifetime_data['campaigns'].to_i,
+        :damage_taken                => lifetime_data['damagetaken'].to_i,
+        :experience                  => lifetime_data['experience'].to_i,
+        :experience_required         => lifetime_data['xprequired'].to_i,
+        :fast_hacks                  => lifetime_data['fasthacks'].to_i,
+        :friendly_fire               => lifetime_data['friendlyfire'].to_i,
+        :games_successful            => lifetime_data['gamessuccess'].to_i,
+        :healing                     => lifetime_data['healing'].to_i,
+        :kills_per_hour              => lifetime_data['killsperhour'].to_f,
+        :level                       => lifetime_data['level'].to_i,
+        :promotion                   => lifetime_data['promotion'].to_i,
+        :next_unlock                 => lifetime_data['nextunlock'],
+        :next_unlock_img             => BASE_URL + lifetime_data['nextunlockimg'],
+        :shots_fired                 => lifetime_data['shotsfired'].to_i,
+        :total_games                 => lifetime_data['totalgames'].to_i,
+        :games_successful_percentage => (@lifetime_stats[:total_games] > 0) ? @lifetime_stats[:games_successful].to_f / @lifetime_stats[:total_games] : 0
+      }
+
+      @lifetime_stats[:promotion_img] = BASE_URL + lifetime_data['promotionpic'] if @lifetime_stats[:promotion] > 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 = {
+        :class                       => favorites_data['class'],
+        :class_img                   => favorites_data['classimg'],
+        :class_percentage            => favorites_data['classpct'].to_f,
+        :difficulty                  => favorites_data['difficulty'],
+        :difficulty_percentage       => favorites_data['difficultypct'].to_f,
+        :extra                       => favorites_data['extra'],
+        :extra_img                   => favorites_data['extraimg'],
+        :extra_percentage            => favorites_data['extrapct'].to_f,
+        :marine                      => favorites_data['marine'],
+        :marine_img                  => favorites_data['marineimg'],
+        :marine_percentage           => favorites_data['marinepct'].to_f,
+        :mission                     => favorites_data['mission'],
+        :mission_img                 => favorites_data['missionimg'],
+        :mission_percentage          => favorites_data['missionpct'].to_f,
+        :primary_weapon              => favorites_data['primary'],
+        :primary_weapon_img          => favorites_data['primaryimg'],
+        :primary_weapon_percentage   => favorites_data['primarypct'].to_f,
+        :secondary_weapon            => favorites_data['secondary'],
+        :secondary_weapon_img        => favorites_data['secondaryimg'],
+        :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 = {
+        :ammo_deployed             => weapons_data['ammo_deployed'].to_i,
+        :sentryguns_deployed       => weapons_data['sentryguns_deployed'].to_i,
+        :sentry_flamers_deployed   => weapons_data['sentry_flamers_deployed'].to_i,
+        :sentry_freeze_deployed    => weapons_data['sentry_freeze_deployed'].to_i,
+        :sentry_cannon_deployed    => weapons_data['sentry_cannon_deployed'].to_i,
+        :medkits_used              => weapons_data['medkits_used'].to_i,
+        :flares_used               => weapons_data['flares_used'].to_i,
+        :adrenaline_used           => weapons_data['adrenaline_used'].to_i,
+        :tesla_traps_deployed      => weapons_data['tesla_traps_deployed'].to_i,
+        :freeze_grenades_thrown    => weapons_data['freeze_grenades_thrown'].to_i,
+        :electric_armor_used       => weapons_data['electric_armor_used'].to_i,
+        :healgun_heals             => weapons_data['healgun_heals'].to_i,
+        :healgun_heals_self        => weapons_data['healgun_heals_self'].to_i,
+        :healbeacon_heals          => weapons_data['healbeacon_heals'].to_i,
+        :healbeacon_heals_self     => weapons_data['healbeacon_heals_self'].to_i,
+        :damage_amps_used          => weapons_data['damage_amps_used'].to_i,
+        :healbeacons_deployed      => weapons_data['healbeacons_deployed'].to_i,
+        :healbeacon_heals_pct      => weapons_data['healbeacon_heals_pct'].to_f,
+        :healgun_heals_pct         => weapons_data['healgun_heals_pct'].to_f,
+        :healbeacon_heals_pct_self => weapons_data['healbeacon_heals_pct_self'].to_f,
+        :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.6/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.6/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