steam-condenser 1.2.0 → 1.2.1

data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_master_server_socket.rb

@@ -0,0 +1,42 @@
+# 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 'helper'
+require 'steam/sockets/master_server_socket'
+
+class TestMasterServerSocket < Test::Unit::TestCase
+
+  context 'A master server socket' do
+
+    setup do
+      @socket = MasterServerSocket.new '127.0.0.1'
+      @socket.instance_variable_set :@buffer, mock
+    end
+
+    should 'raise an error if the packet header is incorrect' do
+      @socket.stubs :receive_packet
+      @socket.instance_variable_get(:@buffer).expects(:long).returns 1
+
+      error = assert_raises PacketFormatError do
+        @socket.reply
+      end
+      assert_equal 'Master query response has wrong packet header.', error.message
+    end
+
+    should 'receive correct packets' do
+      @socket.expects(:receive_packet).with 1500
+      buffer = @socket.instance_variable_get :@buffer
+      buffer.expects(:long).returns 0xFFFFFFFF
+      buffer.expects(:get).returns 'test'
+
+      packet = mock
+      SteamPacketFactory.expects(:packet_from_data).with('test').returns packet
+
+      assert_equal packet, @socket.reply
+    end
+
+  end
+
+end

data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_rcon_socket.rb

@@ -0,0 +1,109 @@
+# 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 'helper'
+require 'steam/sockets/rcon_socket'
+
+class TestRCONSocket < Test::Unit::TestCase
+
+  context 'A new RCON socket' do
+
+    should 'know its IP and port, but not open a connection' do
+      socket = RCONSocket.new '127.0.0.1', 27015
+
+      assert_equal IPAddr.new('127.0.0.1'), socket.instance_variable_get(:@ip)
+      assert_equal 27015, socket.instance_variable_get(:@port)
+      assert_nil socket.instance_variable_get(:@socket)
+    end
+
+  end
+
+  context 'A disconnected RCON socket' do
+
+    setup do
+      @socket = RCONSocket.new '127.0.0.1', 27015
+    end
+
+    should 'establish the TCP connection when sending' do
+      tcp_socket = mock
+      tcp_socket.expects(:send).with 'test', 0
+      @socket.expects(:connect).with do
+        @socket.instance_variable_set :@socket, tcp_socket
+      end
+
+      @socket.send mock(:to_s => 'test')
+    end
+
+    should 're-establish the TCP connection when sending' do
+      tcp_socket = mock
+      tcp_socket.expects(:closed?).returns true
+      tcp_socket.expects(:send).with 'test', 0
+      @socket.expects :connect
+      @socket.instance_variable_set :@socket, tcp_socket
+
+      packet = mock
+      packet.expects(:to_s).returns 'test'
+      @socket.send packet
+    end
+
+    should 'be able to establish the TCP connection' do
+      tcp_socket = mock
+      TCPSocket.expects(:new).with('127.0.0.1', 27015).
+        returns tcp_socket
+
+      @socket.connect
+
+      assert_equal tcp_socket, @socket.instance_variable_get(:@socket)
+    end
+
+    should 'raise a timeout if the connection cannot be established' do
+      @socket.expects(:timeout).raises Timeout::Error
+
+      assert_raises SteamCondenser::TimeoutError do
+        @socket.connect
+      end
+    end
+
+  end
+
+  context 'A connected RCON socket' do
+
+    setup do
+      @socket = RCONSocket.new '127.0.0.1', 27015
+      @tcp_socket = mock
+      @socket.instance_variable_set :@socket, @tcp_socket
+    end
+
+    should 'be able to close the TCP connection' do
+      @tcp_socket.expects :close
+
+      @socket.close
+    end
+
+    should 'receive responses using the TCP connection' do
+      buffer = mock
+      @socket.instance_variable_set :@buffer, buffer
+
+      buffer.expects(:long).returns 1234
+      buffer.expects(:get).twice.returns('test ').returns 'test'
+      @socket.expects(:receive_packet).with(4).returns 1
+      @socket.expects(:receive_packet).with(1234).returns 1000
+      @socket.expects(:receive_packet).with(234).returns 234
+      RCONPacketFactory.expects(:packet_from_data).with 'test test'
+
+      @socket.reply
+    end
+
+    should 'raise an error if the client has been banned' do
+      @socket.expects(:receive_packet).with(4).returns 0
+
+      assert_raises RCONBanError do
+        @socket.reply
+      end
+    end
+
+  end
+
+end

data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_source_socket.rb

@@ -0,0 +1,77 @@
+# 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 'helper'
+require 'steam/sockets/source_socket'
+
+class TestSourceSocket < Test::Unit::TestCase
+
+  context 'A Source socket' do
+
+    setup do
+      @socket = SourceSocket.new '127.0.0.1'
+    end
+
+    should 'be able to receive single packet replies' do
+      buffer = mock
+      @socket.instance_variable_set :@buffer, buffer
+
+      @socket.expects(:receive_packet).with 1400
+      data = mock
+      buffer.expects(:long).returns 0xFFFFFFFF
+      buffer.expects(:get).returns data
+      packet = mock
+      SteamPacketFactory.expects(:packet_from_data).with(data).returns packet
+
+      assert_equal packet, @socket.reply
+    end
+
+    should 'be able to receive split packet replies' do
+      buffer = mock
+      @socket.instance_variable_set :@buffer, buffer
+
+      @socket.expects(:receive_packet).with(1400)
+      @socket.expects(:receive_packet).with().returns 1400
+
+      data1, data2 = mock, mock
+      buffer.expects(:long).times(4).returns(0xFFFFFFFE).returns(1234).
+        returns(0xFFFFFFFE).returns 1234
+      buffer.expects(:byte).times(4).returns(0x02).returns(0x00).returns(0x02).
+        returns 0x01
+      buffer.expects(:short).twice
+      buffer.expects(:get).twice.returns(data1).returns(data2)
+
+      packet = mock
+      SteamPacketFactory.expects(:reassemble_packet).with([data1, data2]).
+        returns packet
+
+      assert_equal packet, @socket.reply
+    end
+
+    should 'be able to receive compressed replies' do
+      buffer = mock
+      @socket.instance_variable_set :@buffer, buffer
+
+      @socket.expects(:receive_packet).with(1400)
+      @socket.expects(:receive_packet).with().returns 1400
+
+      data1, data2 = mock, mock
+      buffer.expects(:long).times(8).returns(0xFFFFFFFE).returns(2147484882).
+        returns(0).returns(1337).returns(0xFFFFFFFE).returns(2147484882).
+        returns(0).returns 1337
+      buffer.expects(:byte).times(4).returns(0x02).returns(0x00).returns(0x02).
+        returns 0x01
+      buffer.expects(:get).twice.returns(data1).returns(data2)
+
+      packet = mock
+      SteamPacketFactory.expects(:reassemble_packet).
+        with([data1, data2], true, 1337).returns packet
+
+      assert_equal packet, @socket.reply
+    end
+
+  end
+
+end

data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_steam_socket.rb

@@ -0,0 +1,97 @@
+# 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 'helper'
+require 'steam/sockets/steam_socket'
+
+class TestSteamSocket < Test::Unit::TestCase
+
+  class GenericSteamSocket
+    include SteamSocket
+  end
+
+  context 'The user timeout of a socket' do
+
+    should 'be able to change the timeout of a socket' do
+      SteamSocket.timeout = 2000
+
+      assert_equal 2000, SteamSocket.send(:class_variable_get, :@@timeout)
+    end
+
+  end
+
+  context 'A new socket' do
+
+    should 'create and connect an UDP socket' do
+      socket = mock
+      socket.expects(:connect).with '127.0.0.1', 27015
+      UDPSocket.expects(:new).returns socket
+
+      GenericSteamSocket.new '127.0.0.1'
+    end
+
+  end
+
+  context 'A socket' do
+
+    setup do
+      @udp_socket = mock
+      @udp_socket.stubs(:connect).with '127.0.0.1', 27015
+      UDPSocket.stubs(:new).returns @udp_socket
+
+      @socket = GenericSteamSocket.new '127.0.0.1'
+    end
+
+    should 'close the UDP socket if it is closed' do
+      @udp_socket.expects :close
+
+      @socket.close
+    end
+
+    should 'send packet data using the UDP socket' do
+      packet = mock
+      packet.expects(:to_s).returns 'test'
+      @udp_socket.expects(:send).with 'test', 0
+
+      @socket.send packet
+    end
+
+    should 'raise a timeout if no reply is received' do
+      @socket.expects(:select).with([@udp_socket], nil, nil, 1).returns nil
+
+      assert_raises SteamCondenser::TimeoutError do
+        @socket.receive_packet
+      end
+    end
+
+    should 'receive a packet into a new buffer' do
+      @socket.expects(:select).with([@udp_socket], nil, nil, 1).returns true
+      @udp_socket.expects(:recv).with(4).returns 'test'
+
+      assert_equal 4, @socket.receive_packet(4)
+
+      buffer = @socket.instance_variable_get :@buffer
+      assert_equal 0, buffer.pos
+      assert_equal 4, buffer.size
+      assert_equal 'test', buffer.string
+    end
+
+    should 'receive a packet into an existing buffer' do
+      @socket.instance_variable_set :@buffer, StringIO.alloc(10)
+
+      @socket.expects(:select).with([@udp_socket], nil, nil, 1).returns true
+      @udp_socket.expects(:recv).with(10).returns 'test'
+
+      assert_equal 4, @socket.receive_packet
+
+      buffer = @socket.instance_variable_get :@buffer
+      assert_equal 0, buffer.pos
+      assert_equal 4, buffer.size
+      assert_equal 'test', buffer.string
+    end
+
+  end
+
+end

data/steam-condenser.gemspec

@@ -12,12 +12,12 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'bzip2-ruby', '~> 0.2.7'
   s.add_dependency 'multi_json', '~> 1.3.1'
-  s.add_dependency 'multi_xml', '~> 0.4.1'
+  s.add_dependency 'multi_xml', '~> 0.5.1'
 
-  s.add_development_dependency 'mocha', '~> 0.11.1'
+  s.add_development_dependency 'mocha', '~> 0.12.0'
   s.add_development_dependency 'rake', '~> 0.9.2'
   s.add_development_dependency 'shoulda-context', '~> 1.0.0'
-  s.add_development_dependency 'yard', '~> 0.7.2'
+  s.add_development_dependency 'yard', '~> 0.8.0'
 
   s.files              = Dir.glob '**/*'
   s.test_files         = Dir.glob 'test/**/*'

data/test/steam/communtiy/test_cacheable.rb

@@ -0,0 +1,100 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2012, Sebastian Staudt
+
+require 'helper'
+require 'steam/community/cacheable'
+
+class TestCacheable < Test::Unit::TestCase
+
+  class SingleCacheable
+    include Cacheable
+    cacheable_with_ids :first_id, :second_id
+
+    def initialize
+      @first_id, @second_id = 1, '2'
+    end
+
+    def fetch
+    end
+  end
+
+  class CompoundCacheable
+    include Cacheable
+    cacheable_with_ids [:first_id, :second_id]
+
+    def initialize
+      @first_id, @second_id = 1, '2'
+    end
+
+    def fetch
+    end
+  end
+
+  context 'A cacheable' do
+
+    should 'know if it was fetched already' do
+      item = SingleCacheable.new false
+      assert_not item.fetched?
+      item.fetch
+      assert item.fetched?
+    end
+
+    should 'automatically update its last update time' do
+      item = SingleCacheable.new false
+      now1 = Time.now
+      item.fetch
+      assert item.fetch_time > now1
+      now2 = Time.now
+      item.fetch
+      assert item.fetch_time > now2
+    end
+
+    should 'load new instances of the same item from cache' do
+      item1 = SingleCacheable.new
+      item2 = SingleCacheable.new
+      assert_equal item1, item2
+    end
+
+    should 'be able to bypass the cache if requested' do
+      item1 = SingleCacheable.new
+      item2 = SingleCacheable.new true, true
+
+      assert item2.fetch_time > item1.fetch_time
+      assert_not_equal item1, item2
+    end
+
+    teardown do
+      SingleCacheable.clear_cache
+      CompoundCacheable.clear_cache
+    end
+
+  end
+
+  context 'A cacheable with one or more single IDs' do
+
+    should 'be cached once for each ID' do
+      item = SingleCacheable.new
+      cache = SingleCacheable.send :class_variable_get, :@@cache
+
+      assert_equal item, cache[1]
+      assert_equal item, cache['2']
+      assert_equal 2, cache.size
+    end
+
+  end
+
+  context 'A cacheable with compound IDs' do
+
+    should 'be cached once for each compound ID' do
+      item = CompoundCacheable.new
+      cache = CompoundCacheable.send :class_variable_get, :@@cache
+
+      assert_equal item, cache[[1, '2']]
+      assert_equal 1, cache.size
+    end
+
+  end
+
+end