spree_vpago 0.1.0.pre.beta

data/db/migrate/20240718195510_create_spree_payout_profile_shipping_methods.rb

@@ -0,0 +1,15 @@
+class CreateSpreePayoutProfileShippingMethods < ActiveRecord::Migration[7.0]
+  def change
+    create_table :spree_payout_profile_shipping_methods, if_not_exists: true do |t|
+      t.references :payout_profile, foreign_key: { to_table: :spree_payout_profiles },
+                                    index: { name: 'index_payout_profile_shipping_methods_on_payout_profile_id' }
+
+      t.references :shipping_method, foreign_key: { to_table: :spree_shipping_methods },
+                                     index: { name: 'index_payout_profile_shipping_methods_on_shipping_method_id' }
+
+      t.boolean :optional, null: false, default: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20240718201453_add_handle_by_to_spree_adjustments.rb

@@ -0,0 +1,5 @@
+class AddHandleByToSpreeAdjustments < ActiveRecord::Migration[7.0]
+  def change
+    add_column :spree_adjustments, :handle_by, :integer, null: false, default: 0, if_not_exists: true
+  end
+end

data/db/migrate/20240718201509_add_run_by_to_spree_promotion_actions.rb

@@ -0,0 +1,5 @@
+class AddRunByToSpreePromotionActions < ActiveRecord::Migration[7.0]
+  def change
+    add_column :spree_promotion_actions, :run_by, :integer, null: false, default: 0, if_not_exists: true
+  end
+end

data/db/migrate/20240718201523_add_collect_by_to_spree_tax_categories.rb

@@ -0,0 +1,5 @@
+class AddCollectByToSpreeTaxCategories < ActiveRecord::Migration[7.0]
+  def change
+    add_column :spree_tax_categories, :collect_by, :integer, null: false, default: 0, if_not_exists: true
+  end
+end

data/db/migrate/20240718201538_add_handle_by_to_spree_shipping_method.rb

@@ -0,0 +1,5 @@
+class AddHandleByToSpreeShippingMethod < ActiveRecord::Migration[7.0]
+  def change
+    add_column :spree_shipping_methods, :handle_by, :integer, null: false, default: 0, if_not_exists: true
+  end
+end

data/db/migrate/20240718201554_add_handle_by_to_spree_shipping_rates.rb

@@ -0,0 +1,5 @@
+class AddHandleByToSpreeShippingRates < ActiveRecord::Migration[7.0]
+  def change
+    add_column :spree_shipping_rates, :handle_by, :integer, null: false, default: 0, if_not_exists: true
+  end
+end

data/db/migrate/20240808102853_add_vendor_reference_to_spree_payment_methods.rb

@@ -0,0 +1,7 @@
+class AddVendorReferenceToSpreePaymentMethods < ActiveRecord::Migration[7.0]
+  def change
+    add_reference :spree_payment_methods, :vendor,
+                  index: true, foreign_key: { to_table: :spree_vendors },
+                  if_not_exists: true
+  end
+end

data/db/migrate/20240904030132_add_gateway_status_to_spree_payments.rb

@@ -0,0 +1,5 @@
+class AddGatewayStatusToSpreePayments < ActiveRecord::Migration[7.0]
+  def change
+    add_column :spree_payments, :gateway_status, :boolean, default: false, if_not_exists: true
+  end
+end

data/db/migrate/20241029071959_add_pre_auth_response_to_spree_payment.rb

@@ -0,0 +1,5 @@
+class AddPreAuthResponseToSpreePayment < ActiveRecord::Migration[7.0]
+  def change
+    add_column :spree_payments, :pre_auth_response, :jsonb, default: {}, if_not_exists: true
+  end
+end

data/db/migrate/20241202104014_add_enable_pre_auth_to_spree_payment_method.rb

@@ -0,0 +1,5 @@
+class AddEnablePreAuthToSpreePaymentMethod < ActiveRecord::Migration[7.0]
+  def change
+    add_column :spree_payment_methods, :enable_pre_auth, :boolean, default: false, if_not_exists: true
+  end
+end

data/db/migrate/20250121044614_add_transaction_response_to_spree_payments.rb

@@ -0,0 +1,5 @@
+class AddTransactionResponseToSpreePayments < ActiveRecord::Migration[7.0]
+  def change
+    add_column :spree_payments, :transaction_response, :jsonb, default: {}, if_not_exists: true
+  end
+end

data/docs/acleda.md

@@ -0,0 +1,65 @@
+# ACLEDA
+
+From latest document of ACLEDA and [documents](https://drive.google.com/drive/folders/1BusMWt6ul8QbDb1R-2HBz-Gduc0zJk1D), there are 2 types of payments:
+- XPAY (xpay or card)
+- KHQR
+
+Both can be created via `Spree::Gateway::Acleda`. Following are instructions to create these payment methods in admin dashboard:
+
+## Getting Start
+To get start, request ACLEDA following:
+- Request credentials (provide them email). They will send us following credentials via email:
+  ```
+  Merchant ID: AoGxxxxxxxxxxxEVY=
+  Merchant name: BOOKMEBUS
+  Remote User: remoteuser
+  Remote password: Bxxxxxxxxxx3
+  ```
+  Also note that they are not usually provide the signature key. Signature is a required credential to create acleda session, so you need request them if they are't provided yet.
+
+- Request account/app to test:
+  - ACLEDA account, for test XPAY. eg. 00010221574410
+  - Cards like VISA, master, for XPAY card (pay with card)
+  - ACLEDA app & provide them your phone. For scan KHQR.
+
+## Setup Payment Methods
+To setup ACLEDA payment method:
+- Go to admin dashboard /admin/payment_methods/
+- Click on "New Payment Method" and fill details with following instructions & example:
+  - Product Name in ACLEDA view. eg. BookMe+
+  - Host: https://epaymentuat.acledabank.com.kh:8443
+  - Signature: `"Signature" provided by ACLEDA`
+  - Payment Expiry Time In Mn: 10
+  - Merchant Name: `"Merchant name" provided by ACLEDA`
+  - Password: `"Remote password" provided by ACLEDA`
+  - Login: `"Remote User" provided by ACLEDA`
+  - Merchant: `"Merchant ID" provided by ACLEDA`
+  - Success Url: `whitelisted-url`/webhook/acledas/success 
+    eg. https://example.com/webhook/acledas/success
+  - Error Url: `whitelisted-url`/webhook/acledas/error
+  - Other Url:`whitelisted-url`/webhook/acledas/return
+  - Icon Name: acleda
+
+Above are details for overall payment type of ACLEDA, to support it for specific type, insert following details:
+
+### 1. for XPAY
+- Payment Type: XPAY-MPGS
+- Payment Card: 0 - XPAY
+
+### 2. for XPAY (card)
+- Payment Type: XPAY-MPGS
+- Payment Card: 1 - Visa, Master Card, etc.
+
+### 3. for KHQR
+- Payment Type: KHQR
+- Payment Card: (this field is ignored for KHQR, can put anything)
+
+## Merchant Logo
+- To update merchant logo inside ACLEDA view, override following path:
+  [app/assets/images/vpago/payway/acleda_merchant_logo_300x300.png](../app/assets/images/vpago/payway/acleda_merchant_logo_300x300.png)
+
+## Expected Outcome
+
+| XPAY | XPAY (card) | KHQR |
+| - | - | - |
+| ![xpay](https://github.com/bookmebus/spree_vpago/assets/29684683/c8d7d022-7b1c-4d5c-91e9-d9fe53ea8cec) | ![xpay_card](https://github.com/bookmebus/spree_vpago/assets/29684683/48712fd7-8e3d-4116-b2f6-c3e2adbbe791) | ![khqr](https://github.com/bookmebus/spree_vpago/assets/29684683/5c1290aa-624c-4e36-a879-2e94961346fa) |

data/gemfiles/spree_3_7.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails-controller-testing"
+gem "spree", "~> 3.7.0"
+gem "sass-rails"
+
+gemspec path: "../"

data/gemfiles/spree_4_0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails-controller-testing"
+gem "spree", "~> 4.0.0"
+
+gemspec path: "../"

data/gemfiles/spree_4_1.gemfile

@@ -0,0 +1,9 @@
+
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails-controller-testing"
+gem "spree", "~> 4.1.0"
+
+gemspec path: "../"

data/gemfiles/spree_master.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails-controller-testing"
+gem "spree", github: "spree/spree", branch: "master"
+
+gemspec path: "../"

data/lib/generators/spree_vpago/install/install_generator.rb

@@ -0,0 +1,26 @@
+module SpreeVpago
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+      source_root File.expand_path('templates', __dir__)
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_multi_vendor'
+        run 'bundle exec rake railties:install:migrations FROM=spree_vpago'
+      end
+
+      def acleda_logo_template
+        template 'app/assets/images/vpago/payway/acleda_merchant_logo_300x300.png'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bundle exec rails db:migrate'
+        else
+          puts 'Skipping rails db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_vpago/engine.rb

@@ -0,0 +1,36 @@
+module SpreeVpago
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_vpago'
+
+    config.autoload_paths += %W[#{config.root}/lib]
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'spree_vpago.environment', before: :load_config_initializers do |_app|
+      Config = Configuration.new # rubocop:disable Lint/ConstantDefinitionInBlock
+    end
+
+    config.after_initialize do
+      Rails.application.config.spree.payment_methods.push(
+        Spree::Gateway::Payway,
+        Spree::Gateway::PaywayV2,
+        Spree::Gateway::WingSdk,
+        Spree::Gateway::Acleda,
+        Spree::Gateway::AcledaMobile
+      )
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/spree_vpago/factories.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_vpago/factories'
+end

data/lib/spree_vpago/version.rb

@@ -0,0 +1,9 @@
+module SpreeVpago
+  module_function
+
+  VERSION = '0.1.0-beta'.freeze
+
+  def version
+    Gem::Version.new VERSION
+  end
+end

data/lib/spree_vpago.rb

@@ -0,0 +1,5 @@
+require 'spree_core'
+require 'spree_multi_vendor'
+require 'spree_extension'
+require 'spree_vpago/engine'
+require 'spree_vpago/version'

data/lib/vpago/acleda/base.rb

@@ -0,0 +1,111 @@
+module Vpago
+  module Acleda
+    class Base
+      include Vpago::PaymentAmountCalculator
+
+      def initialize(payment, options = {})
+        @options = options
+        @payment = payment
+      end
+
+      def payment_number
+        @payment.number
+      end
+
+      def app_checkout
+        app_checkout? ? '1' : '0'
+      end
+
+      def app_checkout?
+        return false if @options[:app_checkout].blank?
+
+        @options[:app_checkout]
+      end
+
+      def host
+        @payment.payment_method.preferences[:host]
+      end
+
+      def success_url
+        preferred_success_url = @payment.payment_method.preferred_success_url
+        return nil if preferred_success_url.blank?
+
+        query_string = {
+          app_checkout:,
+          order_number:,
+          order_channel: @payment.order.channel
+        }.to_query
+
+        "#{preferred_success_url}?#{query_string}"
+      end
+
+      def error_url
+        preferred_error_url = @payment.payment_method.preferred_error_url
+        return nil if preferred_error_url.blank?
+
+        query_string = {
+          app_checkout:,
+          order_number:
+        }.to_query
+
+        "#{preferred_error_url}?#{query_string}"
+      end
+
+      def other_url
+        preferred_other_url = @payment.payment_method.preferred_other_url
+        return nil if preferred_other_url.blank?
+
+        query_string = {
+          app_checkout:,
+          order_number:
+        }.to_query
+
+        "#{preferred_other_url}?#{query_string}"
+      end
+
+      def acleda_company_name
+        @payment.payment_method.preferences[:acleda_company_name]
+      end
+
+      def acleda_payment_card
+        @payment.payment_method.preferences[:acleda_payment_card]
+      end
+
+      def login_id
+        @payment.payment_method.preferences[:login_id]
+      end
+
+      def password
+        @payment.payment_method.preferences[:password]
+      end
+
+      def merchant_id
+        @payment.payment_method.preferences[:merchant_id]
+      end
+
+      def merchant_name
+        @payment.payment_method.preferences[:merchant_name]
+      end
+
+      def signature
+        @payment.payment_method.preferences[:signature]
+      end
+
+      def expiry_time
+        @payment.payment_method.preferences[:payment_expiry_time_in_mn]
+      end
+
+      def purchase_date
+        @payment.created_at.strftime('%d-%m-%Y')
+      end
+
+      def order_number
+        @payment.order.number
+      end
+
+      def action_url
+        "#{host}/#{merchant_name}/paymentPage.jsp"
+      end
+    end
+  end
+end

data/lib/vpago/acleda/checkout.rb

@@ -0,0 +1,105 @@
+module Vpago
+  module Acleda
+    class Checkout < Base
+      attr_accessor :error_message
+
+      def initialize(payment, options = {})
+        super
+
+        @error_message = nil
+        start_connection
+        update_payment_source
+      end
+
+      def start_connection
+        @response = create_session
+
+        if @response.status != 500 && @response.status != 200
+          @error_message = 'Sever Error'
+        elsif @response.status == 500 ## mostly when passing wrong parameter name
+          @error_message = @response.body
+        elsif @response.status == 200 && json_response['result']['code'] != 0 ## mostly when passing invalid payload, wrong loginId, etc.
+          @error_message = json_response['result']['errorDetails']
+        end
+      end
+
+      def update_payment_source
+        return if failed?
+
+        @payment.source.update_column(:transaction_id, json_response['result']['xTran']['paymentTokenid'])
+      end
+
+      def json_response
+        @json_response ||= JSON.parse(@response.body)
+      end
+
+      def create_session
+        con = Faraday::Connection.new(url: host)
+
+        con.post(create_session_path) do |request|
+          request.headers['Content-Type'] = 'application/json'
+          request.body = create_session_request_body.to_json
+        end
+      end
+
+      def failed?
+        @error_message.present?
+      end
+
+      def create_session_request_body
+        request_body = {
+          loginId: login_id,
+          password:,
+          merchantID: merchant_id,
+          signature:,
+          xpayTransaction: {
+            txid: payment_number,
+            invoiceid: order_number,
+            purchaseAmount: amount_with_fee,
+            purchaseCurrency: 'USD',
+            purchaseDate: purchase_date,
+            purchaseDesc: 'items',
+            item: '1',
+            quantity: '1',
+            expiryTime: expiry_time,
+            otherUrl: other_url
+          }
+        }
+
+        if @payment.payment_method.xpay_mpgs?
+          request_body[:xpayTransaction][:paymentCard] = acleda_payment_card if acleda_payment_card.present?
+        elsif @payment.payment_method.khqr?
+          request_body[:xpayTransaction][:operationType] = '3'
+        end
+
+        request_body
+      end
+
+      def create_session_path
+        ENV.fetch('ACLEDA_CREATE_SESSION_PATH', nil)
+      end
+
+      def gateway_params
+        return {} if failed?
+
+        {
+          merchantID: merchant_id,
+          sessionid: json_response['result']['sessionid'],
+          paymenttokenid: json_response['result']['xTran']['paymentTokenid'],
+          description: 'items',
+          expirytime: expiry_time,
+          amount: amount_with_fee,
+          quantity: '1',
+          Item: '1',
+          invoiceid: order_number,
+          currencytype: 'USD',
+          transactionID: payment_number,
+          successUrlToReturn: success_url,
+          errorUrl: error_url,
+          companyName: acleda_company_name,
+          companyLogo: ActionController::Base.helpers.image_url('vpago/payway/acleda_merchant_logo_300x300.png')
+        }
+      end
+    end
+  end
+end

data/lib/vpago/acleda/deeplink_checkout.rb

@@ -0,0 +1,74 @@
+module Vpago
+  module Acleda
+    class DeeplinkCheckout < Base
+      attr_accessor :error_message, :results
+
+      def call
+        @results = {
+          play_store: acleda_play_store,
+          app_store: acleda_app_store,
+          acleda_ios_deeplink: acleda_ios_deeplink,
+          acleda_android_deeplink: acleda_android_deeplink
+        }
+      end
+
+      def acleda_app_store
+        'https://apps.apple.com/us/app/acleda-unity-toanchet/id1196285236'
+      end
+
+      def acleda_play_store
+        'market://details?id=com.domain.acledabankqr'
+      end
+
+      def acleda_ios_deeplink
+        "ACLEDAmobile://?partner_id=#{partner_id}&payment_data=#{aes_encrypted_payment_data}"
+      end
+
+      def acleda_android_deeplink
+        "market://com.domain.acledabankqr/app?partner_id=#{partner_id}&payment_data=#{aes_encrypted_payment_data}"
+      end
+
+      def hmac_encrypted_payment_data
+        json_data = payment_data.to_json
+        key = encryption_key
+
+        encrypted_result = Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), key, json_data))
+        encrypted_result.delete!("\n")
+        encrypted_result
+      end
+
+      def aes_encrypted_payment_data
+        data = "#{payment_data.to_json}~#{hmac_encrypted_payment_data}"
+        key = encryption_key
+        iv = [key].pack('H*') # #hex2bin
+        cipher = OpenSSL::Cipher.new('AES-256-CBC')
+        cipher.encrypt
+
+        cipher.key = pbkdf2_key
+        cipher.iv = iv
+
+        crypt = cipher.update(data) + cipher.final
+        encrypted_result = Base64.encode64(crypt).delete("\n")
+        encrypted_result.gsub('/', 'acledabankSecurityTC') # #follow acleda encrypting guide
+      end
+
+      def payment_data
+        {
+          app_name: 'VTENH',
+          payment_amount: amount_with_fee,
+          payment_amount_ccy: 'USD',
+          payment_purpose: 'VTENH Transaction',
+          txn_ref: payment_number
+        }
+      end
+
+      def pbkdf2_key
+        pass = encryption_key
+        salt = pass
+        iter = 100
+        key_len = 32
+        OpenSSL::KDF.pbkdf2_hmac(pass, salt:, iterations: iter, length: key_len, hash: 'sha1')
+      end
+    end
+  end
+end

data/lib/vpago/acleda/payment_request_updater.rb

@@ -0,0 +1,38 @@
+module Vpago
+  module Acleda
+    class PaymentRequestUpdater < ::Vpago::PaymentRequestUpdater
+      def call
+        return if @payment.order.paid?
+
+        checker = payment_status_checker
+
+        if checker.success?
+          @error_message = nil
+          checker_result = {
+            status: true,
+            description: nil,
+            acleda_response: checker.result
+          }
+          marker_options = @options.merge(checker_result)
+
+          marker = ::Vpago::PaymentStatusMarker.new(@payment, marker_options)
+          marker.call
+        elsif !ignore_on_failed?
+          @error_message = checker.error_message
+          marker_options = @options.merge(status: false, description: @error_message)
+
+          marker = ::Vpago::PaymentStatusMarker.new(@payment, marker_options)
+          marker.call
+        end
+      end
+
+      private
+
+      def payment_status_checker
+        trans_status = Vpago::Acleda::TransactionStatus.new(@payment)
+        trans_status.call
+        trans_status
+      end
+    end
+  end
+end