mangopay 3.4.0 → 3.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3be9c170462d86c30e551361cb135196086b166a5b4da755002635e6dffa367
-  data.tar.gz: f6cba5c6f4a1f3eacaa4fed0ffb484dacbf71e3d8b8f6a8cc16deca7387188ec
+  metadata.gz: 8947a3cfb998752c602955c3d1eb8585e0e8ea9337c39eb141d5c40d90488c6b
+  data.tar.gz: 14067f5dfa5c2c5f31d269a6a0a82a27337efd2f06c4234758c5c8cf325a5a56
 SHA512:
-  metadata.gz: 50f20f836d5eb42c7122b2e5865d20dc6a566ad1433915eef235d9cc0dfef4d4cde39f949c050de0bfafa9510c8aa263d6091ebf7df126e77a222160db8250b2
-  data.tar.gz: 11a3cc3fb9ed24f8b791c331f2113bf35e388082f18f78063c3c2ded7c74d1d8cffe53016d0a4f4fc5ccb03f2a296b09fb73246801bf45b6a1011a065a78d2a0
+  metadata.gz: 0dfcd029183048dc8af4ec10953695d0c125b2d21091d3b0152917876247663e9c47ec31113b16986bce59627de25bf235882b3f71897fed1d37352c65560f9e
+  data.tar.gz: 445e13d574b812491959e370281f83289eae63d07849ce51bd7abb86d1521976105d31d35db0a405e4bdd48ff2795932fdcaa90302e86f672265f173c4e98e6e

data/.github/workflows/ruby_cd.yml

@@ -0,0 +1,34 @@
+name: mangopay2-net-ruby-cd
+
+on:
+  push:
+    # Sequence of patterns matched against refs/tags
+    tags:
+      # It pushes any tags that contain a v. ex: v1.16.1
+      - '*'
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby 2.6
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6.10
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.GEM_HOST_API_KEY}}"

data/.github/workflows/ruby_ci.yml

@@ -0,0 +1,30 @@
+name: mangopay2-net-ruby-ci
+
+on:
+  push:
+    branches:
+      # push on master branch
+      - master
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby 2.6
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6.10
+      - name: Install Rspec
+        run: |
+          gem install bundler -v 2.4.22
+          bundler install
+      - name: Test
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -1,3 +1,248 @@
+## [3.26.0] - 2024-08-07
+### Added
+
+- New endpoint: [Create a Bancontact PayIn](https://mangopay.com/docs/endpoints/bancontact#create-bancontact-payin)
+
+## [3.25.1] - 2024-04-30
+### Fixed
+
+- Updated tests for [Look up metadata for a payment method](https://mangopay.com/docs/endpoints/payment-method-metadata#lookup-payment-method-metadata).
+
+## [3.25.0] - 2024-04-16
+### Added
+
+- Add trace header logging : Introduced the `log_trace_headers` boolean configuration key. Set it to true to enable logging of `x_mangopay_trace-id` and `IdempotencyKey` in the log of the http requests.
+
+## [3.24.1] - 2024-04-10
+### Fixed
+
+- #249 Improve error handling when logging is enabled
+- #226 MultiJson::ParseError is thrown on HTTP error 5XX
+
+## [3.24.0] - 2024-04-02
+### Added
+
+- New endpoint [Add tracking to Paypal payin](https://mangopay.com/docs/endpoints/paypal#add-tracking-paypal-payin)
+
+## [3.23.0] - 2024-03-08
+### Fixed
+
+- Conversions endpoint spelling
+
+### Added
+
+- The optional Fees parameter is now available on instant conversions, allowing platforms to charge users for FX services. More information [here](https://mangopay.com/docs/release-notes/millefeuille).
+- Platforms can now use a quote to secure the rate for a conversion between two currencies for a set amount of time. More information [here](https://mangopay.com/docs/release-notes/millefeuille).
+- Introduced the `uk_header_flag` boolean configuration key. Platforms partnered with Mangopay's UK entity should set this key to true for proper configuration.
+
+## [3.22.0] - 2024-02-08
+### Added
+
+- New endpoint to look up metadata from BIN or Google Pay token. More information [here](https://mangopay.com/docs/release-notes/kisale)
+
+## [3.21.0] - 2024-01-23
+### Added
+
+- The endpoint [View a card Validation](https://mangopay.com/docs/endpoints/card-validations#view-card-validation) is now available
+
+## [3.20.0] - 2023-11-15
+### Added
+
+Now, our SDK enables seamless integration with multiple clientIDs, offering enhanced flexibility and customization.
+
+You can effortlessly create multiple configuration objects tailored to your specific needs:
+
+```
+config = MangoPay::Configuration.new
+config.client_id = 'your-client-id'
+config.client_apiKey = 'your-api-key'
+config.preproduction = true
+```
+add them using :
+
+`MangoPay.add_config('config1', config)`
+
+and perform a call with them using :
+
+`MangoPay.get_config('config1').apply_configuration`
+
+The previous method configure() is still working.
+
+## [3.19.0] - 2023-11-02
+### Updated
+
+- Giropay and Ideal integrations with Mangopay have been improved.
+- Klarna param "MerchantOrderId" has been renamed to "Reference"
+
+## [3.18.0] - 2023-09-29
+### Added
+- Instantly convert funds between 2 wallets of different currencies owned by the same user with the new SPOT FX endpoints
+
+## [3.17.0] - 2023-09-20
+### Added
+
+- A new parameter for Paypal : ShippingPreference
+- Klarna is now available as a payment method with Mangopay. This payment method is in private beta. Please contact support if you have any questions.
+- #225 It's now possible to configure ssl_options. It's now possible to set to false in preproduction environment. Thanks to @mantaskujalis
+
+## [3.16.0] - 2023-09-04
+### Added
+
+- Card validation endpoint management (Private beta)
+- New MOPs added : Multibanco, Blik, Satispay (Private beta)
+
+### Fixed
+
+- Execution Type of MB Way and PayPal has been changed from Direct to Web
+
+## [3.15.0] - 2023-07-07
+### Added
+
+- Google Pay is now available as a payment method with Mangopay. This payment method is in private beta. Please contact support if you have any questions.
+- Paypal integration with Mangopay has been improved. This payment method is in private beta. Please contact support if you have any questions.
+
+### Fixed
+
+- `Phone` parameter instead of `PhoneNumber` for MBWay
+- Timeout should be in secondes instead of milliseconds in the configuration
+## [3.14.0] - 2023-06-21
+### Added
+
+- MB WAY is now available as a payment method with Mangopay. This payment method is in private beta. Please contact support if you have any questions.
+
+## [3.13.2] - 2023-05-18
+### Fixes
+
+- fixed GitHub Actions CD pipeline
+
+## [3.13.1] - 2023-05-18
+### Fixes
+
+- typo fixed in test context name (@batistadasilva)
+
+## [3.13.0] - 2023-05-17
+### Added
+
+- Possibility to configure HTTP `max_retries (http_max_retries)` (default value = 1) and `open_timeout (http_open_timeout)` (default value = 60 seconds)
+- Increased default `read_timeout` to 30 seconds
+
+
+## [3.12.0] - 2022-11-16
+### New 30-day preauthorization feature
+
+Preauthorizations can now hold funds for up to 30 days, therefore ensuring the solvency of a registered card for the same amount of time.
+
+- The **Deposit** service has been added with methods for creating, fetching and canceling a deposit
+- The **create_pre_authorized_deposit_pay_in** method has been added to the PayIn service
+
+Thanks to 30-day preauthorizations, MANGOPAY can provide a simpler and more flexible payment experience for a wide range of use cases, especially for rentals.
+
+## [3.11.1] - 2022-10-18
+### Fixed
+
+Tests has been fixed due to API evolution.
+
+## [3.11.0] - 2022-09-08
+##Added
+**New country authorizations endpoints**
+
+Country authorizations can now be viewed by using one of the following endpoints:
+
+<a href="https://docs.mangopay.com/endpoints/v2.01/regulatory#e1061_the-country-authorizations-object">View a country's authorizations</a> <br>
+<a href="https://docs.mangopay.com/endpoints/v2.01/regulatory#e1061_the-country-authorizations-object">View all countries' authorizations</a>
+
+With these calls, it is possible to check which countries have:
+
+- Blocked user creation
+- Blocked bank account creation
+- Blocked payout creation
+
+Please refer to the <a href="https://docs.mangopay.com/guide/restrictions-by-country">Restrictions by country</a>
+article for more information.
+
+## [3.10.0] - 2022-06-29
+##Added
+**Recurring: €0 deadlines for CIT**
+
+Setting free recurring payment deadlines is now possible for CIT (customer-initiated transactions) with the **FreeCycles** parameter.
+
+The **FreeCycles** parameter allows platforms to define the number of consecutive deadlines that will be free. The following endpoints have been updated to take into account this new parameter:
+
+<a href="https://docs.mangopay.com/endpoints/v2.01/payins#e1051_create-a-recurring-payin-registration">Create a Recurring PayIn Registration</a><br>
+<a href="https://docs.mangopay.com/endpoints/v2.01/payins#e1056_view-a-recurring-payin-registration">View a Recurring PayIn Registration</a><br>
+
+This feature provides new automation capabilities for platforms with offers such as “Get the first month free” or “free trial” subscriptions.
+
+Please refer to the <a href="https://docs.mangopay.com/guide/recurring-payments-introduction">Recurring payments overview</a> documentation for more information.
+
+## [3.9.0] - 2022.03.31
+### Added
+
+#### Instant payment eligibility check
+
+With the function
+`PayOut::InstantPayoutEligibility::Reachability.create(params)`
+the destination bank reachability can now be verified prior to making an instant payout. This results in a better user experience, as this preliminary check will allow the platform to propose the instant payout option only to end users whose bank is eligible.
+
+## [3.8.0] - 2021.10.20
+## Added
+
+You can now change the status to "ENDED" for a recurring payment.
+
+## Fixed
+
+- "Status" is now available in the response when you request a recurring payment registration.
+
+
+## [3.7.0] - 2021.10.11
+## Added
+
+### Payconiq
+
+As requested by numerous clients, we are now providing [Payconiq](https://www.payconiq.be) as a new mean-of-payment. To request access, please contact MANGOPAY.
+
+### Flags for KYC documents
+
+**We provide more information regarding refused KYC documents.** Therefore it will be easier for you to adapt your app behavior and help your end user.
+
+You are now able to see the exact explanation thanks to a new parameter called “Flags”.
+
+It has been added to
+
+`$this->_api->KycDocuments->Get($kycDocument->Id);`
+
+It will display one or several error codes that provide the reason(s) why your document validation has failed. These error codes description are available [here](https://docs.mangopay.com/guide/kyc-document).
+
+## Fixed
+
+Idempotency key is not required anymore for UBO declarations
+
+## [3.6.0] - 2021.08.10
+## Added
+
+- You can now update and view a Recurring PayIn Registration object. To know more about this feature, please consult the documentation [here](https://docs.mangopay.com/guide/recurring-payments-introduction).
+- To improve recurring payments, we have added new parameters for CIT : DebitedFunds & Fees. To know more about this feature, please consult the documentation [here](https://docs.mangopay.com/endpoints/v2.01/payins#e1053_create-a-recurring-payin-cit)
+
+## [3.5.0] - 2021.06.10
+## Added
+
+We have added a new feature **[recurring payments](https://docs.mangopay.com/guide/recurring-payments)** dedicated to clients needing to charge a card repeatedly, such as subscriptions or payments installments.
+
+You can start testing in sandbox, to help you define your workflow. This release provides the first elements of the full feature.
+
+- [Create a Recurring PayIn Registration object](https://docs.mangopay.com/endpoints/v2.01/payins#e1051_create-a-recurring-payin-registration), containing all the information to define the recurring payment
+- [Initiate your recurring payment flow](https://docs.mangopay.com/endpoints/v2.01/payins#e1053_create-a-recurring-payin-cit) with an authenticated transaction (CIT) using the Card Recurring PayIn endpoint
+- [Continue your recurring payment flow](https://docs.mangopay.com/endpoints/v2.01/payins#e1054_create-a-recurring-payin-mit) with an non-authenticated transaction (MIT) using the Card Recurring PayIn endpoint
+
+This feature is not yet available in production and you need to contact the Support team to request access.
+
+## Accepted PRs
+
+- Add support for refund creation
+- Allow to fetch UBO Declaration without User ID
+
+
+
 ## [3.4.0] - 2021.05.27
 ## Added
 
@@ -84,7 +329,7 @@ The parameter `Applied3DSVersion` shows you the version of the 3DS protocol used
 
 ## [3.1.0]
 - 3DS2 integration with Shipping and Billing objects, including FirstName and LastName fields
-The objects Billing and Shipping may be included on all calls to the following endpoints:
+  The objects Billing and Shipping may be included on all calls to the following endpoints:
   - /preauthorizations/card/direct
   - /payins/card/direct
   - /payins/card/web
@@ -105,7 +350,7 @@ The objects Billing and Shipping may be included on all calls to the following e
 ## [3.0.35] - 2020-08-24
 - Improvement to Net::ReadTimeout handling
 - "User-agent" format in the headers changed, aligned to other assets 👤
- 
+
 ## [3.0.34] - 2020-06-25
 ### Added
 - This SDK is now GooglePay-ready ! Feel free to ask our lovely support for more infos about its activation.
@@ -123,7 +368,7 @@ The objects Billing and Shipping may be included on all calls to the following e
 
 ## [3.0.33] - 2019-09-23
 ### Added
-- ApplePay `Payin` functions are now available. More info about activation to come in the following weeks...  
+- ApplePay `Payin` functions are now available. More info about activation to come in the following weeks...
 ### Changed
 - GET EMoney method now supports year and month parameters. More info on our [docs](https://docs.mangopay.com/endpoints/v2.01/user-emoney#e895_view-a-users-emoney)
 
@@ -137,4 +382,4 @@ The objects Billing and Shipping may be included on all calls to the following e
 - `APIKey` is now replacing `passphrase` property for credentials. You must update it by updating to 3.0.32 SDK version and upper ones.
 
 
- 
+ 

data/README.md

@@ -85,6 +85,25 @@ rescue MangoPay::ResponseError => ex
 end
 ```
 
+### Using multiple clientIDs
+You can effortlessly create multiple configuration objects tailored to your specific needs:
+
+```
+config = MangoPay::Configuration.new
+config.client_id = 'your-client-id'
+config.client_apiKey = 'your-api-key'
+config.preproduction = true
+```
+add them using :
+
+`MangoPay.add_config('config1', config)`
+
+and perform a call with them using :
+
+`MangoPay.get_config('config1').apply_configuration`
+
+The previous method configure() is still working.
+
 ### Accessing RateLimit Headers
 Along with each request, the rate limiting headers are automatically updated in MangoPay object:
 

data/lib/mangopay/authorization_token.rb

@@ -73,7 +73,7 @@ module MangoPay
       end
 
       def store(token)
-        File.open(file_path, File::RDWR|File::CREAT, 0644) do |f|
+        File.open(file_path, File::RDWR | File::CREAT, 0644) do |f|
           f.flock(File::LOCK_EX)
           f.truncate(0)
           f.rewind

data/lib/mangopay/bankingaliases_iban.rb

@@ -3,9 +3,9 @@ module MangoPay
   # See parent class MangoPay::BankingAliases
   class BankingAliasesIBAN < BankingAliases
 
-    def self.create(params, wallet_id)
+    def self.create(params, wallet_id, headers_or_idempotency_key = nil)
       url = "#{MangoPay.api_path}/wallets/#{wallet_id}/bankingaliases/iban"
-      MangoPay.request(:post, url, params, {})
+      MangoPay.request(:post, url, params, {}, headers_or_idempotency_key)
     end
 
     def self.url(id = nil)

data/lib/mangopay/card.rb

@@ -35,6 +35,16 @@ module MangoPay
       def get_pre_authorizations(card_id, filters = {})
         MangoPay.request(:get, "#{MangoPay.api_path}/cards/#{card_id}/preauthorizations")
       end
+
+      def validate(card_id, params)
+        url = "#{MangoPay.api_path}/cards/#{card_id}/validation"
+        MangoPay.request(:post, url, params)
+      end
+
+      def get_card_validation(card_id, validation_id)
+        url = "#{MangoPay.api_path}/cards/#{card_id}/validation/#{validation_id}"
+        MangoPay.request(:get, url)
+      end
     end
   end
 end

data/lib/mangopay/client.rb

@@ -72,11 +72,6 @@ module MangoPay
         MangoPay.request(:get, url() + "/wallets/#{funds_type}/#{currency_iso_code}/transactions", {}, filters)
       end
 
-      def validate(client_id, card_id)
-        url = "#{MangoPay.api_path}/cards/#{card_id}/validate"
-        MangoPay.request(:post, url)
-      end
-
       def create_bank_account(params)
         MangoPay.request(:post, url() + "/bankaccounts/iban", params)
       end

data/lib/mangopay/conversion.rb

@@ -0,0 +1,39 @@
+module MangoPay
+
+  class Conversion < Resource
+    include HTTPCalls::Fetch
+    include HTTPCalls::Update
+
+    class << self
+      def get_rate(debited_currency, credited_currency, params)
+        url = "#{MangoPay.api_path}/conversions/rate/#{debited_currency}/#{credited_currency}"
+        MangoPay.request(:get, url, params)
+      end
+
+      def create_instant_conversion(params)
+        url = "#{MangoPay.api_path}/conversions/instant-conversion"
+        MangoPay.request(:post, url, params)
+      end
+
+      def create_quoted_conversion(params)
+        url = "#{MangoPay.api_path}/conversions/quoted-conversion"
+        MangoPay.request(:post, url, params)
+      end
+
+      def get(id, params)
+        url = "#{MangoPay.api_path}/conversions/#{id}"
+        MangoPay.request(:get, url, params)
+      end
+
+      def create_quote(params)
+        url = "#{MangoPay.api_path}/conversions/quote"
+        MangoPay.request(:post, url, params)
+      end
+
+      def get_quote(id, params)
+        url = "#{MangoPay.api_path}/conversions/quote/#{id}"
+        MangoPay.request(:get, url, params)
+      end
+    end
+  end
+end

data/lib/mangopay/deposit.rb

@@ -0,0 +1,20 @@
+module MangoPay
+
+  # See http://docs.mangopay.com/api-references/payins/preauthorized-payin/
+  class Deposit < Resource
+    def self.create(params, idempotency_key = nil)
+      MangoPay.request(:post, "#{MangoPay.api_path}/deposit-preauthorizations/card/direct", params, {}, idempotency_key)
+    end
+
+    def self.get(deposit_id, filters = {})
+      MangoPay.request(:get, "#{MangoPay.api_path}/deposit-preauthorizations/#{deposit_id}", {}, filters)
+    end
+
+    def self.cancel(deposit_id)
+      params = {
+        PaymentStatus: 'CANCELED'
+      }
+      MangoPay.request(:put, "#{MangoPay.api_path}/deposit-preauthorizations/#{deposit_id}", params)
+    end
+  end
+end

data/lib/mangopay/dispute.rb

@@ -50,9 +50,9 @@ module MangoPay
       #####################################################
 
       # see https://docs.mangopay.com/api-references/disputes/repudiations/
-      def fetch_repudiation(repudiation_id)
+      def fetch_repudiation(repudiation_id, idempotency_key = nil)
         url = "#{MangoPay.api_path}/repudiations/#{repudiation_id}"
-        MangoPay.request(:get, url)
+        MangoPay.request(:get, url, {}, {}, idempotency_key)
       end
 
       # +params+: hash; see https://docs.mangopay.com/api-references/disputes/settlement-transfers/

data/lib/mangopay/errors.rb

@@ -48,7 +48,7 @@ module MangoPay
       super(message) if message
     end
 
-    def type;    @details['Type']; end
+    def type;    @details['Type'] || @details['type']; end
     def error;   @details['error']; end
     def errors;  @details['errors'] || error; end
 
@@ -56,7 +56,7 @@ module MangoPay
       if error
         msg = error
       else
-        msg = @details['Message']
+        msg = @details['Message'] || @details['message']
         msg += errors.sort.map {|k,v| " #{k}: #{v}"}.join if (errors && errors.is_a?(Hash))
         msg
       end

data/lib/mangopay/filter_parameters.rb

@@ -39,12 +39,17 @@ module MangoPay
       @@res_confidential_params ||= [
         'access_token', 'AccessKey', 'IBAN', 'CardRegistrationURL',
         'PreregistrationData', 'RedirectURL', 'RegistrationData',
-        'SecureModeRedirectUrl', 'OwnerName', 'OwnerAddress', 'BIC'
+        'SecureModeRedirectUrl', 'OwnerName', 'OwnerAddress', 'BIC',
+        'FirstName', 'LastName', 'Email', 'AddressLine1',
+        'AddressLine2',
       ].freeze
     end
 
     def self.req_confidential_params
-      @@req_confidential_params ||= ['File', 'IBAN', 'OwnerName', 'OwnerAddress', 'BIC'].freeze
+      @@req_confidential_params ||= [
+        'File', 'IBAN', 'OwnerName', 'OwnerAddress', 'BIC', 'FirstName',
+        'LastName', 'Email', 'AddressLine1', 'AddressLine2',
+      ].freeze
     end
 
   end