tcp-client 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a9fe010bf08d26652d93212beee9ffe55275b3b051809a3093d2ff066719372
-  data.tar.gz: bf23f4441be6f32d581dfb069afb09bfbb8a9ca78b90f3e0f2332f16abed89e8
+  metadata.gz: b3222937127a374a29b4f69d84a1e45d78ccc74bffee2ed05d849782385c5402
+  data.tar.gz: 8a56cb5574794f4bbf0f5fcb1f91fbbdc033120eefc86604f881322ddfeedf44
 SHA512:
-  metadata.gz: c929de839e7335c4e8e950d0b96fb6028c74ba1ae6a1acec3bb4a572e54a6564d799a8ee8fdef51b77273a83a2af4c5cc29d66a4ed92c3647e1185e103d82fda
-  data.tar.gz: 00dacdc8d09584e1f4421c7ca62786ab617eaed1005db955ca36da4c1294738591820159d282d27e24fe3194d84e9cd5cb02b47966f231af5d5a26336bcfa366
+  metadata.gz: a096f6f5d41be9f63e5018f014aced375ab5e4574a7ea165bd006be23a9246264fcf77269f6be4335ee6f930794b1ef3332e08ccd580d54601eef2468bdf282d
+  data.tar.gz: ee8edc735c7de68b28688043c8bf6d2715f177941c4e14f4bb742a91c1fc8edf4d47d3c5273379d4f0ec029418506dc3e52f3bbacfbff6cc4466fe7d22bf40f5

data/lib/tcp-client/deadline.rb

@@ -2,7 +2,7 @@
 
 class TCPClient
   class Deadline
-    MONOTONIC = !!defined?(Process::CLOCK_MONOTONIC)
+    MONOTONIC = defined?(Process::CLOCK_MONOTONIC) ? true : false
 
     def initialize(timeout)
       timeout = timeout&.to_f

data/lib/tcp-client/ssl_socket.rb

@@ -13,12 +13,11 @@ 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]
       super(socket, create_context(ssl_params))
       self.sync_close = true
       self.hostname = address.hostname
-      deadline = Deadline.new(configuration.connect_timeout)
       deadline.valid? ? connect_with_deadline(deadline, exception) : connect
       post_connection_check(address.hostname) if should_verify?(ssl_params)
     end
@@ -26,9 +25,7 @@ class TCPClient
     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_with_deadline(deadline, exception)

data/lib/tcp-client/tcp_socket.rb

@@ -8,21 +8,20 @@ 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)
-      deadline = Deadline.new(configuration.connect_timeout)
-      connect_to(address, deadline, exception)
+      connect_to(as_addr_in(address), deadline, exception)
     end
 
     private
 
-    def connect_to(address, deadline, exception)
-      addr =
-        ::Socket.pack_sockaddr_in(
-          address.addrinfo.ip_port,
-          address.addrinfo.ip_address
-        )
+    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)

data/lib/tcp-client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class TCPClient
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/lib/tcp-client.rb

@@ -10,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)
+  def connect(address, configuration, exception: nil)
     raise(NoOpenSSL) if configuration.ssl? && !defined?(SSLSocket)
     close
-    @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)
+    @address = Address.new(address)
+    @configuration = configuration.dup.freeze
+    @socket = create_socket(exception)
     self
   end
 
@@ -67,7 +67,7 @@ class TCPClient
     raise(NotConnected) if closed?
     timeout.nil? && @deadline and
       return read_with_deadline(nbytes, @deadline, exception)
-    deadline = Deadline.new(timeout || @cfg.read_timeout)
+    deadline = Deadline.new(timeout || @configuration.read_timeout)
     return @socket.read(nbytes) unless deadline.valid?
     read_with_deadline(nbytes, deadline, exception)
   end
@@ -76,7 +76,7 @@ class TCPClient
     raise(NotConnected) if closed?
     timeout.nil? && @deadline and
       return write_with_deadline(msg, @deadline, exception)
-    deadline = Deadline.new(timeout || @cfg.read_timeout)
+    deadline = Deadline.new(timeout || @configuration.read_timeout)
     return @socket.write(*msg) unless deadline.valid?
     write_with_deadline(msg, deadline, exception)
   end
@@ -88,13 +88,31 @@ 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)
+    @configuration.ssl? ? as_ssl_socket(socket, deadline, exception) : socket
+  end
+
+  def as_ssl_socket(socket, deadline, exception)
+    SSLSocket.new(socket, @address, @configuration, deadline, exception)
+  rescue StandardError => e
+    begin
+      socket.close
+    rescue IOError
+      # ignore!
+    end
+    raise(e, cause: e.cause)
+  end
+
   def read_with_deadline(nbytes, deadline, exception)
-    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/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'
@@ -20,9 +20,11 @@ GemSpec = Gem::Specification.new do |spec|
     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'
@@ -32,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcp-client
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-01 00:00:00.000000000 Z
+date: 2021-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,6 +65,7 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
+- LICENSE
 files:
 - ".gitignore"
 - LICENSE
@@ -93,7 +94,8 @@ files:
 - 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
@@ -112,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: A TCP client implementation with working timeout support.