tcp-client 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e88146d7f1f966d6c9e7dce6a876c17dca7383ee88eb76a8e5caf36076a03720
-  data.tar.gz: 493d8cbf748789df4efd0301679082023c140f23dbc2a3d52ccfcf8d71a4a1b4
+  metadata.gz: 02440fe17a1480ba18bec8b6918cea6420a065d997c423a6602e165e0f316564
+  data.tar.gz: 73e315f2c80a2f0f1cf0cb57b24f2f2cd45e10caffebd83dd47510ea85de1f25
 SHA512:
-  metadata.gz: 070ba42a0a185a67ae1ac4d1912220ab0aa297a6cdc4147d3afaf8593129f3b25da2ecad7a8569651c6d54dd1ba11c7705ebf8bcc1def2d525388025b45d12b3
-  data.tar.gz: 4c34127d89744a537d5b64c578ac4c1e2121c27e9412208f7c0abcf74999bb1e85c1c246bebfea83401c8caaf4c472daee7ff5e599989632076784881131b3ea
+  metadata.gz: bb22bb974aacd8cfc9d4a1ebcc66393172ec949db8038ecbc37c1a4187bb8a1d703206625f25fb7dba5e336217d2de31475220aa4147bc20df26a5deff7bd7b7
+  data.tar.gz: 0fd048dda8d10ba76659276cd7f5c09e1fba73560d482a5cbbb35ba6db034192137552531dcd294d45a50a10a211839b318015d0546ded7df28c8f55246fe7fd

data/lib/tcp-client/default_configuration.rb

@@ -41,7 +41,7 @@ class TCPClient
       #
       # @!parse attr_reader :default
       # @return [Configuration] used by default if no dedicated configuration
-      # was specified
+      #   was specified
       #
       # @see TCPClient.open
       # @see TCPClient.with_deadline

data/lib/tcp-client/mixin/io_with_deadline.rb

@@ -1,141 +1,149 @@
 # frozen_string_literal: true
 
-# @!visibility private
-module IOWithDeadlineMixin # :nodoc:
-  def self.included(mod)
-    methods = mod.instance_methods
-    if methods.index(:wait_writable) && methods.index(:wait_readable)
-      mod.include(ViaWaitMethod)
-    elsif methods.index(:to_io)
-      mod.include(ViaIOWaitMethod)
-    else
-      mod.include(ViaSelect)
+class TCPClient
+  module IOWithDeadlineMixin
+    def self.included(mod)
+      methods = mod.instance_methods
+      if methods.index(:wait_writable) && methods.index(:wait_readable)
+        mod.include(ViaWaitMethod)
+      elsif methods.index(:to_io)
+        mod.include(ViaIOWaitMethod)
+      else
+        mod.include(ViaSelect)
+      end
     end
-  end
 
-  def read_with_deadline(nbytes, deadline, exception)
-    raise(exception) unless deadline.remaining_time
-    return fetch_avail(deadline, exception) if nbytes.nil?
-    return ''.b if nbytes.zero?
-    @buf ||= ''.b
-    while @buf.bytesize < nbytes
-      read = fetch_next(deadline, exception) and next @buf << read
-      close
-      break
+    def read_with_deadline(nbytes, deadline, exception)
+      raise(exception) unless deadline.remaining_time
+      return fetch_avail(deadline, exception) if nbytes.nil?
+      return ''.b if nbytes.zero?
+      @buf ||= ''.b
+      while @buf.bytesize < nbytes
+        read = fetch_next(deadline, exception) and next @buf << read
+        close
+        break
+      end
+      fetch_buffer_slice(nbytes)
     end
-    fetch_buffer_slice(nbytes)
-  end
 
-  def readto_with_deadline(sep, deadline, exception)
-    raise(exception) unless deadline.remaining_time
-    @buf ||= ''.b
-    while (index = @buf.index(sep)).nil?
-      read = fetch_next(deadline, exception) and next @buf << read
-      close
-      break
+    def readto_with_deadline(sep, deadline, exception)
+      raise(exception) unless deadline.remaining_time
+      @buf ||= ''.b
+      while (index = @buf.index(sep)).nil?
+        read = fetch_next(deadline, exception) and next @buf << read
+        close
+        break
+      end
+      index = @buf.index(sep)
+      return fetch_buffer_slice(index + sep.bytesize) if index
+      result = @buf
+      @buf = nil
+      result
     end
-    index = @buf.index(sep) and return fetch_buffer_slice(index + sep.bytesize)
-    result = @buf
-    @buf = nil
-    result
-  end
 
-  def write_with_deadline(data, deadline, exception)
-    raise(exception) unless deadline.remaining_time
-    return 0 if (size = data.bytesize).zero?
-    result = 0
-    loop do
-      written =
-        with_deadline(deadline, exception) do
-          write_nonblock(data, exception: false)
-        end
-      (result += written) >= size and return result
-      data = data.byteslice(written, data.bytesize - written)
+    def write_with_deadline(data, deadline, exception)
+      raise(exception) unless deadline.remaining_time
+      return 0 if (size = data.bytesize).zero?
+      result = 0
+      loop do
+        written =
+          with_deadline(deadline, exception) do
+            write_nonblock(data, exception: false)
+          end
+        (result += written) >= size and return result
+        data = data.byteslice(written, data.bytesize - written)
+      end
     end
-  end
 
-  private
+    private
 
-  def fetch_avail(deadline, exception)
-    if @buf.nil?
-      result = fetch_next(deadline, exception) and return result
-      close
-      return ''.b
+    def fetch_avail(deadline, exception)
+      if @buf.nil?
+        result = fetch_next(deadline, exception) and return result
+        close
+        return ''.b
+      end
+      result = @buf
+      @buf = nil
+      result
     end
-    result = @buf
-    @buf = nil
-    result
-  end
 
-  def fetch_buffer_slice(size)
-    result = @buf.byteslice(0, size)
-    rest = @buf.bytesize - result.bytesize
-    @buf = rest.zero? ? nil : @buf.byteslice(size, rest)
-    result
-  end
+    def fetch_buffer_slice(size)
+      result = @buf.byteslice(0, size)
+      rest = @buf.bytesize - result.bytesize
+      @buf = rest.zero? ? nil : @buf.byteslice(size, rest)
+      result
+    end
 
-  def fetch_next(deadline, exception)
-    with_deadline(deadline, exception) do
-      read_nonblock(65_536, exception: false)
+    def fetch_next(deadline, exception)
+      with_deadline(deadline, exception) do
+        read_nonblock(65_536, exception: false)
+      end
     end
-  end
 
-  module ViaWaitMethod
-    private def with_deadline(deadline, exception)
-      loop do
-        case ret = yield
-        when :wait_writable
-          remaining_time = deadline.remaining_time or raise(exception)
-          raise(exception) if wait_writable(remaining_time).nil?
-        when :wait_readable
-          remaining_time = deadline.remaining_time or raise(exception)
-          raise(exception) if wait_readable(remaining_time).nil?
-        else
-          return ret
+    module ViaWaitMethod
+      private def with_deadline(deadline, exception)
+        loop do
+          case ret = yield
+          when :wait_writable
+            remaining_time = deadline.remaining_time or raise(exception)
+            raise(exception) if wait_writable(remaining_time).nil?
+          when :wait_readable
+            remaining_time = deadline.remaining_time or raise(exception)
+            raise(exception) if wait_readable(remaining_time).nil?
+          else
+            return ret
+          end
         end
+      rescue Errno::ETIMEDOUT
+        raise(exception)
       end
-    rescue Errno::ETIMEDOUT
-      raise(exception)
     end
-  end
 
-  module ViaIOWaitMethod
-    private def with_deadline(deadline, exception)
-      loop do
-        case ret = yield
-        when :wait_writable
-          remaining_time = deadline.remaining_time or raise(exception)
-          raise(exception) if to_io.wait_writable(remaining_time).nil?
-        when :wait_readable
-          remaining_time = deadline.remaining_time or raise(exception)
-          raise(exception) if to_io.wait_readable(remaining_time).nil?
-        else
-          return ret
+    module ViaIOWaitMethod
+      private def with_deadline(deadline, exception)
+        loop do
+          case ret = yield
+          when :wait_writable
+            remaining_time = deadline.remaining_time or raise(exception)
+            raise(exception) if to_io.wait_writable(remaining_time).nil?
+          when :wait_readable
+            remaining_time = deadline.remaining_time or raise(exception)
+            raise(exception) if to_io.wait_readable(remaining_time).nil?
+          else
+            return ret
+          end
         end
+      rescue Errno::ETIMEDOUT
+        raise(exception)
       end
-    rescue Errno::ETIMEDOUT
-      raise(exception)
     end
-  end
 
-  module ViaSelect
-    private def with_deadline(deadline, exception)
-      loop do
-        case ret = yield
-        when :wait_writable
-          remaining_time = deadline.remaining_time or raise(exception)
-          raise(exception) if ::IO.select(nil, [self], nil, remaining_time).nil?
-        when :wait_readable
-          remaining_time = deadline.remaining_time or raise(exception)
-          raise(exception) if ::IO.select([self], nil, nil, remaining_time).nil?
-        else
-          return ret
+    module ViaSelect
+      private def with_deadline(deadline, exception)
+        loop do
+          case ret = yield
+          when :wait_writable
+            remaining_time = deadline.remaining_time or raise(exception)
+            if ::IO.select(nil, [self], nil, remaining_time).nil?
+              raise(exception)
+            end
+          when :wait_readable
+            remaining_time = deadline.remaining_time or raise(exception)
+            if ::IO.select([self], nil, nil, remaining_time).nil?
+              raise(exception)
+            end
+          else
+            return ret
+          end
         end
+      rescue Errno::ETIMEDOUT
+        raise(exception)
       end
-    rescue Errno::ETIMEDOUT
-      raise(exception)
     end
+
+    private_constant(:ViaWaitMethod, :ViaIOWaitMethod, :ViaSelect)
   end
 
-  private_constant(:ViaWaitMethod, :ViaIOWaitMethod, :ViaSelect)
+  private_constant(:IOWithDeadlineMixin)
 end

data/lib/tcp-client/ssl_socket.rb

@@ -30,7 +30,7 @@ class TCPClient
       ::OpenSSL::SSL::SSLContext.new.tap do |ctx|
         ctx.set_params(ssl_params)
         ctx.session_cache_mode = CONTEXT_CACHE_MODE
-        ctx.session_new_cb = proc { |_, sess| @new_session = sess }
+        ctx.session_new_cb = proc { |_, session| @new_session = session }
       end
     end
 

data/lib/tcp-client/version.rb

@@ -2,5 +2,5 @@
 
 class TCPClient
   # The current version number.
-  VERSION = '0.10.0'
+  VERSION = '0.10.1'
 end

data/lib/tcp-client.rb

@@ -13,7 +13,7 @@ require_relative 'tcp-client/version'
 # Client class to communicate with a server via TCP w/o SSL.
 #
 # All connect/read/write actions can be monitored to ensure that all actions
-# terminate before given time limits - or raise an exception.
+# terminate before given time limit - or raise an exception.
 #
 # @example request to Google.com and limit network interactions to 1.5 seconds
 #   # create a configuration to use at least TLS 1.2

data/spec/tcp_client_spec.rb

@@ -189,7 +189,7 @@ RSpec.describe TCPClient do
           )
           result = client.connect('localhost:1234', configuration, timeout: 10)
 
-          expect(client).to be client
+          expect(result).to be client
         end
 
         it 'is not closed' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcp-client
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-09 00:00:00.000000000 Z
+date: 2022-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A TCP client implementation with working timeout support.