tcp-client 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc62bca2078a00db24dc861aa876a6e2acac79dd1f2eb0cafbd29840d5169704
-  data.tar.gz: c784e00a152bcf7ac5c1246517483a39f55beb3f7591881be58a4edeb847097e
+  metadata.gz: a122629b36ac22b95c2ee7ed0d520391cfc00136982e9c0c4a8c7d0ea4dd5b47
+  data.tar.gz: a63612520461f6d84abffbe71c750158b2d7d0c5227d4ae9de16b9cac5071540
 SHA512:
-  metadata.gz: 77ff9adf39b16aab0ca83cd77c01f688a77efd675c287095e5b67c1b52f89cf0528ddbc0a1c206330703cf430c4f457ddbdcb369f5a0a8f57a6c143ee5266f7e
-  data.tar.gz: 27df4b59116a68cf8232f471214e305d74f650b4e1be6cbd59302660f8d2998beef1fd7c382079311f9139c3465bda20981f3ff0993659f74807c00bb3942959
+  metadata.gz: 31d0760aa3f16564d171ba27dc0c3a919490356319265aa099762ef7f1e9ff57a20e968315d0d70beb291d62405040e01ec76aa4dfd78a229f3d91c0a7db029b
+  data.tar.gz: 265a8cda03d5c8f62138311f05a40756dd7e052c8b55d6e43412b3cf51dcea91e98c6ba38943bedf4b41de7af6b0d3dc86700197f7eafd4919093abd59d15351

data/README.md

@@ -12,22 +12,18 @@ require 'tcp-client'
 
 TCPClient.configure do |cfg|
   cfg.connect_timeout = 1 # second to connect the server
-  cfg.write_timeout = 0.25 # seconds to write a single data junk
-  cfg.read_timeout = 0.5 # seconds to read some bytes
   cfg.ssl_params = { ssl_version: :TLSv1_2 } # use TLS 1.2
 end
 
-# the following request sequence is not allowed to last longer than 2 seconds:
-# 1 second to connect (incl. SSL handshake etc.)
-# + 0.25 seconds to write data
-# + 0.5 seconds to read a response
-
 TCPClient.open('www.google.com:443') do |client|
-  # simple HTTP get request
-  pp client.write("GET / HTTP/1.1\r\nHost: google.com\r\n\r\n")
-
-  # read "HTTP/1.1 " + 3 byte HTTP status code
-  pp client.read(12)
+  # query 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")
+
+    # read "HTTP/1.1 " + 3 byte HTTP status code
+    pp client.read(12)
+  end
 end
 ```
 

data/lib/tcp-client.rb

@@ -41,20 +41,20 @@ class TCPClient
 
   def initialize
     @socket = @address = @write_timeout = @read_timeout = nil
+    @deadline = nil
   end
 
   def to_s
     @address ? @address.to_s : ''
   end
 
-  def connect(addr, configuration)
+  def connect(addr, configuration, exception: ConnectTimeoutError)
     close
     NoOpenSSL.raise! if configuration.ssl? && !defined?(SSLSocket)
     @address = Address.new(addr)
-    @socket = TCPSocket.new(@address, configuration, ConnectTimeoutError)
+    @socket = TCPSocket.new(@address, configuration, exception)
     configuration.ssl? &&
-      @socket =
-        SSLSocket.new(@socket, @address, configuration, ConnectTimeoutError)
+      @socket = SSLSocket.new(@socket, @address, configuration, exception)
     @write_timeout = configuration.write_timeout
     @read_timeout = configuration.read_timeout
     self
@@ -66,24 +66,47 @@ class TCPClient
     self
   rescue IOError
     self
+  ensure
+    @deadline = nil
   end
 
   def closed?
     @socket.nil? || @socket.closed?
   end
 
-  def read(nbytes, timeout: @read_timeout)
+  def with_deadline(timeout)
+    raise('no block given') unless block_given?
+    raise('deadline already used') if @deadline
+    tm = timeout&.to_f
+    raise(ArgumentError, "invalid deadline - #{timeout}") unless tm.positive?
+    @deadline = Time.now + tm
+    yield(self)
+  ensure
+    @deadline = nil
+  end
+
+  def read(nbytes, timeout: nil, exception: ReadTimeoutError)
     NotConnected.raise!(self) if closed?
-    @socket.read(nbytes, timeout: timeout, exception: ReadTimeoutError)
+    time = timeout || remaining_time(exception) || @read_timeout
+    @socket.read(nbytes, timeout: time, exception: exception)
   end
 
-  def write(*msg, timeout: @write_timeout)
+  def write(*msg, timeout: nil, exception: WriteTimeoutError)
     NotConnected.raise!(self) if closed?
-    @socket.write(*msg, timeout: timeout, exception: WriteTimeoutError)
+    time = timeout || remaining_time(exception) || @write_timeout
+    @socket.write(*msg, timeout: time, exception: exception)
   end
 
   def flush
     @socket.flush unless closed?
     self
   end
+
+  private
+
+  def remaining_time(exception)
+    return unless @deadline
+    remaining_time = @deadline - Time.now
+    0 < remaining_time ? remaining_time : raise(exception)
+  end
 end

data/lib/tcp-client/address.rb

@@ -26,7 +26,7 @@ class TCPClient
     end
 
     def to_h
-      {host: @hostname, port: @addrinfo.ip_port}
+      { host: @hostname, port: @addrinfo.ip_port }
     end
 
     def ==(other)

data/lib/tcp-client/version.rb

@@ -1,3 +1,3 @@
 class TCPClient
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.4'.freeze
 end

data/sample/google_ssl.rb

@@ -2,20 +2,16 @@ require_relative '../lib/tcp-client'
 
 TCPClient.configure do |cfg|
   cfg.connect_timeout = 1 # second to connect the server
-  cfg.write_timeout = 0.25 # seconds to write a single data junk
-  cfg.read_timeout = 0.5 # seconds to read some bytes
   cfg.ssl_params = { ssl_version: :TLSv1_2 } # use TLS 1.2
 end
 
-# the following request sequence is not allowed to last longer than 2 seconds:
-# 1 second to connect (incl. SSL handshake etc.)
-# + 0.25 seconds to write data
-# + 0.5 seconds to read a response
-
 TCPClient.open('www.google.com:443') do |client|
-  # simple HTTP get request
-  pp client.write("GET / HTTP/1.1\r\nHost: google.com\r\n\r\n")
+  # query 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")
 
-  # read "HTTP/1.1 " + 3 byte HTTP status code
-  pp client.read(12)
+    # read "HTTP/1.1 " + 3 byte HTTP status code
+    pp client.read(12)
+  end
 end

data/test/tcp-client/address_test.rb

@@ -62,5 +62,4 @@ class AddressTest < MiniTest::Test
     assert(a == b)
     assert(a === b)
   end
-
 end

data/test/tcp_client_test.rb

@@ -3,6 +3,8 @@ require_relative 'test_helper'
 class TCPClientTest < MiniTest::Test
   parallelize_me!
 
+  HUGE_AMOUNT_OF_DATA = Array.new(2024, '?' * 1024).freeze
+
   attr_reader :config
 
   def setup
@@ -65,7 +67,7 @@ class TCPClientTest < MiniTest::Test
         start_time = Time.now
         subject.read(42, timeout: timeout)
       end
-      assert_in_delta(timeout, Time.now - start_time, 0.02)
+      assert_in_delta(timeout, Time.now - start_time, 0.11)
     end
   end
 
@@ -81,27 +83,63 @@ class TCPClientTest < MiniTest::Test
       start_time = nil
       assert_raises(TCPClient::WriteTimeoutError) do
         start_time = Time.now
-
-        # send 1MB to avoid any TCP stack buffering
-        args = Array.new(2024, '?' * 1024)
-        subject.write(*args, timeout: timeout)
+        subject.write(*HUGE_AMOUNT_OF_DATA, timeout: timeout)
       end
       assert_in_delta(timeout, Time.now - start_time, 0.02)
     end
   end
 
   def test_write_timeout
-    check_write_timeout(0.1)
+    check_write_timeout(0.01)
     check_write_timeout(0.25)
   end
 
+  def test_write_deadline
+    TCPClient.open('localhost:1234', config) do |subject|
+      refute(subject.closed?)
+      assert_raises(TCPClient::WriteTimeoutError) do
+        subject.with_deadline(0.25) do |*args|
+          assert_equal([subject], args)
+          loop { subject.write('some data here') }
+        end
+      end
+    end
+  end
+
+  def test_read_deadline
+    TCPClient.open('localhost:1234', config) do |subject|
+      refute(subject.closed?)
+      assert_raises(TCPClient::ReadTimeoutError) do
+        subject.with_deadline(0.25) do |*args|
+          assert_equal([subject], args)
+          loop { subject.read(0) }
+        end
+      end
+    end
+  end
+
+  def test_read_write_deadline
+    TCPClient.open('localhost:1234', config) do |subject|
+      refute(subject.closed?)
+      assert_raises(TCPClient::TimeoutError) do
+        subject.with_deadline(0.25) do |*args|
+          assert_equal([subject], args)
+          loop do
+            subject.write('HUGE_AMOUNT_OF_DATA')
+            subject.read(0)
+          end
+        end
+      end
+    end
+  end
+
   def check_connect_timeout(ssl_config)
     start_time = nil
     assert_raises(TCPClient::ConnectTimeoutError) do
       start_time = Time.now
       TCPClient.new.connect('localhost:1234', ssl_config)
     end
-    assert_in_delta(ssl_config.connect_timeout, Time.now - start_time, 0.02)
+    assert_in_delta(ssl_config.connect_timeout, Time.now - start_time, 0.11)
   end
 
   def test_connect_ssl_timeout

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tcp-client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Mike Blumtritt