gocardless_pro 2.18.1 → 2.22.1

data/lib/gocardless_pro/services/mandates_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -225,15 +224,6 @@ module GoCardlessPro
       def envelope_key
         'mandates'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/payments_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -225,15 +224,6 @@ module GoCardlessPro
       def envelope_key
         'payments'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/payout_items_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -54,15 +53,6 @@ module GoCardlessPro
       def envelope_key
         'payout_items'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/payouts_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -59,6 +58,27 @@ module GoCardlessPro
         Resources::Payout.new(unenvelope_body(response.body), response)
       end
 
+      # Updates a payout object. This accepts only the metadata parameter.
+      # Example URL: /payouts/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "PO".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def update(identity, options = {})
+        path = sub_url('/payouts/:identity', 'identity' => identity)
+
+        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?
+
+        Resources::Payout.new(unenvelope_body(response.body), response)
+      end
+
       private
 
       # Unenvelope the response of the body using the service's `envelope_key`
@@ -72,15 +92,6 @@ module GoCardlessPro
       def envelope_key
         'payouts'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/redirect_flows_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -127,15 +126,6 @@ module GoCardlessPro
       def envelope_key
         'redirect_flows'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/refunds_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -14,7 +13,8 @@ module GoCardlessPro
       # Creates a new refund object.
       #
       # This fails with:<a name="total_amount_confirmation_invalid"></a><a
-      # name="number_of_refunds_exceeded"></a>
+      # name="number_of_refunds_exceeded"></a><a
+      # name="available_refund_amount_insufficient"></a>
       #
       # - `total_amount_confirmation_invalid` if the confirmation amount doesn't match
       # the total amount refunded for the payment. This safeguard is there to prevent
@@ -23,6 +23,10 @@ module GoCardlessPro
       # - `number_of_refunds_exceeded` if five or more refunds have already been
       # created against the payment.
       #
+      # - `available_refund_amount_insufficient` if the creditor does not have
+      # sufficient balance for refunds available to cover the cost of the requested
+      # refund.
+      #
       # Example URL: /refunds
       # @param options [Hash] parameters as a hash, under a params key.
       def create(options = {})
@@ -139,15 +143,6 @@ module GoCardlessPro
       def envelope_key
         'refunds'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/subscriptions_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -141,9 +140,22 @@ module GoCardlessPro
       # Pause a subscription object.
       # No payments will be created until it is resumed.
       #
-      # This can only be used with subscriptions created with `count` or
-      # subscriptions without `count` and `end_date`
-      # If the subscription has `count` its `end_date` will be `null` after pausing.
+      # This can only be used when a subscription collecting a fixed number of
+      # payments (created using `count`)
+      # or when they continue forever (created without `count` or `end_date`)
+      #
+      # When `pause_cycles` is omitted the subscription is paused until the [resume
+      # endpoint](#subscriptions-resume-a-subscription) is called.
+      # If the subscription is collecting a fixed number of payments, `end_date` will
+      # be set to `nil`.
+      # When paused indefinitely, `upcoming_payments` will be empty.
+      #
+      # When `pause_cycles` is provided the subscription will be paused for the number
+      # of cycles requested.
+      # If the subscription is collecting a fixed number of payments, `end_date` will
+      # be set to a new value.
+      # When paused for a number of cycles, `upcoming_payments` will still contain the
+      # upcoming charge dates.
       #
       # This fails with:
       #
@@ -158,6 +170,9 @@ module GoCardlessPro
       #
       # - `subscription_already_ended` if the subscription has taken all payments.
       #
+      # - `pause_cycles_must_be_greater_than_or_equal_to` if the provided value for
+      # `pause_cycles` cannot be satisfied.
+      #
       # Example URL: /subscriptions/:identity/actions/pause
       #
       # @param identity       # Unique identifier, beginning with "SB".
@@ -199,6 +214,8 @@ module GoCardlessPro
       # Resume a subscription object.
       # Payments will start to be created again based on the subscriptions recurrence
       # rules.
+      # The `charge_date` on the next payment will be the same as the subscriptions
+      # `earliest_charge_date_after_resume`
       #
       # This fails with:
       #
@@ -211,9 +228,6 @@ module GoCardlessPro
       #
       # - `subscription_not_paused` if the subscription is not paused.
       #
-      # - `subscription_already_scheduled_to_resume` if a subscription already has a
-      # scheduled resume date.
-      #
       # Example URL: /subscriptions/:identity/actions/resume
       #
       # @param identity       # Unique identifier, beginning with "SB".
@@ -309,15 +323,6 @@ module GoCardlessPro
       def envelope_key
         'subscriptions'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/version.rb

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

data/spec/resources/instalment_schedule_spec.rb

@@ -529,6 +529,41 @@ describe GoCardlessPro::Resources::InstalmentSchedule do
     end
   end
 
+  describe '#update' do
+    subject(:put_update_response) { client.instalment_schedules.update(id, params: update_params) }
+    let(:id) { 'ABC123' }
+
+    context 'with a valid request' do
+      let(:update_params) { { 'hello' => 'world' } }
+
+      let!(:stub) do
+        stub_url = '/instalment_schedules/:identity'.gsub(':identity', id)
+        stub_request(:put, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'instalment_schedules' => {
+
+              'created_at' => 'created_at-input',
+              'currency' => 'currency-input',
+              'id' => 'id-input',
+              'links' => 'links-input',
+              'metadata' => 'metadata-input',
+              'name' => 'name-input',
+              'payment_errors' => 'payment_errors-input',
+              'status' => 'status-input',
+              'total_amount' => 'total_amount-input',
+            },
+          }.to_json,
+          headers: response_headers
+        )
+      end
+
+      it 'updates and returns the resource' do
+        expect(put_update_response).to be_a(GoCardlessPro::Resources::InstalmentSchedule)
+        expect(stub).to have_been_requested
+      end
+    end
+  end
+
   describe '#cancel' do
     subject(:post_response) { client.instalment_schedules.cancel(resource_id) }
 

data/spec/resources/payout_spec.rb

@@ -26,6 +26,7 @@ describe GoCardlessPro::Resources::Payout do
               'fx' => 'fx-input',
               'id' => 'id-input',
               'links' => 'links-input',
+              'metadata' => 'metadata-input',
               'payout_type' => 'payout_type-input',
               'reference' => 'reference-input',
               'status' => 'status-input',
@@ -58,6 +59,8 @@ describe GoCardlessPro::Resources::Payout do
 
         expect(get_list_response.records.first.id).to eq('id-input')
 
+        expect(get_list_response.records.first.metadata).to eq('metadata-input')
+
         expect(get_list_response.records.first.payout_type).to eq('payout_type-input')
 
         expect(get_list_response.records.first.reference).to eq('reference-input')
@@ -88,6 +91,7 @@ describe GoCardlessPro::Resources::Payout do
             'fx' => 'fx-input',
             'id' => 'id-input',
             'links' => 'links-input',
+            'metadata' => 'metadata-input',
             'payout_type' => 'payout_type-input',
             'reference' => 'reference-input',
             'status' => 'status-input',
@@ -114,6 +118,7 @@ describe GoCardlessPro::Resources::Payout do
             'fx' => 'fx-input',
             'id' => 'id-input',
             'links' => 'links-input',
+            'metadata' => 'metadata-input',
             'payout_type' => 'payout_type-input',
             'reference' => 'reference-input',
             'status' => 'status-input',
@@ -156,6 +161,7 @@ describe GoCardlessPro::Resources::Payout do
                 'fx' => 'fx-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'metadata' => 'metadata-input',
                 'payout_type' => 'payout_type-input',
                 'reference' => 'reference-input',
                 'status' => 'status-input',
@@ -192,6 +198,7 @@ describe GoCardlessPro::Resources::Payout do
               'fx' => 'fx-input',
               'id' => 'id-input',
               'links' => 'links-input',
+              'metadata' => 'metadata-input',
               'payout_type' => 'payout_type-input',
               'reference' => 'reference-input',
               'status' => 'status-input',
@@ -228,4 +235,42 @@ describe GoCardlessPro::Resources::Payout do
       end
     end
   end
+
+  describe '#update' do
+    subject(:put_update_response) { client.payouts.update(id, params: update_params) }
+    let(:id) { 'ABC123' }
+
+    context 'with a valid request' do
+      let(:update_params) { { 'hello' => 'world' } }
+
+      let!(:stub) do
+        stub_url = '/payouts/:identity'.gsub(':identity', id)
+        stub_request(:put, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'payouts' => {
+
+              'amount' => 'amount-input',
+              'arrival_date' => 'arrival_date-input',
+              'created_at' => 'created_at-input',
+              'currency' => 'currency-input',
+              'deducted_fees' => 'deducted_fees-input',
+              'fx' => 'fx-input',
+              'id' => 'id-input',
+              'links' => 'links-input',
+              'metadata' => 'metadata-input',
+              'payout_type' => 'payout_type-input',
+              'reference' => 'reference-input',
+              'status' => 'status-input',
+            },
+          }.to_json,
+          headers: response_headers
+        )
+      end
+
+      it 'updates and returns the resource' do
+        expect(put_update_response).to be_a(GoCardlessPro::Resources::Payout)
+        expect(stub).to have_been_requested
+      end
+    end
+  end
 end

data/spec/services/creditor_bank_accounts_service_spec.rb

@@ -692,7 +692,7 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
         stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end

data/spec/services/customer_bank_accounts_service_spec.rb

@@ -754,7 +754,7 @@ describe GoCardlessPro::Services::CustomerBankAccountsService do
         stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end

data/spec/services/customer_notifications_service_spec.rb

@@ -45,7 +45,7 @@ describe GoCardlessPro::Services::CustomerNotificationsService do
         stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end

data/spec/services/customers_service_spec.rb

@@ -882,7 +882,7 @@ describe GoCardlessPro::Services::CustomersService do
         stub = stub_request(:delete, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { delete_response }.to raise_error(Faraday::TimeoutError)
+        expect { delete_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end

data/spec/services/instalment_schedules_service_spec.rb

@@ -828,6 +828,66 @@ describe GoCardlessPro::Services::InstalmentSchedulesService do
     end
   end
 
+  describe '#update' do
+    subject(:put_update_response) { client.instalment_schedules.update(id, params: update_params) }
+    let(:id) { 'ABC123' }
+
+    context 'with a valid request' do
+      let(:update_params) { { 'hello' => 'world' } }
+
+      let!(:stub) do
+        stub_url = '/instalment_schedules/:identity'.gsub(':identity', id)
+        stub_request(:put, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'instalment_schedules' => {
+
+              'created_at' => 'created_at-input',
+              'currency' => 'currency-input',
+              'id' => 'id-input',
+              'links' => 'links-input',
+              'metadata' => 'metadata-input',
+              'name' => 'name-input',
+              'payment_errors' => 'payment_errors-input',
+              'status' => 'status-input',
+              'total_amount' => 'total_amount-input',
+            },
+          }.to_json,
+          headers: response_headers
+        )
+      end
+
+      it 'updates and returns the resource' do
+        expect(put_update_response).to be_a(GoCardlessPro::Resources::InstalmentSchedule)
+        expect(stub).to have_been_requested
+      end
+
+      describe 'retry behaviour' do
+        before { allow_any_instance_of(GoCardlessPro::Request).to receive(:sleep) }
+
+        it 'retries timeouts' do
+          stub_url = '/instalment_schedules/:identity'.gsub(':identity', id)
+          stub = stub_request(:put, /.*api.gocardless.com#{stub_url}/).
+                 to_timeout.then.to_return(status: 200, headers: response_headers)
+
+          put_update_response
+          expect(stub).to have_been_requested.twice
+        end
+
+        it 'retries 5XX errors' do
+          stub_url = '/instalment_schedules/:identity'.gsub(':identity', id)
+          stub = stub_request(:put, /.*api.gocardless.com#{stub_url}/).
+                 to_return(status: 502,
+                           headers: { 'Content-Type' => 'text/html' },
+                           body: '<html><body>Response from Cloudflare</body></html>').
+                 then.to_return(status: 200, headers: response_headers)
+
+          put_update_response
+          expect(stub).to have_been_requested.twice
+        end
+      end
+    end
+  end
+
   describe '#cancel' do
     subject(:post_response) { client.instalment_schedules.cancel(resource_id) }
 
@@ -867,7 +927,7 @@ describe GoCardlessPro::Services::InstalmentSchedulesService do
         stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end