effective_orders 5.8.1 → 5.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90e5e07bb9f141ffa7bfc4b43417e8cb1aedc08768e02c9b5dafb63d1434a40e
-  data.tar.gz: aa819e0ad7f7d949abe6510b74c8a614f0639e9a2f3727c18f8350b264b6bc86
+  metadata.gz: 03a959b70b778d7a61499dcaec401c812b0fda1685fbbf9593fb75dd12aa21b6
+  data.tar.gz: 79f227bd79c340bfe03e37db465dc85addeecf36ab33c3b4977e85ad8bc46a53
 SHA512:
-  metadata.gz: b93e4a1ec80c04b9e507157feb1a92c6443b22d5729800cffca1bcf2f2c52aab4a484e667e31798b8a3d165462bff4454a3099c81818b015b546f708bd5fc3ad
-  data.tar.gz: cd59f3b82d0bc1500ab9b64bf2a0e8789d0dda0bc12cc6f9f068e15e071881b3b61fca7f2f32c954d63e764b68ea6649f14418a2de35d9bfa4cb3a7970139840
+  metadata.gz: 10f7edcd5aa36dfcc1a37802453c781e6e40818747818e14a09994ded71d53021fb4e0218dc5302c15ff952fe4f9272ae846d0b5dce5d897bba530c1e561e51a
+  data.tar.gz: 7450d630b12ae7755093f99239e759f88d0b3ff077bd04cf1a7eb9c9c740dd3d62c5d22db5649d6f594e6299d7162d7936ede470de24a3648008bf11bc9ecdd6

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?) || 'not purchased'
     end
 
     if attributes[:user_id].blank?

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
@@ -524,7 +538,7 @@ module Effective
 
         payment_provider: provider,
         payment_card: (card.presence || 'none'),
-        purchased_at: Time.zone.now,
+        purchased_at: (purchased_at.presence || Time.zone.now),
         payment: payment_to_h(payment)
       )
 
@@ -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/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/mark_as_paid/_form.html.haml

@@ -5,17 +5,19 @@
       = order.refund? ? 'Complete Refund' : 'Mark as Paid'
 
     = effective_form_with(model: order, url: effective_orders.mark_as_paid_order_path(order), method: :post) do |f|
-      = f.hidden_field :purchased_at, value: Time.zone.now
+      .row
+        .col-6
+          = f.select :payment_provider, EffectiveOrders.admin_payment_providers, required: true
 
-      = f.select :payment_provider, EffectiveOrders.admin_payment_providers, required: true
+          = f.text_field :payment_card,
+            label: 'Payment card type, cheque, e-transfer or transaction number',
+            hint: 'Do not enter credit card numbers here, or anywhere.'
 
-      = f.text_field :payment_card,
-        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, label: 'Purchased or completed'
 
-      = f.check_box :send_mark_as_paid_email_to_buyer,
-        label: 'Yes, send a receipt email to the buyer.',
-        input_html: { checked: (f.object.send_mark_as_paid_email_to_buyer.nil? ? EffectiveOrders.send_order_receipts_when_mark_as_paid : f.object.send_mark_as_paid_email_to_buyer?) }
+          = f.check_box :send_mark_as_paid_email_to_buyer,
+            label: 'Yes, send a receipt email to the buyer.',
+            input_html: { checked: (f.object.send_mark_as_paid_email_to_buyer.nil? ? EffectiveOrders.send_order_receipts_when_mark_as_paid : f.object.send_mark_as_paid_email_to_buyer?) }
 
       .row
         .col
@@ -23,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/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/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.1'.freeze
+  VERSION = '5.9.0'.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.1
+  version: 5.9.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-20 00:00:00.000000000 Z
+date: 2022-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails