steam-condenser 0.13.1 → 0.14.0

data/lib/exceptions/packet_format_exception.rb

@@ -1,14 +1,21 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'exceptions/steam_condenser_exception'
 
+# This exception class indicates a problem when parsing packet data from the
+# responses received from a game or master server
+#
+# @author Sebastian Staudt
 class PacketFormatException < SteamCondenserException
 
-  def initialize
-    super 'The packet data received doesn\'t match the packet format.'
+  # Creates a new `PacketFormatException` instance
+  #
+  # @param [String] message The message to attach to the exception
+  def initialize(message)
+    super message
   end
 
 end

data/lib/exceptions/rcon_ban_exception.rb

@@ -1,12 +1,20 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2009-2010, Sebastian Staudt
+# Copyright (c) 2009-2011, Sebastian Staudt
 
 require 'exceptions/steam_condenser_exception'
 
+# This exception class indicates that the IP address your accessing the game
+# server from has been banned by the server
+#
+# You or the server operator will have to unban your IP address on the server.
+#
+# @author Sebastian Staudt
+# @see GameServer#rcon_auth
 class RCONBanException < SteamCondenserException
 
+  # Creates a new `RCONBanException` instance
   def initialize
     super 'You have been banned from this server.'
   end

data/lib/exceptions/rcon_no_auth_exception.rb

@@ -1,12 +1,19 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'exceptions/steam_condenser_exception'
 
+# This exception class indicates that you have not authenticated yet with the
+# game server you're trying to send commands via RCON
+#
+# @author Sebastian Staudt
+# @see GameServer#rcon_auth
+# @see GameServer#rcon_exec
 class RCONNoAuthException < SteamCondenserException
 
+  # Creates a new `RCONNoAuthException` instance
   def initialize
     super 'Not authenticated yet.'
   end

data/lib/exceptions/steam_condenser_exception.rb

@@ -1,8 +1,11 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# 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
+# Copyright (c) 2008-2011, Sebastian Staudt
 
+# This exception class is used as a base class for all exceptions related to
+# Steam Condenser's operation
+#
+# @author Sebastian Staudt
 class SteamCondenserException < StandardError
-  
-end
+end

data/lib/exceptions/timeout_exception.rb

@@ -1,12 +1,22 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'exceptions/steam_condenser_exception'
 
+# This exception class indicates that an operation could not be finished within
+# a reasonable amount of time
+#
+# This usually indicates that a server could not be contacted because of
+# network problems.
+#
+# @author Sebastian Staudt
+# @note {SteamSocket.timeout=} allows to set a custom timeout for socket
+#       operations
 class TimeoutException < SteamCondenserException
 
+  # Creates a new `TimeoutException` instance
   def initialize
     super 'The operation timed out.'
   end

data/lib/exceptions/web_api_exception.rb

@@ -1,34 +1,42 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2010, Sebastian Staudt
+# Copyright (c) 2011, Sebastian Staudt
 
 require 'exceptions/steam_condenser_exception'
 
-# This exceptions is raised when a Steam Web API request or a related action
-# fails. This can have various reasons.
+# This exception is raised when a Steam Web API request or a related action
+# fails. This can have various reasons like an invalid Web API key or a broken
+# request.
+#
+# @author Sebastian Staudt
+# @see WebApi
 class WebApiException < SteamCondenserException
 
-  # Creates a new WebApiException with an error message according to the given
-  # +cause+. If this cause is +:status_bad+ (which will origin from the Web API
-  # itself) or +:http_error+ the details about this failed request will be
-  # taken from +status_code+ and +status_message+.
+  # Creates a new `WebApiException` with an error message according to the given
+  # `cause`. If this cause is `:status_bad` (which will origin from the Web API
+  # itself) or `:http_error` the details about this failed request will be
+  # taken from `status_code` and `status_message`.
+  #
+  # @param [:http_error, :invalid_key, :status_bad, :unauthorized] cause A
+  #        symbolic name for the problem which caused this exception:
   #
-  # * +:http_errpr+:   An error in the HTTP request itself will result in an
-  #                    exception with this reason.
-  # * +:invalid_key+:  This occurs when trying to set a Web API key that isn't
-  #                    valid, i.e. a 128 bit integer in a hexadecimal string.
-  # * +:status_bad+:   This is caused by a succesful request that fails for
-  #                    some Web API internal reason (e.g. a invalid argument).
-  #                    Details about this failed request will be taken from
-  #                    +status_code+ and +status_message+.
-  # * +:unauthorized+: This happens when a Steam Web API request is rejected as
-  #                    unauthorized. This most likely means that you did not
-  #                    specify a valid Web API key using +WebAPI.api_key=+. A
-  #                    Web API key can be obtained from
-  #                    http://steamcommunity.com/dev/apikey.
+  #        * `:http_error`: An error during the HTTP request itself will result
+  #           in an exception with this reason.
+  #        * `:invalid_key`: This occurs when trying to set a Web API key that
+  #           isn't valid, i.e. a 128 bit integer in a hexadecimal string.
+  #        * `:status_bad`: This is caused by a successful request that fails
+  #          for some Web API internal reason (e.g. an invalid argument).
+  #          Details about this failed request will be taken from `status_code`
+  #          and `status_message`.
+  #        * `:unauthorized`: This happens when a Steam Web API request is
+  #          rejected as unauthorized. This most likely means that you did not
+  #          specify a valid Web API key using {WebAPI.api_key=}. A Web API key
+  #          can be obtained from http://steamcommunity.com/dev/apikey.
   #
-  # Other undefined reasons will cause a generic error message.
+  #        Other undefined reasons will cause a generic error message.
+  # @param [Fixnum] status_code The HTTP status code returned by the Web API
+  # @param [String] status_message The status message returned in the response
   def initialize(cause, status_code = nil, status_message = '')
     case cause
       when :http_error then

data/lib/steam-condenser.rb

@@ -1,8 +1,14 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2009-2010, Sebastian Staudt
+# Copyright (c) 2009-2011, Sebastian Staudt
 
+# This module is used as a wrapper around Steam Condenser's classes
+#
+# It does not provide any own functionality, but this file is used as an entry
+# point when using the gem (i.e. +require 'steam-condenser').
+#
+# @author Sebastian Staudt
 module SteamCondenser
 
   require 'steam-condenser/community'

data/lib/steam-condenser/community.rb

@@ -1,12 +1,19 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2010, Sebastian Staudt
+# Copyright (c) 2010-2011, Sebastian Staudt
 
 module SteamCondenser
 
   require 'steam-condenser/version'
 
+  # This module is used as a wrapper around Steam Condenser's Steam Community
+  # classes
+  #
+  # It does not provide any own functionality, but this file is used to easily
+  # require classes to interact with the Steam Community
+  #
+  # @author Sebastian Staudt
   module Community
 
     require 'steam/community/steam_id'

data/lib/steam-condenser/servers.rb

@@ -1,12 +1,18 @@
 # This code is free software; you can redistribute it and/or modify it under the
 # terms of the new BSD License.
 #
-# Copyright (c) 2010, Sebastian Staudt
+# Copyright (c) 2010-2011, Sebastian Staudt
 
 module SteamCondenser
 
   require 'steam-condenser/version'
 
+  # This module is used as a wrapper around Steam Condenser's server classes
+  #
+  # It does not provide any own functionality, but this file is used to easily
+  # require classes to interact with servers
+  #
+  # @author Sebastian Staudt
   module Servers
 
     require 'steam/servers/goldsrc_server'

data/lib/steam-condenser/version.rb

@@ -5,6 +5,7 @@
 
 module SteamCondenser
 
-  VERSION = '0.13.1'
+  # The current version of Steam Condenser
+  VERSION = '0.14.0'
 
 end

data/lib/steam/community/cacheable.rb

@@ -10,8 +10,8 @@ module Cacheable
   def self.included(base) #:nodoc:
 
     base.extend ClassMethods
-    base.class_eval 'class_variable_set :@@cache, {}'
-    base.class_eval 'class_variable_set :@@cache_ids, {}'
+    base.send :class_variable_set, :@@cache, {}
+    base.send :class_variable_set, :@@cache_ids, []
 
     class << base
       alias_method :create, :new
@@ -67,8 +67,8 @@ module Cacheable
 
   # Saves this object in the cache
   def cache
-    cache     = self.class.class_eval 'class_variable_get :@@cache'
-    cache_ids = self.class.class_eval 'class_variable_get :@@cache_ids'
+    cache     = self.class.send :class_variable_get, :@@cache
+    cache_ids = self.class.send :class_variable_get, :@@cache_ids
 
     cache_ids.each do |cache_id|
       cache_id_value = instance_variable_get('@' + cache_id.to_s)

data/lib/steam/community/game_inventory.rb

@@ -0,0 +1,119 @@
+# 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/cacheable'
+require 'steam/community/game_item'
+require 'steam/community/web_api'
+
+# Provides basic functionality to represent an inventory of player in a game
+module GameInventory
+
+  attr_reader :items, :steam_id64
+
+  @@attribute_schema = {}
+
+  @@item_schema = {}
+
+  @@qualities = {}
+
+  @@schema_language = 'en'
+
+  # Sets the language the schema should be fetched in (default is: +'en'+)
+  def self.schema_language=(language)
+    @@schema_language = language
+  end
+
+  # Creates a new inventory object for the given AppID and SteamID64. This
+  # calls update to fetch the data and create the item instances contained in
+  # this players backpack
+  def initialize(steam_id64, fetch_now = true)
+    @steam_id64 = steam_id64
+
+    super fetch_now
+  end
+
+  # Returns the item at the given position in the inventory. The positions
+  # range from 1 to 100 instead of the usual array indices (0 to 99).
+  def [](index)
+    @items[index - 1]
+  end
+
+  # Returns the AppID of the game this inventory class belongs to
+  def app_id
+    self.class.send :class_variable_get, :@@app_id
+  end
+
+  # Returns the attribute schema
+  #
+  # The schemas are fetched first if not done already
+  def attribute_schema
+    update_schema unless @@attribute_schema.key? app_id
+
+    @@attribute_schema[app_id]
+  end
+
+  # Updates the contents of the inventory using Steam Web API
+  def fetch
+    result = WebApi.json!("IEconItems_#{app_id}", 'GetPlayerItems', 1, { :SteamID => @steam_id64 })
+    item_class = self.class.send :class_variable_get, :@@item_class
+
+    @items = []
+    result[:items].each do |item_data|
+      unless item_data.nil?
+        item = item_class.new(self, item_data)
+        @items[item.backpack_position - 1] = item
+      end
+    end
+  end
+
+  # Returns the item schema
+  #
+  # The schemas are fetched first if not done already
+  def item_schema
+    update_schema unless @@item_schema.key? app_id
+
+    @@item_schema[app_id]
+  end
+
+  # Returns the quality schema
+  #
+  # The schemas are fetched first if not done already
+  def qualities
+    update_schema unless @@qualities.key? app_id
+
+    @@qualities[app_id]
+  end
+
+  # Returns the number of items in the user's inventory
+  def size
+    @items.size
+  end
+
+  protected
+
+  # Updates the item schema (this includes attributes and qualities) using the
+  # +GetSchema+ method of interface +IEconItems_{AppID}+
+  def update_schema
+    params = {}
+    params[:language] = @@schema_language unless @@schema_language.nil?
+    result = WebApi.json!("IEconItems_#{app_id}", 'GetSchema', 1, params)
+
+    @@attribute_schema[app_id] = {}
+    result[:attributes].each do |attribute_data|
+      @@attribute_schema[app_id][attribute_data[:name]] = attribute_data
+    end
+
+    @@item_schema[app_id] = []
+    result[:items].each do |item_data|
+      @@item_schema[app_id][item_data[:defindex]] = item_data
+    end
+
+    @@qualities[app_id] = []
+    result[:qualities].each do |quality, id|
+      @@qualities[app_id][id] = quality
+    end
+  end
+
+end

data/lib/steam/community/game_item.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) 2011, Sebastian Staudt
+
+require 'steam/community/web_api'
+
+# Provides basic functionality to represent an item in a game
+module GameItem
+
+  attr_reader :attributes, :backpack_position, :class, :count, :defindex, :id,
+              :level, :name, :quality, :slot, :type
+
+  # Creates a new instance of a GameItem with the given data
+  def initialize(inventory, item_data)
+    @defindex          = item_data[:defindex]
+    @backpack_position = item_data[:inventory] & 0xffff
+    @class             = inventory.item_schema[@defindex][:item_class]
+    @count             = item_data[:quantity]
+    @id                = item_data[:id]
+    @level             = item_data[:level]
+    @name              = inventory.item_schema[@defindex][:item_name]
+    @quality           = inventory.qualities[item_data[:quality]]
+    @slot              = inventory.item_schema[@defindex][:item_slot]
+    @tradeable         = !(item_data[:flag_cannot_trade] == true)
+    @type              = inventory.item_schema[@defindex][:item_type_name]
+
+    unless inventory.item_schema[@defindex][:attributes].nil?
+      @attributes = inventory.item_schema[@defindex][:attributes]
+    end
+  end
+
+  # Returns whether this item is tradeable
+  def tradeable?
+    @tradeable
+  end
+
+end

data/lib/steam/community/game_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.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'open-uri'
 require 'rexml/document'
@@ -37,6 +37,9 @@ class GameStats
       when 'l4d2'
         require 'steam/community/l4d/l4d2_stats'
         L4D2Stats.new(steam_id)
+      when 'portal2'
+        require 'steam/community/portal2/portal2_stats'
+        Portal2Stats.new steam_id
       when 'tf2'
         require 'steam/community/tf2/tf2_stats'
         TF2Stats.new(steam_id)
@@ -58,9 +61,12 @@ class GameStats
     url = base_url + '?xml=all'
     @xml_data = REXML::Document.new(open(url, {:proxy => true}).read).root
 
+    error = @xml_data.elements['error']
+    raise SteamCondenserException.new(error.text) unless error.nil?
+
     @privacy_state = @xml_data.elements['privacyState'].text
     if public?
-      @app_id       = @xml_data.elements['game/gameLink'].text.match(/http:\/\/store.steampowered.com\/app\/([1-9][0-9]+)/)[1]
+      @app_id       = @xml_data.elements['game/gameLink'].text.match(/http:\/\/store.steampowered.com\/app\/([1-9][0-9]+)/)[1].to_i
       @custom_url   = @xml_data.elements['player/customURL'].text if @custom_url.nil?
       @game_name    = @xml_data.elements['game/gameName'].text
       @hours_played = @xml_data.elements['stats/hoursPlayed'].text unless @xml_data.elements['stats/hoursPlayed'].nil?