tcp-client 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b265053761a87007b7de21c3a7a369b778f013ae726bb26220a4fd9aeeaf71c
-  data.tar.gz: 5a71b5dc86ed4ab9ef481e65c24aef0481c5e9d2c868f3f9975b801936d99691
+  metadata.gz: 8d280b6685729b5f2573ec4bfb2f8d57b154275b381ef61084138e03bc5c2c2e
+  data.tar.gz: 5bbd6d4d3b1c94fa87e44d9ae03d80e38f444e0776680eb0eb42aed60d915fd6
 SHA512:
-  metadata.gz: d16d436959c3e1c29962a5c474de8db3b4638e2d99aaf66fe4046b22e8159298cc433e014b14d9c9b3e01cafff1052743cf90896c396d86e1ccfc87d689553da
-  data.tar.gz: 70f4ce83fd7c7c8aa4c066fb94e96ef62a5087c3f78e079cd473e8d45ab22e106eea7b3d7bf5965063fecb9b77c58b8548598f4a873d9480c5b501bc7854dea9
+  metadata.gz: 8b7b41def4591e42fc6db859a7c5f485fc5416e266728526d59313141cfc4ccd828f7adff563a425647a61fac5bc751a1a01193bc98bef589c9b9393737c92c4
+  data.tar.gz: 8d6d5e239dc2ba17a1015a565de2603be0f0421ee0e10fb24a94de86e5cb150d59842fd053cb27a3f58ca58fe43728f321cdfe02bba39a2c723a66ffb2013d0e

data/.gitignore

@@ -1,4 +1,4 @@
-.local/
+local/
 tmp/
 pkg/
 gems.locked

data/README.md

@@ -3,7 +3,8 @@
 A TCP client implementation with working timeout support.
 
 ## Description
-This gem implements a TCP client with (optional) SSL support. The motivation of this project is the need to have a _really working_ easy to use client which can handle time limits correctly. Unlike other implementations this client respects given/configurable time limits for each method (`connect`, `read`, `write`).
+
+This Gem implements a TCP client with (optional) SSL support. It is an easy to use, versatile configurable client that can correctly handle time limits. Unlike other implementations, this client respects predefined/configurable time limits for each method (`connect`, `read`, `write`). Deadlines for a sequence of read/write actions can also be monitored.
 
 ## Sample
 
@@ -11,15 +12,15 @@ This gem implements a TCP client with (optional) SSL support. The motivation of
 require 'tcp-client'
 
 TCPClient.configure do |cfg|
-  cfg.connect_timeout = 1 # second to connect the server
+  cfg.connect_timeout = 1 # limit connect time the server to 1 second
   cfg.ssl_params = { ssl_version: :TLSv1_2 } # use TLS 1.2
 end
 
 TCPClient.open('www.google.com:443') do |client|
-  # query should not last longer than 0.5 seconds
+  # next sequence should not last longer than 0.5 seconds
   client.with_deadline(0.5) do
     # simple HTTP get request
-    pp client.write("GET / HTTP/1.1\r\nHost: google.com\r\n\r\n")
+    pp client.write("GET / HTTP/1.1\r\nHost: www.google.com\r\n\r\n")
 
     # read "HTTP/1.1 " + 3 byte HTTP status code
     pp client.read(12)

data/lib/tcp-client.rb

@@ -2,6 +2,7 @@
 
 require_relative 'tcp-client/errors'
 require_relative 'tcp-client/address'
+require_relative 'tcp-client/deadline'
 require_relative 'tcp-client/tcp_socket'
 require_relative 'tcp-client/ssl_socket'
 require_relative 'tcp-client/configuration'
@@ -55,9 +56,8 @@ class TCPClient
   def with_deadline(timeout)
     previous_deadline = @deadline
     raise(NoBlockGiven) unless block_given?
-    tm = timeout&.to_f
-    raise(InvalidDeadLine) unless tm&.positive?
-    @deadline = Time.now + tm
+    @deadline = Deadline.new(timeout)
+    raise(InvalidDeadLine, timeout) unless @deadline.valid?
     yield(self)
   ensure
     @deadline = previous_deadline
@@ -67,18 +67,18 @@ class TCPClient
     raise(NotConnected) if closed?
     timeout.nil? && @deadline and
       return read_with_deadline(nbytes, @deadline, exception)
-    timeout = (timeout || @cfg.read_timeout).to_f
-    return @socket.read(nbytes) unless timeout.positive?
-    read_with_deadline(nbytes, Time.now + timeout, exception)
+    deadline = Deadline.new(timeout || @cfg.read_timeout)
+    return @socket.read(nbytes) unless deadline.valid?
+    read_with_deadline(nbytes, deadline, exception)
   end
 
   def write(*msg, timeout: nil, exception: nil)
     raise(NotConnected) if closed?
     timeout.nil? && @deadline and
       return write_with_deadline(msg, @deadline, exception)
-    timeout = (timeout || @cfg.write_timeout).to_f
-    return @socket.write(*msg) unless timeout.positive?
-    write_with_deadline(msg, Time.now + timeout, exception)
+    deadline = Deadline.new(timeout || @cfg.read_timeout)
+    return @socket.write(*msg) unless deadline.valid?
+    write_with_deadline(msg, deadline, exception)
   end
 
   def flush

data/lib/tcp-client/address.rb

@@ -58,10 +58,7 @@ class TCPClient
 
     def from_string(str)
       idx = str.rindex(':') or return nil, str.to_i
-      name = str[0, idx]
-      if name.start_with?('[') && name.end_with?(']')
-        name = name[1, name.size - 2]
-      end
+      name = str[0, idx].delete_prefix('[').delete_suffix(']')
       [name, str[idx + 1, str.size - idx].to_i]
     end
   end

data/lib/tcp-client/configuration.rb

@@ -13,7 +13,6 @@ class TCPClient
     attr_reader :buffered,
                 :keep_alive,
                 :reverse_lookup,
-                :timeout,
                 :connect_timeout,
                 :read_timeout,
                 :write_timeout,
@@ -47,9 +46,12 @@ class TCPClient
     end
 
     def ssl=(value)
-      return @ssl_params = nil unless value
-      return @ssl_params = value.dup if Hash === value
-      @ssl_params ||= {}
+      @ssl_params =
+        if Hash === value
+          value.dup
+        else
+          value ? {} : nil
+        end
     end
 
     def buffered=(value)
@@ -65,8 +67,7 @@ class TCPClient
     end
 
     def timeout=(seconds)
-      @timeout =
-        @connect_timeout = @write_timeout = @read_timeout = seconds(seconds)
+      @connect_timeout = @write_timeout = @read_timeout = seconds(seconds)
     end
 
     def connect_timeout=(seconds)
@@ -107,7 +108,6 @@ class TCPClient
         buffered: @buffered,
         keep_alive: @keep_alive,
         reverse_lookup: @reverse_lookup,
-        timeout: @timeout,
         connect_timeout: @connect_timeout,
         read_timeout: @read_timeout,
         write_timeout: @write_timeout,

data/lib/tcp-client/deadline.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class TCPClient
+  class Deadline
+    MONOTONIC = !!defined?(Process::CLOCK_MONOTONIC)
+
+    def initialize(timeout)
+      timeout = timeout&.to_f
+      @deadline = timeout&.positive? ? now + timeout : 0
+    end
+
+    def valid?
+      @deadline != 0
+    end
+
+    def remaining_time
+      (@deadline != 0) && (remaining = @deadline - now) > 0 ? remaining : nil
+    end
+
+    private
+
+    if MONOTONIC
+      def now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    else
+      def now
+        ::Time.now
+      end
+    end
+  end
+end

data/lib/tcp-client/default_configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'configuration'
 
 class TCPClient

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module IOWithDeadlineMixin
   def self.included(mod)
     methods = mod.instance_methods
@@ -9,25 +11,22 @@ module IOWithDeadlineMixin
   end
 
   def read_with_deadline(bytes_to_read, deadline, exception)
-    raise(exception) if Time.now > deadline
+    raise(exception) unless deadline.remaining_time
     result = ''.b
-    return result if bytes_to_read <= 0
-    loop do
+    while result.bytesize < bytes_to_read
       read =
         with_deadline(deadline, exception) do
           read_nonblock(bytes_to_read - result.bytesize, exception: false)
         end
-      unless read
-        close
-        return result
-      end
-      result += read
-      return result if result.bytesize >= bytes_to_read
+      next result += read if read
+      close
+      break
     end
+    result
   end
 
   def write_with_deadline(data, deadline, exception)
-    raise(exception) if Time.now > deadline
+    raise(exception) unless deadline.remaining_time
     return 0 if (size = data.bytesize).zero?
     result = 0
     loop do
@@ -46,10 +45,10 @@ module IOWithDeadlineMixin
       loop do
         case ret = yield
         when :wait_writable
-          raise(exception) if (remaining_time = deadline - Time.now) <= 0
+          remaining_time = deadline.remaining_time or raise(exception)
           raise(exception) if wait_writable(remaining_time).nil?
         when :wait_readable
-          raise(exception) if (remaining_time = deadline - Time.now) <= 0
+          remaining_time = deadline.remaining_time or raise(exception)
           raise(exception) if wait_readable(remaining_time).nil?
         else
           return ret
@@ -65,10 +64,10 @@ module IOWithDeadlineMixin
       loop do
         case ret = yield
         when :wait_writable
-          raise(exception) if (remaining_time = deadline - Time.now) <= 0
+          remaining_time = deadline.remaining_time or raise(exception)
           raise(exception) if ::IO.select(nil, [self], nil, remaining_time).nil?
         when :wait_readable
-          raise(exception) if (remaining_time = deadline - Time.now) <= 0
+          remaining_time = deadline.remaining_time or raise(exception)
           raise(exception) if ::IO.select([self], nil, nil, remaining_time).nil?
         else
           return ret

data/lib/tcp-client/ssl_socket.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 begin
   require 'openssl'
 rescue LoadError
   return
 end
 
+require_relative 'deadline'
 require_relative 'mixin/io_with_deadline'
 
 class TCPClient
@@ -12,8 +15,8 @@ class TCPClient
 
     def initialize(socket, address, configuration, exception)
       ssl_params = Hash[configuration.ssl_params]
-      self.sync_close = true
       super(socket, create_context(ssl_params))
+      self.sync_close = true
       connect_to(
         address,
         ssl_params[:verify_mode] != OpenSSL::SSL::VERIFY_NONE,
@@ -32,13 +35,13 @@ class TCPClient
 
     def connect_to(address, check, timeout, exception)
       self.hostname = address.hostname
-      timeout = timeout.to_f
-      if timeout.zero?
-        connect
-      else
-        with_deadline(Time.now + timeout, exception) do
+      deadline = Deadline.new(timeout)
+      if deadline.valid?
+        with_deadline(deadline, exception) do
           connect_nonblock(exception: false)
         end
+      else
+        connect
       end
       post_connection_check(address.hostname) if check
     end

data/lib/tcp-client/tcp_socket.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'socket'
+require_relative 'deadline'
 require_relative 'mixin/io_with_deadline'
 
 class TCPClient
@@ -19,9 +22,9 @@ class TCPClient
           address.addrinfo.ip_port,
           address.addrinfo.ip_address
         )
-      timeout = timeout.to_f
-      return connect(addr) if timeout.zero?
-      with_deadline(Time.now + timeout, exception) do
+      deadline = Deadline.new(timeout)
+      return connect(addr) unless deadline.valid?
+      with_deadline(deadline, exception) do
         connect_nonblock(addr, exception: false)
       end
     end

data/lib/tcp-client/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class TCPClient
-  VERSION = '0.3.2'.freeze
+  VERSION = '0.4.0'
 end

data/rakefile.rb

@@ -11,7 +11,6 @@ CLOBBER << 'prj'
 task(:default) { exec('rake --tasks') }
 
 Rake::TestTask.new(:test) do |task|
-  task.test_files = FileList['test/**/*_test.rb']
-  task.ruby_opts = %w[-w]
-  task.verbose = true
+  task.pattern = 'test/**/*_test.rb'
+  task.warning = task.verbose = true
 end

data/sample/google.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../lib/tcp-client'
 
 TCPClient.configure(
@@ -6,15 +8,14 @@ TCPClient.configure(
   read_timeout: 0.5 # seconds to read some bytes
 )
 
-# the following request sequence is not allowed
-# to last longer than 1.25 seconds:
+# the following sequence is not allowed to last longer than 1.25 seconds:
 #   0.5 seconds to connect
 # + 0.25 seconds to write data
 # + 0.5 seconds to read a response
 
 TCPClient.open('www.google.com:80') do |client|
   # simple HTTP get request
-  pp client.write("GET / HTTP/1.1\r\nHost: google.com\r\n\r\n")
+  pp client.write("GET / HTTP/1.1\r\nHost: www.google.com\r\n\r\n")
 
   # read "HTTP/1.1 " + 3 byte HTTP status code
   pp client.read(12)

data/sample/google_ssl.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 require_relative '../lib/tcp-client'
 
 TCPClient.configure do |cfg|
-  cfg.connect_timeout = 1 # second to connect the server
+  cfg.connect_timeout = 1 # limit connect time the server to 1 second
   cfg.ssl_params = { ssl_version: :TLSv1_2 } # use TLS 1.2
 end
 
 TCPClient.open('www.google.com:443') do |client|
-  # query should not last longer than 0.5 seconds
+  # next sequence should not last longer than 0.5 seconds
   client.with_deadline(0.5) do
     # simple HTTP get request
-    pp client.write("GET / HTTP/1.1\r\nHost: google.com\r\n\r\n")
+    pp client.write("GET / HTTP/1.1\r\nHost: www.google.com\r\n\r\n")
 
     # read "HTTP/1.1 " + 3 byte HTTP status code
     pp client.read(12)

data/tcp-client.gemspec

@@ -11,11 +11,13 @@ GemSpec = Gem::Specification.new do |spec|
 
   spec.summary = 'A TCP client implementation with working timeout support.'
   spec.description = <<~DESCRIPTION
-    This gem implements a TCP client with (optional) SSL support. The
-    motivation of this project is the need to have a _really working_
-    easy to use client which can handle time limits correctly. Unlike
-    other implementations this client respects given/configurable time
-    limits for each method (`connect`, `read`, `write`).
+    This Gem implements a TCP client with (optional) SSL support.
+    It is an easy to use, versatile configurable client that can correctly
+    handle time limits.
+    Unlike other implementations, this client respects
+    predefined/configurable time limits for each method
+    (`connect`, `read`, `write`). Deadlines for a sequence of read/write
+    actions can also be monitored.
   DESCRIPTION
   spec.homepage = 'https://github.com/mblumtritt/tcp-client'
 

data/test/tcp-client/address_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class AddressTest < MiniTest::Test

data/test/tcp-client/configuration_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class ConfigurationTest < MiniTest::Test

data/test/tcp-client/deadline_test.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+
+class Deadlineest < MiniTest::Test
+  parallelize_me!
+
+  def test_validity
+    assert(TCPClient::Deadline.new(1).valid?)
+    assert(TCPClient::Deadline.new(0.0001).valid?)
+
+    refute(TCPClient::Deadline.new(0).valid?)
+    refute(TCPClient::Deadline.new(nil).valid?)
+  end
+
+  def test_remaining_time
+    assert(TCPClient::Deadline.new(1).remaining_time > 0)
+
+    assert_nil(TCPClient::Deadline.new(0).remaining_time)
+    assert_nil(TCPClient::Deadline.new(nil).remaining_time)
+
+    deadline = TCPClient::Deadline.new(0.2)
+    sleep(0.2)
+    assert_nil(deadline.remaining_time)
+  end
+end

data/test/tcp-client/version_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class VersionTest < MiniTest::Test

data/test/tcp_client_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class TCPClientTest < MiniTest::Test

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcp-client
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-11 00:00:00.000000000 Z
+date: 2021-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,11 +53,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |
-  This gem implements a TCP client with (optional) SSL support. The
-  motivation of this project is the need to have a _really working_
-  easy to use client which can handle time limits correctly. Unlike
-  other implementations this client respects given/configurable time
-  limits for each method (`connect`, `read`, `write`).
+  This Gem implements a TCP client with (optional) SSL support.
+  It is an easy to use, versatile configurable client that can correctly
+  handle time limits.
+  Unlike other implementations, this client respects
+  predefined/configurable time limits for each method
+  (`connect`, `read`, `write`). Deadlines for a sequence of read/write
+  actions can also be monitored.
 email:
 executables: []
 extensions: []
@@ -70,6 +72,7 @@ files:
 - lib/tcp-client.rb
 - lib/tcp-client/address.rb
 - lib/tcp-client/configuration.rb
+- lib/tcp-client/deadline.rb
 - lib/tcp-client/default_configuration.rb
 - lib/tcp-client/errors.rb
 - lib/tcp-client/mixin/io_with_deadline.rb
@@ -83,6 +86,7 @@ files:
 - tcp-client.gemspec
 - test/tcp-client/address_test.rb
 - test/tcp-client/configuration_test.rb
+- test/tcp-client/deadline_test.rb
 - test/tcp-client/default_configuration_test.rb
 - test/tcp-client/version_test.rb
 - test/tcp_client_test.rb
@@ -114,6 +118,7 @@ summary: A TCP client implementation with working timeout support.
 test_files:
 - test/tcp-client/address_test.rb
 - test/tcp-client/configuration_test.rb
+- test/tcp-client/deadline_test.rb
 - test/tcp-client/default_configuration_test.rb
 - test/tcp-client/version_test.rb
 - test/tcp_client_test.rb