steam-condenser 0.8.0 → 0.9.0

data/lib/steam/community/game_stats.rb

@@ -11,50 +11,59 @@ require "steam/community/game_achievement"
 class GameStats
 end
 
-require "steam/community/l4d/l4d_stats"
+require 'steam/community/defense_grid/defense_grid_stats'
 require "steam/community/dods/dods_stats"
+require "steam/community/l4d/l4d_stats"
 require "steam/community/tf2/tf2_stats"
 
 # The GameStats class represents the game statistics for a single user and a
 # specific game
 class GameStats
-  
+
   protected :initialize
 
-  attr_reader :app_id, :game_friendly_name, :game_name, :hours_played,
-              :privacy_state, :steam_id
+  attr_reader :app_id, :custom_url, :game_friendly_name, :game_name,
+              :hours_played, :privacy_state, :steam_id64
 
   # Creates a GameStats (or one of its subclasses) object for the given user
   # depending on the game selected
   def self.create_game_stats(steam_id, game_name)
     case game_name
-      when "DoD:S":
+      when 'defensegrid:awakening'
+        DefenseGridStats.new(steam_id)
+      when 'dod:s'
         DoDSStats.new(steam_id)
-      when "L4D":
+      when 'l4d'
         L4DStats.new(steam_id)
-      when "TF2":
+      when 'tf2'
         TF2Stats.new(steam_id)
       else
         new(steam_id, game_name)
     end
   end
-  
+
   # Creates a GameStats object and fetchs data from Steam Community for the
   # given user and game
-  def initialize(steam_id, game_name)
-    @steam_id = steam_id
-    
-    @xml_data = REXML::Document.new(open("http://www.steamcommunity.com/id/#{@steam_id}/stats/#{game_name}?xml=1", {:proxy => true}).read).elements["playerstats"]
-    
-    @privacy_state = @xml_data.elements["privacyState"].text
+  def initialize(id, game_name)
+    if id.is_a? Numeric
+      @steam_id64 = id
+    else
+      @custom_url = id.downcase
+    end
+    @game_friendly_name = game_name
+
+    url = base_url + '?xml=1'
+    @xml_data = REXML::Document.new(open(url, {:proxy => true}).read).root
+
+    @privacy_state = @xml_data.elements['privacyState'].text
     if public?
-      @app_id             = @xml_data.elements["game"].elements["gameLink"].text.match("http://store.steampowered.com/app/([1-9][0-9]+)")[1]
-      @game_friendly_name = @xml_data.elements["game"].elements["gameFriendlyName"].text
-      @game_name          = @xml_data.elements["game"].elements["gameName"].text
-      @hours_played       = @xml_data.elements["stats"].elements["hoursPlayed"].text
+      @app_id             = @xml_data.elements['game/gameLink'].text.match(/http:\/\/store.steampowered.com\/app\/([1-9][0-9]+)/)[1]
+      @game_friendly_name = @xml_data.elements['game/gameFriendlyName'].text
+      @game_name          = @xml_data.elements['game/gameName'].text
+      @hours_played       = @xml_data.elements['stats/hoursPlayed'].text
     end
   end
-  
+
   # Returns the achievements for this stats' user and game. If the achievements
   # haven't been parsed already, parsing is done now.
   def achievements
@@ -62,16 +71,16 @@ class GameStats
 
     if @achievements.nil?
       @achievements = Array.new
-      @xml_data.elements["achievements"].elements.each("achievement") do |achievement|
-        @achievements << GameAchievement.new(@steam_id, @app_id, achievement.elements["name"].text, (achievement.attributes["closed"].to_i == 1))
+      @xml_data.elements.each('achievements/achievement') do |achievement|
+        @achievements << GameAchievement.new(@steam_id, @app_id, achievement.elements['name'].text, (achievement.attributes['closed'].to_i == 1))
       end
 
       @achievements_done = @achievements.reject{ |a| !a.done? }.size
     end
-    
-    return @achievements
+
+    @achievements
   end
-  
+
   # Returns the count of achievements done by this player. If achievements
   # haven't been parsed yet, parsing is done now.
   def achievements_done
@@ -85,8 +94,17 @@ class GameStats
     achievements_done.to_f / @achievements.size
   end
 
+  # Returns the base URL for this Steam Communtiy object
+  def base_url
+    if @custom_url.nil?
+      "http://steamcommunity.com/profiles/#{@steam_id64}/stats/#{@game_friendly_name}"
+    else
+      "http://steamcommunity.com/id/#{@custom_url}/stats/#{@game_friendly_name}"
+    end
+  end
+
   def public?
     @privacy_state == 'public'
   end
-  
-end
+
+end

data/lib/steam/community/l4d/l4d_map.rb

@@ -20,11 +20,11 @@ class L4DMap
     @times_played = map_data.elements['timesplayed'].text.to_i
 
     case map_data.elements['medal'].text
-      when 'gold':
+      when 'gold'
         @medal = L4DMap::GOLD
-      when 'silver':
+      when 'silver'
         @medal = L4DMap::SILVER
-      when 'bronze':
+      when 'bronze'
         @medal = L4DMap::BRONZE
       else
         @medal = L4DMap::NONE

data/lib/steam/community/steam_group.rb

@@ -1,16 +1,87 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2008, Sebastian Staudt
-#
-# $Id$
+# Copyright (c) 2008-2009, Sebastian Staudt
+
+require 'open-uri'
+require 'rexml/document'
+
+require 'steam/community/cacheable'
+require 'steam/community/steam_id'
 
 # The SteamGroup class represents a group in the Steam Community
 class SteamGroup
-  
+
+  include Cacheable
+  cacheable_with_ids :custom_url, :group_id64
+
+  attr_reader :custom_url, :group_id64
+
   # Creates a SteamGroup object with the given group ID
-  def initialize(id)
-    @id = id
+  def initialize(id, fetch = true)
+    begin
+      if id.is_a? Numeric
+        @group_id64 = id
+      else
+        @custom_url = id.downcase
+      end
+
+      super(fetch)
+    rescue REXML::ParseException
+      raise SteamCondenserException.new('Group could not be loaded.')
+    end
+  end
+
+  # Returns the URL to the group's Steam Community page
+  def base_url
+    if @custom_url.nil?
+      "http://steamcommunity.com/gid/#{@group_id64}"
+    else
+      "http://steamcommunity.com/groups/#{@custom_url}"
+    end
+  end
+
+  # Parses the data about this groups members
+  def fetch
+    @members = []
+    page = 0
+
+    begin
+      page += 1
+      url = open("#{base_url}/memberslistxml?p=#{page}", {:proxy => true})
+      member_data = REXML::Document.new(url.read).root
+
+      if page == 1
+        @group_id64 = member_data.elements['groupID64'].text.to_i
+      end
+      total_pages = member_data.elements['totalPages'].text.to_i
+    
+      member_data.elements['members'].elements.each do |member|
+        @members << SteamId.new(member.text.to_i, false)
+      end
+    end while page < total_pages
+
+    super
+  end
+
+  # Returns the number of members this group has.
+  # If the members have already been fetched with +fetch_members+ the size of
+  # the member array is returned. Otherwise the group size is separately
+  # fetched.
+  def member_count
+    if @members.nil?
+      url = open("#{base_url}/memberslistxml", {:proxy => true})
+      REXML::Document.new(url.read).root.elements['memberCount'].text.to_i
+    else
+      @members.size
+    end
+  end
+
+  # Returns the members of this group
+  # Calls +fetch_members+ if the members haven't been fetched already.
+  def members
+    fetch_members if @members.nil? or @members[0].nil?
+    @members
   end
   
 end

data/lib/steam/community/steam_id.rb

@@ -3,55 +3,60 @@
 #
 # Copyright (c) 2008-2009, Sebastian Staudt
 
-require "open-uri"
-require "rexml/document"
+require 'open-uri'
+require 'rexml/document'
 
-require "exceptions/steam_condenser_exception"
-require "steam/community/game_stats"
-require "steam/community/steam_group"
+require 'exceptions/steam_condenser_exception'
+require 'steam/community/cacheable'
+require 'steam/community/game_stats'
+require 'steam/community/steam_group'
 
 # The SteamId class represents a Steam Community profile (also called Steam ID)
 class SteamId
-  
+
+  include Cacheable
+  cacheable_with_ids :custom_url, :steam_id64
+
   attr_reader :custom_url, :favorite_game, :favorite_game_hours_played,
-              :friends, :groups, :head_line, :hours_played, :image_url, :links,
-              :location, :member_since, :most_played_games, :privacy_state,
-              :real_name, :state_message, :steam_rating, :steam_rating_text,
-              :summary, :vac_banned, :visibility_state
+              :groups, :head_line, :hours_played, :image_url, :links, :location,
+              :member_since, :most_played_games, :nickname, :privacy_state,
+              :real_name, :state_message, :steam_id64, :steam_rating,
+              :steam_rating_text, :summary, :vac_banned, :visibility_state
 
-  # Converts a SteamID as reported by game servers to a 64bit SteamID
+  # Converts the SteamID +steam_id+ as reported by game servers to a 64bit
+  # SteamID
   def self.convert_steam_id_to_community_id(steam_id)
-    if steam_id == "STEAM_ID_LAN"
-      raise SteamCondenserException.new("Cannot convert SteamID \"STEAM_ID_LAN\" to a community ID.")
-    elsif steam_id.match(/STEAM_[0-1]:[0-1]:[0-9]+/).nil?
+    if steam_id == 'STEAM_ID_LAN' or steam_id == 'BOT'
+      raise SteamCondenserException.new("Cannot convert SteamID \"#{steam_id}\" to a community ID.")
+    elsif steam_id.match(/^STEAM_[0-1]:[0-1]:[0-9]+$/).nil?
       raise SteamCondenserException.new("SteamID \"#{steam_id}\" doesn't have the correct format.")
     end
-    
-    steam_id = steam_id[6..-1].split(":").map!{|s| s.to_i}
-    
-    return steam_id[1] + 76561197960265728 + steam_id[2] * 2
+
+    steam_id = steam_id[6..-1].split(':').map!{|s| s.to_i}
+
+    steam_id[1] + steam_id[2] * 2 + 76561197960265728
   end
 
-  # Creates a new SteamId object using a SteamID64 converted from a server
-  # SteamID
+  # Creates a new SteamId object using the SteamID64 converted from a server
+  # SteamID given by +steam_id+
   def self.get_from_steam_id(steam_id)
-    return self.new(self.convert_steam_id_to_community_id(steam_id))
+    self.new(self.convert_steam_id_to_community_id(steam_id))
   end
 
-  # Creates a new SteamId object for the given SteamID, either numeric or the
-  # custom URL specified by the user. If +fetch+ is +true+ (default), fetch_data
-  # is used to load data into the object.
+  # Creates a new SteamId object for the given SteamID +id+, either numeric or
+  # the custom URL specified by the user. If +fetch+ is +true+ (default),
+  # fetch_data is used to load data into the object.
   def initialize(id, fetch = true)
-    if id.is_a? Numeric
-      @steam_id64 = id
-    else
-      @custom_url = id
-    end
-
     begin
-      self.fetch_data if fetch
+      if id.is_a? Numeric
+        @steam_id64 = id
+      else
+        @custom_url = id.downcase
+      end
+
+      super(fetch)
     rescue REXML::ParseException
-      raise SteamCondenserException.new("SteamID could not be loaded.")
+      raise SteamCondenserException.new('SteamID could not be loaded.')
     end
   end
 
@@ -63,78 +68,92 @@ class SteamId
       "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 SteamID
-  def fetch_data
-    url = base_url << '?xml=1'
+  def fetch
+    profile_url = open(base_url + '?xml=1', {:proxy => true})
+    profile = REXML::Document.new(profile_url.read).root
 
-    profile_url = open(url, {:proxy => true})
-    if profile_url.base_uri.to_s != url
-      profile_url = open(profile_url.base_uri.to_s + "?xml=1", {:proxy => true})
+    unless REXML::XPath.first(profile, 'error').nil?
+      raise SteamCondenserException.new(profile.elements['error'].text)
     end
-    
-    profile = REXML::Document.new(profile_url.read).elements["profile"]
-      
-    @image_url        = profile.elements["avatarIcon"].text[0..-5]
-    @online_state     = profile.elements["onlineState"].text
-    @privacy_state    = profile.elements["privacyState"].text
-    @state_message    = profile.elements["stateMessage"].text
-    @steam_id         = profile.elements["steamID"].text
-    @steam_id64       = profile.elements["steamID64"].text.to_i
-    @vac_banned       = (profile.elements["vacBanned"].text == 1)
-    @visibility_state = profile.elements["visibilityState"].text.to_i
-    
-    # Only public profiles can be scanned for further information
-    if @privacy_state == "public"
-      @custom_url                       = profile.elements["customURL"].text
 
-      unless REXML::XPath.first(profile, "favoriteGame").nil?
-        @favorite_game                    = profile.elements["favoriteGame/name"].text
-        @favorite_game_hours_played       = profile.elements["favoriteGame/hoursPlayed2wk"].text
+    @image_url        = profile.elements['avatarIcon'].text[0..-5]
+    @online_state     = profile.elements['onlineState'].text
+    @privacy_state    = profile.elements['privacyState'].text
+    @state_message    = profile.elements['stateMessage'].text
+    @nickname         = profile.elements['steamID'].text
+    @steam_id64       = profile.elements['steamID64'].text.to_i
+    @vac_banned       = (profile.elements['vacBanned'].text == 1)
+    @visibility_state = profile.elements['visibilityState'].text.to_i
+
+    # Only public profiles can be scanned for further information
+    if @privacy_state == 'public'
+      @custom_url                       = profile.elements['customURL'].text.downcase
+
+      # The favorite game cannot be set since 10/10/2008, but old profiles
+      # still have this. May be removed in a future version.
+      unless REXML::XPath.first(profile, 'favoriteGame').nil?
+        @favorite_game                  = profile.elements['favoriteGame/name'].text
+        @favorite_game_hours_played     = profile.elements['favoriteGame/hoursPlayed2wk'].text
       end
 
-      @head_line                        = profile.elements["headline"].text
-      @hours_played                     = profile.elements["hoursPlayed2Wk"].text.to_f
-      @location                         = profile.elements["location"].text
-      @member_since                     = Time.parse profile.elements["memberSince"].text
-      @real_name                        = profile.elements["realname"].text
-      @steam_rating                     = profile.elements["steamRating"].text.to_f
-      @summary                          = profile.elements["summary"].text
-
-      unless REXML::XPath.first(profile, "mostPlayedGames").nil?
-        @most_played_games = Hash.new
-        profile.elements["mostPlayedGames"].elements.each("mostPlayedGame") do |most_played_game|
-          @most_played_games[most_played_game.elements["gameName"].text] = most_played_game.elements["hoursPlayed"].text.to_f
+      @head_line                        = profile.elements['headline'].text
+      @hours_played                     = profile.elements['hoursPlayed2Wk'].text.to_f
+      @location                         = profile.elements['location'].text
+      @member_since                     = Time.parse(profile.elements['memberSince'].text)
+      @real_name                        = profile.elements['realname'].text
+      @steam_rating                     = profile.elements['steamRating'].text.to_f
+      @summary                          = profile.elements['summary'].text
+
+      # The most played games only exist if a user played at least one game in
+      # the last two weeks
+      @most_played_games = {}
+      unless REXML::XPath.first(profile, 'mostPlayedGames').nil?
+        profile.elements.each('mostPlayedGames/mostPlayedGame') do |most_played_game|
+          @most_played_games[most_played_game.elements['gameName'].text] = most_played_game.elements['hoursPlayed'].text.to_f
         end
       end
-      
-      @friends = Array.new
-      profile.elements["friends"].elements.each("friend") do |friend|
-        @friends << SteamId.new(friend.elements["steamID64"].text.to_i, false)
-      end
-      
-      @groups = Array.new
-      profile.elements["groups"].elements.each("group") do |group|
-        @groups << SteamGroup.new(group.elements["groupID64"].text.to_i)
+
+      @groups = []
+      unless REXML::XPath.first(profile, 'groups').nil?
+        profile.elements.each('groups/group') do |group|
+          @groups << SteamGroup.new(group.elements['groupID64'].text.to_i, false)
+        end
       end
-      
-      @links = Hash.new
-      profile.elements["weblinks"].elements.each("weblink") do |link|
-        @links[link.elements["title"].text] = link.elements["link"].text
+
+      @links = {}
+      unless REXML::XPath.first(profile, 'mostPlayedGames').nil?
+        profile.elements.each('weblinks/weblink') do |link|
+          @links[link.elements['title'].text] = link.elements['link'].text
+        end
       end
     end
+
+    super
+  end
+
+  # Fetches the friends of this user
+  def fetch_friends
+    url = "#{base_url}/friends?xml=1"
+
+    @friends = []
+    friends_data = REXML::Document.new(open(url, {:proxy => true}).read).root
+    friends_data.elements.each('friends/friend') do |friend|
+      @friends << SteamId.new(friend.text.to_i, false)
+    end
   end
 
   # Fetches the games this user owns
   def fetch_games
     require 'rubygems'
-    require 'Hpricot'
+    require 'hpricot'
 
-    url = base_url << '/games'
+    url = "#{base_url}/games"
 
     @games = {}
-    games_data = Hpricot(open(url).read).at('div#mainContents')
+    games_data = Hpricot(open(url, {:proxy => true}).read).at('div#mainContents')
 
     games_data.traverse_some_element('h4') do |game|
       game_name = game.inner_html
@@ -153,18 +172,18 @@ class SteamId
       end
     end
 
-    return true
+    true
   end
-  
-  # Returns the URL of the full version of this user's avatar
+
+  # Returns the URL of the full-sized version of this user's avatar
   def full_avatar_url
-    return "#{@image_url}_full.jpg"
+    "#{@image_url}_full.jpg"
   end
-  
+
   # Returns a GameStats object for the given game for the owner of this SteamID
   def game_stats(game_name)
     game_name.downcase!
-    
+
     if games.has_value? game_name
       friendly_name = game_name
     elsif games.has_key? game_name
@@ -176,6 +195,13 @@ class SteamId
     GameStats.create_game_stats(@custom_url || @steam_id64, friendly_name)
   end
 
+  # Returns an Array of SteamId representing all Steam Community friends of this
+  # user.
+  def friends
+    fetch_friends if @friends.nil?
+    @friends
+  end
+
   # Returns a Hash with the games this user owns. The keys are the games' names
   # and the values are the "friendly names" used for stats or +false+ if the
   # games has no stats.
@@ -183,30 +209,30 @@ class SteamId
     fetch_games if @games.nil?
     @games
   end
-  
+
   # Returns the URL of the icon version of this user's avatar
   def icon_url
-    return "#{@image_url}.jpg"
+    "#{@image_url}.jpg"
   end
-  
+
   # Returns whether the owner of this SteamID is VAC banned
   def is_banned?
-    return @vac_banned 
+    @vac_banned
   end
-  
+
   # Returns whether the owner of this SteamId is playing a game
   def is_in_game?
-    return @online_state == "in-game"
+    @online_state == 'in-game'
   end
-  
+
   # Returns whether the owner of this SteamID is currently logged into Steam
   def is_online?
-    return @online_state != "offline"
+    @online_state != 'offline'
   end
-  
-  # Returns the URL of the medium version of this user's avatar
+
+  # Returns the URL of the medium-sized version of this user's avatar
   def medium_avatar_url
-    return "#{@image_url}_medium.jpg"
+    "#{@image_url}_medium.jpg"
   end
 
 end