gocardless_pro 2.27.0 → 2.28.0

data/lib/gocardless_pro/services/webhooks_service.rb

@@ -82,8 +82,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 

data/lib/gocardless_pro/version.rb

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

data/spec/api_service_spec.rb

@@ -1,8 +1,11 @@
 require 'spec_helper'
 
 describe GoCardlessPro::ApiService do
-  subject(:service) { described_class.new('https://api.example.com', 'secret_token') }
+  subject(:service) do
+    described_class.new('https://api.example.com', 'secret_token', options)
+  end
 
+  let(:options) { {} }
   let(:default_response) do
     {
       status: 200,
@@ -174,4 +177,12 @@ describe GoCardlessPro::ApiService do
       expect(stub).to have_been_requested
     end
   end
+
+  describe 'when passing an invalid :on_idempotency_conflict' do
+    let(:options) { { on_idempotency_conflict: :junk } }
+
+    it 'raises an error' do
+      expect { service }.to raise_error(ArgumentError)
+    end
+  end
 end

data/spec/middlewares/raise_gocardless_errors_spec.rb

@@ -74,6 +74,36 @@ describe GoCardlessPro::Middlewares::RaiseGoCardlessErrors do
       end
     end
 
+    context 'for a Permission error' do
+      let(:status) { 403 }
+      let(:body) { { error: { type: 'invalid_api_usage' } }.to_json }
+
+      it 'raises a GoCardlessError' do
+        expect { connection.post('https://api.gocardless.com/widgets') }.
+          to raise_error(GoCardlessPro::PermissionError)
+      end
+    end
+
+    context 'for a RateLimit error' do
+      let(:status) { 429 }
+      let(:body) { { error: { type: 'invalid_api_usage' } }.to_json }
+
+      it 'raises a GoCardlessError' do
+        expect { connection.post('https://api.gocardless.com/widgets') }.
+          to raise_error(GoCardlessPro::RateLimitError)
+      end
+    end
+
+    context 'for a Authentication error' do
+      let(:status) { 401 }
+      let(:body) { { error: { type: 'invalid_api_usage' } }.to_json }
+
+      it 'raises a GoCardlessError' do
+        expect { connection.post('https://api.gocardless.com/widgets') }.
+          to raise_error(GoCardlessPro::AuthenticationError)
+      end
+    end
+
     context 'for an invalid API usage error' do
       let(:status) { 400 }
       let(:body) { { error: { type: 'invalid_api_usage' } }.to_json }

data/spec/resources/bank_authorisation_spec.rb

@@ -24,13 +24,13 @@ describe GoCardlessPro::Resources::BankAuthorisation do
               'bank_authorisations' => {
 
                 'authorisation_type' => 'authorisation_type-input',
+                'authorised_at' => 'authorised_at-input',
                 'created_at' => 'created_at-input',
                 'expires_at' => 'expires_at-input',
                 'id' => 'id-input',
                 'last_visited_at' => 'last_visited_at-input',
                 'links' => 'links-input',
                 'redirect_uri' => 'redirect_uri-input',
-                'short_url' => 'short_url-input',
                 'url' => 'url-input',
               },
             }.to_json,
@@ -58,13 +58,13 @@ describe GoCardlessPro::Resources::BankAuthorisation do
             'bank_authorisations' => {
 
               'authorisation_type' => 'authorisation_type-input',
+              'authorised_at' => 'authorised_at-input',
               'created_at' => 'created_at-input',
               'expires_at' => 'expires_at-input',
               'id' => 'id-input',
               'last_visited_at' => 'last_visited_at-input',
               'links' => 'links-input',
               'redirect_uri' => 'redirect_uri-input',
-              'short_url' => 'short_url-input',
               'url' => 'url-input',
             },
           }.to_json,
@@ -107,13 +107,13 @@ describe GoCardlessPro::Resources::BankAuthorisation do
         {
 
           'authorisation_type' => 'authorisation_type-input',
+          'authorised_at' => 'authorised_at-input',
           'created_at' => 'created_at-input',
           'expires_at' => 'expires_at-input',
           'id' => 'id-input',
           'last_visited_at' => 'last_visited_at-input',
           'links' => 'links-input',
           'redirect_uri' => 'redirect_uri-input',
-          'short_url' => 'short_url-input',
           'url' => 'url-input',
         }
       end
@@ -125,13 +125,13 @@ describe GoCardlessPro::Resources::BankAuthorisation do
               'bank_authorisations' => {
 
                 'authorisation_type' => 'authorisation_type-input',
+                'authorised_at' => 'authorised_at-input',
                 'created_at' => 'created_at-input',
                 'expires_at' => 'expires_at-input',
                 'id' => 'id-input',
                 'last_visited_at' => 'last_visited_at-input',
                 'links' => 'links-input',
                 'redirect_uri' => 'redirect_uri-input',
-                'short_url' => 'short_url-input',
                 'url' => 'url-input',
               },
             }
@@ -143,13 +143,13 @@ describe GoCardlessPro::Resources::BankAuthorisation do
                 {
 
                   'authorisation_type' => 'authorisation_type-input',
+                  'authorised_at' => 'authorised_at-input',
                   'created_at' => 'created_at-input',
                   'expires_at' => 'expires_at-input',
                   'id' => 'id-input',
                   'last_visited_at' => 'last_visited_at-input',
                   'links' => 'links-input',
                   'redirect_uri' => 'redirect_uri-input',
-                  'short_url' => 'short_url-input',
                   'url' => 'url-input',
                 },
 
@@ -194,13 +194,13 @@ describe GoCardlessPro::Resources::BankAuthorisation do
         {
 
           'authorisation_type' => 'authorisation_type-input',
+          'authorised_at' => 'authorised_at-input',
           'created_at' => 'created_at-input',
           'expires_at' => 'expires_at-input',
           'id' => 'id-input',
           'last_visited_at' => 'last_visited_at-input',
           'links' => 'links-input',
           'redirect_uri' => 'redirect_uri-input',
-          'short_url' => 'short_url-input',
           'url' => 'url-input',
         }
       end
@@ -235,13 +235,13 @@ describe GoCardlessPro::Resources::BankAuthorisation do
               'bank_authorisations' => {
 
                 'authorisation_type' => 'authorisation_type-input',
+                'authorised_at' => 'authorised_at-input',
                 'created_at' => 'created_at-input',
                 'expires_at' => 'expires_at-input',
                 'id' => 'id-input',
                 'last_visited_at' => 'last_visited_at-input',
                 'links' => 'links-input',
                 'redirect_uri' => 'redirect_uri-input',
-                'short_url' => 'short_url-input',
                 'url' => 'url-input',
               },
             }.to_json,

data/spec/resources/billing_request_flow_spec.rb

@@ -16,10 +16,15 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
         {
 
           'authorisation_url' => 'authorisation_url-input',
+          'auto_fulfil' => 'auto_fulfil-input',
           'created_at' => 'created_at-input',
           'expires_at' => 'expires_at-input',
+          'id' => 'id-input',
           'links' => 'links-input',
+          'lock_bank_account' => 'lock_bank_account-input',
+          'lock_customer_details' => 'lock_customer_details-input',
           'redirect_uri' => 'redirect_uri-input',
+          'session_token' => 'session_token-input',
         }
       end
 
@@ -30,10 +35,15 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
               'billing_request_flows' => {
 
                 'authorisation_url' => 'authorisation_url-input',
+                'auto_fulfil' => 'auto_fulfil-input',
                 'created_at' => 'created_at-input',
                 'expires_at' => 'expires_at-input',
+                'id' => 'id-input',
                 'links' => 'links-input',
+                'lock_bank_account' => 'lock_bank_account-input',
+                'lock_customer_details' => 'lock_customer_details-input',
                 'redirect_uri' => 'redirect_uri-input',
+                'session_token' => 'session_token-input',
               },
             }
           ).
@@ -44,10 +54,15 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
                 {
 
                   'authorisation_url' => 'authorisation_url-input',
+                  'auto_fulfil' => 'auto_fulfil-input',
                   'created_at' => 'created_at-input',
                   'expires_at' => 'expires_at-input',
+                  'id' => 'id-input',
                   'links' => 'links-input',
+                  'lock_bank_account' => 'lock_bank_account-input',
+                  'lock_customer_details' => 'lock_customer_details-input',
                   'redirect_uri' => 'redirect_uri-input',
+                  'session_token' => 'session_token-input',
                 },
 
             }.to_json,
@@ -91,10 +106,15 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
         {
 
           'authorisation_url' => 'authorisation_url-input',
+          'auto_fulfil' => 'auto_fulfil-input',
           'created_at' => 'created_at-input',
           'expires_at' => 'expires_at-input',
+          'id' => 'id-input',
           'links' => 'links-input',
+          'lock_bank_account' => 'lock_bank_account-input',
+          'lock_customer_details' => 'lock_customer_details-input',
           'redirect_uri' => 'redirect_uri-input',
+          'session_token' => 'session_token-input',
         }
       end
 
@@ -126,4 +146,74 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
       end
     end
   end
+
+  describe '#initialise' do
+    subject(:post_response) { client.billing_request_flows.initialise(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /billing_request_flows/%v/actions/initialise
+      stub_url = '/billing_request_flows/:identity/actions/initialise'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'billing_request_flows' => {
+
+            'authorisation_url' => 'authorisation_url-input',
+            'auto_fulfil' => 'auto_fulfil-input',
+            'created_at' => 'created_at-input',
+            'expires_at' => 'expires_at-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'lock_bank_account' => 'lock_bank_account-input',
+            'lock_customer_details' => 'lock_customer_details-input',
+            'redirect_uri' => 'redirect_uri-input',
+            'session_token' => 'session_token-input',
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+
+    it 'wraps the response and calls the right endpoint' do
+      expect(post_response).to be_a(GoCardlessPro::Resources::BillingRequestFlow)
+
+      expect(stub).to have_been_requested
+    end
+
+    context 'when the request needs a body and custom header' do
+      let(:body) { { foo: 'bar' } }
+      let(:headers) { { 'Foo' => 'Bar' } }
+      subject(:post_response) { client.billing_request_flows.initialise(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /billing_request_flows/%v/actions/initialise
+        stub_url = '/billing_request_flows/:identity/actions/initialise'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'billing_request_flows' => {
+
+                'authorisation_url' => 'authorisation_url-input',
+                'auto_fulfil' => 'auto_fulfil-input',
+                'created_at' => 'created_at-input',
+                'expires_at' => 'expires_at-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'lock_bank_account' => 'lock_bank_account-input',
+                'lock_customer_details' => 'lock_customer_details-input',
+                'redirect_uri' => 'redirect_uri-input',
+                'session_token' => 'session_token-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
 end

data/spec/resources/billing_request_spec.rb

@@ -19,7 +19,6 @@ describe GoCardlessPro::Resources::BillingRequest do
             'billing_requests' => [{
 
               'actions' => 'actions-input',
-              'auto_fulfil' => 'auto_fulfil-input',
               'created_at' => 'created_at-input',
               'id' => 'id-input',
               'links' => 'links-input',
@@ -45,8 +44,6 @@ describe GoCardlessPro::Resources::BillingRequest do
 
         expect(get_list_response.records.first.actions).to eq('actions-input')
 
-        expect(get_list_response.records.first.auto_fulfil).to eq('auto_fulfil-input')
-
         expect(get_list_response.records.first.created_at).to eq('created_at-input')
 
         expect(get_list_response.records.first.id).to eq('id-input')
@@ -78,7 +75,6 @@ describe GoCardlessPro::Resources::BillingRequest do
           'billing_requests' => [{
 
             'actions' => 'actions-input',
-            'auto_fulfil' => 'auto_fulfil-input',
             'created_at' => 'created_at-input',
             'id' => 'id-input',
             'links' => 'links-input',
@@ -103,7 +99,6 @@ describe GoCardlessPro::Resources::BillingRequest do
           'billing_requests' => [{
 
             'actions' => 'actions-input',
-            'auto_fulfil' => 'auto_fulfil-input',
             'created_at' => 'created_at-input',
             'id' => 'id-input',
             'links' => 'links-input',
@@ -136,7 +131,6 @@ describe GoCardlessPro::Resources::BillingRequest do
         {
 
           'actions' => 'actions-input',
-          'auto_fulfil' => 'auto_fulfil-input',
           'created_at' => 'created_at-input',
           'id' => 'id-input',
           'links' => 'links-input',
@@ -155,7 +149,6 @@ describe GoCardlessPro::Resources::BillingRequest do
               'billing_requests' => {
 
                 'actions' => 'actions-input',
-                'auto_fulfil' => 'auto_fulfil-input',
                 'created_at' => 'created_at-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
@@ -174,7 +167,6 @@ describe GoCardlessPro::Resources::BillingRequest do
                 {
 
                   'actions' => 'actions-input',
-                  'auto_fulfil' => 'auto_fulfil-input',
                   'created_at' => 'created_at-input',
                   'id' => 'id-input',
                   'links' => 'links-input',
@@ -226,7 +218,6 @@ describe GoCardlessPro::Resources::BillingRequest do
         {
 
           'actions' => 'actions-input',
-          'auto_fulfil' => 'auto_fulfil-input',
           'created_at' => 'created_at-input',
           'id' => 'id-input',
           'links' => 'links-input',
@@ -268,7 +259,6 @@ describe GoCardlessPro::Resources::BillingRequest do
               'billing_requests' => {
 
                 'actions' => 'actions-input',
-                'auto_fulfil' => 'auto_fulfil-input',
                 'created_at' => 'created_at-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
@@ -306,7 +296,6 @@ describe GoCardlessPro::Resources::BillingRequest do
               'billing_requests' => {
 
                 'actions' => 'actions-input',
-                'auto_fulfil' => 'auto_fulfil-input',
                 'created_at' => 'created_at-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
@@ -341,7 +330,6 @@ describe GoCardlessPro::Resources::BillingRequest do
             'billing_requests' => {
 
               'actions' => 'actions-input',
-              'auto_fulfil' => 'auto_fulfil-input',
               'created_at' => 'created_at-input',
               'id' => 'id-input',
               'links' => 'links-input',
@@ -397,7 +385,6 @@ describe GoCardlessPro::Resources::BillingRequest do
           'billing_requests' => {
 
             'actions' => 'actions-input',
-            'auto_fulfil' => 'auto_fulfil-input',
             'created_at' => 'created_at-input',
             'id' => 'id-input',
             'links' => 'links-input',
@@ -437,7 +424,6 @@ describe GoCardlessPro::Resources::BillingRequest do
               'billing_requests' => {
 
                 'actions' => 'actions-input',
-                'auto_fulfil' => 'auto_fulfil-input',
                 'created_at' => 'created_at-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
@@ -454,20 +440,19 @@ describe GoCardlessPro::Resources::BillingRequest do
     end
   end
 
-  describe '#collect_bank_account_details' do
-    subject(:post_response) { client.billing_requests.collect_bank_account_details(resource_id) }
+  describe '#collect_bank_account' do
+    subject(:post_response) { client.billing_requests.collect_bank_account(resource_id) }
 
     let(:resource_id) { 'ABC123' }
 
     let!(:stub) do
-      # /billing_requests/%v/actions/collect_bank_account_details
-      stub_url = '/billing_requests/:identity/actions/collect_bank_account_details'.gsub(':identity', resource_id)
+      # /billing_requests/%v/actions/collect_bank_account
+      stub_url = '/billing_requests/:identity/actions/collect_bank_account'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
         body: {
           'billing_requests' => {
 
             'actions' => 'actions-input',
-            'auto_fulfil' => 'auto_fulfil-input',
             'created_at' => 'created_at-input',
             'id' => 'id-input',
             'links' => 'links-input',
@@ -491,13 +476,13 @@ describe GoCardlessPro::Resources::BillingRequest do
     context 'when the request needs a body and custom header' do
       let(:body) { { foo: 'bar' } }
       let(:headers) { { 'Foo' => 'Bar' } }
-      subject(:post_response) { client.billing_requests.collect_bank_account_details(resource_id, body, headers) }
+      subject(:post_response) { client.billing_requests.collect_bank_account(resource_id, body, headers) }
 
       let(:resource_id) { 'ABC123' }
 
       let!(:stub) do
-        # /billing_requests/%v/actions/collect_bank_account_details
-        stub_url = '/billing_requests/:identity/actions/collect_bank_account_details'.gsub(':identity', resource_id)
+        # /billing_requests/%v/actions/collect_bank_account
+        stub_url = '/billing_requests/:identity/actions/collect_bank_account'.gsub(':identity', resource_id)
         stub_request(:post, /.*api.gocardless.com#{stub_url}/).
           with(
             body: { foo: 'bar' },
@@ -507,7 +492,6 @@ describe GoCardlessPro::Resources::BillingRequest do
               'billing_requests' => {
 
                 'actions' => 'actions-input',
-                'auto_fulfil' => 'auto_fulfil-input',
                 'created_at' => 'created_at-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
@@ -537,7 +521,6 @@ describe GoCardlessPro::Resources::BillingRequest do
           'billing_requests' => {
 
             'actions' => 'actions-input',
-            'auto_fulfil' => 'auto_fulfil-input',
             'created_at' => 'created_at-input',
             'id' => 'id-input',
             'links' => 'links-input',
@@ -577,7 +560,74 @@ describe GoCardlessPro::Resources::BillingRequest do
               'billing_requests' => {
 
                 'actions' => 'actions-input',
-                'auto_fulfil' => 'auto_fulfil-input',
+                'created_at' => 'created_at-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'mandate_request' => 'mandate_request-input',
+                'metadata' => 'metadata-input',
+                'payment_request' => 'payment_request-input',
+                'resources' => 'resources-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+
+  describe '#confirm_payer_details' do
+    subject(:post_response) { client.billing_requests.confirm_payer_details(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /billing_requests/%v/actions/confirm_payer_details
+      stub_url = '/billing_requests/:identity/actions/confirm_payer_details'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'billing_requests' => {
+
+            'actions' => 'actions-input',
+            'created_at' => 'created_at-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'mandate_request' => 'mandate_request-input',
+            'metadata' => 'metadata-input',
+            'payment_request' => 'payment_request-input',
+            'resources' => 'resources-input',
+            'status' => 'status-input',
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+
+    it 'wraps the response and calls the right endpoint' do
+      expect(post_response).to be_a(GoCardlessPro::Resources::BillingRequest)
+
+      expect(stub).to have_been_requested
+    end
+
+    context 'when the request needs a body and custom header' do
+      let(:body) { { foo: 'bar' } }
+      let(:headers) { { 'Foo' => 'Bar' } }
+      subject(:post_response) { client.billing_requests.confirm_payer_details(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /billing_requests/%v/actions/confirm_payer_details
+        stub_url = '/billing_requests/:identity/actions/confirm_payer_details'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'billing_requests' => {
+
+                'actions' => 'actions-input',
                 'created_at' => 'created_at-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
@@ -607,7 +657,6 @@ describe GoCardlessPro::Resources::BillingRequest do
           'billing_requests' => {
 
             'actions' => 'actions-input',
-            'auto_fulfil' => 'auto_fulfil-input',
             'created_at' => 'created_at-input',
             'id' => 'id-input',
             'links' => 'links-input',
@@ -647,7 +696,6 @@ describe GoCardlessPro::Resources::BillingRequest do
               'billing_requests' => {
 
                 'actions' => 'actions-input',
-                'auto_fulfil' => 'auto_fulfil-input',
                 'created_at' => 'created_at-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
@@ -677,7 +725,6 @@ describe GoCardlessPro::Resources::BillingRequest do
           'billing_requests' => {
 
             'actions' => 'actions-input',
-            'auto_fulfil' => 'auto_fulfil-input',
             'created_at' => 'created_at-input',
             'id' => 'id-input',
             'links' => 'links-input',
@@ -717,7 +764,6 @@ describe GoCardlessPro::Resources::BillingRequest do
               'billing_requests' => {
 
                 'actions' => 'actions-input',
-                'auto_fulfil' => 'auto_fulfil-input',
                 'created_at' => 'created_at-input',
                 'id' => 'id-input',
                 'links' => 'links-input',