gocardless_pro 2.12.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 384196ace34af04e506d4cea92c7ac56cf06a6aebeffbfe207321b0cb06be45a
-  data.tar.gz: a12aedcca4213a389e56c6669679f89b8dbf52afcb1ce7e494e8abadbeeb582a
+  metadata.gz: 0fd702df303218fec5c4bc90ad731762d95c78a57df3c5f4c74dd2cec45e1c61
+  data.tar.gz: f7de4d6744ee3c86a191b9649ca921d468ba64740031612670ee558d2d67f81d
 SHA512:
-  metadata.gz: 47242ac68d7a5d6973da5dc4e75639b2196367c17a34fef7b32f70bf524d5077a21c08d2000fbe8e27ad344008e3fe5ee67c7723e21e3e9e03d29ad9597ea361
-  data.tar.gz: d42198b7495ecb3e1daeb6f3a7304be9fd7eff831cea1fe2bd92bd83c54a7a2807f0c92e51342fe120eb31f7b1fb2b3dd2b2285ab64da4b49d1b60800b21d374
+  metadata.gz: 51f15a425b95e8a38a957f4d875fbc8518c452e32f5a1d118866981aca16d7d4ebdecae96006b1cdb4adbb9d276184e2953d2991085a42004bf074019791281c
+  data.tar.gz: 4c39f5eb990e649758ab981b20e9b74dda3a322de0e94a51f1765551db0d33792a705bd1377b511d0f1b4e8deda500676a2abe9f45160ffe80c0a2f9ef6fc38c

data/.circleci/config.yml

@@ -0,0 +1,50 @@
+version: 2
+references:
+  test_library: &test_library
+    parallelism: 1
+    steps:
+      - checkout
+      - run: |
+          bundle install
+          bundle exec rspec
+jobs:
+  test_ruby_2_5:
+    <<: *test_library
+    docker:
+      - image: ruby:2.5
+
+  test_ruby_2_4:
+    <<: *test_library
+    docker:
+      - image: ruby:2.4
+
+  test_ruby_2_3:
+    <<: *test_library
+    docker:
+      - image: ruby:2.3
+
+  test_ruby_2_2:
+    <<: *test_library
+    docker:
+      - image: ruby:2.2
+
+  test_ruby_2_1:
+    <<: *test_library
+    docker:
+      - image: ruby:2.1
+
+  test_ruby_2_0:
+    <<: *test_library
+    docker:
+      - image: ruby:2.0
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - test_ruby_2_5
+      - test_ruby_2_4
+      - test_ruby_2_3
+      - test_ruby_2_2
+      - test_ruby_2_1
+      - test_ruby_2_0

data/README.md

@@ -164,7 +164,21 @@ These different types of error are fully documented in the [API documentation](h
 - `#request_id`
 - `#errors`
 
-When the API returns an `invalid_state` error due to an `idempotent_creation_conflict`, where possible, the library will automatically retrieve the existing record which was created using the idempotency key.
+When the API returns an `invalid_state` error due to an `idempotent_creation_conflict`,
+this library will attempt to retrieve the existing record which was created using the
+idempotency key, however you can also configure the library to raise an exception instead:
+
+```ruby
+@client = GoCardlessPro::Client.new(
+  on_idempotency_conflict: :raise
+)
+
+begin
+  @client.payments.create(...)
+rescue GoCardlessPro::IdempotencyConflict => e
+  # do something useful
+end
+```
 
 If the client is unable to connect to GoCardless, an appropriate exception will be raised, for example:
 

data/gocardless_pro.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'rspec', '~> 3.7.0'
+  # Used by webmock and newer versions require ruby 2.1
+  spec.add_development_dependency 'public_suffix', '~> 2.0.5'
   spec.add_development_dependency 'webmock', '~> 1.18'
   spec.add_development_dependency 'rubocop', '~> 0.49.1'
   spec.add_development_dependency 'yard', '~> 0.9.11'

data/lib/gocardless_pro.rb

@@ -53,6 +53,9 @@ require_relative 'gocardless_pro/services/customers_service'
 require_relative 'gocardless_pro/resources/customer_bank_account'
 require_relative 'gocardless_pro/services/customer_bank_accounts_service'
 
+require_relative 'gocardless_pro/resources/customer_notification'
+require_relative 'gocardless_pro/services/customer_notifications_service'
+
 require_relative 'gocardless_pro/resources/event'
 require_relative 'gocardless_pro/services/events_service'
 

data/lib/gocardless_pro/api_service.rb

@@ -11,6 +11,8 @@ require 'base64'
 module GoCardlessPro
   # GoCardless API
   class ApiService
+    attr_reader :on_idempotency_conflict
+
     # Initialize an APIService
     #
     # @param url [String] the URL to make requests to
@@ -31,6 +33,7 @@ module GoCardlessPro
 
       @headers = options[:default_headers] || {}
       @headers['Authorization'] = "Bearer #{token}"
+      @on_idempotency_conflict = options[:on_idempotency_conflict] || :fetch
     end
 
     # Make a request to the API

data/lib/gocardless_pro/client.rb

@@ -28,6 +28,11 @@ module GoCardlessPro
       @customer_bank_accounts ||= Services::CustomerBankAccountsService.new(@api_service)
     end
 
+    # Access to the service for customer_notification to make API calls
+    def customer_notifications
+      @customer_notifications ||= Services::CustomerNotificationsService.new(@api_service)
+    end
+
     # Access to the service for event to make API calls
     def events
       @events ||= Services::EventsService.new(@api_service)
@@ -133,7 +138,7 @@ module GoCardlessPro
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.12.0',
+          'GoCardless-Client-Version' => '2.13.0',
         },
       }
     end

data/lib/gocardless_pro/error/invalid_state_error.rb

@@ -19,4 +19,6 @@ module GoCardlessPro
       errors.find { |error| error['reason'] == IDEMPOTENT_CREATION_CONFLICT }
     end
   end
+
+  IdempotencyConflict = Class.new(Error)
 end

data/lib/gocardless_pro/resources/creditor.rb

@@ -94,6 +94,10 @@ module GoCardlessPro
           @links['default_gbp_payout_account']
         end
 
+        def default_nzd_payout_account
+          @links['default_nzd_payout_account']
+        end
+
         def default_sek_payout_account
           @links['default_sek_payout_account']
         end

data/lib/gocardless_pro/resources/customer.rb

@@ -18,6 +18,9 @@ module GoCardlessPro
     # several Direct Debit [mandates](#core-endpoints-mandates).
     #
     # Notes:
+    # - the `phone_number` field may only be supplied for New Zealand customers,
+    # and must be supplied if you intend to set up an BECS NZ mandate with the
+    # customer.
     # - the `swedish_identity_number` field may only be supplied for Swedish
     # customers, and must be supplied if you intend to set up an Autogiro
     # mandate with the customer.
@@ -39,6 +42,7 @@ module GoCardlessPro
       attr_reader :id
       attr_reader :language
       attr_reader :metadata
+      attr_reader :phone_number
       attr_reader :postal_code
       attr_reader :region
       attr_reader :swedish_identity_number
@@ -62,6 +66,7 @@ module GoCardlessPro
         @id = object['id']
         @language = object['language']
         @metadata = object['metadata']
+        @phone_number = object['phone_number']
         @postal_code = object['postal_code']
         @region = object['region']
         @swedish_identity_number = object['swedish_identity_number']

data/lib/gocardless_pro/resources/customer_notification.rb

@@ -0,0 +1,97 @@
+# 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 customer_notification resource returned from the API
+
+    # Customer Notifications represent the notification which is due to be sent
+    # to a customer
+    # after an event has happened. The event, the resource and the customer to
+    # be notified
+    # are all identified in the `links` property.
+    #
+    # Note that these are ephemeral records - once the notification has been
+    # actioned in some
+    # way, it is no longer visible using this API.
+    #
+    # <p class="restricted-notice"><strong>Restricted</strong>: This API is
+    # currently
+    # only available for approved integrators - please <a
+    # href="mailto:help@gocardless.com">get
+    # in touch</a> if you would like to use this API.</p>
+    #
+    class CustomerNotification
+      attr_reader :action_taken
+      attr_reader :action_taken_at
+      attr_reader :action_taken_by
+      attr_reader :id
+      attr_reader :type
+
+      # Initialize a customer_notification resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @action_taken = object['action_taken']
+        @action_taken_at = object['action_taken_at']
+        @action_taken_by = object['action_taken_by']
+        @id = object['id']
+        @links = object['links']
+        @type = object['type']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @customer_notification_links ||= Links.new(@links)
+      end
+
+      # Provides the customer_notification resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+
+      class Links
+        def initialize(links)
+          @links = links || {}
+        end
+
+        def customer
+          @links['customer']
+        end
+
+        def event
+          @links['event']
+        end
+
+        def mandate
+          @links['mandate']
+        end
+
+        def payment
+          @links['payment']
+        end
+
+        def refund
+          @links['refund']
+        end
+
+        def subscription
+          @links['subscription']
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/event.rb

@@ -18,6 +18,7 @@ module GoCardlessPro
     class Event
       attr_reader :action
       attr_reader :created_at
+      attr_reader :customer_notifications
       attr_reader :details
       attr_reader :id
       attr_reader :metadata
@@ -30,6 +31,7 @@ module GoCardlessPro
 
         @action = object['action']
         @created_at = object['created_at']
+        @customer_notifications = object['customer_notifications']
         @details = object['details']
         @id = object['id']
         @links = object['links']

data/lib/gocardless_pro/resources/mandate_import.rb

@@ -54,7 +54,7 @@ module GoCardlessPro
     #
     # <p class="restricted-notice"><strong>Restricted</strong>: This API is
     # currently
-    # only available for approved partners - please <a
+    # only available for approved integrators - please <a
     # href="mailto:help@gocardless.com">get
     # in touch</a> if you would like to use this API.</p>
     class MandateImport

data/lib/gocardless_pro/resources/mandate_import_entry.rb

@@ -40,7 +40,7 @@ module GoCardlessPro
     #
     # <p class="restricted-notice"><strong>Restricted</strong>: This API is
     # currently
-    # only available for approved partners - please <a
+    # only available for approved integrators - please <a
     # href="mailto:help@gocardless.com">get
     # in touch</a> if you would like to use this API.</p>
     #

data/lib/gocardless_pro/services/creditor_bank_accounts_service.rb

@@ -29,7 +29,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          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
@@ -112,7 +121,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          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

data/lib/gocardless_pro/services/creditors_service.rb

@@ -29,7 +29,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          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

data/lib/gocardless_pro/services/customer_bank_accounts_service.rb

@@ -41,7 +41,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          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
@@ -145,7 +154,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          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

data/lib/gocardless_pro/services/customer_notifications_service.rb

@@ -0,0 +1,66 @@
+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 CustomerNotification endpoints
+    class CustomerNotificationsService < BaseService
+      # "Handling" a notification means that you have sent the notification yourself
+      # (and
+      # don't want GoCardless to send it).
+      # If the notification has already been actioned, or the deadline to notify has
+      # passed,
+      # this endpoint will return an `already_actioned` error and you should not take
+      # further action.
+      #
+      # Example URL: /customer_notifications/:identity/actions/handle
+      #
+      # @param identity       # The id of the notification.
+      # @param options [Hash] parameters as a hash, under a params key.
+      def handle(identity, options = {})
+        path = sub_url('/customer_notifications/:identity/actions/handle', 'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+
+        options[:retry_failures] = false
+
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+
+        Resources::CustomerNotification.new(unenvelope_body(response.body), response)
+      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
+        'customer_notifications'
+      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