active_utils 1.0.3 → 1.0.4

data/README.md

@@ -12,3 +12,4 @@ Active Utils extracts commonly used modules and classes used by [Active Merchant
 * RequiresParameters - helper method to ensure the required parameters are passed in
 * Utils - common utils such as uid generator
 * Validateable - module used for making models validateable
+* NetworkConnectionRetries - module for retrying network connections when connection errors occur

data/lib/active_utils/common/connection.rb

@@ -5,6 +5,8 @@ require 'benchmark'
 
 module ActiveMerchant
   class Connection
+    include NetworkConnectionRetries
+
     MAX_RETRIES = 3
     OPEN_TIMEOUT = 60
     READ_TIMEOUT = 60
@@ -16,7 +18,6 @@ module ActiveMerchant
     attr_accessor :open_timeout
     attr_accessor :read_timeout
     attr_accessor :verify_peer
-    attr_accessor :retry_safe
     attr_accessor :pem
     attr_accessor :pem_password
     attr_accessor :wiredump_device
@@ -34,7 +35,7 @@ module ActiveMerchant
     end
 
     def request(method, body, headers = {})
-      retry_exceptions do
+      retry_exceptions(:max_retries => MAX_RETRIES, :logger => logger, :tag => tag) do
         begin
           info "#{method.to_s.upcase} #{endpoint}", tag
 
@@ -65,17 +66,6 @@ module ActiveMerchant
           info "--> %d %s (%d %.4fs)" % [result.code, result.message, result.body ? result.body.length : 0, realtime], tag
           debug result.body
           result
-        rescue EOFError => e
-          raise ConnectionError, "The remote server dropped the connection"
-        rescue Errno::ECONNRESET => e
-          raise ConnectionError, "The remote server reset the connection"
-        rescue Errno::ECONNREFUSED => e
-          raise RetriableConnectionError, "The remote server refused the connection"
-        rescue OpenSSL::X509::CertificateError => e
-          error(e.message, tag)
-          raise ClientCertificateError, "The remote server did not accept the provided SSL certificate"
-        rescue Timeout::Error, Errno::ETIMEDOUT => e
-          raise ConnectionError, "The connection to the remote server timed out"
         end
       end
     end
@@ -124,23 +114,6 @@ module ActiveMerchant
       end
     end
 
-    def retry_exceptions
-      retries = MAX_RETRIES
-      begin
-        yield
-      rescue RetriableConnectionError => e
-        retries -= 1
-        retry unless retries.zero?
-        error(e.message, tag)
-        raise ConnectionError, e.message
-      rescue ConnectionError => e
-        retries -= 1
-        retry if retry_safe && !retries.zero?
-        error(e.message, tag)
-        raise
-      end
-    end
-
     def handle_response(response)
       if @ignore_http_status then
         return response.body

data/lib/active_utils/common/network_connection_retries.rb

@@ -0,0 +1,58 @@
+module ActiveMerchant
+  module NetworkConnectionRetries
+    DEFAULT_RETRIES = 3
+    DEFAULT_CONNECTION_ERRORS = {
+      EOFError          => "The remote server dropped the connection",
+      Errno::ECONNRESET => "The remote server reset the connection",
+      Timeout::Error    => "The connection to the remote server timed out",
+      Errno::ETIMEDOUT  => "The connection to the remote server timed out"
+    }
+
+    def self.included(base)
+      base.send(:attr_accessor, :retry_safe)
+    end
+
+    def retry_exceptions(options={})
+      connection_errors = DEFAULT_CONNECTION_ERRORS.merge(options[:connection_exceptions] || {})
+
+      retry_network_exceptions(options) do
+        begin
+          yield
+        rescue Errno::ECONNREFUSED => e
+          raise ActiveMerchant::RetriableConnectionError, "The remote server refused the connection"
+        rescue OpenSSL::X509::CertificateError => e
+          NetworkConnectionRetries.log(options[:logger], :error, e.message, options[:tag])
+          raise ActiveMerchant::ClientCertificateError, "The remote server did not accept the provided SSL certificate"
+        rescue *connection_errors.keys => e
+          raise ActiveMerchant::ConnectionError, connection_errors[e.class]
+        end
+      end
+    end
+
+    private
+
+    def retry_network_exceptions(options = {})
+      retries = options[:max] || DEFAULT_RETRIES
+
+      begin
+        yield
+      rescue ActiveMerchant::RetriableConnectionError => e
+        retries -= 1
+        retry unless retries.zero?
+        NetworkConnectionRetries.log(options[:logger], :error, e.message, options[:tag])
+        raise ActiveMerchant::ConnectionError, e.message
+      rescue ActiveMerchant::ConnectionError => e
+        retries -= 1
+        retry if (options[:retry_safe] || retry_safe) && !retries.zero?
+        NetworkConnectionRetries.log(options[:logger], :error, e.message, options[:tag])
+        raise
+      end
+    end
+
+    def self.log(logger, level, message, tag=nil)
+      tag ||= self.class.to_s
+      message = "[#{tag}] #{message}"
+      logger.send(level, message) if logger
+    end
+  end
+end

data/lib/active_utils/common/posts_data.rb

@@ -31,6 +31,8 @@ module ActiveMerchant #:nodoc:
     end
 
     def raw_ssl_request(method, endpoint, data, headers = {})
+      logger.warn "#{self.class} using ssl_strict=false, which is insecure" if logger unless ssl_strict
+
       connection = new_connection(endpoint)
       connection.open_timeout = open_timeout
       connection.read_timeout = read_timeout

data/lib/active_utils/common/utils.rb

@@ -1,16 +1,9 @@
-require 'digest/md5'
+require 'securerandom'
 
 module ActiveMerchant #:nodoc:
   module Utils #:nodoc:
     def generate_unique_id
-      md5 = Digest::MD5.new
-      now = Time.now
-      md5 << now.to_s
-      md5 << String(now.usec)
-      md5 << String(rand(0))
-      md5 << String($$)
-      md5 << self.class.name
-      md5.hexdigest
+      SecureRandom.hex(16)
     end
 
     module_function :generate_unique_id

data/lib/active_utils/version.rb

@@ -1,3 +1,3 @@
 module ActiveUtils
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/lib/active_utils.rb

@@ -3,6 +3,7 @@ require 'active_support/core_ext/hash/conversions'
 require 'active_support/core_ext/class/attribute'
 
 module ActiveMerchant
+  autoload :NetworkConnectionRetries,  'active_utils/common/network_connection_retries'
   autoload :Connection,                'active_utils/common/connection'
   autoload :Country,                   'active_utils/common/country'
   autoload :CountryCode,               'active_utils/common/country'

data/test/unit/network_connection_retries_test.rb

@@ -0,0 +1,127 @@
+require 'test_helper'
+require 'openssl'
+require 'net/http'
+
+class NetworkConnectionRetriesTest < Test::Unit::TestCase
+  class MyNewError < StandardError
+  end
+
+  include NetworkConnectionRetries
+
+  def setup
+    @logger = stubs(:logger)
+    @requester = stubs(:requester)
+    @ok = stub(:code => 200, :message => 'OK', :body => 'success')
+  end
+
+  def test_unrecoverable_exception
+    assert_raises(ActiveMerchant::ConnectionError) do
+      retry_exceptions do
+        raise EOFError
+      end
+    end
+  end
+
+  def test_unrecoverable_exception_logged_if_logger_provided
+    @logger.expects(:error).once
+    assert_raises(ActiveMerchant::ConnectionError) do
+      retry_exceptions :logger => @logger do
+        raise EOFError
+      end
+    end
+  end
+
+  def test_failure_then_success_with_recoverable_exception
+    @requester.expects(:post).times(2).raises(Errno::ECONNREFUSED).then.returns(@ok)
+
+    assert_nothing_raised do
+      retry_exceptions do
+        @requester.post
+      end
+    end
+  end
+
+  def test_failure_limit_reached
+    @requester.expects(:post).times(ActiveMerchant::NetworkConnectionRetries::DEFAULT_RETRIES).raises(Errno::ECONNREFUSED)
+
+    assert_raises(ActiveMerchant::ConnectionError) do
+      retry_exceptions do
+        @requester.post
+      end
+    end
+  end
+
+  def test_failure_limit_reached_logs_final_error
+    @logger.expects(:error).once
+    @requester.expects(:post).times(ActiveMerchant::NetworkConnectionRetries::DEFAULT_RETRIES).raises(Errno::ECONNREFUSED)
+
+    assert_raises(ActiveMerchant::ConnectionError) do
+      retry_exceptions(:logger => @logger) do
+        @requester.post
+      end
+    end
+  end
+
+  def test_failure_then_success_with_retry_safe_enabled
+    @requester.expects(:post).times(2).raises(EOFError).then.returns(@ok)
+
+    assert_nothing_raised do
+      retry_exceptions :retry_safe => true do
+        @requester.post
+      end
+    end
+  end
+
+  def test_mixture_of_failures_with_retry_safe_enabled
+    @requester.expects(:post).times(3).raises(Errno::ECONNRESET).
+                                       raises(Errno::ECONNREFUSED).
+                                       raises(EOFError)
+
+    assert_raises(ActiveMerchant::ConnectionError) do
+      retry_exceptions :retry_safe => true do
+        @requester.post
+      end
+    end
+  end
+
+  def test_failure_with_ssl_certificate
+    @requester.expects(:post).raises(OpenSSL::X509::CertificateError)
+
+    assert_raises(ActiveMerchant::ClientCertificateError) do
+      retry_exceptions do
+        @requester.post
+      end
+    end
+  end
+
+  def test_failure_with_ssl_certificate_logs_error_if_logger_specified
+    @logger.expects(:error).once
+    @requester.expects(:post).raises(OpenSSL::X509::CertificateError)
+
+    assert_raises(ActiveMerchant::ClientCertificateError) do
+      retry_exceptions :logger => @logger do
+        @requester.post
+      end
+    end
+  end
+
+  def test_failure_with_additional_exceptions_specified
+    @requester.expects(:post).raises(MyNewError)
+
+    assert_raises(ActiveMerchant::ConnectionError) do
+      retry_exceptions :connection_exceptions => {MyNewError => "my message"} do
+        @requester.post
+      end
+    end
+  end
+
+  def test_failure_without_additional_exceptions_specified
+    @requester.expects(:post).raises(MyNewError)
+
+    assert_raises(MyNewError) do
+      retry_exceptions do
+        @requester.post
+      end
+    end
+  end
+end

data/test/unit/posts_data_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+require 'active_support/core_ext/class'
+
+class PostsDataTest < Test::Unit::TestCase
+
+  class SSLPoster
+    include PostsData
+
+    attr_accessor :logger
+  end
+
+  def setup
+    @poster = SSLPoster.new
+  end
+
+  def test_logger_warns_if_ssl_strict_disabled
+    @poster.logger = stub()
+    @poster.logger.expects(:warn).with("PostsDataTest::SSLPoster using ssl_strict=false, which is insecure")
+
+    Connection.any_instance.stubs(:request)
+
+    SSLPoster.ssl_strict = false
+    @poster.raw_ssl_request(:post, "https://shopify.com", "", {})
+  end
+
+  def test_logger_no_warning_if_ssl_strict_enabled
+    @poster.logger = stub()
+    @poster.logger.stubs(:warn).never
+    Connection.any_instance.stubs(:request)
+
+    SSLPoster.ssl_strict = true
+    @poster.raw_ssl_request(:post, "https://shopify.com", "", {})
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_utils
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-13 00:00:00.000000000 Z
+date: 2012-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2164858760 !ruby/object:Gem::Requirement
+  requirement: &70122750912260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.11
   type: :runtime
   prerelease: false
-  version_requirements: *2164858760
+  version_requirements: *70122750912260
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2164856640 !ruby/object:Gem::Requirement
+  requirement: &70122750911460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164856640
+  version_requirements: *70122750911460
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2164854980 !ruby/object:Gem::Requirement
+  requirement: &70122750910440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164854980
+  version_requirements: *70122750910440
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2164870020 !ruby/object:Gem::Requirement
+  requirement: &70122750909780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164870020
+  version_requirements: *70122750909780
 description: 
 email:
 - developers@jadedpixel.com
@@ -72,6 +72,7 @@ files:
 - lib/active_utils/common/connection.rb
 - lib/active_utils/common/country.rb
 - lib/active_utils/common/error.rb
+- lib/active_utils/common/network_connection_retries.rb
 - lib/active_utils/common/post_data.rb
 - lib/active_utils/common/posts_data.rb
 - lib/active_utils/common/requires_parameters.rb
@@ -83,7 +84,9 @@ files:
 - test/unit/connection_test.rb
 - test/unit/country_code_test.rb
 - test/unit/country_test.rb
+- test/unit/network_connection_retries_test.rb
 - test/unit/post_data_test.rb
+- test/unit/posts_data_test.rb
 - test/unit/utils_test.rb
 - test/unit/validateable_test.rb
 homepage: http://github.com/shopify/active_utils
@@ -115,6 +118,8 @@ test_files:
 - test/unit/connection_test.rb
 - test/unit/country_code_test.rb
 - test/unit/country_test.rb
+- test/unit/network_connection_retries_test.rb
 - test/unit/post_data_test.rb
+- test/unit/posts_data_test.rb
 - test/unit/utils_test.rb
 - test/unit/validateable_test.rb