mangopay 3.11.1 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b1c4ab5a218b4ccd0da9317cb444381509768780a2ff99d27b920ae48edbbec
-  data.tar.gz: 3c5af9a55982270cd08a57a02603f243c0c205f512a8560536ee5a370f0a6951
+  metadata.gz: 913f73df1d1821cd5a933ee4a5c0bc7c776f1eeb512588b7488aa110706bf0b6
+  data.tar.gz: bda53a132d7e5b3a44739277405a9f79200dcb6bdab4e120ede7f6cae0e71a04
 SHA512:
-  metadata.gz: 515d50e9a5dcfcaab5fc81cf63609e80351ae955efaec23e7549c32ff345184e4af24ecf50367d482cfda1cd2e93d513271ebda859bee48379cf89ef5fa3769d
-  data.tar.gz: f6a6dace6284cbac4b6bb27a23092196fcfd8f325fccf850c3dfd47431fbedf280d1e2cd77cac1b3c65642b4992cd2ecfd906a0bfc533942274bf00e4c1bc81e
+  metadata.gz: d29406640c31ef0d20e5c060582cb5860946ce8ff4b0f249412e7edc368d355efbaf94cd595885afa863607264a9facfb6af3912e814743969e424ac559ebfe8
+  data.tar.gz: 7f31702439cff0df222e723c363e5b6c6f242fa582f82986f5a26809db63291eb17f46c2a2a476ecf15a9caadbd9c807766b5f8707b41abb58658cffd571f878

data/.github/workflows/ruby_ci.yml

@@ -21,11 +21,11 @@ jobs:
       packages: write
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Ruby 2.6
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.6.x
+          ruby-version: 2.6.10
       - name: Install Rspec
         run: |
           gem install bundler

data/CHANGELOG.md

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

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/pay_in.rb

@@ -55,6 +55,10 @@ module MangoPay
         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

data/lib/mangopay/version.rb

@@ -1,3 +1,3 @@
 module MangoPay
-  VERSION = '3.11.1'
+  VERSION = '3.12.0'
 end

data/lib/mangopay.rb

@@ -43,6 +43,7 @@ module MangoPay
   autoload :UboDeclaration, 'mangopay/ubo_declaration'
   autoload :Ubo, 'mangopay/ubo'
   autoload :Regulatory, 'mangopay/regulatory'
+  autoload :Deposit, 'mangopay/deposit'
 
   # temporary
   autoload :Temp, 'mangopay/temp'

data/spec/mangopay/deposit_spec.rb

@@ -0,0 +1,76 @@
+describe MangoPay::Deposit do
+  include_context 'users'
+  include_context 'payins'
+
+  describe 'CREATE' do
+    it 'creates a new deposit' do
+      author = new_natural_user
+      card_registration = new_card_registration_completed_for_deposit
+      deposit = create_new_deposit(card_registration['CardId'], author['Id'])
+
+      assert_deposit(deposit, card_registration['CardId'], author["Id"])
+    end
+  end
+
+  describe 'GET' do
+    it 'get an existing deposit' do
+      author = new_natural_user
+      card_registration = new_card_registration_completed_for_deposit
+      deposit = create_new_deposit(card_registration['CardId'], author['Id'])
+
+      assert_deposit(deposit, card_registration['CardId'], author["Id"])
+
+      fetched_deposit = MangoPay::Deposit.get(deposit['Id'])
+
+      assert_deposit(fetched_deposit, card_registration['CardId'], author["Id"])
+    end
+  end
+
+# the Cancel flow will be teste manually for now
+=begin
+  describe 'CANCEL' do
+    it 'cancel an existing deposit' do
+      author = new_natural_user
+      card_registration = new_card_registration_completed
+      deposit = create_new_deposit(card_registration['CardId'], author['Id'])
+
+      assert_deposit(deposit, card_registration['CardId'], author["Id"])
+      expect(deposit['Status']).to eq('CREATED')
+      expect(deposit['PaymentStatus']).to eq('WAITING')
+
+      MangoPay::Deposit.cancel(deposit['Id'])
+
+      updated_deposit = MangoPay::Deposit.get(deposit['Id'])
+
+      assert_deposit(updated_deposit, card_registration['CardId'], author["Id"])
+      expect(updated_deposit['Status']).to eq('SUCCEEDED')
+      expect(updated_deposit['PaymentStatus']).to eq('CANCELED')
+    end
+  end
+=end
+end
+
+
+def assert_deposit(deposit, card_reg_id, author_id)
+  expect(deposit['Id']).not_to be_nil
+  expect(deposit['CreationDate']).not_to be_nil
+  expect(deposit['ExpirationDate']).not_to be_nil
+  expect(deposit['AuthorId']).not_to be_nil
+  expect(deposit['DebitedFunds']).not_to be_nil
+  expect(deposit['Status']).not_to be_nil
+  expect(deposit['PaymentStatus']).not_to be_nil
+  expect(deposit['PayinsLinked']).not_to be_nil
+  expect(deposit['CardId']).not_to be_nil
+  expect(deposit['CardId']).to eq(card_reg_id)
+  expect(deposit['AuthorId']).to eq(author_id)
+  expect(deposit['SecureModeReturnURL']).not_to be_nil
+  expect(deposit['SecureModeRedirectURL']).not_to be_nil
+  expect(deposit['PaymentType']).not_to be_nil
+  expect(deposit['ExecutionType']).not_to be_nil
+  expect(deposit['StatementDescriptor']).not_to be_nil
+  expect(deposit['Culture']).not_to be_nil
+  expect(deposit['BrowserInfo']).not_to be_nil
+  expect(deposit['IpAddress']).not_to be_nil
+  expect(deposit['Billing']).not_to be_nil
+  expect(deposit['Shipping']).not_to be_nil
+end

data/spec/mangopay/payin_preauthorized_direct_spec.rb

@@ -1,7 +1,8 @@
 describe MangoPay::PayIn::PreAuthorized::Direct, type: :feature do
   include_context 'wallets'
   include_context 'payins'
-  
+  include_context 'users'
+
   def check_type_and_status(payin)
     expect(payin['Type']).to eq('PAYIN')
     expect(payin['Nature']).to eq('REGULAR')
@@ -67,4 +68,21 @@ describe MangoPay::PayIn::PreAuthorized::Direct, type: :feature do
     end
   end
 
+    # this flow is tested manually for the moment
+=begin
+  describe 'CREATE AND VIEW PRE AUTHORIZED DEPOSIT' do
+    it 'creates a card direct pre authorized deposit payin' do
+      wallet = new_wallet
+      author = new_natural_user
+      card_registration = new_card_registration_completed
+      deposit = create_new_deposit(card_registration['CardId'], author['Id'])
+
+      created = create_new_payin_pre_authorized_deposit_direct(deposit['Id'], author['Id'], wallet['Id'])
+
+      expect(created['Id']).not_to be_nil
+      check_type_and_status(created)
+      expect(created['DepositId']).to eq(deposit['Id'])
+    end
+  end
+=end
 end

data/spec/mangopay/shared_resources.rb

@@ -393,6 +393,28 @@ shared_context 'payins' do
                                       RegistrationData: cardreg['RegistrationData'])
   end
 
+  let(:new_card_registration_completed_for_deposit) do
+    # 1st step: create
+    cardreg = new_card_registration
+
+    # 2nd step: tokenize by payline (fills-in RegistrationData)
+    data = {
+        data: cardreg['PreregistrationData'],
+        accessKeyRef: cardreg['AccessKey'],
+        cardNumber: 4970105181818183,
+        cardExpirationDate: 1226,
+        cardCvx: 123}
+
+    res = Net::HTTP.post_form(URI(cardreg['CardRegistrationURL']), data)
+    raise Exception, [res, res.body] unless res.is_a?(Net::HTTPOK) && res.body.start_with?('data=')
+
+    cardreg['RegistrationData'] = res.body
+
+    # 3rd step: update (fills-in CardId) and return it
+    MangoPay::CardRegistration.update(cardreg['Id'],
+                                      RegistrationData: cardreg['RegistrationData'])
+  end
+
   let(:new_payin_card_direct) { create_new_payin_card_direct(new_wallet) }
 
   def create_new_payin_card_direct(to_wallet, amnt = 1000)
@@ -480,6 +502,21 @@ shared_context 'payins' do
     )
   end
 
+  ###############################################
+  # pre-authorized direct deposit
+  ###############################################
+
+  def create_new_payin_pre_authorized_deposit_direct(deposit_id, author_id, credited_wallet_id)
+    MangoPay::PayIn::PreAuthorized::Direct.create_pre_authorized_deposit_pay_in(
+        AuthorId: author_id,
+        CreditedWalletId: credited_wallet_id,
+        DebitedFunds: {Currency: 'EUR', Amount: 500},
+        Fees: {Currency: 'EUR', Amount: 0},
+        DepositId: deposit_id,
+        Tag: 'lorem ipsum'
+    )
+  end
+
   ###############################################
   # bankwire/direct
   ###############################################
@@ -578,3 +615,57 @@ shared_context 'bankigaliases' do
                                         }, new_wallet['Id'])
   end
 end
+
+
+###############################################
+# deposits
+###############################################
+
+def create_new_deposit(card_registration_id, author_id)
+  MangoPay::Deposit.create(
+      {
+          AuthorId: author_id,
+          DebitedFunds: {Currency: 'EUR', Amount: 1000},
+          CardId: card_registration_id,
+          SecureModeReturnURL: 'http://mangopay-sandbox-test.com',
+          StatementDescriptor: "lorem",
+          Culture: 'FR',
+          IpAddress: "2001:0620:0000:0000:0211:24FF:FE80:C12C",
+          BrowserInfo: {
+              AcceptHeader: "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
+              JavaEnabled: true,
+              Language: "FR-FR",
+              ColorDepth: 4,
+              ScreenHeight: 1800,
+              ScreenWidth: 400,
+              JavascriptEnabled: true,
+              TimeZoneOffset: "+60",
+              UserAgent: "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148"
+          },
+          Billing: {
+              Address: {
+                  AddressLine1: 'AddressLine1',
+                  AddressLine2: 'AddressLine2',
+                  City: 'City',
+                  Region: 'Region',
+                  PostalCode: 'PostalCode',
+                  Country: 'FR'
+              },
+              FirstName: 'Joe',
+              LastName: 'Blogs'
+          },
+          Shipping: {
+              Address: {
+                  AddressLine1: 'AddressLine1',
+                  AddressLine2: 'AddressLine2',
+                  City: 'City',
+                  Region: 'Region',
+                  PostalCode: 'PostalCode',
+                  Country: 'FR'
+              },
+              FirstName: 'Joe',
+              LastName: 'Blogs'
+          }
+      }
+  )
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mangopay
 version: !ruby/object:Gem::Version
-  version: 3.11.1
+  version: 3.12.0
 platform: ruby
 authors:
 - Geoffroy Lorieux
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2022-11-16 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/deposit.rb
 - lib/mangopay/dispute.rb
 - lib/mangopay/errors.rb
 - lib/mangopay/event.rb
@@ -115,6 +116,7 @@ files:
 - spec/mangopay/client_spec.png
 - spec/mangopay/client_spec.rb
 - spec/mangopay/configuration_spec.rb
+- spec/mangopay/deposit_spec.rb
 - spec/mangopay/dispute_spec.png
 - spec/mangopay/dispute_spec.rb
 - spec/mangopay/event_spec.rb
@@ -182,6 +184,7 @@ test_files:
 - spec/mangopay/client_spec.png
 - spec/mangopay/client_spec.rb
 - spec/mangopay/configuration_spec.rb
+- spec/mangopay/deposit_spec.rb
 - spec/mangopay/dispute_spec.png
 - spec/mangopay/dispute_spec.rb
 - spec/mangopay/event_spec.rb