steam-condenser 1.3.0 → 1.3.1

data/README.md

@@ -41,6 +41,7 @@ included LICENSE file.
 * Mike Połtyn – mike(at)railslove.com
 * Sam Kinard – snkinard(at)gmail.com
 * "withgod" – noname(at)withgod.jp
+* John Amicangelo - amicangelo.j(at)husky.neu.edu
 
 ## See Also
 

data/lib/steam-condenser/version.rb

@@ -1,11 +1,11 @@
 # This code is free software; you can redistribute it and/or modify it under
 # the terms of the new BSD License.
 #
-# Copyright (c) 2010-2012, Sebastian Staudt
+# Copyright (c) 2010-2013, Sebastian Staudt
 
 module SteamCondenser
 
   # The current version of Steam Condenser
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 
 end

data/lib/steam/community/cacheable.rb

@@ -96,7 +96,8 @@ module Cacheable
       bypass_cache = args.size > arity + 1 ? !!args.pop : false
       fetch = args.size > arity ? !!args.pop : true
 
-      object = super *args
+      object = self.allocate
+      object.send :initialize, *args
       cached_object = object.send :cached_instance
       object = cached_object unless cached_object.nil? || bypass_cache
 

data/lib/steam/community/game_inventory.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-2012, Sebastian Staudt
+# Copyright (c) 2011-2013, Sebastian Staudt
 
 require 'steam/community/cacheable'
 require 'steam/community/game_item'
@@ -36,6 +36,11 @@ class GameInventory
   # @return [Array<GameItem>] All items in the backpack
   attr_reader :items
 
+  # Returns an array of all items that this player just found or traded
+  #
+  # @return [Array<GameItem>] All preliminary items of the inventory
+  attr_reader :preliminary_items
+
   # Returns the Steam ID of the player owning this inventory
   #
   # @return [SteamId] The Steam ID of the owner of this inventory
@@ -55,9 +60,11 @@ class GameInventory
   # @return [GameInventory] The inventory for the given user and game
   # @raise [SteamCondenserException] if creating the inventory fails
   # @macro cacheable
-  def self.new(app_id, steam_id, *args)
-    args = args.unshift steam_id
-    if self != GameInventory
+  def self.new(app_id, steam_id = nil, *args)
+    args = args.unshift steam_id unless steam_id.nil?
+    if self == GameInventory
+      raise ArgumentError, 'wrong number of arguments (1 for 2)' if args.empty?
+    else
       args = args.unshift app_id
       app_id = self::APP_ID
     end
@@ -125,10 +132,15 @@ class GameInventory
     item_class = self.class.send :class_variable_get, :@@item_class
 
     @items = []
+    @preliminary_items = []
     result[:items].each do |item_data|
       unless item_data.nil?
         item = item_class.new(self, item_data)
-        @items[item.backpack_position - 1] = item
+        if item.preliminary?
+          @preliminary_items << item
+        else
+          @items[item.backpack_position - 1] = item
+        end
       end
     end
   end

data/lib/steam/community/game_item.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-2012, Sebastian Staudt
+# Copyright (c) 2011-2013, Sebastian Staudt
 
 require 'steam/community/web_api'
 
@@ -99,6 +99,7 @@ module GameItem
     @name              = schema_data[:item_name]
     @origin            = inventory.item_schema.origins[item_data[:origin]]
     @original_id       = item_data[:original_id]
+    @preliminary       = item_data[:inventory] & 0x40000000 != 0
     @quality           = inventory.item_schema.qualities[item_data[:quality]]
     @tradeable         = !!item_data[:flag_cannot_trade]
     @type              = schema_data[:item_type_name]
@@ -125,6 +126,16 @@ module GameItem
     @craftable
   end
 
+  # Returns whether this item is preliminary
+  #
+  # Preliminary means that this item was just found or traded and has not yet
+  # been added to the inventory
+  #
+  # @return [Boolean] `true` if this item is preliminary
+  def preliminary?
+    @preliminary
+  end
+
   # Returns the data for this item that's defined in the item schema
   #
   # @return [Hash<Symbol, Object>] The schema data for this item

data/lib/steam/community/steam_id.rb

@@ -312,8 +312,8 @@ class SteamId
   # @see #friends
   # @see #initialize
   def fetch_friends
-    @friends = []
     friends_data = parse "#{base_url}/friends?xml=1"
+    @friends = []
     friends_data['friends']['friend'].each do |friend|
       @friends << SteamId.new(friend.to_i, false)
     end
@@ -327,9 +327,9 @@ class SteamId
   #
   # @see #games
   def fetch_games
+    games_data = parse "#{base_url}/games?xml=1"
     @games     = {}
     @playtimes = {}
-    games_data = parse "#{base_url}/games?xml=1"
     games_data['games']['game'].each do |game_data|
       app_id = game_data['appID'].to_i
       game = SteamGame.new app_id, game_data

data/lib/steam/servers/source_server.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) 2008-2011, Sebastian Staudt
+# Copyright (c) 2008-2013, Sebastian Staudt
 
 require 'errors/rcon_no_auth_error'
 require 'steam/packets/rcon/rcon_auth_request'
@@ -72,7 +72,7 @@ class SourceServer
     @rcon_request_id = rand 2**16
 
     @rcon_socket.send RCONAuthRequest.new(@rcon_request_id, password)
-    return rcon_auth(password) if @rcon_socket.reply.nil?
+    @rcon_socket.reply
     reply = @rcon_socket.reply
 
     @rcon_authenticated = reply.request_id == @rcon_request_id
@@ -82,6 +82,9 @@ class SourceServer
   #
   # @param [String] command The command to execute on the server via RCON
   # @return [String] The output of the executed command
+  # @raise [RCONBanException] if the IP of the local machine has been banned on
+  #        the game server
+  # @raise [RCONNoAuthException] if not authenticated with the server
   # @see #rcon_auth
   def rcon_exec(command)
     raise RCONNoAuthError unless @rcon_authenticated
@@ -91,13 +94,19 @@ class SourceServer
 
     response = []
     begin
-      response_packet = @rcon_socket.reply
-      if response_packet.nil?
-        @rcon_authenticated = false
-        break
-      elsif response_packet.is_a?(RCONAuthResponse)
-        @rcon_authenticated = false
-        raise RCONNoAuthError
+      begin
+        response_packet = @rcon_socket.reply
+        if response_packet.is_a? RCONAuthResponse
+          @rcon_authenticated = false
+          raise RCONNoAuthError
+        end
+      rescue RCONBanError
+        if @rcon_authenticated
+          @rcon_authenticated = false
+          raise RCONNoAuthError
+        end
+
+        raise $!
       end
       response << response_packet.response
     end while response.size < 3 || response_packet.response.size > 0

data/lib/steam/sockets/rcon_socket.rb

@@ -1,13 +1,14 @@
 # This code is free software; you can redistribute it and/or modify it under
 # the terms of the new BSD License.
 #
-# Copyright (c) 2008-2012, Sebastian Staudt
+# Copyright (c) 2008-2013, Sebastian Staudt
 
 require 'ipaddr'
 require 'socket'
 require 'timeout'
 
 require 'errors/rcon_ban_error'
+require 'errors/rcon_no_auth_error'
 require 'errors/timeout_error'
 require 'steam/packets/rcon/rcon_packet'
 require 'steam/packets/rcon/rcon_packet_factory'
@@ -74,11 +75,17 @@ class RCONSocket
   #
   # @raise [RCONBanError] if the IP of the local machine has been banned on the
   #        game server
+  # @raise [RCONNoAuthException] if an authenticated connection has been
+  #        dropped by the server
   # @return [RCONPacket] The packet replied from the server
   def reply
-    if receive_packet(4) == 0
-      @socket.close
-      return nil
+    begin
+      if receive_packet(4) == 0
+        @socket.close
+        raise RCONNoAuthError
+      end
+    rescue Errno::ECONNRESET
+      raise RCONBanError
     end
 
     remaining_bytes = @buffer.long

data/lib/steam/sockets/steam_socket.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) 2008-2011, Sebastian Staudt
+# Copyright (c) 2008-2013, Sebastian Staudt
 
 require 'ipaddr'
 require 'socket'
@@ -65,7 +65,8 @@ module SteamSocket
     begin
       data = @socket.recv @buffer.remaining
     rescue Errno::ECONNRESET
-      return 0
+      @socket.close
+      raise $!
     end
     bytes_read = @buffer.write data
     @buffer.truncate bytes_read

data/test/steam/community/test_steam_id.rb

@@ -123,6 +123,17 @@ class TestSteamId < Test::Unit::TestCase
       end
       assert_equal 'XML data could not be parsed.', error.message
     end
+    
+    should 'not cache an empty hash when an error is encountered on steam' do
+      SteamId.any_instance.expects(:parse).raises(OpenURI::HTTPError.new('', nil))
+      steam_id = SteamId.new(76561197983311154, false)
+      
+      assert_raises OpenURI::HTTPError do
+        steam_id.games
+      end
+      
+      assert_equal(nil, steam_id.instance_variable_get("@games"))
+    end
 
     teardown do
       SteamId.clear_cache

data/test/steam/sockets/test_rcon_socket.rb

@@ -96,12 +96,21 @@ class TestRCONSocket < Test::Unit::TestCase
       @socket.reply
     end
 
-    should 'raise an error if the client has been banned' do
+    should 'raise an RCONBanError if the client has been banned' do
+      @socket.expects(:receive_packet).with(4).raises Errno::ECONNRESET
+
+      assert_raise RCONBanError do
+        assert_nil @socket.reply
+      end
+    end
+
+    should 'raise an RCONNoAuthError if the connection has been dropped' do
       @socket.expects(:receive_packet).with(4).returns 0
       @tcp_socket.expects :close
 
-      assert_nil @socket.reply
-      assert_nil @socket.instance_variable_get(:@tcp_socket)
+      assert_raise RCONNoAuthError do
+        assert_nil @socket.reply
+      end
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: steam-condenser
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-29 00:00:00.000000000 Z
+date: 2013-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bzip2-ruby