gocardless_pro 2.18.1 → 2.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56e422f17e5916ab4eac449f5d12f138bac13589a481b1da75ca70e2da1ceae6
-  data.tar.gz: 9df2ae977e5988ab8660062884644b8fdd14051d1866d940a3bd61957cd3436f
+  metadata.gz: a7e71f4726525b3ce899c9f4ce10cb6f957805c654f1025a5aad542c6181aa60
+  data.tar.gz: 9501e18394e43ab7d541712fd3130f2184d6f4caede7916abf01c24add413160
 SHA512:
-  metadata.gz: 99e3c28948e6b35328daf3744b44ea934644ed64666f2e2887c44057e03b6fb4e66475c97b53a2ace80f41558864142dcbaee49f07f44217a8224360bd47b13f
-  data.tar.gz: 1451294c75349cb5342388b69d2676ab61785fe6d4bf5b8b8df88c91295e30e67c209c0c24e9e997e2fb4ef808b97fa3b576f92c4509b2b8132929320cb2f9ac
+  metadata.gz: a8015fa41e3a0b6c5bd62810ff5f00438d880313d3a0051f756af8ba4d3c6eccd3f71c7b56452fcf9981a52a265feb692caf2deca77cf8705b094e24bb1e3a25
+  data.tar.gz: 972c8baa19abfbe69390010d4350788b04263c4af0665f19f35161f6b899cc32c3d5a073b36bb0596a010f9c8f34442dac56fe643e27588edfbd800ddbd6414e

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.18.1',
+          'GoCardless-Client-Version' => '2.19.0',
         },
       }
     end

data/lib/gocardless_pro/resources/payout.rb

@@ -26,6 +26,7 @@ module GoCardlessPro
       attr_reader :deducted_fees
       attr_reader :fx
       attr_reader :id
+      attr_reader :metadata
       attr_reader :payout_type
       attr_reader :reference
       attr_reader :status
@@ -43,6 +44,7 @@ module GoCardlessPro
         @fx = object['fx']
         @id = object['id']
         @links = object['links']
+        @metadata = object['metadata']
         @payout_type = object['payout_type']
         @reference = object['reference']
         @status = object['status']

data/lib/gocardless_pro/services/payouts_service.rb

@@ -59,6 +59,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`

data/lib/gocardless_pro/services/subscriptions_service.rb

@@ -141,9 +141,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 +171,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 +215,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 +229,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".

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.19.0'.freeze
 end

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/payouts_service_spec.rb

@@ -25,6 +25,7 @@ describe GoCardlessPro::Services::PayoutsService do
             'fx' => 'fx-input',
             'id' => 'id-input',
             'links' => 'links-input',
+            'metadata' => 'metadata-input',
             'payout_type' => 'payout_type-input',
             'reference' => 'reference-input',
             'status' => 'status-input',
@@ -62,6 +63,8 @@ describe GoCardlessPro::Services::PayoutsService 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')
@@ -115,6 +118,7 @@ describe GoCardlessPro::Services::PayoutsService do
             'fx' => 'fx-input',
             'id' => 'id-input',
             'links' => 'links-input',
+            'metadata' => 'metadata-input',
             'payout_type' => 'payout_type-input',
             'reference' => 'reference-input',
             'status' => 'status-input',
@@ -141,6 +145,7 @@ describe GoCardlessPro::Services::PayoutsService do
             'fx' => 'fx-input',
             'id' => 'id-input',
             'links' => 'links-input',
+            'metadata' => 'metadata-input',
             'payout_type' => 'payout_type-input',
             'reference' => 'reference-input',
             'status' => 'status-input',
@@ -176,6 +181,7 @@ describe GoCardlessPro::Services::PayoutsService do
               'fx' => 'fx-input',
               'id' => 'id-input',
               'links' => 'links-input',
+              'metadata' => 'metadata-input',
               'payout_type' => 'payout_type-input',
               'reference' => 'reference-input',
               'status' => 'status-input',
@@ -202,6 +208,7 @@ describe GoCardlessPro::Services::PayoutsService do
                                      'fx' => 'fx-input',
                                      'id' => 'id-input',
                                      'links' => 'links-input',
+                                     'metadata' => 'metadata-input',
                                      'payout_type' => 'payout_type-input',
                                      'reference' => 'reference-input',
                                      'status' => 'status-input',
@@ -233,6 +240,7 @@ describe GoCardlessPro::Services::PayoutsService do
               'fx' => 'fx-input',
               'id' => 'id-input',
               'links' => 'links-input',
+              'metadata' => 'metadata-input',
               'payout_type' => 'payout_type-input',
               'reference' => 'reference-input',
               'status' => 'status-input',
@@ -262,6 +270,7 @@ describe GoCardlessPro::Services::PayoutsService do
                                      'fx' => 'fx-input',
                                      'id' => 'id-input',
                                      'links' => 'links-input',
+                                     'metadata' => 'metadata-input',
                                      'payout_type' => 'payout_type-input',
                                      'reference' => 'reference-input',
                                      'status' => 'status-input',
@@ -304,6 +313,7 @@ describe GoCardlessPro::Services::PayoutsService do
                 'fx' => 'fx-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'metadata' => 'metadata-input',
                 'payout_type' => 'payout_type-input',
                 'reference' => 'reference-input',
                 'status' => 'status-input',
@@ -340,6 +350,7 @@ describe GoCardlessPro::Services::PayoutsService do
               'fx' => 'fx-input',
               'id' => 'id-input',
               'links' => 'links-input',
+              'metadata' => 'metadata-input',
               'payout_type' => 'payout_type-input',
               'reference' => 'reference-input',
               'status' => 'status-input',
@@ -431,4 +442,67 @@ describe GoCardlessPro::Services::PayoutsService 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
+
+      describe 'retry behaviour' do
+        before { allow_any_instance_of(GoCardlessPro::Request).to receive(:sleep) }
+
+        it 'retries timeouts' do
+          stub_url = '/payouts/: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 = '/payouts/: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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 2.18.1
+  version: 2.19.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -266,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A gem for calling the GoCardless Pro API