active_merchant-epsilon 0.5.1

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

@@ -0,0 +1,194 @@
+require 'active_support/core_ext/string'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class EpsilonGateway < EpsilonBaseGateway
+      module CreditType
+        SINGLE      = 10
+        INSTALLMENT = 61
+        REVOLVING   = 80
+      end
+
+      PATHS = {
+        purchase:                'direct_card_payment.cgi',
+        registered_recurring:    'direct_card_payment.cgi',
+        registered_purchase:     'direct_card_payment.cgi',
+        cancel_recurring:        'receive_order3.cgi',
+        terminate_recurring:     'receive_order3.cgi',
+        void:                    'cancel_payment.cgi',
+        find_user:               'get_user_info.cgi',
+        change_recurring_amount: 'change_amount_payment.cgi',
+      }.freeze
+
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+
+      def purchase(amount, credit_card, detail = {})
+        detail[:mission_code] = EpsilonMissionCode::PURCHASE
+
+        params = billing_params(amount, credit_card, detail)
+
+        commit(PATHS[:purchase], params)
+      end
+
+      def registered_purchase(amount, detail = {})
+        params = {
+          contract_code: self.contract_code,
+          user_id:       detail[:user_id],
+          user_name:     detail[:user_name],
+          user_mail_add: detail[:user_email],
+          item_code:     detail[:item_code],
+          item_name:     detail[:item_name],
+          order_number:  detail[:order_number],
+          st_code:       '10000-0000-0000',
+          mission_code:  EpsilonMissionCode::PURCHASE,
+          item_price:    amount,
+          process_code:  2,
+          xml:           1,
+        }
+
+        commit(PATHS[:registered_purchase], params)
+      end
+
+      def recurring(amount, credit_card, detail = {})
+        detail[:mission_code] ||= EpsilonMissionCode::RECURRING_2
+
+        requires!(detail, [:mission_code, *EpsilonMissionCode::RECURRINGS])
+
+        params = billing_params(amount, credit_card, detail)
+
+        commit(PATHS[:purchase], params)
+      end
+
+      def registered_recurring(amount, detail = {})
+        params = {
+          contract_code: self.contract_code,
+          user_id:       detail[:user_id],
+          user_name:     detail[:user_name],
+          user_mail_add: detail[:user_email],
+          item_code:     detail[:item_code],
+          item_name:     detail[:item_name],
+          order_number:  detail[:order_number],
+          st_code:       '10000-0000-0000',
+          mission_code:  detail[:mission_code],
+          item_price:    amount,
+          process_code:  2,
+          xml:           1,
+        }
+
+        commit(PATHS[:registered_recurring], params)
+      end
+
+      def cancel_recurring(user_id:, item_code:)
+        params = {
+          contract_code: self.contract_code,
+          user_id:       user_id,
+          item_code:     item_code,
+          xml:           1,
+          process_code:  8,
+        }
+
+        commit(PATHS[:cancel_recurring], params)
+      end
+
+      def terminate_recurring(user_id:)
+        params = {
+          contract_code: self.contract_code,
+          user_id:       user_id,
+          xml:           1,
+          process_code:  9,
+        }
+
+        commit(PATHS[:terminate_recurring], params)
+      end
+
+      def find_user(user_id:)
+        params = {
+          contract_code: self.contract_code,
+          user_id:       user_id,
+        }
+
+        commit(PATHS[:find_user], params)
+      end
+
+      def change_recurring_amount(new_item_price:, user_id:, item_code:)
+        params = {
+          contract_code:  self.contract_code,
+          mission_code:   2,
+          user_id:        user_id,
+          item_code:      item_code,
+          new_item_price: new_item_price,
+        }
+        commit(PATHS[:change_recurring_amount], params)
+      end
+
+      #
+      # Second request for 3D secure
+      #
+      def authenticate(order_number:, three_d_secure_pa_res:)
+        params = {
+          contract_code:  self.contract_code,
+          order_number:   order_number,
+          tds_check_code: 2,
+          tds_pares:      three_d_secure_pa_res,
+        }
+
+        commit(PATHS[:purchase], params)
+      end
+
+      def void(order_number)
+        params = {
+          contract_code: self.contract_code,
+          order_number:  order_number,
+        }
+
+        commit(PATHS[:void], params)
+      end
+
+      def verify(credit_card, options = {})
+        o = options.dup
+        o[:order_number] ||= "#{Time.now.to_i}#{options[:user_id]}".first(32)
+        o[:item_code] = 'verifycreditcard'
+        o[:item_name] = 'verify credit card'
+
+        MultiResponse.run(:use_first_response) do |r|
+          r.process { purchase(1, credit_card, o) }
+          r.process(:ignore_result) { void(o[:order_number]) }
+        end
+      end
+
+      private
+
+      def billing_params(amount, payment_method, detail)
+        params = {
+          contract_code:  self.contract_code,
+          user_id:        detail[:user_id],
+          user_name:      detail[:user_name],
+          user_mail_add:  detail[:user_email],
+          item_code:      detail[:item_code],
+          item_name:      detail[:item_name],
+          order_number:   detail[:order_number],
+          st_code:        '10000-0000-0000',
+          mission_code:   detail[:mission_code],
+          item_price:     amount,
+          process_code:   1,
+          card_number:    payment_method.number,
+          expire_y:       payment_method.year,
+          expire_m:       payment_method.month,
+          card_st_code:   detail[:credit_type],
+          pay_time:       detail[:payment_time],
+          tds_check_code: detail[:three_d_secure_check_code],
+          user_agent:     "#{ActiveMerchant::Epsilon}-#{ActiveMerchant::Epsilon::VERSION}",
+        }
+
+        if payment_method.class.requires_verification_value?
+          params.merge!(
+            security_code:  payment_method.verification_value,
+            security_check: 1, # use security code
+          )
+        end
+
+        params
+      end
+    end
+  end
+end

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

@@ -0,0 +1,132 @@
+require 'nokogiri'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc
+
+    #
+    # This is the base gateway for concrete payment gateway for Epsilon
+    #
+    # === Create a new EpsilonGatway
+    #
+    # class EpsilonSampleGateway < EpsilonBaseGateway
+    #   def purchase(amount, payment_method, detail = {})
+    #     request_params = {
+    #       contract_code: self.contract_code,
+    #       user_id:       detail[:user_id],
+    #       item_code:     detail[:item_code],
+    #       order_number:  detail[:order_number],
+    #       item_price:    amount,
+    #     }
+    #
+    #     request_path = 'purchase'
+    #
+    #     commit(request_path, request_paramsparams)
+    #   end
+    # end
+    #
+
+    class EpsilonBaseGateway < Gateway
+
+      self.abstract_class = true
+
+      module ResponseXpath
+        RESULT                       = '//Epsilon_result/result[@result]/@result'
+        TRANSACTION_CODE             = '//Epsilon_result/result[@trans_code]/@trans_code'
+        ERROR_CODE                   = '//Epsilon_result/result[@err_code]/@err_code'
+        ERROR_DETAIL                 = '//Epsilon_result/result[@err_detail]/@err_detail'
+        CARD_NUMBER_MASK             = '//Epsilon_result/result[@card_number_mask]/@card_number_mask'
+        CARD_BRAND                   = '//Epsilon_result/result[@card_brand]/@card_brand'
+        ACS_URL                      = '//Epsilon_result/result[@acsurl]/@acsurl' # ACS (Access Control Server)
+        PA_REQ                       = '//Epsilon_result/result[@pareq]/@pareq' # PAReq (payer authentication request)
+        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'
+      end
+
+      module ResultCode
+        FAILURE        = '0'
+        SUCCESS        = '1'
+        THREE_D_SECURE = '5'
+        SYSTEM_ERROR   = '9'
+      end
+
+      cattr_accessor :contract_code, :proxy_address, :proxy_port
+
+      self.test_url            = 'https://beta.epsilon.jp/cgi-bin/order/'
+      self.live_url            = 'https://secure.epsilon.jp/cgi-bin/order/'
+      self.supported_countries = ['JP']
+      self.default_currency    = 'JPY'
+      self.homepage_url        = 'http://www.example.net/'
+      self.display_name        = 'New Gateway'
+
+      private
+
+      def authorization_from(response)
+        {}
+      end
+
+      def commit(path, params)
+        url          = (test? ? test_url : live_url)
+        raw_response = ssl_post(File.join(url, path), post_data(params))
+        response     = parse(raw_response)
+
+        options = {
+          authorization: authorization_from(response),
+          test:          test?
+        }
+
+        Response.new(success_from(response), message_from(response), response, options)
+      end
+
+      def message_from(response)
+        response[:message]
+      end
+
+      def parse(body)
+        # because of following error
+        #   Nokogiri::XML::SyntaxError: Unsupported encoding x-sjis-cp932
+        xml = Nokogiri::XML(body.sub('x-sjis-cp932', 'UTF-8'))
+
+        result                       = xml.xpath(ResponseXpath::RESULT).to_s
+        transaction_code             = xml.xpath(ResponseXpath::TRANSACTION_CODE).to_s
+        error_code                   = xml.xpath(ResponseXpath::ERROR_CODE).to_s
+        error_detail                 = uri_decode(xml.xpath(ResponseXpath::ERROR_DETAIL).to_s)
+        card_number_mask             = uri_decode(xml.xpath(ResponseXpath::CARD_NUMBER_MASK).to_s)
+        card_brand                   = uri_decode(xml.xpath(ResponseXpath::CARD_BRAND).to_s)
+        acs_url                      = uri_decode(xml.xpath(ResponseXpath::ACS_URL).to_s)
+        pa_req                       = uri_decode(xml.xpath(ResponseXpath::PA_REQ).to_s)
+        receipt_number               = xml.xpath(ResponseXpath::RECEIPT_NUMBER).to_s
+        receipt_date                 = uri_decode(xml.xpath(ResponseXpath::RECEIPT_DATE).to_s)
+        convenience_store_limit_date = uri_decode(xml.xpath(ResponseXpath::CONVENIENCE_STORE_LIMIT_DATE).to_s)
+
+        {
+          success:                      [ResultCode::SUCCESS, ResultCode::THREE_D_SECURE].include?(result),
+          message:                      "#{error_code}: #{error_detail}",
+          transaction_code:             transaction_code,
+          error_code:                   error_code,
+          error_detail:                 error_detail,
+          card_number_mask:             card_number_mask,
+          card_brand:                   card_brand,
+          three_d_secure:               result == ResultCode::THREE_D_SECURE,
+          acs_url:                      acs_url,
+          pa_req:                       pa_req,
+          receipt_number:               receipt_number,
+          receipt_date:                 receipt_date,
+          convenience_store_limit_date: convenience_store_limit_date,
+        }
+      end
+
+      def post_data(parameters = {})
+        parameters.map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')
+      end
+
+      def success_from(response)
+        response[:success]
+      end
+
+      def uri_decode(string)
+        URI.decode(string).encode(Encoding::UTF_8, Encoding::CP932)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module EpsilonMissionCode
+      # クレジット1回、またはクレジット決済以外の場合
+      PURCHASE = 1
+
+      # | CODE | 登録月 | 解除月 | 同月内での登録解除 |
+      # | 2    | 全額   | 無料   | 1ヶ月分            |
+      # | 3    | 全額   | 全額   | 1ヶ月分            |
+      # | 4    | 全額   | 日割   | 1ヶ月分            |
+      # | 5    | 無料   | 無料   | 無料               |
+      # | 6    | 無料   | 全角   | 1ヶ月分            |
+      # | 7    | 無料   | 日割   | 日割               |
+      # | 8    | 日割   | 無料   | 日割               |
+      # | 9    | 日割   | 全額   | 1ヶ月分            |
+      # | 10   | 日割   | 日割   | 日割               |
+      RECURRING_2  = 2
+      RECURRING_3  = 3
+      RECURRING_4  = 4
+      RECURRING_5  = 5
+      RECURRING_6  = 6
+      RECURRING_7  = 7
+      RECURRING_8  = 8
+      RECURRING_9  = 9
+      RECURRING_10 = 10
+
+      RECURRINGS = (2..10).to_a.freeze
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class EpsilonConvenienceStoreGateway < EpsilonBaseGateway
+      def purchase(amount, payment_method, detail = {})
+        params = {
+          contract_code:  self.contract_code,
+          user_id:        detail[:user_id],
+          user_name:      detail[:user_name],
+          user_mail_add:  detail[:user_email],
+          item_code:      detail[:item_code],
+          item_name:      detail[:item_name],
+          order_number:   detail[:order_number],
+          st_code:        '00100-0000-0000',
+          mission_code:   EpsilonMissionCode::PURCHASE,
+          item_price:     amount,
+          process_code:   1,
+          xml:            1,
+          conveni_code:   payment_method.code,
+          user_tel:       payment_method.phone_number,
+          user_name_kana: payment_method.name,
+        }
+
+        commit('receive_order3.cgi', params)
+      end
+    end
+  end
+end

data/lib/active_merchant/epsilon.rb

@@ -0,0 +1,9 @@
+require 'active_merchant'
+
+require_relative 'epsilon/version'
+
+require_relative 'billing/convenience_store'
+require_relative 'billing/gateways/epsilon/epsilon_mission_code'
+require_relative 'billing/gateways/epsilon/epsilon_base'
+require_relative 'billing/gateways/epsilon'
+require_relative 'billing/gateways/epslion_convenience_store'

data/lib/active_merchant/epsilon/version.rb

@@ -0,0 +1,5 @@
+module ActiveMerchant
+  module Epsilon
+    VERSION = "0.5.1"
+  end
+end

data/test/fixtures/vcr_cassettes/autheticate_three_d_secure_card_successful.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://beta.epsilon.jp/cgi-bin/order/direct_card_payment.cgi
+    body:
+      encoding: US-ASCII
+      string: contract_code=[CONTRACT_CODE]&order_number=O42938159&tds_check_code=2&tds_pares=xxxxxxxxxxxxxxxx
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+      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:
+      - Tue, 31 Mar 2015 03:58:45 GMT
+      Server:
+      - Apache
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - text/xml; charset=CP932
+    body:
+      encoding: UTF-8
+      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="521710" />
+        </Epsilon_result>
+    http_version:
+  recorded_at: Tue, 31 Mar 2015 03:58:43 GMT
+recorded_with: VCR 2.9.3