mangopay 3.4.0 → 3.26.0

data/lib/mangopay/pay_in.rb

@@ -21,6 +21,7 @@ module MangoPay
       # See http://docs.mangopay.com/api-references/payins/payins-card-web/
       class Web < Resource
         include HTTPCalls::Create
+
         def self.url(*)
           "#{MangoPay.api_path}/payins/card/#{CGI.escape(class_name.downcase)}"
         end
@@ -40,6 +41,7 @@ module MangoPay
       # See http://docs.mangopay.com/api-references/payins/payindirectcard/
       class Direct < Resource
         include HTTPCalls::Create
+
         def self.url(*)
           "#{MangoPay.api_path}/payins/card/#{CGI.escape(class_name.downcase)}"
         end
@@ -52,9 +54,14 @@ module MangoPay
       # See http://docs.mangopay.com/api-references/payins/preauthorized-payin/
       class Direct < Resource
         include HTTPCalls::Create
+
         def self.url(*)
           "#{MangoPay.api_path}/payins/preauthorized/direct"
         end
+
+        def self.create_pre_authorized_deposit_pay_in(params, idempotency_key = nil)
+          MangoPay.request(:post, "#{MangoPay.api_path}/payins/deposit-preauthorized/direct/full-capture", params, {}, idempotency_key)
+        end
       end
 
     end
@@ -64,6 +71,7 @@ module MangoPay
       # See http://docs.mangopay.com/api-references/payins/payinbankwire/
       class Direct < Resource
         include HTTPCalls::Create
+
         def self.url(*)
           "#{MangoPay.api_path}/payins/bankwire/direct"
         end
@@ -79,6 +87,7 @@ module MangoPay
       # See http://docs.mangopay.com/api-references/payins/direct-debit-pay-in-web/
       class Web < Resource
         include HTTPCalls::Create
+
         def self.url(*)
           "#{MangoPay.api_path}/payins/directdebit/#{CGI.escape(class_name.downcase)}"
         end
@@ -87,6 +96,7 @@ module MangoPay
       # See https://docs.mangopay.com/api-references/payins/direct-debit-pay-in-direct/
       class Direct < Resource
         include HTTPCalls::Create
+
         def self.url(*)
           "#{MangoPay.api_path}/payins/directdebit/#{CGI.escape(class_name.downcase)}"
         end
@@ -97,11 +107,38 @@ module MangoPay
     module PayPal
 
       # See https://docs.mangopay.com/api-references/payins/paypal-payin/
+      # # <b>DEPRECATED</b>: 'create' function is now deprecated.
+      # Please use the 'create_v2' function - MangoPay::PayIn::PayPal::Web.create_new(params)
       class Web < Resource
         include HTTPCalls::Create
+
         def self.url(*)
           "#{MangoPay.api_path}/payins/paypal/#{CGI.escape(class_name.downcase)}"
         end
+
+        def self.create_v2(params, idempotency_key = nil)
+          MangoPay.request(:post, "#{MangoPay.api_path}/payins/payment-methods/paypal", params, {}, idempotency_key)
+        end
+
+        # Add tracking information to a PayPal PayIn (add the tracking number and carrier for LineItems shipments.)
+        # Caution – Tracking information cannot be edited
+        # You can’t modify the TrackingNumber, Carrier, or NotifyBuyer once added.
+        # You can only send a unique tracking number once.
+        def self.add_paypal_tracking_information(pay_in_id, params, idempotency_key = nil)
+          MangoPay.request(:put, "#{MangoPay.api_path}/payins/#{pay_in_id}/trackings", params, {}, idempotency_key)
+        end
+      end
+
+    end
+
+    module Payconiq
+
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payconiq/#{CGI.escape(class_name.downcase)}"
+        end
       end
 
     end
@@ -121,7 +158,119 @@ module MangoPay
         include HTTPCalls::Create
 
         def self.url(*)
-          "#{MangoPay.api_path}/payins/googlepay/#{CGI.escape(class_name.downcase)}"
+          "#{MangoPay.api_path}/payins/payment-methods/googlepay"
+        end
+      end
+    end
+
+    module Mbway
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/mbway"
+        end
+      end
+    end
+
+    module Multibanco
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/multibanco"
+        end
+      end
+    end
+
+    module Blik
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/blik"
+        end
+      end
+    end
+
+    module Satispay
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/satispay"
+        end
+      end
+    end
+
+    module Klarna
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/klarna"
+        end
+      end
+    end
+
+    module Ideal
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/ideal"
+        end
+      end
+    end
+
+    module Giropay
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/giropay"
+        end
+      end
+    end
+
+    module Bancontact
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/bancontact"
+        end
+      end
+    end
+
+    module RecurringPayments
+      class Recurring < Resource
+        include HTTPCalls::Create
+        include HTTPCalls::Fetch
+        include HTTPCalls::Update
+
+        def self.url(*args)
+          if args.any?
+            "#{MangoPay.api_path}/recurringpayinregistrations/#{args.first}"
+          else
+            "#{MangoPay.api_path}/recurringpayinregistrations"
+          end
+        end
+      end
+
+      class CIT < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/recurring/card/direct"
+        end
+      end
+
+      class MIT < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/recurring/card/direct"
         end
       end
     end

data/lib/mangopay/pay_out.rb

@@ -26,5 +26,16 @@ module MangoPay
         MangoPay.request(:get, url);
       end
     end
+
+    # See https://docs.mangopay.com/endpoints/v2.01/payouts#e1058_check-instant-payout-eligibility
+    module InstantPayoutEligibility
+      class Reachability < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payouts/reachability"
+        end
+      end
+    end
   end
 end

data/lib/mangopay/payment_method_metadata.rb

@@ -0,0 +1,13 @@
+module MangoPay
+  class PaymentMethodMetadata < Resource
+    include HTTPCalls::Fetch
+    include HTTPCalls::Update
+
+    class << self
+      def get_metadata(metadata)
+        url = "#{MangoPay.api_path}/payment-methods/metadata"
+        MangoPay.request(:post, url, metadata)
+      end
+    end
+  end
+end

data/lib/mangopay/refund.rb

@@ -2,6 +2,7 @@ module MangoPay
 
   # See http://docs.mangopay.com/api-references/refund/
   class Refund < Resource
+    include HTTPCalls::Create
     include HTTPCalls::Fetch
 
     # Fetches list of refunds belonging to given +repudiation_id+

data/lib/mangopay/regulatory.rb

@@ -0,0 +1,22 @@
+module MangoPay
+  # Provides API methods for the UBO entity.
+  class Regulatory < Resource
+    class << self
+      def one_country_url(country_iso)
+        "#{MangoPay.api_path_no_client}/countries/#{country_iso}/authorizations"
+      end
+
+      def all_countries_url
+        "#{MangoPay.api_path_no_client}/countries/authorizations"
+      end
+
+      def get_country_authorizations(country_iso)
+        MangoPay.request(:get, one_country_url(country_iso))
+      end
+
+      def get_all_countries_authorizations
+        MangoPay.request(:get, all_countries_url)
+      end
+    end
+  end
+end

data/lib/mangopay/ubo_declaration.rb

@@ -10,15 +10,17 @@ module MangoPay
         end
       end
 
-      def create(user_id, idempotency_key)
+      def create(user_id, idempotency_key = nil)
         MangoPay.request(:post, url(user_id), {}, {}, idempotency_key)
       end
 
-      def fetch(user_id, id, idempotency_key)
-        MangoPay.request(:get, url(user_id, id), {}, {}, idempotency_key)
+      # Fetches the Ubo declaration belonging to the given +user_id+ if given, with the given +id+.
+      def fetch(user_id, id, idempotency_key = nil)
+        url = (user_id) ? url(user_id, id) : "#{MangoPay.api_path}/kyc/ubodeclarations/#{CGI.escape(id.to_s)}"
+        MangoPay.request(:get, url, {}, {}, idempotency_key)
       end
 
-      def update(user_id, id, params = {}, idempotency_key)
+      def update(user_id, id, params = {}, idempotency_key = nil)
         request_params = {
             Status: params['Status'],
             Ubos: params['Ubos']

data/lib/mangopay/version.rb

@@ -1,3 +1,3 @@
 module MangoPay
-  VERSION = '3.4.0'
+  VERSION = '3.26.0'
 end

data/lib/mangopay.rb

@@ -5,6 +5,7 @@ require 'multi_json'
 require 'benchmark'
 require 'logger'
 require 'time'
+require 'securerandom'
 
 # helpers
 require 'mangopay/version'
@@ -42,15 +43,38 @@ module MangoPay
   autoload :BankingAliasesIBAN, 'mangopay/bankingaliases_iban'
   autoload :UboDeclaration, 'mangopay/ubo_declaration'
   autoload :Ubo, 'mangopay/ubo'
+  autoload :Regulatory, 'mangopay/regulatory'
+  autoload :Deposit, 'mangopay/deposit'
+  autoload :Conversion, 'mangopay/conversion'
+  autoload :PaymentMethodMetadata, 'mangopay/payment_method_metadata'
 
   # temporary
   autoload :Temp, 'mangopay/temp'
 
+  @configurations = {}
+
   class Configuration
     attr_accessor :preproduction, :root_url,
                   :client_id, :client_apiKey,
-                  :temp_dir, :log_file, :http_timeout,
-                  :logger
+                  :temp_dir, :log_file, :log_trace_headers, :http_timeout,
+                  :http_max_retries, :http_open_timeout,
+                  :logger, :use_ssl, :uk_header_flag
+
+    def apply_configuration
+      MangoPay.configure do |config|
+        config.preproduction = @preproduction
+        config.client_id = @client_id
+        config.client_apiKey = @client_apiKey
+        config.log_file = @log_file
+        config.log_trace_headers = @log_trace_headers
+        config.http_timeout = @http_timeout
+        config.http_max_retries = @http_max_retries
+        config.http_open_timeout = @http_open_timeout
+        config.use_ssl = @use_ssl
+        config.logger = @logger
+        config.uk_header_flag = @uk_header_flag
+      end
+    end
 
     def preproduction
       @preproduction || false
@@ -61,7 +85,31 @@ module MangoPay
     end
 
     def http_timeout
-      @http_timeout || 10000
+      @http_timeout || 30
+    end
+
+    def http_max_retries
+      @http_max_retries || 1
+    end
+
+    def http_open_timeout
+      @http_open_timeout || 30
+    end
+
+    def use_ssl?
+      return true unless preproduction == true
+      return true unless defined?(@use_ssl)
+      return false if @use_ssl == false
+
+      true
+    end
+    
+    def log_trace_headers
+      @log_trace_headers || false
+    end
+
+    def uk_header_flag
+      @uk_header_flag || false
     end
   end
 
@@ -74,6 +122,10 @@ module MangoPay
       "/#{version_code}/#{MangoPay.configuration.client_id}"
     end
 
+    def api_path_no_client
+      "/#{version_code}"
+    end
+
     def api_uri(url='')
       URI(configuration.root_url + url)
     end
@@ -114,6 +166,23 @@ module MangoPay
       @ratelimit = obj
     end
 
+    # Add MangoPay.Configuration to the list of configs
+    def add_config(name, config)
+      @configurations[name] = config
+    end
+
+    # Fetch a MangoPay configuration from the list of configs. Throw error if not found
+    def get_config(name)
+      config = @configurations[name]
+      raise "Could not find any configuration with name '#{name}'" unless config
+      config
+    end
+
+    def remove_config(name)
+      raise "Could not find any configuration with name '#{name}'" unless @configurations[name]
+      @configurations[name] = nil
+    end
+
     #
     # - +method+: HTTP method; lowercase symbol, e.g. :get, :post etc.
     # - +url+: the part after Configuration#root_url
@@ -135,7 +204,13 @@ module MangoPay
         headers['Idempotency-Key'] = headers_or_idempotency_key if headers_or_idempotency_key != nil
       end
 
-      res = Net::HTTP.start(uri.host, uri.port, use_ssl: true, :read_timeout => configuration.http_timeout, ssl_version: :TLSv1_2) do |http|
+      if configuration.uk_header_flag
+        headers['x-tenant-id'] = 'uk'
+      end
+
+      res = Net::HTTP.start(uri.host, uri.port, :use_ssl => configuration.use_ssl?, :read_timeout => configuration.http_timeout,
+                            :max_retries => configuration.http_max_retries,
+                            :open_timeout => configuration.http_open_timeout, ssl_version: :TLSv1_2) do |http|
         req = Net::HTTP::const_get(method.capitalize).new(uri.request_uri, headers)
         req.body = JSON.dump(params)
         before_request_proc.call(req) if before_request_proc
@@ -145,7 +220,13 @@ module MangoPay
       raise MangoPay::ResponseError.new(uri, '408', {'Message' => 'Request Timeout'}) if res.nil?
 
       # decode json data
-      data = res.body.to_s.empty? ? {} : JSON.load(res.body.to_s)
+      begin
+        data = res.body.to_s.empty? ? {} : JSON.load(res.body.to_s)
+      rescue MultiJson::ParseError
+        details = {}
+        details['Message'] = res.body
+        raise MangoPay::ResponseError.new(uri, res.code, details)
+      end
 
       unless res.is_a?(Net::HTTPOK)
         raise MangoPay::ResponseError.new(uri, res.code, data)
@@ -199,6 +280,9 @@ module MangoPay
           'Authorization' => "#{auth_token['token_type']} #{auth_token['access_token']}",
           'Content-Type' => 'application/json'
       }
+      if configuration.log_trace_headers
+        headers.update('x_mangopay_trace-id' => SecureRandom.uuid)
+      end
       begin
         headers.update('x_mangopay_client_user_agent' => JSON.dump(user_agent))
       rescue => e
@@ -217,7 +301,12 @@ module MangoPay
     def do_request_with_log(http, req, uri)
       res, time = nil, nil
       params = FilterParameters.request(req.body)
-      line = "[#{Time.now.iso8601}] #{req.method.upcase} \"#{uri.to_s}\" #{params}"
+      if configuration.log_trace_headers
+        trace_headers = JSON.dump({ 'Idempotency-Key' => req['Idempotency-Key'] , 'x_mangopay_trace-id' =>  req['x_mangopay_trace-id'] })
+        line = "[#{Time.now.iso8601}] #{req.method.upcase} \"#{uri.to_s}\" #{params} #{trace_headers}"
+      else
+        line = "[#{Time.now.iso8601}] #{req.method.upcase} \"#{uri.to_s}\" #{params}"
+      end
       begin
         time = Benchmark.realtime {
           begin
@@ -229,12 +318,17 @@ module MangoPay
         res
       ensure
         line = "#{log_severity(res)} #{line}"
+        if time.nil?
+          time_log = "[Unknown ms]"
+        else
+          time_log = "[#{(time * 1000).round(1)}ms]"
+        end
         if res.nil?
           params = ''
-          line += "\n  [#{(time * 1000).round(1)}ms] 408 Request Timeout #{params}\n"
+          line += "\n  #{time_log} 408 Request Timeout #{params}\n"
         else
           params = FilterParameters.response(res.body)
-          line += "\n  [#{(time * 1000).round(1)}ms] #{res.code} #{params}\n"
+          line += "\n  #{time_log} #{res.code} #{params}\n"
         end
         logger.info { line }
       end

data/spec/mangopay/bankingaliases_spec.rb

@@ -1,7 +1,7 @@
 describe MangoPay::BankingAliases do
   include_context 'users'
   include_context 'wallets'
-  include_context 'bankigaliases'
+  include_context 'bankingaliases'
 
   describe 'CREATE' do
     it 'creates a new banking alias' do

data/spec/mangopay/card_registration_spec.rb

@@ -6,7 +6,6 @@ describe MangoPay::CardRegistration do
     it 'creates a new card registration' do
       created = new_card_registration
       expect(created['Id']).not_to be_nil
-      expect(created['Id'].to_i).to be > 0
       expect(created['AccessKey']).not_to be_nil
       expect(created['PreregistrationData']).not_to be_nil
       expect(created['CardRegistrationURL']).not_to be_nil
@@ -51,7 +50,6 @@ describe MangoPay::CardRegistration do
 
       # card id filled-in...
       expect(card_id).not_to be_nil
-      expect(card_id.to_i).to be > 0
 
       # ...and points to existing (newly created) card
       card = MangoPay::Card.fetch(card_id)
@@ -92,4 +90,21 @@ describe MangoPay::CardRegistration do
       expect(transactions).to be_an(Array)
     end
   end
+
+  describe 'VALIDATE CARD' do
+    it "validates a card" do
+      created = new_card_registration_completed
+      validated = create_card_validation(created['UserId'], created['CardId'])
+
+      expect(validated).to_not be_nil
+    end
+
+    it "fetches card validation" do
+      created = new_card_registration_completed
+      card_validation = create_card_validation(created['UserId'], created['CardId'])
+      fetched_card_validation = MangoPay::Card.get_card_validation(created['CardId'], card_validation['Id'])
+
+      expect(card_validation['Id']).equal? fetched_card_validation['Id']
+    end
+  end
 end

data/spec/mangopay/client_spec.rb

@@ -126,18 +126,18 @@ describe MangoPay::Client do
     end
   end
 
-  describe 'validate' do
-    it 'validates card' do
-      client = MangoPay::Client.fetch
-      completed = new_card_registration_completed
-      card_id = completed['CardId']
-      client_id = client['ClientId']
-
-      card = MangoPay::Client.validate(client_id, card_id)
-      expect(client).not_to be_nil
-      expect(card).not_to be_nil
-    end
-  end
+  # describe 'validate' do
+  #   it 'validates card' do
+  #     client = MangoPay::Client.fetch
+  #     completed = new_card_registration_completed
+  #     card_id = completed['CardId']
+  #     client_id = client['ClientId']
+  #
+  #     card = MangoPay::Client.validate(client_id, card_id)
+  #     expect(client).not_to be_nil
+  #     expect(card).not_to be_nil
+  #   end
+  # end
 
   describe 'create_bank_account' do
     it 'creates a new bank account' do

data/spec/mangopay/configuration_spec.rb

@@ -13,12 +13,110 @@ describe MangoPay::Configuration do
       }
   end
 
+  it 'fails when calling with wrong client credentials, but succeeds after applying a new (correct) config' do
+    # create a wrong configuration
+    wrong_config = MangoPay::Configuration.new
+    wrong_config.client_id = 'placeholder'
+    wrong_config.client_apiKey = '0000'
+    wrong_config.preproduction = true
+
+    # create a valid configuration
+    valid_config = MangoPay::Configuration.new
+    valid_config.client_id = 'sdk-unit-tests'
+    valid_config.client_apiKey = 'cqFfFrWfCcb7UadHNxx2C9Lo6Djw8ZduLi7J9USTmu8bhxxpju'
+    valid_config.preproduction = true
+
+    # add the 2 configs to the list of MangoPay configs
+    MangoPay.add_config('wrong', wrong_config)
+    MangoPay.add_config('valid', valid_config)
+
+    # apply wrong config
+    MangoPay.get_config('wrong').apply_configuration
+
+    expect {
+      MangoPay::User.fetch()
+    }.to raise_error { |err|
+      expect(err).to be_a MangoPay::ResponseError
+      expect(err.code).to eq '401'
+      expect(err.message).to eq 'invalid_client'
+    }
+
+    # apply valid configuration
+    MangoPay.get_config('valid').apply_configuration
+
+    # expect success
+    users = MangoPay::User.fetch()
+    expect(users).to be_kind_of(Array)
+  end
+
+  it 'fails when fetching a config that does not exist' do
+    expect {
+      MangoPay.get_config('placeholder')
+    }.to raise_error { |err|
+      expect(err).to be_a RuntimeError
+      expect(err.message).to eq "Could not find any configuration with name 'placeholder'"
+    }
+  end
+
+  it 'succeeds when removing config' do
+    wrong_config = MangoPay::Configuration.new
+    wrong_config.client_id = 'placeholder'
+    wrong_config.client_apiKey = '0000'
+    wrong_config.preproduction = true
+
+    MangoPay.add_config('wrong', wrong_config)
+
+    # pass when fetching config before removing it
+    MangoPay.get_config('wrong')
+
+    # remove config
+    MangoPay.remove_config('wrong')
+
+    # fail when trying to fetch after removal
+    expect {
+      MangoPay.get_config('wrong')
+    }.to raise_error { |err|
+      expect(err).to be_a RuntimeError
+      expect(err.message).to eq "Could not find any configuration with name 'wrong'"
+    }
+  end
+
   it 'goes ok when calling with correct client credentials' do
     reset_mangopay_configuration
     users = MangoPay::User.fetch()
     expect(users).to be_kind_of(Array)
   end
 
+  describe '.use_ssl?' do
+    let(:configuration) { MangoPay::Configuration.new }
+
+    it 'defaults to true' do
+      expect(configuration.use_ssl?).to eq(true)
+    end
+
+    context 'when assigned to false in production' do
+      before do
+        configuration.use_ssl = false
+        configuration.preproduction = false
+      end
+
+      it 'uses true as value' do
+        expect(configuration.use_ssl?).to eq(true)
+      end
+    end
+
+    context 'when assigned to false in preproduction' do
+      before do
+        configuration.use_ssl = false
+        configuration.preproduction = true
+      end
+
+      it 'uses assigned as value' do
+        expect(configuration.use_ssl?).to eq(false)
+      end
+    end
+  end
+
   describe 'logger' do
     around(:each) do |example|
       c = MangoPay.configuration