steam-condenser 1.2.0 → 1.2.1

data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d2_weapon.rb

@@ -0,0 +1,38 @@
+# 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/l4d/abstract_l4d_weapon'
+
+# This class represents the statistics of a single weapon for a user in
+# Left4Dead 2
+#
+# @author Sebastian Staudt
+class L4D2Weapon
+
+  include AbstractL4DWeapon
+
+  # Returns the amount of damage done by the player with this weapon
+  #
+  # @return [Fixnum] The damage done by this weapon
+  attr_reader :damage
+
+  # Returns the weapon group this weapon belongs to
+  #
+  # @return [String] The group this weapon belongs to
+  attr_reader :weapon_group
+
+  # Creates a new instance of a weapon based on the given XML data
+  #
+  # @param [String] weapon_name The name of this weapon
+  # @param [Hash<String, Object>] weapon_data The XML data of this weapon
+  def initialize(weapon_name, weapon_data)
+    super
+
+    @damage          = weapon_data['damage'].to_i
+    @kill_percentage = weapon_data['pctkills'].to_f * 0.01
+    @weapon_group    = weapon_data['group']
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_explosive.rb

@@ -0,0 +1,34 @@
+# 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'
+
+# This class represents the statistics of a single explosive weapon for a user
+# in Left4Dead
+#
+# @author Sebastian Staudt
+class L4DExplosive
+
+  include GameWeapon
+
+  # Creates a new instance of an explosivve based on the given XML data
+  #
+  # @param [String] weapon_name The name of this weapon
+  # @param [Hash<String, Object>] weapon_data The XML data of this weapon
+  def initialize(weapon_name, weapon_data)
+    super weapon_data
+
+    @id    = weapon_name
+    @shots = weapon_data['thrown'].to_i
+  end
+
+  # Returns the average number of killed zombies for one shot of this explosive
+  #
+  # @return [Float] The average number of kills per shot
+  def avg_kills_per_shot
+    1 / avg_shots_per_kill
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_map.rb

@@ -0,0 +1,65 @@
+# 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
+
+# This class holds statistical information about a map played by a player in
+# Survival mode of Left4Dead
+#
+# @author Sebastian Staudt
+class L4DMap
+
+  # Returns the best survival time of this player on this map
+  #
+  # @return [Float] The best survival time of this player on this map
+  attr_reader :best_time
+
+  # Returns the ID of this map
+  #
+  # @return [String] The ID of this map
+  attr_reader :id
+
+  # Returns the highest medal this player has won on this map
+  #
+  # @return [Fixnum] The highest medal won by this player on this map
+  attr_reader :medal
+
+  # Returns the name of the map
+  #
+  # @return [String] The name of the map
+  attr_reader :name
+
+  # Returns the number of times this map has been played by this player
+  #
+  # @return [Fixnum] The number of times this map has been played
+  attr_reader :times_played
+
+  GOLD   = 1
+  SILVER = 2
+  BRONZE = 3
+  NONE   = 0
+
+  # Creates a new instance of a Left4Dead Survival map based on the given
+  # XML data
+  #
+  # @param [String] map_name The name of this map
+  # @param [Hash<String, Object>] map_data The XML data for this map
+  def initialize(map_name, map_data)
+    @best_time    = map_data['besttimeseconds'].to_f
+    @id           = map_name
+    @name         = map_data['name']
+    @times_played = map_data['timesplayed'].to_i
+
+    case map_data['medal']
+      when 'gold'
+        @medal = L4DMap::GOLD
+      when 'silver'
+        @medal = L4DMap::SILVER
+      when 'bronze'
+        @medal = L4DMap::BRONZE
+      else
+        @medal = L4DMap::NONE
+    end
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_stats.rb

@@ -0,0 +1,71 @@
+# 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/l4d/abstract_l4d_stats'
+require 'steam/community/l4d/l4d_explosive'
+require 'steam/community/l4d/l4d_map'
+require 'steam/community/l4d/l4d_weapon'
+
+# This class represents the game statistics for a single user in Left4Dead
+#
+# @author Sebastian Staudt
+class L4DStats < GameStats
+
+  include AbstractL4DStats
+
+  # Creates a `L4DStats` object by calling the super constructor
+  # with the game name `'l4d'`
+  #
+  # @param [String] steam_id The custom URL or 64bit Steam ID of the user
+  def initialize(steam_id)
+    super steam_id, 'l4d'
+  end
+
+  # Returns a hash of Survival statistics for this user like revived teammates
+  #
+  # If the Survival statistics haven't been parsed already, parsing is done
+  # now.
+  #
+  # @return [Hash<String, Object>] The stats for the Survival mode
+  def survival_stats
+    return unless public?
+
+    if @survival_stats.nil?
+      super
+      @survival_stats[:maps] = {}
+      @xml_data['stats']['survival']['maps'].each do |map_data|
+        @survival_stats[:maps][map_data[0]] = L4DMap.new *map_data
+      end
+    end
+
+    @survival_stats
+  end
+
+  # Returns a hash of `L4DWeapon` for this user containing all Left4Dead
+  # weapons
+  #
+  # If the weapons haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<String, Object>] The weapon statistics
+  def weapon_stats
+    return unless public?
+
+    if @weapon_stats.nil?
+      @weapon_stats = {}
+      @xml_data['stats']['weapons'].each do |weapon_data|
+        unless %w{molotov pipes}.include? weapon_data[0]
+          weapon = L4DWeapon.new *weapon_data
+        else
+          weapon = L4DExplosive.new *weapon_data
+        end
+
+        @weapon_stats[weapon_data[0]] = weapon
+      end
+    end
+
+    @weapon_stats
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_weapon.rb

@@ -0,0 +1,26 @@
+# 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/l4d/abstract_l4d_weapon'
+
+# This class represents the statistics of a single weapon for a user in
+# Left4Dead
+#
+# @author Sebastian Staudt
+class L4DWeapon
+
+  include AbstractL4DWeapon
+
+  # Creates a new instance of a weapon based on the given XML data
+  #
+  # @param [String] weapon_name The name of this weapon
+  # @param [Hash<String, Object>] weapon_data The XML data of this weapon
+  def initialize(weapon_name, weapon_data)
+    super
+
+    @kill_percentage = weapon_data['killpct'].to_f * 0.01
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/portal2/portal2_inventory.rb

@@ -0,0 +1,25 @@
+# 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/game_inventory'
+require 'steam/community/portal2/portal2_item'
+
+# Represents the inventory (a.k.a. Robot Enrichment) of a Portal 2 player
+#
+# @author Sebastian Staudt
+class Portal2Inventory
+
+  include Cacheable
+  cacheable_with_ids :steam_id64
+
+  include GameInventory
+
+  # The Steam Application ID of Portal 2
+  @@app_id = 620
+
+  # The class representing Portal 2 items
+  @@item_class = Portal2Item
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/portal2/portal2_item.rb

@@ -0,0 +1,47 @@
+# 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/game_item'
+
+# Represents a Portal 2 item
+#
+# @author Sebastian Staudt
+class Portal2Item
+
+  include GameItem
+
+  # The names of the bots available in Portal 2
+  BOTS = [ :pbody, :atlas ]
+
+  # Creates a new instance of a Portal 2 item with the given data
+  #
+  # @param [Portal2Inventory] 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 = {}
+    BOTS.each_index do |class_id|
+      @equipped[BOTS[class_id]] = (item_data[:inventory] & (1 << 16 + class_id) != 0)
+    end
+  end
+
+  # Returns the symbols for each bot this player has equipped this item
+  #
+  # @return [Array<String>] The names of the bots this player has equipped this
+  #         item
+  def bots_equipped?
+    @equipped.reject { |bot_id, equipped| !equipped }
+  end
+
+  # Returns whether this item is equipped by this player at all
+  #
+  # @return [Boolean] `true` if the player has equipped this item at all
+  def equipped?
+    @equipped.has_value? true
+  end
+
+end

data/pkg/steam-condenser-1.2.0/lib/steam/community/portal2/portal2_stats.rb

@@ -0,0 +1,32 @@
+# 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/game_stats'
+require 'steam/community/portal2/portal2_inventory'
+
+# This class represents the game statistics for a single user in Portal 2
+#
+# @author Sebastian Staudt
+class Portal2Stats < GameStats
+
+  # Creates a `Portal2Stats` object by calling the super constructor with the
+  # game name `'portal2'`
+  #
+  # @param [String, Fixnum] steam_id The custom URL or 64bit Steam ID of the
+  #        user
+  def initialize(steam_id)
+    super steam_id, 'portal2'
+  end
+
+  # Returns the current Portal 2 inventory (a.k.a Robot Enrichment) of this
+  # player
+  #
+  # @return [Portal2Inventory] This player's Portal 2 inventory
+  def inventory
+    @inventory = Portal2Inventory.new(user.steam_id64) if @inventory.nil?
+    @inventory
+  end
+
+end

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

@@ -0,0 +1,182 @@
+# 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_leaderboard'
+require 'steam/community/game_stats'
+require 'steam/community/web_api'
+
+# This class represents a game available on Steam
+#
+# @author Sebastian Staudt
+class SteamGame
+
+  include Cacheable
+  cacheable_with_ids :app_id
+
+  # Returns the Steam application ID of this game
+  #
+  # @return [Fixnum] The Steam application ID of this game
+  attr_reader :app_id
+
+  # Returns the URL for the icon image of this game
+  #
+  # @return [String] The URL for the game icon
+  attr_reader :icon_url
+
+  # Returns the full name of this game
+  #
+  # @return [String] The full name of this game
+  attr_reader :name
+
+  # Returns the short name of this game (also known as "friendly name")
+  #
+  # @return [String] The short name of this game
+  attr_reader :short_name
+
+  # Checks if a game is up-to-date by reading information from a `steam.inf`
+  # file and comparing it using the Web API
+  #
+  # @param [String] path The file system path of the `steam.inf` file
+  # @return [Boolean] `true` if the game is up-to-date
+  def self.check_steam_inf(path)
+    steam_inf = File.read path
+    begin
+      app_id = steam_inf.match(/^\s*appID=(\d+)\s*$/im)[1].to_i
+      version = steam_inf.match(/^\s*PatchVersion=([\d\.]+)\s*$/im)[1].gsub('.', '').to_i
+    rescue
+      raise SteamCondenserError, "The steam.inf file at \"#{path}\" is invalid."
+    end
+    uptodate? app_id, version
+  end
+
+  # Creates a new instance of a game with the given data and caches it
+  #
+  # @param [Fixnum] app_id The application ID of the game
+  # @param [Hash<String, Object>] game_data The XML data of the game
+  def self.new(app_id, game_data = nil)
+    if cached? app_id
+      class_variable_get(:@@cache)[app_id]
+    else
+      game = SteamGame.allocate
+      game.send :initialize, app_id, game_data
+      game
+    end
+  end
+
+  # Returns whether the given version of the game with the given application ID
+  # is up-to-date
+  #
+  # @param [Fixnum] app_id The application ID of the game to check
+  # @param [Fixnum] version The version to check against the Web API
+  # @return [Boolean] `true` if the given version is up-to-date
+  def self.uptodate?(app_id, version)
+    params = { :appid => app_id, :version => version }
+    result = WebApi.json 'ISteamApps', 'UpToDateCheck', 1, params
+    result = MultiJson.load(result, { :symbolize_keys => true})[:response]
+    raise SteamCondenserError, result[:error] unless result[:success]
+    result[:up_to_date]
+  end
+
+  # Returns whether this game has statistics available
+  #
+  # @return [Boolean] `true` if this game has stats
+  def has_stats?
+    !@short_name.nil?
+  end
+
+  # Returns a unique identifier for this game
+  #
+  # This is either the numeric application ID or the unique short name
+  #
+  # @return [Fixnum, String] The application ID or short name of the game
+  def id
+    @short_name == @app_id.to_s ? @app_id : @short_name
+  end
+
+  # Returns the leaderboard for this game and the given leaderboard ID or name
+  #
+  # @param [Fixnum, String] id The ID or name of the leaderboard to return
+  # @return [GameLeaderboard] The matching leaderboard if available
+  def leaderboard(id)
+    GameLeaderboard.leaderboard @short_name, id
+  end
+
+  # Returns an array containing all of this game's leaderboards
+  #
+  # @return [Array<GameLeaderboard>] The leaderboards for this game
+  def leaderboards
+    GameLeaderboard.leaderboards @short_name
+  end
+
+  # Returns the URL for the logo image of this game
+  #
+  # @return [String] The URL for the game logo
+  def logo_url
+    "http://media.steampowered.com/steamcommunity/public/images/apps/#@app_id/#@logo_hash.jpg"
+  end
+
+  # Returns the URL for the logo thumbnail image of this game
+  #
+  # @return [String] The URL for the game logo thumbnail
+  def logo_thumbnail_url
+    "http://media.steampowered.com/steamcommunity/public/images/apps/#@app_id/#@logo_hash_thumb.jpg"
+  end
+
+  # Returns the URL of this game's page in the Steam Store
+  #
+  # @return [String] This game's store page
+  def store_url
+    "http://store.steampowered.com/app/#@app_id"
+  end
+
+  # Returns whether the given version of this game is up-to-date
+  #
+  # @param [Fixnum] version The version to check against the Web API
+  # @return [Boolean] `true` if the given version is up-to-date
+  def uptodate?(version)
+    self.class.uptodate? @app_id, version
+  end
+
+  # Creates a stats object for the given user and this game
+  #
+  # @param [String, Fixnum] steam_id The custom URL or the 64bit Steam ID of
+  #        the user
+  # @return [GameStats] The stats of this game for the given user
+  def user_stats(steam_id)
+    return unless has_stats?
+
+    GameStats.create_game_stats steam_id, @short_name
+  end
+
+  private
+
+  # Creates a new instance of a game with the given data and caches it
+  #
+  # @note The real constructor of `SteamGame` is {.new}
+  # @param [Fixnum] app_id The application ID of the game
+  # @param [Hash<String, Object>] game_data The XML data of the game
+  def initialize(app_id, game_data)
+    @app_id   = app_id
+
+    if game_data.key? 'name'
+      @logo_hash = game_data['logo'].match(/\/#{app_id}\/([0-9a-f]+).jpg/)[1]
+      @name      = game_data['name']
+
+      if game_data.key? 'globalStatsLink'
+        @short_name = game_data['globalStatsLink'].match(/http:\/\/steamcommunity.com\/stats\/([^?\/]+)\/achievements\//)[1].downcase
+      end
+    else
+      @icon_url   = game_data['gameIcon']
+      @logo_hash  = game_data['gameLogo'].match(/\/#{app_id}\/([0-9a-f]+).jpg/)[1]
+      @name       = game_data['gameName']
+      @short_name = game_data['gameFriendlyName'].downcase
+      @short_name = @app_id if @short_name == @app_id.to_s
+    end
+
+    super()
+  end
+
+end