effective_orders 6.27.2 → 6.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acc426e93e1ea3adbe5196dbde6e2fba838633da8b7af235face31c2a49a006f
-  data.tar.gz: 706cab97c78e46022a093625aca51d4cd6f4c742e0d56b05f4dd9fdf9e61f3ce
+  metadata.gz: 5d9af403d4a78ea5498469fb7c45b0dddad5ff8f72b6e752c059d473442e332d
+  data.tar.gz: 79cfedddb1851a9bb4c7c6b798dbc8cd14ad5a0e77aebe3ce5954d4b8ace116c
 SHA512:
-  metadata.gz: fc4c197abee2f8735da26394903951a9f09e4296c462bb7c806786c23760ec6eff9c60106c32d2e1ca484f4b5b5b6ca07d246cdb8d37286b79609b0f31775f1b
-  data.tar.gz: 527409a4eaabbbf8b5bf50fec7672cab51f0daa83fc6bbd68299701b1baf682aba589828e8e676fda351135cb3e5ec5829a6999d13662d0e2ff5525b3faa7383
+  metadata.gz: fddb18b9e210244dc6c009a4885f97610cf324a10cf9c154373e1bd95a13f61c995bbe262d9d0784fd17d32a3af7a8f237bac4950c599b2c3d6cbad2d168310f
+  data.tar.gz: 4a262a7709a4df828f604bf5f4f02cb9825bcf3a27b1713ea3b0006cc56339be48a23ab87e262b36d2d8b7ae261eb7c8ac2478b3f8fbe6980c27ba2555eb1ef9

data/app/assets/javascripts/effective_orders/providers/helcim.js

@@ -20,14 +20,17 @@ function initializeHelcim() {
 
 function helcimPayIframeEvent(event) {
   if(event.data.eventName.startsWith('helcim-pay-js')) {
-    window.removeEventListener('message', helcimPayIframeEvent, false);
 
     if(event.data.eventStatus == 'HIDE') {
+      window.removeEventListener('message', helcimPayIframeEvent, false);
+
       let button = $('.effective-helcim-checkout').find('#helcim-checkout-button').get(0);
       Rails.enableElement(button)
     }
 
     if(event.data.eventStatus == 'SUCCESS') {
+      window.removeEventListener('message', helcimPayIframeEvent, false);
+
       let payment = btoa(event.data.eventMessage);
   
       let $form = $('form[data-helcim-checkout]').first();

data/app/controllers/effective/providers/helcim.rb

@@ -22,8 +22,14 @@ module Effective
           return order_not_processed(declined_url: helcim_params[:declined_url])
         end
 
-        # Verify the payment
-        payment = api.verify_payment(@order, payment_payload)
+        # Get the trusted payment Hash from Helcim
+        payment = api.get_payment(@order, payment_payload)
+
+        # If fee_saver? we assign any surcharge to the order
+        api.assign_order_charges!(@order, payment)
+
+        # Verify the payment. This will raise a 500 error if the payment is not valid
+        api.verify_payment!(@order, payment)
 
         # If it's purchased
         purchased = api.purchased?(payment)

data/app/helpers/effective_orders_helper.rb

@@ -51,7 +51,7 @@ module EffectiveOrdersHelper
     when :free
       'Checkout Free'
     when :helcim
-      'Pay by Credit Card'
+      EffectiveOrders.fee_saver? ? 'Pay by Credit Card or ACH Payment' : 'Pay by Credit Card'
     when :mark_as_paid
       'Admin: Mark as Paid'
     when :moneris

data/app/models/effective/helcim_api.rb

@@ -49,7 +49,7 @@ module Effective
           brandColor: (brand_color || '815AF0')
         },
         invoiceRequest: {
-          invoiceNumber: '#' + order.to_param
+          invoiceNumber: '#' + order.transaction_id(short: true)
         },
         customerRequest: {
           contactName: order.billing_name,
@@ -110,6 +110,22 @@ module Effective
     end
 
     # Decode the base64 encoded JSON object that was given from the form into a Hash
+    # {"transactionId"=>"38142732",
+    # "dateCreated"=>"2025-08-15 10:10:32",
+    # "cardBatchId"=>"4656307",
+    # "status"=>"APPROVED",
+    # "type"=>"purchase",
+    # "amount"=>"10.97",
+    # "currency"=>"CAD",
+    # "avsResponse"=>"X",
+    # "cvvResponse"=>"",
+    # "approvalCode"=>"T5E3ST",
+    # "cardToken"=>"gv5J-lJAQNqVjZ_HkXyisQ",
+    # "cardNumber"=>"4242424242",
+    # "cardHolderName"=>"Test User",
+    # "customerCode"=>"CST1022",
+    # "invoiceNumber"=>"#30",
+    # "warning"=>""}
     def decode_payment_payload(payload)
       return if payload.blank?
 
@@ -127,11 +143,15 @@ module Effective
 
     def purchased?(payment)
       raise('expected a payment Hash') unless payment.kind_of?(Hash)
-      (payment['status'] == 'APPROVED' && payment['type'] == 'purchase')
+
+      return true if (payment['status'] == 'APPROVED' && payment['type'] == 'purchase') # CC
+      return true if (payment['bankToken'].present? && payment['type'] == 'WITHDRAWAL') # ACH
+
+      false
     end
 
     # Considers the insecure payment_payload, requests the real transaction from Helcim and verifies it vs the order
-    def verify_payment(order, payment_payload)
+    def get_payment(order, payment_payload)
       raise('expected a payment_payload Hash') unless payment_payload.kind_of?(Hash)
 
       transaction_id = payment_payload['transactionId']
@@ -145,8 +165,32 @@ module Effective
         raise('expected the payment and payment_payload to have the same transactionId')
       end
 
+      # Normalize the card info and scrub out the card number
+      payment = payment.merge(card_info(payment)).except('cardNumber')
+
+      payment
+    end
+
+    # Adds the order.surcharge if this is a fee saver order
+    def assign_order_charges!(order, payment)
+      raise('expected an order') unless order.kind_of?(Effective::Order)
+      raise('expected a payment Hash') unless payment.kind_of?(Hash)
+
+      return unless EffectiveOrders.fee_saver?
+
+      # Validate amounts if purchased
+      amount = payment['amount'].to_f
+      amountAuthorized = order.total_to_f
+
+      surcharge = ((amount - amountAuthorized) * 100.0).round(0)
+      raise('expected surcharge to be a positive number') if surcharge < 0
+
+      order.update!(surcharge: surcharge)
+    end
+
+    def verify_payment!(order, payment)
       # Validate order ids
-      if payment['invoiceNumber'].to_s != '#' + order.to_param
+      unless payment['invoiceNumber'].to_s.start_with?('#' + order.to_param)
         raise("expected card-transaction invoiceNumber to be the same as the order to_param")
       end
 
@@ -155,9 +199,6 @@ module Effective
         raise("expected card-transaction amount #{amount} to be the same as the amountAuthorized #{amountAuthorized} but it was not")
       end
 
-      # Normalize the card info and scrub out the card number
-      payment = payment.merge(card_info(payment)).except('cardNumber')
-
       payment
     end
 
@@ -167,6 +208,8 @@ module Effective
       last4 = payment['cardNumber'].to_s.last(4)
       card = payment['cardType'].to_s.downcase
 
+      card = 'ACH' if card.blank? && payment['bankToken'].present?
+
       active_card = "**** **** **** #{last4} #{card}" if last4.present?
 
       { 'active_card' => active_card, 'card' => card }.compact

data/app/models/effective/order.rb

@@ -205,6 +205,13 @@ module Effective
       validates :delayed_payment_total, presence: true
     end
 
+    # helcim fee saver and our own surcharge cannot co-exist
+    validate do
+      if EffectiveOrders.fee_saver? && EffectiveOrders.surcharge?
+        errors.add(:base, "cannot use fee saver and surcharge at the same time")
+      end
+    end
+
     validate do
       if EffectiveOrders.organization_enabled?
         errors.add(:base, "must have a User or #{EffectiveOrders.organization_class_name || 'Organization'}") if user_id.blank? && organization_id.blank?
@@ -214,6 +221,8 @@ module Effective
     end
 
     # Price validations
+    validates :surcharge, numericality: { greater_than_or_equal_to: 0, allow_blank: true }, unless: -> { refund? }
+
     validates :subtotal, presence: true
     validates :total, presence: true, if: -> { EffectiveOrders.minimum_charge.to_i > 0 }
 
@@ -337,7 +346,7 @@ module Effective
       removed.each { |order_item| order_item.mark_for_destruction }
 
       # Make sure to reset stored aggregates
-      assign_attributes(subtotal: nil, tax_rate: nil, tax: nil, amount_owing: nil, surcharge_percent: nil, surcharge: nil, total: nil)
+      assign_attributes(subtotal: nil, tax_rate: nil, tax: nil, amount_owing: nil, surcharge_percent: nil, surcharge: nil, surcharge_tax: nil, total: nil)
 
       removed.length == 1 ? removed.first : removed
     end
@@ -381,7 +390,7 @@ module Effective
       end.compact
 
       # Make sure to reset stored aggregates
-      assign_attributes(subtotal: nil, tax_rate: nil, tax: nil, amount_owing: nil, surcharge_percent: nil, surcharge: nil, total: nil)
+      assign_attributes(subtotal: nil, tax_rate: nil, tax: nil, amount_owing: nil, surcharge_percent: nil, surcharge: nil, surcharge_tax: nil, total: nil)
 
       retval = cart_items.map do |item|
         order_items.build(
@@ -455,8 +464,12 @@ module Effective
     end
 
     # For moneris and moneris_checkout. Just a unique value. Must be 50 characters or fewer or will raise moneris error.
-    def transaction_id
-      [to_param, billing_name.to_s.parameterize.first(20).presence, Time.zone.now.to_i, rand(1000..9999)].compact.join('-')
+    def transaction_id(short: false)
+      if short
+        [to_param, Time.zone.now.to_i].compact.join('-')
+      else
+        [to_param, billing_name.to_s.parameterize.first(20).presence, Time.zone.now.to_i, rand(1000..9999)].compact.join('-')
+      end
     end
 
     def billing_first_name
@@ -979,10 +992,10 @@ module Effective
     end
 
     def get_surcharge_percent
-      percent = EffectiveOrders.credit_card_surcharge_percent.to_f
-      return nil unless percent > 0.0
+      return nil unless EffectiveOrders.surcharge?
+      return nil if purchased_without_credit_card?
 
-      return 0.0 if purchased_without_credit_card?
+      percent = EffectiveOrders.credit_card_surcharge_percent.to_f
 
       if (percent > 10.0 || percent < 0.5)
         raise "expected EffectiveOrders.credit_card_surcharge to return a value between 10.0 (10%) and 0.5 (0.5%) or nil. Received #{percent}. Please return 2.5 for 2.5% surcharge."
@@ -992,21 +1005,25 @@ module Effective
     end
 
     def get_surcharge
-      return 0 unless surcharge_percent.present?
+      return nil unless EffectiveOrders.surcharge?
+      return nil unless surcharge_percent.present?
+
       ((subtotal + tax) * (surcharge_percent / 100.0)).round(0).to_i
     end
 
     def get_surcharge_tax
-      return 0 unless tax_rate.present?
-      (surcharge * (tax_rate / 100.0)).round(0).to_i
+      return nil unless EffectiveOrders.surcharge?
+      return nil unless tax_rate.present?
+
+      (surcharge.to_i * (tax_rate / 100.0)).round(0).to_i
     end
 
     def get_total
-      subtotal + tax + surcharge + surcharge_tax
+      subtotal + tax + surcharge.to_i + surcharge_tax.to_i
     end
 
     def get_total_with_surcharge
-      subtotal + tax + surcharge + surcharge_tax
+      subtotal + tax + surcharge.to_i + surcharge_tax.to_i
     end
 
     def get_total_without_surcharge
@@ -1025,6 +1042,7 @@ module Effective
         when 'm', 'mc', 'master', 'mastercard' then 'MasterCard'
         when 'a', 'ax', 'american', 'americanexpress' then 'American Express'
         when 'd', 'discover' then 'Discover'
+        when 'ach' then 'ACH Payment'
         else payment_card.to_s
       end
 
@@ -1119,10 +1137,15 @@ module Effective
     end
 
     def assign_order_charges
+      # We are assigning credit card surcharges ourselves
       # We only apply surcharge for credit card orders. But we have to display and calculate for non purchased orders
-      self.surcharge_percent = get_surcharge_percent()
-      self.surcharge = get_surcharge()
-      self.surcharge_tax = get_surcharge_tax()
+      if EffectiveOrders.surcharge?
+        raise('surcharge is not supported with fee saver') if EffectiveOrders.fee_saver?
+
+        self.surcharge_percent = get_surcharge_percent()
+        self.surcharge = get_surcharge()
+        self.surcharge_tax = get_surcharge_tax()
+      end
 
       # Subtotal + Tax + Surcharge + Surcharge Tax
       self.total = get_total()

data/app/views/effective/order_emails/_info.html.haml

@@ -32,7 +32,7 @@
 
   - elsif order.payment_provider == 'etransfer'
     %ul
-      %li Please submit your etransfer payment within 30 days of the invoice date.
+      %li Please submit your e-transfer payment within 30 days of the invoice date.
       %li You have until payment is received or until <strong>#{order.delayed_payment_date.strftime("%A, %B %e, %Y")}</strong>, whichever is first, to make changes and cancellations.
       %li A receipt will be sent after payment has been received.
 
@@ -65,7 +65,7 @@
       %li A receipt will be sent after payment has been received.
   - elsif order.payment_provider == 'etransfer'
     %ul
-      %li Please submit your etransfer within 30 days of the invoice date.
+      %li Please submit your e-transfer within 30 days of the invoice date.
       %li A receipt will be sent after payment has been received.
   - else
     - providers = EffectiveOrders.deferred_providers.to_sentence(last_word_connector: ', or', two_words_connector: ' or ')

data/app/views/effective/orders/_checkout_step2.html.haml

@@ -23,6 +23,11 @@
     = render partial: '/effective/orders/refund/form', locals: provider_locals
 
   - else
+    - if EffectiveOrders.fee_saver?
+      .alert.alert-info.mb-4
+        All credit card transations are subject to a surcharge.
+        To avoid this fee you can pay by #{['ACH', ('cheque' if EffectiveOrders.cheque?), ('e-transfer' if EffectiveOrders.etransfer?)].compact.to_sentence(last_word_connector: ' or ')}.
+
     - if EffectiveOrders.pretend?
       = render partial: '/effective/orders/pretend/form', locals: provider_locals
 

data/app/views/effective/orders/_order_items.html.haml

@@ -36,6 +36,7 @@
         -# Nothing to do. We can't display Tax, Total or Credit Card Surcharge (which is taxed) yet.
 
       - elsif order.tax_rate.present? && order.surcharge_percent.to_f > 0.0
+        - # We're adding the surcharge. EffectiveOrders.surcharge? mode
         %tr
           %th.tax{colspan: 2} #{EffectiveOrders.tax_label} (#{rate_to_percentage(order.tax_rate)})
           %td.price.tax-price= price_to_currency(order.tax)
@@ -56,7 +57,26 @@
           %th.total{colspan: 2} Total amount charged to credit card
           %td.price.total-price= price_to_currency(order.total)
 
+      - elsif order.tax_rate.present? && !(order.surcharge_percent.to_f > 0.0) && order.surcharge.to_i > 0
+        - # The surcharge is being added by the payment processor. EffectiveOrders.fee_saver? mode
+        %tr
+          %th.tax{colspan: 2} #{EffectiveOrders.tax_label} (#{rate_to_percentage(order.tax_rate)})
+          %td.price.tax-price= price_to_currency(order.tax)
+
+        %tr.single-line
+          %th.amount-owing{colspan: 2} Total
+          %td.price.amount-owing-price= price_to_currency(order.amount_owing)
+
+        %tr
+          %th.surcharge{colspan: 2} Credit card surcharge
+          %td.price.surcharge-price= price_to_currency(order.surcharge)
+
+        %tr.double-line
+          %th.total{colspan: 2} Credit card sale
+          %td.price.total-price= price_to_currency(order.total)
+
       - elsif order.tax_rate.present? && !(order.surcharge_percent.to_f > 0.0)
+        - # No surcharges
         %tr
           %th.tax{colspan: 2} #{EffectiveOrders.tax_label} (#{rate_to_percentage(order.tax_rate)})
           %td.price.tax-price= price_to_currency(order.tax)

data/app/views/effective/orders/_order_shipping.html.haml

@@ -11,7 +11,7 @@
         %td
           %div= order.billing_name
 
-          - if order.user.try(:membership).present?
+          - if order.user.try(:membership).try(:number).present?
             %div= "##{order.user.membership.number}"
 
           %div= mail_to(order.email)

data/app/views/effective/orders/helcim/_form.html.haml

@@ -17,6 +17,6 @@
         .alert.alert-info.mb-4
           This is the #{Rails.env.upcase} SERVER.
           %br
-          Use credit card number 4242 4242 4242 4242 with any future expiry and cvv 123
+          Use credit card number 4242 4242 4242 4242 with any future Expiry date and CVV 123
 
       = render('effective/orders/helcim/element')

data/lib/effective_orders/engine.rb

@@ -50,6 +50,5 @@ module EffectiveOrders
         end
       end
     end
-
   end
 end

data/lib/effective_orders/version.rb

@@ -1,3 +1,3 @@
 module EffectiveOrders
-  VERSION = '6.27.2'.freeze
+  VERSION = '6.28.0'.freeze
 end

data/lib/effective_orders.rb

@@ -243,6 +243,10 @@ module EffectiveOrders
     credit_card_surcharge_percent.to_f > 0.0
   end
 
+  def self.fee_saver?
+    helcim? && helcim[:fee_saver] == true
+  end
+
   def self.mailer_class
     mailer&.constantize || Effective::OrdersMailer
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_orders
 version: !ruby/object:Gem::Version
-  version: 6.27.2
+  version: 6.28.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-12 00:00:00.000000000 Z
+date: 2025-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails