tcp-client 0.11.3 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d7af455e50934e3a112047a9f8779993e890b44e01f100c78695ed52fdde979
-  data.tar.gz: f144e06f7a7e5be0c2691bfafb536a3709a0a069b6280141b876b4a6b56b118d
+  metadata.gz: 1fc5d1bf109cf729758affe093ed44313d0e688c9c0098bf671f9c8e1250118c
+  data.tar.gz: 185ea5d345ecd2cceecafe6d19179a68919429df7269c5088bd89032749d6db3
 SHA512:
-  metadata.gz: 82f2061ef746877f1152475e836d925181353d3b6f7e4a1592dafb5d6151cd495882da17801b487ccade8c5b46dfe75b63b9d8f9b16d781a22d51cb9e79e8227
-  data.tar.gz: 1b42dc104cd5f9c0d02c98d4f020136658f428ce629347c7065101f55195c8f94e2bbaaf36e08a6adc74989b566f99042849c9fe2320df3a53872d8ef085528b
+  metadata.gz: b34d0fef41cafa8d915ed203a5a4a934f22d2ee37fbe4a1f992bef6278f3ebfb7715ff7b4672e01af98c81d7a39eb7d057d79499b41248db44cf4de730240b1d
+  data.tar.gz: 5125d264eb11b6c5358df65525ad8ac9806f69d4e3f5bccd3dc775a36ae1f49c6c3b3cb97b410e09bdc214275a3b95b0f576c3a52db77f79ef610203e29fabd9

data/README.md

@@ -18,11 +18,14 @@ require 'tcp-client'
 
 # create a configuration:
 # - don't use internal buffering
-# - use TLS 1.2 or TLS 1.3
-cfg = TCPClient::Configuration.create(
-  buffered: false,
-  ssl_params: {min_version: :TLS1_2, max_version: :TLS1_3}
-)
+# - use at least TLS 1.2
+cfg =
+  TCPClient::Configuration.create(
+    buffered: false,
+    ssl_params: {
+      min_version: :TLS1_2
+    }
+  )
 
 # request to Google.com:
 # - limit all network interactions to 1.5 seconds
@@ -52,13 +55,13 @@ gem 'tcp-client'
 
 and install it by running Bundler:
 
-```bash
+```shell
 bundle
 ```
 
 To install the gem globally use:
 
-```bash
+```shell
 gem install tcp-client
 ```
 

data/lib/tcp-client/address.rb

@@ -4,21 +4,46 @@ require 'socket'
 
 class TCPClient
   #
-  # The address used by a TCPClient
+  # The address used by a TCPClient.
+  #
+  # @note An {Address} does not resolve the required TCP information until it is
+  #   needed.
+  #
+  #   This means that address resolution only occurs when an instance attribute
+  #   is accessed or the address is frozen.
+  #   To force the address resolution at a certain time, {#freeze} can be called.
   #
   class Address
     #
+    # @attribute [r] addrinfo
+    # @return [Addrinfo] the address info
+    #
+    def addrinfo
+      freeze if @addrinfo.nil?
+      @addrinfo
+    end
+
+    #
+    # @attribute [r] host
     # @return [String] the host name
     #
-    attr_reader :hostname
+    def host
+      freeze if @host.nil?
+      @host
+    end
+    alias hostname host
 
     #
-    # @return [Addrinfo] the address info
+    # @attribute [r] port
+    # @return [Integer] the port number
     #
-    attr_reader :addrinfo
+    def port
+      addrinfo.ip_port
+    end
 
     #
     # Initializes an address
+    #
     # @overload initialize(addr)
     #   The addr can be specified as
     #
@@ -49,46 +74,53 @@ class TCPClient
     #   @param port [Integer] the addressed port
     #
     def initialize(addr)
-      case addr
-      when self.class
-        init_from_selfclass(addr)
-      when Addrinfo
-        init_from_addrinfo(addr)
-      when Integer
-        init_from_addrinfo(Addrinfo.tcp(nil, addr))
-      else
-        init_from_string(addr)
-      end
-      @addrinfo.freeze
+      @addr = addr
     end
 
     #
-    # @attribute [r] port
-    # @return [Integer] the port number
+    # Convert `self` to a Hash containing host and port attribute.
     #
-    def port
-      @addrinfo.ip_port
+    # @return [Hash] host and port
+    #
+    def to_hash
+      { host: host, port: port }
+    end
+
+    #
+    # Convert `self` to a Hash containing host and port attribute.
+    #
+    # @overload to_h
+    # @overload to_h(&block)
+    # @return [Hash] host and port
+    #
+    def to_h(&block)
+      block ? to_hash.to_h(&block) : to_hash
     end
 
     #
     # @return [String] text representation of self as "host:port"
     #
     def to_s
-      hostname.index(':') ? "[#{hostname}]:#{port}" : "#{hostname}:#{port}"
+      host.index(':') ? "[#{host}]:#{port}" : "#{host}:#{port}"
     end
 
     #
-    # Convert `self` to a Hash containing host and port attribute.
+    # Force the address resolution and prevents further modifications of itself.
     #
-    # @return [Hash] host and port
+    # @return [Address] itself
     #
-    def to_h
-      { host: hostname, port: port }
+    def freeze
+      return super if frozen?
+      solve
+      @addrinfo.freeze
+      @host.freeze
+      @addr = nil
+      super
     end
 
     # @!visibility private
     def ==(other)
-      to_h == other.to_h
+      to_hash == other.to_h
     end
     alias eql? ==
 
@@ -99,26 +131,40 @@ class TCPClient
 
     private
 
-    def init_from_selfclass(address)
-      @hostname = address.hostname
+    def solve
+      case @addr
+      when self.class
+        from_self_class(@addr)
+      when Addrinfo
+        from_addrinfo(@addr)
+      when Integer
+        from_addrinfo(Addrinfo.tcp(nil, @addr))
+      else
+        from_string(@addr)
+      end
+    end
+
+    def from_self_class(address)
+      unless address.frozen?
+        @addr = address.instance_variable_get(:@addr)
+        return solve
+      end
       @addrinfo = address.addrinfo
+      @host = address.host
     end
 
-    def init_from_addrinfo(addrinfo)
-      @hostname = addrinfo.getnameinfo(Socket::NI_NUMERICSERV).first
+    def from_addrinfo(addrinfo)
+      @host = addrinfo.getnameinfo(Socket::NI_NUMERICSERV).first
       @addrinfo = addrinfo
     end
 
-    def init_from_string(str)
-      @hostname, port = from_string(str.to_s)
-      if @hostname
-        @addrinfo = Addrinfo.tcp(@hostname, port)
-      else
-        init_from_addrinfo(Addrinfo.tcp(nil, port)) unless @hostname
-      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))
     end
 
-    def from_string(str)
+    def host_n_port(str)
       idx = str.rindex(':') or return nil, str.to_i
       name = str[0, idx].delete_prefix('[').delete_suffix(']')
       [name.empty? ? nil : name, str[idx + 1, str.size - idx].to_i]

data/lib/tcp-client/configuration.rb

@@ -268,7 +268,7 @@ class TCPClient
     #
     # @see #configure
     #
-    def to_h
+    def to_hash
       {
         buffered: @buffered,
         keep_alive: @keep_alive,
@@ -284,6 +284,17 @@ class TCPClient
       }
     end
 
+    #
+    # @overload to_h
+    # @overload to_h(&block)
+    # @return [{Symbol => Object}] Hash containing all attributes
+    #
+    # @see #configure
+    #
+    def to_h(&block)
+      block ? to_hash.to_h(&block) : to_hash
+    end
+
     #
     # Configures the instance with given options Hash.
     #
@@ -326,7 +337,7 @@ class TCPClient
 
     # @!visibility private
     def ==(other)
-      to_h == other.to_h
+      to_hash == other.to_h
     end
     alias eql? ==
 

data/lib/tcp-client/deadline.rb

@@ -12,7 +12,7 @@ class TCPClient
     end
 
     def remaining_time
-      @deadline&.-(now)
+      @deadline && (remaining = @deadline - now) > 0 ? remaining : nil
     end
 
     private

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

@@ -48,7 +48,7 @@ class TCPClient
       return 0 if (size = data.bytesize).zero?
       raise(exception) unless deadline.remaining_time
       result = 0
-      loop do
+      while true
         written =
           with_deadline(deadline, exception) do
             write_nonblock(data, exception: false)
@@ -84,7 +84,7 @@ class TCPClient
     end
 
     def with_deadline(deadline, exception)
-      loop do
+      while true
         case ret = yield
         when :wait_writable
           remaining_time = deadline.remaining_time or raise(exception)

data/lib/tcp-client/version.rb

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

data/lib/tcp-client.rb

@@ -161,7 +161,7 @@ class TCPClient
     close if @socket
     @configuration = (configuration || Configuration.default).dup
     raise(NoOpenSSLError) if @configuration.ssl? && !defined?(SSLSocket)
-    @address = stem_errors { Address.new(address) }
+    @address = Address.new(address)
     @socket = create_socket(timeout, exception)
     self
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcp-client
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.12.0
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-15 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies: []
 description: |
   This gem implements a customizable TCP client class that gives you control
@@ -43,6 +43,7 @@ metadata:
   source_code_uri: https://github.com/mblumtritt/tcp-client
   bug_tracker_uri: https://github.com/mblumtritt/tcp-client/issues
   documentation_uri: https://rubydoc.info/gems/tcp-client
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -58,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Use your TCP connections with working timeout.