net_tcp_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf88786139faafadc4b1f1fad33c681c4137b083
+  data.tar.gz: ef3ed6ce5f9ab0620bc7ef8746d3d0291ae03364
+SHA512:
+  metadata.gz: 610d155da8d923ab15282c013900f16a9a624855a154ce97ea74388820352ebb112dc7fe19aa777aaef7d6b388a0da3c611f2b24a8dec8cb37b58b669e90f314
+  data.tar.gz: 30c4854a12224824e2e804f185ca8ca96c9dab9f809a4b669813a396b47ba4b1f3f266b367ec4527fa3cf13aa6383435d6f09dc91c0c66af0e5fa9ca8a2459d7

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2012, 2013, 2014 Reid Morrison
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,101 @@
+net_tcp_client
+==============
+
+Net::TCPClient is a TCP Socket Client with built-in timeouts, retries, and logging
+
+* http://github.com/reidmorrison/net_tcp_client
+
+## Introduction
+
+Net::TCPClient implements resilience features that most developers wish was
+already included in the standard Ruby libraries.
+
+With so many "client" libraries to servers such us memcache, MongoDB, Redis, etc.
+their focus is on the communication formats and messaging interactions. As a result
+adding resilience is usually an after thought.
+
+More importantly the way that each client implements connection failure handling
+varies dramatically. The purpose of this library is to extract the best
+of all the socket error handling out there and create a consistent way of dealing
+with connection failures.
+
+Another important feature is that the _connect_ and _read_ API's use timeout's to
+prevent a network issue from "hanging" the client program.
+
+## Net::TCPClient API
+
+Net::TCPClient is a drop in replacement for TCPSocket when used as a client.
+
+The initializer is the only deviation since it accepts several new options
+that support automatic failover, re-connect and messaging retries.
+
+## Example
+
+Connect to a server at address `localhost`, and on port `3300`.
+
+Specify a custom retry interval and retry counts during connection.
+
+```ruby
+require 'net/tcp_client'
+
+Net::TCPClient.connect(
+  server:                 'localhost:3300',
+  connect_retry_interval: 0.1,
+  connect_retry_count:    5
+) do |client|
+  # If the connection is lost, create a new one and retry the send
+  client.retry_on_connection_failure do
+    client.send('Update the database')
+  end
+  response = client.read(20)
+  puts "Received: #{response}"
+end
+```
+
+## Dependencies
+
+- Ruby 1.9.3, JRuby 1.7, or greater
+
+There is a soft dependency on SemanticLogger. It will use SemanticLogger only if
+it is already available, otherwise any other standard Ruby logger can be used.
+- [SemanticLogger](http://github.com/reidmorrison/semantic_logger)
+
+## Production Use
+
+Net::TCPClient was built for and is being used in a high performance, highly concurrent
+production environment. The resilient capabilities of Net::TCPClient are put to the
+test on a daily basis, especially with connections over the internet between
+remote data centers.
+
+## Installation
+
+    gem install net_tcp_client
+
+## Meta
+
+* Code: `git clone git://github.com/reidmorrison/net_tcp_client.git`
+* Home: <https://github.com/reidmorrison/net_tcp_client>
+* Bugs: <http://github.com/reidmorrison/net_tcp_client/issues>
+* Gems: <http://rubygems.org/gems/net_tcp_client>
+
+This project uses [Semantic Versioning](http://semver.org/).
+
+## Author
+
+[Reid Morrison](https://github.com/reidmorrison) :: @reidmorrison
+
+## License
+
+Copyright 2012, 2013, 2014 Reid Morrison
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rake/clean'
+require 'rake/testtask'
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'net/tcp_client/version'
+
+task :gem do
+  system "gem build net_tcp_client.gemspec"
+end
+
+task :publish => :gem do
+  system "git tag -a v#{Net::TCPClient::VERSION} -m 'Tagging #{Net::TCPClient::VERSION}'"
+  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
+end
+
+task :default => :test

data/lib/net/tcp_client.rb

@@ -0,0 +1,5 @@
+require 'net/tcp_client/version'
+require 'net/tcp_client/exceptions'
+require 'net/tcp_client/tcp_client'
+# Use the builtin logger only if semantic logger is not already loaded
+require 'net/tcp_client/logging'

data/lib/net/tcp_client/exceptions.rb

@@ -0,0 +1,35 @@
+require 'socket'
+module Net
+  class TCPClient
+
+    class ConnectionTimeout < ::SocketError; end
+    class ReadTimeout < ::SocketError; end
+
+    # Raised by ResilientSocket whenever a Socket connection failure has occurred
+    class ConnectionFailure < ::SocketError
+      # Returns the hostname and port against which the connection failure occurred
+      attr_reader :server
+
+      # Returns the original exception that caused the connection failure
+      # For example instances of Errno::ECONNRESET
+      attr_reader :cause
+
+      # Parameters
+      #   message [String]
+      #     Text message of the reason for the failure and/or where it occurred
+      #
+      #   server [String]
+      #     Hostname and port
+      #     For example: "localhost:2000"
+      #
+      #   cause [Exception]
+      #     Original Exception if any, otherwise nil
+      def initialize(message, server, cause=nil)
+        @server = server
+        @cause = cause
+        super(message)
+      end
+    end
+
+  end
+end

data/lib/net/tcp_client/logging.rb

@@ -0,0 +1,191 @@
+module Net
+  class TCPClient
+    #
+    # Purpose: Support SemanticLogger API without forcing a dependency on SemanticLogger
+    #
+    # This Mix-in has been copied from semantic_logger/compatible
+    #
+    # Do not modify this file, grab the latest version from Semantic Logger
+    #
+    module Logging
+      def self.new_logger(logger=nil, name=nil, log_level=nil)
+        # SemanticLogger is a soft dependency, use it if already loaded
+        if defined?(SemanticLogger)
+          SemanticLogger::Logger.new(name, log_level)
+        elsif logger && !logger.respond_to?(:benchmark_trace)
+          logger.extend(InstanceMethods)
+          logger
+        else
+          # Return a nil logger
+          require 'logger'
+          logger = Logger.new($null)
+          logger.level = Logger::FATAL
+          logger.extend(InstanceMethods)
+          logger
+        end
+      end
+
+      module InstanceMethods
+        # See SemanticLogger for details on these logging extensions
+        [:debug, :info, :warn, :error, :fatal].each_with_index do |level|
+          class_eval <<-EOT, __FILE__, __LINE__ + 1
+        def #{level}(message=nil, payload=nil, exception=nil, &block)
+          if #{level}?
+            super(format_log_message('#{level}', message, payload, exception, &block))
+            true
+          else
+            false
+          end
+        end
+
+        def benchmark_#{level}(message, params = {}, &block)
+          if #{level}?
+            benchmark(:#{level}, message, params, &block)
+          else
+            block.call(params) if block
+          end
+        end
+          EOT
+        end
+
+        # Log trace level messages as debug
+        def trace(*args)
+          debug(*args)
+        end
+
+        def trace?
+          debug?
+        end
+
+        def trace_benchmark(*args)
+          debug_benchmark(*args)
+        end
+
+        def format_log_message(level, message=nil, payload=nil, exception=nil, duration=nil, &block)
+          if exception.nil? && payload && payload.is_a?(Exception)
+            exception = payload
+            payload = nil
+          end
+
+          if block && (result = block.call)
+            if result.is_a?(String)
+              message = message.nil? ? result : "\#{message} -- \#{result}"
+            elsif payload && payload.respond_to?(:merge)
+              payload.merge(result)
+            else
+              payload = result
+            end
+          end
+
+          # Add scoped payload
+          if self.payload
+            payload = payload.nil? ? self.payload : self.payload.merge(payload)
+          end
+
+          tags_str = tags.collect { |tag| "[#{tag}]" }.join(" ") + " " if tags && (tags.size > 0)
+
+          message = message.to_s.dup
+          message << " -- " << payload.inspect if payload
+          message << " -- Exception: " << "#{exception.class}: #{exception.message}\n#{(exception.backtrace || []).join("\n")}" if exception
+
+          duration_str = duration ? "(#{'%.1f' % duration}ms) " : ''
+
+          "#{tags_str}#{duration_str} #{message}"
+        end
+
+        # Measure the supplied block and log the message
+        def benchmark(level, message, params, &block)
+          start     = Time.now
+          begin
+            rc = block.call(params) if block
+            exception = params[:exception]
+            rc
+          rescue Exception => exc
+            exception = exc
+          ensure
+            end_time = Time.now
+            # Extract options after block completes so that block can modify any of the options
+            log_exception      = params[:log_exception] || :partial
+            on_exception_level = params[:on_exception_level]
+            min_duration       = params[:min_duration] || 0.0
+            payload            = params[:payload]
+            metric             = params[:metric]
+            duration           = if block_given?
+              1000.0 * (end_time - start)
+            else
+              params[:duration] || raise("Mandatory block missing when :duration option is not supplied")
+            end
+
+            # Add scoped payload
+            if self.payload
+              payload = payload.nil? ? self.payload : self.payload.merge(payload)
+            end
+            if exception
+              logged_exception = exception
+              case log_exception
+              when :full
+                # On exception change the log level
+                level = on_exception_level if on_exception_level
+              when :partial
+                # On exception change the log level
+                level = on_exception_level if on_exception_level
+                message = "#{message} -- Exception: #{exception.class}: #{exception.message}"
+                logged_exception = nil
+              else
+                logged_exception = nil
+              end
+              send(level, format_log_message(level, message, payload, logged_exception, duration, &block))
+              raise exception
+            elsif duration >= min_duration
+              # Only log if the block took longer than 'min_duration' to complete
+              send(level, format_log_message(level, message, payload, logged_exception, duration, &block))
+            end
+          end
+        end
+
+        def tagged(*tags)
+          new_tags = push_tags(*tags)
+          yield self
+        ensure
+          pop_tags(new_tags.size)
+        end
+
+        # Previous method for supplying tags
+        alias_method :with_tags, :tagged
+
+        def tags
+          # Since tags are stored on a per thread basis this list is thread-safe
+          t = Thread.current[:semantic_logger_tags]
+          t.nil? ? [] : t.clone
+        end
+
+        def push_tags *tags
+          # Need to flatten and reject empties to support calls from Rails 4
+          new_tags = tags.flatten.collect(&:to_s).reject(&:empty?)
+          t = Thread.current[:semantic_logger_tags]
+          Thread.current[:semantic_logger_tags] = t.nil? ? new_tags : t.concat(new_tags)
+          new_tags
+        end
+
+        def pop_tags(quantity=1)
+          t = Thread.current[:semantic_logger_tags]
+          t.pop(quantity) unless t.nil?
+        end
+
+        def with_payload(payload)
+          current_payload = self.payload
+          Thread.current[:semantic_logger_payload] = current_payload ? current_payload.merge(payload) : payload
+          yield
+        ensure
+          Thread.current[:semantic_logger_payload] = current_payload
+        end
+
+        def payload
+          Thread.current[:semantic_logger_payload]
+        end
+
+      end
+    end
+  end
+
+end