effective_orders 5.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72eca7d0655eb6a817f703d2787d7a211d5b9da7889aaf1920ec79edb49384b7
-  data.tar.gz: ff602f25ce5ab9294c292e98060d505da015b6fb38c57f11463705d404871183
+  metadata.gz: 31540d5d07a5c2afc891284cd037d88d25ea6aba9db57073a53b5dd60c952a11
+  data.tar.gz: 502ad51ce45452ff307292de9d2f16c934a7e1a0aca7c62376272b1f3ede07b0
 SHA512:
-  metadata.gz: 251acbaf892b9f51e0fd6ebd739d1a64538b6a597f071afcd4d2c0fd3b4b839c9f4423594620ae31ed7ce4dc8c92a79bbe30e7d6f2d07a3ab29607eab04accbe
-  data.tar.gz: bd8a5fd153eba267e138a32f598e01888c427fde5171327cc6271b8a1d7dcea7931f2d4b3187981f7bcea1e3e397cef4aafedd00aa64504c66b221f0deadd04b
+  metadata.gz: 7541296d5ee6f6d52dc2edf94938f28734bf8da046612c46b0de23ee51fcd70c2eb80a32dd53534d16ffd3a9de72a923de9fffa709c4b96651ccf49fe7779b9b
+  data.tar.gz: 7be888605850e6dda6b952bf6ba9cceb575577b3d18ded8c118c8028890715bf41c8d8ded387de1bd5378c38207329af61709d071f2a80eec528ce6c7e701164

data/README.md

@@ -594,8 +594,74 @@ You will need an external IP address to work with these sandboxes.
 
 We suggest the free application `https://ngrok.com/` for this ability.
 
+## Paying with Moneris Checkout
 
-## Paying via Moneris
+Use the following instructions to set up a Moneris Checkout store.
+
+This is the javascript / pay in place form implementation.
+
+We do not use or implement tokenization of credentials with Moneris Checkout.
+
+We are also going to use ngrok to give us a public facing URL
+
+### Create Test / Development Store
+
+Visit https://esqa.moneris.com/mpg/ and login with: demouser / store1 / password
+
+- Select Admin -> Moneris Checkout Config from the menu
+- Click Create Profile
+
+Checkout Type: I have my custom order form and want to use Moneris simply for payment processing
+
+Multi-Currency: None
+
+Payment:
+
+- Google Pay: No
+- Card Logos: Yes
+- Payment Security: CVV
+- Transaction Type: Purchase
+- Transaction Limits: None
+
+Branding & Design
+
+- Logo Url: None
+- Colors: Default
+
+Customizations
+
+- Enable Fullscreen: No false (important)
+- Card Borders/Shadows: Yes
+
+Order Confirmation
+
+- Order Confirmation Processing: Use Moneris
+- Confirmation Page Content: Check all
+
+Email Communications
+
+- None
+- Customer Emails: None
+
+
+Now copy the Checkout id, something like `chktJF76Btore1` into the config/initializers/effective_orders.rb file.
+
+For the store_id and api_token values, you can use
+
+```
+config.moneris_checkout = {
+  environment: 'qa',
+  store_id: 'store1',
+  api_token: 'yesguy1',
+  checkout_id: '',  # You need to generate this one
+}
+```
+
+[Testing a Solution](https://developer.moneris.com/en/More/Testing/Testing%20a%20Solution)
+
+
+
+## Paying via Moneris (hosted pay page - old)
 
 Use the following instructions to set up a Moneris TEST store.
 

data/app/assets/config/effective_orders_manifest.js

@@ -0,0 +1,3 @@
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link_directory ../images/effective_orders

data/app/assets/javascripts/effective_orders.js

@@ -2,5 +2,5 @@
 
 //= require ./effective_orders/customers
 //= require ./effective_orders/subscriptions
-//= require_tree ./effective_orders/providers
 
+//= require_tree ./effective_orders/providers

data/app/assets/javascripts/effective_orders/providers/moneris_checkout.js.coffee

@@ -0,0 +1,71 @@
+this.MonerisCheckoutForm ||= class MonerisCheckoutForm
+  constructor: ->
+    @form = null
+    @data = null
+    @moneris = null
+
+  initialize: ->
+    @form = $('form[data-moneris-checkout-form]:not(.initialized)').first()
+    return false unless @form.length > 0
+
+    @data = @form.data('moneris-checkout-form')
+    @moneris = new monerisCheckout()
+
+    @mount()
+    @form.addClass('initialized')
+
+  mount: ->
+    @moneris.setCheckoutDiv('monerisCheckout')
+
+    @moneris.setCallback('page_loaded', @pageLoaded)
+    @moneris.setCallback('cancel_transaction', @cancelTransaction)
+    @moneris.setCallback('error_event', @errorEvent)
+    @moneris.setCallback('payment_receipt', @paymentReceipt)
+    @moneris.setCallback('payment_complete', @paymentComplete)
+
+    @moneris.setMode(@data.environment)
+    @moneris.startCheckout(@data.ticket)
+
+  success: (payload) ->
+    @moneris.closeCheckout()
+
+    payment = JSON.parse(payload)
+    @form.find('#moneris-checkout-success').html("Transaction complete! Please wait a moment...")
+    @form.find("input[name$='[ticket]']").first().val(payment['ticket'])
+    @form.submit()
+
+  error: (text) ->
+    @moneris.closeCheckout()
+
+    text = "<p>" + text + "<p>Please <a href='#', onclick='window.location.reload();' class='alert-link'>reload the page</a> and try again.</p>"
+    @form.find('#moneris-checkout-error').addClass('alert').html(text)
+    EffectiveForm.invalidate(@form)
+
+  # Moneris iframe has loaded
+  pageLoaded: (payload) =>
+    preload = JSON.parse(payload)
+
+    switch preload['response_code']
+      when '001'
+        true # Success. Nothing to do.
+      when '902'
+        @error('3-D secure failed on response')
+      when '2001'
+        @error('Invalid ticket/ticket re-use')
+      else
+        @error('Unknown payment gateway preload status')
+
+  # Cancel Button
+  cancelTransaction: (payload) => false
+
+  # Any kind of error
+  errorEvent: (payload) =>
+    error = JSON.parse(payload)
+    @error("A payment gateway error #{error['response_code']} has occurred. Your card has not been charged.")
+
+  # Payment is all done
+  paymentReceipt: (payload) => @success(payload)
+  paymentComplete: (payload) => @success(payload)
+
+$ -> (new MonerisCheckoutForm()).initialize()
+$(document).on 'turbolinks:load', -> (new MonerisCheckoutForm()).initialize()

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

@@ -45,6 +45,10 @@ form.new_effective_order {
   a.remove_fields.dynamic { float: right; }
 }
 
+.effective-moneris-checkout {
+  height: 640px;
+}
+
 @media print {
   .effective-orders-page-content { display: none; }
 

data/app/controllers/effective/concerns/purchase.rb

@@ -5,28 +5,21 @@ module Effective
 
       protected
 
-      def order_purchased(payment:, provider:, card: 'none', email: true, skip_buyer_validations: false, purchased_url: nil, declined_url: nil)
-        begin
-          @order.purchase!(payment: payment, provider: provider, card: card, email: email, skip_buyer_validations: skip_buyer_validations)
-
-          Effective::Cart.where(user: @order.user).destroy_all
-
-          if flash[:success].blank?
-            if EffectiveOrders.mailer[:send_order_receipt_to_buyer] && email
-              flash[:success] = "Payment successful! A receipt has been sent to #{@order.emails_send_to}"
-            else
-              flash[:success] = "Payment successful! An email receipt has not been sent."
-            end
-          end
+      def order_purchased(payment:, provider:, card: 'none', email: true, skip_buyer_validations: false, purchased_url: nil)
+        @order.purchase!(payment: payment, provider: provider, card: card, email: email, skip_buyer_validations: skip_buyer_validations)
 
-          purchased_url ||= effective_orders.purchased_order_path(':id')
-          redirect_to purchased_url.gsub(':id', @order.to_param.to_s)
-        rescue => e
-          flash[:danger] = "An error occurred while processing your payment: #{e.message}. Please try again."
+        Effective::Cart.where(user: @order.user).destroy_all
 
-          declined_url ||= effective_orders.declined_order_path(':id')
-          redirect_to declined_url.gsub(':id', @order.to_param.to_s)
+        if flash[:success].blank?
+          if email && EffectiveOrders.mailer[:send_order_receipt_to_buyer]
+            flash[:success] = "Payment successful! A receipt has been sent to #{@order.emails_send_to}"
+          else
+            flash[:success] = "Payment successful! An email receipt has not been sent."
+          end
         end
+
+        purchased_url = effective_orders.purchased_order_path(':id') if purchased_url.blank?
+        redirect_to purchased_url.gsub(':id', @order.to_param.to_s)
       end
 
       def order_deferred(provider:, email: true, deferred_url: nil)
@@ -42,7 +35,7 @@ module Effective
           end
         end
 
-        deferred_url ||= effective_orders.deferred_order_path(':id')
+        deferred_url = effective_orders.deferred_order_path(':id') if deferred_url.blank?
         redirect_to deferred_url.gsub(':id', @order.to_param.to_s)
       end
 
@@ -53,7 +46,7 @@ module Effective
           flash[:danger] = 'Payment was unsuccessful. Your credit card was declined by the payment processor. Please try again.'
         end
 
-        declined_url ||= effective_orders.declined_order_path(':id')
+        declined_url = effective_orders.declined_order_path(':id') if declined_url.blank?
         redirect_to declined_url.gsub(':id', @order.to_param.to_s)
       end
 

data/app/controllers/effective/orders_controller.rb

@@ -1,19 +1,19 @@
 module Effective
   class OrdersController < ApplicationController
+    include Effective::CrudController
     include Concerns::Purchase
 
     include Providers::Cheque
     include Providers::Free
     include Providers::MarkAsPaid
     include Providers::Moneris
+    include Providers::MonerisCheckout
     include Providers::Paypal
     include Providers::Phone
     include Providers::Pretend
     include Providers::Refund
     include Providers::Stripe
 
-    include Effective::CrudController
-
     if (config = EffectiveOrders.layout)
       layout(config.kind_of?(Hash) ? (config[:orders] || config[:application]) : config)
     end

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

@@ -21,7 +21,6 @@ module Effective
           provider: 'free',
           card: 'none',
           purchased_url: free_params[:purchased_url],
-          declined_url: free_params[:declined_url],
           email: false
         )
       end

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

@@ -19,8 +19,7 @@ module Effective
           card: mark_as_paid_params[:payment_card],
           email: @order.send_mark_as_paid_email_to_buyer?,
           skip_buyer_validations: true,
-          purchased_url: effective_orders.admin_order_path(@order),
-          declined_url: effective_orders.admin_order_path(@order)
+          purchased_url: effective_orders.admin_order_path(@order)
         )
       end
 

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

@@ -0,0 +1,59 @@
+module Effective
+  module Providers
+    module MonerisCheckout
+      extend ActiveSupport::Concern
+
+      def moneris_checkout
+        raise('moneris_checkout provider is not available') unless EffectiveOrders.moneris_checkout?
+
+        @order = Order.find(params[:id])
+        (EffectiveResources.authorize!(self, :update, @order) rescue false)
+
+        payment = moneris_checkout_receipt_request(moneris_checkout_params[:ticket])
+        purchased = (1..49).include?(payment['response_code'].to_i) # Must be > 0 and < 50 to be valid. Sometimes we get the string 'null'
+
+        if purchased == false
+          return order_declined(
+            payment: payment,
+            provider: 'moneris_checkout',
+            declined_url: moneris_checkout_params[:declined_url]
+          )
+        end
+
+        order_purchased(
+          payment: payment,
+          provider: 'moneris_checkout',
+          card: payment['card_type'],
+          purchased_url: moneris_checkout_params[:purchased_url]
+        )
+      end
+
+      private
+
+      def moneris_checkout_params
+        params.require(:moneris_checkout).permit(:ticket, :purchased_url, :declined_url)
+      end
+
+      def moneris_checkout_receipt_request(ticket)
+        params = {
+          environment: EffectiveOrders.moneris_checkout.fetch(:environment),
+
+          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: :receipt,
+          ticket: ticket
+        }
+
+        response = Effective::Http.post(EffectiveOrders.moneris_request_url, params: params)
+        response = response['response'] if response
+
+        raise("moneris receipt error #{response}") unless response && response['success'].to_s == 'true'
+
+        response.dig('receipt', 'cc') || response.dig('receipt', 'gift') || response
+      end
+
+    end
+  end
+end

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

@@ -14,8 +14,7 @@ module Effective
           payment: 'for pretend',
           provider: 'pretend',
           card: 'none',
-          purchased_url: pretend_params[:purchased_url],
-          declined_url: pretend_params[:declined_url]
+          purchased_url: pretend_params[:purchased_url]
         )
       end
 

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

@@ -21,8 +21,7 @@ module Effective
         order_purchased(
           payment: 'refund. no payment required.',
           provider: 'refund',
-          purchased_url: refund_params[:purchased_url],
-          declined_url: refund_params[:declined_url]
+          purchased_url: refund_params[:purchased_url]
         )
       end
 

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

@@ -26,8 +26,7 @@ module Effective
           payment: payment,
           provider: 'stripe',
           card: payment[:card],
-          purchased_url: stripe_params[:purchased_url],
-          declined_url: stripe_params[:declined_url]
+          purchased_url: stripe_params[:purchased_url]
         )
       end
 

data/app/datatables/admin/effective_orders_datatable.rb

@@ -14,12 +14,12 @@ class Admin::EffectiveOrdersDatatable < Effective::Datatable
   end
 
   filters do
-    if attributes[:user_id].blank? && attributes[:parent_id].blank?
-      scope :purchased, default: true
+    unless attributes[:skip_filters]
+      scope :all
+      scope :purchased
       scope :deferred
       scope :refunds
       scope :not_purchased
-      scope :all
     end
   end
 
@@ -84,13 +84,14 @@ class Admin::EffectiveOrdersDatatable < Effective::Datatable
   end
 
   collection do
-    scope = Effective::Order.all.includes(:addresses, :order_items, :user)
+    scope = Effective::Order.all.deep
 
     if EffectiveOrders.orders_collection_scope.respond_to?(:call)
       scope = EffectiveOrders.orders_collection_scope.call(scope)
     end
 
     if attributes[:user_id].present?
+      user = current_user.class.find(attributes[:user_id])
       scope = scope.where(user: user)
     end
 
@@ -101,8 +102,4 @@ class Admin::EffectiveOrdersDatatable < Effective::Datatable
     scope
   end
 
-  def user
-    @user ||= current_user.class.find(attributes[:user_id])
-  end
-
 end

data/app/datatables/effective_orders_datatable.rb

@@ -6,8 +6,6 @@ class EffectiveOrdersDatatable < Effective::Datatable
       scope :purchased, default: true
       scope :deferred
       scope :refunds
-      scope :not_purchased
-      scope :all
     end
   end
 
@@ -61,7 +59,9 @@ class EffectiveOrdersDatatable < Effective::Datatable
   end
 
   collection do
-    scope = Effective::Order.all.where(user: user).includes(:addresses, :order_items, :user)
+    user = current_user.class.find(attributes[:user_id])
+
+    scope = Effective::Order.all.deep.where(user: user)
 
     if EffectiveOrders.orders_collection_scope.respond_to?(:call)
       scope = EffectiveOrders.orders_collection_scope.call(scope)
@@ -78,8 +78,4 @@ class EffectiveOrdersDatatable < Effective::Datatable
     scope
   end
 
-  def user
-    @user ||= current_user.class.find(attributes[:user_id])
-  end
-
 end