mangopay 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efb0b3e0cf693443b3c9e18d1553a029762cf2263d6ca10d72cd1e19a075de21
-  data.tar.gz: f3a81ab3ed039247efec2bc76f48fe2c28dafb097d6211fbae1d6394b49f8a4d
+  metadata.gz: 98ce43d5b86c9ebc7d2b4385da9ef113e4cac11ca6cacc3fe339afc2cf0c3197
+  data.tar.gz: 1879444087321901f562eb4e031a7fa5474fbfb63119908e69964a381bb5d03b
 SHA512:
-  metadata.gz: c3132d0152e7c24690c347d761d3d41dfe1e264ae9a7918590cf792223ee7ba071919ef7339a29bfe21fc33a63297c147c5c5cf9d5a84274119acc052de37ad0
-  data.tar.gz: 1634c646e41c4948dae6abb69fa93319c28b1e7e1cd3ce4383aa966b2b058808fb94e5f4a8f1b448b746475e42c7a09aa4a5c1a4a84d0568bcccb77ed2f61d87
+  metadata.gz: 9daff7284d4b7f3720655a7933e0971ca34f80f945de6b8bcbef83b5ab83c46e42ca7bc23d804fcd35e982bfdb8afdf7d936c4a1e93c0f8ae190cc539f0cd9d2
+  data.tar.gz: edbde0cde8b2308e6d950a730f595cedfe53e50852a30baff92be7cf58869b99cc0817304095d723f0aa48e72812c88c7fdecb83c0bd78c6cc5199986a2f9730

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [3.3.0]
+## Fixed
+
+### IBAN for testing purposes
+
+⚠️ **IBAN provided for testing purpose should never be used outside of a testing environement!**
+
+More information about how to test payments, click [here](https://docs.mangopay.com/guide/testing-payments).
+
+### Others
+
+- Adding missing json require in log requests filter spec. Thank you @Vin0uz
+- Extend fetch_wallet and create_payout API. Thank you @peterb
+
+## Added
+
+Some of you use a lot the [PreAuthorization](https://docs.mangopay.com/endpoints/v2.01/preauthorizations#e183_the-preauthorization-object) feature of our API. To make your life easier, we have added three new events :
+
+- PREAUTHORIZATION_CREATED
+- PREAUTHORIZATION_SUCCEEDED
+- PREAUTHORIZATION_FAILED
+
+The goal is to help you monitor a PreAuthorization with a [webhook](https://docs.mangopay.com/endpoints/v2.01/hooks#e246_the-hook-object).
+
+*Example: If a PreAuthorization is desynchronized, when the status is updated, you will be able to know it.*
+
+
+
 ## [3.2.0]
 ## Added
 

data/lib/mangopay/client.rb

@@ -47,7 +47,10 @@ module MangoPay
       # +currency_iso_code+ is currncy ISO code
       # see https://docs.mangopay.com/api-references/client-wallets/
       def fetch_wallet(funds_type, currency_iso_code)
-        MangoPay.request(:get, url() + "/wallets/#{funds_type}/#{currency_iso_code}")
+        method = :get
+        path = url() + "/wallets/#{funds_type}/#{currency_iso_code}"
+        yield method, path if block_given?
+        MangoPay.request(method, path)
       end
 
       # Fetch transactions for all your client wallets.
@@ -79,7 +82,10 @@ module MangoPay
       end
 
       def create_payout(params)
-        MangoPay.request(:post, url() + "/payouts", params)
+        method = :post
+        path = url() + "/payouts"
+        yield method, path, params if block_given?
+        MangoPay.request(method, path, params)
       end
 
     end

data/lib/mangopay/dispute.rb

@@ -8,9 +8,9 @@ module MangoPay
     include HTTPCalls::Update
     class << self
 
-      def close(dispute_id)
+      def close(dispute_id, idempotency_key = nil)
         url = url(dispute_id) + "/close/"
-        MangoPay.request(:put, url)
+        MangoPay.request(:put, url, {}, {}, idempotency_key)
       end
 
       # +contested_funds+: Money hash
@@ -44,7 +44,7 @@ module MangoPay
         url = "#{MangoPay.api_path}/disputes/pendingsettlement"
         MangoPay.request(:get, url, {}, filters)
       end
-      
+
       #####################################################
       # repudiations / settlement transfers
       #####################################################
@@ -66,7 +66,7 @@ module MangoPay
         url = "#{MangoPay.api_path}/settlements/#{transfer_id}"
         MangoPay.request(:get, url)
       end
-      
+
       #####################################################
       # documents
       #####################################################
@@ -91,13 +91,13 @@ module MangoPay
       # Fetches list of dispute documents:
       # - for the particular dispute if +dispute_id+ is provided (not nil)
       # - or for all disputes otherwise.
-      # 
+      #
       # Optional +filters+ is a hash accepting following keys:
       # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
       # - filters such as +Type+ (e.g. 'REFUND_PROOF') and +Status+ (e.g. 'VALIDATED')
       # - +BeforeDate+ (timestamp): filters documents with CreationDate _before_ this date
       # - +AfterDate+ (timestamp): filters documents with CreationDate _after_ this date
-      # 
+      #
       # See https://docs.mangopay.com/api-references/disputes/dispute-documents/
       #
       def fetch_documents(dispute_id = nil, filters = {})
@@ -106,12 +106,12 @@ module MangoPay
       end
 
       # Adds the file page (attachment) to the given document.
-      # 
+      #
       # See https://docs.mangopay.com/api-references/disputes/dispute-document-pages/ :
       # - Document have to be in 'CREATED' Status
       # - You can create as many pages as needed
       # - Change Status to 'VALIDATION_ASKED' to submit dispute documents
-      # 
+      #
       # The file_content_base64 param may be:
       # - Base64 encoded file content
       # - or nil: in this case pass the file path in the next param

data/lib/mangopay/http_calls.rb

@@ -52,9 +52,9 @@ module MangoPay
         #   MangoPay::User.fetch(filter = {'page' => 2, 'per_page' => 3})
         #   filter # => {"page"=>2, "per_page"=>3, "total_pages"=>1969, "total_items"=>5905}
         #
-        def fetch(id_or_filters = nil)
+        def fetch(id_or_filters = nil, idempotency_key = nil)
           id, filters = HTTPCalls::Fetch.parse_id_or_filters(id_or_filters)
-          response = MangoPay.request(:get, url(id), {}, filters)
+          response = MangoPay.request(:get, url(id), {}, filters, idempotency_key)
         end
       end
 

data/lib/mangopay/kyc_document.rb

@@ -9,20 +9,20 @@ module MangoPay
         MangoPay.request(:post, url(user_id), params, {}, idempotency_key)
       end
 
-      def update(user_id, document_id, params = {})
-        MangoPay.request(:put, url(user_id, document_id), params)
+      def update(user_id, document_id, params = {}, idempotency_key = nil)
+        MangoPay.request(:put, url(user_id, document_id), params, {}, idempotency_key)
       end
 
       # Fetches the KYC document belonging to the given +user_id+, with the given +document_id+.
-      def fetch(user_id, document_id)
+      def fetch(user_id, document_id, idempotency_key = nil)
         url = (user_id) ? url(user_id, document_id) : "#{MangoPay.api_path}/KYC/documents/#{CGI.escape(document_id.to_s)}"
-        MangoPay.request(:get, url)
+        MangoPay.request(:get, url, {}, {}, idempotency_key)
       end
 
       # Fetches list of KYC documents:
       # - for the particular user if +user_id+ is provided (not nil)
       # - or for all users otherwise.
-      # 
+      #
       # Optional +filters+ is a hash accepting following keys:
       # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
       # - filters such as +Type+ (e.g. 'IDENTITY_PROOF') and +Status+ (e.g. 'VALIDATED')
@@ -35,12 +35,12 @@ module MangoPay
       end
 
       # Adds the file page (attachment) to the given document.
-      # 
+      #
       # See http://docs.mangopay.com/api-references/kyc/pages/ :
       # - Document have to be in 'CREATED' Status
       # - You can create as many pages as needed
       # - Change Status to 'VALIDATION_ASKED' to submit KYC documents
-      # 
+      #
       # The file_content_base64 param may be:
       # - Base64 encoded file content
       # - or nil: in this case pass the file path in the next param

data/lib/mangopay/pay_out.rb

@@ -8,9 +8,9 @@ module MangoPay
     # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
     # - +Status+: TransactionStatus {CREATED, SUCCEEDED, FAILED}
     # - +ResultCode+: string representing the transaction result
-    def self.refunds(pay_out_id, filters = {})
+    def self.refunds(pay_out_id, filters = {}, idempotency_key = nil)
       url = url(pay_out_id) + '/refunds'
-      MangoPay.request(:get, url, {}, filters)
+      MangoPay.request(:get, url, {}, filters, idempotency_key)
     end
 
     # See http://docs.mangopay.com/api-references/pay-out-bank-wire/

data/lib/mangopay/transaction.rb

@@ -3,7 +3,7 @@ module MangoPay
     class << self
       # Fetches list of transactions belonging to the given +wallet_id+.
       # See also transactions for user: MangoPay::User#transactions
-      # 
+      #
       # Optional +filters+ is a hash accepting following keys:
       # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
       # - +Status+: TransactionStatus {CREATED, SUCCEEDED, FAILED}
@@ -12,8 +12,8 @@ module MangoPay
       # - +BeforeDate+ (timestamp): filters transactions with CreationDate _before_ this date
       # - +AfterDate+ (timestamp): filters transactions with CreationDate _after_ this date
       # See https://docs.mangopay.com/api-references/sort-lists/
-      def fetch(wallet_id, filters={})
-        MangoPay.request(:get, url(wallet_id), {}, filters)
+      def fetch(wallet_id, filters={}, headers = nil)
+        MangoPay.request(:get, url(wallet_id), {}, filters, headers)
       end
 
       def url(wallet_id)

data/lib/mangopay/ubo.rb

@@ -10,16 +10,16 @@ module MangoPay
         end
       end
 
-      def create(user_id, ubo_declaration_id, params)
-        MangoPay.request(:post, url(user_id, ubo_declaration_id), params)
+      def create(user_id, ubo_declaration_id, params, idempotency_key = nil)
+        MangoPay.request(:post, url(user_id, ubo_declaration_id), params, {}, idempotency_key)
       end
 
       def fetch(user_id, ubo_declaration_id, ubo_id)
         MangoPay.request(:get, url(user_id, ubo_declaration_id, ubo_id))
       end
 
-      def update(user_id, ubo_declaration_id, ubo_id, params)
-        MangoPay.request(:put, url(user_id, ubo_declaration_id, ubo_id), params)
+      def update(user_id, ubo_declaration_id, ubo_id, params, idempotency_key = nil)
+        MangoPay.request(:put, url(user_id, ubo_declaration_id, ubo_id), params, {}, idempotency_key)
       end
     end
   end

data/lib/mangopay/ubo_declaration.rb

@@ -10,20 +10,20 @@ module MangoPay
         end
       end
 
-      def create(user_id)
-        MangoPay.request(:post, url(user_id))
+      def create(user_id, idempotency_key)
+        MangoPay.request(:post, url(user_id), {}, {}, idempotency_key)
       end
 
-      def fetch(user_id, id)
-        MangoPay.request(:get, url(user_id, id))
+      def fetch(user_id, id, idempotency_key)
+        MangoPay.request(:get, url(user_id, id), {}, {}, idempotency_key)
       end
 
-      def update(user_id, id, params = {})
+      def update(user_id, id, params = {}, idempotency_key)
         request_params = {
             Status: params['Status'],
             Ubos: params['Ubos']
         }
-        MangoPay.request(:put, url(user_id, id), request_params)
+        MangoPay.request(:put, url(user_id, id), request_params, {}, idempotency_key)
       end
     end
   end

data/lib/mangopay/version.rb

@@ -1,3 +1,3 @@
 module MangoPay
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

data/lib/mangopay/wallet.rb

@@ -10,8 +10,8 @@ module MangoPay
     # Optional +filters+ is a hash accepting following keys:
     # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
     # - other keys specific for transactions filtering (see MangoPay::Transaction.fetch)
-    def self.transactions(wallet_id, filters = {})
-      Transaction.fetch(wallet_id, filters)
+    def self.transactions(wallet_id, filters = {}, headers = nil)
+      Transaction.fetch(wallet_id, filters, headers)
     end
   end
 end

data/spec/mangopay/client_spec.rb

@@ -151,8 +151,8 @@ describe MangoPay::Client do
                                                               PostalCode: '75001',
                                                               Country: 'FR'
                                                           },
-                                                          IBAN: 'FR7618829754160173622224154',
-                                                          BIC: 'CMBRFR2BCME',
+                                                          IBAN: 'FR7630004000031234567890143',
+                                                          BIC: 'BNPAFRPP',
                                                           Tag: 'Test bank account')
       expect(bank_account).not_to be_nil
       expect(bank_account['Id']).not_to be_nil
@@ -172,8 +172,8 @@ describe MangoPay::Client do
                                                               PostalCode: '75001',
                                                               Country: 'FR'
                                                           },
-                                                          IBAN: 'FR7618829754160173622224154',
-                                                          BIC: 'CMBRFR2BCME',
+                                                          IBAN: 'FR7630004000031234567890143',
+                                                          BIC: 'BNPAFRPP',
                                                           Tag: 'Test bank account')
       pay_out = MangoPay::Client.create_payout(BankAccountId: bank_account['Id'],
 

data/spec/mangopay/log_requests_filter_spec.rb

@@ -1,6 +1,7 @@
 describe MangoPay do
   include_context 'users'
   include_context 'payins'
+  require 'json'
 
   describe 'requests log file' do
 

data/spec/mangopay/shared_resources.rb

@@ -136,8 +136,8 @@ shared_context 'bank_accounts' do
                                      PostalCode: '75001',
                                      Country: 'FR'
                                  },
-                                 IBAN: 'FR7618829754160173622224154',
-                                 BIC: 'CMBRFR2BCME',
+                                 IBAN: 'FR7630004000031234567890143',
+                                 BIC: 'BNPAFRPP',
                                  Tag: 'Test bank account')
   end
 end

data/spec/mangopay/ubo_declaration_spec.rb

@@ -6,9 +6,9 @@ describe MangoPay::UboDeclaration do
     it 'can fetch a UBO declaration' do
       legal_user = new_legal_user
 
-      ubo_declaration = MangoPay::UboDeclaration.create(legal_user['Id'])
+      ubo_declaration = MangoPay::UboDeclaration.create(legal_user['Id'], nil)
 
-      ubo_declaration_byId = MangoPay::UboDeclaration.fetch(legal_user['Id'], ubo_declaration['Id'])
+      ubo_declaration_byId = MangoPay::UboDeclaration.fetch(legal_user['Id'], ubo_declaration['Id'], nil)
 
       expect(ubo_declaration).not_to be_nil
       expect(ubo_declaration_byId).not_to be_nil
@@ -17,13 +17,13 @@ describe MangoPay::UboDeclaration do
     describe 'UPDATE' do
       it 'can update a UBO declaration' do
         legal_user = new_legal_user
-        ubo_declaration = MangoPay::UboDeclaration.create(legal_user['Id'])
+        ubo_declaration = MangoPay::UboDeclaration.create(legal_user['Id'], nil)
         ubo_declaration['Status'] = 'VALIDATION_ASKED'
 
         ubo = new_ubo(legal_user, ubo_declaration)
 
         ubo_declaration['Ubos'] = [ubo]
-        ubo_declaration = MangoPay::UboDeclaration.update(legal_user['Id'], ubo_declaration['Id'], ubo_declaration)
+        ubo_declaration = MangoPay::UboDeclaration.update(legal_user['Id'], ubo_declaration['Id'], ubo_declaration, nil)
 
         expect(ubo_declaration).not_to be_nil
         expect(ubo_declaration['Status']).to eq 'VALIDATION_ASKED'

data/spec/mangopay/ubo_spec.rb

@@ -5,7 +5,7 @@ describe MangoPay::Ubo do
   describe 'FETCH' do
     it 'can fetch a Ubo' do
       legal_user = new_legal_user
-      ubo_declaration = MangoPay::UboDeclaration.create(legal_user['Id'])
+      ubo_declaration = MangoPay::UboDeclaration.create(legal_user['Id'], nil)
       ubo = new_ubo(legal_user, ubo_declaration)
       result = MangoPay::Ubo.fetch(legal_user['Id'], ubo_declaration['Id'], ubo['Id'])
       expect(result).not_to be_nil
@@ -16,7 +16,7 @@ describe MangoPay::Ubo do
   describe 'CREATE' do
     it 'can create a new Ubo' do
       legal_user = new_legal_user
-      ubo_declaration = MangoPay::UboDeclaration.create(legal_user['Id'])
+      ubo_declaration = MangoPay::UboDeclaration.create(legal_user['Id'], nil)
       result = new_ubo(legal_user, ubo_declaration)
       expect(result).not_to be_nil
     end
@@ -25,7 +25,7 @@ describe MangoPay::Ubo do
   describe 'UPDATE' do
     it 'can update a Ubo' do
       legal_user = new_legal_user
-      ubo_declaration = MangoPay::UboDeclaration.create(legal_user['Id'])
+      ubo_declaration = MangoPay::UboDeclaration.create(legal_user['Id'], nil)
       ubo = new_ubo(legal_user, ubo_declaration)
       ubo['FirstName'] = 'Santa'
       ubo['LastName'] = 'Clause'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mangopay
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Geoffroy Lorieux
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json