stripe 1.45.0 → 1.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ed148072cc048ea24b62fc7a64645d8714eec90
-  data.tar.gz: 2f478d4c522c9cff1cf502328289233f0b71c8b2
+  metadata.gz: d883d1c0eb0486e3c51e5076178c4351ca70ee68
+  data.tar.gz: a992c6c4e854019538a0406dbca5382c8f99d77e
 SHA512:
-  metadata.gz: 4035922aa5bd4d02bf82ea89c52c645cf761ebbedea8ca165b81a6a379af363b9a027911313d447c7db9e846e633774780a0e838b9771c3aaf0fa132992028e2
-  data.tar.gz: ee89f0e1140edeead9e86733d3467468dcdf94551b35878ae438e0acd7dd70ec3a68ca66e3acf5e29d23d194f8cd59bb4641e5d0e6c2eb8efd6ebbe8dc991f1e
+  metadata.gz: caf72f6851481ed302b8d06d450b55cf72c260104e549c099f52bb7477ec0ec28777648f4d3e4edae0f1c96cfec8123248a645cb316325cefec4f04cab74fab8
+  data.tar.gz: 165a6679fea615754af43de70e04c5d33a225ad1e938222e7c13767736bcdd9955162b22f266044f20818758ec3bcae0bb366c1c641b3fe1a388ed441315264b

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.46.0 2016-07-07
+
+* Allow retry when a 409 conflict is encountered
+
 === 1.45.0 2016-07-07
 
 * Do not send subresources when updating except when explicitly told to do so (see #433)

data/VERSION

@@ -1 +1 @@
-1.45.0
+1.46.0

data/lib/stripe.rb

@@ -68,6 +68,23 @@ require 'stripe/errors/rate_limit_error'
 module Stripe
   DEFAULT_CA_BUNDLE_PATH = File.dirname(__FILE__) + '/data/ca-certificates.crt'
 
+  # HTTP status exceptions which we'd like to retry. Most HTTP status
+  # exceptions are from a Stripe API server response, so we generally _don't_
+  # retry because doing so would have the same result as the original request.
+  RETRY_HTTP_EXCEPTIONS = [
+    # A server may respond with a 409 to indicate that there is a concurrent
+    # request executing with the same idempotency key. In the case that a
+    # request failed due to a connection problem and the client has retried too
+    # early, but the server is still executing the old request, we would like
+    # the client to continue retrying until getting a "real" response status
+    # back.
+    RestClient::Conflict,
+
+    # Retry on timeout-related problems. This shouldn't be lumped in with HTTP
+    # exceptions, but with RestClient it is.
+    RestClient::RequestTimeout,
+  ].freeze
+
   @api_base = 'https://api.stripe.com'
   @connect_base = 'https://connect.stripe.com'
   @uploads_base = 'https://uploads.stripe.com'
@@ -194,24 +211,45 @@ module Stripe
   def self.execute_request_with_rescues(request_opts, api_base_url, retry_count = 0)
     begin
       response = execute_request(request_opts)
-    rescue SocketError => e
-      response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
-    rescue NoMethodError => e
-      # Work around RestClient bug
-      if e.message =~ /\WRequestFailed\W/
-        e = APIConnectionError.new('Unexpected HTTP response code')
+
+    # We rescue all exceptions from a request so that we have an easy spot to
+    # implement our retry logic across the board. We'll re-raise if it's a type
+    # of exception that we didn't expect to handle.
+    rescue => e
+      if should_retry?(e, retry_count)
+        retry_count = retry_count + 1
+        sleep sleep_time(retry_count)
+        retry
+      end
+
+      case e
+      when SocketError
+        response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
+
+      when NoMethodError
+        # Work around RestClient bug
+        if e.message =~ /\WRequestFailed\W/
+          e = APIConnectionError.new('Unexpected HTTP response code')
+          response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
+        else
+          raise
+        end
+
+      when RestClient::ExceptionWithResponse
+        if e.response
+          handle_api_error(e.response)
+        else
+          response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
+        end
+
+      when RestClient::Exception, Errno::ECONNREFUSED, OpenSSL::SSL::SSLError
         response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
+
+      # Only handle errors when we know we can do so, and re-raise otherwise.
+      # This should be pretty infrequent.
       else
         raise
       end
-    rescue RestClient::ExceptionWithResponse => e
-      if e.response
-        handle_api_error(e.response)
-      else
-        response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
-      end
-    rescue RestClient::Exception, Errno::ECONNREFUSED, OpenSSL::SSL::SSLError => e
-      response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
     end
 
     response
@@ -367,13 +405,6 @@ module Stripe
 
   def self.handle_restclient_error(e, request_opts, retry_count, api_base_url=nil)
 
-    if should_retry?(e, retry_count)
-      retry_count = retry_count + 1
-      sleep sleep_time(retry_count)
-      response = execute_request_with_rescues(request_opts, api_base_url, retry_count)
-      return response
-    end
-
     api_base_url = @api_base unless api_base_url
     connection_message = "Please check your internet connection and try again. " \
         "If this problem persists, you should check Stripe's service status at " \
@@ -419,7 +450,16 @@ module Stripe
 
   def self.should_retry?(e, retry_count)
     return false if retry_count >= self.max_network_retries
+
+    # Certificate validation problem: do not retry.
     return false if e.is_a?(RestClient::SSLCertificateNotVerified)
+
+    # Generally don't retry when we got a successful response back from the
+    # Stripe API server, but with some exceptions (for more details, see notes
+    # on RETRY_HTTP_EXCEPTIONS).
+    return false if e.is_a?(RestClient::ExceptionWithResponse) &&
+      !RETRY_HTTP_EXCEPTIONS.any? { |klass| e.is_a?(klass) }
+
     return true
   end
 

data/lib/stripe/version.rb

@@ -1,3 +1,3 @@
 module Stripe
-  VERSION = '1.45.0'
+  VERSION = '1.46.0'
 end

data/test/stripe/api_resource_test.rb

@@ -685,14 +685,14 @@ module Stripe
     end
 
     context "with retries" do
-
       setup do
         Stripe.stubs(:max_network_retries).returns(2)
       end
 
       should 'retry failed network requests if specified and raise if error persists' do
         Stripe.expects(:sleep_time).at_least_once.returns(0)
-        @mock.expects(:post).times(3).with('https://api.stripe.com/v1/charges', nil, 'amount=50&currency=usd').raises(Errno::ECONNREFUSED.new)
+        @mock.expects(:post).times(3).with('https://api.stripe.com/v1/charges', nil, 'amount=50&currency=usd').
+          raises(Errno::ECONNREFUSED.new)
 
         err = assert_raises Stripe::APIConnectionError do
           Stripe::Charge.create(:amount => 50, :currency => 'usd', :card => { :number => nil })
@@ -704,34 +704,15 @@ module Stripe
         Stripe.expects(:sleep_time).at_least_once.returns(0)
         response = make_response({"id" => "myid"})
         err = Errno::ECONNREFUSED.new
-        @mock.expects(:post).times(2).with('https://api.stripe.com/v1/charges', nil, 'amount=50&currency=usd').raises(err).then.returns(response)
+        @mock.expects(:post).times(2).with('https://api.stripe.com/v1/charges', nil, 'amount=50&currency=usd').
+          raises(Errno::ECONNREFUSED.new).
+          then.
+          returns(response)
 
         result = Stripe::Charge.create(:amount => 50, :currency => 'usd', :card => { :number => nil })
         assert_equal "myid", result.id
       end
 
-      # We retry the request if we receive SSL errors, since these can be caused
-      # by transient network issues, in addition to compatibility issues between
-      # the client and server.
-      should 'retry failed network requests if they fail with OpenSSL::SSL::SSLError' do
-        Stripe.expects(:sleep_time).at_least_once.returns(0)
-        @mock.expects(:post).times(3).with('https://api.stripe.com/v1/charges', nil, 'amount=50&currency=usd').raises(OpenSSL::SSL::SSLError.new('message'))
-
-        err = assert_raises Stripe::APIConnectionError do
-          Stripe::Charge.create(:amount => 50, :currency => 'usd', :card => { :number => nil })
-        end
-        assert_match(/Request was retried 2 times/, err.message)
-      end
-
-      should 'not retry a SSLCertificateNotVerified error' do
-        @mock.expects(:post).times(1).with('https://api.stripe.com/v1/charges', nil, 'amount=50&currency=usd').raises(RestClient::SSLCertificateNotVerified.new('message'))
-
-        err = assert_raises Stripe::APIConnectionError do
-          Stripe::Charge.create(:amount => 50, :currency => 'usd', :card => { :number => nil })
-        end
-        assert_no_match(/retried/, err.message)
-      end
-
       should 'not add an idempotency key to GET requests' do
         SecureRandom.expects(:uuid).times(0)
         Stripe.expects(:execute_request).with do |opts|
@@ -770,8 +751,33 @@ module Stripe
 
     end
 
-    context "sleep_time" do
+    context ".should_retry?" do
+      setup do
+        Stripe.stubs(:max_network_retries).returns(2)
+      end
+
+      should 'retry on a low-level network error' do
+        assert Stripe.should_retry?(Errno::ECONNREFUSED.new, 0)
+      end
+
+      should 'retry on timeout' do
+        assert Stripe.should_retry?(RestClient::RequestTimeout.new, 0)
+      end
 
+      should 'retry on a conflict' do
+        assert Stripe.should_retry?(RestClient::Conflict.new, 0)
+      end
+
+      should 'not retry at maximum count' do
+        refute Stripe.should_retry?(RuntimeError.new, Stripe.max_network_retries)
+      end
+
+      should 'not retry on a certificate validation error' do
+        refute Stripe.should_retry?(RestClient::SSLCertificateNotVerified.new('message'), 0)
+      end
+    end
+
+    context ".sleep_time" do
       should "should grow exponentially" do
         Stripe.stubs(:rand).returns(1)
         Stripe.stubs(:max_network_retry_delay).returns(999)
@@ -808,7 +814,6 @@ module Stripe
         assert_equal(base_value * 4, Stripe.sleep_time(3))
         assert_equal(base_value * 8, Stripe.sleep_time(4))
       end
-
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 1.45.0
+  version: 1.46.0
 platform: ruby
 authors:
 - Stripe