steam-condenser 1.1.0 → 1.2.0

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

@@ -25,13 +25,14 @@ class L4D2Weapon
 
   # Creates a new instance of a weapon based on the given XML data
   #
-  # @param [REXML::Element] weapon_data The XML data of this weapon
-  def initialize(weapon_data)
-    super weapon_data
-
-    @damage          = weapon_data.elements['damage'].text.to_i
-    @kill_percentage = weapon_data.elements['pctkills'].text.to_f * 0.01
-    @weapon_group    = weapon_data.attribute('group')
+  # @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/lib/steam/community/l4d/l4d_explosive.rb

@@ -15,12 +15,13 @@ class L4DExplosive
 
   # Creates a new instance of an explosivve based on the given XML data
   #
-  # @param [REXML::Element] weapon_data The XML data of this explosive
-  def initialize(weapon_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_data.name
-    @shots = weapon_data.elements['thrown'].text.to_i
+    @id    = weapon_name
+    @shots = weapon_data['thrown'].to_i
   end
 
   # Returns the average number of killed zombies for one shot of this explosive

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

@@ -42,14 +42,15 @@ class L4DMap
   # Creates a new instance of a Left4Dead Survival map based on the given
   # XML data
   #
-  # @param [REXML::Element] map_data The XML data for this map
-  def initialize(map_data)
-    @best_time    = map_data.elements['besttimeseconds'].text.to_f
-    @id           = map_data.name
-    @name         = map_data.elements['name'].text
-    @times_played = map_data.elements['timesplayed'].text.to_i
+  # @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.elements['medal'].text
+    case map_data['medal']
       when 'gold'
         @medal = L4DMap::GOLD
       when 'silver'

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

@@ -35,8 +35,8 @@ class L4DStats < GameStats
     if @survival_stats.nil?
       super
       @survival_stats[:maps] = {}
-      @xml_data.elements.each('stats/survival/maps/*') do |map_data|
-        @survival_stats[:maps][map_data.name] = L4DMap.new(map_data)
+      @xml_data['stats']['survival']['maps'].each do |map_data|
+        @survival_stats[:maps][map_data[0]] = L4DMap.new *map_data
       end
     end
 
@@ -54,14 +54,14 @@ class L4DStats < GameStats
 
     if @weapon_stats.nil?
       @weapon_stats = {}
-      @xml_data.elements.each('stats/weapons/*') do |weapon_data|
-        unless %w{molotov pipes}.include? weapon_data.name
-          weapon = L4DWeapon.new(weapon_data)
+      @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)
+          weapon = L4DExplosive.new *weapon_data
         end
 
-        @weapon_stats[weapon_data.name] = weapon
+        @weapon_stats[weapon_data[0]] = weapon
       end
     end
 

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

@@ -15,11 +15,12 @@ class L4DWeapon
 
   # Creates a new instance of a weapon based on the given XML data
   #
-  # @param [REXML::Element] weapon_data The XML data for this weapon
-  def initialize(weapon_data)
-    super weapon_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.elements['killpct'].text.to_f * 0.01
+    @kill_percentage = weapon_data['killpct'].to_f * 0.01
   end
 
 end

data/lib/steam/community/portal2/portal2_stats.rb

@@ -1,7 +1,7 @@
 # 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
+# Copyright (c) 2011-2012, Sebastian Staudt
 
 require 'steam/community/game_stats'
 require 'steam/community/portal2/portal2_inventory'
@@ -23,9 +23,9 @@ class Portal2Stats < GameStats
   # Returns the current Portal 2 inventory (a.k.a Robot Enrichment) of this
   # player
   #
-  # @return [TF2Inventory] This player's Portal 2 inventory
+  # @return [Portal2Inventory] This player's Portal 2 inventory
   def inventory
-    @inventory = Portal2Inventory.new(steam_id64) if @inventory.nil?
+    @inventory = Portal2Inventory.new(user.steam_id64) if @inventory.nil?
     @inventory
   end
 

data/lib/steam/community/steam_game.rb

@@ -1,23 +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) 2011, Sebastian Staudt
+# 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
 
-  @@games = {}
+  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
@@ -28,14 +36,48 @@ class SteamGame
   # @return [String] The short name of this game
   attr_reader :short_name
 
-  # Creates a new or cached instance of the game specified by the given XML
-  # data
+  # 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 [REXML::Element] game_data The XML data of the game
-  # @see #initialize
-  def self.new(game_data)
-    app_id = game_data.elements['appID'].text.to_i
-    @@games.key?(app_id) ? @@games[app_id] : super(app_id, game_data)
+  # @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
@@ -45,6 +87,15 @@ class SteamGame
     !@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
@@ -60,6 +111,35 @@ class SteamGame
     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
@@ -75,18 +155,28 @@ class SteamGame
 
   # 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 [REXML::Element] game_data The XML data 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
-    @name   = game_data.elements['name'].text
-    if game_data.elements['globalStatsLink'].nil?
-      @short_name = nil
+    @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
-      @short_name = game_data.elements['globalStatsLink'].text.match(/http:\/\/steamcommunity.com\/stats\/([^?\/]+)\/achievements\//)[1].downcase
+      @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
 
-    @@games[@app_id] = self
+    super()
   end
 
 end

data/lib/steam/community/steam_group.rb

@@ -1,14 +1,12 @@
 # This code is free software; you can redistribute it and/or modify it under
 # the terms of the new BSD License.
 #
-# Copyright (c) 2008-2011, Sebastian Staudt
-
-require 'open-uri'
-require 'rexml/document'
+# 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
 #
@@ -18,6 +16,8 @@ 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
@@ -38,17 +38,14 @@ class SteamGroup
   # @param [Boolean] fetch if `true` the groups's data is loaded into the
   #        object
   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 SteamCondenserError, 'Group could not be loaded.'
+    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
@@ -58,9 +55,9 @@ class SteamGroup
   # @return [String] The base URL for this group
   def base_url
     if @custom_url.nil?
-      "http://steamcommunity.com/gid/#{@group_id64}"
+      "http://steamcommunity.com/gid/#@group_id64"
     else
-      "http://steamcommunity.com/groups/#{@custom_url}"
+      "http://steamcommunity.com/groups/#@custom_url"
     end
   end
 
@@ -71,24 +68,14 @@ class SteamGroup
   #
   # @see Cacheable#fetch
   def fetch
-    @members = []
-    page = 0
+    if @member_count.nil? || @member_count == @members.size
+      page = 0
+    else
+      page = 1
+    end
 
     begin
-      page += 1
-      url = open("#{base_url}/memberslistxml?p=#{page}", {:proxy => true})
-      member_data = REXML::Document.new(url.read).root
-
-      begin
-        @group_id64 = member_data.elements['groupID64'].text.to_i if page == 1
-        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
-      rescue
-        raise SteamCondenserError, 'XML data could not be parsed.'
-      end
+      total_pages = fetch_page(page += 1)
     end while page < total_pages
 
     super
@@ -97,17 +84,17 @@ class SteamGroup
   # 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 group size is separately fetched without needing
-  # multiple requests for big groups.
+  # 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 @members.nil?
-      url = open("#{base_url}/memberslistxml", {:proxy => true})
-      REXML::Document.new(url.read).root.elements['memberCount'].text.to_i
-    else
-      @members.size
+    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
@@ -117,8 +104,32 @@ class SteamGroup
   # @return [Array<SteamId>] The Steam ID's of the members of this group
   # @see #fetch
   def members
-    fetch if @members.nil? || @members[0].nil?
+    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