socketry 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3035f86108ed663a3bae8c6ef3d50b09925e9628
-  data.tar.gz: f21df11ab03cbddfe484f6f73ec2c08e501d7d88
+  metadata.gz: c144331b5b09954959008e255335d5ac43c70be3
+  data.tar.gz: 704cb38c89f0cc0779aaeba5859877f189f5664c
 SHA512:
-  metadata.gz: a659f5c5b1be2398364efe1a0a088476d1ec85594c8986c88836baea15fe235d99d58e29b8e0a765de89691a843f35658757dab17586f490bb21adf7be80997d
-  data.tar.gz: 4e96517be39871436dcd8afe7bf22752a58f906fc1da5aef8e0edf3189987fe11905fb7cb6cd2f01332083e1146e4312280c41d51f9c4152bce24aa10ff6a6ac
+  metadata.gz: f49d7c5ee328c0c6b7f6366aca43d147a56045b1b1f3dca05219caef2216e791454585e512a7195f61dc1fb767230a2dde82f5130e1a174474d26b6ad0fbbabb
+  data.tar.gz: 7147ec4e25e1d4af36d27452be851adbec957ce65747f95ce873e91936ec962b3576d62b0f171304079dad998030289874a55267682c7842debb7fe7d7ac0413

data/.rubocop.yml

@@ -14,6 +14,9 @@ Style/AccessorMethodName:
 Style/ConditionalAssignment:
   Enabled: false
 
+Style/NumericPredicate:
+  Enabled: false
+
 Style/RescueModifier:
   Enabled: false
 

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 0.3.0 (2016-09-24)
+
+* Implement Socketry::TCP::Socket#read and #write
+* Use StandardError as the base class for Socketry::Error
+* Add Socketry::ConnectionRefusedError
+* Parameterize SSL contexts
+
 ## 0.2.0 (2016-09-12)
 
 * Rename Socketry::TCP::Socket#connected? -> #closed?

data/README.md

@@ -64,11 +64,11 @@ socket.writepartial("GET / HTTP/1.0\r\nHost: github.com\r\n\r\n")
 p socket.readpartial(1024)
 ```
 
-[TCP], [UDP], and [SSL] servers and sockets also available.
+[TCP], [SSL], and [UDP] servers and sockets also available.
 
 [TCP]: https://github.com/socketry/socketry/wiki/TCP
-[UDP]: https://github.com/socketry/socketry/wiki/UDP
 [SSL]: https://github.com/socketry/socketry/wiki/SSL
+[UDP]: https://github.com/socketry/socketry/wiki/UDP
 
 ## Documentation
 

data/lib/socketry/exceptions.rb

@@ -2,7 +2,10 @@
 
 module Socketry
   # Generic catch all for all Socketry errors
-  Error = Class.new(::IOError)
+  Error = Class.new(StandardError)
+
+  # Failed to connect to a remote host
+  ConnectionRefusedError = Class.new(Socketry::Error)
 
   # Invalid address
   AddressError = Class.new(Socketry::Error)

data/lib/socketry/ssl/server.rb

@@ -12,14 +12,16 @@ module Socketry
         hostname_or_port,
         port = nil,
         ssl_socket_class: OpenSSL::SSL::SSLSocket,
+        ssl_context: OpenSSL::SSL::SSLContext.new,
         ssl_params: nil,
         **args
       )
+        raise TypeError, "invalid SSL context (#{ssl_context.class})" unless ssl_context.is_a?(OpenSSL::SSL::SSLContext)
         raise TypeError, "expected Hash, got #{ssl_params.class}" if ssl_params && !ssl_params.is_a?(Hash)
 
         @ssl_socket_class = ssl_socket_class
-        @ssl_context = OpenSSL::SSL::SSLContext.new
-        @ssl_context.set_params(ssl_params) if ssl_params
+        @ssl_context = ssl_context
+        @ssl_context.set_params(ssl_params) if ssl_params && !ssl_params.empty?
         @ssl_context.freeze
 
         super(hostname_or_port, port, **args)

data/lib/socketry/ssl/socket.rb

@@ -7,18 +7,27 @@ module Socketry
     class Socket < Socketry::TCP::Socket
       # Create an unconnected Socketry::SSL::Socket
       #
-      # @param read_timeout  [Numeric] Seconds to wait before an uncompleted read errors
+      # @param read_timeout [Numeric] Seconds to wait before an uncompleted read errors
       # @param write_timeout [Numeric] Seconds to wait before an uncompleted write errors
-      # @param timer         [Object]  A timekeeping object to use for measuring timeouts
-      # @param resolver      [Object]  A resolver object to use for resolving DNS names
-      # @param socket_class  [Object]  Underlying socket class which implements I/O ops
+      # @param timer [Object] A timekeeping object to use for measuring timeouts
+      # @param resolver [Object] A resolver object to use for resolving DNS names
+      # @param socket_class [Object] Underlying socket class which implements I/O ops
+      # @param ssl_socket_class [Object] Class which provides the underlying SSL implementation
+      # @param ssl_context [OpenSSL::SSL::SSLContext] SSL configuration object
+      # @param ssL_params [Hash] Parameter hash to set on the given SSL context
       # @return [Socketry::SSL::Socket]
-      def initialize(ssl_socket_class: OpenSSL::SSL::SSLSocket, ssl_params: nil, **args)
+      def initialize(
+        ssl_socket_class: OpenSSL::SSL::SSLSocket,
+        ssl_context: OpenSSL::SSL::SSLContext.new,
+        ssl_params: nil,
+        **args
+      )
+        raise TypeError, "invalid SSL context (#{ssl_context.class})" unless ssl_context.is_a?(OpenSSL::SSL::SSLContext)
         raise TypeError, "expected Hash, got #{ssl_params.class}" if ssl_params && !ssl_params.is_a?(Hash)
 
         @ssl_socket_class = ssl_socket_class
-        @ssl_context = OpenSSL::SSL::SSLContext.new
-        @ssl_context.set_params(ssl_params) if ssl_params
+        @ssl_context = ssl_context
+        @ssl_context.set_params(ssl_params) if ssl_params && !ssl_params.empty?
         @ssl_context.freeze
         @ssl_socket = nil
 
@@ -27,12 +36,12 @@ module Socketry
 
       # Make an SSL connection to a remote host
       #
-      # @param remote_addr  [String]  DNS name or IP address of the host to connect to
-      # @param remote_port  [Fixnum]  TCP port to connect to
-      # @param local_addr   [String]  DNS name or IP address to bind to locally
-      # @param local_port   [Fixnum]  Local TCP port to bind to
-      # @param timeout      [Numeric] Number of seconds to wait before aborting connect
-      # @param socket_class [Class]   Custom low-level socket class
+      # @param remote_addr [String] DNS name or IP address of the host to connect to
+      # @param remote_port [Fixnum] TCP port to connect to
+      # @param local_addr [String] DNS name or IP address to bind to locally
+      # @param local_port [Fixnum] Local TCP port to bind to
+      # @param timeout [Numeric] Number of seconds to wait before aborting connect
+      # @param socket_class [Class] Custom low-level socket class
       # @raise [Socketry::AddressError] an invalid address was given
       # @raise [Socketry::TimeoutError] connect operation timed out
       # @raise [Socketry::SSL::Error] an error occurred negotiating an SSL connection

data/lib/socketry/tcp/socket.rb

@@ -98,6 +98,8 @@ module Socketry
           # Note: `exception: false` for Socket#connect_nonblock is only supported in Ruby 2.3+
           begin
             socket.connect_nonblock(remote_sockaddr)
+          rescue Errno::ECONNREFUSED => ex
+            raise Socketry::ConnectionRefusedError, "connection to #{remote_addr}:#{remote_port} refused", ex.backtrace
           rescue Errno::EINPROGRESS, Errno::EALREADY
             # Earlier JRuby 9.x versions do not seem to correctly support Socket#wait_writable in this case
             # Newer versions seem to behave correctly
@@ -162,14 +164,16 @@ module Socketry
       # Read a partial amounth of data, blocking until it becomes available
       #
       # @param size [Fixnum] number of bytes to attempt to read
+      # @param outbuf [String] an output buffer to read data into
+      # @param timeout [Numeric] Number of seconds to wait for read operation to complete
       # @raise [Socketry::Error] an I/O operation failed
-      # @return [String]
+      # @return [String, :eof] bytes read, or :eof if socket closed while reading
       def readpartial(size, outbuf: nil, timeout: @read_timeout)
         set_timeout(timeout)
 
         begin
           while (result = read_nonblock(size, outbuf: outbuf)) == :wait_readable
-            next if @socket.wait_readable(read_timeout)
+            next if @socket.wait_readable(time_remaining(timeout))
             raise TimeoutError, "read timed out after #{timeout} seconds"
           end
         ensure
@@ -179,9 +183,35 @@ module Socketry
         result || :eof
       end
 
+      # Read all of the data in a given string to a socket unless timeout or EOF
+      #
+      # @param size [Fixnum] number of bytes to attempt to read
+      # @param outbuf [String] an output buffer to read data into
+      # @param timeout [Numeric] Number of seconds to wait for read operation to complete
+      # @raise [Socketry::Error] an I/O operation failed
+      # @return [String, :eof] bytes read, or :eof if socket closed while reading
+      def read(size, outbuf: String.new, timeout: @write_timeout)
+        outbuf.clear
+        deadline = lifetime + timeout if timeout
+
+        begin
+          until outbuf.size == size
+            time_remaining = deadline - lifetime if deadline
+            raise Socketry::TimeoutError, "read timed out after #{timeout} seconds" if timeout && time_remaining <= 0
+
+            chunk = readpartial(size - outbuf.size, timeout: time_remaining)
+            return :eof if chunk == :eof
+
+            outbuf << chunk
+          end
+        end
+
+        outbuf
+      end
+
       # Perform a non-blocking write operation
       #
-      # @param data [String] number of bytes to attempt to read
+      # @param data [String] data to write to the socket
       # @raise [Socketry::Error] an I/O operation failed
       # @return [Fixnum, :wait_writable] number of bytes written, or :wait_writable if op would block
       def write_nonblock(data)
@@ -196,15 +226,16 @@ module Socketry
 
       # Write a partial amounth of data, blocking until it's completed
       #
-      # @param data [String] number of bytes to attempt to read
+      # @param data [String] data to write to the socket
+      # @param timeout [Numeric] Number of seconds to wait for write operation to complete
       # @raise [Socketry::Error] an I/O operation failed
-      # @return [Fixnum, :wait_writable] number of bytes written, or :wait_writable if op would block
+      # @return [Fixnum, :eof] number of bytes written, or :eof if socket closed during writing
       def writepartial(data, timeout: @write_timeout)
         set_timeout(timeout)
 
         begin
           while (result = write_nonblock(data)) == :wait_writable
-            next if @socket.wait_writable(read_timeout)
+            next if @socket.wait_writable(time_remaining(timeout))
             raise TimeoutError, "write timed out after #{timeout} seconds"
           end
         ensure
@@ -214,6 +245,32 @@ module Socketry
         result || :eof
       end
 
+      # Write all of the data in a given string to a socket unless timeout or EOF
+      #
+      # @param data [String] data to write to the socket
+      # @param timeout [Numeric] Number of seconds to wait for write operation to complete
+      # @raise [Socketry::Error] an I/O operation failed
+      # @return [Fixnum] number of bytes written, or :eof if socket closed during writing
+      def write(data, timeout: @write_timeout)
+        total_written = data.size
+        deadline = lifetime + timeout if timeout
+
+        begin
+          until data.empty?
+            time_remaining = deadline - lifetime if deadline
+            raise Socketry::TimeoutError, "write timed out after #{timeout} seconds" if timeout && time_remaining <= 0
+
+            bytes_written = writepartial(data, timeout: time_remaining)
+            return :eof if bytes_written == :eof
+
+            break if bytes_written == data.bytesize
+            data = data.byteslice(bytes_written..-1)
+          end
+        end
+
+        total_written
+      end
+
       # Check whether Nagle's algorithm has been disabled
       #
       # @return [true]  Nagle's algorithm has been explicitly disabled

data/lib/socketry/timeout.rb

@@ -44,6 +44,8 @@ module Socketry
     def set_timeout(timeout)
       raise Socketry::InternalError, "deadline already set" if @deadline
       return unless timeout
+      raise Socketry::TimeoutError, "time expired" if timeout < 0
+
       @deadline = lifetime + timeout
     end
 

data/lib/socketry/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Socketry
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: socketry
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tony Arcieri
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-12 00:00:00.000000000 Z
+date: 2016-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hitimes