tcp-client 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fc5d1bf109cf729758affe093ed44313d0e688c9c0098bf671f9c8e1250118c
-  data.tar.gz: 185ea5d345ecd2cceecafe6d19179a68919429df7269c5088bd89032749d6db3
+  metadata.gz: b9cfd60cce36d13e734e17197f76d5d887eae87f9b4ec08ef00a43d6ea5d8d5a
+  data.tar.gz: ff17c9f4cb54ae7a6d00d888c34e45077b17c8225e26d1695854587ecb01f3dc
 SHA512:
-  metadata.gz: b34d0fef41cafa8d915ed203a5a4a934f22d2ee37fbe4a1f992bef6278f3ebfb7715ff7b4672e01af98c81d7a39eb7d057d79499b41248db44cf4de730240b1d
-  data.tar.gz: 5125d264eb11b6c5358df65525ad8ac9806f69d4e3f5bccd3dc775a36ae1f49c6c3b3cb97b410e09bdc214275a3b95b0f576c3a52db77f79ef610203e29fabd9
+  metadata.gz: d2c03a28cc57eba3b3468ed911ac24bb7a24279bbe80d6ddea6fca8a65848b5079c409d968599348476e041e04ff891196a90014ce5cee19e5204fdfad78ed15
+  data.tar.gz: 68551bdbc6e978368cf615c2d68d078ceb20b8857fdd6451efba921efdf37bc25732e366d246126bb42006bffa50fa60540f30b3390f635080c99116b296f575

data/README.md

@@ -45,27 +45,19 @@ For more samples see [the examples dir](./examples)
 
 ## Installation
 
-Use [Bundler](http://gembundler.com/) to add TCPClient in your own project:
-
-Include in your `Gemfile`:
-
-```ruby
-gem 'tcp-client'
-```
-
-and install it by running Bundler:
+You can install the gem in your system with
 
 ```shell
-bundle
+gem install tcp-client
 ```
 
-To install the gem globally use:
+You can use [Bundler](http://gembundler.com/) to add TCPClient to your own project:
 
 ```shell
-gem install tcp-client
+bundle add 'tcp-client'
 ```
 
-After that you need only a single line of code in your project to have it on board:
+After that you only need one line of code to have everything together
 
 ```ruby
 require 'tcp-client'

data/lib/tcp-client/address.rb

@@ -19,7 +19,7 @@ class TCPClient
     # @return [Addrinfo] the address info
     #
     def addrinfo
-      freeze if @addrinfo.nil?
+      freeze unless @addrinfo
       @addrinfo
     end
 
@@ -28,7 +28,7 @@ class TCPClient
     # @return [String] the host name
     #
     def host
-      freeze if @host.nil?
+      freeze unless @host
       @host
     end
     alias hostname host
@@ -37,9 +37,7 @@ class TCPClient
     # @attribute [r] port
     # @return [Integer] the port number
     #
-    def port
-      addrinfo.ip_port
-    end
+    def port = addrinfo.ip_port
 
     #
     # Initializes an address
@@ -73,18 +71,14 @@ class TCPClient
     #
     #   @param port [Integer] the addressed port
     #
-    def initialize(addr)
-      @addr = addr
-    end
+    def initialize(addr) = (@addr = addr)
 
     #
     # Convert `self` to a Hash containing host and port attribute.
     #
     # @return [Hash] host and port
     #
-    def to_hash
-      { host: host, port: port }
-    end
+    def to_hash = { host: host, port: port }
 
     #
     # Convert `self` to a Hash containing host and port attribute.
@@ -93,16 +87,12 @@ class TCPClient
     # @overload to_h(&block)
     # @return [Hash] host and port
     #
-    def to_h(&block)
-      block ? to_hash.to_h(&block) : to_hash
-    end
+    def to_h(&block) = block ? to_hash.to_h(&block) : to_hash
 
     #
     # @return [String] text representation of self as "host:port"
     #
-    def to_s
-      host.index(':') ? "[#{host}]:#{port}" : "#{host}:#{port}"
-    end
+    def to_s = host.index(':') ? "[#{host}]:#{port}" : "#{host}:#{port}"
 
     #
     # Force the address resolution and prevents further modifications of itself.
@@ -114,20 +104,15 @@ class TCPClient
       solve
       @addrinfo.freeze
       @host.freeze
-      @addr = nil
       super
     end
 
     # @!visibility private
-    def ==(other)
-      to_hash == other.to_h
-    end
+    def ==(other) = to_hash == other.to_h
     alias eql? ==
 
     # @!visibility private
-    def equal?(other)
-      self.class == other.class && self == other
-    end
+    def equal?(other) = self.class == other.class && self == other
 
     private
 
@@ -142,6 +127,7 @@ class TCPClient
       else
         from_string(@addr)
       end
+      @addr = nil
     end
 
     def from_self_class(address)
@@ -154,14 +140,13 @@ class TCPClient
     end
 
     def from_addrinfo(addrinfo)
-      @host = addrinfo.getnameinfo(Socket::NI_NUMERICSERV).first
-      @addrinfo = addrinfo
+      @host = (@addrinfo = addrinfo).getnameinfo(Socket::NI_NUMERICSERV).first
     end
 
     def from_string(str)
       @host, port = host_n_port(str.to_s)
-      return @addrinfo = Addrinfo.tcp(@host, port) if @host
-      from_addrinfo(Addrinfo.tcp(nil, port))
+      @addrinfo = Addrinfo.tcp(@host, port)
+      @host ||= @addrinfo.getnameinfo(Socket::NI_NUMERICSERV).first
     end
 
     def host_n_port(str)

data/lib/tcp-client/configuration.rb

@@ -93,9 +93,7 @@ class TCPClient
     # @!parse attr_reader :ssl?
     # @return [Boolean] whether SSL is configured, see {#ssl_params}
     #
-    def ssl?
-      @ssl_params ? true : false
-    end
+    def ssl? = @ssl_params ? true : false
 
     #
     # Parameters used to initialize a SSL context. SSL/TLS will only be used if
@@ -111,7 +109,7 @@ class TCPClient
         if value.respond_to?(:to_hash)
           Hash[value.to_hash]
         elsif value.respond_to?(:to_h)
-          value.nil? ? nil : Hash[value.to_h]
+          value.nil? ? nil : value.to_h.dup
         else
           value ? {} : nil
         end
@@ -133,7 +131,7 @@ class TCPClient
     attr_reader :connect_timeout
 
     def connect_timeout=(value)
-      @connect_timeout = seconds(value)
+      @connect_timeout = as_seconds(value)
     end
 
     #
@@ -146,8 +144,7 @@ class TCPClient
     attr_reader :connect_timeout_error
 
     def connect_timeout_error=(value)
-      raise(NotAnExceptionError, value) unless exception_class?(value)
-      @connect_timeout_error = value
+      @connect_timeout_error = as_exception(value)
     end
 
     #
@@ -161,7 +158,7 @@ class TCPClient
     attr_reader :read_timeout
 
     def read_timeout=(value)
-      @read_timeout = seconds(value)
+      @read_timeout = as_seconds(value)
     end
 
     #
@@ -174,8 +171,7 @@ class TCPClient
     attr_reader :read_timeout_error
 
     def read_timeout_error=(value)
-      raise(NotAnExceptionError, value) unless exception_class?(value)
-      @read_timeout_error = value
+      @read_timeout_error = as_exception(value)
     end
 
     #
@@ -189,7 +185,7 @@ class TCPClient
     attr_reader :write_timeout
 
     def write_timeout=(value)
-      @write_timeout = seconds(value)
+      @write_timeout = as_seconds(value)
     end
 
     #
@@ -202,8 +198,7 @@ class TCPClient
     attr_reader :write_timeout_error
 
     def write_timeout_error=(value)
-      raise(NotAnExceptionError, value) unless exception_class?(value)
-      @write_timeout_error = value
+      @write_timeout_error = as_exception(value)
     end
 
     #
@@ -218,7 +213,7 @@ class TCPClient
     # @see #write_timeout
     #
     def timeout=(value)
-      @connect_timeout = @write_timeout = @read_timeout = seconds(value)
+      @connect_timeout = @write_timeout = @read_timeout = as_seconds(value)
     end
 
     #
@@ -235,9 +230,8 @@ class TCPClient
     # @see #write_timeout_error
     #
     def timeout_error=(value)
-      raise(NotAnExceptionError, value) unless exception_class?(value)
       @connect_timeout_error =
-        @read_timeout_error = @write_timeout_error = value
+        @read_timeout_error = @write_timeout_error = as_exception(value)
     end
 
     # @!endgroup
@@ -291,9 +285,7 @@ class TCPClient
     #
     # @see #configure
     #
-    def to_h(&block)
-      block ? to_hash.to_h(&block) : to_hash
-    end
+    def to_h(&block) = block ? to_hash.to_h(&block) : to_hash
 
     #
     # Configures the instance with given options Hash.
@@ -318,7 +310,7 @@ class TCPClient
     # @return [Configuration] self
     #
     def configure(options)
-      options.each_pair { |attribute, value| set(attribute, value) }
+      options.each_pair { set(*_1) }
       self
     end
 
@@ -336,30 +328,25 @@ class TCPClient
     end
 
     # @!visibility private
-    def ==(other)
-      to_hash == other.to_h
-    end
+    def ==(other) = to_hash == other.to_h
     alias eql? ==
 
     # @!visibility private
-    def equal?(other)
-      self.class == other.class && self == other
-    end
+    def equal?(other) = self.class == other.class && to_hash == other.to_hash
 
     private
 
-    def exception_class?(value)
-      value.is_a?(Class) && value < Exception
+    def as_seconds(value) = value&.to_f&.positive? ? value : nil
+
+    def as_exception(value)
+      return value if value.is_a?(Class) && value < Exception
+      raise(NotAnExceptionError, value, caller(2))
     end
 
     def set(attribute, value)
       public_send("#{attribute}=", value)
     rescue NoMethodError
-      raise(UnknownAttributeError, attribute)
-    end
-
-    def seconds(value)
-      value&.to_f&.positive? ? value : nil
+      raise(UnknownAttributeError, attribute, caller(2))
     end
   end
 end

data/lib/tcp-client/deadline.rb

@@ -7,9 +7,7 @@ class TCPClient
       @deadline = timeout&.positive? ? now + timeout : nil
     end
 
-    def valid?
-      !@deadline.nil?
-    end
+    def valid? = !@deadline.nil?
 
     def remaining_time
       @deadline && (remaining = @deadline - now) > 0 ? remaining : nil
@@ -18,13 +16,9 @@ class TCPClient
     private
 
     if defined?(Process::CLOCK_MONOTONIC)
-      def now
-        Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      end
+      def now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
     else
-      def now
-        ::Time.now
-      end
+      def now = ::Time.now
     end
   end
 

data/lib/tcp-client/default_configuration.rb

@@ -37,19 +37,15 @@ class TCPClient
   end
 
   class Configuration
-    class << self
-      #
-      # @!parse attr_reader :default
-      # @return [Configuration] used by default if no dedicated configuration
-      #   was specified
-      #
-      # @see TCPClient.open
-      # @see TCPClient.with_deadline
-      # @see TCPClient#connect
-      #
-      def default
-        TCPClient.default_configuration
-      end
-    end
+    #
+    # @attribute [r] :default
+    # @return [Configuration] used by default if no dedicated configuration
+    #   was specified
+    #
+    # @see TCPClient.open
+    # @see TCPClient.with_deadline
+    # @see TCPClient#connect
+    #
+    def self.default = TCPClient.default_configuration
   end
 end

data/lib/tcp-client/errors.rb

@@ -6,9 +6,7 @@ class TCPClient
   # not available.
   #
   class NoOpenSSLError < RuntimeError
-    def initialize
-      super('OpenSSL is not available')
-    end
+    def initialize = super('OpenSSL is not available')
   end
 
   #
@@ -16,9 +14,7 @@ class TCPClient
   # specified.
   #
   class NoBlockGivenError < ArgumentError
-    def initialize
-      super('no block given')
-    end
+    def initialize = super('no block given')
   end
 
   #
@@ -28,9 +24,7 @@ class TCPClient
     #
     # @param timeout [Object] the invalid value
     #
-    def initialize(timeout)
-      super("invalid deadline - #{timeout}")
-    end
+    def initialize(timeout) = super("invalid deadline - #{timeout}")
   end
 
   #
@@ -40,9 +34,7 @@ class TCPClient
     #
     # @param attribute [Object] the undefined attribute
     #
-    def initialize(attribute)
-      super("unknown attribute - #{attribute}")
-    end
+    def initialize(attribute) = super("unknown attribute - #{attribute}")
   end
 
   #
@@ -74,9 +66,7 @@ class TCPClient
   # but is not connected.
   #
   class NotConnectedError < NetworkError
-    def initialize
-      super('client not connected')
-    end
+    def initialize = super('client not connected')
   end
 
   #
@@ -104,9 +94,7 @@ class TCPClient
     # @attribute [r] action
     # @return [Symbol] the action which timed out
     #
-    def action
-      :process
-    end
+    def action = :process
   end
 
   #
@@ -117,9 +105,7 @@ class TCPClient
     # @attribute [r] action
     # @return [Symbol] the action which timed out: `:connect`
     #
-    def action
-      :connect
-    end
+    def action = :connect
   end
 
   #
@@ -130,9 +116,7 @@ class TCPClient
     # @attribute [r] action
     # @return [Symbol] the action which timed out: :read`
     #
-    def action
-      :read
-    end
+    def action = :read
   end
 
   #
@@ -143,9 +127,7 @@ class TCPClient
     # @attribute [r] action
     # @return [Symbol] the action which timed out: `:write`
     #
-    def action
-      :write
-    end
+    def action = :write
   end
 
   NoOpenSSL = NoOpenSSLError # @!visibility private

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

@@ -6,25 +6,18 @@ class TCPClient
       private
 
       def included(mod)
-        return if supports_wait?(mod)
-        mod.include(method_defined?(:to_io) ? WaitWithIO : WaitWithSelect)
-      end
-
-      def supports_wait?(mod)
-        mod.method_defined?(:wait_writable) &&
-          mod.method_defined?(:wait_readable)
+        return if defined?(mod.wait_writable) && defined?(mod.wait_readable)
+        mod.include(defined?(mod.to_io) ? WaitWithIO : WaitWithSelect)
       end
     end
 
     def read_with_deadline(nbytes, deadline, exception)
       raise(exception) unless deadline.remaining_time
       return fetch_avail(deadline, exception) if nbytes.nil?
-      return ''.b if nbytes.zero?
       @read_buffer ||= ''.b
       while @read_buffer.bytesize < nbytes
-        read = fetch_next(deadline, exception) and next @read_buffer << read
-        close
-        break
+        read = fetch_next(deadline, exception)
+        read ? @read_buffer << read : (break close)
       end
       fetch_slice(nbytes)
     end
@@ -32,12 +25,10 @@ class TCPClient
     def read_to_with_deadline(sep, deadline, exception)
       raise(exception) unless deadline.remaining_time
       @read_buffer ||= ''.b
-      while @read_buffer.index(sep).nil?
-        read = fetch_next(deadline, exception) and next @read_buffer << read
-        close
-        break
+      while (index = @read_buffer.index(sep)).nil?
+        read = fetch_next(deadline, exception)
+        read ? @read_buffer << read : (break close)
       end
-      index = @read_buffer.index(sep)
       return fetch_slice(index + sep.bytesize) if index
       result = @read_buffer
       @read_buffer = nil
@@ -53,7 +44,7 @@ class TCPClient
           with_deadline(deadline, exception) do
             write_nonblock(data, exception: false)
           end
-        (result += written) >= size and return result
+        return result if (result += written) >= size
         data = data.byteslice(written, data.bytesize - written)
       end
     end
@@ -70,7 +61,7 @@ class TCPClient
     end
 
     def fetch_slice(size)
-      return ''.b if size.zero?
+      return ''.b if size <= 0
       result = @read_buffer.byteslice(0, size)
       rest = @read_buffer.bytesize - result.bytesize
       @read_buffer = rest.zero? ? nil : @read_buffer.byteslice(size, rest)
@@ -101,23 +92,13 @@ class TCPClient
     end
 
     module WaitWithIO
-      def wait_writable(remaining_time)
-        to_io.wait_writable(remaining_time)
-      end
-
-      def wait_readable(remaining_time)
-        to_io.wait_readable(remaining_time)
-      end
+      def wait_writable(time) = to_io.wait_writable(time)
+      def wait_readable(time) = to_io.wait_readable(time)
     end
 
     module WaitWithSelect
-      def wait_writable(remaining_time)
-        ::IO.select(nil, [self], nil, remaining_time)
-      end
-
-      def wait_readable(remaining_time)
-        ::IO.select([self], nil, nil, remaining_time)
-      end
+      def wait_writable(time) = ::IO.select(nil, [self], nil, time)
+      def wait_readable(time) = ::IO.select([self], nil, nil, time)
     end
 
     private_constant(:WaitWithIO, :WaitWithSelect)

data/lib/tcp-client/ssl_socket.rb

@@ -30,7 +30,7 @@ class TCPClient
       ::OpenSSL::SSL::SSLContext.new.tap do |ctx|
         ctx.set_params(ssl_params)
         ctx.session_cache_mode = CONTEXT_CACHE_MODE
-        ctx.session_new_cb = proc { |_, session| @new_session = session }
+        ctx.session_new_cb = proc { @new_session = _2 }
       end
     end
 

data/lib/tcp-client/version.rb

@@ -2,5 +2,5 @@
 
 class TCPClient
   # The current version number.
-  VERSION = '0.12.0'
+  VERSION = '0.14.0'
 end

data/lib/tcp-client.rb

@@ -92,7 +92,6 @@ class TCPClient
   # @see #with_deadline
   #
   def self.with_deadline(timeout, address, configuration = nil)
-    client = nil
     raise(NoBlockGivenError) unless block_given?
     client = new
     client.with_deadline(timeout) do
@@ -113,12 +112,10 @@ class TCPClient
   attr_reader :configuration
 
   #
-  # @!parse attr_reader :closed?
+  # @attribute [r] :closed?
   # @return [Boolean] whether the connection is closed
   #
-  def closed?
-    @socket.nil? || @socket.closed?
-  end
+  def closed? = @socket.nil? || @socket.closed?
 
   #
   # Close the current connection if connected.
@@ -240,9 +237,7 @@ class TCPClient
   #
   # @see Address#to_s
   #
-  def to_s
-    @address&.to_s || ''
-  end
+  def to_s = @address.to_s
 
   #
   # Executes a block with a given overall time limit.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcp-client
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2024-03-09 00:00:00.000000000 Z
 dependencies: []
 description: |
   This gem implements a customizable TCP client class that gives you control
@@ -59,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Use your TCP connections with working timeout.