sappho-socket 0.1.1 → 0.1.2

data/lib/sappho-socket/connected_socket.rb

@@ -1,40 +1,40 @@
-# See https://github.com/sappho/sappho-socket/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
-# Copyright 2012 Andrew Heald.
-
-module Sappho
-  module Socket
-
-    require 'socket'
-
-    class ConnectedSocket
-
-      def attach socket
-        @socket = socket
-      end
-
-      def open host, port
-        @socket = TCPSocket.new host, port
-      end
-
-      def read bytesNeeded
-        @socket.read bytesNeeded
-      end
-
-      def write str
-        @socket.write str
-      end
-
-      def settle seconds
-        sleep seconds
-      end
-
-      def close
-        @socket.close
-      end
-
-    end
-
-  end
-end
+# See https://github.com/sappho/sappho-socket/wiki for project documentation.
+# This software is licensed under the GNU Affero General Public License, version 3.
+# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# Copyright 2012 Andrew Heald.
+
+module Sappho
+  module Socket
+
+    require 'socket'
+
+    class ConnectedSocket
+
+      def attach socket
+        @socket = socket
+      end
+
+      def open host, port
+        @socket = TCPSocket.new host, port
+      end
+
+      def read bytesNeeded
+        @socket.read bytesNeeded
+      end
+
+      def write str
+        @socket.write str
+      end
+
+      def settle seconds
+        sleep seconds
+      end
+
+      def close
+        @socket.close
+      end
+
+    end
+
+  end
+end

data/lib/sappho-socket/mock_socket.rb

@@ -1,148 +1,148 @@
-# See https://github.com/sappho/sappho-socket/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
-# Copyright 2012 Andrew Heald.
-
-module Sappho
-  module Socket
-
-    class MockSocket
-
-      def MockSocket.session session
-        @@session = session
-      end
-
-      def attach socket
-        @@session.action :attach, socket
-      end
-
-      def open host, port
-        @@session.action :open, host, port
-      end
-
-      def read bytesNeeded
-        @@session.action :read, bytesNeeded
-      end
-
-      def write str
-        @@session.action :write, str
-      end
-
-      def settle seconds
-        @@session.action :settle, seconds
-      end
-
-      def close
-        @@session.action :close
-      end
-
-    end
-
-    class MockSocketSession
-
-      def initialize activities
-        @activities = activities
-        @index = -1
-      end
-
-      def action expectedActivityType, *parameters
-        activity = @activities[@index += 1]
-        activityType = activity[:type]
-        unless activityType == expectedActivityType
-          raise MockSocketSessionError,
-                "Expected #{activityType} call but code under test asked for #{expectedActivityType}"
-        end
-        activity[:action].action *parameters
-      end
-
-    end
-
-    class MockSocketAttach
-
-      def action socket
-        raise MockSocketSessionError, 'Nil socket supplied' unless socket
-      end
-
-    end
-
-    class MockSocketOpen
-
-      def initialize host, port
-        @host = host
-        @port = port
-      end
-
-      def action host, port
-        unless host == @host and port == @port
-          raise MockSocketSessionError,
-                "Expected connection to #{@host}:#{@port} but got #{host}:#{port}"
-        end
-      end
-
-    end
-
-    class MockSocketRead
-
-      def initialize str
-        @str = str
-      end
-
-      def action bytesNeeded
-        unless bytesNeeded >= @str.length
-          raise MockSocketSessionError,
-                "Expected read of #{@str.length} bytes but got request for #{bytesNeeded}"
-        end
-        raise Timeout::Error if bytesNeeded > @str.length
-        @str
-      end
-
-    end
-
-    class MockSocketWrite
-
-      def initialize str
-        @str = str
-      end
-
-      def action str
-        raise MockSocketSessionError, 'Unexpected string on write' unless str == @str
-      end
-
-    end
-
-    class MockSocketSettle
-
-      def initialize seconds
-        @seconds = seconds
-      end
-
-      def action seconds
-        unless seconds == @seconds
-          raise MockSocketSessionError,
-                "Expected settle sleep of #{@seconds} seconds but got request for #{seconds}"
-        end
-      end
-
-    end
-
-    class MockSocketClose
-
-      def action
-      end
-
-    end
-
-    class MockSocketTimeout
-
-      def action *parameters
-        # ignore parameters - this can be used for any action
-        raise Timeout::Error
-      end
-
-    end
-
-    class MockSocketSessionError < RuntimeError
-    end
-
-  end
-end
+# See https://github.com/sappho/sappho-socket/wiki for project documentation.
+# This software is licensed under the GNU Affero General Public License, version 3.
+# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# Copyright 2012 Andrew Heald.
+
+module Sappho
+  module Socket
+
+    class MockSocket
+
+      def MockSocket.session session
+        @@session = session
+      end
+
+      def attach socket
+        @@session.action :attach, socket
+      end
+
+      def open host, port
+        @@session.action :open, host, port
+      end
+
+      def read bytesNeeded
+        @@session.action :read, bytesNeeded
+      end
+
+      def write str
+        @@session.action :write, str
+      end
+
+      def settle seconds
+        @@session.action :settle, seconds
+      end
+
+      def close
+        @@session.action :close
+      end
+
+    end
+
+    class MockSocketSession
+
+      def initialize activities
+        @activities = activities
+        @index = -1
+      end
+
+      def action expectedActivityType, *parameters
+        activity = @activities[@index += 1]
+        activityType = activity[:type]
+        unless activityType == expectedActivityType
+          raise MockSocketSessionError,
+                "Expected #{activityType} call but code under test asked for #{expectedActivityType}"
+        end
+        activity[:action].action *parameters
+      end
+
+    end
+
+    class MockSocketAttach
+
+      def action socket
+        raise MockSocketSessionError, 'Nil socket supplied' unless socket
+      end
+
+    end
+
+    class MockSocketOpen
+
+      def initialize host, port
+        @host = host
+        @port = port
+      end
+
+      def action host, port
+        unless host == @host and port == @port
+          raise MockSocketSessionError,
+                "Expected connection to #{@host}:#{@port} but got #{host}:#{port}"
+        end
+      end
+
+    end
+
+    class MockSocketRead
+
+      def initialize str
+        @str = str
+      end
+
+      def action bytesNeeded
+        unless bytesNeeded >= @str.length
+          raise MockSocketSessionError,
+                "Expected read of #{@str.length} bytes but got request for #{bytesNeeded}"
+        end
+        raise Timeout::Error if bytesNeeded > @str.length
+        @str
+      end
+
+    end
+
+    class MockSocketWrite
+
+      def initialize str
+        @str = str
+      end
+
+      def action str
+        raise MockSocketSessionError, 'Unexpected string on write' unless str == @str
+      end
+
+    end
+
+    class MockSocketSettle
+
+      def initialize seconds
+        @seconds = seconds
+      end
+
+      def action seconds
+        unless seconds == @seconds
+          raise MockSocketSessionError,
+                "Expected settle sleep of #{@seconds} seconds but got request for #{seconds}"
+        end
+      end
+
+    end
+
+    class MockSocketClose
+
+      def action
+      end
+
+    end
+
+    class MockSocketTimeout
+
+      def action *parameters
+        # ignore parameters - this can be used for any action
+        raise Timeout::Error
+      end
+
+    end
+
+    class MockSocketSessionError < RuntimeError
+    end
+
+  end
+end

data/lib/sappho-socket/safe_server.rb

@@ -1,76 +1,77 @@
-# See https://github.com/sappho/sappho-socket/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
-# Copyright 2012 Andrew Heald.
-
-module Sappho
-  module Socket
-
-    require 'sappho-basics/auto_flush_log'
-    require 'thread'
-    require 'socket'
-
-    class SafeServer
-
-      def initialize name, port, maxClients = 10
-        @name = name
-        @port = port
-        @maxClients = maxClients
-        @clients = {}
-        @mutex = Mutex.new
-        @log = Sappho::ApplicationAutoFlushLog.instance
-      end
-
-      def serve
-        Thread.new do
-          begin
-            @log.info "opening #{@name} server port #{@port}"
-            @server = TCPServer.open @port
-            @log.info "#{@name} server port #{@port} is now open"
-            clientCount = 0
-            loop do
-              @mutex.synchronize do
-                clientCount = @clients.size
-              end
-              if clientCount >= @maxClients
-                sleep 1
-              else
-                @log.info "listening for new clients on #{@name} server port #{@port}"
-                client = @server.accept
-                ip = client.getpeername
-                ip = (4 ... 8).map{|pos|ip[pos]}.join('.')
-                @mutex.synchronize do
-                  @clients[client] = ip
-                  log ip, 'connected'
-                end
-                Thread.new client, ip do | client, ip |
-                  socket = SafeSocket.new 30
-                  socket.attach client
-                  begin
-                    yield socket, ip, @name, @port
-                  rescue => error
-                    @log.error error
-                  end
-                  socket.close
-                  @mutex.synchronize do
-                    @clients.delete client
-                    log ip, 'disconnected'
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-
-      private
-
-      def log ip, status
-        @log.info "client #{ip} #{status}"
-        @log.info "clients: #{@clients.size > 0 ? (@clients.collect{|client, ip| ip}).join(', ') : 'none'}"
-      end
-
-    end
-
-  end
-end
+# See https://github.com/sappho/sappho-socket/wiki for project documentation.
+# This software is licensed under the GNU Affero General Public License, version 3.
+# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# Copyright 2012 Andrew Heald.
+
+module Sappho
+  module Socket
+
+    require 'sappho-basics/auto_flush_log'
+    require 'thread'
+    require 'socket'
+
+    class SafeServer
+
+      def initialize name, port, maxClients = 10, detailedLogging = false
+        @name = name
+        @port = port
+        @maxClients = maxClients
+        @detailedLogging = detailedLogging
+        @clients = {}
+        @mutex = Mutex.new
+        @log = Sappho::ApplicationAutoFlushLog.instance
+      end
+
+      def serve
+        Thread.new do
+          begin
+            @log.info "opening #{@name} server port #{@port}"
+            @server = TCPServer.open @port
+            @log.info "#{@name} server port #{@port} is now open"
+            clientCount = 0
+            loop do
+              @mutex.synchronize do
+                clientCount = @clients.size
+              end
+              if clientCount >= @maxClients
+                sleep 1
+              else
+                @log.info "listening for new clients on #{@name} server port #{@port}" if @detailedLogging
+                client = @server.accept
+                ip = client.getpeername
+                ip = (4 ... 8).map{|pos|ip[pos]}.join('.')
+                @mutex.synchronize do
+                  @clients[client] = ip
+                  log ip, 'connected' if @detailedLogging
+                end
+                Thread.new client, ip do | client, ip |
+                  socket = SafeSocket.new 30
+                  socket.attach client
+                  begin
+                    yield socket, ip, @name, @port
+                  rescue => error
+                    @log.error error
+                  end
+                  socket.close
+                  @mutex.synchronize do
+                    @clients.delete client
+                    log ip, 'disconnected' if @detailedLogging
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      def log ip, status
+        @log.info "client #{ip} #{status}"
+        @log.info "clients: #{@clients.size > 0 ? (@clients.collect{|client, ip| ip}).join(', ') : 'none'}"
+      end
+
+    end
+
+  end
+end

data/lib/sappho-socket/safe_socket.rb

@@ -1,88 +1,88 @@
-# See https://github.com/sappho/sappho-socket/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
-# Copyright 2012 Andrew Heald.
-
-module Sappho
-  module Socket
-
-    require 'timeout'
-    require 'socket'
-    require 'sappho-socket/connected_socket'
-
-    class SafeSocket
-
-      def SafeSocket.mock session, timeout = 10
-        MockSocket.session session
-        SafeSocket.new timeout, MockSocket.new
-      end
-
-      def initialize timeout = 10, socket = ConnectedSocket.new
-        @socket = socket
-        @open = false
-        @timeout = timeout
-      end
-
-      def attach socket
-        @socket.attach socket
-        @open = true
-      end
-
-      def open host, port
-        timeout @timeout do
-          @socket.open host, port
-          @open = true
-        end
-      end
-
-      def setTimeout timeout
-        @timeout = timeout
-      end
-
-      def read bytesNeeded
-        check
-        timeout @timeout do
-          @socket.read bytesNeeded
-        end
-      end
-
-      def write str
-        check
-        timeout @timeout do
-          @socket.write str
-        end
-      end
-
-      def settle seconds
-        @socket.settle seconds
-      end
-
-      def close
-        actuallyClosed = false
-        begin
-          timeout @timeout do
-            if @open
-              @socket.close
-              actuallyClosed = true
-            end
-          end
-        rescue
-        end
-        @open = false
-        actuallyClosed
-      end
-
-      def open?
-        @open
-      end
-
-      private
-
-      def check
-        raise SocketError, 'Attempt to access unopened TCP/IP socket' unless @open
-      end
-
-    end
-
-  end
-end
+# See https://github.com/sappho/sappho-socket/wiki for project documentation.
+# This software is licensed under the GNU Affero General Public License, version 3.
+# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# Copyright 2012 Andrew Heald.
+
+module Sappho
+  module Socket
+
+    require 'timeout'
+    require 'socket'
+    require 'sappho-socket/connected_socket'
+
+    class SafeSocket
+
+      def SafeSocket.mock session, timeout = 10
+        MockSocket.session session
+        SafeSocket.new timeout, MockSocket.new
+      end
+
+      def initialize timeout = 10, socket = ConnectedSocket.new
+        @socket = socket
+        @open = false
+        @timeout = timeout
+      end
+
+      def attach socket
+        @socket.attach socket
+        @open = true
+      end
+
+      def open host, port
+        timeout @timeout do
+          @socket.open host, port
+          @open = true
+        end
+      end
+
+      def setTimeout timeout
+        @timeout = timeout
+      end
+
+      def read bytesNeeded
+        check
+        timeout @timeout do
+          @socket.read bytesNeeded
+        end
+      end
+
+      def write str
+        check
+        timeout @timeout do
+          @socket.write str
+        end
+      end
+
+      def settle seconds
+        @socket.settle seconds
+      end
+
+      def close
+        actuallyClosed = false
+        begin
+          timeout @timeout do
+            if @open
+              @socket.close
+              actuallyClosed = true
+            end
+          end
+        rescue
+        end
+        @open = false
+        actuallyClosed
+      end
+
+      def open?
+        @open
+      end
+
+      private
+
+      def check
+        raise SocketError, 'Attempt to access unopened TCP/IP socket' unless @open
+      end
+
+    end
+
+  end
+end

data/lib/sappho-socket/version.rb

@@ -1,16 +1,16 @@
-# See https://github.com/sappho/sappho-socket/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
-# Copyright 2012 Andrew Heald.
-
-module Sappho
-  module Socket
-    NAME = 'sappho-socket'
-    VERSION = '0.1.1'
-    AUTHORS = ['Andrew Heald']
-    EMAILS = ['andrew@heald.co.uk']
-    HOMEPAGE = 'https://github.com/sappho/sappho-socket/wiki'
-    SUMMARY = 'Provides a usable TCP socket and mock implementation for testing'
-    DESCRIPTION = 'See the project home page for more information'
-  end
-end
+# See https://github.com/sappho/sappho-socket/wiki for project documentation.
+# This software is licensed under the GNU Affero General Public License, version 3.
+# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# Copyright 2012 Andrew Heald.
+
+module Sappho
+  module Socket
+    NAME = 'sappho-socket'
+    VERSION = '0.1.2'
+    AUTHORS = ['Andrew Heald']
+    EMAILS = ['andrew@heald.co.uk']
+    HOMEPAGE = 'https://github.com/sappho/sappho-socket/wiki'
+    SUMMARY = 'Provides a usable TCP socket and mock implementation for testing'
+    DESCRIPTION = 'See the project home page for more information'
+  end
+end

data/test/ruby/socket_test.rb

@@ -1,80 +1,80 @@
-# See https://github.com/sappho/sappho-socket/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
-# Copyright 2012 Andrew Heald.
-
-require "test/unit"
-require 'sappho-socket/safe_socket'
-require 'sappho-socket/mock_socket'
-
-module Sappho
-  module Socket
-
-    class SocketTest < Test::Unit::TestCase
-
-      def test_session
-        @socket = SafeSocket.mock MockSocketSession.new [
-          { :type => :open, :action => MockSocketOpen.new('localhost', 80) },
-          { :type => :settle, :action => MockSocketSettle.new(42) },
-          { :type => :read, :action => MockSocketRead.new('login: ') },
-          { :type => :write, :action => MockSocketWrite.new('anon') },
-          { :type => :write, :action => MockSocketTimeout.new },
-          { :type => :close, :action => MockSocketClose.new },
-          { :type => :attach, :action => MockSocketAttach.new },
-          { :type => :attach, :action => MockSocketAttach.new },
-          { :type => :close, :action => MockSocketClose.new } ]
-        # test of initiated connect
-        @socket.open 'localhost', 80
-        assert @socket.open?
-        @socket.settle 42
-        assert_equal 'login: ', @socket.read(7)
-        @socket.write 'anon'
-        assert_raises Timeout::Error do
-          @socket.write 'abc'
-        end
-        assert @socket.close
-        assert !@socket.open?
-        assert !@socket.close # a second close does not actually close anything
-        assert !@socket.open?
-        # this should fail because the socket has been closed
-        assert_raises SocketError do
-          @socket.read(1)
-        end
-        # test of attached socket (ie. one that has come from a client connection to a server)
-        assert_raises MockSocketSessionError do
-          @socket.attach nil
-        end
-        @socket.attach 1 # any object will do here to satisfy the nil test
-        assert @socket.close
-      end
-
-      def test_attached_session
-        MockSocket.session MockSocketSession.new [
-           { :type => :read, :action => MockSocketRead.new('xyz') },
-           { :type => :write, :action => MockSocketWrite.new('pqr') },
-           { :type => :close, :action => MockSocketClose.new } ]
-        @socket = SafeSocket.new
-        @socket.attach MockSocket.new
-        assert @socket.open?
-        assert_equal 'xyz', @socket.read(3)
-        @socket.write 'pqr'
-        start = Time.now
-        @socket.settle 1
-        elapsed = Time.now - start
-        assert elapsed > 0.99 and elapsed < 1.01
-        assert @socket.close
-        assert !@socket.open?
-      end
-
-      def test_sequence_mismatch
-        @socket = SafeSocket.mock MockSocketSession.new [
-          { :type => :open, :action => MockSocketOpen.new('localhost', 80) } ]
-        assert_raises MockSocketSessionError do
-          @socket.settle 42
-        end
-      end
-
-    end
-
-  end
-end
+# See https://github.com/sappho/sappho-socket/wiki for project documentation.
+# This software is licensed under the GNU Affero General Public License, version 3.
+# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# Copyright 2012 Andrew Heald.
+
+require "test/unit"
+require 'sappho-socket/safe_socket'
+require 'sappho-socket/mock_socket'
+
+module Sappho
+  module Socket
+
+    class SocketTest < Test::Unit::TestCase
+
+      def test_session
+        @socket = SafeSocket.mock MockSocketSession.new [
+          { :type => :open, :action => MockSocketOpen.new('localhost', 80) },
+          { :type => :settle, :action => MockSocketSettle.new(42) },
+          { :type => :read, :action => MockSocketRead.new('login: ') },
+          { :type => :write, :action => MockSocketWrite.new('anon') },
+          { :type => :write, :action => MockSocketTimeout.new },
+          { :type => :close, :action => MockSocketClose.new },
+          { :type => :attach, :action => MockSocketAttach.new },
+          { :type => :attach, :action => MockSocketAttach.new },
+          { :type => :close, :action => MockSocketClose.new } ]
+        # test of initiated connect
+        @socket.open 'localhost', 80
+        assert @socket.open?
+        @socket.settle 42
+        assert_equal 'login: ', @socket.read(7)
+        @socket.write 'anon'
+        assert_raises Timeout::Error do
+          @socket.write 'abc'
+        end
+        assert @socket.close
+        assert !@socket.open?
+        assert !@socket.close # a second close does not actually close anything
+        assert !@socket.open?
+        # this should fail because the socket has been closed
+        assert_raises SocketError do
+          @socket.read(1)
+        end
+        # test of attached socket (ie. one that has come from a client connection to a server)
+        assert_raises MockSocketSessionError do
+          @socket.attach nil
+        end
+        @socket.attach 1 # any object will do here to satisfy the nil test
+        assert @socket.close
+      end
+
+      def test_attached_session
+        MockSocket.session MockSocketSession.new [
+           { :type => :read, :action => MockSocketRead.new('xyz') },
+           { :type => :write, :action => MockSocketWrite.new('pqr') },
+           { :type => :close, :action => MockSocketClose.new } ]
+        @socket = SafeSocket.new
+        @socket.attach MockSocket.new
+        assert @socket.open?
+        assert_equal 'xyz', @socket.read(3)
+        @socket.write 'pqr'
+        start = Time.now
+        @socket.settle 1
+        elapsed = Time.now - start
+        assert elapsed > 0.99 and elapsed < 1.01
+        assert @socket.close
+        assert !@socket.open?
+      end
+
+      def test_sequence_mismatch
+        @socket = SafeSocket.mock MockSocketSession.new [
+          { :type => :open, :action => MockSocketOpen.new('localhost', 80) } ]
+        assert_raises MockSocketSessionError do
+          @socket.settle 42
+        end
+      end
+
+    end
+
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sappho-socket
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Andrew Heald
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-18 00:00:00 Z
+date: 2012-03-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -60,11 +60,11 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/sappho-socket/version.rb
 - lib/sappho-socket/connected_socket.rb
-- lib/sappho-socket/safe_server.rb
 - lib/sappho-socket/mock_socket.rb
+- lib/sappho-socket/safe_server.rb
 - lib/sappho-socket/safe_socket.rb
+- lib/sappho-socket/version.rb
 - test/ruby/socket_test.rb
 homepage: https://github.com/sappho/sappho-socket/wiki
 licenses: []
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: sappho-socket
-rubygems_version: 1.8.17
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Provides a usable TCP socket and mock implementation for testing