active_merchant-epsilon 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c43c4d71a9719ec55be94aa1f66222eac8bead4b16db6a31611269aee844afcf
-  data.tar.gz: 6bb0b39a5598d3cb8718037df3fd00ff42a53cded61bc98529a4ad00aa9f4259
+  metadata.gz: 8fe0b19a8605e29e5c3a2a310e3b9684767a21fb2f93957342ffd41b9135657e
+  data.tar.gz: b8eb1a2b4d150c0696d26a52e58f5069a60542739bc6461d61f864ad20a470db
 SHA512:
-  metadata.gz: 164e39f8d0e343f0172e5371fc99d1c46d8d04346c8e0c135ac7478cbe507be36d6182913df016e510eb75073559ad9d59b042718f3c26fa5fb6a37c20e940f6
-  data.tar.gz: 1b5e435a9342d69b78e032d466fb3f930805912bb2c4ac24eb7e7d9ce2bcf652a5b15f050ab38ad3526929cda5cc00ac32d0f540828226d97a0ca69ab986f845
+  metadata.gz: 87d7533d96fd6591a2b4ffeb78c7cfe2de4ad987e41c58be72083672f346178be6fa593e3aad6a5f3b66b0dde708e883d6d82a8c864a05006589d33a2978b41c
+  data.tar.gz: '0782a6f4c48fcc0e905a7b72205d5511bea0ffa95ca285dceee5058d97ae0d63e25fc2e2b009910b800c398b2cb07451cb525f8d0ee1f58696228c487f2f4106'

data/.github/workflows/test.yml

@@ -1,6 +1,9 @@
 name: test
-on: push
-
+on:
+  push:
+    branches:
+      - master
+  pull_request:
 jobs:
   test-all:
     runs-on: ubuntu-latest

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+### 0.14.0
+
+- [Support 3D Secure 2.0 for credit card payments](https://github.com/pepabo/active_merchant-epsilon/pull/121)
+
 ### 0.13.0
 
 - [Add `last-update` to OrderResponse](https://github.com/pepabo/active_merchant-epsilon/pull/118)

data/README.md

@@ -159,6 +159,57 @@ purchase_detail = {
 # (snip)
 ```
 
+### CreditCard Payment with 3D secure 2.0(with token)
+
+```ruby
+# 3D secure 2.0 does not have a test environment for epsilon
+ActiveMerchant::Billing::Base.mode = :production
+
+amount = 1000
+purchase_detail = {
+  user_id:                   'YOUR_APP_USER_IDENTIFIER',
+  user_name:                 '山田 太郎',
+  user_email:                'yamada-taro@example.com',
+  item_code:                 'ITEM001',
+  item_name:                 'Greate Product',
+  order_number:              'UNIQUE ORDER NUMBER',
+  three_d_secure_check_code: 1,
+  token:                     'CREDIT CARD TOKEN'
+  tds_flag:                  21 # 21 or 22
+  # optional:
+  #   add params for risk-based certification(billAddrCity etc...)
+}
+
+response = gateway.purchase(amount, ActiveMerchant::Billing::CreditCard.new, purchase_detail)
+
+if response.success?
+  if response.params['three_d_secure']
+    puts response.params['tds2_url']
+    puts response.params['pa_req']
+  else
+    # NOT 3D SECURE
+    puts "Successfully charged #{amount} yen as credit card payment(not 3D secure)"
+  end
+else
+  raise StandardError, response.message
+end
+
+# (The card holder identifies himself on credit card's page and comes back here)
+
+# AND SECOND REQUEST
+
+response = gateway.authenticate(
+  order_number:         'ORDER NUMBER',
+  three_d_secure_pares: 'PAYMENT AUTHENTICATION RESPONSE',
+)
+
+if response.success?
+  puts 'Successfully charged as credit card payment(3D secure 2.0)'
+else
+  raise StandardError, response.message
+end
+```
+
 ### CreditCard Revolving Payment
 
 ```ruby

data/lib/active_merchant/billing/gateways/epsilon/epsilon_base.rb

@@ -48,6 +48,7 @@ module ActiveMerchant #:nodoc:
         :three_d_secure,
         :acs_url,
         :pa_req,
+        :tds2_url,
         :receipt_number,
         :receipt_date,
         :captured,

data/lib/active_merchant/billing/gateways/epsilon.rb

@@ -22,6 +22,20 @@ module ActiveMerchant #:nodoc:
         capture:                 'sales_payment.cgi',
       }.freeze
 
+      RISK_BASE_AUTH_PARAMS_KEYS = %i[
+        tds_flag billAddrCity billAddrCountry billAddrLine1 billAddrLine2 billAddrLine3
+        billAddrPostCode billAddrState shipAddrCity shipAddrCountry shipAddrLine1 shipAddrLine2
+        shipAddrLine3 shipAddrPostCode shipAddrState chAccAgeInd chAccChange
+        chAccChangeIndchAccDate chAccPwdChange chAccPwChangeInd nbPurchaseAccount paymentAccAge
+        paymentAccInd provisionAttemptsDay shipAddressUsage shipAddressUsageInd shipNameIndicator
+        suspiciousAccActivity txnActivityDay txnActivityYear threeDSReqAuthData threeDSReqAuthMethod
+        threeDSReqAuthTimestamp addrMatch cardholderName homePhone mobilePhone
+        workPhone challengeInd deliveryEmailAddress deliveryTimeframe giftCardAmount
+        giftCardCount preOrderDate preOrderPurchaseInd reorderItemsInd shipIndicator
+      ].freeze
+
+      THREE_D_SECURE_2_INDICATORS = [21, 22].freeze
+
       self.supported_cardtypes = [:visa, :master, :american_express, :discover]
 
       def purchase(amount, credit_card, detail = {})
@@ -29,6 +43,10 @@ module ActiveMerchant #:nodoc:
 
         params = billing_params(amount, credit_card, detail)
 
+        if three_d_secure_2?(detail)
+          params.merge!(detail.slice(*RISK_BASE_AUTH_PARAMS_KEYS).compact)
+        end
+
         commit(PATHS[:purchase], params)
       end
 
@@ -54,6 +72,10 @@ module ActiveMerchant #:nodoc:
         params[:memo2] = detail[:memo2] if detail.has_key?(:memo2)
         params[:kari_flag] = detail[:capture] ? 2 : 1 if detail.has_key?(:capture)
 
+        if three_d_secure_2?(detail)
+          params.merge!(detail.slice(*RISK_BASE_AUTH_PARAMS_KEYS).compact)
+        end
+
         commit(PATHS[:registered_purchase], params)
       end
 
@@ -239,6 +261,10 @@ module ActiveMerchant #:nodoc:
 
         params
       end
+
+      def three_d_secure_2?(detail)
+        THREE_D_SECURE_2_INDICATORS.include?(detail[:tds_flag])
+      end
     end
   end
 end

data/lib/active_merchant/billing/gateways/response_parser.rb

@@ -10,7 +10,7 @@ module ActiveMerchant #:nodoc:
         @result = @xml.xpath(ResponseXpath::RESULT).to_s
 
         response = {
-          success: [ResultCode::SUCCESS, ResultCode::THREE_D_SECURE].include?(@result) || !state.empty?,
+          success: [ResultCode::SUCCESS, ResultCode::THREE_D_SECURE_1, ResultCode::THREE_D_SECURE_2].include?(@result) || !state.empty?,
           message: "#{error_code}: #{error_detail}"
         }
 
@@ -48,7 +48,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def three_d_secure
-        @result == ResultCode::THREE_D_SECURE
+        [ResultCode::THREE_D_SECURE_1, ResultCode::THREE_D_SECURE_2].include?(@result)
       end
 
       def acs_url
@@ -59,6 +59,10 @@ module ActiveMerchant #:nodoc:
         uri_decode(@xml.xpath(ResponseXpath::PA_REQ).to_s)
       end
 
+      def tds2_url
+        uri_decode(@xml.xpath(ResponseXpath::TDS2_URL).to_s)
+      end
+
       def receipt_number
         @xml.xpath(ResponseXpath::RECEIPT_NUMBER).to_s
       end
@@ -145,6 +149,7 @@ module ActiveMerchant #:nodoc:
         CARD_EXPIRE                        = '//Epsilon_result/result[@card_expire]/@card_expire'
         ACS_URL                            = '//Epsilon_result/result[@acsurl]/@acsurl' # ACS (Access Control Server)
         PA_REQ                             = '//Epsilon_result/result[@pareq]/@pareq' # PAReq (payer authentication request)
+        TDS2_URL                           = '//Epsilon_result/result[@tds2_url]/@tds2_url'
         RECEIPT_NUMBER                     = '//Epsilon_result/result[@receipt_no][1]/@receipt_no'
         RECEIPT_DATE                       = '//Epsilon_result/result[@receipt_date][1]/@receipt_date'
         CONVENIENCE_STORE_LIMIT_DATE       = '//Epsilon_result/result[@conveni_limit][1]/@conveni_limit'
@@ -166,10 +171,11 @@ module ActiveMerchant #:nodoc:
       end
 
       module ResultCode
-        FAILURE        = '0'
-        SUCCESS        = '1'
-        THREE_D_SECURE = '5'
-        SYSTEM_ERROR   = '9'
+        FAILURE          = '0'
+        SUCCESS          = '1'
+        THREE_D_SECURE_1 = '5'
+        THREE_D_SECURE_2 = '6'
+        SYSTEM_ERROR     = '9'
       end
     end
   end

data/lib/active_merchant/epsilon/version.rb

@@ -1,5 +1,5 @@
 module ActiveMerchant
   module Epsilon
-    VERSION = "0.13.0"
+    VERSION = "0.14.0"
   end
 end

data/test/fixtures/vcr_cassettes/authenticate_with_three_d_secure_2_successful.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://secure.epsilon.jp/cgi-bin/order/direct_card_payment.cgi
+    body:
+      encoding: UTF-8
+      string: contract_code=[CONTRACT_CODE]&order_number=O30189731&tds_check_code=2&tds_pares=dummy+pa_res
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Connection:
+      - close
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 15 Sep 2022 08:09:38 GMT
+      Server:
+      - Apache
+      Vary:
+      - Accept-Encoding
+      Content-Length:
+      - '161'
+      Connection:
+      - close
+      Content-Type:
+      - text/xml; charset=CP932
+    body:
+      encoding: ASCII-8BIT
+      string: |-
+        <?xml version="1.0" encoding="x-sjis-cp932"?>
+        <Epsilon_result>
+          <result acsurl="" />
+          <result err_code="" />
+          <result err_detail="" />
+          <result kari_flag="0" />
+          <result pareq="" />
+          <result result="1" />
+          <result trans_code="257072796" />
+        </Epsilon_result>
+  recorded_at: Thu, 15 Sep 2022 08:09:38 GMT
+recorded_with: VCR 6.1.0

data/test/fixtures/vcr_cassettes/purchase_with_three_d_secure_2_successful.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://secure.epsilon.jp/cgi-bin/order/direct_card_payment.cgi
+    body:
+      encoding: UTF-8
+      string: contract_code=[CONTRACT_CODE]&user_id=124014051&user_name=YAMADA+TARO&user_mail_add=yamada-taro%40example.com&item_code=ITEM001&item_name=Greate+Product&order_number=O1663728963&st_code=10000-0000-0000&mission_code=1&item_price=1000&process_code=2&card_st_code=&pay_time=&xml=1&tds_flag=21
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Connection:
+      - close
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 21 Sep 2022 02:56:03 GMT
+      Server:
+      - Apache
+      Vary:
+      - Accept-Encoding
+      Content-Length:
+      - '234'
+      Connection:
+      - close
+      Content-Type:
+      - text/xml; charset=CP932
+    body:
+      encoding: ASCII-8BIT
+      string: |-
+        <?xml version="1.0" encoding="x-sjis-cp932"?>
+        <Epsilon_result>
+          <result acsurl="" />
+          <result err_code="" />
+          <result err_detail="" />
+          <result pareq="sOuxTX%252BZHCDBJKRdKkN2Iw53" />
+          <result result="6" />
+          <result tds2_url="https%3A%2F%2Fsecure.epsilon.jp%2Fcgi-bin%2Forder%2Ftds2.cgi" />
+          <result trans_code="257810878" />
+        </Epsilon_result>
+  recorded_at: Wed, 21 Sep 2022 02:56:04 GMT
+recorded_with: VCR 6.1.0

data/test/remote/gateways/remote_epsilon_test.rb

@@ -75,6 +75,34 @@ class RemoteEpsilonGatewayTest < MiniTest::Test
     end
   end
 
+  def test_purchase_with_three_d_secure_2_successful
+    # 3DS2.0はテスト環境がないので mode を :production にする
+    ActiveMerchant::Billing::Base.stub(:mode, :production) do
+      VCR.use_cassette(:purchase_with_three_d_secure_2_successful) do
+        response = gateway.purchase(
+          1000,
+          ActiveMerchant::Billing::CreditCard.new,
+          purchase_detail_for_three_d_secure_2
+        )
+
+        assert_equal true, response.success?
+        assert_equal true, response.params['three_d_secure']
+        assert_equal true, response.params['tds2_url'].present?
+        assert_equal true, response.params['pa_req'].present?
+        assert_empty response.params['acs_url']
+      end
+
+      VCR.use_cassette(:authenticate_with_three_d_secure_2_successful) do
+        response = gateway.authenticate(
+          order_number: purchase_detail_for_three_d_secure_2[:order_number],
+          three_d_secure_pa_res: 'dummy pa_res'
+        )
+
+        assert_equal true, response.success?
+      end
+    end
+  end
+
   def test_purchase_with_capture_true_successful
     VCR.use_cassette(:purchase_with_capture_true_successful) do
       response = gateway.purchase(1000, valid_credit_card, purchase_detail.merge(capture: true))
@@ -256,6 +284,30 @@ class RemoteEpsilonGatewayTest < MiniTest::Test
     end
   end
 
+  def test_registered_purchase_with_three_d_secure_2_successful
+    # 3DS2.0はテスト環境がないので mode を :production にする
+    ActiveMerchant::Billing::Base.stub(:mode, :production) do
+      VCR.use_cassette(:purchase_with_three_d_secure_2_successful) do
+        response = gateway.registered_purchase(1000, purchase_detail_for_registered_and_three_d_secure_2)
+
+        assert_equal true, response.success?
+        assert_equal true, response.params['three_d_secure']
+        assert_equal true, response.params['tds2_url'].present?
+        assert_equal true, response.params['pa_req'].present?
+        assert_empty response.params['acs_url']
+      end
+
+      VCR.use_cassette(:authenticate_with_three_d_secure_2_successful) do
+        response = gateway.authenticate(
+          order_number: purchase_detail_for_three_d_secure_2[:order_number],
+          three_d_secure_pa_res: 'dummy pa_res'
+        )
+
+        assert_equal true, response.success?
+      end
+    end
+  end
+
   def test_registered_purchase_fail
     VCR.use_cassette(:registered_purchase_fail) do
       invalid_purchase_detail = purchase_detail_for_registered

data/test/test_helper.rb

@@ -156,6 +156,33 @@ module SamplePaymentMethods
     }
   end
 
+  def purchase_detail_for_three_d_secure_2
+    now = Time.now
+    {
+      user_id:                   "U#{now.to_i}",
+      user_name:                 'YAMADA Taro',
+      user_email:                'yamada-taro@example.com',
+      item_code:                 'ITEM001',
+      item_name:                 'Greate Product',
+      order_number:              "O#{now.sec}#{now.usec}",
+      token:                     '03d4a2ce2f747c9223a4ead24888d0293ad26c06273e296f9faa0675f99a1ff7',
+      three_d_secure_check_code: 1,
+      tds_flag:                  21,
+    }
+  end
+
+  def purchase_detail_for_registered_and_three_d_secure_2
+    {
+      user_id:      '124014051',
+      user_email:   'yamada-taro@example.com',
+      user_name:    'YAMADA TARO',
+      item_code:    'ITEM001',
+      item_name:    'Greate Product',
+      order_number: "O#{Time.now.to_i}",
+      tds_flag:      21,
+    }
+  end
+
   def valid_three_d_secure_pa_res
     now = Time.now
     {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_merchant-epsilon
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Kenichi TAKAHASHI
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2022-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemerchant
@@ -178,6 +178,7 @@ files:
 - lib/active_merchant/billing/gateways/response_parser.rb
 - lib/active_merchant/epsilon.rb
 - lib/active_merchant/epsilon/version.rb
+- test/fixtures/vcr_cassettes/authenticate_with_three_d_secure_2_successful.yml
 - test/fixtures/vcr_cassettes/autheticate_three_d_secure_card_successful.yml
 - test/fixtures/vcr_cassettes/cancel_recurring_fail.yml
 - test/fixtures/vcr_cassettes/cancel_recurring_successful.yml
@@ -208,6 +209,7 @@ files:
 - test/fixtures/vcr_cassettes/purchase_successful.yml
 - test/fixtures/vcr_cassettes/purchase_with_capture_false_successful.yml
 - test/fixtures/vcr_cassettes/purchase_with_capture_true_successful.yml
+- test/fixtures/vcr_cassettes/purchase_with_three_d_secure_2_successful.yml
 - test/fixtures/vcr_cassettes/purchase_with_three_d_secure_card_successful.yml
 - test/fixtures/vcr_cassettes/purchase_with_verification_value.yml
 - test/fixtures/vcr_cassettes/recurring_fail.yml
@@ -239,7 +241,7 @@ homepage: http://github.com/pepabo/active_merchant-epsilon
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -254,11 +256,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Epsilon integration for ActiveMerchant.
 test_files:
+- test/fixtures/vcr_cassettes/authenticate_with_three_d_secure_2_successful.yml
 - test/fixtures/vcr_cassettes/autheticate_three_d_secure_card_successful.yml
 - test/fixtures/vcr_cassettes/cancel_recurring_fail.yml
 - test/fixtures/vcr_cassettes/cancel_recurring_successful.yml
@@ -289,6 +292,7 @@ test_files:
 - test/fixtures/vcr_cassettes/purchase_successful.yml
 - test/fixtures/vcr_cassettes/purchase_with_capture_false_successful.yml
 - test/fixtures/vcr_cassettes/purchase_with_capture_true_successful.yml
+- test/fixtures/vcr_cassettes/purchase_with_three_d_secure_2_successful.yml
 - test/fixtures/vcr_cassettes/purchase_with_three_d_secure_card_successful.yml
 - test/fixtures/vcr_cassettes/purchase_with_verification_value.yml
 - test/fixtures/vcr_cassettes/recurring_fail.yml