steam-condenser 1.0.2 → 1.1.0

data/README.md

@@ -1,4 +1,4 @@
-Steam Condenser
+Steam Condenser [![Build Status](https://secure.travis-ci.org/koraktor/steam-condenser-ruby.png)](http://travis-ci.org/koraktor/steam-condenser-ruby)
 ===============
 
 The Steam Condenser is a multi-language library for querying the Steam
@@ -31,6 +31,7 @@ included LICENSE file.
 
 * Sebastian Staudt -- koraktor(at)gmail.com
 * DeFirence -- defirence(at)defirence.za.net
+* Mike Połtyn -- mike(at)railslove.com
 
 ## See Also
 

data/Rakefile

@@ -5,12 +5,21 @@
 #
 # Copyright (c) 2008-2011, Sebastian Staudt
 
-require 'rubygems'
+require 'rake/testtask'
 require 'rubygems/package_task'
 
+task :default => :test
+
 Gem::PackageTask.new Gem::Specification.load 'steam-condenser.gemspec' do |pkg|
 end
 
+# Rake task for running the test suite
+Rake::TestTask.new do |t|
+  t.libs << 'lib' << 'test'
+  t.test_files = Dir.glob 'test/**/test_*.rb'
+  t.verbose = true
+end
+
 # Check if YARD is installed
 begin
   require 'yard'

data/lib/steam-condenser/version.rb

@@ -6,6 +6,6 @@
 module SteamCondenser
 
   # The current version of Steam Condenser
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 
 end

data/lib/steam/community/game_leaderboard.rb

@@ -0,0 +1,199 @@
+# 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_leaderboard_entry';
+require 'steam/community/steam_id';
+
+# The GameLeaderboard class represents a single leaderboard for a specific game
+#
+# @author Sebastian Staudt
+class GameLeaderboard
+
+  LEADERBOARD_DISPLAY_TYPE_NONE         = 0
+  LEADERBOARD_DISPLAY_TYPE_NUMERIC      = 1
+  LEADERBOARD_DISPLAY_TYPE_SECONDS      = 2
+  LEADERBOARD_DISPLAY_TYPE_MILLISECONDS = 3
+
+  LEADERBOARD_SORT_METHOD_NONE = 0
+  LEADERBOARD_SORT_METHOD_ASC  = 1
+  LEADERBOARD_SORT_METHOD_DESC = 2
+
+  @@leaderboards = {}
+
+  # Returns the display type of the scores on this leaderboard
+  #
+  # @return [Fixnum] The display type of the scores
+  attr_reader :display_type
+
+  # Returns the number of entries on this leaderboard
+  #
+  # @return [Fixnum] The number of entries on this leaderboard
+  attr_reader :entry_count
+
+  # Returns the ID of the leaderboard
+  #
+  # @return [Fixnum] The ID of the leaderboard
+  attr_reader :id
+
+  # Returns the name of the leaderboard
+  #
+  # @return [String] The name of the leaderboard
+  attr_reader :name
+
+  # Returns the method that is used to sort the entries on the leaderboard
+  #
+  # @return [Fixnum] The sort method
+  attr_reader :sort_method
+
+  # Returns the leaderboard for the given game and leaderboard ID or name
+  #
+  # @param [String] game_name The short name of the game
+  # @param [Fixnum, String] id The ID or name of the leaderboard to return
+  # @return [GameLeaderboard] The matching leaderboard if available
+  def self.leaderboard(game_name, id)
+    leaderboards = self.leaderboards game_name
+
+    if id.is_a? Fixnum
+      leaderboards[id]
+    else
+      leaderboards.each_value do |board|
+        return board if board.name == id
+      end
+    end
+  end
+
+  # Returns an array containing all of a game's leaderboards
+  #
+  # @param [String] game_name The name of the game
+  # @return [Array<GameLeaderboard>] The leaderboards for this game
+  def self.leaderboards(game_name)
+    self.load_leaderboards game_name unless @@leaderboards.key? game_name
+
+    @@leaderboards[game_name]
+  end
+
+  # Returns the entry on this leaderboard for the user with the given SteamID
+  #
+  # @param [Fixnum, SteamId] steam_id The 64bit SteamID or the `SteamId` object
+  #        of the user
+  # @return [GameLeaderboardEntry] The entry of the user if available
+  # raise [SteamCondenserException] if an error occurs while fetching the
+  #         leaderboard
+  def entry_for_steam_id(steam_id)
+    steam_id = steam_id.steam_id64 if steam_id.is_a? SteamId
+
+    url = "#{@url}&steamid=#{steam_id}"
+    xml = REXML::Document.new(open(url, {:proxy => true}).read).root
+
+    error = @xml_data.elements['error']
+    raise SteamCondenserError, error.text unless error.nil?
+
+    boards_data.elements.each('entries/entry') do |entry_data|
+      if entry_data.elements['steamid'].text.to_i == steam_id
+        return GameLeaderboardEntry.new entry_data, self
+      end
+    end
+
+    nil
+  end
+
+  # Returns an array of entries on this leaderboard for the user with the given
+  # SteamID and his/her friends
+  #
+  # @param [Fixnum, SteamId] steam_id The 64bit SteamID or the `SteamId` object
+  #        of the user
+  # @return [Array<GameLeaderboardEntry>] The entries of the user and his/her
+  #         friends
+  # raise [SteamCondenserException] if an error occurs while fetching the
+  #         leaderboard
+  def entry_for_steam_id_friends(steam_id)
+    steam_id = steam_id.steam_id64 if steam_id.is_a? SteamId
+
+    url = "#{@url}&steamid=#{steam_id}"
+    xml = REXML::Document.new(open(url, {:proxy => true}).read).root
+
+    error = @xml_data.elements['error']
+    raise SteamCondenserError, error.text unless error.nil?
+
+    entries = []
+    boards_data.elements.each('entries/entry') do |entry_data|
+      rank = entry_data.elements['rank'].text.to_i
+      entries[rank] = GameLeaderboardEntry.new entry_data, self
+    end
+
+    entries
+  end
+
+  # Returns the entries on this leaderboard for a given rank range
+  #
+  # The range is inclusive and a maximum of 5001 entries can be returned in a
+  # single request.
+  #
+  # @param [Fixnum] first The first entry to return from the leaderboard
+  # @param [Fixnum] last The last entry to return from the leaderboard
+  # @return [Array<GameLeaderboardEntry>] The entries that match the given rank
+  #         range
+  # raise [SteamCondenserException] if an error occurs while fetching the
+  #         leaderboard
+  def entry_range(first, last)
+    if last < first
+      raise SteamCondenserException,
+        'First entry must be prior to last entry for leaderboard entry lookup.'
+    end
+
+    if (last - first) > 5000
+      raise SteamCondenserException,
+        'Leaderboard entry lookup is currently limited to a maximum of 5001 entries per request.'
+    end
+
+    url = "#{@url}&start=#{first}&end=#{last}"
+    xml = REXML::Document.new(open(url, {:proxy => true}).read).root
+
+    error = @xml_data.elements['error']
+    raise SteamCondenserError, error.text unless error.nil?
+
+    entries = []
+    boards_data.elements.each('entries/entry') do |entry_data|
+      rank = entry_data.elements['rank'].text.to_i
+      entries[rank] = GameLeaderboardEntry.new entry_data, self
+    end
+
+    entries
+  end
+
+  private
+
+  # Creates a new leaderboard instance with the given XML data
+  #
+  # @param [REXML::Element] board_data The XML data of the leaderboard
+  def initialize(board_data)
+    @url          = board_data.elements['url'].text
+    @id           = board_data.elements['lbid'].text.to_i
+    @name         = board_data.elements['name'].text
+    @entry_count  = board_data.elements['entries'].text.to_i
+    @sort_method  = board_data.elements['sortmethod'].text.to_i
+    @display_type = board_data.elements['displaytype'].text.to_i
+  end
+
+  # Loads the leaderboards of the specified games into the cache
+  #
+  # @param [String] game_name The short name of the game
+  # @raise [SteamCondenserException] if an error occurs while fetching the
+  #         leaderboards
+  def self.load_leaderboards(game_name)
+    url = "http://steamcommunity.com/stats/#{game_name}/leaderboards/?xml=1"
+    boards_data = REXML::Document.new(open(url, {:proxy => true}).read).root
+
+    error = boards_data.elements['error']
+    raise SteamCondenserError, error.text unless error.nil?
+
+    @@leaderboards[game_name] = []
+    boards_data.elements.each('leaderboard') do |board_data|
+      leaderboard = GameLeaderboard.new board_data
+      @@leaderboards[game_name][leaderboard.id] = leaderboard
+    end
+  end
+
+end

data/lib/steam/community/game_leaderboard_entry.rb

@@ -0,0 +1,43 @@
+# 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
+
+# The GameLeaderboard class represents a single entry in a leaderboard
+#
+# @author Sebastian Staudt
+class GameLeaderboardEntry
+
+  # Returns the Steam ID of this entry's player
+  #
+  # @return [SteamId] The Steam ID of the player
+  attr_reader :steam_id
+
+  # Returns the score of this entry
+  #
+  # @return [Fixnum] The score of this player
+  attr_reader :score
+
+  # Returns the rank where this entry is listed in the leaderboard
+  #
+  # @return [Fixnum] The rank of this entry
+  attr_reader :rank
+
+  # Returns the leaderboard this entry belongs to
+  #
+  # @return [GameLeaderboard] The leaderboard of this entry
+  attr_reader :leaderboard
+
+  # Creates new entry instance for the given XML data and leaderboard
+  #
+  # @param [REXML::Element] entry_data The XML data of the leaderboard of the
+  #        leaderboard entry
+  # @param [GameLeaderboard] leaderboard The leaderboard this entry belongs to
+  def initialize(entry_data, leaderboard)
+    @steam_id    = SteamId.new entry_data.elements['steamid'].text.to_i, false
+    @score       = entry_data.elements['score'].text.to_i
+    @rank        = entry_data.elements['rank'].text.to_i
+    @leaderboard = leaderboard
+  end
+
+end

data/lib/steam/community/game_stats.rb

@@ -7,6 +7,7 @@ require 'open-uri'
 require 'rexml/document'
 
 require 'steam/community/game_achievement'
+require 'steam/community/game_leaderboard'
 
 # This class represents the game statistics for a single user and a specific
 # game
@@ -175,6 +176,21 @@ class GameStats
     end
   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 @game_friendly_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 @game_friendly_name
+  end
+
   # Returns whether this Steam ID is publicly accessible
   #
   # @return [Boolean] `true` if this Steam ID is publicly accessible

data/lib/steam/community/steam_game.rb

@@ -3,6 +3,9 @@
 #
 # Copyright (c) 2011, Sebastian Staudt
 
+require 'steam/community/game_leaderboard'
+require 'steam/community/game_stats'
+
 # This class represents a game available on Steam
 #
 # @author Sebastian Staudt
@@ -42,6 +45,21 @@ class SteamGame
     !@short_name.nil?
   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
+
   # 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

data/lib/steam/community/steam_group.rb

@@ -6,6 +6,7 @@
 require 'open-uri'
 require 'rexml/document'
 
+require 'errors/steam_condenser_error'
 require 'steam/community/cacheable'
 require 'steam/community/steam_id'
 
@@ -78,11 +79,15 @@ class SteamGroup
       url = open("#{base_url}/memberslistxml?p=#{page}", {:proxy => true})
       member_data = REXML::Document.new(url.read).root
 
-      @group_id64 = member_data.elements['groupID64'].text.to_i if page == 1
-      total_pages = member_data.elements['totalPages'].text.to_i
+      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)
+        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
     end while page < total_pages
 

data/lib/steam/community/steam_id.rb

@@ -232,57 +232,61 @@ class SteamId
       raise SteamCondenserError, profile.elements['error'].text
     end
 
-    @nickname         = CGI.unescapeHTML profile.elements['steamID'].text
-    @steam_id64       = profile.elements['steamID64'].text.to_i
-    @vac_banned       = (profile.elements['vacBanned'].text == 1)
-
     unless REXML::XPath.first(profile, 'privacyMessage').nil?
       raise SteamCondenserError, profile.elements['privacyMessage'].text
     end
+    
+    begin
+      @nickname         = CGI.unescapeHTML profile.elements['steamID'].text
+      @steam_id64       = profile.elements['steamID64'].text.to_i
+      @vac_banned       = (profile.elements['vacBanned'].text == 1)
+
+      @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
+      @visibility_state = profile.elements['visibilityState'].text.to_i
+
+      if @privacy_state == 'public'
+        @custom_url                       = profile.elements['customURL'].text.downcase
+        @custom_url                       = nil if @custom_url.empty?
+
+        unless REXML::XPath.first(profile, 'favoriteGame').nil?
+          @favorite_game                  = profile.elements['favoriteGame/name'].text
+          @favorite_game_hours_played     = profile.elements['favoriteGame/hoursPlayed2wk'].text
+        end
 
-    @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
-    @visibility_state = profile.elements['visibilityState'].text.to_i
-
-    if @privacy_state == 'public'
-      @custom_url                       = profile.elements['customURL'].text.downcase
-      @custom_url                       = nil if @custom_url.empty?
-
-      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    = CGI.unescapeHTML 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    = CGI.unescapeHTML profile.elements['realname'].text
-      @steam_rating = profile.elements['steamRating'].text.to_f
-      @summary      = CGI.unescapeHTML profile.elements['summary'].text
-
-      @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
+        @head_line    = CGI.unescapeHTML 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    = CGI.unescapeHTML profile.elements['realname'].text
+        @steam_rating = profile.elements['steamRating'].text.to_f
+        @summary      = CGI.unescapeHTML profile.elements['summary'].text
+
+        @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
-      end
 
-      @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)
+        @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
-      end
 
-      @links = {}
-      unless REXML::XPath.first(profile, 'mostPlayedGames').nil?
-        profile.elements.each('weblinks/weblink') do |link|
-          @links[CGI.unescapeHTML link.elements['title'].text] = link.elements['link'].text
+        @links = {}
+        unless REXML::XPath.first(profile, 'weblinks').nil?
+          profile.elements.each('weblinks/weblink') do |link|
+            @links[CGI.unescapeHTML link.elements['title'].text] = link.elements['link'].text
+          end
         end
       end
+    rescue
+      raise SteamCondenserError, 'XML data could not be parsed.'
     end
 
     super