steam-condenser 1.2.1 → 1.3.0

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

@@ -1,135 +0,0 @@
-# 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 '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
-  # @param [Boolean] fetch if `true` the groups's data is loaded into the
-  #        object
-  def initialize(id, fetch = true)
-    if id.is_a? Numeric
-      @group_id64 = id
-    else
-      @custom_url = id.downcase
-    end
-    @members = []
-
-    super fetch
-  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
-
-    super
-  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}"
-
-    begin
-      @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
-    rescue
-      raise SteamCondenserError, 'XML data could not be parsed.', $!.backtrace
-    end
-
-    total_pages
-  end
-
-end

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

@@ -1,513 +0,0 @@
-# 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 'cgi'
-
-require 'errors/steam_condenser_error'
-require 'steam/community/cacheable'
-require 'steam/community/game_stats'
-require 'steam/community/steam_game'
-require 'steam/community/steam_group'
-require 'steam/community/xml_data'
-
-# The SteamId class represents a Steam Community profile (also called Steam ID)
-#
-# @author Sebastian Staudt
-class SteamId
-
-  include Cacheable
-  cacheable_with_ids :custom_url, :steam_id64
-
-  include XMLData
-
-  # Returns the custom URL of this Steam ID
-  #
-  # The custom URL is a user specified unique string that can be used instead
-  # of the 64bit SteamID as an identifier for a Steam ID.
-  #
-  # @note The custom URL is not necessarily the same as the user's nickname.
-  # @return [String] The custom URL of this Steam ID
-  attr_reader :custom_url
-
-  # Returns the favorite game of this user
-  #
-  # @deprecated The favorite game is no longer listed for new users
-  # @return [String] The favorite game of this user
-  attr_reader :favorite_game
-
-  # Returns the number of hours that this user played his/her favorite game in
-  # the last two weeks
-  #
-  # @deprecated The favorite game is no longer listed for new users
-  # @return [String] The number of hours the favorite game has been played
-  #         recently
-  attr_reader :favorite_game_hours_played
-
-  # Returns the groups this user is a member of
-  #
-  # @return [Array<SteamGroup>] The groups this user is a member of
-  attr_reader :groups
-
-  # Returns the headline specified by the user
-  #
-  # @return [String] The headline specified by the user
-  attr_reader :head_line
-
-  # Returns the number of hours that this user played a game in the last two
-  # weeks
-  #
-  # @return [Float] The number of hours the user has played recently
-  attr_reader :hours_played
-
-  # Returns the links that this user has added to his/her Steam ID
-  #
-  # The keys of the hash contain the titles of the links while the values
-  # contain the corresponding URLs.
-  #
-  # @return [Hash<String, String>] The links of this user
-  attr_reader :links
-
-  # Returns the location of the user
-  #
-  # @return [String] The location of the user
-  attr_reader :location
-
-  # Returns the date of registration for the Steam account belonging to this
-  # SteamID
-  #
-  # @return [Time] The date of the Steam account registration
-  attr_reader :member_since
-
-  # Returns the games this user has played the most in the last two weeks
-  #
-  # The keys of the hash contain the names of the games while the values
-  # contain the number of hours the corresponding game has been played by the
-  # user in the last two weeks.
-  #
-  # @return [Hash<String, Float>] The games this user has played the most
-  #         recently
-  attr_reader :most_played_games
-
-  # Returns the Steam nickname of the user
-  #
-  # @return [String] The Steam nickname of the user
-  attr_reader :nickname
-
-  # Returns the privacy state of this Steam ID
-  #
-  # @return [String] The privacy state of this Steam ID
-  attr_reader :privacy_state
-
-  # Returns the real name of this user
-  #
-  # @return [String] The real name of this user
-  attr_reader :real_name
-
-  # Returns the message corresponding to this user's online state
-  #
-  # @return [String] The message corresponding to this user's online state
-  # @see #ingame?
-  # @see #online?
-  attr_reader :state_message
-
-  # Returns this user's 64bit SteamID
-  #
-  # @return [Fixnum] This user's 64bit SteamID
-  attr_reader :steam_id64
-
-  # Returns the Steam rating calculated over the last two weeks' activity
-  #
-  # @return [Float] The Steam rating of this user
-  attr_reader :steam_rating
-
-  # Returns the summary this user has provided
-  #
-  # @return [String] This user's summary
-  attr_reader :summary
-
-  # Returns this user's ban state in Steam's trading system
-  #
-  # @return [String] This user's trading ban state
-  attr_reader :trade_ban_state
-
-  # Returns the visibility state of this Steam ID
-  #
-  # @return [Fixnum] This Steam ID's visibility State
-  attr_reader :visibility_state
-
-  # Converts a 64bit numeric SteamID as used by the Steam Community to a
-  # SteamID as reported by game servers
-  #
-  # @param [Fixnum] community_id The SteamID string as used by the Steam
-  #        Community
-  # @raise [SteamCondenserError] if the community ID is to small
-  # @return [String] The converted SteamID, like `STEAM_0:0:12345`
-  def self.community_id_to_steam_id(community_id)
-    steam_id1 = community_id % 2
-    steam_id2 = community_id - 76561197960265728
-
-    unless steam_id2 > 0
-      raise SteamCondenserError, "SteamID #{community_id} is too small."
-    end
-
-    steam_id2 = (steam_id2 - steam_id1) / 2
-
-    "STEAM_0:#{steam_id1}:#{steam_id2}"
-  end
-
-  # Converts a SteamID as reported by game servers to a 64bit numeric SteamID
-  # as used by the Steam Community
-  #
-  # @param [String] steam_id The SteamID string as used on servers, like
-  #        `STEAM_0:0:12345`
-  # @raise [SteamCondenserError] if the SteamID doesn't have the correct
-  #        format
-  # @return [Fixnum] The converted 64bit numeric SteamID
-  def self.steam_id_to_community_id(steam_id)
-    if steam_id == 'STEAM_ID_LAN' || steam_id == 'BOT'
-      raise SteamCondenserError, "Cannot convert SteamID \"#{steam_id}\" to a community ID."
-    elsif steam_id.match(/^STEAM_[0-1]:[0-1]:[0-9]+$/).nil?
-      raise SteamCondenserError, "SteamID \"#{steam_id}\" doesn't have the correct format."
-    end
-
-    steam_id = steam_id[6..-1].split(':').map!{|s| s.to_i}
-
-    steam_id[1] + steam_id[2] * 2 + 76561197960265728
-  end
-
-  class << self
-    alias_method :convert_community_id_to_steam_id, :community_id_to_steam_id
-    alias_method :convert_steam_id_to_community_id, :steam_id_to_community_id
-  end
-
-  # Creates a new `SteamId` instance using a SteamID as used on servers
-  #
-  # The SteamID from the server is converted into a 64bit numeric SteamID first
-  # before this is used to retrieve the corresponding Steam Community profile.
-  #
-  # @param [String] steam_id The SteamID string as used on servers, like
-  #        `STEAM_0:0:12345`
-  # @return [SteamId] The `SteamId` belonging to the given SteamID
-  # @see .convert_steam_id_to_community_id
-  # @see #initialize
-  def self.from_steam_id(steam_id)
-    new(convert_steam_id_to_community_id(steam_id))
-  end
-
-  # Creates a new `SteamId` instance for the given Steam ID
-  #
-  # @param [String, Fixnum] id The custom URL of the Steam ID specified by the
-  #        user or the 64bit SteamID
-  # @param [Boolean] fetch if `true` the Steam ID's data is loaded into the
-  #        object
-  def initialize(id, fetch = true)
-    if id.is_a? Numeric
-      @steam_id64 = id
-    else
-      @custom_url = id.downcase
-    end
-
-    super fetch
-  end
-
-  # Returns whether the owner of this SteamID is VAC banned
-  #
-  # @return [Boolean] `true` if the user has been banned by VAC
-  def banned?
-    @vac_banned
-  end
-  alias_method :is_banned?, :banned?
-
-  # Returns the base URL for this Steam ID
-  #
-  # This URL is different for Steam IDs having a custom URL.
-  #
-  # @return [String] The base URL for this SteamID
-  def base_url
-    if @custom_url.nil?
-      "http://steamcommunity.com/profiles/#@steam_id64"
-    else
-      "http://steamcommunity.com/id/#@custom_url"
-    end
-  end
-
-  # Fetchs data from the Steam Community by querying the XML version of the
-  # profile specified by the ID of this Steam ID
-  #
-  # @raise SteamCondenserError if the Steam ID data is not available, e.g.
-  #        when it is private
-  # @see Cacheable#fetch
-  def fetch
-    begin
-      profile = parse "#{base_url}?xml=1"
-
-      if profile.key? 'error'
-        raise SteamCondenserError, profile['error']
-      end
-
-      if profile.key? 'privacyMessage'
-        raise SteamCondenserError, profile['privacyMessage']
-      end
-
-      @nickname         = CGI.unescapeHTML profile['steamID']
-      @steam_id64       = profile['steamID64'].to_i
-      @limited          = (profile['isLimitedAccount'].to_i == 1)
-      @trade_ban_state  = profile['tradeBanState']
-      @vac_banned       = (profile['vacBanned'].to_i == 1)
-
-      @image_url        = profile['avatarIcon'][0..-5]
-      @online_state     = profile['onlineState']
-      @privacy_state    = profile['privacyState']
-      @state_message    = profile['stateMessage']
-      @visibility_state = profile['visibilityState'].to_i
-
-      if public?
-        @custom_url = profile['customURL'].downcase
-        @custom_url = nil if @custom_url.empty?
-
-        if profile.key? 'favoriteGame'
-          @favorite_game              = profile['favoriteGame']['name']
-          @favorite_game_hours_played = profile['favoriteGame']['hoursPlayed2wk']
-        end
-
-        @head_line    = CGI.unescapeHTML profile['headline'] || ''
-        @hours_played = profile['hoursPlayed2Wk'].to_f
-        @location     = profile['location']
-        @member_since = Time.parse profile['memberSince']
-        @real_name    = CGI.unescapeHTML profile['realname'] || ''
-        @steam_rating = profile['steamRating'].to_f
-        @summary      = CGI.unescapeHTML profile['summary'] || ''
-
-        @most_played_games = {}
-        if profile.key? 'mostPlayedGames'
-          [profile['mostPlayedGames']['mostPlayedGame']].flatten.each do |most_played_game|
-            @most_played_games[most_played_game['gameName']] = most_played_game['hoursPlayed'].to_f
-          end
-        end
-
-        @groups = []
-        if profile.key? 'groups'
-          [profile['groups']['group']].flatten.each do |group|
-            @groups << SteamGroup.new(group['groupID64'].to_i, false)
-          end
-        end
-
-        @links = {}
-        if profile.key? 'weblinks'
-          [profile['weblinks']['weblink']].flatten.each do |link|
-            @links[CGI.unescapeHTML link['title']] = link['link']
-          end
-        end
-      end
-    rescue
-      raise $! if $!.is_a? SteamCondenserError
-      raise SteamCondenserError, 'XML data could not be parsed.', $!.backtrace
-    end
-
-    super
-  end
-
-  # Fetches the friends of this user
-  #
-  # This creates a new `SteamId` instance for each of the friends without
-  # fetching their data.
-  #
-  # @see #friends
-  # @see #initialize
-  def fetch_friends
-    @friends = []
-    friends_data = parse "#{base_url}/friends?xml=1"
-    friends_data['friends']['friend'].each do |friend|
-      @friends << SteamId.new(friend.to_i, false)
-    end
-  end
-
-  # Fetches the games this user owns
-  #
-  # This fills the game hash with the names of the games as keys. The values
-  # will either be `false` if the game does not have stats or the game's
-  # "friendly name".
-  #
-  # @see #games
-  def fetch_games
-    @games     = {}
-    @playtimes = {}
-    games_data = parse "#{base_url}/games?xml=1"
-    [games_data['games']['game']].flatten.each do |game_data|
-      app_id = game_data['appID'].to_i
-      game = SteamGame.new app_id, game_data
-      @games[app_id] = game
-      recent = total = 0
-      if game_data.key? 'hoursLast2Weeks'
-        recent = game_data['hoursLast2Weeks'].to_f
-      end
-      if game_data.key? 'hoursOnRecord'
-        total = game_data['hoursOnRecord'].to_f
-      end
-      @playtimes[app_id] = [(recent * 60).to_i, (total * 60).to_i]
-    end
-
-    true
-  end
-
-  # Returns the URL of the full-sized version of this user's avatar
-  #
-  # @return [String] The URL of the full-sized avatar
-  def full_avatar_url
-    "#{@image_url}_full.jpg"
-  end
-
-  # Returns the stats for the given game for the owner of this SteamID
-  #
-  # @param [Fixnum, String] id The full or short name or the application ID of
-  #        the game stats should be fetched for
-  # @return [GameStats] The statistics for the game with the given name
-  # @raise [SteamCondenserError] if the user does not own this game or it
-  #        does not have any stats
-  # @see find_game
-  # @see SteamGame#has_stats?
-  def game_stats(id)
-    game = find_game id
-
-    unless game.has_stats?
-      raise SteamCondenserError, "\"#{game.name}\" does not have stats."
-    end
-
-    GameStats.create_game_stats(@custom_url || @steam_id64, game.short_name)
-  end
-
-  # Returns the Steam Community friends of this user
-  #
-  # If the friends haven't been fetched yet, this is done now.
-  #
-  # @return [Array<SteamId>] The friends of this user
-  # @see #fetch_friends
-  def friends
-    fetch_friends if @friends.nil?
-    @friends
-  end
-
-  # Returns the games this user owns
-  #
-  # The keys of the hash are the games' application IDs and the values are
-  # the corresponding game instances.
-  #
-  # If the friends haven't been fetched yet, this is done now.
-  #
-  # @return [Hash<Fixnum, SteamGame>] The games this user owns
-  # @see #fetch_games
-  def games
-    fetch_games if @games.nil?
-    @games
-  end
-
-  # Returns the URL of the icon version of this user's avatar
-  #
-  # @return [String] The URL of the icon-sized avatar
-  def icon_url
-    "#@image_url.jpg"
-  end
-
-  # Returns a unique identifier for this Steam ID
-  #
-  # This is either the 64bit numeric SteamID or custom URL
-  #
-  # @return [Fixnum, String] The 64bit numeric SteamID or the custom URL
-  def id
-    @custom_url.nil? ? @steam_id64 : @custom_url
-  end
-
-  # Returns whether the owner of this SteamId is playing a game
-  #
-  # @return [Boolean] `true` if the user is in-game
-  def in_game?
-    @online_state == 'in-game'
-  end
-  alias_method :is_in_game?, :in_game?
-
-  # Returns whether this Steam account is limited
-  #
-  # @return [Boolean] `true` if this account is limited
-  def limited?
-    @limited
-  end
-
-  # Returns the URL of the medium-sized version of this user's avatar
-  #
-  # @return [String] The URL of the medium-sized avatar
-  def medium_avatar_url
-    "#{@image_url}_medium.jpg"
-  end
-
-  # Returns whether the owner of this SteamID is currently logged into Steam
-  #
-  # @return [Boolean] `true` if the user is online
-  def online?
-    @online_state != 'offline'
-  end
-  alias_method :is_online?, :online?
-
-  # Returns whether this Steam ID is publicly accessible
-  #
-  # @return [Boolean] `true` if this Steam ID is public
-  def public?
-    @privacy_state == 'public'
-  end
-
-  # Returns the time in minutes this user has played this game in the last two
-  # weeks
-  #
-  # @param [Fixnum, String] id The full or short name or the application ID of
-  #        the game
-  # @return [Fixnum] The number of minutes this user played the given game in
-  #         the last two weeks
-  def recent_playtime(id)
-    game = find_game id
-    @playtimes[game.app_id][0]
-  end
-
-  # Returns the total time in minutes this user has played this game
-  #
-  # @param [Fixnum, String] id The full or short name or the application ID of
-  #        the game
-  # @return [Fixnum] The total number of minutes this user played the given
-  #         game
-  def total_playtime(id)
-    game = find_game id
-    @playtimes[game.app_id][1]
-  end
-
-  private
-
-  # Tries to find a game instance with the given application ID or full name or
-  # short name
-  #
-  # @param [Fixnum, String] id The full or short name or the application ID of
-  #        the game
-  # @raise [SteamCondenserError] if the user does not own the game or no
-  #        game with the given ID exists
-  # @return [SteamGame] The game found with the given ID
-  def find_game(id)
-    if id.is_a? Integer
-      game = games[id]
-    else
-      game = games.values.find do |game|
-        game.short_name == id || game.name == id
-      end
-    end
-
-    if game.nil?
-      if id.is_a? Numeric
-        message = "This SteamID does not own a game with application ID #{id}."
-      else
-        message = "This SteamID does not own the game \"#{id}\"."
-      end
-      raise SteamCondenserError, message
-    end
-
-    game
-  end
-
-end