net_tcp_client 2.0.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 729fc42e6f4a4480a26a68bbe970d6e7c79c4690
-  data.tar.gz: 6b9184a059415db496de138d6f54952deb916f91
+SHA256:
+  metadata.gz: e8ada0256a62a84b52bd1084e1c82d4735c28fafb652e933afb7828d9176a262
+  data.tar.gz: ebb5a4e0ae53dffdc317b88263ed60a027b85cac35f1fa909fb626fad62fef88
 SHA512:
-  metadata.gz: 6adaab1f407ef8fd782bb72d0c8fc8dcf42b3de34ae5b5d6b09e4000479ea89a394e8912f24f7c682af3b0493d6f417a557377e53c78ba539516ea0ea648a394
-  data.tar.gz: b597c576047fa6b7478c89aae82ee10ba0893dc49d3651548a57978f4e7236343eaaddcfeccc7e05b4113c9e77b65f2df0ac05babca3f54362051c75326141c2
+  metadata.gz: 74165666c671d74fd1ffe989692cf8f108145cdcf2f70cd82fc4f90730129e391deb8055177ea9eebabcd9d03ea6bdcbf60f117c8aa5f1fe77645a2762b46905
+  data.tar.gz: b5de49d7560b9ed8a20fde3d211178b37481b5e988c7027afe2c87569f3d81c012aa8d5c4d79590ec5f47d2cfce41280e76cdf3c8cd4bad31d2f7fd2f48f077e

data/README.md

@@ -1,9 +1,9 @@
 # net_tcp_client
-[![Gem Version](https://img.shields.io/gem/v/net_tcp_client.svg)](https://rubygems.org/gems/net_tcp_client) [![Build Status](https://travis-ci.org/rocketjob/net_tcp_client.svg?branch=master)](https://travis-ci.org/rocketjob/net_tcp_client) [![Downloads](https://img.shields.io/gem/dt/net_tcp_client.svg)](https://rubygems.org/gems/net_tcp_client) [![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache-2.0) ![](https://img.shields.io/badge/status-Production%20Ready-blue.svg) [![Gitter chat](https://img.shields.io/badge/IRC%20(gitter)-Support-brightgreen.svg)](https://gitter.im/rocketjob/support)
+[![Gem Version](https://img.shields.io/gem/v/net_tcp_client.svg)](https://rubygems.org/gems/net_tcp_client) [![Build Status](https://github.com/reidmorrison/net_tcp_client/workflows/build/badge.svg)](https://github.com/reidmorrison/net_tcp_client/actions?query=workflow%3Abuild) [![Downloads](https://img.shields.io/gem/dt/net_tcp_client.svg)](https://rubygems.org/gems/net_tcp_client) [![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache-2.0) ![](https://img.shields.io/badge/status-Production%20Ready-blue.svg)
 
 Net::TCPClient is a TCP Socket Client with automated failover, load balancing, retries and built-in timeouts.
 
-* http://github.com/rocketjob/net_tcp_client
+* https://github.com/reidmorrison/net_tcp_client
 
 ## Introduction
 
@@ -36,7 +36,7 @@ prevent a network issue from "hanging" the client program.
 require 'net/tcp_client'
 
 Net::TCPClient.connect(server: 'mydomain:3300') do |client|
-  client.send('Update the database')
+  client.write('Update the database')
   response = client.read(20)
   puts "Received: #{response}"
 end
@@ -48,7 +48,7 @@ Enable SSL encryption:
 require 'net/tcp_client'
 
 Net::TCPClient.connect(server: 'mydomain:3300', ssl: true) do |client|
-  client.send('Update the database')
+  client.write('Update the database')
   response = client.read(20)
   puts "Received: #{response}"
 end
@@ -104,7 +104,7 @@ Servers are tried in a Random order.
 ~~~ruby
 tcp_client = Net::TCPClient.new(
   servers: ['server1:3300', 'server2:3300', 'server3:3600'],
-  policy:  :ordered
+  policy:  :random
 )
 ~~~
 
@@ -145,7 +145,7 @@ Example run, the servers could be tried in the following order:
 If a connection cannot be established to any servers in the list Net::TCPClient will retry from the
 first server. This retry behavior can be controlled using the following options:
 
-* `connect_retry_count` [Fixnum]
+* `connect_retry_count` [Integer]
     * Number of times to retry connecting when a connection fails
     * Default: 10
 
@@ -153,7 +153,7 @@ first server. This retry behavior can be controlled using the following options:
     * Number of seconds between connection retry attempts after the first failed attempt
     * Default: 0.5
 
-* `retry_count` [Fixnum]
+* `retry_count` [Integer]
     * Number of times to retry when calling #retry_on_connection_failure
     * This is independent of :connect_retry_count which still applies with
     * connection failures. This retry controls upto how many times to retry the
@@ -184,16 +184,16 @@ Net::TCPClient.connect(
   connect_retry_interval: 0.1,
   connect_retry_count:    5
 ) do |client|
-  # If the connection is lost, create a new one and retry the send
+  # If the connection is lost, create a new one and retry the write
   client.retry_on_connection_failure do
-    client.send('How many users available?')
+    client.write('How many users available?')
     response = client.read(20)
     puts "Received: #{response}"
   end
 end
 ~~~
 
-If the connection is lost during either the `send` or the `read` above the
+If the connection is lost during either the `write` or the `read` above the
 entire block will be re-tried once the connection has been re-stablished.
 
 ## Callbacks
@@ -210,7 +210,7 @@ Any time a connection has been established a callback can be called to handle ac
 tcp_client = Net::TCPClient.new(
   servers: ['server1:3300', 'server2:3300', 'server3:3600'],
   on_connect: -> do |client|
-    client.send('My username and password')
+    client.write('My username and password')
     result = client.read(2)
     raise "Authentication failed" if result != 'OK'
   end
@@ -224,13 +224,13 @@ tcp_client = Net::TCPClient.new(
   servers: ['server1:3300', 'server2:3300', 'server3:3600'],
   on_connect: -> do |client|
     # Set the sequence number to 0
-    user_data = 0
+    client.user_data = 0
   end
 )
 
 tcp_client.retry_on_connection_failure do
-  # Send with the sequence number
-  tcp_client.send("#{tcp_client.user_data} hello")
+  # Write with the sequence number
+  tcp_client.write("#{tcp_client.user_data} hello")
   result = tcp_client.receive(30)
 
   # Increment sequence number after every call to the server
@@ -250,7 +250,7 @@ test on a daily basis, including connections over the internet between remote da
 
     gem install net_tcp_client
 
-To enable logging add [Semantic Logger](http://rocketjob.github.io/semantic_logger):
+To enable logging add [Semantic Logger](https://logger.rocketjob.io/):
 
     gem install semantic_logger
 
@@ -273,13 +273,13 @@ SemanticLogger.default_level = :trace
 SemanticLogger.add_appender(file_name: 'development.log', formatter: :color)
 ~~~
 
-If running Rails, see: [Semantic Logger Rails](http://rocketjob.github.io/semantic_logger/rails.html)
+If running Rails, see: [Semantic Logger Rails](https://logger.rocketjob.io/rails.html)
 
 ### Support
 
 Join the [Gitter chat session](https://gitter.im/rocketjob/support) if you have any questions.
 
-Issues / bugs can be reported via [Github issues](https://github.com/rocketjob/net_tcp_client/issues).
+Issues / bugs can be reported via [Github issues](https://github.com/reidmorrison/net_tcp_client/issues).
 
 ### Upgrading to V2
 
@@ -303,7 +303,7 @@ Tested and supported on the following Ruby platforms:
 - JRuby 1.7.23, 9.0 and above
 - Rubinius 2.5 and above
 
-There is a soft dependency on [Semantic Logger](http://github.com/rocketjob/semantic_logger). It will use SemanticLogger only if
+There is a soft dependency on [Semantic Logger](https://github.com/reidmorrison/semantic_logger). It will use SemanticLogger only if
 it is already available, otherwise any other standard Ruby logger can be used.
 
 ### Note
@@ -314,8 +314,8 @@ Be sure to place the `semantic_logger` gem dependency before `net_tcp_client` in
 
 [Reid Morrison](https://github.com/reidmorrison)
 
-[Contributors](https://github.com/rocketjob/net_tcp_client/graphs/contributors)
+[Contributors](https://github.com/reidmorrison/net_tcp_client/graphs/contributors)
 
 ## Versioning
 
-This project uses [Semantic Versioning](http://semver.org/).
+This project uses [Semantic Versioning](https://semver.org/).

data/Rakefile

@@ -1,28 +1,21 @@
-require 'rake/clean'
-require 'rake/testtask'
-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require 'net/tcp_client/version'
+require "rake/testtask"
+require_relative "lib/net/tcp_client/version"
 
 task :gem do
-  system 'gem build net_tcp_client.gemspec'
+  system "gem build net_tcp_client.gemspec"
 end
 
-task :publish => :gem do
+task publish: :gem do
   system "git tag -a v#{Net::TCPClient::VERSION} -m 'Tagging #{Net::TCPClient::VERSION}'"
-  system 'git push --tags'
+  system "git push --tags"
   system "gem push net_tcp_client-#{Net::TCPClient::VERSION}.gem"
   system "rm net_tcp_client-#{Net::TCPClient::VERSION}.gem"
 end
 
-desc 'Run Test Suite'
-task :test do
-  Rake::TestTask.new(:functional) do |t|
-    t.test_files = FileList['test/*_test.rb']
-    t.verbose    = true
-  end
-
-  Rake::Task['functional'].invoke
+Rake::TestTask.new(:test) do |t|
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+  t.warning = true
 end
 
-task :default => :test
+task default: :test

data/lib/net/tcp_client/address.rb

@@ -1,5 +1,5 @@
-require 'socket'
-require 'ipaddr'
+require "socket"
+require "ipaddr"
 module Net
   class TCPClient
     # Host name, ip address and port to connect to
@@ -11,7 +11,7 @@ module Net
       def self.ip_addresses(dns_name)
         ips = []
         Socket.getaddrinfo(dns_name, nil, Socket::AF_INET, Socket::SOCK_STREAM).each do |s|
-          ips << s[3] if s[0] == 'AF_INET'
+          ips << s[3] if s[0] == "AF_INET"
         end
         ips.uniq
       end
@@ -32,9 +32,15 @@ module Net
       #   "host_name:1234"
       #   "192.168.1.10:80"
       def self.addresses_for_server_name(server_name)
-        dns_name, port = server_name.split(':')
+        dns_name, port = server_name.split(":")
         port           = port.to_i
-        raise(ArgumentError, "Invalid host_name: #{server_name.inspect}. Must be formatted as 'host_name:1234' or '192.168.1.10:80'") unless dns_name && (port > 0)
+        unless dns_name && port&.positive?
+          raise(
+            ArgumentError,
+            "Invalid host_name: #{server_name.inspect}. Must be formatted as 'host_name:1234' or '192.168.1.10:80'"
+          )
+        end
+
         addresses(dns_name, port)
       end
 
@@ -48,6 +54,5 @@ module Net
         "#{host_name}[#{ip_address}]:#{port}"
       end
     end
-
   end
 end

data/lib/net/tcp_client/exceptions.rb

@@ -1,10 +1,11 @@
 module Net
   class TCPClient
-
     class ConnectionTimeout < ::SocketError
     end
+
     class ReadTimeout < ::SocketError
     end
+
     class WriteTimeout < ::SocketError
     end
 
@@ -27,12 +28,11 @@ module Net
       #
       #   cause [Exception]
       #     Original Exception if any, otherwise nil
-      def initialize(message, server, cause=nil)
+      def initialize(message, server, cause = nil)
         @server = server
         @cause  = cause
         super(message)
       end
     end
-
   end
 end

data/lib/net/tcp_client/policy/base.rb

@@ -29,7 +29,6 @@ module Net
         def each(&block)
           raise NotImplementedError
         end
-
       end
     end
   end

data/lib/net/tcp_client/policy/custom.rb

@@ -26,13 +26,15 @@ module Net
         #   end
         def each(&block)
           count = 1
-          while address = @block.call(addresses, count)
-            raise(ArgumentError, 'Proc must return Net::TCPClient::Address, or nil') unless address.is_a?(Net::TCPClient::Address) || address.nil?
+          while (address = @block.call(addresses, count))
+            unless address.is_a?(Net::TCPClient::Address) || address.nil?
+              raise(ArgumentError, "Proc must return Net::TCPClient::Address, or nil")
+            end
+
             block.call(address)
             count += 1
           end
         end
-
       end
     end
   end

data/lib/net/tcp_client/policy/ordered.rb

@@ -5,9 +5,8 @@ module Net
       class Ordered < Base
         # Calls the block once for each server, with the addresses in order
         def each(&block)
-          addresses.each {|address| block.call(address)}
+          addresses.each { |address| block.call(address) }
         end
-
       end
     end
   end

data/lib/net/tcp_client/policy/random.rb

@@ -5,9 +5,8 @@ module Net
       class Random < Base
         # Calls the block once for each server, with the addresses in random order
         def each(&block)
-          addresses.shuffle.each {|address| block.call(address)}
+          addresses.shuffle.each { |address| block.call(address) }
         end
-
       end
     end
   end