steam-condenser 1.3.6 → 1.3.7

data/pkg/steam-condenser-1.3.6/pkg/steam-condenser-1.3.5/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.3.6/pkg/steam-condenser-1.3.5/lib/steam/community/portal2/portal2_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) 2011-2012, 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 < GameInventory
+
+  # The Steam application ID of Portal 2
+  APP_ID = 620
+
+  # Creates a new inventory object for the given SteamID64 in Portal 2 (App ID
+  # 620)
+  #
+  # @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 Portal 2 items
+  @@item_class = Portal2Item
+
+end

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

@@ -0,0 +1,55 @@
+# 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 ]
+
+  # Returns the slot where this item can be equipped in or `nil` if this item
+  # cannot be equipped
+  #
+  # @return [String, nil] The slot where this item can be equipped in
+  attr_reader :slot
+
+  # 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
+
+    @slot = schema_data[:item_slot]
+
+    @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.3.6/pkg/steam-condenser-1.3.5/lib/steam/community/portal2/portal2_stats.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) 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
+  # @macro cacheable
+  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.3.6/pkg/steam-condenser-1.3.5/lib/steam/community/steam_game.rb

@@ -0,0 +1,193 @@
+# 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 the overall number of players currently playing this game
+  #
+  # @return [Fixnum] The number of players playing this game
+  def player_count
+    params = { :appid => @app_id }
+    result = WebApi.json 'ISteamUserStats', 'GetNumberOfCurrentPlayers', 1, params
+    result = MultiJson.load(result, { :symbolize_keys => true})[:response]
+    result[:player_count]
+  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
+    return nil if @logo_hash.nil?
+    "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
+    return nil if @logo_hash.nil?
+    "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'
+      hash = game_data['logo'].match /\/#{app_id}\/([0-9a-f]+).jpg/
+      @logo_hash = hash[1] unless hash.nil?
+      @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
+  end
+
+end

data/pkg/steam-condenser-1.3.6/pkg/steam-condenser-1.3.5/lib/steam/community/steam_group.rb

@@ -0,0 +1,129 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2008-2013, Sebastian Staudt
+
+require 'errors/steam_condenser_error'
+require 'steam/community/cacheable'
+require 'steam/community/steam_id'
+require 'steam/community/xml_data'
+
+# The SteamGroup class represents a group in the Steam Community
+#
+# @author Sebastian Staudt
+class SteamGroup
+
+  include Cacheable
+  cacheable_with_ids :custom_url, :group_id64
+
+  include XMLData
+
+  # Returns the custom URL of this group
+  #
+  # The custom URL is a admin specified unique string that can be used instead
+  # of the 64bit SteamID as an identifier for a group.
+  #
+  # @return [String] The custom URL of this group
+  attr_reader :custom_url
+
+  # Returns this group's 64bit SteamID
+  #
+  # @return [Fixnum] This group's 64bit SteamID
+  attr_reader :group_id64
+
+  # Creates a new `SteamGroup` instance for the group with the given ID
+  #
+  # @param [String, Fixnum] id The custom URL of the group specified by the
+  #        group admin or the 64bit group ID
+  # @macro cacheable
+  def initialize(id)
+    if id.is_a? Numeric
+      @group_id64 = id
+    else
+      @custom_url = id.downcase
+    end
+    @members = []
+  end
+
+  # Returns the base URL for this group's page
+  #
+  # This URL is different for groups having a custom URL.
+  #
+  # @return [String] The base URL for this group
+  def base_url
+    if @custom_url.nil?
+      "http://steamcommunity.com/gid/#@group_id64"
+    else
+      "http://steamcommunity.com/groups/#@custom_url"
+    end
+  end
+
+  # Loads the members of this group
+  #
+  # This might take several HTTP requests as the Steam Community splits this
+  # data over several XML documents if the group has lots of members.
+  #
+  # @see Cacheable#fetch
+  def fetch
+    if @member_count.nil? || @member_count == @members.size
+      page = 0
+    else
+      page = 1
+    end
+
+    begin
+      total_pages = fetch_page(page += 1)
+    end while page < total_pages
+  end
+
+  # Returns the number of members this group has
+  #
+  # If the members have already been fetched the size of the member array is
+  # returned. Otherwise the the first page of the member listing is fetched and
+  # the member count and the first batch of members is stored.
+  #
+  # @return [Fixnum] The number of this group's members
+  def member_count
+    if @member_count.nil?
+      total_pages = fetch_page(1)
+      @fetch_time = Time.now if total_pages == 1
+    end
+
+    @member_count
+  end
+
+  # Returns the members of this group
+  #
+  # If the members haven't been fetched yet, this is done now.
+  #
+  # @return [Array<SteamId>] The Steam ID's of the members of this group
+  # @see #fetch
+  def members
+    fetch if @members.size != @member_count
+    @members
+  end
+
+  private
+
+  # Fetches a specific page of the member listing of this group
+  #
+  # @param [Fixnum] page The member page to fetch
+  # @return [Fixnum] The total number of pages of this group's member listing
+  def fetch_page(page)
+    member_data = parse "#{base_url}/memberslistxml?p=#{page}"
+
+    @group_id64   = member_data['groupID64'].to_i if page == 1
+    @member_count = member_data['memberCount'].to_i
+    total_pages   = member_data['totalPages'].to_i
+
+    member_data['members']['steamID64'].each do |member|
+      @members << SteamId.new(member.to_i, false)
+    end
+
+    total_pages
+  rescue
+    raise $! if $!.is_a? SteamCondenserError
+    raise SteamCondenserError, 'XML data could not be parsed.'
+  end
+
+end