gocardless_pro 2.18.1 → 2.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56e422f17e5916ab4eac449f5d12f138bac13589a481b1da75ca70e2da1ceae6
-  data.tar.gz: 9df2ae977e5988ab8660062884644b8fdd14051d1866d940a3bd61957cd3436f
+  metadata.gz: 2380802da7e32b788d03eb0ce5965cb79b27f310c7643bf40078880823dcb2f7
+  data.tar.gz: ad1ebf6cbec94675df50e0b4a0154fb2eea77f659993625c5d8a9bcb8bd9f7df
 SHA512:
-  metadata.gz: 99e3c28948e6b35328daf3744b44ea934644ed64666f2e2887c44057e03b6fb4e66475c97b53a2ace80f41558864142dcbaee49f07f44217a8224360bd47b13f
-  data.tar.gz: 1451294c75349cb5342388b69d2676ab61785fe6d4bf5b8b8df88c91295e30e67c209c0c24e9e997e2fb4ef808b97fa3b576f92c4509b2b8132929320cb2f9ac
+  metadata.gz: 54622b040fa474ef16f0431e439bef3603d45cdf74c6001bc175fc638057db41231eae81cd9c502e5d16f3a796d6c1e068d27907aeacc1b0bfceb15186bcce0b
+  data.tar.gz: e89435ce6a6da8761c8b113e93f34fe1c7268e462aeda83fe8183620334c35f939c362efc1027b7bf0e3bef1a0ab9d56bb1eacf09e3ab64fd6596f1cc0055ad1

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/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

@@ -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.22.1',
         },
       }
     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/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

data/lib/gocardless_pro/services/mandate_import_entries_service.rb

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

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

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