raktr 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2aa060f18df13540e73b42a5e9c68bdf86eaf03ae21104da0e827e57252dffe3
-  data.tar.gz: 5f1dd3fa7626e764f5212424c8e25b26a16bb52d4d00a2d2e6e4e5684575123a
+  metadata.gz: 78b82e1e277f9547fdfc576009b4b5883df5711ba8cca50a369651f758407aff
+  data.tar.gz: 1f594aa25c1872d359de5f7ef1a5e42dcad7699ff5ab54594ab099a3d2fa4315
 SHA512:
-  metadata.gz: 8889f36f41d78a38dbd5afb95af6f4c2836e2056bb00451dabb10141c19d34c1ce02a7809c54e3c807713ab0b3bb94e6d969eb423878ab2c8514db703c868f85
-  data.tar.gz: fa3426f952f1980e9916aeaa1af050da734fec2c8de94a8e352c5223271e4309f66abd9fba46399d5470394ad9b4d65801620c4b060e9b4db1c0775d23a8859e
+  metadata.gz: b0f1c2ec3508f4fa3c7bc841c553e5cc220208a3f7ea922802681742d33fbcb930a329eec352198f42f7910e90b679e663d08a1be19e5a91afdeb75b7cca57ed
+  data.tar.gz: 70eea04282a7c7ddf99d7f3df0e1e170e4eafaecb165ae02355aa1af899df089577aee4473b36a02358dd90008d2dded1772d3f7853d50dfc8ab62c7cc74a025

data/CHANGELOG.md

@@ -1 +1,10 @@
 # ChangeLog
+
+# 0.0.3
+
+* `#connect`, `#listen`: Re-raise exceptions.
+
+
+# 0.0.2
+
+* Reduced object allocations.

data/README.md

@@ -1,34 +1,5 @@
 # Raktr
 
-<table>
-    <tr>
-        <th>Version</th>
-        <td>0.0.1</td>
-    </tr>
-    <tr>
-        <th>Github page</th>
-        <td><a href="http://github.com/qadron/raktr">http://github.com/qadron/raktr</a></td>
-     <tr/>
-    <tr>
-        <th>Code Documentation</th>
-        <td><a href="http://rubydoc.info/github/qadron/raktr/">http://rubydoc.info/github/qadron/raktr/</a></td>
-    </tr>
-    <tr>
-       <th>Author</th>
-       <td><a href="http://twitter.com/Zap0tek">Tasos Laskos</a></td>
-    </tr>
-    <tr>
-        <th>Copyright</th>
-        <td>2022 <a href="https://ecsypno.com">Ecsypno</a></td>
-    </tr>
-    <tr>
-        <th>License</th>
-        <td><a href="file.LICENSE.html">3-clause BSD</a></td>
-    </tr>
-</table>
-
-## Synopsis
-
 Raktr is a simple, lightweight, pure-Ruby implementation of the
 [Reactor](http://en.wikipedia.org/wiki/Reactor_pattern) pattern, mainly focused
 on network connections -- and less so on generic tasks.

data/lib/raktr/connection/tls.rb

@@ -77,18 +77,16 @@ module TLS
     def _connect
         return if @ssl_connected
 
-        Error.translate do
-            @plaintext_connected ||= super
-            return if !@plaintext_connected
+        @plaintext_connected ||= super
+        return if !@plaintext_connected
 
-            # Mark the connection as not connected due to the pending SSL handshake.
-            @connected = false
+        # Mark the connection as not connected due to the pending SSL handshake.
+        @connected = false
 
-            @socket.connect_nonblock
-            @ssl_connected = @connected = true
-        end
+        @socket.connect_nonblock
+        @ssl_connected = @connected = true
     rescue IO::WaitReadable, IO::WaitWritable, Errno::EINPROGRESS
-    rescue Error => e
+    rescue => e
         close e
     end
 
@@ -118,11 +116,9 @@ module TLS
     private
 
     def ssl_accept
-        Error.translate do
-            @accepted = !!@socket.accept_nonblock
-        end
+        @accepted = !!@socket.accept_nonblock
     rescue IO::WaitReadable, IO::WaitWritable
-    rescue Error => e
+    rescue => e
         close e
         false
     end
@@ -142,19 +138,17 @@ module TLS
     #
     # @private
     def socket_accept
-        Error.translate do
-            socket = to_io.accept_nonblock
-
-            ssl_socket = OpenSSL::SSL::SSLSocket.new(
-                socket,
-                @ssl_context
-            )
-            ssl_socket.sync_close = true
-            ssl.accept if @start_immediately
-            ssl_socket
-        end
+        socket = to_io.accept_nonblock
+
+        ssl_socket = OpenSSL::SSL::SSLSocket.new(
+            socket,
+            @ssl_context
+        )
+        ssl_socket.sync_close = true
+        ssl.accept if @start_immediately
+        ssl_socket
     rescue IO::WaitReadable, IO::WaitWritable
-    rescue Error => e
+    rescue => e
         close e
     end
 

data/lib/raktr/connection.rb

@@ -6,7 +6,6 @@
 
 =end
 
-require_relative 'connection/error'
 require_relative 'connection/callbacks'
 require_relative 'connection/peer_info'
 require_relative 'connection/tls'
@@ -229,9 +228,7 @@ class Connection
         return true if unix? || connected?
 
         begin
-            Error.translate do
-                socket.connect_nonblock( Socket.sockaddr_in( @port, @host ) )
-            end
+            socket.connect_nonblock( Socket.sockaddr_in( @port, @host ) )
         # Already connected. :)
         rescue Errno::EISCONN, Errno::EALREADY
         end
@@ -241,7 +238,7 @@ class Connection
 
         true
     rescue IO::WaitReadable, IO::WaitWritable, Errno::EINPROGRESS
-    rescue Error => e
+    rescue => e
         close e
     end
 
@@ -256,13 +253,11 @@ class Connection
         return _connect if !listener? && !connected?
         return accept   if listener?
 
-        Error.translate do
-            on_read @socket.read_nonblock( BLOCK_SIZE )
-        end
+        on_read @socket.read_nonblock( BLOCK_SIZE )
 
     # Not ready to read or write yet, we'll catch it on future Reactor ticks.
     rescue IO::WaitReadable, IO::WaitWritable
-    rescue Error => e
+    rescue => e
         close e
     end
 
@@ -282,22 +277,21 @@ class Connection
     def _write
         return _connect if !connected?
 
-        chunk = write_buffer.byteslice( 0, BLOCK_SIZE )
+        write_buffer.force_encoding( Encoding::BINARY )
+        chunk = write_buffer[0, BLOCK_SIZE]
         total_written = 0
 
         begin
-            Error.translate do
-                # Send out the chunk, **all** of it, or at least try to.
-                loop do
-                    total_written += written = @socket.write_nonblock( chunk )
-                    @write_buffer = @write_buffer.byteslice( written..-1 )
-
-                    # Call #on_write every time any of the buffer is consumed.
-                    on_write
-
-                    break if written == chunk.bytesize
-                    chunk = chunk.byteslice( written..-1 )
-                end
+            # Send out the chunk, **all** of it, or at least try to.
+            loop do
+                total_written += written = @socket.write_nonblock( chunk )
+                write_buffer[0, written] = ''
+
+                # Call #on_write every time any of the buffer is consumed.
+                on_write
+
+                break if written == chunk.size
+                chunk[0, written] = ''
             end
 
         # Not ready to read or write yet, we'll catch it on future Reactor ticks.
@@ -310,7 +304,7 @@ class Connection
         end
 
         total_written
-    rescue Error => e
+    rescue => e
         close e
     end
 

data/lib/raktr/version.rb

@@ -8,6 +8,6 @@
 
 class Raktr
 
-    VERSION = '0.0.1'
+    VERSION = '0.0.3'
 
 end

data/lib/raktr.rb

@@ -195,15 +195,14 @@ class Raktr
         block.call connection if block_given?
 
         begin
-            Connection::Error.translate do
-                socket = options[:unix_socket] ?
-                    connect_unix( options[:unix_socket] ) : connect_tcp
+            socket = options[:unix_socket] ?
+                connect_unix( options[:unix_socket] ) : connect_tcp
 
-                connection.configure options.merge( socket: socket, role: :client )
-                attach connection
-            end
-        rescue Connection::Error => e
+            connection.configure options.merge( socket: socket, role: :client )
+            attach connection
+        rescue => e
             connection.close e
+            raise
         end
 
         connection
@@ -258,16 +257,15 @@ class Raktr
         server = server_handler.call
 
         begin
-            Connection::Error.translate do
-                socket = options[:unix_socket] ?
-                    listen_unix( options[:unix_socket] ) :
-                    listen_tcp( options[:host], options[:port] )
+            socket = options[:unix_socket] ?
+                listen_unix( options[:unix_socket] ) :
+                listen_tcp( options[:host], options[:port] )
 
-                server.configure options.merge( socket: socket, role: :server, server_handler: server_handler )
-                attach server
-            end
-        rescue Connection::Error => e
+            server.configure options.merge( socket: socket, role: :server, server_handler: server_handler )
+            attach server
+        rescue => e
             server.close e
+            raise
         end
 
         server
@@ -659,10 +657,8 @@ class Raktr
 
         selected_sockets =
             begin
-                Connection::Error.translate do
-                    select( r, w, e, @select_timeout )
-                end
-            rescue Connection::Error => e
+                select( r, w, e, @select_timeout )
+            rescue => e
                 nil
             end
 

data/spec/raktr/connection/tls_spec.rb

@@ -141,7 +141,7 @@ describe Raktr::Connection::TLS do
                 context 'and options have been provided' do
                     let(:client_ssl_options) { client_valid_ssl_options }
 
-                    it "passes #{Raktr::Connection::Error::SSL} to #on_error" do
+                    it "passes #{OpenSSL::SSL::SSLError} to #on_error" do
                         error = nil
 
                         options = server_ssl_options.merge(
@@ -165,7 +165,7 @@ describe Raktr::Connection::TLS do
 
                         raktr.wait rescue Raktr::Error::NotRunning
 
-                        error.should be_kind_of Raktr::Connection::Error::SSL
+                        error.should be_kind_of OpenSSL::SSL::SSLError
                     end
                 end
             end
@@ -199,7 +199,7 @@ describe Raktr::Connection::TLS do
                     context 'and are invalid' do
                         let(:client_ssl_options) { client_invalid_ssl_options }
 
-                        it "passes #{Raktr::Connection::Error::SSL} to #on_error" do
+                        it "passes #{OpenSSL::SSL::SSLError} to #on_error" do
                             error = nil
 
                             options = server_ssl_options.merge(
@@ -222,7 +222,7 @@ describe Raktr::Connection::TLS do
 
                             raktr.wait rescue Raktr::Error::NotRunning
 
-                            error.should be_kind_of Raktr::Connection::Error::SSL
+                            error.should be_kind_of OpenSSL::SSL::SSLError
                         end
                     end
                 end
@@ -230,7 +230,7 @@ describe Raktr::Connection::TLS do
                 context 'and no options have been provided' do
                     let(:client_ssl_options) { {} }
 
-                    it "passes #{Raktr::Connection::Error::SSL} to #on_error" do
+                    it "passes #{OpenSSL::SSL::SSLError} to #on_error" do
                         error = nil
 
                         options = server_ssl_options.merge(
@@ -254,7 +254,7 @@ describe Raktr::Connection::TLS do
 
                         raktr.wait rescue Raktr::Error::NotRunning
 
-                        error.should be_kind_of Raktr::Connection::Error::SSL
+                        error.should be_kind_of OpenSSL::SSL::SSLError
                     end
                 end
             end
@@ -302,13 +302,13 @@ describe Raktr::Connection::TLS do
                 let(:server_ssl_options) { server_valid_ssl_options }
 
                 context 'and no options have been provided' do
-                    it "passes #{Raktr::Connection::Error} to #on_error" do
+                    it "passes #{OpenSSL::SSL::SSLError} to #on_error" do
                         connection = nil
                         raktr.run do
                             connection = raktr.connect( host, port, TLSHandler )
                         end
 
-                        connection.error.should be_kind_of Raktr::Connection::Error
+                        connection.error.should be_kind_of OpenSSL::SSL::SSLError
                     end
                 end
 
@@ -332,13 +332,13 @@ describe Raktr::Connection::TLS do
                     end
 
                     context 'and are invalid' do
-                        it "passes #{Raktr::Connection::Error} to #on_error" do
+                        it "passes #{OpenSSL::SSL::SSLError} to #on_error" do
                             connection = nil
                             raktr.run do
                                 connection = raktr.connect( host, port, TLSHandler, client_invalid_ssl_options )
                             end
 
-                            connection.error.should be_kind_of Raktr::Connection::Error
+                            connection.error.should be_kind_of OpenSSL::SSL::SSLError
                         end
                     end
                 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'ap'
 require_relative '../lib/raktr'
 
+require_relative 'support/helpers/paths'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each do |f|
     next if f.include? '/servers/'
     require f

data/spec/support/lib/servers.rb

@@ -4,6 +4,7 @@ require 'net/http'
 class Servers
     include Singleton
 
+    require_relative '../helpers/paths'
     RUNNER = "#{support_lib_path}/servers/runner.rb"
 
     attr_reader :lib

data/spec/support/shared/raktr.rb

@@ -578,7 +578,7 @@ shared_examples_for 'Raktr' do
             end
 
             context 'when the socket is invalid' do
-                it "calls #on_close with #{klass::Connection::Error::HostNotFound}" do
+                it "calls #on_close with #{Errno::ENOENT}" do
                     outside_thread = Thread.current
                     subject.run do
                         Thread.current[:outside_thread] = outside_thread
@@ -591,7 +591,7 @@ shared_examples_for 'Raktr' do
                         end
                     end
 
-                    Thread.current[:outside_thread][:error].should be_a_kind_of klass::Connection::Error::HostNotFound
+                    Thread.current[:outside_thread][:error].should be_a_kind_of Errno::ENOENT
                 end
             end
         end
@@ -625,7 +625,7 @@ shared_examples_for 'Raktr' do
             end
 
             context 'when the host is invalid' do
-                it "calls #on_close with #{klass::Connection::Error::HostNotFound}" do
+                it "calls #on_close with #{SocketError}" do
                     outside_thread = Thread.current
                     subject.run do
                         Thread.current[:outside_thread] = outside_thread
@@ -638,12 +638,12 @@ shared_examples_for 'Raktr' do
                         end
                     end
 
-                    Thread.current[:outside_thread][:error].should be_a_kind_of klass::Connection::Error::HostNotFound
+                    Thread.current[:outside_thread][:error].should be_a_kind_of SocketError
                 end
             end
 
             context 'when the port is invalid' do
-                it "calls #on_close with #{klass::Connection::Error::Refused}" do
+                it "calls #on_close with #{Errno::ECONNREFUSED}" do
                     outside_thread = Thread.current
                     subject.run do
                         Thread.current[:outside_thread] = outside_thread
@@ -663,9 +663,9 @@ shared_examples_for 'Raktr' do
                         end
                     end
 
-                    [:error, klass::Connection::Error::Closed,
-                     klass::Connection::Error::Refused,
-                     Raktr::Connection::Error::BrokenPipe
+                    [:error, IOError,
+                     Errno::ECONNREFUSED,
+                     Errno::EPIPE
                     ].should include Thread.current[:outside_thread][:error]
                 end
             end
@@ -735,7 +735,7 @@ shared_examples_for 'Raktr' do
                         end
                     end
 
-                    [:error, klass::Connection::Error::Permission].should include Thread.current[:outside_thread][:error]
+                    [:error, Errno::EACCES].should include Thread.current[:outside_thread][:error]
                 end
             end
         end
@@ -777,7 +777,7 @@ shared_examples_for 'Raktr' do
                         end
                     end
 
-                    [:error, klass::Connection::Error::HostNotFound].should include Thread.current[:outside_thread][:error]
+                    [:error, SocketError].should include Thread.current[:outside_thread][:error]
                 end
             end
 
@@ -802,7 +802,7 @@ shared_examples_for 'Raktr' do
                         end
                     end
 
-                    [:error, klass::Connection::Error::Permission].should include Thread.current[:outside_thread][:error]
+                    [:error, Errno::EACCES].should include Thread.current[:outside_thread][:error]
                 end
             end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raktr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Tasos Laskos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-20 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies: []
 description: |2
       Raktr is a simple, lightweight, pure-Ruby implementation of the Reactor
@@ -28,7 +28,6 @@ files:
 - lib/raktr.rb
 - lib/raktr/connection.rb
 - lib/raktr/connection/callbacks.rb
-- lib/raktr/connection/error.rb
 - lib/raktr/connection/peer_info.rb
 - lib/raktr/connection/tls.rb
 - lib/raktr/global.rb
@@ -97,44 +96,44 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.4.13
 signing_key: 
 specification_version: 4
 summary: A pure-Ruby implementation of the Reactor pattern.
 test_files:
-- spec/raktr/connection/tls_spec.rb
 - spec/raktr/connection_spec.rb
-- spec/raktr/iterator_spec.rb
+- spec/raktr/tasks_spec.rb
 - spec/raktr/queue_spec.rb
-- spec/raktr/tasks/base.rb
 - spec/raktr/tasks/delayed_spec.rb
 - spec/raktr/tasks/one_off_spec.rb
+- spec/raktr/tasks/base.rb
 - spec/raktr/tasks/periodic_spec.rb
 - spec/raktr/tasks/persistent_spec.rb
-- spec/raktr/tasks_spec.rb
-- spec/raktr_spec.rb
-- spec/raktr_tls_spec.rb
+- spec/raktr/iterator_spec.rb
+- spec/raktr/connection/tls_spec.rb
 - spec/spec_helper.rb
-- spec/support/fixtures/handlers/echo_client.rb
-- spec/support/fixtures/handlers/echo_client_tls.rb
+- spec/raktr_tls_spec.rb
+- spec/support/helpers/utilities.rb
+- spec/support/helpers/paths.rb
 - spec/support/fixtures/handlers/echo_server.rb
 - spec/support/fixtures/handlers/echo_server_tls.rb
+- spec/support/fixtures/handlers/echo_client_tls.rb
+- spec/support/fixtures/handlers/echo_client.rb
 - spec/support/fixtures/pems/cacert.pem
-- spec/support/fixtures/pems/client/cert.pem
-- spec/support/fixtures/pems/client/foo-cert.pem
-- spec/support/fixtures/pems/client/foo-key.pem
-- spec/support/fixtures/pems/client/key.pem
 - spec/support/fixtures/pems/server/cert.pem
 - spec/support/fixtures/pems/server/key.pem
-- spec/support/helpers/paths.rb
-- spec/support/helpers/utilities.rb
-- spec/support/lib/server_option_parser.rb
-- spec/support/lib/servers/runner.rb
+- spec/support/fixtures/pems/client/foo-key.pem
+- spec/support/fixtures/pems/client/foo-cert.pem
+- spec/support/fixtures/pems/client/cert.pem
+- spec/support/fixtures/pems/client/key.pem
+- spec/support/shared/task.rb
+- spec/support/shared/raktr.rb
+- spec/support/shared/connection.rb
 - spec/support/lib/servers.rb
-- spec/support/servers/echo.rb
-- spec/support/servers/echo_tls.rb
+- spec/support/lib/servers/runner.rb
+- spec/support/lib/server_option_parser.rb
 - spec/support/servers/echo_unix.rb
+- spec/support/servers/echo_tls.rb
+- spec/support/servers/echo.rb
 - spec/support/servers/echo_unix_tls.rb
-- spec/support/shared/connection.rb
-- spec/support/shared/raktr.rb
-- spec/support/shared/task.rb
+- spec/raktr_spec.rb

data/lib/raktr/connection/error.rb

@@ -1,120 +0,0 @@
-=begin
-
-    This file is part of the Raktr project and may be subject to
-    redistribution and commercial restrictions. Please see the Raktr
-    web site for more information on licensing and terms of use.
-
-=end
-
-class Raktr
-class Connection
-
-# {Connection} error namespace.
-#
-# All {Connection} errors inherit from and live under it.
-#
-# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
-class Error < Raktr::Error
-
-    class << self
-        # Captures Ruby exceptions and converts them to an appropriate
-        # subclass of {Error}.
-        #
-        # @param  [Block] block Block to run.
-        def translate( &block )
-            block.call
-        rescue IOError, Errno::ENOTCONN, Errno::ENOTSOCK => e
-            raise_with_proper_backtrace( e, Closed )
-        rescue SocketError, Errno::ENOENT => e
-            raise_with_proper_backtrace( e, HostNotFound )
-        rescue Errno::EPIPE => e
-            raise_with_proper_backtrace( e, BrokenPipe )
-        rescue Errno::ECONNREFUSED,
-            # JRuby throws Errno::EADDRINUSE when trying to connect to a
-            # non-existent server.
-            Errno::EADDRINUSE => e
-            raise_with_proper_backtrace( e, Refused )
-        rescue Errno::ECONNRESET, Errno::ECONNABORTED => e
-            raise_with_proper_backtrace( e, Reset )
-        rescue Errno::EACCES => e
-            raise_with_proper_backtrace( e, Permission )
-        rescue Errno::EBADF => e
-            raise_with_proper_backtrace( e, BadSocket )
-
-        # Catch and forward these before handling OpenSSL::OpenSSLError because
-        # all SSL errors inherit from it, including OpenSSL::SSL::SSLErrorWaitReadable
-        # and OpenSSL::SSL::SSLErrorWaitWritable which also inherit from
-        # IO::WaitReadable and IO::WaitWritable and need special treatment.
-        rescue IO::WaitReadable, IO::WaitWritable, Errno::EINPROGRESS
-            raise
-
-        # We're mainly interested in translating SSL handshake errors but there
-        # aren't any specific exceptions for these.
-        #
-        # Why make things easy and clean, right?
-        rescue OpenSSL::SSL::SSLError, OpenSSL::OpenSSLError => e
-            raise_with_proper_backtrace( e, SSL )
-        end
-
-        def raise_with_proper_backtrace( ruby, raktr )
-            e = raktr.new( ruby.to_s )
-            e.set_backtrace ruby.backtrace
-            raise e
-        end
-    end
-
-    # Like a `SocketError.getaddrinfo` exception.
-    #
-    # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
-    class HostNotFound < Error
-    end
-
-    # Like a `Errno::EACCES` exception.
-    #
-    # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
-    class Permission < Error
-    end
-
-    # Like a `Errno::ECONNREFUSED` exception.
-    #
-    # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
-    class Refused < Error
-    end
-
-    # Like a `Errno::ECONNRESET` exception.
-    #
-    # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
-    class Reset < Error
-    end
-
-    # Like a `Errno::EPIPE` exception.
-    #
-    # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
-    class BrokenPipe < Error
-    end
-
-    # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
-    class Timeout < Error
-    end
-
-    # Like a `IOError` exception.
-    #
-    # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
-    class Closed < Error
-    end
-
-    # Like a `Errno::EBADF` exception.
-    #
-    # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
-    class BadSocket < Error
-    end
-
-    # Like a `OpenSSL::OpenSSLError` exception.
-    #
-    # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
-    class SSL < Error
-    end
-
-end
-end
-end