resilient_socket 0.4.0 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ffdee0e077d518369067ed0b3248ec8c67f2aa2
+  data.tar.gz: 82f2d747a1bf0caee65bf4428be6d7e47ea83337
+SHA512:
+  metadata.gz: 5c7d639d4af9a6493a34fcf14c06e20d36e95fe352608d01484fc230029d672623364ef79430a508cff5b1d8045250962ac8009fe37b823d24bb8698f75ddad4
+  data.tar.gz: 9120d0ee7557ca7f512afe84ed4d3546a2c3c749e5ecd7b1392387db9fbf24ced1363552aa31385f6f1457acdf84d23f32d5399ce6afc90e8de0294cbbc83e42

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+group :test do
+  gem "shoulda"
+  gem "bson_ext", :platform => 'ruby'
+end
+
+gem 'semantic_logger'
+

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    atomic (1.0.1)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
+    bson (1.8.3)
+    bson_ext (1.8.3)
+      bson (~> 1.8.3)
+    i18n (0.6.4)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.6.1)
+    semantic_logger (2.0.0)
+      sync_attr
+      thread_safe
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.2)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
+    sync_attr (0.1.1)
+    thread_safe (0.1.0)
+      atomic
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson_ext
+  semantic_logger
+  shoulda

data/Rakefile

@@ -2,6 +2,7 @@ lib = File.expand_path('../lib/', __FILE__)
 $:.unshift lib unless $:.include?(lib)
 
 require 'rubygems'
+require 'rubygems/package'
 require 'rake/clean'
 require 'rake/testtask'
 require 'date'
@@ -19,11 +20,12 @@ task :gem  do |t|
     spec.date        = Date.today.to_s
     spec.summary     = "A Resilient TCP Socket Client with built-in timeouts, retries, and logging"
     spec.description = "A Resilient TCP Socket Client with built-in timeouts, retries, and logging"
-    spec.files       = FileList["./**/*"].exclude(/.gem$/, /.log$/,/^nbproject/).map{|f| f.sub(/^\.\//, '')}
+    spec.files       = FileList["./**/*"].exclude(/\.gem$/, /\.log$/,/nbproject/).map{|f| f.sub(/^\.\//, '')}
+    spec.license     = "Apache License V2.0"
     spec.has_rdoc    = true
-    spec.add_dependency 'semantic_logger'
+    spec.add_dependency 'semantic_logger', '>= 2.1'
   end
-  Gem::Builder.new(gemspec).build
+  Gem::Package.build gemspec
 end
 
 desc "Run Test Suite"

data/lib/resilient_socket/tcp_client.rb

@@ -29,9 +29,6 @@ module ResilientSocket
   #  * write
   #
   # Future:
-  #
-  # * Automatic failover to another server should the current server not respond
-  #   to a connection request by supplying an array of host names
   # * Add auto-reconnect feature to sysread, syswrite, etc...
   # * To be a drop-in replacement to TCPSocket should also need to implement the
   #   following TCPSocket instance methods:  :addr, :peeraddr
@@ -41,6 +38,8 @@ module ResilientSocket
   #   has to be completely destroyed and recreated after a connection failure
   #
   class TCPClient
+    include SemanticLogger::Loggable
+
     # Supports embedding user supplied data along with this connection
     # such as sequence number and other connection specific information
     attr_accessor :user_data
@@ -49,7 +48,7 @@ module ResilientSocket
     #
     # Example:
     #   localhost:2000
-    attr_reader :server, :buffered
+    attr_reader :server
 
     attr_accessor :read_timeout, :connect_timeout, :connect_retry_count,
       :retry_count, :connect_retry_interval, :server_selector, :close_on_error
@@ -131,10 +130,10 @@ module ResilientSocket
     #     Default: Half of the :read_timeout ( 30 seconds )
     #
     #   :log_level [Symbol]
-    #     Only set this level to override the global SemanticLogger logging level
-    #     Can be used to turn on trace or debug level logging in production
+    #     Set the logging level for the TCPClient
     #     Any valid SemanticLogger log level:
     #       :trace, :debug, :info, :warn, :error, :fatal
+    #     Default: SemanticLogger.default_level
     #
     #   :buffered [Boolean]
     #     Whether to use Nagle's Buffering algorithm (http://en.wikipedia.org/wiki/Nagle's_algorithm)
@@ -177,6 +176,15 @@ module ResilientSocket
     #       :random
     #         Randomly select a server from the list every time a connection
     #         is established, including during automatic connection recovery.
+    #       :nearest
+    #         FUTURE - Not implemented yet
+    #         The server with an IP address that most closely matches the
+    #         local ip address will be attempted first
+    #         This will result in connections to servers on the localhost
+    #         first prior to looking at remote servers
+    #       :ping_time
+    #         FUTURE - Not implemented yet
+    #         The server with the lowest ping time will be selected first
     #       Proc:
     #         When a Proc is supplied, it will be called passing in the list
     #         of servers. The Proc must return one server name
@@ -226,8 +234,8 @@ module ResilientSocket
         raise "Missing mandatory :server or :servers" unless server = params.delete(:server)
         @servers = [ server ]
       end
-      @logger = SemanticLogger::Logger.new("#{self.class.name} #{@servers.inspect}", params.delete(:log_level) || SemanticLogger::Logger.default_level)
-      params.each_pair {|k,v| @logger.warn "Ignoring unknown option #{k} = #{v}"}
+      self.logger = SemanticLogger::Logger.new("#{self.class.name} #{@servers.inspect}", params.delete(:log_level))
+      params.each_pair {|k,v| logger.warn "Ignoring unknown option #{k} = #{v}"}
 
       # Connect to the Server
       connect
@@ -318,12 +326,12 @@ module ResilientSocket
     #        For a description of the errors, see Socket#write
     #
     def write(data)
-      @logger.trace("#write ==> sending", data)
-      @logger.benchmark_debug("#write ==> sent #{data.length} bytes") do
+      logger.trace("#write ==> sending", data)
+      logger.benchmark_debug("#write ==> sent #{data.length} bytes") do
         begin
           @socket.write(data)
         rescue SystemCallError => exception
-          @logger.warn "#write Connection failure: #{exception.class}: #{exception.message}"
+          logger.warn "#write Connection failure: #{exception.class}: #{exception.message}"
           close if close_on_error
           raise ConnectionFailure.new("Send Connection failure: #{exception.class}: #{exception.message}", @server, exception)
         rescue Exception
@@ -371,13 +379,13 @@ module ResilientSocket
     #
     def read(length, buffer=nil, timeout=nil)
       result = nil
-      @logger.benchmark_debug("#read <== read #{length} bytes") do
+      logger.benchmark_debug("#read <== read #{length} bytes") do
         if timeout != -1
           # Block on data to read for @read_timeout seconds
           ready = begin
             ready = IO.select([@socket], nil, [@socket], timeout || @read_timeout)
           rescue IOError => exception
-            @logger.warn "#read Connection failure while waiting for data: #{exception.class}: #{exception.message}"
+            logger.warn "#read Connection failure while waiting for data: #{exception.class}: #{exception.message}"
             close if close_on_error
             raise ConnectionFailure.new("#{exception.class}: #{exception.message}", @server, exception)
           rescue Exception
@@ -388,7 +396,7 @@ module ResilientSocket
           end
           unless ready
             close if close_on_error
-            @logger.warn "#read Timeout waiting for server to reply"
+            logger.warn "#read Timeout waiting for server to reply"
             raise ReadTimeout.new("Timedout after #{timeout || @read_timeout} seconds trying to read from #{@server}")
           end
         end
@@ -396,17 +404,17 @@ module ResilientSocket
         # Read data from socket
         begin
           result = buffer.nil? ? @socket.read(length) : @socket.read(length, buffer)
-          @logger.trace("#read <== received", result.inspect)
+          logger.trace("#read <== received", result.inspect)
 
           # EOF before all the data was returned
           if result.nil? || (result.length < length)
             close if close_on_error
-            @logger.warn "#read server closed the connection before #{length} bytes were returned"
+            logger.warn "#read server closed the connection before #{length} bytes were returned"
             raise ConnectionFailure.new("Connection lost while reading data", @server, EOFError.new("end of file reached"))
           end
         rescue SystemCallError, IOError => exception
           close if close_on_error
-          @logger.warn "#read Connection failure while reading data: #{exception.class}: #{exception.message}"
+          logger.warn "#read Connection failure while reading data: #{exception.class}: #{exception.message}"
           raise ConnectionFailure.new("#{exception.class}: #{exception.message}", @server, exception)
         rescue Exception
           # Close the connection on any other exception since the connection
@@ -468,15 +476,15 @@ module ResilientSocket
         exc_str = exception.cause ? "#{exception.cause.class}: #{exception.cause.message}" : exception.message
         # Re-raise exceptions that should not be retried
         if !self.class.reconnect_on_errors.include?(exception.cause.class)
-          @logger.warn "#retry_on_connection_failure not configured to retry: #{exc_str}"
+          logger.warn "#retry_on_connection_failure not configured to retry: #{exc_str}"
           raise exception
         elsif retries < @retry_count
           retries += 1
-          @logger.warn "#retry_on_connection_failure retry #{retries} due to #{exception.class}: #{exception.message}"
+          logger.warn "#retry_on_connection_failure retry #{retries} due to #{exception.class}: #{exception.message}"
           connect
           retry
         end
-        @logger.error "#retry_on_connection_failure Connection failure: #{exception.class}: #{exception.message}. Giving up after #{retries} retries"
+        logger.error "#retry_on_connection_failure Connection failure: #{exception.class}: #{exception.message}. Giving up after #{retries} retries"
         raise ConnectionFailure.new("After #{retries} retries to host '#{server}': #{exc_str}", @server, exception.cause)
       end
     end
@@ -487,7 +495,7 @@ module ResilientSocket
     def close
       @socket.close unless @socket.closed?
     rescue IOError => exception
-      @logger.warn "IOError when attempting to close socket: #{exception.class}: #{exception.message}"
+      logger.warn "IOError when attempting to close socket: #{exception.class}: #{exception.message}"
     end
 
     # Returns whether the socket is closed
@@ -539,7 +547,7 @@ module ResilientSocket
       # :accept, :accept_nonblock, :bind, :connect, :connect_nonblock, :getpeereid,
       # :ipv6only!, :listen, :recvfrom_nonblock, :sysaccept
       retries = 0
-      @logger.benchmark_info "Connecting to server #{server}" do
+      logger.benchmark_info "Connected to #{server}" do
         host_name, port = server.split(":")
         port = port.to_i
 
@@ -570,11 +578,11 @@ module ResilientSocket
         rescue SystemCallError => exception
           if retries < @connect_retry_count && self.class.reconnect_on_errors.include?(exception.class)
             retries += 1
-            @logger.warn "Connection failure: #{exception.class}: #{exception.message}. Retry: #{retries}"
+            logger.warn "Connection failure: #{exception.class}: #{exception.message}. Retry: #{retries}"
             sleep @connect_retry_interval
             retry
           end
-          @logger.error "Connection failure: #{exception.class}: #{exception.message}. Giving up after #{retries} retries"
+          logger.error "Connection failure: #{exception.class}: #{exception.message}. Giving up after #{retries} retries"
           raise ConnectionFailure.new("After #{retries} connection attempts to host '#{server}': #{exception.class}: #{exception.message}", @server, exception)
         end
       end

data/lib/resilient_socket/version.rb

@@ -1,3 +1,3 @@
 module ResilientSocket #:nodoc
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/test/simple_tcp_server.rb

@@ -107,8 +107,8 @@ class SimpleTCPServer
 end
 
 if $0 == __FILE__
-  SemanticLogger::Logger.default_level = :trace
-  SemanticLogger::Logger.appenders << SemanticLogger::Appender::File.new(STDOUT)
+  SemanticLogger.default_level = :trace
+  SemanticLogger.add_appender(STDOUT)
   server = SimpleTCPServer.new(2000)
   server.thread.join
 end

data/test/tcp_client_test.rb

@@ -8,8 +8,8 @@ require 'shoulda'
 require 'resilient_socket'
 require 'simple_tcp_server'
 
-SemanticLogger::Logger.default_level = :trace
-SemanticLogger::Logger.appenders << SemanticLogger::Appender::File.new('test.log')
+SemanticLogger.default_level = :trace
+SemanticLogger.add_appender('test.log')
 
 # Unit Test for ResilientSocket::TCPClient
 class TCPClientTest < Test::Unit::TestCase

metadata

@@ -1,32 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: resilient_socket
 version: !ruby/object:Gem::Version
-  version: 0.4.0
-  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-13 00:00:00.000000000 Z
+date: 2013-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semantic_logger
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 description: A Resilient TCP Socket Client with built-in timeouts, retries, and logging
 email:
 - reidmo@gmail.com
@@ -34,44 +31,39 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resilient_socket.rb
 - lib/resilient_socket/exceptions.rb
 - lib/resilient_socket/tcp_client.rb
 - lib/resilient_socket/version.rb
-- lib/resilient_socket.rb
-- LICENSE.txt
-- nbproject/private/config.properties
-- nbproject/private/private.properties
-- nbproject/private/private.xml
-- nbproject/private/rake-d.txt
-- nbproject/project.properties
-- nbproject/project.xml
-- Rakefile
-- README.md
 - test/simple_tcp_server.rb
 - test/tcp_client_test.rb
-- test.log.working
 homepage: https://github.com/ClarityServices/resilient_socket
-licenses: []
+licenses:
+- Apache License V2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Resilient TCP Socket Client with built-in timeouts, retries, and logging
 test_files: []

data/nbproject/private/private.properties

@@ -1,3 +0,0 @@
-file.reference.resilient_socket-lib=/Users/rmorrison/Sandbox/resilient_socket/lib
-file.reference.resilient_socket-test=/Users/rmorrison/Sandbox/resilient_socket/test
-platform.active=Ruby_0

data/nbproject/private/private.xml

@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project-private xmlns="http://www.netbeans.org/ns/project-private/1">
-    <editor-bookmarks xmlns="http://www.netbeans.org/ns/editor-bookmarks/1"/>
-</project-private>

data/nbproject/private/rake-d.txt

@@ -1,4 +0,0 @@
-clean=
-clobber=
-gem=
-test=

data/nbproject/project.properties

@@ -1,7 +0,0 @@
-file.reference.resilient_socket-lib=lib
-file.reference.resilient_socket-test=test
-main.file=
-platform.active=Ruby
-source.encoding=UTF-8
-src.dir=${file.reference.resilient_socket-lib}
-test.src.dir=${file.reference.resilient_socket-test}

data/nbproject/project.xml

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://www.netbeans.org/ns/project/1">
-    <type>org.netbeans.modules.ruby.rubyproject</type>
-    <configuration>
-        <data xmlns="http://www.netbeans.org/ns/ruby-project/1">
-            <name>resilient_socket</name>
-            <source-roots>
-                <root id="src.dir"/>
-            </source-roots>
-            <test-roots>
-                <root id="test.src.dir"/>
-            </test-roots>
-        </data>
-    </configuration>
-</project>