gocardless_pro 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a89de0204c5098ce2b5049a622271defb672b0abf80ad4fc0d1f6ef3538f88b8
-  data.tar.gz: ece535f8f59810a51656f5e01b2667db60488f73cbd953a66a86e8bfa48da1e5
+  metadata.gz: 06d8895916dd0f220182f39eb35a9c286f50288c84391984715f2362b142319d
+  data.tar.gz: d2839e1c60c82d2907980843abb9c8e1e6a911d7a157752be15cf773b8333b4d
 SHA512:
-  metadata.gz: 5a793807b561f52c2abdf3989d335ffa14d6dbdb2509c5f11d27fefb29bf82b9cf73c4937640b76d2a35ac869704798401e7636fe7a9a590e4f1d110171da1d9
-  data.tar.gz: e89fb66ba9c3b79e7f1c10e5b1812bee44a82bcd33526b018f963570c364cf8168bbc93574dd5ca4e5988b80d6aaa5665450edb62a76fbdb5f73ca244f065e93
+  metadata.gz: 4cb9c53de215e5ad3c01d83f0568e3b6fa58bd5fc50daa43de0115977cf49e0d74f9e47836d99d1c5c0b9eb51663b778c4de572c7a8190cb97650b1d6cfbfa62
+  data.tar.gz: e247fb19810b43ca4131471833e700734c77231f0ebb8109da023229846c63cb1a12df04d232d2430ad69ec46fc9ce6e51ed4dc7a09d9d9066467125c72a8408

data/README.md

@@ -147,18 +147,14 @@ The most common use of a custom header would be to set a custom [idempotency key
 
 ### Handling failures
 
-When the API returns an error, the client will raise a corresponding one. There are four classes of error which could be thrown, all of which subclass `GoCardlessPro::Error`:
+When the API itself returns an error, the client will raise a corresponding exception. There are four classes of exception which could be thrown, all of which subclass `GoCardlessPro::Error`:
 
 - `GoCardlessPro::GoCardlessError`
 - `GoCardlessPro::InvalidApiUsageError`
 - `GoCardlessPro::InvalidStateError`
 - `GoCardlessPro::ValidationError`
 
-These errors are fully documented in the [API documentation](https://developer.gocardless.com/api-reference/#overview-errors).
-
-When the API returns an `invalid_state` error due to an `idempotent_creation_conflict`, where possible, the library will automatically retrieve the existing record which was created using the idempotency key.
-
-All errors have the following methods to facilitate access to information in the API response:
+These different types of error are fully documented in the [API documentation](https://developer.gocardless.com/api-reference/#overview-errors). Exceptions raised by the library have the following methods to provide access to information in the API response:
 
 - `#documentation_url`
 - `#message`
@@ -167,7 +163,15 @@ All errors have the following methods to facilitate access to information in the
 - `#request_id`
 - `#errors`
 
-If a timeout occurs, and the request being made is idempotent, the library will automatically retry the request up to 3 times before giving up and raising a `Faraday::TimeoutError` error.
+When the API returns an `invalid_state` error due to an `idempotent_creation_conflict`, where possible, the library will automatically retrieve the existing record which was created using the idempotency key.
+
+If the client is unable to connect to GoCardless, an appropriate exception will be raised, for example:
+
+* `Faraday::TimeoutError`, in case of a timeout
+* `Faraday::ConnectionFailed`, in case of a connection issue (e.g. problems with DNS resolution)
+* `GoCardlessPro::ApiError`, for `5xx` errors returned from our infrastructure, but not by the API itself
+
+If an error occurs which is likely to be resolved with a retry (e.g. a timeout or connection error), and the request being made is idempotent, the library will automatically retry the request twice (i.e. it will make up to 3 attempts) before giving up and raising an exception.
 
 ### Using the OAuth API
 

data/lib/gocardless_pro/client.rb

@@ -133,7 +133,7 @@ module GoCardlessPro
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.9.0',
+          'GoCardless-Client-Version' => '2.10.0',
         },
       }
     end

data/lib/gocardless_pro/request.rb

@@ -3,8 +3,12 @@ require 'securerandom'
 module GoCardlessPro
   # A class that wraps an API request
   class Request
-    MAX_NETWORK_RETRIES = 3
+    MAX_RETRIES = 3
     RETRY_DELAY = 0.5
+    RETRYABLE_EXCEPTIONS = [Faraday::TimeoutError,
+                            Faraday::ConnectionFailed,
+                            GoCardlessPro::ApiError,
+                            GoCardlessPro::GoCardlessError].freeze
 
     # Initialize a request class, which makes calls to the API
     # @param connection
@@ -42,13 +46,14 @@ module GoCardlessPro
 
     def with_retries
       requests_attempted = 0
-      total_requests_allowed = MAX_NETWORK_RETRIES + 1
+      total_requests_allowed = MAX_RETRIES
 
       begin
         yield
       rescue => exception
+        requests_attempted += 1
+
         if requests_attempted < total_requests_allowed && should_retry?(exception)
-          requests_attempted += 1
           sleep(RETRY_DELAY)
           retry
         else
@@ -90,9 +95,7 @@ module GoCardlessPro
     private
 
     def should_retry?(exception)
-      return true if exception.is_a?(Faraday::TimeoutError)
-      return true if exception.is_a?(Faraday::ConnectionFailed)
-      return true if exception.is_a?(GoCardlessPro::ApiError)
+      RETRYABLE_EXCEPTIONS.include?(exception.class)
     end
   end
 end

data/lib/gocardless_pro/version.rb

@@ -4,5 +4,5 @@ end
 
 module GoCardlessPro
   # Current version of the GC gem
-  VERSION = '2.9.0'.freeze
+  VERSION = '2.10.0'.freeze
 end

data/spec/services/creditor_bank_accounts_service_spec.rb

@@ -563,7 +563,7 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
         expect(stub).to have_been_requested.twice
       end
 
-      it 'retries 5XX errors' do
+      it 'retries 5XX errors, other than 500s' do
         stub_url = '/creditor_bank_accounts/:identity'.gsub(':identity', id)
 
         stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
@@ -575,6 +575,34 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
         get_response
         expect(stub).to have_been_requested.twice
       end
+
+      it 'retries 500 errors returned by the API' do
+        stub_url = '/creditor_bank_accounts/:identity'.gsub(':identity', id)
+
+        gocardless_error = {
+          'error' => {
+            'message' => 'Internal server error',
+            'documentation_url' => 'https://developer.gocardless.com/#gocardless',
+            'errors' => [{
+              'message' => 'Internal server error',
+              'reason' => 'internal_server_error',
+            }],
+            'type' => 'gocardless',
+            'code' => 500,
+            'request_id' => 'dummy_request_id',
+            'id' => 'dummy_exception_id',
+          },
+        }
+
+        stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+               to_return(status: 500,
+                         headers: response_headers,
+                         body: gocardless_error.to_json).
+               then.to_return(status: 200, headers: response_headers)
+
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
     end
   end
 

data/spec/services/creditors_service_spec.rb

@@ -643,7 +643,7 @@ describe GoCardlessPro::Services::CreditorsService do
         expect(stub).to have_been_requested.twice
       end
 
-      it 'retries 5XX errors' do
+      it 'retries 5XX errors, other than 500s' do
         stub_url = '/creditors/:identity'.gsub(':identity', id)
 
         stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
@@ -655,6 +655,34 @@ describe GoCardlessPro::Services::CreditorsService do
         get_response
         expect(stub).to have_been_requested.twice
       end
+
+      it 'retries 500 errors returned by the API' do
+        stub_url = '/creditors/:identity'.gsub(':identity', id)
+
+        gocardless_error = {
+          'error' => {
+            'message' => 'Internal server error',
+            'documentation_url' => 'https://developer.gocardless.com/#gocardless',
+            'errors' => [{
+              'message' => 'Internal server error',
+              'reason' => 'internal_server_error',
+            }],
+            'type' => 'gocardless',
+            'code' => 500,
+            'request_id' => 'dummy_request_id',
+            'id' => 'dummy_exception_id',
+          },
+        }
+
+        stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+               to_return(status: 500,
+                         headers: response_headers,
+                         body: gocardless_error.to_json).
+               then.to_return(status: 200, headers: response_headers)
+
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
     end
   end
 

data/spec/services/customer_bank_accounts_service_spec.rb

@@ -563,7 +563,7 @@ describe GoCardlessPro::Services::CustomerBankAccountsService do
         expect(stub).to have_been_requested.twice
       end
 
-      it 'retries 5XX errors' do
+      it 'retries 5XX errors, other than 500s' do
         stub_url = '/customer_bank_accounts/:identity'.gsub(':identity', id)
 
         stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
@@ -575,6 +575,34 @@ describe GoCardlessPro::Services::CustomerBankAccountsService do
         get_response
         expect(stub).to have_been_requested.twice
       end
+
+      it 'retries 500 errors returned by the API' do
+        stub_url = '/customer_bank_accounts/:identity'.gsub(':identity', id)
+
+        gocardless_error = {
+          'error' => {
+            'message' => 'Internal server error',
+            'documentation_url' => 'https://developer.gocardless.com/#gocardless',
+            'errors' => [{
+              'message' => 'Internal server error',
+              'reason' => 'internal_server_error',
+            }],
+            'type' => 'gocardless',
+            'code' => 500,
+            'request_id' => 'dummy_request_id',
+            'id' => 'dummy_exception_id',
+          },
+        }
+
+        stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+               to_return(status: 500,
+                         headers: response_headers,
+                         body: gocardless_error.to_json).
+               then.to_return(status: 200, headers: response_headers)
+
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
     end
   end
 

data/spec/services/customers_service_spec.rb

@@ -677,7 +677,7 @@ describe GoCardlessPro::Services::CustomersService do
         expect(stub).to have_been_requested.twice
       end
 
-      it 'retries 5XX errors' do
+      it 'retries 5XX errors, other than 500s' do
         stub_url = '/customers/:identity'.gsub(':identity', id)
 
         stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
@@ -689,6 +689,34 @@ describe GoCardlessPro::Services::CustomersService do
         get_response
         expect(stub).to have_been_requested.twice
       end
+
+      it 'retries 500 errors returned by the API' do
+        stub_url = '/customers/:identity'.gsub(':identity', id)
+
+        gocardless_error = {
+          'error' => {
+            'message' => 'Internal server error',
+            'documentation_url' => 'https://developer.gocardless.com/#gocardless',
+            'errors' => [{
+              'message' => 'Internal server error',
+              'reason' => 'internal_server_error',
+            }],
+            'type' => 'gocardless',
+            'code' => 500,
+            'request_id' => 'dummy_request_id',
+            'id' => 'dummy_exception_id',
+          },
+        }
+
+        stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+               to_return(status: 500,
+                         headers: response_headers,
+                         body: gocardless_error.to_json).
+               then.to_return(status: 200, headers: response_headers)
+
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
     end
   end
 

data/spec/services/events_service_spec.rb

@@ -345,7 +345,7 @@ describe GoCardlessPro::Services::EventsService do
         expect(stub).to have_been_requested.twice
       end
 
-      it 'retries 5XX errors' do
+      it 'retries 5XX errors, other than 500s' do
         stub_url = '/events/:identity'.gsub(':identity', id)
 
         stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
@@ -357,6 +357,34 @@ describe GoCardlessPro::Services::EventsService do
         get_response
         expect(stub).to have_been_requested.twice
       end
+
+      it 'retries 500 errors returned by the API' do
+        stub_url = '/events/:identity'.gsub(':identity', id)
+
+        gocardless_error = {
+          'error' => {
+            'message' => 'Internal server error',
+            'documentation_url' => 'https://developer.gocardless.com/#gocardless',
+            'errors' => [{
+              'message' => 'Internal server error',
+              'reason' => 'internal_server_error',
+            }],
+            'type' => 'gocardless',
+            'code' => 500,
+            'request_id' => 'dummy_request_id',
+            'id' => 'dummy_exception_id',
+          },
+        }
+
+        stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+               to_return(status: 500,
+                         headers: response_headers,
+                         body: gocardless_error.to_json).
+               then.to_return(status: 200, headers: response_headers)
+
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
     end
   end
 end

data/spec/services/mandate_imports_service_spec.rb

@@ -257,7 +257,7 @@ describe GoCardlessPro::Services::MandateImportsService do
         expect(stub).to have_been_requested.twice
       end
 
-      it 'retries 5XX errors' do
+      it 'retries 5XX errors, other than 500s' do
         stub_url = '/mandate_imports/:identity'.gsub(':identity', id)
 
         stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
@@ -269,6 +269,34 @@ describe GoCardlessPro::Services::MandateImportsService do
         get_response
         expect(stub).to have_been_requested.twice
       end
+
+      it 'retries 500 errors returned by the API' do
+        stub_url = '/mandate_imports/:identity'.gsub(':identity', id)
+
+        gocardless_error = {
+          'error' => {
+            'message' => 'Internal server error',
+            'documentation_url' => 'https://developer.gocardless.com/#gocardless',
+            'errors' => [{
+              'message' => 'Internal server error',
+              'reason' => 'internal_server_error',
+            }],
+            'type' => 'gocardless',
+            'code' => 500,
+            'request_id' => 'dummy_request_id',
+            'id' => 'dummy_exception_id',
+          },
+        }
+
+        stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+               to_return(status: 500,
+                         headers: response_headers,
+                         body: gocardless_error.to_json).
+               then.to_return(status: 200, headers: response_headers)
+
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
     end
   end
 

data/spec/services/mandates_service_spec.rb

@@ -547,7 +547,7 @@ describe GoCardlessPro::Services::MandatesService do
         expect(stub).to have_been_requested.twice
       end
 
-      it 'retries 5XX errors' do
+      it 'retries 5XX errors, other than 500s' do
         stub_url = '/mandates/:identity'.gsub(':identity', id)
 
         stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
@@ -559,6 +559,34 @@ describe GoCardlessPro::Services::MandatesService do
         get_response
         expect(stub).to have_been_requested.twice
       end
+
+      it 'retries 500 errors returned by the API' do
+        stub_url = '/mandates/:identity'.gsub(':identity', id)
+
+        gocardless_error = {
+          'error' => {
+            'message' => 'Internal server error',
+            'documentation_url' => 'https://developer.gocardless.com/#gocardless',
+            'errors' => [{
+              'message' => 'Internal server error',
+              'reason' => 'internal_server_error',
+            }],
+            'type' => 'gocardless',
+            'code' => 500,
+            'request_id' => 'dummy_request_id',
+            'id' => 'dummy_exception_id',
+          },
+        }
+
+        stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+               to_return(status: 500,
+                         headers: response_headers,
+                         body: gocardless_error.to_json).
+               then.to_return(status: 200, headers: response_headers)
+
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
     end
   end
 

data/spec/services/payments_service_spec.rb

@@ -579,7 +579,7 @@ describe GoCardlessPro::Services::PaymentsService do
         expect(stub).to have_been_requested.twice
       end
 
-      it 'retries 5XX errors' do
+      it 'retries 5XX errors, other than 500s' do
         stub_url = '/payments/:identity'.gsub(':identity', id)
 
         stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
@@ -591,6 +591,34 @@ describe GoCardlessPro::Services::PaymentsService do
         get_response
         expect(stub).to have_been_requested.twice
       end
+
+      it 'retries 500 errors returned by the API' do
+        stub_url = '/payments/:identity'.gsub(':identity', id)
+
+        gocardless_error = {
+          'error' => {
+            'message' => 'Internal server error',
+            'documentation_url' => 'https://developer.gocardless.com/#gocardless',
+            'errors' => [{
+              'message' => 'Internal server error',
+              'reason' => 'internal_server_error',
+            }],
+            'type' => 'gocardless',
+            'code' => 500,
+            'request_id' => 'dummy_request_id',
+            'id' => 'dummy_exception_id',
+          },
+        }
+
+        stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+               to_return(status: 500,
+                         headers: response_headers,
+                         body: gocardless_error.to_json).
+               then.to_return(status: 200, headers: response_headers)
+
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
     end
   end
 

data/spec/services/payouts_service_spec.rb

@@ -378,7 +378,7 @@ describe GoCardlessPro::Services::PayoutsService do
         expect(stub).to have_been_requested.twice
       end
 
-      it 'retries 5XX errors' do
+      it 'retries 5XX errors, other than 500s' do
         stub_url = '/payouts/:identity'.gsub(':identity', id)
 
         stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
@@ -390,6 +390,34 @@ describe GoCardlessPro::Services::PayoutsService do
         get_response
         expect(stub).to have_been_requested.twice
       end
+
+      it 'retries 500 errors returned by the API' do
+        stub_url = '/payouts/:identity'.gsub(':identity', id)
+
+        gocardless_error = {
+          'error' => {
+            'message' => 'Internal server error',
+            'documentation_url' => 'https://developer.gocardless.com/#gocardless',
+            'errors' => [{
+              'message' => 'Internal server error',
+              'reason' => 'internal_server_error',
+            }],
+            'type' => 'gocardless',
+            'code' => 500,
+            'request_id' => 'dummy_request_id',
+            'id' => 'dummy_exception_id',
+          },
+        }
+
+        stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+               to_return(status: 500,
+                         headers: response_headers,
+                         body: gocardless_error.to_json).
+               then.to_return(status: 200, headers: response_headers)
+
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
     end
   end
 end

data/spec/services/redirect_flows_service_spec.rb

@@ -292,7 +292,7 @@ describe GoCardlessPro::Services::RedirectFlowsService do
         expect(stub).to have_been_requested.twice
       end
 
-      it 'retries 5XX errors' do
+      it 'retries 5XX errors, other than 500s' do
         stub_url = '/redirect_flows/:identity'.gsub(':identity', id)
 
         stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
@@ -304,6 +304,34 @@ describe GoCardlessPro::Services::RedirectFlowsService do
         get_response
         expect(stub).to have_been_requested.twice
       end
+
+      it 'retries 500 errors returned by the API' do
+        stub_url = '/redirect_flows/:identity'.gsub(':identity', id)
+
+        gocardless_error = {
+          'error' => {
+            'message' => 'Internal server error',
+            'documentation_url' => 'https://developer.gocardless.com/#gocardless',
+            'errors' => [{
+              'message' => 'Internal server error',
+              'reason' => 'internal_server_error',
+            }],
+            'type' => 'gocardless',
+            'code' => 500,
+            'request_id' => 'dummy_request_id',
+            'id' => 'dummy_exception_id',
+          },
+        }
+
+        stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+               to_return(status: 500,
+                         headers: response_headers,
+                         body: gocardless_error.to_json).
+               then.to_return(status: 200, headers: response_headers)
+
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
     end
   end
 

data/spec/services/refunds_service_spec.rb

@@ -515,7 +515,7 @@ describe GoCardlessPro::Services::RefundsService do
         expect(stub).to have_been_requested.twice
       end
 
-      it 'retries 5XX errors' do
+      it 'retries 5XX errors, other than 500s' do
         stub_url = '/refunds/:identity'.gsub(':identity', id)
 
         stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
@@ -527,6 +527,34 @@ describe GoCardlessPro::Services::RefundsService do
         get_response
         expect(stub).to have_been_requested.twice
       end
+
+      it 'retries 500 errors returned by the API' do
+        stub_url = '/refunds/:identity'.gsub(':identity', id)
+
+        gocardless_error = {
+          'error' => {
+            'message' => 'Internal server error',
+            'documentation_url' => 'https://developer.gocardless.com/#gocardless',
+            'errors' => [{
+              'message' => 'Internal server error',
+              'reason' => 'internal_server_error',
+            }],
+            'type' => 'gocardless',
+            'code' => 500,
+            'request_id' => 'dummy_request_id',
+            'id' => 'dummy_exception_id',
+          },
+        }
+
+        stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+               to_return(status: 500,
+                         headers: response_headers,
+                         body: gocardless_error.to_json).
+               then.to_return(status: 200, headers: response_headers)
+
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
     end
   end
 

data/spec/services/subscriptions_service_spec.rb

@@ -675,7 +675,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
         expect(stub).to have_been_requested.twice
       end
 
-      it 'retries 5XX errors' do
+      it 'retries 5XX errors, other than 500s' do
         stub_url = '/subscriptions/:identity'.gsub(':identity', id)
 
         stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
@@ -687,6 +687,34 @@ describe GoCardlessPro::Services::SubscriptionsService do
         get_response
         expect(stub).to have_been_requested.twice
       end
+
+      it 'retries 500 errors returned by the API' do
+        stub_url = '/subscriptions/:identity'.gsub(':identity', id)
+
+        gocardless_error = {
+          'error' => {
+            'message' => 'Internal server error',
+            'documentation_url' => 'https://developer.gocardless.com/#gocardless',
+            'errors' => [{
+              'message' => 'Internal server error',
+              'reason' => 'internal_server_error',
+            }],
+            'type' => 'gocardless',
+            'code' => 500,
+            'request_id' => 'dummy_request_id',
+            'id' => 'dummy_exception_id',
+          },
+        }
+
+        stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+               to_return(status: 500,
+                         headers: response_headers,
+                         body: gocardless_error.to_json).
+               then.to_return(status: 200, headers: response_headers)
+
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2018-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec