effective_orders 5.9.3 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c21ba05da7239366ba59d58f08bc997193192c6b9cb83c93caade90b61072bd
-  data.tar.gz: 965fe919c2c7a6537dd7b15427291cef1119c768ccd38cf1fdbcaf282b1fd95a
+  metadata.gz: f548373346f66befb20e325b166d275eff0444b9b8d2865f87c37d8116d32b0d
+  data.tar.gz: c2cdbd728306010ba79e3847fd59578e3b51afbf2764021b3581767bad0d6831
 SHA512:
-  metadata.gz: 344e2cdaa0de66f512335a2c9da024de369713f34c84480a1b813b59874343bc4fc2ac81579f35ce718153346eb9e53826f46e657a5def99a6ff266b0f0aa45e
-  data.tar.gz: 51f49f85b475d26fea9cfc593f627ed4e1c1761075d6fb508264419246485035995272e638da63cb5ed99635a9d7ff4b1aad0c1c34b8bc7c385e26eda737f069
+  metadata.gz: 027327c45635652ad18bf89f0597d3c22156adf9ba04a527014c5aae2daed01a92f50dd6d134cf7afc5a34b6ca02daae7b69e73fd801269bf22f75e07f61cc16
+  data.tar.gz: 54576594dab1cd9a569e7c37aab4cf945b8670628d92868a85a8d068a212a8f175cf31c0955fbb933fb618efde82cd9a0d090cb8a83446c876ea74b0a9b10c0a

data/app/assets/stylesheets/effective_orders/_order.scss

@@ -1,31 +1,37 @@
 .effective-order {
   table {
-    clear: both;
-    margin-bottom: 25px;
+    .quantity { width: 0%; }
 
-    tfoot {
-      > tr:first-child {
-        border-top: 20px solid transparent;
-      }
+    .price {
+      text-align: right;
+      padding-left: 2rem;
+    }
 
-      th {
+    tfoot {
+      th, td {
         border: none;
         text-align: right;
-        padding-right: 65px;
+        white-space: nowrap;
       }
 
-      td {
-        text-align: right;
+      // This is the first column
+      th { width: 100%; }
+
+      tr.single-line {
+        td { border-top: solid 1px; }
+      }
+
+      tr.double-line {
+        td { border-top: double 4px; }
       }
 
-      .actions { border: none; }
+      .amount-owing { font-style: italic; }
+      .total { font-style: italic; }
     }
   }
-
-  .price { text-align: right; }
 }
 
-// Print - Resend Receipt.  Ontop of order.
+// Print - Resend Receipt. Ontop of order.
 .effective-order-actions {
   text-align: right;
   margin-bottom: 0.5rem;

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

@@ -13,7 +13,7 @@ module Effective
 
         payment = validate_stripe_payment(stripe_params[:payment_intent_id])
 
-        if payment.blank? || !payment.kind_of?(Hash)
+        if payment.blank?
           return order_declined(payment: payment, provider: 'stripe', declined_url: stripe_params[:declined_url])
         end
 
@@ -37,36 +37,35 @@ module Effective
       end
 
       def validate_stripe_payment(payment_intent_id)
-        begin
-          intent = EffectiveOrders.with_stripe { ::Stripe::PaymentIntent.retrieve(payment_intent_id) }
-
-          raise('status is not succeeded') unless intent.status == 'succeeded'
-          raise('charges are not present') unless intent.charges.present?
-
-          charge = intent.charges.data.first
-          raise('charge not succeeded') unless charge.status == 'succeeded'
-
-          card = charge.payment_method_details.try(:card) || {}
-          active_card = "**** **** **** #{card['last4']} #{card['brand']} #{card['exp_month']}/#{card['exp_year']}" if card.present?
-
-          {
-            charge_id: charge.id,
-            payment_method_id: charge.payment_method,
-            payment_intent_id: intent.id,
-
-            active_card: active_card,
-            card: card['brand'],
-
-            amount: charge.amount,
-            created: charge.created,
-            currency: charge.currency,
-            customer: charge.customer,
-            status: charge.status
-          }.compact
-
-        rescue => e
-          e.message
-        end
+        intent = EffectiveOrders.with_stripe { ::Stripe::PaymentIntent.retrieve(payment_intent_id) }
+        raise('expected stripe intent to be present') if intent.blank?
+        return unless intent.status == 'succeeded'
+
+        # Stripe API version 2022-11-15 and 2022-08-01
+        charge_id = intent.try(:latest_charge) || (intent.charges.data.first.id rescue nil)
+        raise('expected stripe charge_id to be present') if charge_id.blank?
+
+        charge = EffectiveOrders.with_stripe { ::Stripe::Charge.retrieve(charge_id) }
+        raise('expected stripe charge to be present') if charge.blank?
+        return unless charge.status == 'succeeded'
+
+        card = charge.payment_method_details.try(:card) || {}
+        active_card = "**** **** **** #{card['last4']} #{card['brand']} #{card['exp_month']}/#{card['exp_year']}" if card.present?
+
+        {
+          charge_id: charge.id,
+          payment_method_id: charge.payment_method,
+          payment_intent_id: intent.id,
+
+          active_card: active_card,
+          card: card['brand'],
+
+          amount: charge.amount,
+          created: charge.created,
+          currency: charge.currency,
+          customer: charge.customer,
+          status: charge.status
+        }.compact
       end
 
     end

data/app/datatables/admin/effective_orders_datatable.rb

@@ -28,7 +28,7 @@ class Admin::EffectiveOrdersDatatable < Effective::Datatable
   end
 
   datatable do
-    order :id, :desc
+    order :updated_at
 
     bulk_actions_col
 
@@ -66,20 +66,19 @@ class Admin::EffectiveOrdersDatatable < Effective::Datatable
     end
 
     col :payment_method
-    col :payment_provider
+    col :payment_provider, label: 'Provider', visible: false, search: { collection: EffectiveOrders.admin_payment_providers }
+    col :payment_card, label: 'Card', visible: false
 
     col :subtotal, as: :price, visible: false
+
     col :tax, as: :price, visible: false
+    col(:tax_rate, visible: false) { |order| rate_to_percentage(order.tax_rate) }
 
-    col :tax_rate, visible: false do |order|
-      tax_rate_to_percentage(order.tax_rate)
-    end
+    col :surcharge, as: :price, visible: false
+    col(:surcharge_percent, visible: false) { |order| rate_to_percentage(order.surcharge_percent) }
 
     col :total, as: :price
 
-    col :payment_provider, label: 'Provider', visible: false, search: { collection: EffectiveOrders.admin_payment_providers }
-    col :payment_card, label: 'Card', visible: false
-
     if EffectiveOrders.collect_note
       col :note, visible: false
     end

data/app/datatables/effective_orders_datatable.rb

@@ -42,18 +42,20 @@ class EffectiveOrdersDatatable < Effective::Datatable
       collection.where(id: Effective::OrderItem.where('name ILIKE ?', "%#{term}%").select('order_id'))
     end
 
+    col :payment_method, visible: false
+    col :payment_provider, label: 'Provider', visible: false, search: { collection: EffectiveOrders.payment_providers }
+    col :payment_card, label: 'Card', visible: false
+
     col :subtotal, as: :price, visible: false
+
     col :tax, as: :price, visible: false
+    col(:tax_rate, visible: false) { |order| rate_to_percentage(order.tax_rate) }
 
-    col :tax_rate, visible: false do |order|
-      tax_rate_to_percentage(order.tax_rate)
-    end
+    col :surcharge, as: :price, visible: false
+    col(:surcharge_percent, visible: false) { |order| rate_to_percentage(order.surcharge_percent) }
 
     col :total, as: :price
 
-    col :payment_provider, label: 'Provider', visible: false, search: { collection: EffectiveOrders.payment_providers }
-    col :payment_card, label: 'Card', visible: false
-
     if EffectiveOrders.collect_note
       col :note
     end

data/app/helpers/effective_carts_helper.rb

@@ -103,11 +103,12 @@ module EffectiveCartsHelper
 
   def render_cart(cart = nil)
     cart ||= current_cart
-    render(partial: 'effective/carts/cart', locals: { cart: cart })
+    render('effective/carts/cart', cart: cart)
   end
 
   def render_purchasables(*purchasables)
-    render(partial: 'effective/orders/order_items', locals: { order: Effective::Order.new(purchasables) })
+    order = Effective::Order.new(purchasables)
+    render('effective/orders/purchasables', order: order)
   end
 
 end

data/app/helpers/effective_moneris_checkout_helper.rb

@@ -10,9 +10,8 @@ module EffectiveMonerisCheckoutHelper
       api_token: EffectiveOrders.moneris_checkout.fetch(:api_token),
       store_id: EffectiveOrders.moneris_checkout.fetch(:store_id),
       checkout_id: EffectiveOrders.moneris_checkout.fetch(:checkout_id),
-
       action: :preload,
-      txn_total: price_to_currency(order.total).gsub(',', '').gsub('$', ''),
+      txn_total: ('%.2f' % (order.total_with_surcharge / 100.0)),
 
       # Optional
       order_no: order.transaction_id, # Has to be unique. This is order number, billing name and Time.now

data/app/helpers/effective_orders_helper.rb

@@ -5,6 +5,12 @@ module EffectiveOrdersHelper
     number_to_currency(price / 100.0)
   end
 
+  def rate_to_percentage(rate)
+    rate = rate || 0.0
+    number_to_percentage(rate, strip_insignificant_zeros: true)
+  end
+
+  # Deprecated.
   def tax_rate_to_percentage(tax_rate, options = {})
     options[:strip_insignificant_zeros] = true if options[:strip_insignificant_zeros].nil?
     number_to_percentage(tax_rate, strip_insignificant_zeros: true)
@@ -119,4 +125,21 @@ module EffectiveOrdersHelper
     icon_to('shopping-cart', path, { title: 'Checkout' }.merge(options))
   end
 
+  def admin_mark_as_paid_payment_providers
+    providers = EffectiveOrders.admin_payment_providers
+
+    percentage = EffectiveOrders.credit_card_surcharge_percent.to_f
+    return providers unless percentage > 0.0
+
+    surcharge_providers = EffectiveOrders.credit_card_payment_providers
+
+    with_surcharge = providers.select { |provider| surcharge_providers.include?(provider) }
+    without_surcharge = providers.reject { |provider| surcharge_providers.include?(provider) }
+
+    {
+      "With #{rate_to_percentage(percentage)} credit card surcharge": with_surcharge.map { |provider| [provider, provider] },
+      'Without credit card surcharge': without_surcharge.map { |provider| [provider, provider] }
+    }
+  end
+
 end

data/app/helpers/effective_paypal_helper.rb

@@ -31,16 +31,31 @@ module EffectivePaypalHelper
       cert_id: EffectiveOrders.paypal[:cert_id],
       currency_code: EffectiveOrders.paypal[:currency],
       invoice: order.id,
-      amount: (order.subtotal / 100.0).round(2),
-      tax_cart: (order.tax / 100.0).round(2)
+      amount: '%.2f' % (order.amount_owing / 100.0),
+      tax_cart: '%.2f' % ((order.tax + order.surcharge_tax) / 100.0)
     }
 
-    order.order_items.each_with_index do |item, x|
-      values["item_number_#{x+1}"] = x+1
-      values["item_name_#{x+1}"] = item.name
-      values["quantity_#{x+1}"] = item.quantity
-      values["amount_#{x+1}"] = '%.2f' % (item.price / 100.0)
-      values["tax_#{x+1}"] = '%.2f' % ((item.tax / 100.0) / item.quantity)  # Tax for 1 of these items
+    number = 0
+
+    order.order_items.each do |item|
+      number += 1
+
+      values["item_number_#{number}"] = number
+      values["item_name_#{number}"] = item.name
+      values["quantity_#{number}"] = item.quantity
+      values["amount_#{number}"] = '%.2f' % (item.price / 100.0)
+      values["tax_#{number}"] = '%.2f' % ((item.tax / 100.0) / item.quantity)  # Tax for 1 of these items
+    end
+
+    # Credit Card Surcharge
+    if order.surcharge != 0
+      number += 1
+
+      values["item_number_#{number}"] = number
+      values["item_name_#{number}"] = 'Credit Card Surcharge'
+      values["quantity_#{number}"] = 1
+      values["amount_#{number}"] = '%.2f' % (order.surcharge / 100.0)
+      values["tax_#{number}"] = '%.2f' % (order.surcharge_tax / 100.0)
     end
 
     signed = OpenSSL::PKCS7::sign(OpenSSL::X509::Certificate.new(APP_CERT_PEM), OpenSSL::PKey::RSA.new(APP_KEY_PEM, ''), values.map { |k, v| "#{k}=#{v}" }.join("\n"), [], OpenSSL::PKCS7::BINARY)

data/app/helpers/effective_stripe_helper.rb

@@ -60,12 +60,12 @@ module EffectiveStripeHelper
     customer.create_stripe_customer! # Only creates if customer not already present
 
     payment = {
-      amount: order.total,
+      amount: order.total_with_surcharge,
       currency: EffectiveOrders.stripe[:currency],
       customer: customer.stripe_customer_id,
       payment_method: customer.payment_method_id.presence,
       description: stripe_order_description(order),
-      metadata: { order_id: order.id },
+      metadata: { order_id: order.id }
     }
 
     token_required = customer.token_required?

data/app/models/effective/order.rb

@@ -52,11 +52,17 @@ module Effective
       payment_provider  :string
       payment_card      :string
 
-      tax_rate          :decimal, precision: 6, scale: 3
+      tax_rate            :decimal, precision: 6, scale: 3
+      surcharge_percent   :decimal, precision: 6, scale: 3
 
-      subtotal          :integer
-      tax               :integer
-      total             :integer
+      subtotal          :integer   # Sum of items subtotal
+      tax               :integer   # Tax on subtotal
+      amount_owing      :integer   # Subtotal + Tax
+
+      surcharge         :integer   # Credit Card Surcharge
+      surcharge_tax     :integer   # Tax on surcharge
+
+      total             :integer   # Subtotal + Tax + Surcharge + Surcharge Tax
 
       timestamps
     end
@@ -88,7 +94,8 @@ module Effective
       before_validation { assign_email }
       before_validation { assign_user_address }
       before_validation { assign_billing_name }
-      before_validation { assign_order_totals }
+      before_validation { assign_order_values }
+      before_validation { assign_order_charges }
     end
 
     # Order validations
@@ -119,7 +126,7 @@ module Effective
     end
 
     # User validations -- An admin skips these when working in the admin/ namespace
-    with_options unless: -> { pending? || skip_buyer_validations? || purchased? } do
+    with_options(unless: -> { pending? || skip_buyer_validations? || purchased? }) do
       validates :tax_rate, presence: { message: "can't be determined based on billing address" }
       validates :tax, presence: true
 
@@ -129,7 +136,7 @@ module Effective
     end
 
     # When Purchased
-    with_options if: -> { purchased? } do
+    with_options(if: -> { purchased? }) do
       validates :purchased_at, presence: true
       validates :payment, presence: true
 
@@ -137,7 +144,7 @@ module Effective
       validates :payment_card, presence: true
     end
 
-    with_options if: -> { deferred? } do
+    with_options(if: -> { deferred? }) do
       validates :payment_provider, presence: true
 
       validate do
@@ -145,11 +152,18 @@ module Effective
       end
     end
 
-    before_save(if: -> { state_was == EffectiveOrders::PURCHASED }) do
-      raise EffectiveOrders::AlreadyPurchasedException.new('cannot unpurchase an order') unless purchased?
-    end
+    # Sanity check
+    before_save(if: -> { was_purchased? }) do
+      raise('cannot unpurchase an order') unless purchased?
+
+      raise('cannot change subtotal of a purchased order') if changes[:subtotal].present?
+
+      raise('cannot change tax of a purchased order') if changes[:tax].present?
+      raise('cannot change tax of a purchased order') if changes[:tax_rate].present?
+
+      raise('cannot change surcharge of a purchased order') if changes[:surcharge].present?
+      raise('cannot change surcharge percent of a purchased order') if changes[:surcharge_percent].present?
 
-    before_save(if: -> { done? }) do
       raise('cannot change total of a purchased order') if changes[:total].present?
     end
 
@@ -213,9 +227,7 @@ module Effective
       removed.each { |order_item| order_item.mark_for_destruction }
 
       # Make sure to reset stored aggregates
-      self.total = nil
-      self.subtotal = nil
-      self.tax = nil
+      assign_attributes(subtotal: nil, tax_rate: nil, tax: nil, surcharge_percent: nil, surcharge: nil, total: nil)
 
       removed.length == 1 ? removed.first : removed
     end
@@ -259,9 +271,7 @@ module Effective
       end.compact
 
       # Make sure to reset stored aggregates
-      self.total = nil
-      self.subtotal = nil
-      self.tax = nil
+      assign_attributes(subtotal: nil, tax_rate: nil, tax: nil, surcharge_percent: nil, surcharge: nil, total: nil)
 
       retval = cart_items.map do |item|
         order_items.build(
@@ -311,24 +321,14 @@ module Effective
     end
 
     def total_label
-      if refund? && purchased?
-        'Total Paid'
-      elsif purchased?
-        'Total Paid'
-      elsif refund? && (pending? || confirmed?)
-        'Total Due'
-      elsif (pending? || confirmed?)
-        'Total Due'
-      else
-        'Total'
-      end
+      purchased? ? 'Total Paid' : 'Total Due'
     end
 
     # Visa - 1234
     def payment_method
       return nil unless purchased?
 
-      provider = payment_provider if ['cheque', 'etransfer', 'phone'].include?(payment_provider)
+      provider = payment_provider if ['cheque', 'etransfer', 'phone', 'credit card'].include?(payment_provider)
 
       # Normalize payment card
       card = case payment_card.to_s.downcase.gsub(' ', '').strip
@@ -411,6 +411,18 @@ module Effective
       false
     end
 
+    def was_purchased?
+      state_was == EffectiveOrders::PURCHASED
+    end
+
+    def purchased_with_credit_card?
+      purchased? && EffectiveOrders.credit_card_payment_providers.include?(payment_provider)
+    end
+
+    def purchased_without_credit_card?
+      purchased? && EffectiveOrders.credit_card_payment_providers.exclude?(payment_provider)
+    end
+
     def declined?
       state == EffectiveOrders::DECLINED
     end
@@ -424,7 +436,7 @@ module Effective
     end
 
     def subtotal
-      self[:subtotal] || present_order_items.map { |oi| oi.subtotal }.sum
+      self[:subtotal] || get_subtotal()
     end
 
     def tax_rate
@@ -435,8 +447,32 @@ module Effective
       self[:tax] || get_tax()
     end
 
+    def amount_owing
+      self[:amount_owing] || get_amount_owing()
+    end
+
+    def surcharge_percent
+      self[:surcharge_percent] || get_surcharge_percent()
+    end
+
+    def surcharge
+      self[:surcharge] || get_surcharge()
+    end
+
+    def surcharge_tax
+      self[:surcharge_tax] || get_surcharge_tax()
+    end
+
     def total
-      (self[:total] || (subtotal + tax.to_i)).to_i
+      self[:total] || get_total()
+    end
+
+    def total_with_surcharge
+      get_total_with_surcharge()
+    end
+
+    def total_without_surcharge
+      get_total_without_surcharge()
     end
 
     def free?
@@ -526,12 +562,13 @@ module Effective
 
     # Call this as a way to skip over non consequential orders
     # And mark some purchasables purchased
+    # This is different than the Mark as Paid payment processor
     def mark_as_purchased!
       purchase!(skip_buyer_validations: true, email: false, skip_quickbooks: true)
     end
 
     # Effective::Order.new(items: Product.first, user: User.first).purchase!(email: false)
-    def purchase!(payment: 'none', provider: 'none', card: 'none', email: true, skip_buyer_validations: false, skip_quickbooks: false)
+    def purchase!(payment: nil, provider: nil, card: nil, email: true, skip_buyer_validations: false, skip_quickbooks: false)
       return true if purchased?
 
       # Assign attributes
@@ -539,12 +576,16 @@ module Effective
         state: EffectiveOrders::PURCHASED,
         skip_buyer_validations: skip_buyer_validations,
 
-        payment_provider: provider,
-        payment_card: (card.presence || 'none'),
+        payment: payment_to_h(payment.presence || 'none'),
         purchased_at: (purchased_at.presence || Time.zone.now),
-        payment: payment_to_h(payment)
+
+        payment_provider: (provider.presence || 'none'),
+        payment_card: (card.presence || 'none')
       )
 
+      # Updates surcharge and total based on payment_provider
+      assign_order_charges()
+
       begin
         Effective::Order.transaction do
           run_purchasable_callbacks(:before_purchase)
@@ -600,7 +641,7 @@ module Effective
     def decline!(payment: 'none', provider: 'none', card: 'none', validate: true)
       return false if declined?
 
-      raise EffectiveOrders::AlreadyPurchasedException.new('order already purchased') if purchased?
+      raise('order already purchased') if purchased?
 
       error = nil
 
@@ -664,6 +705,10 @@ module Effective
 
     protected
 
+    def get_subtotal
+      present_order_items.map { |oi| oi.subtotal }.sum
+    end
+
     def get_tax_rate
       rate = instance_exec(self, &EffectiveOrders.order_tax_rate_method).to_f
 
@@ -675,10 +720,49 @@ module Effective
     end
 
     def get_tax
-      return nil unless tax_rate.present?
+      return 0 unless tax_rate.present?
       present_order_items.reject { |oi| oi.tax_exempt? }.map { |oi| (oi.subtotal * (tax_rate / 100.0)).round(0).to_i }.sum
     end
 
+    def get_amount_owing
+      subtotal + tax
+    end
+
+    def get_surcharge_percent
+      percent = EffectiveOrders.credit_card_surcharge_percent.to_f
+      return nil unless percent > 0.0
+
+      return 0.0 if purchased_without_credit_card?
+
+      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."
+      end
+
+      percent
+    end
+
+    def get_surcharge
+      return 0 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
+    end
+
+    def get_total
+      subtotal + tax + surcharge + surcharge_tax
+    end
+
+    def get_total_with_surcharge
+      subtotal + tax + surcharge + surcharge_tax
+    end
+
+    def get_total_without_surcharge
+      subtotal + tax
+    end
+
     private
 
     def present_order_items
@@ -707,18 +791,31 @@ module Effective
       end
     end
 
-    # This overwrites the prices, taxes, etc on every save.
-    def assign_order_totals
+    # This overwrites the prices, taxes, surcharge, etc on every save.
+    # Does not get run from the before_validate on purchase.
+    def assign_order_values
       # Copies prices from purchasable into order items
       present_order_items.each { |oi| oi.assign_purchasable_attributes }
 
-      # Sum of order item subtotals
-      subtotal = present_order_items.map { |oi| oi.subtotal }.sum
+      # Calculated from each item
+      self.subtotal = get_subtotal()
 
-      self.subtotal = subtotal
+      # We only know tax if there is a billing address
       self.tax_rate = get_tax_rate()
       self.tax = get_tax()
-      self.total = subtotal + (tax || 0)
+
+      # Subtotal + Tax
+      self.amount_owing = get_amount_owing()
+    end
+
+    def assign_order_charges
+      # 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()
+
+      # Subtotal + Tax + Surcharge + Surcharge Tax
+      self.total = get_total()
     end
 
     def update_purchasables_purchased_order!

data/app/models/effective/order_item.rb

@@ -32,7 +32,7 @@ module Effective
       ((quantity || 0) > 1 ? "#{quantity}x #{name}" : name) || 'order item'
     end
 
-    # This method is called in a before_validation in order.assign_order_totals()
+    # This method is called in a before_validation in order.assign_order_values()
     def assign_purchasable_attributes
       assign_attributes(name: purchasable.purchasable_name, price: purchasable.price, tax_exempt: purchasable.tax_exempt) if purchasable
     end

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

@@ -1,67 +1,72 @@
-- include_quantity_column = order.order_items.any? { |order_item| order_item.quantity > 1 }
-- include_download_column = order.purchased? && order.order_items.any? { |order_item| order_item.purchased_download_url.present? }
-
 .effective-order-items
   %table.table
     %thead
       %tr
-        - if include_quantity_column
-          %th.quantity Qty
-
-        - if include_download_column
-          %th.download Download
-
+        %th.quantity Qty
         %th.item= order.order_items.length > 1 ? 'Items' : 'Item'
         %th.price Price
 
     %tbody
       - order.order_items.each do |item|
         %tr
-          - if include_quantity_column
-            %td.quantity= item.quantity
+          %td.quantity= item.quantity
+
+          %td.item
+            = item.name.html_safe
 
-          - if include_download_column
-            %td.download
-              - if item.purchased_download_url.present?
-                = link_to 'download', item.purchased_download_url
-              - else
-                = '-'
+            - if order.purchased? && item.purchased_download_url.present?
+              = link_to 'Download', item.purchased_download_url
 
-          %td.item= item.name.html_safe
           %td.price= price_to_currency(item.subtotal)
 
+  %table.table
     %tfoot
-      - if order.tax.to_i != 0 || order.tax_rate == nil
-        %tr
-          - if include_quantity_column
-            %th.quantity
-
-          - if include_download_column
-            %th.download
+      %tr
+        %th
+        %td.subtotal Subtotal
+        %td.price.subtotal-price= price_to_currency(order.subtotal)
 
-          %th.subtotal Subtotal
-          %td.price.subtotal-price= price_to_currency(order.subtotal)
+      - if order.tax_rate.blank?
+        -# Nothing to do. We can't display Tax, Total or Credit Card Surcharge (which is taxed) yet.
 
-      - if order.tax.to_i != 0
+      - elsif order.tax_rate.present? && order.surcharge_percent.to_f > 0.0
         %tr
-          - if include_quantity_column
-            %th.quantity
+          %th
+          %td.tax Tax (#{rate_to_percentage(order.tax_rate)})
+          %td.price.tax-price= price_to_currency(order.tax)
 
-          - if include_download_column
-            %th.download
+        %tr.single-line
+          %th
+          %td.amount-owing Amount owing before Credit Card Processing Fee
+          %td.price.amount-owing-price= price_to_currency(order.amount_owing)
 
-          %th.tax Tax (#{tax_rate_to_percentage(order.tax_rate)})
-          %td.price.tax-price= price_to_currency(order.tax)
+        %tr
+          %th
+          %td
+          %td
+
+        %tr
+          %th
+          %td.surcharge Credit Card Processing Fee (#{rate_to_percentage(order.surcharge_percent)}) on #{price_to_currency(order.amount_owing)}
+          %td.price.surcharge-price= price_to_currency(order.surcharge)
 
-      - if order.tax_rate.present?
         %tr
-          - if include_quantity_column
-            %th.quantity
+          %th
+          %td.surcharge-tax Tax (#{rate_to_percentage(order.tax_rate)}) on Credit Card Processing Fee
+          %td.price.surcharge-tax-price= price_to_currency(order.surcharge_tax)
 
-          - if include_download_column
-            %th.download
+        %tr.double-line
+          %th
+          %td.total Total amount charged to credit card
+          %td.price.total-price= price_to_currency(order.total)
 
-          %th.total
-            = order.total_label
+      - elsif order.tax_rate.present? && !(order.surcharge_percent.to_f > 0.0)
+        %tr
+          %th
+          %td.tax Tax (#{rate_to_percentage(order.tax_rate)})
+          %td.price.tax-price= price_to_currency(order.tax)
 
+        %tr.single-line
+          %th
+          %td.total= order.total_label
           %td.price.total-price= price_to_currency(order.total)

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

@@ -0,0 +1,20 @@
+.effective-order-items
+  %table.table
+    %thead
+      %tr
+        %th.quantity Qty
+        %th.item= order.order_items.length > 1 ? 'Items' : 'Item'
+        %th.price Price
+
+    %tbody
+      - order.order_items.each do |item|
+        %tr
+          %td.quantity= item.quantity
+
+          %td.item
+            = item.name.html_safe
+
+            - if order.purchased? && item.purchased_download_url.present?
+              = link_to 'Download', item.purchased_download_url
+
+          %td.price= price_to_currency(item.subtotal)

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

@@ -7,7 +7,8 @@
     = effective_form_with(model: order, url: effective_orders.mark_as_paid_order_path(order), method: :post) do |f|
       .row
         .col-6
-          = f.select :payment_provider, EffectiveOrders.admin_payment_providers, required: true
+          - collection = admin_mark_as_paid_payment_providers()
+          = f.select :payment_provider, collection, required: true, grouped: collection.kind_of?(Hash)
 
           = f.text_field :payment_card,
             label: 'Payment card type, cheque, e-transfer or transaction number',

data/app/views/layouts/effective_orders_mailer_layout.html.haml

@@ -4,15 +4,24 @@
     %meta{:content => 'text/html; charset=UTF-8', 'http-equiv' => 'Content-Type'}
 
   :css
+    .effective-order-header h1 { margin: 0; }
+    .effective-order-shipping { padding-top: 12px; padding-bottom: 12px; }
+
     .effective-order table.table { min-width: 650px; vertical-align: top; border: 0; }
-    .effective-order table.table td { border: 0; vertical-align: top; }
     .effective-order { text-align: left; }
-    .effective-order .price { text-align: right; }
-    .effective-order tfoot th { text-align: right; }
-    .effective-order tfoot tr:first-child td { padding-top: 24px; }
-    .effective-order tfoot tr:first-child th { padding-top: 24px; }
-    .effective-order-shipping { padding-top: 12px; padding-bottom: 12px; }
-    .effective-order-header h1 { margin: 0; }
+    .effective-order .price { text-align: right; padding-left: 24px; }
+
+    .effective-order tfoot th { text-align: right; white-space: nowrap; }
+    .effective-order tfoot td { text-align: right; white-space: nowrap; }
+
+    .effective-order tfoot th { width: 100%; }
+
+    .effective-order tfoot tr.single-line td { border-top: solid 1px; }
+    .effective-order tfoot tr.double-line td { border-top: double 4px; }
+
+    .effective-order tfoot .amount-owing { font-style: italic; }
+    .effective-order tfoot .total { font-style: italic; }
+
     @media print { .effective-page-break { page-break-inside: avoid; page-break-after: always; min-height: 1px; } }
 
   %body{style: 'background: #fff;'}

data/config/effective_orders.rb

@@ -47,6 +47,12 @@ EffectiveOrders.setup do |config|
   # An order must have a tax rate (even if the value is 0) to be purchased
   config.order_tax_rate_method = Proc.new { |order| Effective::TaxRateCalculator.new(order: order).tax_rate }
 
+  # Credit Card Surcharge
+  # Will be applied to all orders based off the after-tax total.
+  # Use 2.4 for 2.4% or nil for none
+  config.credit_card_surcharge_percent = nil
+  config.credit_card_surcharge_qb_item_name = 'Credit Card Surcharge'
+
   # Minimum Charge
   # Prevent orders less than this value from being purchased
   # Stripe doesn't allow orders less than $0.50

data/db/migrate/01_create_effective_orders.rb.erb

@@ -23,9 +23,13 @@ class CreateEffectiveOrders < ActiveRecord::Migration[4.2]
       t.string    :payment_card
 
       t.decimal   :tax_rate, :precision => 6, :scale => 3
+      t.decimal   :surcharge_percent, :precision => 6, :scale => 3
 
       t.integer   :subtotal
       t.integer   :tax
+      t.integer   :amount_owing
+      t.integer   :surcharge
+      t.integer   :surcharge_tax
       t.integer   :total
 
       t.timestamps

data/lib/effective_orders/version.rb

@@ -1,3 +1,3 @@
 module EffectiveOrders
-  VERSION = '5.9.3'.freeze
+  VERSION = '6.0.0'.freeze
 end

data/lib/effective_orders.rb

@@ -39,6 +39,7 @@ module EffectiveOrders
       :billing_address, :shipping_address,
       :collect_note, :collect_note_required, :collect_note_message,
       :terms_and_conditions, :terms_and_conditions_label, :minimum_charge,
+      :credit_card_surcharge_percent, :credit_card_surcharge_qb_item_name,
 
       # Mailer
       :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject,
@@ -166,7 +167,7 @@ module EffectiveOrders
       #('pretend' if pretend?),
       #('refund' if refund?),
       ('stripe' if stripe?),
-      ('other' if mark_as_paid?),
+      ('other (non credit card)' if mark_as_paid?),
       'none'
     ].compact
   end
@@ -175,6 +176,10 @@ module EffectiveOrders
     [('cheque' if cheque?), ('etransfer' if etransfer?), ('phone' if phone?)].compact
   end
 
+  def self.credit_card_payment_providers
+    ['credit card', 'moneris', 'moneris_checkout', 'paypal', 'stripe']
+  end
+
   def self.qb_sync?
     use_effective_qb_sync && defined?(EffectiveQbSync)
   end
@@ -285,7 +290,6 @@ module EffectiveOrders
   end
 
   class SoldOutException < Exception; end
-  class AlreadyPurchasedException < Exception; end
 
   def self.gem_path
     __dir__.chomp('/lib')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_orders
 version: !ruby/object:Gem::Version
-  version: 5.9.3
+  version: 6.0.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-29 00:00:00.000000000 Z
+date: 2022-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -269,6 +269,7 @@ files:
 - app/views/effective/orders/_order_payment.html.haml
 - app/views/effective/orders/_order_shipping.html.haml
 - app/views/effective/orders/_orders_table.html.haml
+- app/views/effective/orders/_purchasables.html.haml
 - app/views/effective/orders/cheque/_form.html.haml
 - app/views/effective/orders/declined.html.haml
 - app/views/effective/orders/deferred.html.haml