mangopay 3.22.0 → 3.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d92bb15f455816281326eca83963d639590bcb68580848ff6c4589cee926a0a9
-  data.tar.gz: 4162a17a66cfa34730c0ed90d27fecb375654d3e4175a82431863ec64e25e57c
+  metadata.gz: 7321bd891306f53afcbd49ecb871a872f7899d2ee039688392b076ee64c45142
+  data.tar.gz: c93e03ce101e31b67def7784e6a1d9490ca4cf5d4254f312f6cda02d32f528ec
 SHA512:
-  metadata.gz: 53796ff9758362b4d5e6cf5cf848b14e55928876e15ea78cd4f7105f1731a62344851d786b9103dd4ac1f58976dcfbd8b8b3aac0f16fdec424ccc669c60ffdec
-  data.tar.gz: 0a17dc77df68459acc86123ba7bd48806fe02fb8c07a5485aeaa8bef323a9998bd77d37e4ed241136774e20eb26054ed2db464fa3f7a678de7f3ea431a63a07e
+  metadata.gz: 889df791bf8d890fedbaca69373b91f7f14bb332b9bd2bda09524bfe8d5438c04c0189aea216627c097ccfb1453c1b8f5f4fcb53f6c90d328c04b143e47b75bb
+  data.tar.gz: 91c75bf32947a0eb9023d309164a5e416fb80744ca9516da1843b51dff4fdf01b7136c3c3489a3d50aecfa868c735c7f65330eebfe8f1e9ee37cbbaf79ad98de

data/.github/workflows/ruby_ci.yml

@@ -5,10 +5,6 @@ on:
     branches:
       # push on master branch
       - master
-      # push on a feature branch
-      - feature/*
-      # push on a bugfix branch
-      - bugfix/*
   pull_request:
     branches: [ master ]
 

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [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
 

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/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/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,6 +54,7 @@ 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
@@ -68,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
@@ -83,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
@@ -91,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
@@ -105,6 +111,7 @@ module MangoPay
       # 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
@@ -112,6 +119,14 @@ module MangoPay
         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
@@ -120,6 +135,7 @@ module MangoPay
 
       class Web < Resource
         include HTTPCalls::Create
+
         def self.url(*)
           "#{MangoPay.api_path}/payins/payconiq/#{CGI.escape(class_name.downcase)}"
         end

data/lib/mangopay/version.rb

@@ -1,3 +1,3 @@
 module MangoPay
-  VERSION = '3.22.0'
+  VERSION = '3.24.0'
 end

data/lib/mangopay.rb

@@ -44,7 +44,7 @@ module MangoPay
   autoload :Ubo, 'mangopay/ubo'
   autoload :Regulatory, 'mangopay/regulatory'
   autoload :Deposit, 'mangopay/deposit'
-  autoload :InstantConversion, 'mangopay/instant_conversion'
+  autoload :Conversion, 'mangopay/conversion'
   autoload :PaymentMethodMetadata, 'mangopay/payment_method_metadata'
 
   # temporary
@@ -57,7 +57,7 @@ module MangoPay
                   :client_id, :client_apiKey,
                   :temp_dir, :log_file, :http_timeout,
                   :http_max_retries, :http_open_timeout,
-                  :logger, :use_ssl
+                  :logger, :use_ssl, :uk_header_flag
 
     def apply_configuration
       MangoPay.configure do |config|
@@ -70,6 +70,7 @@ module MangoPay
         config.http_open_timeout = @http_open_timeout
         config.use_ssl = @use_ssl
         config.logger = @logger
+        config.uk_header_flag = @uk_header_flag
       end
     end
 
@@ -100,6 +101,10 @@ module MangoPay
 
       true
     end
+
+    def uk_header_flag
+      @uk_header_flag || false
+    end
   end
 
   class << self
@@ -193,6 +198,10 @@ module MangoPay
         headers['Idempotency-Key'] = headers_or_idempotency_key if headers_or_idempotency_key != nil
       end
 
+      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|

data/spec/mangopay/conversion_spec.rb

@@ -0,0 +1,64 @@
+describe MangoPay::Conversion, type: :feature do
+  include_context 'instant_conversion'
+
+  describe 'GET CONVERSION RATE' do
+    it 'get a conversion rate' do
+      conversion_rate = get_conversion_rate('EUR','GBP')
+
+      expect(conversion_rate['ClientRate']).not_to be_nil
+      expect(conversion_rate['MarketRate']).not_to be_nil
+    end
+  end
+
+  describe 'CREATE INSTANT CONVERSION' do
+    it 'creates a new instant conversion' do
+      conversion = create_instant_conversion
+
+      expect(conversion['DebitedFunds']['Amount']).not_to be_nil
+      expect(conversion['CreditedFunds']['Amount']).not_to be_nil
+      expect(conversion['Fees']['Amount']).not_to be_nil
+      expect(conversion['Status']).equal? 'SUCCEEDED'
+    end
+  end
+
+  describe 'CREATE QUOTED CONVERSION' do
+    it 'creates a new quoted conversion' do
+      conversion = create_quoted_conversion
+
+      expect(conversion['DebitedFunds']['Amount']).not_to be_nil
+      expect(conversion['CreditedFunds']['Amount']).not_to be_nil
+      expect(conversion['Status']).equal? 'SUCCEEDED'
+    end
+  end
+
+  describe 'GET EXISTING CONVERSION' do
+    it 'get an existing conversion' do
+      conversion = create_instant_conversion
+      returned_conversion = get_conversion(conversion['Id'])
+
+      expect(returned_conversion['DebitedFunds']['Amount']).not_to be_nil
+      expect(returned_conversion['CreditedFunds']['Amount']).not_to be_nil
+      expect(conversion['Fees']['Amount']).not_to be_nil
+      expect(returned_conversion['Status']).equal? 'SUCCEEDED'
+    end
+  end
+
+  describe 'CREATE CONVERSION QUOTE' do
+    it 'create a conversion quote' do
+      conversion_quote = create_conversion_quote
+      expect(conversion_quote['DebitedFunds']).not_to be_nil
+      expect(conversion_quote['CreditedFunds']).not_to be_nil
+      expect(conversion_quote['Duration']).equal? 90
+    end
+  end
+
+  describe 'GET CONVERSION QUOTE' do
+    it 'get a conversion quote' do
+      conversion_quote = create_conversion_quote
+      returned_conversion_quote = get_conversion_quote(conversion_quote['Id'])
+      expect(returned_conversion_quote['DebitedFunds']).not_to be_nil
+      expect(returned_conversion_quote['CreditedFunds']).not_to be_nil
+      expect(returned_conversion_quote['Duration']).equal? 90
+    end
+  end
+end

data/spec/mangopay/shared_resources.rb

@@ -898,7 +898,7 @@ shared_context 'instant_conversion' do
   include_context 'payins'
 
   def get_conversion_rate(debited_currency, credited_currency)
-    MangoPay::InstantConversion.get_rate(debited_currency, credited_currency, params = {})
+    MangoPay::Conversion.get_rate(debited_currency, credited_currency, params = {})
   end
 
   def create_instant_conversion()
@@ -910,7 +910,7 @@ shared_context 'instant_conversion' do
       Tag: 'Test wallet'
     )
 
-    MangoPay::InstantConversion.create(
+    MangoPay::Conversion.create_instant_conversion(
       AuthorId: user['Id'],
       CreditedWalletId: credited_wallet['Id'],
       DebitedWalletId: new_wallet_with_money['Id'],
@@ -921,12 +921,48 @@ shared_context 'instant_conversion' do
         Currency: 'EUR',
         Amount: 79
       },
+      Fees: {
+        Currency: 'EUR',
+        Amount: 9
+      },
       Tag: 'Instant conversion test'
     )
   end
 
-  def get_instant_conversion(id)
-    MangoPay::InstantConversion.get(id, params = {})
+  def create_quoted_conversion()
+    user = new_natural_user
+    credited_wallet = MangoPay::Wallet.create(
+      Owners: [user['Id']],
+      Description: 'A test wallet',
+      Currency: 'GBP',
+      Tag: 'Test wallet'
+    )
+    quote = create_conversion_quote
+
+    MangoPay::Conversion.create_quoted_conversion(
+      AuthorId: user['Id'],
+      QuoteId: quote['Id'],
+      CreditedWalletId: credited_wallet['Id'],
+      DebitedWalletId: new_wallet_with_money['Id'],
+      Tag: 'Quoted conversion test'
+    )
+  end
+
+  def create_conversion_quote
+    MangoPay::Conversion.create_quote(
+      CreditedFunds:  { Currency: 'GBP' },
+      DebitedFunds:  { Currency: 'EUR', Amount: 50 },
+      Duration: 90,
+      Tag: 'Created using the Mangopay Ruby SDK'
+    )
+  end
+
+  def get_conversion(id)
+    MangoPay::Conversion.get(id, params = {})
+  end
+
+  def get_conversion_quote(id)
+    MangoPay::Conversion.get_quote(id, params = {})
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mangopay
 version: !ruby/object:Gem::Version
-  version: 3.22.0
+  version: 3.24.0
 platform: ruby
 authors:
 - Geoffroy Lorieux
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -82,6 +82,7 @@ files:
 - lib/mangopay/card.rb
 - lib/mangopay/card_registration.rb
 - lib/mangopay/client.rb
+- lib/mangopay/conversion.rb
 - lib/mangopay/deposit.rb
 - lib/mangopay/dispute.rb
 - lib/mangopay/errors.rb
@@ -89,7 +90,6 @@ files:
 - lib/mangopay/filter_parameters.rb
 - lib/mangopay/hook.rb
 - lib/mangopay/http_calls.rb
-- lib/mangopay/instant_conversion.rb
 - lib/mangopay/json.rb
 - lib/mangopay/kyc_document.rb
 - lib/mangopay/legal_user.rb
@@ -118,6 +118,7 @@ files:
 - spec/mangopay/client_spec.png
 - spec/mangopay/client_spec.rb
 - spec/mangopay/configuration_spec.rb
+- spec/mangopay/conversion_spec.rb
 - spec/mangopay/deposit_spec.rb
 - spec/mangopay/dispute_spec.png
 - spec/mangopay/dispute_spec.rb
@@ -125,7 +126,6 @@ files:
 - spec/mangopay/fetch_filters_spec.rb
 - spec/mangopay/hook_spec.rb
 - spec/mangopay/idempotency_spec.rb
-- spec/mangopay/instant_conversion_spec.rb
 - spec/mangopay/kyc_document_spec.png
 - spec/mangopay/kyc_document_spec.rb
 - spec/mangopay/log_requests_filter_spec.rb
@@ -196,6 +196,7 @@ test_files:
 - spec/mangopay/client_spec.png
 - spec/mangopay/client_spec.rb
 - spec/mangopay/configuration_spec.rb
+- spec/mangopay/conversion_spec.rb
 - spec/mangopay/deposit_spec.rb
 - spec/mangopay/dispute_spec.png
 - spec/mangopay/dispute_spec.rb
@@ -203,7 +204,6 @@ test_files:
 - spec/mangopay/fetch_filters_spec.rb
 - spec/mangopay/hook_spec.rb
 - spec/mangopay/idempotency_spec.rb
-- spec/mangopay/instant_conversion_spec.rb
 - spec/mangopay/kyc_document_spec.png
 - spec/mangopay/kyc_document_spec.rb
 - spec/mangopay/log_requests_filter_spec.rb

data/lib/mangopay/instant_conversion.rb

@@ -1,24 +0,0 @@
-module MangoPay
-
-  class InstantConversion < Resource
-    include HTTPCalls::Fetch
-    include HTTPCalls::Update
-
-    class << self
-      def get_rate(debited_currency, credited_currency, params)
-        url = "#{MangoPay.api_path}/conversion/rate/#{debited_currency}/#{credited_currency}"
-        MangoPay.request(:get, url, params)
-      end
-
-      def create(params)
-        url = "#{MangoPay.api_path}/instant-conversion"
-        MangoPay.request(:post, url, params)
-      end
-
-      def get(id, params)
-        url = "#{MangoPay.api_path}/instant-conversion/#{id}"
-        MangoPay.request(:get, url, params)
-      end
-    end
-  end
-end

data/spec/mangopay/instant_conversion_spec.rb

@@ -1,33 +0,0 @@
-describe MangoPay::InstantConversion, type: :feature do
-  include_context 'instant_conversion'
-
-  describe 'GET CONVERSION RATE' do
-    it 'get a conversion rate' do
-      conversion_rate = get_conversion_rate('EUR','GBP')
-
-      expect(conversion_rate['ClientRate']).not_to be_nil
-      expect(conversion_rate['MarketRate']).not_to be_nil
-    end
-  end
-
-  describe 'CREATE CONVERSION' do
-    it 'creates a new conversion' do
-      conversion = create_instant_conversion
-
-      expect(conversion['DebitedFunds']['Amount']).not_to be_nil
-      expect(conversion['CreditedFunds']['Amount']).not_to be_nil
-      expect(conversion['Status']).equal? 'SUCCEEDED'
-    end
-  end
-
-  describe 'GET EXISTING CONVERSION' do
-    it 'get an existing conversion' do
-      conversion = create_instant_conversion
-      returned_conversion = get_instant_conversion(conversion['Id'])
-
-      expect(returned_conversion['DebitedFunds']['Amount']).not_to be_nil
-      expect(returned_conversion['CreditedFunds']['Amount']).not_to be_nil
-      expect(returned_conversion['Status']).equal? 'SUCCEEDED'
-    end
-  end
-end