gocardless_pro 2.17.1 → 2.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb41d5906c1d6d6a9fc78abc852058cf63715020e3c957c7a0a8bcc8e907d74e
-  data.tar.gz: c85a921b9ea881ed5acc7d56c20b4f75f5c51e1c5e305d4de8c7d0079798adbf
+  metadata.gz: 250fed25fc74cb084ad988286e20f8dd2c679fcb62e0de5a1fc3bfca71b67c43
+  data.tar.gz: af02087f4d85aafa9337d51219c467bc195c6c9eff6d03b2f9c5dbf209956680
 SHA512:
-  metadata.gz: 54114ab5751f18ea4c0b010ca600db89523de93353f309cd0e247dbc13a7339f1cf14d7869f44db7d7b0a7571233a54bd9bc0130c9c4eb796bf186bda5e659eb
-  data.tar.gz: a2c5a5cdc5321d2e8a00f82adaba6b56540f3aa86d55cf950862f92fbc1cd971e5bad955b4701d69c4babb2fa5ac83a01a53f5da3427117ec7c11d652c47730e
+  metadata.gz: a3bd1149c2936dfd1ba6d8b60e7183c279d105046c4c02ab497e2d11da3c3f93c363a56ce5a2c1133138ad9acd421bbfb4c479c1da3970afb4c6b650a0197965
+  data.tar.gz: '07951005f59ae4328b34342bb24c9b06bfb9f0221a87630751d21b9755354fb3daaf7f0b34bb51d98811f2e1199479be08745afdb66c888953bfad50fc8bc099'

data/lib/gocardless_pro.rb

@@ -47,6 +47,9 @@ require_relative 'gocardless_pro/services/creditors_service'
 require_relative 'gocardless_pro/resources/creditor_bank_account'
 require_relative 'gocardless_pro/services/creditor_bank_accounts_service'
 
+require_relative 'gocardless_pro/resources/currency_exchange_rate'
+require_relative 'gocardless_pro/services/currency_exchange_rates_service'
+
 require_relative 'gocardless_pro/resources/customer'
 require_relative 'gocardless_pro/services/customers_service'
 

data/lib/gocardless_pro/client.rb

@@ -18,6 +18,11 @@ module GoCardlessPro
       @creditor_bank_accounts ||= Services::CreditorBankAccountsService.new(@api_service)
     end
 
+    # Access to the service for currency_exchange_rate to make API calls
+    def currency_exchange_rates
+      @currency_exchange_rates ||= Services::CurrencyExchangeRatesService.new(@api_service)
+    end
+
     # Access to the service for customer to make API calls
     def customers
       @customers ||= Services::CustomersService.new(@api_service)
@@ -143,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.17.1',
+          'GoCardless-Client-Version' => '2.18.0',
         },
       }
     end

data/lib/gocardless_pro/resources/currency_exchange_rate.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+#
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
+#
+
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Represents an instance of a currency_exchange_rate resource returned from the API
+
+    # Currency exchange rates from our foreign exchange provider.
+    class CurrencyExchangeRate
+      attr_reader :rate
+      attr_reader :source
+      attr_reader :target
+      attr_reader :time
+
+      # Initialize a currency_exchange_rate resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @rate = object['rate']
+        @source = object['source']
+        @target = object['target']
+        @time = object['time']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the currency_exchange_rate resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/subscription.rb

@@ -69,6 +69,7 @@ module GoCardlessPro
     class Subscription
       attr_reader :amount
       attr_reader :app_fee
+      attr_reader :count
       attr_reader :created_at
       attr_reader :currency
       attr_reader :day_of_month
@@ -92,6 +93,7 @@ module GoCardlessPro
 
         @amount = object['amount']
         @app_fee = object['app_fee']
+        @count = object['count']
         @created_at = object['created_at']
         @currency = object['currency']
         @day_of_month = object['day_of_month']

data/lib/gocardless_pro/services/currency_exchange_rates_service.rb

@@ -0,0 +1,67 @@
+require_relative './base_service'
+require 'uri'
+
+# encoding: utf-8
+#
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
+#
+
+module GoCardlessPro
+  module Services
+    # Service for making requests to the CurrencyExchangeRate endpoints
+    class CurrencyExchangeRatesService < BaseService
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of all
+      # exchange rates.
+      # Example URL: /currency_exchange_rates
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/currency_exchange_rates'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::CurrencyExchangeRate
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      #
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Otherwise they will be the body of the request.
+      def all(options = {})
+        Paginator.new(
+          service: self,
+          options: options
+        ).enumerator
+      end
+
+      private
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        body[envelope_key] || body['data']
+      end
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'currency_exchange_rates'
+      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/instalment_schedules_service.rb

@@ -12,11 +12,66 @@ module GoCardlessPro
     # Service for making requests to the InstalmentSchedule endpoints
     class InstalmentSchedulesService < BaseService
       # Creates a new instalment schedule object, along with the associated payments.
+      # This
+      # API is recommended if you know the specific dates you wish to charge.
+      # Otherwise,
+      # please check out the [scheduling
+      # version](#instalment-schedules-create-with-schedule).
       #
-      # The `instalments` property can either be an array of payment properties
-      # (`amount`
-      # and `charge_date`) or a schedule object with `interval`, `interval_unit` and
-      # `amounts`.
+      # The `instalments` property is an array of payment properties (`amount` and
+      # `charge_date`).
+      #
+      # It can take quite a while to create the associated payments, so the API will
+      # return
+      # the status as `pending` initially. When processing has completed, a subsequent
+      # GET
+      # request for the instalment schedule will either have the status `success` and
+      # link
+      # to the created payments, or the status `error` and detailed information about
+      # the
+      # failures.
+      # Example URL: /instalment_schedules
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create_with_dates(options = {})
+        path = '/instalment_schedules'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
+        begin
+          response = make_request(:post, path, options)
+
+          # Response doesn't raise any errors until #body is called
+          response.tap(&:body)
+        rescue InvalidStateError => e
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
+
+          raise e
+        end
+
+        return if response.body.nil?
+
+        Resources::InstalmentSchedule.new(unenvelope_body(response.body), response)
+      end
+
+      # Creates a new instalment schedule object, along with the associated payments.
+      # This
+      # API is recommended if you wish to use the GoCardless scheduling logic. For
+      # finer
+      # control over the individual dates, please check out the [alternative
+      # version](#instalment-schedules-create-with-dates).
       #
       # It can take quite a while to create the associated payments, so the API will
       # return
@@ -27,7 +82,7 @@ module GoCardlessPro
       # failures.
       # Example URL: /instalment_schedules
       # @param options [Hash] parameters as a hash, under a params key.
-      def create(options = {})
+      def create_with_schedule(options = {})
         path = '/instalment_schedules'
 
         params = options.delete(:params) || {}

data/lib/gocardless_pro/version.rb

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

data/spec/resources/currency_exchange_rate_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Resources::CurrencyExchangeRate do
+  let(:client) do
+    GoCardlessPro::Client.new(
+      access_token: 'SECRET_TOKEN'
+    )
+  end
+
+  let(:response_headers) { { 'Content-Type' => 'application/json' } }
+
+  describe '#list' do
+    describe 'with no filters' do
+      subject(:get_list_response) { client.currency_exchange_rates.list }
+
+      before do
+        stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates}).to_return(
+          body: {
+            'currency_exchange_rates' => [{
+
+              'rate' => 'rate-input',
+              'source' => 'source-input',
+              'target' => 'target-input',
+              'time' => 'time-input',
+            }],
+            meta: {
+              cursors: {
+                before: nil,
+                after: 'ABC123',
+              },
+            },
+          }.to_json,
+          headers: response_headers
+        )
+      end
+
+      it 'wraps each item in the resource class' do
+        expect(get_list_response.records.map(&:class).uniq.first).to eq(GoCardlessPro::Resources::CurrencyExchangeRate)
+
+        expect(get_list_response.records.first.rate).to eq('rate-input')
+
+        expect(get_list_response.records.first.source).to eq('source-input')
+
+        expect(get_list_response.records.first.target).to eq('target-input')
+
+        expect(get_list_response.records.first.time).to eq('time-input')
+      end
+
+      it 'exposes the cursors for before and after' do
+        expect(get_list_response.before).to eq(nil)
+        expect(get_list_response.after).to eq('ABC123')
+      end
+
+      specify { expect(get_list_response.api_response.headers).to eql('content-type' => 'application/json') }
+    end
+  end
+
+  describe '#all' do
+    let!(:first_response_stub) do
+      stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates$}).to_return(
+        body: {
+          'currency_exchange_rates' => [{
+
+            'rate' => 'rate-input',
+            'source' => 'source-input',
+            'target' => 'target-input',
+            'time' => 'time-input',
+          }],
+          meta: {
+            cursors: { after: 'AB345' },
+            limit: 1,
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+
+    let!(:second_response_stub) do
+      stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates\?after=AB345}).to_return(
+        body: {
+          'currency_exchange_rates' => [{
+
+            'rate' => 'rate-input',
+            'source' => 'source-input',
+            'target' => 'target-input',
+            'time' => 'time-input',
+          }],
+          meta: {
+            limit: 2,
+            cursors: {},
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+
+    it 'automatically makes the extra requests' do
+      expect(client.currency_exchange_rates.all.to_a.length).to eq(2)
+      expect(first_response_stub).to have_been_requested
+      expect(second_response_stub).to have_been_requested
+    end
+  end
+end

data/spec/resources/instalment_schedule_spec.rb

@@ -10,7 +10,164 @@ describe GoCardlessPro::Resources::InstalmentSchedule do
   let(:response_headers) { { 'Content-Type' => 'application/json' } }
 
   describe '#create' do
-    subject(:post_create_response) { client.instalment_schedules.create(params: new_resource) }
+    subject(:post_create_response) { client.instalment_schedules.create_with_dates(params: new_resource) }
+    context 'with a valid request' do
+      let(:new_resource) do
+        {
+
+          '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',
+        }
+      end
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/instalment_schedules}).
+          with(
+            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_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 'creates and returns the resource' do
+        expect(post_create_response).to be_a(GoCardlessPro::Resources::InstalmentSchedule)
+      end
+    end
+
+    context 'with a request that returns a validation error' do
+      let(:new_resource) { {} }
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/instalment_schedules}).to_return(
+          body: {
+            error: {
+              type: 'validation_failed',
+              code: 422,
+              errors: [
+                { message: 'test error message', field: 'test_field' },
+              ],
+            },
+          }.to_json,
+          headers: response_headers,
+          status: 422
+        )
+      end
+
+      it 'throws the correct error' do
+        expect { post_create_response }.to raise_error(GoCardlessPro::ValidationError)
+      end
+    end
+
+    context 'with a request that returns an idempotent creation conflict error' do
+      let(:id) { 'ID123' }
+
+      let(:new_resource) do
+        {
+
+          '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',
+        }
+      end
+
+      let!(:post_stub) do
+        stub_request(:post, %r{.*api.gocardless.com/instalment_schedules}).to_return(
+          body: {
+            error: {
+              type: 'invalid_state',
+              code: 409,
+              errors: [
+                {
+                  message: 'A resource has already been created with this idempotency key',
+                  reason: 'idempotent_creation_conflict',
+                  links: {
+                    conflicting_resource_id: id,
+                  },
+                },
+              ],
+            },
+          }.to_json,
+          headers: response_headers,
+          status: 409
+        )
+      end
+
+      let!(:get_stub) do
+        stub_url = "/instalment_schedules/#{id}"
+        stub_request(:get, /.*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 'fetches the already-created resource' do
+        post_create_response
+        expect(post_stub).to have_been_requested
+        expect(get_stub).to have_been_requested
+      end
+    end
+  end
+
+  describe '#create' do
+    subject(:post_create_response) { client.instalment_schedules.create_with_schedule(params: new_resource) }
     context 'with a valid request' do
       let(:new_resource) do
         {

data/spec/resources/subscription_spec.rb

@@ -17,6 +17,7 @@ describe GoCardlessPro::Resources::Subscription do
 
           'amount' => 'amount-input',
           'app_fee' => 'app_fee-input',
+          'count' => 'count-input',
           'created_at' => 'created_at-input',
           'currency' => 'currency-input',
           'day_of_month' => 'day_of_month-input',
@@ -44,6 +45,7 @@ describe GoCardlessPro::Resources::Subscription do
 
                 'amount' => 'amount-input',
                 'app_fee' => 'app_fee-input',
+                'count' => 'count-input',
                 'created_at' => 'created_at-input',
                 'currency' => 'currency-input',
                 'day_of_month' => 'day_of_month-input',
@@ -71,6 +73,7 @@ describe GoCardlessPro::Resources::Subscription do
 
                   'amount' => 'amount-input',
                   'app_fee' => 'app_fee-input',
+                  'count' => 'count-input',
                   'created_at' => 'created_at-input',
                   'currency' => 'currency-input',
                   'day_of_month' => 'day_of_month-input',
@@ -131,6 +134,7 @@ describe GoCardlessPro::Resources::Subscription do
 
           'amount' => 'amount-input',
           'app_fee' => 'app_fee-input',
+          'count' => 'count-input',
           'created_at' => 'created_at-input',
           'currency' => 'currency-input',
           'day_of_month' => 'day_of_month-input',
@@ -181,6 +185,7 @@ describe GoCardlessPro::Resources::Subscription do
 
                 'amount' => 'amount-input',
                 'app_fee' => 'app_fee-input',
+                'count' => 'count-input',
                 'created_at' => 'created_at-input',
                 'currency' => 'currency-input',
                 'day_of_month' => 'day_of_month-input',
@@ -222,6 +227,7 @@ describe GoCardlessPro::Resources::Subscription do
 
               'amount' => 'amount-input',
               'app_fee' => 'app_fee-input',
+              'count' => 'count-input',
               'created_at' => 'created_at-input',
               'currency' => 'currency-input',
               'day_of_month' => 'day_of_month-input',
@@ -257,6 +263,8 @@ describe GoCardlessPro::Resources::Subscription do
 
         expect(get_list_response.records.first.app_fee).to eq('app_fee-input')
 
+        expect(get_list_response.records.first.count).to eq('count-input')
+
         expect(get_list_response.records.first.created_at).to eq('created_at-input')
 
         expect(get_list_response.records.first.currency).to eq('currency-input')
@@ -305,6 +313,7 @@ describe GoCardlessPro::Resources::Subscription do
 
             'amount' => 'amount-input',
             'app_fee' => 'app_fee-input',
+            'count' => 'count-input',
             'created_at' => 'created_at-input',
             'currency' => 'currency-input',
             'day_of_month' => 'day_of_month-input',
@@ -338,6 +347,7 @@ describe GoCardlessPro::Resources::Subscription do
 
             'amount' => 'amount-input',
             'app_fee' => 'app_fee-input',
+            'count' => 'count-input',
             'created_at' => 'created_at-input',
             'currency' => 'currency-input',
             'day_of_month' => 'day_of_month-input',
@@ -387,6 +397,7 @@ describe GoCardlessPro::Resources::Subscription do
 
                 'amount' => 'amount-input',
                 'app_fee' => 'app_fee-input',
+                'count' => 'count-input',
                 'created_at' => 'created_at-input',
                 'currency' => 'currency-input',
                 'day_of_month' => 'day_of_month-input',
@@ -430,6 +441,7 @@ describe GoCardlessPro::Resources::Subscription do
 
               'amount' => 'amount-input',
               'app_fee' => 'app_fee-input',
+              'count' => 'count-input',
               'created_at' => 'created_at-input',
               'currency' => 'currency-input',
               'day_of_month' => 'day_of_month-input',
@@ -495,6 +507,7 @@ describe GoCardlessPro::Resources::Subscription do
 
               'amount' => 'amount-input',
               'app_fee' => 'app_fee-input',
+              'count' => 'count-input',
               'created_at' => 'created_at-input',
               'currency' => 'currency-input',
               'day_of_month' => 'day_of_month-input',
@@ -538,6 +551,7 @@ describe GoCardlessPro::Resources::Subscription do
 
             'amount' => 'amount-input',
             'app_fee' => 'app_fee-input',
+            'count' => 'count-input',
             'created_at' => 'created_at-input',
             'currency' => 'currency-input',
             'day_of_month' => 'day_of_month-input',
@@ -586,6 +600,7 @@ describe GoCardlessPro::Resources::Subscription do
 
                 'amount' => 'amount-input',
                 'app_fee' => 'app_fee-input',
+                'count' => 'count-input',
                 'created_at' => 'created_at-input',
                 'currency' => 'currency-input',
                 'day_of_month' => 'day_of_month-input',

data/spec/services/currency_exchange_rates_service_spec.rb

@@ -0,0 +1,223 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Services::CurrencyExchangeRatesService do
+  let(:client) do
+    GoCardlessPro::Client.new(
+      access_token: 'SECRET_TOKEN'
+    )
+  end
+
+  let(:response_headers) { { 'Content-Type' => 'application/json' } }
+
+  describe '#list' do
+    describe 'with no filters' do
+      subject(:get_list_response) { client.currency_exchange_rates.list }
+
+      let(:body) do
+        {
+          'currency_exchange_rates' => [{
+
+            'rate' => 'rate-input',
+            'source' => 'source-input',
+            'target' => 'target-input',
+            'time' => 'time-input',
+          }],
+          meta: {
+            cursors: {
+              before: nil,
+              after: 'ABC123',
+            },
+          },
+        }.to_json
+      end
+
+      before do
+        stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates}).to_return(
+          body: body,
+          headers: response_headers
+        )
+      end
+
+      it 'wraps each item in the resource class' do
+        expect(get_list_response.records.map(&:class).uniq.first).to eq(GoCardlessPro::Resources::CurrencyExchangeRate)
+
+        expect(get_list_response.records.first.rate).to eq('rate-input')
+
+        expect(get_list_response.records.first.source).to eq('source-input')
+
+        expect(get_list_response.records.first.target).to eq('target-input')
+
+        expect(get_list_response.records.first.time).to eq('time-input')
+      end
+
+      it 'exposes the cursors for before and after' do
+        expect(get_list_response.before).to eq(nil)
+        expect(get_list_response.after).to eq('ABC123')
+      end
+
+      specify { expect(get_list_response.api_response.headers).to eql('content-type' => 'application/json') }
+
+      describe 'retry behaviour' do
+        before { allow_any_instance_of(GoCardlessPro::Request).to receive(:sleep) }
+
+        it 'retries timeouts' do
+          stub = stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates}).
+                 to_timeout.then.to_return(status: 200, headers: response_headers, body: body)
+
+          get_list_response
+          expect(stub).to have_been_requested.twice
+        end
+
+        it 'retries 5XX errors' do
+          stub = stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates}).
+                 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, body: body)
+
+          get_list_response
+          expect(stub).to have_been_requested.twice
+        end
+      end
+    end
+  end
+
+  describe '#all' do
+    let!(:first_response_stub) do
+      stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates$}).to_return(
+        body: {
+          'currency_exchange_rates' => [{
+
+            'rate' => 'rate-input',
+            'source' => 'source-input',
+            'target' => 'target-input',
+            'time' => 'time-input',
+          }],
+          meta: {
+            cursors: { after: 'AB345' },
+            limit: 1,
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+
+    let!(:second_response_stub) do
+      stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates\?after=AB345}).to_return(
+        body: {
+          'currency_exchange_rates' => [{
+
+            'rate' => 'rate-input',
+            'source' => 'source-input',
+            'target' => 'target-input',
+            'time' => 'time-input',
+          }],
+          meta: {
+            limit: 2,
+            cursors: {},
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+
+    it 'automatically makes the extra requests' do
+      expect(client.currency_exchange_rates.all.to_a.length).to eq(2)
+      expect(first_response_stub).to have_been_requested
+      expect(second_response_stub).to have_been_requested
+    end
+
+    describe 'retry behaviour' do
+      before { allow_any_instance_of(GoCardlessPro::Request).to receive(:sleep) }
+
+      it 'retries timeouts' do
+        first_response_stub = stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates$}).to_return(
+          body: {
+            'currency_exchange_rates' => [{
+
+              'rate' => 'rate-input',
+              'source' => 'source-input',
+              'target' => 'target-input',
+              'time' => 'time-input',
+            }],
+            meta: {
+              cursors: { after: 'AB345' },
+              limit: 1,
+            },
+          }.to_json,
+          headers: response_headers
+        )
+
+        second_response_stub = stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates\?after=AB345}).
+                               to_timeout.then.
+                               to_return(
+                                 body: {
+                                   'currency_exchange_rates' => [{
+
+                                     'rate' => 'rate-input',
+                                     'source' => 'source-input',
+                                     'target' => 'target-input',
+                                     'time' => 'time-input',
+                                   }],
+                                   meta: {
+                                     limit: 2,
+                                     cursors: {},
+                                   },
+                                 }.to_json,
+                                 headers: response_headers
+                               )
+
+        client.currency_exchange_rates.all.to_a
+
+        expect(first_response_stub).to have_been_requested
+        expect(second_response_stub).to have_been_requested.twice
+      end
+
+      it 'retries 5XX errors' do
+        first_response_stub = stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates$}).to_return(
+          body: {
+            'currency_exchange_rates' => [{
+
+              'rate' => 'rate-input',
+              'source' => 'source-input',
+              'target' => 'target-input',
+              'time' => 'time-input',
+            }],
+            meta: {
+              cursors: { after: 'AB345' },
+              limit: 1,
+            },
+          }.to_json,
+          headers: response_headers
+        )
+
+        second_response_stub = stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates\?after=AB345}).
+                               to_return(
+                                 status: 502,
+                                 body: '<html><body>Response from Cloudflare</body></html>',
+                                 headers: { 'Content-Type' => 'text/html' }
+                               ).then.to_return(
+                                 body: {
+                                   'currency_exchange_rates' => [{
+
+                                     'rate' => 'rate-input',
+                                     'source' => 'source-input',
+                                     'target' => 'target-input',
+                                     'time' => 'time-input',
+                                   }],
+                                   meta: {
+                                     limit: 2,
+                                     cursors: {},
+                                   },
+                                 }.to_json,
+                                 headers: response_headers
+                               )
+
+        client.currency_exchange_rates.all.to_a
+
+        expect(first_response_stub).to have_been_requested
+        expect(second_response_stub).to have_been_requested.twice
+      end
+    end
+  end
+end

data/spec/services/instalment_schedules_service_spec.rb

@@ -10,7 +10,216 @@ describe GoCardlessPro::Services::InstalmentSchedulesService do
   let(:response_headers) { { 'Content-Type' => 'application/json' } }
 
   describe '#create' do
-    subject(:post_create_response) { client.instalment_schedules.create(params: new_resource) }
+    subject(:post_create_response) { client.instalment_schedules.create_with_dates(params: new_resource) }
+    context 'with a valid request' do
+      let(:new_resource) do
+        {
+
+          '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',
+        }
+      end
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/instalment_schedules}).
+          with(
+            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_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 'creates and returns the resource' do
+        expect(post_create_response).to be_a(GoCardlessPro::Resources::InstalmentSchedule)
+      end
+
+      describe 'retry behaviour' do
+        before { allow_any_instance_of(GoCardlessPro::Request).to receive(:sleep) }
+
+        it 'retries timeouts' do
+          stub = stub_request(:post, %r{.*api.gocardless.com/instalment_schedules}).
+                 to_timeout.then.to_return(status: 200, headers: response_headers)
+
+          post_create_response
+          expect(stub).to have_been_requested.twice
+        end
+
+        it 'retries 5XX errors' do
+          stub = stub_request(:post, %r{.*api.gocardless.com/instalment_schedules}).
+                 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)
+
+          post_create_response
+          expect(stub).to have_been_requested.twice
+        end
+      end
+    end
+
+    context 'with a request that returns a validation error' do
+      let(:new_resource) { {} }
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/instalment_schedules}).to_return(
+          body: {
+            error: {
+              type: 'validation_failed',
+              code: 422,
+              errors: [
+                { message: 'test error message', field: 'test_field' },
+              ],
+            },
+          }.to_json,
+          headers: response_headers,
+          status: 422
+        )
+      end
+
+      it 'throws the correct error' do
+        expect { post_create_response }.to raise_error(GoCardlessPro::ValidationError)
+      end
+    end
+
+    context 'with a request that returns an idempotent creation conflict error' do
+      let(:id) { 'ID123' }
+
+      let(:new_resource) do
+        {
+
+          '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',
+        }
+      end
+
+      let!(:post_stub) do
+        stub_request(:post, %r{.*api.gocardless.com/instalment_schedules}).to_return(
+          body: {
+            error: {
+              type: 'invalid_state',
+              code: 409,
+              errors: [
+                {
+                  message: 'A resource has already been created with this idempotency key',
+                  reason: 'idempotent_creation_conflict',
+                  links: {
+                    conflicting_resource_id: id,
+                  },
+                },
+              ],
+            },
+          }.to_json,
+          headers: response_headers,
+          status: 409
+        )
+      end
+
+      let!(:get_stub) do
+        stub_url = "/instalment_schedules/#{id}"
+        stub_request(:get, /.*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
+
+      context 'with default behaviour' do
+        it 'fetches the already-created resource' do
+          post_create_response
+          expect(post_stub).to have_been_requested
+          expect(get_stub).to have_been_requested
+        end
+      end
+
+      context 'with on_idempotency_conflict: :raise' do
+        let(:client) do
+          GoCardlessPro::Client.new(
+            access_token: 'SECRET_TOKEN',
+            on_idempotency_conflict: :raise
+          )
+        end
+
+        it 'raises an IdempotencyConflict error' do
+          expect { post_create_response }.
+            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
+
+  describe '#create' do
+    subject(:post_create_response) { client.instalment_schedules.create_with_schedule(params: new_resource) }
     context 'with a valid request' do
       let(:new_resource) do
         {

data/spec/services/subscriptions_service_spec.rb

@@ -17,6 +17,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
           'amount' => 'amount-input',
           'app_fee' => 'app_fee-input',
+          'count' => 'count-input',
           'created_at' => 'created_at-input',
           'currency' => 'currency-input',
           'day_of_month' => 'day_of_month-input',
@@ -44,6 +45,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
                 'amount' => 'amount-input',
                 'app_fee' => 'app_fee-input',
+                'count' => 'count-input',
                 'created_at' => 'created_at-input',
                 'currency' => 'currency-input',
                 'day_of_month' => 'day_of_month-input',
@@ -71,6 +73,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
                   'amount' => 'amount-input',
                   'app_fee' => 'app_fee-input',
+                  'count' => 'count-input',
                   'created_at' => 'created_at-input',
                   'currency' => 'currency-input',
                   'day_of_month' => 'day_of_month-input',
@@ -154,6 +157,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
           'amount' => 'amount-input',
           'app_fee' => 'app_fee-input',
+          'count' => 'count-input',
           'created_at' => 'created_at-input',
           'currency' => 'currency-input',
           'day_of_month' => 'day_of_month-input',
@@ -204,6 +208,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
                 'amount' => 'amount-input',
                 'app_fee' => 'app_fee-input',
+                'count' => 'count-input',
                 'created_at' => 'created_at-input',
                 'currency' => 'currency-input',
                 'day_of_month' => 'day_of_month-input',
@@ -273,6 +278,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
             'amount' => 'amount-input',
             'app_fee' => 'app_fee-input',
+            'count' => 'count-input',
             'created_at' => 'created_at-input',
             'currency' => 'currency-input',
             'day_of_month' => 'day_of_month-input',
@@ -313,6 +319,8 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
         expect(get_list_response.records.first.app_fee).to eq('app_fee-input')
 
+        expect(get_list_response.records.first.count).to eq('count-input')
+
         expect(get_list_response.records.first.created_at).to eq('created_at-input')
 
         expect(get_list_response.records.first.currency).to eq('currency-input')
@@ -384,6 +392,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
             'amount' => 'amount-input',
             'app_fee' => 'app_fee-input',
+            'count' => 'count-input',
             'created_at' => 'created_at-input',
             'currency' => 'currency-input',
             'day_of_month' => 'day_of_month-input',
@@ -417,6 +426,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
             'amount' => 'amount-input',
             'app_fee' => 'app_fee-input',
+            'count' => 'count-input',
             'created_at' => 'created_at-input',
             'currency' => 'currency-input',
             'day_of_month' => 'day_of_month-input',
@@ -459,6 +469,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
               'amount' => 'amount-input',
               'app_fee' => 'app_fee-input',
+              'count' => 'count-input',
               'created_at' => 'created_at-input',
               'currency' => 'currency-input',
               'day_of_month' => 'day_of_month-input',
@@ -492,6 +503,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
                                      'amount' => 'amount-input',
                                      'app_fee' => 'app_fee-input',
+                                     'count' => 'count-input',
                                      'created_at' => 'created_at-input',
                                      'currency' => 'currency-input',
                                      'day_of_month' => 'day_of_month-input',
@@ -530,6 +542,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
               'amount' => 'amount-input',
               'app_fee' => 'app_fee-input',
+              'count' => 'count-input',
               'created_at' => 'created_at-input',
               'currency' => 'currency-input',
               'day_of_month' => 'day_of_month-input',
@@ -566,6 +579,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
                                      'amount' => 'amount-input',
                                      'app_fee' => 'app_fee-input',
+                                     'count' => 'count-input',
                                      'created_at' => 'created_at-input',
                                      'currency' => 'currency-input',
                                      'day_of_month' => 'day_of_month-input',
@@ -615,6 +629,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
                 'amount' => 'amount-input',
                 'app_fee' => 'app_fee-input',
+                'count' => 'count-input',
                 'created_at' => 'created_at-input',
                 'currency' => 'currency-input',
                 'day_of_month' => 'day_of_month-input',
@@ -658,6 +673,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
               'amount' => 'amount-input',
               'app_fee' => 'app_fee-input',
+              'count' => 'count-input',
               'created_at' => 'created_at-input',
               'currency' => 'currency-input',
               'day_of_month' => 'day_of_month-input',
@@ -778,6 +794,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
               'amount' => 'amount-input',
               'app_fee' => 'app_fee-input',
+              'count' => 'count-input',
               'created_at' => 'created_at-input',
               'currency' => 'currency-input',
               'day_of_month' => 'day_of_month-input',
@@ -846,6 +863,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
             'amount' => 'amount-input',
             'app_fee' => 'app_fee-input',
+            'count' => 'count-input',
             'created_at' => 'created_at-input',
             'currency' => 'currency-input',
             'day_of_month' => 'day_of_month-input',
@@ -905,6 +923,7 @@ describe GoCardlessPro::Services::SubscriptionsService do
 
                 'amount' => 'amount-input',
                 'app_fee' => 'app_fee-input',
+                'count' => 'count-input',
                 'created_at' => 'created_at-input',
                 'currency' => 'currency-input',
                 'day_of_month' => 'day_of_month-input',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 2.17.1
+  version: 2.18.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-24 00:00:00.000000000 Z
+date: 2020-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -144,6 +144,7 @@ files:
 - LICENSE.txt
 - README.md
 - demo.rb
+- gocardless_pro-2.17.1.gem
 - gocardless_pro.gemspec
 - lib/gocardless_pro.rb
 - lib/gocardless_pro/api_response.rb
@@ -162,6 +163,7 @@ files:
 - lib/gocardless_pro/resources/bank_details_lookup.rb
 - lib/gocardless_pro/resources/creditor.rb
 - lib/gocardless_pro/resources/creditor_bank_account.rb
+- lib/gocardless_pro/resources/currency_exchange_rate.rb
 - lib/gocardless_pro/resources/customer.rb
 - lib/gocardless_pro/resources/customer_bank_account.rb
 - lib/gocardless_pro/resources/customer_notification.rb
@@ -182,6 +184,7 @@ files:
 - lib/gocardless_pro/services/base_service.rb
 - lib/gocardless_pro/services/creditor_bank_accounts_service.rb
 - lib/gocardless_pro/services/creditors_service.rb
+- lib/gocardless_pro/services/currency_exchange_rates_service.rb
 - lib/gocardless_pro/services/customer_bank_accounts_service.rb
 - lib/gocardless_pro/services/customer_notifications_service.rb
 - lib/gocardless_pro/services/customers_service.rb
@@ -207,6 +210,7 @@ files:
 - spec/resources/bank_details_lookup_spec.rb
 - spec/resources/creditor_bank_account_spec.rb
 - spec/resources/creditor_spec.rb
+- spec/resources/currency_exchange_rate_spec.rb
 - spec/resources/customer_bank_account_spec.rb
 - spec/resources/customer_notification_spec.rb
 - spec/resources/customer_spec.rb
@@ -226,6 +230,7 @@ files:
 - spec/services/bank_details_lookups_service_spec.rb
 - spec/services/creditor_bank_accounts_service_spec.rb
 - spec/services/creditors_service_spec.rb
+- spec/services/currency_exchange_rates_service_spec.rb
 - spec/services/customer_bank_accounts_service_spec.rb
 - spec/services/customer_notifications_service_spec.rb
 - spec/services/customers_service_spec.rb
@@ -275,6 +280,7 @@ test_files:
 - spec/resources/bank_details_lookup_spec.rb
 - spec/resources/creditor_bank_account_spec.rb
 - spec/resources/creditor_spec.rb
+- spec/resources/currency_exchange_rate_spec.rb
 - spec/resources/customer_bank_account_spec.rb
 - spec/resources/customer_notification_spec.rb
 - spec/resources/customer_spec.rb
@@ -294,6 +300,7 @@ test_files:
 - spec/services/bank_details_lookups_service_spec.rb
 - spec/services/creditor_bank_accounts_service_spec.rb
 - spec/services/creditors_service_spec.rb
+- spec/services/currency_exchange_rates_service_spec.rb
 - spec/services/customer_bank_accounts_service_spec.rb
 - spec/services/customer_notifications_service_spec.rb
 - spec/services/customers_service_spec.rb