gocardless_pro 1.1.0 → 2.0.0

data/lib/gocardless_pro/services/payments_service.rb

@@ -26,7 +26,19 @@ module GoCardlessPro
         params = options.delete(:params) || {}
         options[:params] = {}
         options[:params][envelope_key] = params
-        response = make_request(:post, path, options)
+
+        options[:retry_failures] = true
+
+        begin
+          response = make_request(:post, path, options)
+
+          # Response doesn't raise any errors until #body is called
+          response.tap(&:body)
+        rescue InvalidStateError => e
+          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+
+          raise e
+        end
 
         return if response.body.nil?
 
@@ -40,7 +52,10 @@ module GoCardlessPro
       def list(options = {})
         path = '/payments'
 
+        options[:retry_failures] = true
+
         response = make_request(:get, path, options)
+
         ListResponse.new(
           response: response,
           unenveloped_body: unenvelope_body(response.body),
@@ -67,6 +82,8 @@ module GoCardlessPro
       def get(identity, options = {})
         path = sub_url('/payments/:identity', 'identity' => identity)
 
+        options[:retry_failures] = true
+
         response = make_request(:get, path, options)
 
         return if response.body.nil?
@@ -85,6 +102,9 @@ module GoCardlessPro
         params = options.delete(:params) || {}
         options[:params] = {}
         options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
         response = make_request(:put, path, options)
 
         return if response.body.nil?
@@ -108,7 +128,19 @@ module GoCardlessPro
         params = options.delete(:params) || {}
         options[:params] = {}
         options[:params]['data'] = params
-        response = make_request(:post, path, options)
+
+        options[:retry_failures] = false
+
+        begin
+          response = make_request(:post, path, options)
+
+          # Response doesn't raise any errors until #body is called
+          response.tap(&:body)
+        rescue InvalidStateError => e
+          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+
+          raise e
+        end
 
         return if response.body.nil?
 
@@ -137,7 +169,19 @@ module GoCardlessPro
         params = options.delete(:params) || {}
         options[:params] = {}
         options[:params]['data'] = params
-        response = make_request(:post, path, options)
+
+        options[:retry_failures] = false
+
+        begin
+          response = make_request(:post, path, options)
+
+          # Response doesn't raise any errors until #body is called
+          response.tap(&:body)
+        rescue InvalidStateError => e
+          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+
+          raise e
+        end
 
         return if response.body.nil?
 

data/lib/gocardless_pro/services/payouts_service.rb

@@ -18,7 +18,10 @@ module GoCardlessPro
       def list(options = {})
         path = '/payouts'
 
+        options[:retry_failures] = true
+
         response = make_request(:get, path, options)
+
         ListResponse.new(
           response: response,
           unenveloped_body: unenvelope_body(response.body),
@@ -47,6 +50,8 @@ module GoCardlessPro
       def get(identity, options = {})
         path = sub_url('/payouts/:identity', 'identity' => identity)
 
+        options[:retry_failures] = true
+
         response = make_request(:get, path, options)
 
         return if response.body.nil?

data/lib/gocardless_pro/services/redirect_flows_service.rb

@@ -21,7 +21,19 @@ module GoCardlessPro
         params = options.delete(:params) || {}
         options[:params] = {}
         options[:params][envelope_key] = params
-        response = make_request(:post, path, options)
+
+        options[:retry_failures] = true
+
+        begin
+          response = make_request(:post, path, options)
+
+          # Response doesn't raise any errors until #body is called
+          response.tap(&:body)
+        rescue InvalidStateError => e
+          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+
+          raise e
+        end
 
         return if response.body.nil?
 
@@ -36,6 +48,8 @@ module GoCardlessPro
       def get(identity, options = {})
         path = sub_url('/redirect_flows/:identity', 'identity' => identity)
 
+        options[:retry_failures] = true
+
         response = make_request(:get, path, options)
 
         return if response.body.nil?
@@ -64,7 +78,19 @@ module GoCardlessPro
         params = options.delete(:params) || {}
         options[:params] = {}
         options[:params]['data'] = params
-        response = make_request(:post, path, options)
+
+        options[:retry_failures] = false
+
+        begin
+          response = make_request(:post, path, options)
+
+          # Response doesn't raise any errors until #body is called
+          response.tap(&:body)
+        rescue InvalidStateError => e
+          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+
+          raise e
+        end
 
         return if response.body.nil?
 

data/lib/gocardless_pro/services/refunds_service.rb

@@ -38,7 +38,19 @@ module GoCardlessPro
         params = options.delete(:params) || {}
         options[:params] = {}
         options[:params][envelope_key] = params
-        response = make_request(:post, path, options)
+
+        options[:retry_failures] = true
+
+        begin
+          response = make_request(:post, path, options)
+
+          # Response doesn't raise any errors until #body is called
+          response.tap(&:body)
+        rescue InvalidStateError => e
+          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+
+          raise e
+        end
 
         return if response.body.nil?
 
@@ -52,7 +64,10 @@ module GoCardlessPro
       def list(options = {})
         path = '/refunds'
 
+        options[:retry_failures] = true
+
         response = make_request(:get, path, options)
+
         ListResponse.new(
           response: response,
           unenveloped_body: unenvelope_body(response.body),
@@ -79,6 +94,8 @@ module GoCardlessPro
       def get(identity, options = {})
         path = sub_url('/refunds/:identity', 'identity' => identity)
 
+        options[:retry_failures] = true
+
         response = make_request(:get, path, options)
 
         return if response.body.nil?
@@ -97,6 +114,9 @@ module GoCardlessPro
         params = options.delete(:params) || {}
         options[:params] = {}
         options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
         response = make_request(:put, path, options)
 
         return if response.body.nil?

data/lib/gocardless_pro/services/subscriptions_service.rb

@@ -20,7 +20,19 @@ module GoCardlessPro
         params = options.delete(:params) || {}
         options[:params] = {}
         options[:params][envelope_key] = params
-        response = make_request(:post, path, options)
+
+        options[:retry_failures] = true
+
+        begin
+          response = make_request(:post, path, options)
+
+          # Response doesn't raise any errors until #body is called
+          response.tap(&:body)
+        rescue InvalidStateError => e
+          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+
+          raise e
+        end
 
         return if response.body.nil?
 
@@ -34,7 +46,10 @@ module GoCardlessPro
       def list(options = {})
         path = '/subscriptions'
 
+        options[:retry_failures] = true
+
         response = make_request(:get, path, options)
+
         ListResponse.new(
           response: response,
           unenveloped_body: unenvelope_body(response.body),
@@ -61,6 +76,8 @@ module GoCardlessPro
       def get(identity, options = {})
         path = sub_url('/subscriptions/:identity', 'identity' => identity)
 
+        options[:retry_failures] = true
+
         response = make_request(:get, path, options)
 
         return if response.body.nil?
@@ -79,6 +96,9 @@ module GoCardlessPro
         params = options.delete(:params) || {}
         options[:params] = {}
         options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
         response = make_request(:put, path, options)
 
         return if response.body.nil?
@@ -102,7 +122,19 @@ module GoCardlessPro
         params = options.delete(:params) || {}
         options[:params] = {}
         options[:params]['data'] = params
-        response = make_request(:post, path, options)
+
+        options[:retry_failures] = false
+
+        begin
+          response = make_request(:post, path, options)
+
+          # Response doesn't raise any errors until #body is called
+          response.tap(&:body)
+        rescue InvalidStateError => e
+          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+
+          raise e
+        end
 
         return if response.body.nil?
 

data/lib/gocardless_pro/version.rb

@@ -4,5 +4,5 @@ end
 
 module GoCardlessPro
   # Current version of the GC gem
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end

data/spec/api_service_spec.rb

@@ -3,9 +3,19 @@ require 'spec_helper'
 describe GoCardlessPro::ApiService do
   subject(:service) { described_class.new('https://api.example.com', 'secret_token') }
 
+  let(:default_response) do
+    {
+      status: 200,
+      body: '{}',
+      headers: { 'Content-Type' => 'application/json' }
+    }
+  end
+
   it 'uses basic auth' do
     stub = stub_request(:get, 'https://api.example.com/customers')
            .with(headers: { 'Authorization' => 'Bearer secret_token' })
+           .to_return(default_response)
+
     service.make_request(:get, '/customers')
     expect(stub).to have_been_requested
   end
@@ -13,6 +23,17 @@ describe GoCardlessPro::ApiService do
   describe 'making a get request without any parameters' do
     it 'is expected to call the correct stub' do
       stub = stub_request(:get, /.*api.example.com\/customers/)
+             .to_return(default_response)
+
+      service.make_request(:get, '/customers')
+      expect(stub).to have_been_requested
+    end
+
+    it "doesn't include an idempotency key" do
+      stub = stub_request(:get, /.*api.example.com\/customers/)
+             .with { |request| !request.headers.key?('Idempotency-Key') }
+             .to_return(default_response)
+
       service.make_request(:get, '/customers')
       expect(stub).to have_been_requested
     end
@@ -21,6 +42,17 @@ describe GoCardlessPro::ApiService do
   describe 'making a get request with query parameters' do
     it 'correctly passes the query parameters' do
       stub = stub_request(:get, /.*api.example.com\/customers\?a=1&b=2/)
+             .to_return(default_response)
+
+      service.make_request(:get, '/customers', params: { a: 1, b: 2 })
+      expect(stub).to have_been_requested
+    end
+
+    it "doesn't include an idempotency key" do
+      stub = stub_request(:get, /.*api.example.com\/customers\?a=1&b=2/)
+             .with { |request| !request.headers.key?('Idempotency-Key') }
+             .to_return(default_response)
+
       service.make_request(:get, '/customers', params: { a: 1, b: 2 })
       expect(stub).to have_been_requested
     end
@@ -30,6 +62,25 @@ describe GoCardlessPro::ApiService do
     it 'passes the data in as the post body' do
       stub = stub_request(:post, /.*api.example.com\/customers/)
              .with(body: { given_name: 'Jack', family_name: 'Franklin' })
+             .to_return(default_response)
+
+      service.make_request(:post, '/customers', params: {
+                             given_name: 'Jack',
+                             family_name: 'Franklin'
+                           })
+      expect(stub).to have_been_requested
+    end
+
+    it 'generates a random idempotency key' do
+      allow(SecureRandom).to receive(:uuid).and_return('random-uuid')
+
+      stub = stub_request(:post, /.*api.example.com\/customers/)
+             .with(
+               body: { given_name: 'Jack', family_name: 'Franklin' },
+               headers: { 'Idempotency-Key' => 'random-uuid' }
+             )
+             .to_return(default_response)
+
       service.make_request(:post, '/customers', params: {
                              given_name: 'Jack',
                              family_name: 'Franklin'
@@ -45,6 +96,27 @@ describe GoCardlessPro::ApiService do
                body: { given_name: 'Jack', family_name: 'Franklin' },
                headers: { 'Foo' => 'Bar' }
              )
+             .to_return(default_response)
+
+      service.make_request(:post, '/customers', params: {
+                             given_name: 'Jack',
+                             family_name: 'Franklin'
+                           },
+                                                headers: {
+                                                  'Foo' => 'Bar'
+                                                })
+      expect(stub).to have_been_requested
+    end
+
+    it 'merges in a random idempotency key' do
+      allow(SecureRandom).to receive(:uuid).and_return('random-uuid')
+
+      stub = stub_request(:post, /.*api.example.com\/customers/)
+             .with(
+               body: { given_name: 'Jack', family_name: 'Franklin' },
+               headers: { 'Idempotency-Key' => 'random-uuid', 'Foo' => 'Bar' }
+             )
+             .to_return(default_response)
 
       service.make_request(:post, '/customers', params: {
                              given_name: 'Jack',
@@ -55,12 +127,46 @@ describe GoCardlessPro::ApiService do
                                                 })
       expect(stub).to have_been_requested
     end
+
+    context 'with a custom idempotency key' do
+      it "doesn't replace it with a randomly-generated idempotency key" do
+        stub = stub_request(:post, /.*api.example.com\/customers/)
+               .with(
+                 body: { given_name: 'Jack', family_name: 'Franklin' },
+                 headers: { 'Idempotency-Key' => 'my-custom-idempotency-key' }
+               )
+               .to_return(default_response)
+
+        service.make_request(:post, '/customers', params: {
+                               given_name: 'Jack',
+                               family_name: 'Franklin'
+                             },
+                                                  headers: {
+                                                    'Idempotency-Key' => 'my-custom-idempotency-key'
+                                                  })
+        expect(stub).to have_been_requested
+      end
+    end
   end
 
   describe 'making a put request with some data' do
     it 'passes the data in as the request body' do
       stub = stub_request(:put, /.*api.example.com\/customers\/CU123/)
              .with(body: { given_name: 'Jack', family_name: 'Franklin' })
+             .to_return(default_response)
+
+      service.make_request(:put, '/customers/CU123', params: {
+                             given_name: 'Jack',
+                             family_name: 'Franklin'
+                           })
+      expect(stub).to have_been_requested
+    end
+
+    it "doesn't include an idempotency key" do
+      stub = stub_request(:put, /.*api.example.com\/customers\/CU123/)
+             .with { |request| !request.headers.key?('Idempotency-Key') }
+             .to_return(default_response)
+
       service.make_request(:put, '/customers/CU123', params: {
                              given_name: 'Jack',
                              family_name: 'Franklin'

data/spec/middlewares/raise_gocardless_errors_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Middlewares::RaiseGoCardlessErrors do
+  let(:connection) do
+    Faraday.new do |faraday|
+      faraday.response :raise_gocardless_errors
+      faraday.adapter :net_http
+    end
+  end
+
+  before do
+    stub_request(:post, 'https://api.gocardless.com/widgets').to_return(status: status,
+                                                                        body: body,
+                                                                        headers: headers)
+  end
+
+  let(:body) { nil }
+  let(:headers) { { 'Content-Type' => 'application/json' } }
+
+  context 'with a non-JSON response' do
+    let(:body) { '<html><body>Response from Cloudflare</body></html>' }
+    let(:headers) { { 'Content-Type' => 'text/html' } }
+    let(:status) { 514 }
+
+    it 'raises an error' do
+      expect { connection.post('https://api.gocardless.com/widgets') }
+        .to raise_error(GoCardlessPro::ApiError)
+    end
+  end
+
+  context 'with a 5XX response' do
+    let(:status) { 503 }
+
+    it 'raises an error' do
+      expect { connection.post('https://api.gocardless.com/widgets') }
+        .to raise_error(GoCardlessPro::ApiError)
+    end
+  end
+
+  context 'with a 2XX response' do
+    let(:status) { 200 }
+
+    it "doesn't raise an error" do
+      expect { connection.post('https://api.gocardless.com/widgets') }
+        .to_not raise_error(GoCardlessPro::ApiError)
+    end
+  end
+
+  context 'with a 4XX response' do
+    context 'for a validation error' do
+      let(:raw_response) do
+        double('response',
+               headers: default_headers,
+               status: 400,
+               body: { error: { type: 'validation_failed' } }.to_json
+              )
+      end
+
+      let(:status) { 422 }
+      let(:body) { { error: { type: 'validation_failed' } }.to_json }
+
+      it 'raises a ValidationError' do
+        expect { connection.post('https://api.gocardless.com/widgets') }
+          .to raise_error(GoCardlessPro::ValidationError)
+      end
+    end
+
+    context 'for a GoCardless error' do
+      let(:status) { 500 }
+      let(:body) { { error: { type: 'gocardless' } }.to_json }
+
+      it 'raises a GoCardlessError' do
+        expect { connection.post('https://api.gocardless.com/widgets') }
+          .to raise_error(GoCardlessPro::GoCardlessError)
+      end
+    end
+
+    context 'for an invalid API usage error' do
+      let(:status) { 400 }
+      let(:body) { { error: { type: 'invalid_api_usage' } }.to_json }
+
+      it 'raises a InvalidApiUsageError' do
+        expect { connection.post('https://api.gocardless.com/widgets') }
+          .to raise_error(GoCardlessPro::InvalidApiUsageError)
+      end
+    end
+
+    context 'for an invalid state error' do
+      let(:status) { 422 }
+      let(:body) { { error: { type: 'invalid_state' } }.to_json }
+
+      it 'raises an InvalidStateError' do
+        expect { connection.post('https://api.gocardless.com/widgets') }
+          .to raise_error(GoCardlessPro::InvalidStateError)
+      end
+    end
+  end
+end