tcp-client 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a5a96328918c653aaec2296d19a7434b65c8801f3a1132a152dcd66326bc9ce
-  data.tar.gz: 5add4cd9d2607a90522b14c04a8b9d60a27bcad30c0f56212aba5df6c5036ac9
+  metadata.gz: f139f1f90fcb6d8c32a0d0fab85b4c96eab70b2a08845e9cdb26c5de8acfd184
+  data.tar.gz: f703e1c0c6f5edb4d732284ba983e31820c1e116cff1329cb7458a642b4ec1af
 SHA512:
-  metadata.gz: 859acc902ed173236fac760ce2edbbda4353bf7fb438ecdb3856bdba3076a464a34f542458abc5b1fb2ec157b4f3ab007e0eb67123c551f1b6abedc6f810d978
-  data.tar.gz: 36b9c267842f00e2d6181d2523b84b776528b7d754fb4eb378fbdb4fc8d33fbb43ac7b9faf5ff613cf34c4687cc2eab74eaff04601fa72196efe3787d622dc7d
+  metadata.gz: a19cf4e0ba023fd6a52a7470d1304b6718250c1dc28b49cefa07dc6c1fca6c52d35797bd6e769a80cd9d96feba09d48ebfcbc45273b2718f2fea8fda1de6d749
+  data.tar.gz: 1e0444b2cf3169b4d3e31af9ea072f0c44a98c88983f8f657f7917e1d4ee7d245599d7a640183acbb7bcbded8a319f2eed677c4f3aca8bdd15138c04acd13895

data/lib/tcp-client.rb

@@ -15,7 +15,7 @@ class TCPClient
 
   class NotConnected < SocketError
     def self.raise!(which)
-      raise(self, format('client not connected - %s', which), caller(1))
+      raise(self, "client not connected - #{which}", caller(1))
     end
   end
 
@@ -25,11 +25,9 @@ class TCPClient
     addr = Address.new(addr)
     client = new
     client.connect(addr, configuration)
-    return yield(client) if block_given?
-    client, ret = nil, client
-    ret
+    block_given? ? yield(client) : client
   ensure
-    client.close if client
+    client&.close if block_given?
   end
 
   attr_reader :address
@@ -47,7 +45,9 @@ class TCPClient
     NoOpenSSL.raise! if configuration.ssl? && !defined?(SSLSocket)
     @address = Address.new(addr)
     @socket = TCPSocket.new(@address, configuration, Timeout)
-    @socket = SSLSocket.new(@socket, @address, configuration, Timeout) if configuration.ssl?
+    configuration.ssl? && @socket = SSLSocket.new(
+      @socket, @address, configuration, Timeout
+    )
     @write_timeout = configuration.write_timeout
     @read_timeout = configuration.read_timeout
     self
@@ -55,7 +55,7 @@ class TCPClient
 
   def close
     socket, @socket = @socket, nil
-    socket.close if socket
+    socket&.close
     self
   rescue IOError
     self
@@ -66,11 +66,13 @@ class TCPClient
   end
 
   def read(nbytes, timeout: @read_timeout)
-    closed? ? NotConnected.raise!(self) : @socket.read(nbytes, timeout: timeout, exception: Timeout)
+    NotConnected.raise!(self) if closed?
+    @socket.read(nbytes, timeout: timeout, exception: Timeout)
   end
 
   def write(*msg, timeout: @write_timeout)
-    closed? ? NotConnected.raise!(self) : @socket.write(*msg, timeout: timeout, exception: Timeout)
+    NotConnected.raise!(self) if closed?
+    @socket.write(*msg, timeout: timeout, exception: Timeout)
   end
 
   def flush

data/lib/tcp-client/configuration.rb

@@ -68,7 +68,7 @@ class TCPClient
     private
 
     def seconds(value)
-      value && value > 0 ? value : nil
+      value&.positive? ? value : nil
     end
   end
 end

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

@@ -3,7 +3,11 @@ IOTimeoutError = Class.new(IOError) unless defined?(IOTimeoutError)
 module IOTimeoutMixin
   def self.included(mod)
     im = mod.instance_methods
-    mod.include(im.index(:wait_writable) && im.index(:wait_readable) ? WithDeadlineMethods : WidthDeadlineIO)
+    if im.index(:wait_writable) && im.index(:wait_readable)
+      mod.include(DeadlineMethods)
+    else
+      mod.include(DeadlineIO)
+    end
   end
 
   def read(nbytes, timeout: nil, exception: IOTimeoutError)
@@ -11,7 +15,9 @@ module IOTimeoutMixin
     return read_all(nbytes){ |junk_size| super(junk_size) } if timeout <= 0
     deadline = Time.now + timeout
     read_all(nbytes) do |junk_size|
-      with_deadline(deadline, exception){ read_nonblock(junk_size, exception: false) }
+      with_deadline(deadline, exception) do
+        read_nonblock(junk_size, exception: false)
+      end
     end
   end
 
@@ -20,7 +26,9 @@ module IOTimeoutMixin
     return write_all(msgs.join){ |junk| super(junk) } if timeout <= 0
     deadline = Time.now + timeout
     write_all(msgs.join) do |junk|
-      with_deadline(deadline, exception){ write_nonblock(junk, exception: false) }
+      with_deadline(deadline, exception) do
+        write_nonblock(junk, exception: false)
+      end
     end
   end
 
@@ -50,18 +58,18 @@ module IOTimeoutMixin
     end
   end
 
-  module WithDeadlineMethods
+  module DeadlineMethods
     private
 
     def with_deadline(deadline, exclass)
       loop do
         case ret = yield
         when :wait_writable
-          remaining_time = deadline - Time.now
-          raise(exclass) if remaining_time <= 0 || wait_writable(remaining_time).nil?
+          raise(exclass) if (remaining_time = deadline - Time.now) <= 0
+          raise(exclass) if wait_writable(remaining_time).nil?
         when :wait_readable
-          remaining_time = deadline - Time.now
-          raise(exclass) if remaining_time <= 0 || wait_readable(remaining_time).nil?
+          raise(exclass) if (remaining_time = deadline - Time.now) <= 0
+          raise(exclass) if wait_readable(remaining_time).nil?
         else
           return ret
         end
@@ -69,18 +77,18 @@ module IOTimeoutMixin
     end
   end
 
-  module WidthDeadlineIO
+  module DeadlineIO
     private
 
     def with_deadline(deadline, exclass)
       loop do
         case ret = yield
         when :wait_writable
-          remaining_time = deadline - Time.now
-          raise(exclass) if remaining_time <= 0 || ::IO.select(nil, [self], nil, remaining_time).nil?
+          raise(exclass) if (remaining_time = deadline - Time.now) <= 0
+          raise(exclass) if ::IO.select(nil, [self], nil, remaining_time).nil?
         when :wait_readable
-          remaining_time = deadline - Time.now
-          raise(exclass) if remaining_time <= 0 || ::IO.select([self], nil, nil, remaining_time).nil?
+          raise(exclass) if (remaining_time = deadline - Time.now) <= 0
+          raise(exclass) if ::IO.select([self], nil, nil, remaining_time).nil?
         else
           return ret
         end
@@ -88,5 +96,5 @@ module IOTimeoutMixin
     end
   end
 
-  private_constant :WithDeadlineMethods, :WidthDeadlineIO
+  private_constant :DeadlineMethods, :DeadlineIO
 end

data/lib/tcp-client/ssl_socket.rb

@@ -31,7 +31,13 @@ class TCPClient
 
     def connect_to(address, check, timeout, exception)
       self.hostname = address.hostname
-      timeout ? with_deadline(Time.now + timeout, exception){ connect_nonblock(exception: false) } : connect
+      if timeout
+        with_deadline(Time.now + timeout, exception) do
+          connect_nonblock(exception: false)
+        end
+      else
+        connect
+      end
       post_connection_check(address.hostname) if check
     end
   end

data/lib/tcp-client/tcp_socket.rb

@@ -14,9 +14,13 @@ class TCPClient
     private
 
     def connect_to(address, timeout, exception)
-      addr = ::Socket.pack_sockaddr_in(address.addrinfo.ip_port, address.addrinfo.ip_address)
+      addr = ::Socket.pack_sockaddr_in(
+        address.addrinfo.ip_port, address.addrinfo.ip_address
+      )
       return connect(addr) unless timeout
-      with_deadline(Time.now + timeout, exception){ connect_nonblock(addr, exception: false) }
+      with_deadline(Time.now + timeout, exception) do
+        connect_nonblock(addr, exception: false)
+      end
     end
 
     def configure(configuration)

data/lib/tcp-client/version.rb

@@ -1,3 +1,3 @@
 class TCPClient
-  VERSION = '0.0.6'.freeze
+  VERSION = '0.0.8'.freeze
 end

data/rakefile.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
@@ -8,5 +10,5 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task :default do
-  exec('rake -T')
+  exec("#{$0} --tasks")
 end

data/tcp-client.gemspec

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require File.expand_path('../lib/tcp-client/version', __FILE__)
+require_relative './lib/tcp-client/version'
 
 GemSpec = Gem::Specification.new do |spec|
   spec.name = 'tcp-client'
   spec.version = TCPClient::VERSION
   spec.summary = 'A TCP client implementation with working timeout support.'
-  spec.description = <<~EOS
+  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`).
-  EOS
+  DESCRIPTION
   spec.author = 'Mike Blumtritt'
   spec.email = 'mike.blumtritt@invision.de'
   spec.homepage = 'https://github.com/mblumtritt/tcp-client'
@@ -20,12 +20,12 @@ GemSpec = Gem::Specification.new do |spec|
   spec.rubyforge_project = spec.name
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
 
   spec.platform = Gem::Platform::RUBY
-  spec.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
   spec.required_ruby_version = '>= 2.5.0'
+  spec.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
 
   spec.require_paths = %w[lib]
 
@@ -33,6 +33,5 @@ GemSpec = Gem::Specification.new do |spec|
   spec.test_files = all_files.grep(%r{^(spec|test)/})
   spec.files = all_files - spec.test_files
 
-  spec.has_rdoc = false
   spec.extra_rdoc_files = %w[README.md]
 end

data/test/tcp_client_test.rb

@@ -40,24 +40,30 @@ class TCPClientTest < Test
     end
   end
 
+  def with_dummy_server(port)
+    # this server will never receive or send any data
+    server = TCPServer.new('localhost', port)
+  ensure
+    server&.close
+  end
+
   def test_connected_state
-    server = TCPServer.new(1234)
-    TCPClient.open('localhost:1234', TCPClient::Configuration.new) do |subject|
-      refute(subject.closed?)
-      assert_equal('localhost:1234', subject.to_s)
-      refute_nil(subject.address)
-      address_when_opened = subject.address
-      assert_equal('localhost:1234', subject.address.to_s)
-      assert_equal('localhost', subject.address.hostname)
-      assert_instance_of(Addrinfo, subject.address.addrinfo)
-      assert_same(1234, subject.address.addrinfo.ip_port)
+    with_dummy_server(1234) do
+      TCPClient.open('localhost:1234') do |subject|
+        refute(subject.closed?)
+        assert_equal('localhost:1234', subject.to_s)
+        refute_nil(subject.address)
+        address_when_opened = subject.address
+        assert_equal('localhost:1234', subject.address.to_s)
+        assert_equal('localhost', subject.address.hostname)
+        assert_instance_of(Addrinfo, subject.address.addrinfo)
+        assert_same(1234, subject.address.addrinfo.ip_port)
 
-      subject.close
-      assert(subject.closed?)
-      assert_same(address_when_opened, subject.address)
+        subject.close
+        assert(subject.closed?)
+        assert_same(address_when_opened, subject.address)
+      end
     end
-  ensure
-    server.close if server
   end
 
   def check_read_write_timeout(addr, timeout)
@@ -66,7 +72,7 @@ class TCPClientTest < Test
       start_time = nil
       assert_raises(TCPClient::Timeout) do
         start_time = Time.now
-        # we need to send 1MB to avoid any TCP stack buffering
+        # send 1MB to avoid any TCP stack buffering
         subject.write('?' * (1024 * 1024), timeout: timeout)
       end
       assert_in_delta(timeout, Time.now - start_time, 0.02)
@@ -79,32 +85,30 @@ class TCPClientTest < Test
   end
 
   def test_read_write_timeout
-    server = TCPServer.new(1235) # this server will never read/write client data
-    [0.5, 1, 1.5].each do |timeout|
-      check_read_write_timeout(':1235', timeout)
+    with_dummy_server(1235) do
+      [0.5, 1, 1.5].each do |timeout|
+        check_read_write_timeout('localhost:1235', timeout)
+      end
     end
-  ensure
-    server.close if server
   end
 
-  def check_connect_timeout(addr, config, timeout)
+  def check_connect_timeout(addr, config)
     start_time = nil
     assert_raises(TCPClient::Timeout) do
       start_time = Time.now
       TCPClient.new.connect(addr, config)
     end
-    assert_in_delta(timeout, Time.now - start_time, 0.02)
+    assert_in_delta(config.connect_timeout, Time.now - start_time, 0.02)
   end
 
   def test_connect_ssl_timeout
-    server = TCPServer.new(1236)
-    config = TCPClient::Configuration.new
-    config.ssl = true
-    [0.5, 1, 1.5].each do |timeout|
-      config.timeout = timeout
-      check_connect_timeout('localhost:1236', config, timeout)
+    with_dummy_server(1236) do
+      config = TCPClient::Configuration.new
+      config.ssl = true
+      [0.5, 1, 1.5].each do |timeout|
+        config.timeout = timeout
+        check_connect_timeout('localhost:1236', config)
+      end
     end
-  ensure
-    server.close if server
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcp-client
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-21 00:00:00.000000000 Z
+date: 2018-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: tcp-client
-rubygems_version: 2.7.3
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A TCP client implementation with working timeout support.