steam-condenser 0.8.0

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

@@ -0,0 +1,23 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2009, Sebastian Staudt
+
+require 'steam/community/game_weapon'
+
+class L4DWeapon < GameWeapon
+
+  attr_reader :accuracy, :headshots_percentage, :kill_percentage
+
+  # Creates a new instance of L4DWeapon based on the assigned XML data
+  def initialize(weapon_data)
+    super weapon_data
+
+    @accuracy             = weapon_data.elements['accuracy'].text
+    @headshots_percentage = weapon_data.elements['headshots'].text
+    @id                   = weapon_data.name
+    @kill_percentage      = weapon_data.elements['killpct'].text
+    @shots                = weapon_data.elements['shots'].text.to_i
+  end
+
+end

data/lib/steam/community/steam_group.rb

@@ -0,0 +1,16 @@
+# 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$
+
+# The SteamGroup class represents a group in the Steam Community
+class SteamGroup
+  
+  # Creates a SteamGroup object with the given group ID
+  def initialize(id)
+    @id = id
+  end
+  
+end

data/lib/steam/community/steam_id.rb

@@ -0,0 +1,212 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2008-2009, Sebastian Staudt
+
+require "open-uri"
+require "rexml/document"
+
+require "exceptions/steam_condenser_exception"
+require "steam/community/game_stats"
+require "steam/community/steam_group"
+
+# The SteamId class represents a Steam Community profile (also called Steam ID)
+class SteamId
+  
+  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
+
+  # Converts a SteamID 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?
+      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
+  end
+
+  # Creates a new SteamId object using a SteamID64 converted from a server
+  # SteamID
+  def self.get_from_steam_id(steam_id)
+    return 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.
+  def initialize(id, fetch = true)
+    if id.is_a? Numeric
+      @steam_id64 = id
+    else
+      @custom_url = id
+    end
+
+    begin
+      self.fetch_data if fetch
+    rescue REXML::ParseException
+      raise SteamCondenserException.new("SteamID could not be loaded.")
+    end
+  end
+
+  # Returns 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 SteamID
+  def fetch_data
+    url = base_url << '?xml=1'
+
+    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})
+    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
+      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
+        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)
+      end
+      
+      @links = Hash.new
+      profile.elements["weblinks"].elements.each("weblink") do |link|
+        @links[link.elements["title"].text] = link.elements["link"].text
+      end
+    end
+  end
+
+  # Fetches the games this user owns
+  def fetch_games
+    require 'rubygems'
+    require 'Hpricot'
+
+    url = base_url << '/games'
+
+    @games = {}
+    games_data = Hpricot(open(url).read).at('div#mainContents')
+
+    games_data.traverse_some_element('h4') do |game|
+      game_name = game.inner_html
+      stats = game.next_sibling
+      if stats.name == 'br'
+        @games[game_name] = false
+      else
+        stats = stats.next_sibling if stats.name == 'h5'
+        if stats.name == 'br'
+          @games[game_name] = false
+        else
+          stats = stats.siblings_at(2)[0]
+          friendly_name = stats['href'].match(/http:\/\/steamcommunity.com\/stats\/([0-9a-zA-Z:]+)\/achievements\//)[1]
+          @games[game_name] = friendly_name.downcase
+        end
+      end
+    end
+
+    return true
+  end
+  
+  # Returns the URL of the full version of this user's avatar
+  def full_avatar_url
+    return "#{@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
+      friendly_name = games[game_name]
+    else
+      raise ArgumentError.new("Stats for game #{game_name} do not exist.")
+    end
+
+    GameStats.create_game_stats(@custom_url || @steam_id64, friendly_name)
+  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.
+  def games
+    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"
+  end
+  
+  # Returns whether the owner of this SteamID is VAC banned
+  def is_banned?
+    return @vac_banned 
+  end
+  
+  # Returns whether the owner of this SteamId is playing a game
+  def is_in_game?
+    return @online_state == "in-game"
+  end
+  
+  # Returns whether the owner of this SteamID is currently logged into Steam
+  def is_online?
+    return @online_state != "offline"
+  end
+  
+  # Returns the URL of the medium version of this user's avatar
+  def medium_avatar_url
+    return "#{@image_url}_medium.jpg"
+  end
+
+end

data/lib/steam/community/tf2/tf2_class.rb

@@ -0,0 +1,31 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2008-2009, Sebastian Staudt
+
+require 'steam/community/game_class'
+
+# Represents the stats for a Team Fortress 2 class for a specific user
+class TF2Class < GameClass
+  
+  attr_reader :max_buildings_destroyed, :max_captures, :max_damage,
+              :max_defenses, :max_dominations, :max_kill_assists, :max_kills,
+              :max_revenges, :max_score, :max_time_alive
+  
+  # Creates a new instance of TF2Class based on the assigned XML data
+  def initialize(class_data)
+    @name                    = class_data.elements["className"].text
+    @max_buildings_destroyed = class_data.elements["ibuildingsdestroyed"].text.to_i
+    @max_captures            = class_data.elements["ipointcaptures"].text.to_i
+    @max_damage              = class_data.elements["idamagedealt"].text.to_i
+    @max_defenses            = class_data.elements["ipointdefenses"].text.to_i
+    @max_dominations         = class_data.elements["idominations"].text.to_i
+    @max_kill_assists        = class_data.elements["ikillassists"].text.to_i
+    @max_kills               = class_data.elements["inumberofkills"].text.to_i
+    @max_revenges            = class_data.elements["irevenge"].text.to_i
+    @max_score               = class_data.elements["ipointsscored"].text.to_i
+    @max_time_alive          = class_data.elements["iplaytime"].text.to_i
+    @play_time               = class_data.elements["playtimeSeconds"].text.to_i
+  end
+  
+end

data/lib/steam/community/tf2/tf2_class_factory.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) 2008, Sebastian Staudt
+#
+# $Id$
+
+require "abstract_class"
+require "steam/community/tf2/tf2_class"
+require "steam/community/tf2/tf2_engineer"
+require "steam/community/tf2/tf2_medic"
+require "steam/community/tf2/tf2_sniper"
+require "steam/community/tf2/tf2_spy"
+
+# The TF2ClassFactory is used to created instances of TF2Class based on the XML
+# input data
+class TF2ClassFactory
+  
+  include AbstractClass
+  
+  # Creates a new instance of TF2Class storing the statistics for a Team
+  # Fortress 2 class with the assigned XML data
+  def self.get_tf2_class(class_data)
+    case class_data.elements("className")[0].text
+      when "Engineer" then
+        return TF2Engineer.new(class_data)
+      when "Medic" then
+        return TF2Medic.new(class_data)
+      when "Sniper" then
+        return TF2Sniper.new(class_data)
+      when "Spy" then
+        return TF2Spy.new(class_data)
+      else
+        return TF2Class.new(class_data)
+    end
+  end
+  
+end

data/lib/steam/community/tf2/tf2_engineer.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) 2008, Sebastian Staudt
+#
+# $Id$
+
+require "steam/community/tf2/tf2_class"
+
+# Represents the stats for the Team Fortress 2 engineer class for a specific
+# user
+class TF2Engineer < TF2Class
+  
+  attr_reader :max_buildings_built, :max_teleports, :max_sentry_kills
+  
+  # Creates a new instance of TF2Engineer based on the assigned XML data
+  def initialize(class_data)
+    super class_data
+    
+    @max_buildings_built = class_data.elements["ibuildingsbuilt"].text.to_i
+    @max_teleports       = class_data.elements["inumteleports"].text.to_i
+    @max_sentry_kills    = class_data.elements["isentrykills"].text.to_i
+  end
+  
+end

data/lib/steam/community/tf2/tf2_medic.rb

@@ -0,0 +1,22 @@
+# 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$
+
+require "steam/community/tf2/tf2_class"
+
+# Represents the stats for the Team Fortress 2 medic class for a specific user
+class TF2Medic < TF2Class
+  
+  attr_reader :max_health_healed, :max_ubercharges
+  
+  def initialize(class_data)
+    super class_data
+    
+    @max_health_healed = class_data.elements["ihealthpointshealed"].text.to_i
+    @max_ubercharges   = class_data.elements["inuminvulnerable"].text.to_i
+  end
+  
+end

data/lib/steam/community/tf2/tf2_sniper.rb

@@ -0,0 +1,20 @@
+# 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$
+
+require "steam/community/tf2/tf2_class"
+
+# Represents the stats for the Team Fortress 2 sniper class for a specific user
+class TF2Sniper < TF2Class
+  
+  # Creates a new instance of TF2Sniper based on the assigned XML data
+  def initialize(class_data)
+    super class_data
+    
+    @max_headshots = class_data.elements["iheadshots"].text.to_i
+  end
+  
+end

data/lib/steam/community/tf2/tf2_spy.rb

@@ -0,0 +1,23 @@
+# 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$
+
+require "steam/community/tf2/tf2_class"
+
+# Represents the stats for the Team Fortress 2 spy class for a specific user
+class TF2Spy < TF2Class
+  
+  attr_reader :max_backstabs, :max_health_leeched
+  
+  # Creates a new instance of TF2Spy based on the assigned XML data
+  def initialize(class_data)
+    super class_data
+    
+    @max_backstabs      = class_data.elements["ibackstabs"].text.to_i
+    @max_health_leeched = class_data.elements["ihealthpointsleached"].text.to_i
+  end
+  
+end

data/lib/steam/community/tf2/tf2_stats.rb

@@ -0,0 +1,39 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2008-2009, Sebastian Staudt
+
+require "steam/community/tf2/tf2_class"
+
+# The TF2Stats class represents the game statistics for a single user in Team
+# Fortress 2
+class TF2Stats < GameStats
+
+  attr_reader :accumulated_points
+  
+  # Creates a TF2Stats object by calling the super constructor with the game
+  # name "TF2"
+  def initialize(steam_id)
+    super steam_id, "TF2"
+
+    if public?
+      @accumulated_points = @xml_data.elements["stats"].elements["accumulatedPoints"].text.to_i
+    end
+  end
+  
+  # Returns a Hash of TF2Class for this user containing all Team Fortress 2
+  # classes. If the classes haven't been parsed already, parsing is done now.
+  def class_stats
+    return unless public?
+
+    if @class_stats.nil?
+      @class_stats = Hash.new
+      @xml_data.elements["stats"].elements.each("classData") do |class_data|
+        @class_stats[class_data.elements["className"].text] = TF2Class.new class_data
+      end
+    end
+    
+    return @class_stats
+  end
+  
+end