gocardless_pro 2.27.0 → 2.30.0

data/spec/resources/mandate_import_spec.rb

@@ -231,6 +231,7 @@ describe GoCardlessPro::Resources::MandateImport do
       # /mandate_imports/%v/actions/submit
       stub_url = '/mandate_imports/:identity/actions/submit'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'mandate_imports' => {
 
@@ -240,6 +241,7 @@ describe GoCardlessPro::Resources::MandateImport do
             'status' => 'status-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end
@@ -289,6 +291,7 @@ describe GoCardlessPro::Resources::MandateImport do
       # /mandate_imports/%v/actions/cancel
       stub_url = '/mandate_imports/:identity/actions/cancel'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'mandate_imports' => {
 
@@ -298,6 +301,7 @@ describe GoCardlessPro::Resources::MandateImport do
             'status' => 'status-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end

data/spec/resources/mandate_spec.rb

@@ -416,6 +416,7 @@ describe GoCardlessPro::Resources::Mandate do
       # /mandates/%v/actions/cancel
       stub_url = '/mandates/:identity/actions/cancel'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'mandates' => {
 
@@ -430,6 +431,7 @@ describe GoCardlessPro::Resources::Mandate do
             'status' => 'status-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end
@@ -484,6 +486,7 @@ describe GoCardlessPro::Resources::Mandate do
       # /mandates/%v/actions/reinstate
       stub_url = '/mandates/:identity/actions/reinstate'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'mandates' => {
 
@@ -498,6 +501,7 @@ describe GoCardlessPro::Resources::Mandate do
             'status' => 'status-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end

data/spec/resources/payer_authorisation_spec.rb

@@ -293,6 +293,7 @@ describe GoCardlessPro::Resources::PayerAuthorisation do
       # /payer_authorisations/%v/actions/submit
       stub_url = '/payer_authorisations/:identity/actions/submit'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'payer_authorisations' => {
 
@@ -306,6 +307,7 @@ describe GoCardlessPro::Resources::PayerAuthorisation do
             'status' => 'status-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end
@@ -359,6 +361,7 @@ describe GoCardlessPro::Resources::PayerAuthorisation do
       # /payer_authorisations/%v/actions/confirm
       stub_url = '/payer_authorisations/:identity/actions/confirm'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'payer_authorisations' => {
 
@@ -372,6 +375,7 @@ describe GoCardlessPro::Resources::PayerAuthorisation do
             'status' => 'status-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end

data/spec/resources/payment_spec.rb

@@ -468,6 +468,7 @@ describe GoCardlessPro::Resources::Payment do
       # /payments/%v/actions/cancel
       stub_url = '/payments/:identity/actions/cancel'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'payments' => {
 
@@ -486,6 +487,7 @@ describe GoCardlessPro::Resources::Payment do
             'status' => 'status-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end
@@ -544,6 +546,7 @@ describe GoCardlessPro::Resources::Payment do
       # /payments/%v/actions/retry
       stub_url = '/payments/:identity/actions/retry'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'payments' => {
 
@@ -562,6 +565,7 @@ describe GoCardlessPro::Resources::Payment do
             'status' => 'status-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end

data/spec/resources/redirect_flow_spec.rb

@@ -20,6 +20,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
           'description' => 'description-input',
           'id' => 'id-input',
           'links' => 'links-input',
+          'mandate_reference' => 'mandate_reference-input',
           'metadata' => 'metadata-input',
           'redirect_url' => 'redirect_url-input',
           'scheme' => 'scheme-input',
@@ -39,6 +40,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                 'description' => 'description-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'mandate_reference' => 'mandate_reference-input',
                 'metadata' => 'metadata-input',
                 'redirect_url' => 'redirect_url-input',
                 'scheme' => 'scheme-input',
@@ -58,6 +60,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                   'description' => 'description-input',
                   'id' => 'id-input',
                   'links' => 'links-input',
+                  'mandate_reference' => 'mandate_reference-input',
                   'metadata' => 'metadata-input',
                   'redirect_url' => 'redirect_url-input',
                   'scheme' => 'scheme-input',
@@ -110,6 +113,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
           'description' => 'description-input',
           'id' => 'id-input',
           'links' => 'links-input',
+          'mandate_reference' => 'mandate_reference-input',
           'metadata' => 'metadata-input',
           'redirect_url' => 'redirect_url-input',
           'scheme' => 'scheme-input',
@@ -152,6 +156,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                 'description' => 'description-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'mandate_reference' => 'mandate_reference-input',
                 'metadata' => 'metadata-input',
                 'redirect_url' => 'redirect_url-input',
                 'scheme' => 'scheme-input',
@@ -190,6 +195,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                 'description' => 'description-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'mandate_reference' => 'mandate_reference-input',
                 'metadata' => 'metadata-input',
                 'redirect_url' => 'redirect_url-input',
                 'scheme' => 'scheme-input',
@@ -225,6 +231,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
               'description' => 'description-input',
               'id' => 'id-input',
               'links' => 'links-input',
+              'mandate_reference' => 'mandate_reference-input',
               'metadata' => 'metadata-input',
               'redirect_url' => 'redirect_url-input',
               'scheme' => 'scheme-input',
@@ -273,6 +280,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
       # /redirect_flows/%v/actions/complete
       stub_url = '/redirect_flows/:identity/actions/complete'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'redirect_flows' => {
 
@@ -281,6 +289,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
             'description' => 'description-input',
             'id' => 'id-input',
             'links' => 'links-input',
+            'mandate_reference' => 'mandate_reference-input',
             'metadata' => 'metadata-input',
             'redirect_url' => 'redirect_url-input',
             'scheme' => 'scheme-input',
@@ -288,6 +297,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
             'success_redirect_url' => 'success_redirect_url-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end
@@ -321,6 +331,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                 'description' => 'description-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'mandate_reference' => 'mandate_reference-input',
                 'metadata' => 'metadata-input',
                 'redirect_url' => 'redirect_url-input',
                 'scheme' => 'scheme-input',

data/spec/resources/scenario_simulator_spec.rb

@@ -18,12 +18,14 @@ describe GoCardlessPro::Resources::ScenarioSimulator do
       # /scenario_simulators/%v/actions/run
       stub_url = '/scenario_simulators/:identity/actions/run'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'scenario_simulators' => {
 
             'id' => 'id-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end

data/spec/resources/subscription_spec.rb

@@ -559,6 +559,7 @@ describe GoCardlessPro::Resources::Subscription do
       # /subscriptions/%v/actions/pause
       stub_url = '/subscriptions/:identity/actions/pause'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'subscriptions' => {
 
@@ -584,6 +585,7 @@ describe GoCardlessPro::Resources::Subscription do
             'upcoming_payments' => 'upcoming_payments-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end
@@ -649,6 +651,7 @@ describe GoCardlessPro::Resources::Subscription do
       # /subscriptions/%v/actions/resume
       stub_url = '/subscriptions/:identity/actions/resume'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'subscriptions' => {
 
@@ -674,6 +677,7 @@ describe GoCardlessPro::Resources::Subscription do
             'upcoming_payments' => 'upcoming_payments-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end
@@ -739,6 +743,7 @@ describe GoCardlessPro::Resources::Subscription do
       # /subscriptions/%v/actions/cancel
       stub_url = '/subscriptions/:identity/actions/cancel'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'subscriptions' => {
 
@@ -764,6 +769,7 @@ describe GoCardlessPro::Resources::Subscription do
             'upcoming_payments' => 'upcoming_payments-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end

data/spec/resources/webhook_spec.rb

@@ -254,6 +254,7 @@ describe GoCardlessPro::Resources::Webhook do
       # /webhooks/%v/actions/retry
       stub_url = '/webhooks/:identity/actions/retry'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'webhooks' => {
 
@@ -272,6 +273,7 @@ describe GoCardlessPro::Resources::Webhook do
             'url' => 'url-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end

data/spec/services/bank_authorisations_service_spec.rb

@@ -24,13 +24,13 @@ describe GoCardlessPro::Services::BankAuthorisationsService 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::Services::BankAuthorisationsService 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,
@@ -162,13 +162,13 @@ describe GoCardlessPro::Services::BankAuthorisationsService 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
@@ -180,13 +180,13 @@ describe GoCardlessPro::Services::BankAuthorisationsService 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',
               },
             }
@@ -198,13 +198,13 @@ describe GoCardlessPro::Services::BankAuthorisationsService 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',
                 },
 
@@ -272,13 +272,13 @@ describe GoCardlessPro::Services::BankAuthorisationsService 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
@@ -313,13 +313,13 @@ describe GoCardlessPro::Services::BankAuthorisationsService 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,
@@ -348,19 +348,6 @@ describe GoCardlessPro::Services::BankAuthorisationsService do
             to raise_error(GoCardlessPro::IdempotencyConflict)
         end
       end
-
-      context 'with on_idempotency_conflict: :unknown' do
-        let(:client) do
-          GoCardlessPro::Client.new(
-            access_token: 'SECRET_TOKEN',
-            on_idempotency_conflict: :unknown
-          )
-        end
-
-        it 'raises an ArgumentError' do
-          expect { post_create_response }.to raise_error(ArgumentError)
-        end
-      end
     end
   end
 end

data/spec/services/billing_request_flows_service_spec.rb

@@ -16,10 +16,17 @@ describe GoCardlessPro::Services::BillingRequestFlowsService do
         {
 
           'authorisation_url' => 'authorisation_url-input',
+          'auto_fulfil' => 'auto_fulfil-input',
           'created_at' => 'created_at-input',
+          'exit_uri' => 'exit_uri-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',
+          'show_redirect_buttons' => 'show_redirect_buttons-input',
         }
       end
 
@@ -30,10 +37,17 @@ describe GoCardlessPro::Services::BillingRequestFlowsService do
               'billing_request_flows' => {
 
                 'authorisation_url' => 'authorisation_url-input',
+                'auto_fulfil' => 'auto_fulfil-input',
                 'created_at' => 'created_at-input',
+                'exit_uri' => 'exit_uri-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',
+                'show_redirect_buttons' => 'show_redirect_buttons-input',
               },
             }
           ).
@@ -44,10 +58,17 @@ describe GoCardlessPro::Services::BillingRequestFlowsService do
                 {
 
                   'authorisation_url' => 'authorisation_url-input',
+                  'auto_fulfil' => 'auto_fulfil-input',
                   'created_at' => 'created_at-input',
+                  'exit_uri' => 'exit_uri-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',
+                  'show_redirect_buttons' => 'show_redirect_buttons-input',
                 },
 
             }.to_json,
@@ -114,10 +135,17 @@ describe GoCardlessPro::Services::BillingRequestFlowsService do
         {
 
           'authorisation_url' => 'authorisation_url-input',
+          'auto_fulfil' => 'auto_fulfil-input',
           'created_at' => 'created_at-input',
+          'exit_uri' => 'exit_uri-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',
+          'show_redirect_buttons' => 'show_redirect_buttons-input',
         }
       end
 
@@ -149,4 +177,91 @@ describe GoCardlessPro::Services::BillingRequestFlowsService 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',
+            'exit_uri' => 'exit_uri-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',
+            'show_redirect_buttons' => 'show_redirect_buttons-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
+
+    describe 'retry behaviour' do
+      it "doesn't retry errors" do
+        stub_url = '/billing_request_flows/:identity/actions/initialise'.gsub(':identity', resource_id)
+        stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+               to_timeout
+
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
+        expect(stub).to have_been_requested
+      end
+    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',
+                'exit_uri' => 'exit_uri-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',
+                'show_redirect_buttons' => 'show_redirect_buttons-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
 end