tcp-client 0.3.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b265053761a87007b7de21c3a7a369b778f013ae726bb26220a4fd9aeeaf71c
-  data.tar.gz: 5a71b5dc86ed4ab9ef481e65c24aef0481c5e9d2c868f3f9975b801936d99691
+  metadata.gz: f36e18e6865766292ff44adf5cd46244e8944049f524553ba4168725454a2d0b
+  data.tar.gz: abd4ec63f48c1be4e73922aaed7702bdacebe398e6cda13887fcd2efaa62818c
 SHA512:
-  metadata.gz: d16d436959c3e1c29962a5c474de8db3b4638e2d99aaf66fe4046b22e8159298cc433e014b14d9c9b3e01cafff1052743cf90896c396d86e1ccfc87d689553da
-  data.tar.gz: 70f4ce83fd7c7c8aa4c066fb94e96ef62a5087c3f78e079cd473e8d45ab22e106eea7b3d7bf5965063fecb9b77c58b8548598f4a873d9480c5b501bc7854dea9
+  metadata.gz: 11b5302d3da2d0d46f35fb2370177916b1044b659b1f62bdbf0a30c39581844dd425487a6c94300b4a7afcf25eafef5828a6ef04cb0ff9bcae4fff01a9a312bb
+  data.tar.gz: 54b3505c1eb90565e0a80dab5c92a394883b74cf3bb975ed83df4c1affbad15e9acbfcee7ec3d0a5bb79c1486fa46fbfbd958fc9e43106b9a97dc22411c84335

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2017-2021, Mike Blumtritt. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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/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,
@@ -38,7 +37,7 @@ class TCPClient
 
     def initialize_copy(_org)
       super
-      @ssl_params = @ssl_params.dup
+      @ssl_params = Hash[@ssl_params] if @ssl_params
       self
     end
 
@@ -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
+          Hash[value]
+        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) ? true : false
+
+    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/errors.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require 'socket'
-
 class TCPClient
   class NoOpenSSL < RuntimeError
     def initialize
-      super('OpenSSL is not avail')
+      super('OpenSSL is not available')
     end
   end
 
@@ -29,7 +27,7 @@ class TCPClient
 
   class NotAnException < TypeError
     def initialize(object)
-      super("not a valid exception class - #{object.inspect}")
+      super("exception class required - #{object.inspect}")
     end
   end
 

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,46 +1,39 @@
+# frozen_string_literal: true
+
 begin
   require 'openssl'
 rescue LoadError
   return
 end
 
+require_relative 'deadline'
 require_relative 'mixin/io_with_deadline'
 
 class TCPClient
   class SSLSocket < ::OpenSSL::SSL::SSLSocket
     include IOWithDeadlineMixin
 
-    def initialize(socket, address, configuration, exception)
+    def initialize(socket, address, configuration, deadline, exception)
       ssl_params = Hash[configuration.ssl_params]
-      self.sync_close = true
       super(socket, create_context(ssl_params))
-      connect_to(
-        address,
-        ssl_params[:verify_mode] != OpenSSL::SSL::VERIFY_NONE,
-        configuration.connect_timeout,
-        exception
-      )
+      self.sync_close = true
+      self.hostname = address.hostname
+      deadline.valid? ? connect_with_deadline(deadline, exception) : connect
+      post_connection_check(address.hostname) if should_verify?(ssl_params)
     end
 
     private
 
     def create_context(ssl_params)
-      context = OpenSSL::SSL::SSLContext.new
-      context.set_params(ssl_params)
-      context
+      OpenSSL::SSL::SSLContext.new.tap { |ctx| ctx.set_params(ssl_params) }
     end
 
-    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
-          connect_nonblock(exception: false)
-        end
-      end
-      post_connection_check(address.hostname) if check
+    def connect_with_deadline(deadline, exception)
+      with_deadline(deadline, exception) { connect_nonblock(exception: false) }
+    end
+
+    def should_verify?(ssl_params)
+      ssl_params[:verify_mode] != OpenSSL::SSL::VERIFY_NONE
     end
   end
 

data/lib/tcp-client/tcp_socket.rb

@@ -1,27 +1,29 @@
+# frozen_string_literal: true
+
 require 'socket'
+require_relative 'deadline'
 require_relative 'mixin/io_with_deadline'
 
 class TCPClient
   class TCPSocket < ::Socket
     include IOWithDeadlineMixin
 
-    def initialize(address, configuration, exception)
+    def initialize(address, configuration, deadline, exception)
       super(address.addrinfo.ipv6? ? :INET6 : :INET, :STREAM)
       configure(configuration)
-      connect_to(address, configuration.connect_timeout, exception)
+      connect_to(as_addr_in(address), deadline, exception)
     end
 
     private
 
-    def connect_to(address, timeout, exception)
-      addr =
-        ::Socket.pack_sockaddr_in(
-          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
+    def as_addr_in(address)
+      addrinfo = address.addrinfo
+      ::Socket.pack_sockaddr_in(addrinfo.ip_port, addrinfo.ip_address)
+    end
+
+    def connect_to(addr, deadline, exception)
+      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.5.1'
 end

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'
@@ -9,33 +10,33 @@ require_relative 'tcp-client/default_configuration'
 require_relative 'tcp-client/version'
 
 class TCPClient
-  def self.open(addr, configuration = Configuration.default)
+  def self.open(address, configuration = Configuration.default)
     client = new
-    client.connect(Address.new(addr), configuration)
-    block_given? ? yield(client) : client
-  ensure
-    client&.close if block_given?
+    client.connect(Address.new(address), configuration)
+    return client unless block_given?
+    begin
+      yield(client)
+    ensure
+      client.close
+    end
   end
 
-  attr_reader :address
+  attr_reader :address, :configuration
 
   def initialize
-    @socket = @address = @deadline = @cfg = nil
+    @socket = @address = @deadline = @configuration = nil
   end
 
   def to_s
-    @address ? @address.to_s : ''
+    @address&.to_s || ''
   end
 
-  def connect(addr, configuration, exception: nil)
-    close
+  def connect(address, configuration, exception: nil)
     raise(NoOpenSSL) if configuration.ssl? && !defined?(SSLSocket)
-    @address = Address.new(addr)
-    @cfg = configuration.dup
-    exception ||= configuration.connect_timeout_error
-    @socket = TCPSocket.new(@address, @cfg, exception)
-    @cfg.ssl? &&
-      @socket = SSLSocket.new(@socket, @address, configuration, exception)
+    close
+    @address = Address.new(address)
+    @configuration = configuration.dup.freeze
+    @socket = create_socket(exception)
     self
   end
 
@@ -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 || @configuration.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 || @configuration.read_timeout)
+    return @socket.write(*msg) unless deadline.valid?
+    write_with_deadline(msg, deadline, exception)
   end
 
   def flush
@@ -88,16 +88,21 @@ class TCPClient
 
   private
 
+  def create_socket(exception)
+    exception ||= @configuration.connect_timeout_error
+    deadline = Deadline.new(@configuration.connect_timeout)
+    @socket = TCPSocket.new(@address, @configuration, deadline, exception)
+    return @socket unless @configuration.ssl?
+    SSLSocket.new(@socket, @address, @configuration, deadline, exception)
+  end
+
   def read_with_deadline(nbytes, deadline, exception)
-    @socket.read_with_deadline(
-      nbytes,
-      deadline,
-      exception || @cfg.read_timeout_error
-    )
+    exception ||= @configuration.read_timeout_error
+    @socket.read_with_deadline(nbytes, deadline, exception)
   end
 
   def write_with_deadline(msg, deadline, exception)
-    exception ||= @cfg.write_timeout_error
+    exception ||= @configuration.write_timeout_error
     msg.sum do |chunk|
       @socket.write_with_deadline(chunk.b, deadline, exception)
     end

data/lib/tcp_client.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'tcp-client'

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

@@ -2,7 +2,7 @@
 
 require_relative './lib/tcp-client/version'
 
-GemSpec = Gem::Specification.new do |spec|
+Gem::Specification.new do |spec|
   spec.name = 'tcp-client'
   spec.version = TCPClient::VERSION
   spec.author = 'Mike Blumtritt'
@@ -11,16 +11,20 @@ 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'
+  spec.license = 'BSD-3-Clause'
 
   spec.metadata['source_code_uri'] = 'https://github.com/mblumtritt/tcp-client'
-  spec.metadata['bug_tracker_uri'] = 'https://github.com/mblumtritt/tcp-client/issues'
+  spec.metadata['bug_tracker_uri'] =
+    'https://github.com/mblumtritt/tcp-client/issues'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'minitest'
@@ -30,5 +34,5 @@ GemSpec = Gem::Specification.new do |spec|
   spec.test_files = all_files.grep(%r{^test/})
   spec.files = all_files - spec.test_files
 
-  spec.extra_rdoc_files = %w[README.md]
+  spec.extra_rdoc_files = %w[README.md LICENSE]
 end

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.5.1
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-11 00:00:00.000000000 Z
+date: 2021-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,23 +53,28 @@ 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: []
 extra_rdoc_files:
 - README.md
+- LICENSE
 files:
 - ".gitignore"
+- LICENSE
 - README.md
 - gems.rb
 - 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,12 +88,14 @@ 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
 - test/test_helper.rb
 homepage: https://github.com/mblumtritt/tcp-client
-licenses: []
+licenses:
+- BSD-3-Clause
 metadata:
   source_code_uri: https://github.com/mblumtritt/tcp-client
   bug_tracker_uri: https://github.com/mblumtritt/tcp-client/issues
@@ -114,6 +121,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