gocardless_pro 2.19.0 → 2.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7e71f4726525b3ce899c9f4ce10cb6f957805c654f1025a5aad542c6181aa60
-  data.tar.gz: 9501e18394e43ab7d541712fd3130f2184d6f4caede7916abf01c24add413160
+  metadata.gz: 380e86ab83d0876327222f7966dbae08687e51cec34c468f2f57b9064a6de49b
+  data.tar.gz: 92a6001ee0d724bb218d3d4ef6e245389842391b8d251e7b79afe6210432367a
 SHA512:
-  metadata.gz: a8015fa41e3a0b6c5bd62810ff5f00438d880313d3a0051f756af8ba4d3c6eccd3f71c7b56452fcf9981a52a265feb692caf2deca77cf8705b094e24bb1e3a25
-  data.tar.gz: 972c8baa19abfbe69390010d4350788b04263c4af0665f19f35161f6b899cc32c3d5a073b36bb0596a010f9c8f34442dac56fe643e27588edfbd800ddbd6414e
+  metadata.gz: 6241d24b24dcf35224c87bf2c559c3a0c6f543ef4f3e2c73885e8aee1a4cccc9e8fb748d323df5768c9acd01510b0ae78cf8182d2d684a7feb119bd91ad0c5ac
+  data.tar.gz: 2981ece7e5ad7cef1056ed51a02dc805c5a4c3d41ec483604e2b0ae2a552ca6cd2d2da1e7a92fa1740c9ce61b55e3fecd27c9138817bcf87a8d830047acdd552

data/.circleci/config.yml

@@ -1,50 +1,32 @@
-version: 2
-references:
-  test_library: &test_library
+version: 2.1
+
+jobs:
+  test: &test
     parallelism: 1
+    parameters:
+      faraday-version: { type: string }
+      ruby-version: { type: string }
+    docker:
+      - image: ruby:<<parameters.ruby-version>>
+        environment:
+          - FARADAY_VERSION=<<parameters.faraday-version>>
     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
+      - run: bundle install && bundle exec rspec
 
 workflows:
   version: 2
-  build:
+  tests:
     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
+      - test:
+          matrix:
+            parameters:
+              faraday-version: ["0.9.2", "1.0"]
+              ruby-version: ["2.0", "2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7"]
+            exclude:
+              - faraday-version: "1.0"
+                ruby-version: "2.0"
+              - faraday-version: "1.0"
+                ruby-version: "2.1"
+              - faraday-version: "1.0"
+                ruby-version: "2.2"

data/Gemfile

@@ -1,2 +1,9 @@
 source 'https://rubygems.org'
 gemspec
+
+# We support both pre-1.x and post-1.x Faraday versions, but to ensure compatibility we
+# pin this gem against each in separate runs of CI, using the FARADAY_VERSION env var. For
+# more details on the values, see .circleci/config.yml.
+if ENV.key?("FARADAY_VERSION")
+  gem 'faraday', "~> #{ENV["FARADAY_VERSION"]}"
+end

data/gocardless_pro.gemspec

@@ -17,10 +17,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'faraday', ['>= 0.9.2', '< 1.0']
+  spec.add_dependency 'faraday', ['>= 0.9.2', '< 2']
 
   spec.add_development_dependency 'rspec', '~> 3.7.0'
-  spec.add_development_dependency 'webmock', '~> 1.18'
+  spec.add_development_dependency 'webmock', '~> 3.8.3'
   spec.add_development_dependency 'rubocop', '~> 0.49.1'
   spec.add_development_dependency 'yard', '~> 0.9.11'
 

data/lib/gocardless_pro.rb

@@ -95,4 +95,7 @@ require_relative 'gocardless_pro/services/refunds_service'
 require_relative 'gocardless_pro/resources/subscription'
 require_relative 'gocardless_pro/services/subscriptions_service'
 
+require_relative 'gocardless_pro/resources/tax_rate'
+require_relative 'gocardless_pro/services/tax_rates_service'
+
 require_relative 'gocardless_pro/client.rb'

data/lib/gocardless_pro/api_service.rb

@@ -23,7 +23,7 @@ module GoCardlessPro
       @url = url
       root_url, @path_prefix = unpack_url(url)
       http_adapter = options[:http_adapter] || [:net_http]
-      connection_options = options[:connection_options]
+      connection_options = options.fetch(:connection_options, {})
 
       @connection = Faraday.new(root_url, connection_options) do |faraday|
         faraday.response :raise_gocardless_errors

data/lib/gocardless_pro/client.rb

@@ -98,6 +98,11 @@ module GoCardlessPro
       @subscriptions ||= Services::SubscriptionsService.new(@api_service)
     end
 
+    # Access to the service for tax_rate to make API calls
+    def tax_rates
+      @tax_rates ||= Services::TaxRatesService.new(@api_service)
+    end
+
     # Get a Client configured to use HTTP Basic authentication with the GC Api
     #
     # @param options [Hash<Symbol,String>] configuration for creating the client
@@ -148,7 +153,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.23.0',
         },
       }
     end

data/lib/gocardless_pro/resources/payout.rb

@@ -30,6 +30,7 @@ module GoCardlessPro
       attr_reader :payout_type
       attr_reader :reference
       attr_reader :status
+      attr_reader :tax_currency
 
       # Initialize a payout resource instance
       # @param object [Hash] an object returned from the API
@@ -48,6 +49,7 @@ module GoCardlessPro
         @payout_type = object['payout_type']
         @reference = object['reference']
         @status = object['status']
+        @tax_currency = object['tax_currency']
         @response = response
       end
 

data/lib/gocardless_pro/resources/payout_item.rb

@@ -32,6 +32,7 @@ module GoCardlessPro
     #
     class PayoutItem
       attr_reader :amount
+      attr_reader :taxes
       attr_reader :type
 
       # Initialize a payout_item resource instance
@@ -41,6 +42,7 @@ module GoCardlessPro
 
         @amount = object['amount']
         @links = object['links']
+        @taxes = object['taxes']
         @type = object['type']
         @response = response
       end

data/lib/gocardless_pro/resources/tax_rate.rb

@@ -0,0 +1,48 @@
+# 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 tax_rate resource returned from the API
+
+    # Tax rates from tax authority.
+    class TaxRate
+      attr_reader :end_date
+      attr_reader :id
+      attr_reader :jurisdiction
+      attr_reader :percentage
+      attr_reader :start_date
+      attr_reader :type
+
+      # Initialize a tax_rate resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @end_date = object['end_date']
+        @id = object['id']
+        @jurisdiction = object['jurisdiction']
+        @percentage = object['percentage']
+        @start_date = object['start_date']
+        @type = object['type']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the tax_rate resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/bank_details_lookups_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -59,15 +58,6 @@ module GoCardlessPro
       def envelope_key
         'bank_details_lookups'
       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/base_service.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 module GoCardlessPro
   # Module that contains all services for making requests to the API.
   module Services
@@ -23,6 +25,15 @@ module GoCardlessPro
       def envelope_key
         raise NotImplementedError
       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}", CGI.escape(value))
+        end
+      end
     end
   end
 end

data/lib/gocardless_pro/services/creditor_bank_accounts_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -153,15 +152,6 @@ module GoCardlessPro
       def envelope_key
         'creditor_bank_accounts'
       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/creditors_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -129,15 +128,6 @@ module GoCardlessPro
       def envelope_key
         'creditors'
       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/currency_exchange_rates_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -53,15 +52,6 @@ module GoCardlessPro
       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/customer_bank_accounts_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -186,15 +185,6 @@ module GoCardlessPro
       def envelope_key
         'customer_bank_accounts'
       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/customer_notifications_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -52,15 +51,6 @@ module GoCardlessPro
       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

data/lib/gocardless_pro/services/customers_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -153,15 +152,6 @@ module GoCardlessPro
       def envelope_key
         'customers'
       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/events_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -70,15 +69,6 @@ module GoCardlessPro
       def envelope_key
         'events'
       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

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -162,6 +161,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.
       #
@@ -218,15 +238,6 @@ module GoCardlessPro
       def envelope_key
         'instalment_schedules'
       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