effective_orders 5.8.2 → 5.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88341609720b1eea6a41fbe9aef2556b14791e12072e195f966d17460355d26d
-  data.tar.gz: dcb1636b46c9b788a925e36708f6d1aebb433424eaac25657773bc4e04aba6e4
+  metadata.gz: 460e5652f16e49b5751f29cecd6d1cd41f8b92c5d9cb10d36f8f7f863fad9ca5
+  data.tar.gz: d2f4c23a86b09022a38779718232ebe2b5226c5e1ca03b9286a6cf6a3504564e
 SHA512:
-  metadata.gz: b23cfd1c483fae1ed2387ce838b8cace69bbde2c925bb97057c4e1b58836f0f50b65b2e523de335ff856295b49125c5e68ddf93f9a0eb159a2728e4dd48d8550
-  data.tar.gz: 8db2613a663b3ed0fb929f717ba95a04470fdbbe1d836823650c6294e4d7f0021922b62a8ed0afa3a2da9dc8f35517ec4708041d40d567c16a44ac3f261b75f4
+  metadata.gz: cee63481230c23907ef97547657e402d566b09c0f030fb4bae984608f352ca9a7715beedf5ccc6b7cba9e0f3ef96c4f550dd55d9ca50d57d7051a3e173316143
+  data.tar.gz: fee709031224ca9818f454f73c7781dfb1259ec1bca86938b6f31450f3d1dddb2d71ae1521ad8fc7d026c405cac078fe5cb81ab1a6a18b7b1c309a241c2d0e2e

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

@@ -5,6 +5,7 @@ module Effective
 
       def refund
         raise('refund provider is not available') unless EffectiveOrders.refund?
+        raise('refund provider is not configured for buyer purchase') unless EffectiveOrders.buyer_purchases_refund?
 
         @order ||= Order.find(params[:id])
 

data/app/datatables/admin/effective_orders_datatable.rb

@@ -19,6 +19,8 @@ class Admin::EffectiveOrdersDatatable < Effective::Datatable
       scope :purchased
 
       scope :deferred if EffectiveOrders.deferred_providers.present?
+
+      scope :pending_refunds if EffectiveOrders.refund && !EffectiveOrders.buyer_purchases_refund?
       scope :refunds if EffectiveOrders.refund
 
       scope :not_purchased
@@ -38,7 +40,7 @@ class Admin::EffectiveOrdersDatatable < Effective::Datatable
     end
 
     col :purchased_at do |order|
-      order.purchased_at&.strftime('%F %H:%M') || 'not purchased'
+      order.purchased_at&.strftime('%F %H:%M') || ('pending refund' if order.pending_refund?) || ("pending #{order.payment_provider}" if order.deferred?) || 'not purchased'
     end
 
     if attributes[:user_id].blank?
@@ -64,6 +66,7 @@ class Admin::EffectiveOrdersDatatable < Effective::Datatable
     end
 
     col :payment_method
+    col :payment_provider
 
     col :subtotal, as: :price, visible: false
     col :tax, as: :price, visible: false

data/app/models/concerns/acts_as_purchasable.rb

@@ -1,3 +1,15 @@
+# Acts as purchasable
+# Add to your model:
+# t.integer :purchased_order_id
+# t.integer :price
+# t.boolean :tax_exempt, default: false
+# t.string :qb_item_name
+# or
+# add_column :resources, :purchased_order_id, :integer
+# add_column :resources, :price, :integer
+# add_column :resources, :tax_exempt, :boolean, default: false
+# add_column :resources, :qb_item_name, :string
+
 module ActsAsPurchasable
   extend ActiveSupport::Concern
 

data/app/models/effective/order.rb

@@ -75,7 +75,9 @@ module Effective
     scope :deferred, -> { where(state: EffectiveOrders::DEFERRED) }
     scope :declined, -> { where(state: EffectiveOrders::DECLINED) }
     scope :abandoned, -> { where(state: EffectiveOrders::ABANDONED) }
+
     scope :refunds, -> { purchased.where('total < ?', 0) }
+    scope :pending_refunds, -> { not_purchased.where('total < ?', 0) }
 
     before_validation do
       self.state ||= EffectiveOrders::PENDING
@@ -445,6 +447,13 @@ module Effective
       total.to_i < 0
     end
 
+    def pending_refund?
+      return false if EffectiveOrders.buyer_purchases_refund?
+      return false if purchased?
+
+      refund?
+    end
+
     def num_items
       present_order_items.map { |oi| oi.quantity }.sum
     end
@@ -466,6 +475,11 @@ module Effective
       EffectiveResources.truthy?(send_payment_request_to_buyer)
     end
 
+    def send_refund_notification_to_admin?
+      return false unless refund?
+      EffectiveOrders.send_refund_notification_to_admin
+    end
+
     def send_mark_as_paid_email_to_buyer?
       EffectiveResources.truthy?(send_mark_as_paid_email_to_buyer)
     end
@@ -622,7 +636,7 @@ module Effective
     def send_order_receipts!
       send_order_receipt_to_admin! if send_order_receipt_to_admin?
       send_order_receipt_to_buyer! if send_order_receipt_to_buyer?
-      send_refund_notification! if refund?
+      send_refund_notification! if send_refund_notification_to_admin?
     end
 
     def send_order_receipt_to_admin!
@@ -642,7 +656,7 @@ module Effective
     end
 
     def send_refund_notification!
-      EffectiveOrders.send_email(:refund_notification_to_admin, self) if purchased? && refund?
+      EffectiveOrders.send_email(:refund_notification_to_admin, self) if refund?
     end
 
     protected

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

@@ -8,7 +8,7 @@
     = dropdown_link_to 'Email receipt to buyer', effective_orders.send_buyer_receipt_order_path(order),
       data: { method: :post, confirm: "Send receipt to #{order.emails_send_to}?" }
 
-  - if order.pending? || order.confirmed? || order.deferred?
+  - if (order.pending? || order.confirmed? || order.deferred?) && !order.refund?
     = dropdown_link_to 'Email request for payment to buyer', effective_orders.send_payment_request_admin_order_path(order),
       data: { method: :post, confirm: "Send request for payment to #{order.emails_send_to}?" }
 

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

@@ -0,0 +1,2 @@
+.effective-orders
+  = yield

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

@@ -1,3 +1,4 @@
-%h1.effective-admin-heading= @page_title
+= render 'layout' do
+  %h1.effective-admin-heading= @page_title
 
-= render_checkout(@order, namespace: :admin, purchased_url: effective_orders.admin_order_path(@order), declined_url: effective_orders.admin_order_path(@order))
+  = render_checkout(@order, namespace: :admin, purchased_url: effective_orders.admin_order_path(@order), declined_url: effective_orders.admin_order_path(@order))

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

@@ -1,15 +1,16 @@
-%h1.effective-admin-heading= @page_title
+= render 'layout' do
+  %h1.effective-admin-heading= @page_title
 
-- if @order.custom_order? && @order.in_progress?
-  = render 'effective/orders/order_actions', order: @order
+  - if @order.custom_order? && @order.in_progress?
+    = render 'effective/orders/order_actions', order: @order
 
-  .mb-4
-    = collapse('show order') do
-      = render 'effective/orders/order', order: @order, no_order_actions: true
+    .mb-4
+      = collapse('show order') do
+        = render 'effective/orders/order', order: @order, no_order_actions: true
 
-  = render 'admin/orders/form', order: @order
+    = render 'admin/orders/form', order: @order
 
-- else
-  - # Same as the show action
-  = render 'effective/orders/order', order: @order
-  = render 'admin/orders/form_note_internal', order: @order
+  - else
+    - # Same as the show action
+    = render 'effective/orders/order', order: @order
+    = render 'admin/orders/form_note_internal', order: @order

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

@@ -1,6 +1,7 @@
-%h1.effective-admin-heading= @page_title
+= render 'layout' do
+  %h1.effective-admin-heading= @page_title
 
-%p.text-right.effective-admin-actions
-  = link_to 'New Order', effective_orders.new_admin_order_path, class: 'btn btn-primary'
+  %p.text-right.effective-admin-actions
+    = link_to 'New Order', effective_orders.new_admin_order_path, class: 'btn btn-primary'
 
-= render_datatable @datatable
+  = render_datatable @datatable

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

@@ -1,3 +1,4 @@
-%h1.effective-admin-heading= @page_title
+= render 'layout' do
+  %h1.effective-admin-heading= @page_title
 
-= render 'admin/orders/form', order: @order
+  = render 'admin/orders/form', order: @order

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

@@ -1,4 +1,5 @@
-%h1.effective-admin-heading= @page_title
+= render 'layout' do
+  %h1.effective-admin-heading= @page_title
 
-= render 'effective/orders/order', order: @order
-= render 'admin/orders/form_note_internal', order: @order
+  = render 'effective/orders/order', order: @order
+  = render 'admin/orders/form_note_internal', order: @order

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

@@ -0,0 +1,2 @@
+.effective-orders
+  = yield

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

@@ -15,9 +15,10 @@
       - if params[:action] == 'edit'
         = link_to('Show', effective_orders.admin_order_path(order), class: 'btn btn-primary')
 
-      = link_to 'Email request for payment to buyer', effective_orders.send_payment_request_admin_order_path(order),
-        class: 'btn btn-secondary',
-        data: { method: :post, confirm: "Send request for payment to #{order.emails_send_to}?" }
+      - unless order.refund?
+        = link_to 'Email request for payment to buyer', effective_orders.send_payment_request_admin_order_path(order),
+          class: 'btn btn-secondary',
+          data: { method: :post, confirm: "Send request for payment to #{order.emails_send_to}?" }
 
       = link_to 'Delete', effective_orders.admin_order_path(order),
         class: 'btn btn-danger',

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

@@ -1,10 +1,11 @@
-%h1.effective-heading= @page_title
+= render 'layout' do
+  %h1.effective-heading= @page_title
 
-%p.effective-orders-page-content
-  - if current_cart.present?
-    Your #{link_to_current_cart(label: 'Cart')} items have been saved. Please try again.
-  - else
-    Please try again.
+  %p.effective-orders-page-content
+    - if current_cart.present?
+      Your #{link_to_current_cart(label: 'Cart')} items have been saved. Please try again.
+    - else
+      Please try again.
 
-%p.text-center
-  = link_to 'Continue', root_path, class: 'btn btn-primary'
+  %p.text-center
+    = link_to 'Continue', root_path, class: 'btn btn-primary'

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

@@ -1,11 +1,12 @@
-%h1.effective-heading= @page_title
+= render 'layout' do
+  %h1.effective-heading= @page_title
 
-%p.effective-orders-page-content
-  You have indicated that this order will be paid by #{@order.payment_provider}.
-  Your order will not be considered purchased until we receive your payment.
-  Please contact us at your earliest convenience.
+  %p.effective-orders-page-content
+    You have indicated that this order will be paid by #{@order.payment_provider}.
+    Your order will not be considered purchased until we receive your payment.
+    Please contact us at your earliest convenience.
 
-= render @order
+  = render @order
 
-%p.text-center
-  = link_to 'Continue', root_path, class: 'btn btn-primary'
+  %p.text-center
+    = link_to 'Continue', root_path, class: 'btn btn-primary'

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

@@ -1,3 +1,4 @@
-%h1.effective-heading= @page_title
+= render 'layout' do
+  %h1.effective-heading= @page_title
 
-= render_checkout_step1(@order)
+  = render_checkout_step1(@order)

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

@@ -1,3 +1,4 @@
-%h1.effective-heading= @page_title
+= render 'layout' do
+  %h1.effective-heading= @page_title
 
-= render_datatable(@datatable)
+  = render_datatable(@datatable)

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

@@ -13,7 +13,7 @@
             label: 'Payment card type, cheque, e-transfer or transaction number',
             hint: 'Do not enter credit card numbers here, or anywhere.'
 
-          = f.datetime_field :purchased_at
+          = f.datetime_field :purchased_at, label: 'Purchased or completed'
 
           = f.check_box :send_mark_as_paid_email_to_buyer,
             label: 'Yes, send a receipt email to the buyer.',
@@ -25,4 +25,5 @@
         .col
           = f.text_area :note_internal, hint: 'For or internal admin use only. This note will never be displayed to the buyer.'
 
-      = f.submit order_checkout_label(order.refund? ? :refund : :mark_as_paid)
+      = f.submit(center: true) do
+        = f.save(order.refund? ? 'Complete Refund' : 'Mark as Paid')

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

@@ -1,3 +1,4 @@
-%h1.effective-heading= @page_title
+= render 'layout' do
+  %h1.effective-heading= @page_title
 
-= render_checkout_step1(@order)
+  = render_checkout_step1(@order)

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

@@ -1,9 +1,10 @@
-%h1.effective-heading= @page_title
+= render 'layout' do
+  %h1.effective-heading= @page_title
 
-%p.effective-orders-page-content
-  You have successfully purchased the following:
+  %p.effective-orders-page-content
+    You have successfully purchased the following:
 
-= render @order
+  = render @order
 
-%p.text-center
-  = link_to 'Continue', root_path, class: 'btn btn-primary'
+  %p.text-center
+    = link_to 'Continue', root_path, class: 'btn btn-primary'

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

@@ -1,5 +1,10 @@
-= effective_form_with(scope: :refund, url: effective_orders.refund_order_path(order), method: :post) do |f|
-  = f.hidden_field :purchased_url, value: purchased_url
-  = f.hidden_field :declined_url, value: declined_url
+- if EffectiveOrders.buyer_purchases_refund?
+  = effective_form_with(scope: :refund, url: effective_orders.refund_order_path(order), method: :post) do |f|
+    = f.hidden_field :purchased_url, value: purchased_url
+    = f.hidden_field :declined_url, value: declined_url
 
-  = f.submit order_checkout_label(:refund), center: true, border: false
+    = f.submit order_checkout_label(:refund), center: true, border: false
+
+- else
+  .text-center
+    = EffectiveOrders.refund[:pending].presence || 'Refund pending'

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

@@ -1,9 +1,10 @@
-%h1.effective-heading= @page_title
+= render 'layout' do
+  %h1.effective-heading= @page_title
 
-- if !@order.purchased? && @order.user == current_user
-  = render_checkout(@order)
-- else
-  = render(@order)
+  - if !@order.purchased? && @order.user == current_user
+    = render_checkout(@order)
+  - else
+    = render(@order)
 
-  %p.text-center
-    = link_to 'Continue', effective_orders.orders_path, class: 'btn btn-primary'
+    %p.text-center
+      = link_to 'Continue', effective_orders.orders_path, class: 'btn btn-primary'

data/config/effective_orders.rb

@@ -95,6 +95,8 @@ EffectiveOrders.setup do |config|
   config.send_payment_request_to_buyer = true
   config.send_pending_order_invoice_to_buyer = true
 
+  config.send_refund_notification_to_admin = true
+
   config.send_order_receipts_when_mark_as_paid = true
   config.send_order_receipts_when_free = true
 
@@ -201,17 +203,33 @@ EffectiveOrders.setup do |config|
   #   success: 'Thank you! You have indicated that this order will be purchased by phone. Please give us a call at your earliest convenience.'
   # }
 
-
   # Refunds
   # This does not issue a refund with the payment processor at all.
-  # Instead, we mark the order as purchased, create a refund object to track it, and
-  # send an email to config.mailer_admin with instructions to issue a refund
+  #
+  # The historic way of doing refunds was the user would click Accept Refund
+  # Which marks the order as purchased and sends an admin the notification to issue a refund with processor
+  # To support this, set:
+  # config.buyer_purchases_refund = true
+  # config.send_refund_notification_to_admin = true
+  #
+  # The newer way of doing refunds is driven by the admin
+  # The user just sees a pending refund and cannot purchase the order
+  # The admin does the refund with processor, then uses Admin: Mark as Paid to mark order as purchased thereby completing the refund
+  # To support this, set:
+  # config.buyer_purchases_refund = false
+  # config.send_refund_notification_to_admin = false
+  #
+  # You can call order.send_refund_notification! directly or implement a better one in your app
   config.refund = false
 
   # config.refund = {
-  #   success: 'Thank you! Your refund will be processed in the next few business days.'
+  #   success: 'Thank you! Your refund will be processed in the next few business days.',
+  #   pending: 'Thank you! Your refund will be processed in the next few business days.'
   # }
 
+  config.buyer_purchases_refund = true
+  config.send_refund_notification_to_admin = true  # On Purchase
+
   # Stripe
   config.stripe = false
 

data/lib/effective_orders/version.rb

@@ -1,3 +1,3 @@
 module EffectiveOrders
-  VERSION = '5.8.2'.freeze
+  VERSION = '5.9.1'.freeze
 end

data/lib/effective_orders.rb

@@ -48,9 +48,10 @@ module EffectiveOrders
       :send_order_receipts_when_mark_as_paid, :send_order_receipts_when_free,
       :send_subscription_events,
       :send_subscription_trialing, :send_subscription_trial_expired,
+      :send_refund_notification_to_admin,
 
       # Features
-      :free_enabled, :mark_as_paid_enabled, :pretend_enabled, :pretend_message,
+      :free_enabled, :mark_as_paid_enabled, :pretend_enabled, :pretend_message, :buyer_purchases_refund,
 
       # Payment processors. false or Hash
       :cheque, :etransfer, :moneris, :moneris_checkout, :paypal, :phone, :refund, :stripe, :subscriptions, :trial
@@ -112,6 +113,10 @@ module EffectiveOrders
     refund.kind_of?(Hash)
   end
 
+  def self.buyer_purchases_refund?
+    buyer_purchases_refund == true
+  end
+
   def self.stripe?
     stripe.kind_of?(Hash)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_orders
 version: !ruby/object:Gem::Version
-  version: 5.8.2
+  version: 5.9.1
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-05 00:00:00.000000000 Z
+date: 2022-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -236,6 +236,7 @@ files:
 - app/views/admin/orders/_datatable_actions.html.haml
 - app/views/admin/orders/_form.html.haml
 - app/views/admin/orders/_form_note_internal.html.haml
+- app/views/admin/orders/_layout.html.haml
 - app/views/admin/orders/_order_actions.html.haml
 - app/views/admin/orders/_order_item_fields.html.haml
 - app/views/admin/orders/checkout.html.haml
@@ -257,6 +258,7 @@ files:
 - app/views/effective/orders/_fields.html.haml
 - app/views/effective/orders/_fields_note.html.haml
 - app/views/effective/orders/_fields_terms.html.haml
+- app/views/effective/orders/_layout.html.haml
 - app/views/effective/orders/_order.html.haml
 - app/views/effective/orders/_order_actions.html.haml
 - app/views/effective/orders/_order_deferred.html.haml