gocardless_pro 2.19.0 → 2.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7e71f4726525b3ce899c9f4ce10cb6f957805c654f1025a5aad542c6181aa60
-  data.tar.gz: 9501e18394e43ab7d541712fd3130f2184d6f4caede7916abf01c24add413160
+  metadata.gz: 7afba51474a66685fa1e954707bdc6c339a4c3c10e5f64160f5676137804d455
+  data.tar.gz: 378a39b27909235511aafcfcb207d6c4ffffb6358c1747c9c5b4d7e1b1e76340
 SHA512:
-  metadata.gz: a8015fa41e3a0b6c5bd62810ff5f00438d880313d3a0051f756af8ba4d3c6eccd3f71c7b56452fcf9981a52a265feb692caf2deca77cf8705b094e24bb1e3a25
-  data.tar.gz: 972c8baa19abfbe69390010d4350788b04263c4af0665f19f35161f6b899cc32c3d5a073b36bb0596a010f9c8f34442dac56fe643e27588edfbd800ddbd6414e
+  metadata.gz: 545b24573eec2cc2f9bceef08add1d8199d2769ee2256f1901f84a2c0b178b5860200c1fdb093f6bed07e432493bbee92758146fba64010d1072a7e0c048eea7
+  data.tar.gz: 7571194e496636bdd23bf173d1e31712592edcf5f3cefc26ea513ac48e871fe21d1291d4e5a365e59a7be7cebf21e71e43c72fd75fe7da88d270b8f86b6bc0c2

data/lib/gocardless_pro/client.rb

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

data/lib/gocardless_pro/services/instalment_schedules_service.rb

@@ -162,6 +162,27 @@ module GoCardlessPro
         Resources::InstalmentSchedule.new(unenvelope_body(response.body), response)
       end
 
+      # Updates an instalment schedule. This accepts only the metadata parameter.
+      # Example URL: /instalment_schedules/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "IS".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def update(identity, options = {})
+        path = sub_url('/instalment_schedules/: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::InstalmentSchedule.new(unenvelope_body(response.body), response)
+      end
+
       # Immediately cancels an instalment schedule; no further payments will be
       # collected for it.
       #

data/lib/gocardless_pro/version.rb

@@ -4,5 +4,5 @@ end
 
 module GoCardlessPro
   # Current version of the GC gem
-  VERSION = '2.19.0'.freeze
+  VERSION = '2.20.0'.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/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) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 2.19.0
+  version: 2.20.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday