effective_orders 6.25.4 → 6.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 997019591c0afbc15cd753ec5be961fc741cb9aa27b2106237949d57556f1009
-  data.tar.gz: 2db2ecb0f21460b43ab088e081fe0fca6e43a68288f12240535f7f90d94781a8
+  metadata.gz: 8f2d362666e0acf723037a83305a0d8abb7390b9450bdb70ca8edb2917023062
+  data.tar.gz: a9582919b75d433be885f5bd4f58b7fe45f4b49778627cbd1d66152d346c7a02
 SHA512:
-  metadata.gz: f0c36e3d457379454db871feb90a69f7e1076e1daa5695925d527d2854fb2f28547c01ffee1dfa41a4269b5e596dbae9d1739ac3ba18465f380b0041ee34de39
-  data.tar.gz: 8c85e37a9931ffc619f79424b62d7658e5c566bc51fa91f446196afaf0ff9dc8cc0b76992c4394978705c6dc821658d0ae591e031c974b464aee9939ce39cf68
+  metadata.gz: de9920886821096194b4ee8b07ee2a643994e3daa4c726173cb354de7a0b044b74ca28d51deda550857e52f9166fb539cd6484f0eb5b3149c5d353a3f6fb76ca
+  data.tar.gz: 302f8062e198841746e462b589946f8fbd4b1bc52744e1f493402889db788739069708d9cc5729513a12cbfeae6c3c2551e945f470b3ce5c3942b6b88bc2d67a

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

@@ -0,0 +1,41 @@
+// https://devdocs.helcim.com/docs/render-helcimpayjs
+
+$(document).on('click', 'form[data-helcim-checkout] a', function(event) {
+  event.preventDefault();
+  initializeHelcim();
+});
+
+function initializeHelcim() {
+  let $helcim = $('form[data-helcim-checkout]');
+  if($helcim.length == 0) return;
+
+  let token = $helcim.data('helcim-checkout');
+
+  // From HelcimPay.js
+  appendHelcimPayIframe(token)
+
+  // Add our event listener
+  window.addEventListener('message', helcimPayIframeEvent, false);
+};
+
+function helcimPayIframeEvent(event) {
+  if(event.data.eventName.startsWith('helcim-pay-js')) {
+    window.removeEventListener('message', helcimPayIframeEvent, false);
+
+    if(event.data.eventStatus == 'HIDE') {
+      let button = $('.effective-helcim-checkout').find('#helcim-checkout-button').get(0);
+      Rails.enableElement(button)
+    }
+
+    if(event.data.eventStatus == 'SUCCESS') {
+      let payment = btoa(event.data.eventMessage);
+  
+      let $form = $('form[data-helcim-checkout]').first();
+      $form.find('input[name="helcim[payment]"]').val(payment);
+      $form.submit();
+  
+      $('#helcimCheckout').fadeOut('slow');
+      $('#helcim-checkout-loading').text('Thank you! Processing payment information. Please wait...');
+    }
+  }
+};

data/app/controllers/admin/orders_controller.rb

@@ -16,7 +16,7 @@ module Admin
 
     submit :save, 'Save', success: -> {
       message = flash_success(resource, params[:action])
-      message << ". A request for payment has been sent to #{resource.emails_send_to}" if resource.send_payment_request_to_buyer?
+      message << ". A request for payment has been sent to #{resource.emails_send_to}" if resource.send_payment_request?
       message
     }
 
@@ -78,7 +78,7 @@ module Admin
       @order = Effective::Order.deep.was_not_purchased.find(params[:id])
       authorize_effective_order!
 
-      if @order.send_payment_request_to_buyer!
+      if @order.send_payment_request!
         flash[:success] = "A request for payment has been sent to #{@order.emails_send_to}"
       else
         flash[:danger] = 'Unable to send payment request'
@@ -93,7 +93,7 @@ module Admin
       begin
         authorize_effective_order!
 
-        @orders.each { |order| order.send_payment_request_to_buyer! }
+        @orders.each { |order| order.send_payment_request! }
         render json: { status: 200, message: "Successfully sent #{@orders.length} payment request emails"}
       rescue Exception => e
         render json: { status: 500, message: "Bulk send payment request error: #{e.message}" }

data/app/controllers/effective/orders_controller.rb

@@ -9,6 +9,7 @@ module Effective
     include Providers::DeluxeDelayedPurchase
     include Providers::Etransfer
     include Providers::Free
+    include Providers::Helcim
     include Providers::MarkAsPaid
     include Providers::Moneris
     include Providers::MonerisCheckout

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

@@ -0,0 +1,58 @@
+module Effective
+  module Providers
+    module Helcim
+      extend ActiveSupport::Concern
+
+      def helcim
+        raise('helcim provider is not available') unless EffectiveOrders.helcim?
+
+        @order = Effective::Order.deep.find(params[:id])
+        @order.current_user = current_user unless admin_checkout?(helcim_params)
+
+        EffectiveResources.authorize!(self, :update, @order)
+
+        # Process and Verify Payment
+        api = Effective::HelcimApi.new
+
+        # Decode the payment payload
+        payment_payload = api.decode_payment_payload(helcim_params[:payment])
+
+        if payment_payload.blank?
+          flash[:danger] = 'Unable to process helcim order without payment. please try again.'
+          return order_not_processed(declined_url: helcim_params[:declined_url])
+        end
+
+        # Verify the payment
+        payment = api.verify_payment(@order, payment_payload)
+
+        # If it's purchased
+        purchased = api.purchased?(payment)
+
+        if purchased == false
+          flash[:danger] = "Payment was unsuccessful. The credit card payment failed with message: #{payment['status'] || 'none'}. Please try again."
+          return order_declined(
+            payment: payment, 
+            provider: 'helcim', 
+            card: payment['card'], 
+            declined_url: helcim_params[:declined_url]
+          )
+        end
+
+        # Valid Authorized and Completed Payment
+        order_purchased(
+          payment: payment,
+          provider: 'helcim',
+          card: payment['card'],
+          purchased_url: helcim_params[:purchased_url]
+        )
+      end
+
+      private
+
+      def helcim_params
+        params.require(:helcim).permit(:payment, :purchased_url, :declined_url)
+      end
+
+    end
+  end
+end

data/app/datatables/admin/effective_orders_datatable.rb

@@ -10,7 +10,7 @@ module Admin
 
         bulk_action(
           'Send invoice email to selected purchased orders',
-          effective_orders.bulk_send_order_email_to_buyer_orders_path,
+          effective_orders.bulk_send_order_email_orders_path,
           data: { confirm: 'Send invoice emails?' }
         )
       end

data/app/helpers/effective_helcim_helper.rb

@@ -0,0 +1,5 @@
+module EffectiveHelcimHelper
+  def helcim_initialize_request(order)
+    Effective::HelcimApi.new.initialize_request(order)
+  end
+end

data/app/helpers/effective_orders_helper.rb

@@ -50,6 +50,8 @@ module EffectiveOrdersHelper
       'Pay by E-transfer'
     when :free
       'Checkout Free'
+    when :helcim
+      'Pay by Credit Card'
     when :mark_as_paid
       'Admin: Mark as Paid'
     when :moneris

data/app/mailers/effective/orders_mailer.rb

@@ -26,7 +26,7 @@ module Effective
       raise('expected an Effective::Order') unless resource.kind_of?(Effective::Order)
 
       @order = resource
-      @order_email = Effective::OrderEmail.new(resource)
+      @order_email = Effective::OrderEmail.new(resource, opts)
 
       subject = subject_for(__method__, @order_email.subject, @order, opts)
       headers = headers_for(@order, opts)

data/app/models/effective/helcim_api.rb

@@ -0,0 +1,277 @@
+# https://devdocs.helcim.com/docs/overview-of-helcimpayjs
+# Effective::HelcimApi.new.health_check
+module Effective
+  class HelcimApi
+    # All required
+    attr_accessor :environment
+    attr_accessor :api_token
+    attr_accessor :currency
+    attr_accessor :brand_color
+
+    attr_accessor :read_timeout
+
+    def initialize(environment: nil, api_token: nil, currency: nil, brand_color: nil)
+      self.environment = environment || EffectiveOrders.helcim.fetch(:environment)
+      self.api_token = api_token || EffectiveOrders.helcim.fetch(:api_token)
+      self.currency = currency || EffectiveOrders.helcim.fetch(:currency)
+      self.brand_color = brand_color || EffectiveOrders.helcim.fetch(:brand_color)
+    end
+
+    def health_check
+      get('/connection-test')
+    end
+
+    def get_transaction(id)
+      get("/card-transactions/#{id}")
+    end
+
+    # Make the Preload Request
+    # https://devdocs.helcim.com/reference/checkout-init
+    def initialize_request(order)
+      params = {
+        amount: ('%.2f' % order.total_to_f),
+        currency: currency,
+        paymentMethod: 'cc',
+        paymentType: 'purchase',   # purchase, preauth, verify
+        allowPartial: 0,
+        hasConvenienceFee: 0,
+        taxAmount: ('%.2f' % order.tax_to_f if order.tax.to_i > 0),
+        hideExistingPaymentDetails: 0,
+        setAsDefaultPaymentMethod: 1,
+        confirmationScreen: false,
+        displayContactFields: 0,
+        customStyling: {
+          brandColor: (brand_color || '815AF0')
+        },
+        invoiceRequest: {
+          invoiceNumber: '#' + order.to_param
+        },
+        customerRequest: {
+          contactName: order.billing_name,
+          businessName: order.organization.to_s.presence,
+        }.compact,
+      }.compact
+
+      params[:invoiceRequest][:lineItems] = order.order_items.map do |item|
+        {
+          description: item.name,
+          quantity: item.quantity,
+          price: ('%.2f' % item.price_to_f),
+          total: ('%.2f' % item.subtotal_to_f),
+          taxAmount: ('%.2f' % item.tax_to_f),
+        }
+      end
+
+      address = order.billing_address
+      country = helcim_country(address&.country_code)
+
+      if address.present? && country.to_s.length == 3
+        params[:customerRequest][:billingAddress] = {
+          name: order.billing_name,
+          street1: address.address1,
+          street2: address.address2,
+          city: address.city,
+          province: address.state_code,
+          country: country,
+          postalCode: address.postal_code,
+          email: order.email,
+        }
+      end
+
+      address = order.shipping_address
+      country = helcim_country(address&.country_code)
+
+      if address.present? && country.to_s.length == 3
+        params[:customerRequest][:shippingAddress] = {
+          name: order.billing_name,
+          street1: address.address1,
+          street2: address.address2,
+          city: address.city,
+          province: address.state_code,
+          country: country,
+          postalCode: address.postal_code,
+          email: order.email,
+        }
+      end
+
+      response = post('/helcim-pay/initialize', params: params)
+      raise("expected response to be a Hash") unless response.kind_of?(Hash)
+
+      token = response['checkoutToken']
+      raise("expected response to include a checkoutToken") unless token.present?
+
+      # Return the token to the front end form
+      token
+    end
+
+    # Decode the base64 encoded JSON object that was given from the form into a Hash
+    def decode_payment_payload(payload)
+      return if payload.blank?
+
+      raise('expected a string') unless payload.kind_of?(String)
+
+      payment = (JSON.parse(Base64.decode64(payload)) rescue nil)
+      raise('expected payment to be a Hash') unless payment.kind_of?(Hash)
+
+      payment = payment.dig('data', 'data')
+      raise('expected payment data') unless payment.kind_of?(Hash)
+      raise('expected payment data with a transactionId') unless payment['transactionId'].present?
+
+      payment
+    end
+
+    def purchased?(payment)
+      raise('expected a payment Hash') unless payment.kind_of?(Hash)
+      (payment['status'] == 'APPROVED' && payment['type'] == 'purchase')
+    end
+
+    # Considers the insecure payment_payload, requests the real transaction from Helcim and verifies it vs the order
+    def verify_payment(order, payment_payload)
+      raise('expected a payment_payload Hash') unless payment_payload.kind_of?(Hash)
+
+      transaction_id = payment_payload['transactionId']
+      raise('expected a payment_payload with a transactionId') unless transaction_id.present?
+
+      payment = get_transaction(transaction_id)
+      raise('expected an existing card-transaction payment') unless payment.kind_of?(Hash)
+
+      # Compare the payment (trusted truth) and the payment_payload (untrusted)
+      if payment['transactionId'].to_s != payment_payload['transactionId'].to_s
+        raise('expected the payment and payment_payload to have the same transactionId')
+      end
+
+      # Validate order ids
+      if payment['invoiceNumber'].to_s != '#' + order.to_param
+        raise("expected card-transaction invoiceNumber to be the same as the order to_param")
+      end
+
+      # Validate amounts if purchased
+      if purchased?(payment) && (amount = payment['amount'].to_f) != (amountAuthorized = order.total_to_f)
+        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
+
+    # Takes a payment_intent and returns the card info we can store
+    def card_info(payment)
+      # Return the authorization params merged with the card info
+      last4 = payment['cardNumber'].to_s.last(4)
+      card = payment['cardType'].to_s.downcase
+
+      active_card = "**** **** **** #{last4} #{card}" if last4.present?
+
+      { 'active_card' => active_card, 'card' => card }.compact
+    end
+
+    def get(endpoint, params: nil)
+      query = ('?' + params.compact.map { |k, v| "$#{k}=#{v}" }.join('&')) if params.present?
+
+      uri = URI.parse(api_url + endpoint + query.to_s)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.read_timeout = (read_timeout || 30)
+      http.use_ssl = true
+
+      result = with_retries do
+        puts "[GET] #{uri}" if Rails.env.development?
+
+        response = http.get(uri, headers)
+        raise Exception.new("#{response.code} #{response.body}") unless response.code == '200'
+
+        response
+      end
+
+      JSON.parse(result.body)
+    end
+
+    def post(endpoint, params:)
+      uri = URI.parse(api_url + endpoint)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.read_timeout = (read_timeout || 30)
+      http.use_ssl = true
+
+      puts "[POST] #{uri} #{params}" if Rails.env.development?
+
+      response = http.post(uri.path, params.to_json, headers)
+      raise Exception.new("#{response.code} #{response.body}") unless response.code == '200'
+
+      JSON.parse(response.body)
+    end
+
+    # Effective::HelcimApi.new.set_logo!
+    # Put your file in the apps/tenant/app/assets/images/tenant/helcim-logo.png
+    # Run this once to set the logo
+    def set_logo!(path: nil)
+      path ||= Rails.root.join("apps/#{Tenant.current}/app/assets/images/#{Tenant.current}/helcim-logo.png")
+      raise("Expected #{path} to exist") unless File.exist?(path)
+
+      url = URI.parse(api_url + '/branding/logo')
+      boundary = "AaB03x"
+
+      # Build multipart form data
+      body = [
+        "--#{boundary}",
+        "Content-Disposition: form-data; name=\"logo\"; filename=\"#{File.basename(path)}\"",
+        "Content-Type: image/#{File.extname(path).downcase.delete('.')}",
+        "",
+        File.binread(path),
+        "--#{boundary}--"
+      ].join("\r\n")
+
+      # Set up HTTP request
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      
+      # Create POST request
+      request = Net::HTTP::Post.new(url.path)
+      request.body = body
+
+      request.initialize_http_header(headers.merge({
+        'Content-Type' => "multipart/form-data; boundary=#{boundary}",
+        'Content-Length' => request.body.length.to_s,
+      }))
+
+      # Send request
+      response = http.request(request)
+      raise Exception.new("#{response.code} #{response.body}") unless response.code == '200'
+
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def headers
+      { "Accept": "application/json", "Content-Type": "application/json", 'api-token': api_token }
+    end
+
+    def api_url
+      'https://api.helcim.com/v2' # No trailing /
+    end
+
+    def helcim_country(country_code)
+      return 'CAN' if country_code == 'CA' || country_code == 'CAD'
+      return 'USA' if country_code == 'US'
+      country_code
+    end
+
+    def with_retries(retries: (Rails.env.development? ? 0 : 3), wait: 2, &block)
+      raise('expected a block') unless block_given?
+
+      begin
+        return yield
+      rescue Exception => e
+        if (retries -= 1) > 0
+          sleep(wait); retry
+        else
+          raise
+        end
+      end
+    end
+
+  end
+end

data/app/models/effective/order.rb

@@ -43,7 +43,7 @@ module Effective
     attr_accessor :confirmed_checkout   # Set on the Checkout Step 1
 
     # Settings in the /admin action forms
-    attr_accessor :send_payment_request_to_buyer # Set by Admin::Orders#new. Should the payment request email be sent after creating an order?
+    attr_accessor :send_payment_request # Set by Admin::Orders#new. Should the payment request email be sent after creating an order?
     attr_accessor :send_mark_as_paid_email_to_buyer  # Set by Admin::Orders#mark_as_paid
     attr_accessor :skip_buyer_validations # Set by Admin::Orders#create
     attr_accessor :mailer_preview # Set by the mailer preview. Disabled delayed payment validations
@@ -539,6 +539,10 @@ module Effective
       ((total || 0) / 100.0).to_f
     end
 
+    def tax_to_f
+      ((tax || 0) / 100.0).to_f
+    end
+
     def total_with_surcharge
       get_total_with_surcharge()
     end
@@ -635,8 +639,8 @@ module Effective
       self.addresses.clear if addresses.any? { |address| address.valid? == false }
       save!
 
-      if send_payment_request_to_buyer?
-        after_commit { send_payment_request_to_buyer! }
+      if send_payment_request?
+        after_commit { send_payment_request! }
       end
 
       true
@@ -893,6 +897,7 @@ module Effective
       false
     end
 
+    # Used internally to send emails to the buyer or admin depending on order status
     def send_order_emails!
       return false if skip_order_emails?
 
@@ -911,18 +916,24 @@ module Effective
       end
     end
 
-    def send_payment_request_to_buyer?
-      EffectiveResources.truthy?(send_payment_request_to_buyer)
+    def send_payment_request?
+      EffectiveResources.truthy?(send_payment_request)
     end
 
     # Admin datatable action
-    def send_payment_request_to_buyer!
-      EffectiveOrders.send_email(:order_email, self, payment_request: true) unless (purchased? || refund?)
+    def send_payment_request!
+      return if (purchased_or_deferred? || refund?)
+
+      EffectiveOrders.send_email(:order_email, self, payment_request: true)
+      EffectiveOrders.send_email(:order_email_to_admin, self, payment_request: true) if EffectiveOrders.send_payment_request_to_admin
     end
 
     # Admin datatable action
-    def send_order_email_to_buyer!
-      EffectiveOrders.send_email(:order_email, self) if purchased_or_deferred?
+    def send_order_email!
+      return unless purchased_or_deferred?
+
+      EffectiveOrders.send_email(:order_email, self)
+      EffectiveOrders.send_email(:order_email_to_admin, self) if EffectiveOrders.send_order_receipt_to_admin
     end
 
     def log_changes_formatted_value(attribute, value)
@@ -1010,7 +1021,7 @@ module Effective
       # Normalize payment card
       card = case payment_card.to_s.downcase.gsub(' ', '').strip
         when '' then nil
-        when 'v', 'visa' then 'Visa'
+        when 'v', 'visa', 'vi' then 'Visa'
         when 'm', 'mc', 'master', 'mastercard' then 'MasterCard'
         when 'a', 'ax', 'american', 'americanexpress' then 'American Express'
         when 'd', 'discover' then 'Discover'
@@ -1021,7 +1032,7 @@ module Effective
       if card == 'none' && payment['card_type'].present?
         card = case payment['card_type'].to_s.downcase.gsub(' ', '').strip
           when '' then nil
-          when 'v', 'visa' then 'Visa'
+          when 'v', 'visa', 'vi' then 'Visa'
           when 'm', 'mc', 'master', 'mastercard' then 'MasterCard'
           when 'a', 'ax', 'american', 'americanexpress' then 'American Express'
           when 'd', 'discover' then 'Discover'

data/app/models/effective/order_item.rb

@@ -58,10 +58,18 @@ module Effective
       purchasable&.purchased_download_url
     end
 
+    def price_to_f
+      ((price|| 0) / 100.0).to_f
+    end
+
     def subtotal
       price * quantity
     end
 
+    def subtotal_to_f
+      ((subtotal || 0) / 100.0).to_f
+    end
+
     def quantity
       self[:quantity] || 1
     end
@@ -72,6 +80,10 @@ module Effective
       (subtotal * order.tax_rate / 100.0).round(0).to_i
     end
 
+    def tax_to_f
+      ((tax || 0) / 100.0).to_f
+    end
+
     def amount_owing
       total
     end

data/app/views/admin/orders/_form_order.html.haml

@@ -17,9 +17,9 @@
   = f.email_cc_field :cc, hint: "Cc the above on any emailed receipts or payment requests."
 
   - if f.object.new_record?
-    = f.check_box :send_payment_request_to_buyer,
+    = f.check_box :send_payment_request,
       label: 'Yes, send a payment request email to the buyer and any cc.',
-      value: (f.object.send_payment_request_to_buyer.nil? ? EffectiveOrders.send_payment_request_to_buyer : f.object.send_payment_request_to_buyer?)
+      value: (f.object.send_payment_request.nil? ? EffectiveOrders.send_payment_request_to_buyer : f.object.send_payment_request?)
 
   %hr
 

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

@@ -29,6 +29,9 @@
     - if EffectiveOrders.deluxe?
       = render partial: '/effective/orders/deluxe/form', locals: provider_locals
 
+    - if EffectiveOrders.helcim?
+      = render partial: '/effective/orders/helcim/form', locals: provider_locals
+
     - if EffectiveOrders.moneris?
       = render partial: '/effective/orders/moneris/form', locals: provider_locals
 

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

@@ -4,6 +4,6 @@
   - else
     = dropdown_link_to 'View', effective_orders.order_path(order)
 
-  - if EffectiveResources.authorized?(controller, :send_order_email_to_buyer, order)
-    = dropdown_link_to 'E-mail Receipt', effective_orders.send_order_email_to_buyer_order_path(order),
+  - if EffectiveResources.authorized?(controller, :send_order_email, order)
+    = dropdown_link_to 'E-mail Receipt', effective_orders.send_order_email_order_path(order),
       data: { method: :post, confirm: "Send receipt to #{order.emails.first}?" }

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

@@ -0,0 +1,5 @@
+.effective-helcim-checkout.text-center
+  #helcim-checkout-loading.text-center
+
+  #helcimCheckout
+    = link_to(order_checkout_label(:helcim), '#', id: 'helcim-checkout-button', class: 'btn btn-primary', 'data-disable-with' => 'Loading...')

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

@@ -0,0 +1,22 @@
+- token = helcim_initialize_request(order)
+
+.card
+  .card-body
+    %h2 Checkout
+
+    .mt-4
+
+    = effective_form_with(scope: :helcim, url: effective_orders.helcim_order_path(order), data: { 'helcim-checkout': token }) do |f|
+      = f.hidden_field :purchased_url, value: purchased_url
+      = f.hidden_field :declined_url, value: declined_url
+
+      -# This is set by the helcim.js javascript
+      = f.hidden_field :payment
+
+      - if EffectiveOrders.helcim[:environment] == 'sandbox'
+        .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
+
+      = render('effective/orders/helcim/element')

data/config/effective_orders.rb

@@ -106,9 +106,9 @@ EffectiveOrders.setup do |config|
   config.send_order_declined_to_admin = false
   config.send_order_declined_to_buyer = false
   config.send_payment_request_to_buyer = true
-  config.send_pending_order_invoice_to_buyer = true
-  config.send_refund_notification_to_admin = true
+  config.send_payment_request_to_admin = true
 
+  config.send_refund_notification_to_admin = true
   config.send_order_receipts_when_mark_as_paid = true
   config.send_order_receipts_when_free = true
 
@@ -166,6 +166,16 @@ EffectiveOrders.setup do |config|
   #   success: 'Thank you! You have indicated that this order will be purchased by e-transfer. Please send us an e-transfer to "payments@example.com" with password "example" at your earliest convenience'
   # }
 
+  # Helcim
+  config.helcim = false
+
+  # config.helcim = {
+  #   environment: (Rails.env.production? ? 'production' : 'sandbox'),
+  #   api_token: '',
+  #   currency: 'CAD',
+  #   brand_color: '815AF0'  # 6-digit hex color without any # sign
+  # }
+
   # Moneris
   config.moneris = false
 

data/config/locales/effective_orders.en.yml

@@ -6,8 +6,8 @@ en:
   activerecord:
     actions:
       effective/order:
-        send_order_email_to_buyer: 'Send order email'
-        send_order_email_to_buyer_confirm: 'Send order email to @resource.emails_send_to?'
+        send_order_email: 'Send order email'
+        send_order_email_confirm: 'Send order email to @resource.emails_send_to?'
 
   datatables:
     admin/report_transactions_datatable: 'Report: Individual Transactions'

data/config/routes.rb

@@ -7,7 +7,7 @@ EffectiveOrders::Engine.routes.draw do
         get :purchased
         get :deferred
         get :declined
-        post :send_order_email_to_buyer
+        post :send_order_email
 
         post :cheque
         post :deluxe              # 1-off payment and purchase
@@ -16,6 +16,7 @@ EffectiveOrders::Engine.routes.draw do
 
         post :etransfer
         post :free
+        post :helcim
         post :mark_as_paid
         post :moneris_checkout
         post :phone
@@ -25,7 +26,7 @@ EffectiveOrders::Engine.routes.draw do
       end
 
       collection do
-        post :bulk_send_order_email_to_buyer
+        post :bulk_send_order_email
 
         post :moneris_postback
         post :paypal_postback
@@ -56,7 +57,7 @@ EffectiveOrders::Engine.routes.draw do
     resources :orders do
       member do
         post :send_payment_request
-        post :send_order_email_to_buyer
+        post :send_order_email
 
         delete :void
         post :unvoid

data/lib/effective_orders/version.rb

@@ -1,3 +1,3 @@
 module EffectiveOrders
-  VERSION = '6.25.4'.freeze
+  VERSION = '6.27.0'.freeze
 end

data/lib/effective_orders.rb

@@ -36,7 +36,7 @@ module EffectiveOrders
       # Emails
       :send_order_receipt_to_admin, :send_order_receipt_to_buyer, 
       :send_order_declined_to_admin, :send_order_declined_to_buyer, 
-      :send_payment_request_to_buyer, :send_pending_order_invoice_to_buyer,
+      :send_payment_request_to_admin, :send_payment_request_to_buyer,
       :send_order_receipts_when_mark_as_paid, :send_order_receipts_when_free,
       :send_subscription_events,
       :send_subscription_trialing, :send_subscription_trial_expired,
@@ -49,7 +49,7 @@ module EffectiveOrders
       :free_enabled, :mark_as_paid_enabled, :pretend_enabled, :pretend_message, :buyer_purchases_refund,
 
       # Payment processors. false or Hash
-      :cheque, :deluxe, :deluxe_delayed, :etransfer, :moneris, :moneris_checkout, :paypal, :phone, :refund, :stripe, :subscriptions, :trial
+      :cheque, :deluxe, :deluxe_delayed, :etransfer, :helcim, :moneris, :moneris_checkout, :paypal, :phone, :refund, :stripe, :subscriptions, :trial
     ]
   end
 
@@ -104,6 +104,10 @@ module EffectiveOrders
     delayed_providers.present?
   end
 
+  def self.helcim?
+    helcim.kind_of?(Hash)
+  end
+
   def self.mark_as_paid?
     mark_as_paid_enabled == true
   end
@@ -164,6 +168,7 @@ module EffectiveOrders
       ('deluxe' if deluxe?),
       ('etransfer' if etransfer?),
       ('free' if free?),
+      ('helcim' if helcim?),
       ('moneris' if moneris?),
       ('moneris_checkout' if moneris_checkout?),
       ('paypal' if paypal?),
@@ -183,6 +188,7 @@ module EffectiveOrders
       ('credit card' if mark_as_paid?),
       ('deluxe' if deluxe?),
       ('etransfer' if etransfer?),
+      ('helcim' if helcim?),
       #('free' if free?),
       ('moneris' if moneris?),
       ('moneris_checkout' if moneris_checkout?),
@@ -206,7 +212,7 @@ module EffectiveOrders
   end
 
   def self.credit_card_payment_providers
-    ['credit card', 'deluxe', 'moneris', 'moneris_checkout', 'paypal', 'stripe']
+    ['credit card', 'deluxe', 'helcim', 'moneris', 'moneris_checkout', 'paypal', 'stripe']
   end
 
   def self.qb_sync?
@@ -330,6 +336,10 @@ module EffectiveOrders
     end
   end
 
+  def self.helcim_script_url
+    "https://secure.helcim.app/helcim-pay/services/start.js"
+  end
+
   def self.moneris_checkout_script_url
     case EffectiveOrders.moneris_checkout.fetch(:environment)
     when 'prod' then 'https://gateway.moneris.com/chktv2/js/chkt_v2.00.js'
@@ -346,6 +356,10 @@ module EffectiveOrders
     end
   end
 
+  def self.stripe_script_url
+    "https://js.stripe.com/v3/"
+  end
+
   class SoldOutException < Exception; end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_orders
 version: !ruby/object:Gem::Version
-  version: 6.25.4
+  version: 6.27.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-14 00:00:00.000000000 Z
+date: 2025-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -195,6 +195,7 @@ files:
 - app/assets/javascripts/effective_orders/customers.js.coffee
 - app/assets/javascripts/effective_orders/providers/deluxe.js
 - app/assets/javascripts/effective_orders/providers/deluxe_delayed.js
+- app/assets/javascripts/effective_orders/providers/helcim.js
 - app/assets/javascripts/effective_orders/providers/moneris_checkout.js.coffee
 - app/assets/javascripts/effective_orders/providers/stripe.js.coffee
 - app/assets/javascripts/effective_orders/subscriptions.js.coffee
@@ -216,6 +217,7 @@ files:
 - app/controllers/effective/providers/deluxe_delayed_purchase.rb
 - app/controllers/effective/providers/etransfer.rb
 - app/controllers/effective/providers/free.rb
+- app/controllers/effective/providers/helcim.rb
 - app/controllers/effective/providers/mark_as_paid.rb
 - app/controllers/effective/providers/moneris.rb
 - app/controllers/effective/providers/moneris_checkout.rb
@@ -239,6 +241,7 @@ files:
 - app/helpers/effective_carts_helper.rb
 - app/helpers/effective_deluxe_delayed_helper.rb
 - app/helpers/effective_deluxe_helper.rb
+- app/helpers/effective_helcim_helper.rb
 - app/helpers/effective_moneris_checkout_helper.rb
 - app/helpers/effective_orders_helper.rb
 - app/helpers/effective_paypal_helper.rb
@@ -253,6 +256,7 @@ files:
 - app/models/effective/cart_item.rb
 - app/models/effective/customer.rb
 - app/models/effective/deluxe_api.rb
+- app/models/effective/helcim_api.rb
 - app/models/effective/item_name.rb
 - app/models/effective/order.rb
 - app/models/effective/order_email.rb
@@ -326,6 +330,8 @@ files:
 - app/views/effective/orders/edit.html.haml
 - app/views/effective/orders/etransfer/_form.html.haml
 - app/views/effective/orders/free/_form.html.haml
+- app/views/effective/orders/helcim/_element.html.haml
+- app/views/effective/orders/helcim/_form.html.haml
 - app/views/effective/orders/index.html.haml
 - app/views/effective/orders/mark_as_paid/_form.html.haml
 - app/views/effective/orders/moneris/_form.html.haml