effective_orders 4.3.2 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbc56753acb82a9f43d3c6cd058e4351cf54ee58d4df9fad0f266bb88d40af19
-  data.tar.gz: 4537fe9ccd27a6aeb1d659bedbe620e8e85d17f78f76609396c5fb05a4e79dc8
+  metadata.gz: a3c5dc28f41342a9aaa1a3bb051ffba863a967ad6ffc29f4b7e314b699a8a840
+  data.tar.gz: a79cb8afd1238efee7e12fd2817900e6f68244bd420b5d0fa0a41d4bad634193
 SHA512:
-  metadata.gz: 46733ccd15b8de247c865c88df956deb0e66234ca614aab1db0b79e60fade92c7b18c98b06ab508e6776d55cbf83c9dae6c7bf17b6598747f8739d019b17e382
-  data.tar.gz: bb9b03c81ed435ffd7dfe7320c975f0d76d86e45ec6e149b0667e6094107505cb0e9abcbefaa9cb8e2af3707e77aa29b1a2b1466dfc65dbc8fc5cc1ade3f8f81
+  metadata.gz: 86af0e572fc9e7dbfec253786dd984f342bd926e5b4ecf5edc7ed7cc90a29478c8de6ee353c936aa0b87c9602cdbb99e136f53ed28da3a3818e260c7293f2e12
+  data.tar.gz: 2cafc367de7ffaedd679581bc969e3a98637ce4125ad3641b52c721743ef0b89a2c3abedd3fa31a73173cea2b04727d2bdcc866ac7c29eed63e56d06588b8248

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

@@ -11,12 +11,12 @@ module Effective
 
           Effective::Cart.where(user_id: @order.user_id).destroy_all
 
-          if EffectiveOrders.mailer[:send_order_receipt_to_buyer] && email
-            flash[:success] = "Payment successful! A receipt has been sent to #{@order.user.email}"
-          elsif @order.free?
-            # Nothing
-          else
-            flash[:success] = 'Payment successful! An email receipt has not been sent.'
+          unless flash[:success]
+            if EffectiveOrders.mailer[:send_order_receipt_to_buyer] && email
+              flash[:success] = "Payment successful! A receipt has been sent to #{@order.user.email}"
+            else
+              flash[:success] = "Payment successful! An email receipt has not been sent."
+            end
           end
 
           redirect_to (purchased_url.presence || effective_orders.purchased_order_path(':id')).gsub(':id', @order.to_param.to_s)

data/app/controllers/effective/orders_controller.rb

@@ -8,7 +8,7 @@ module Effective
     include Providers::Moneris if EffectiveOrders.moneris?
     include Providers::Paypal if EffectiveOrders.paypal?
     include Providers::Pretend if EffectiveOrders.pretend?
-    include Providers::Refund if EffectiveOrders.refunds?
+    include Providers::Refund if EffectiveOrders.refund?
     include Providers::Stripe if EffectiveOrders.stripe?
 
     layout (EffectiveOrders.layout.kind_of?(Hash) ? EffectiveOrders.layout[:orders] : EffectiveOrders.layout)

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

@@ -18,14 +18,14 @@ module Effective
           payment: 'free order. no payment required.',
           provider: 'free',
           card: 'none',
-          purchased_url: params[:purchased_url],
-          declined_url: params[:declined_url],
+          purchased_url: free_params[:purchased_url],
+          declined_url: free_params[:declined_url],
           email: false
         )
       end
 
       def free_params
-        params.require(:effective_order).permit(:purchased_url, :declined_url)
+        params.require(:free).permit(:purchased_url, :declined_url)
       end
 
     end

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

@@ -7,31 +7,25 @@ module Effective
         @order ||= Order.find(params[:id])
 
         EffectiveOrders.authorize!(self, :update, @order)
-        EffectiveOrders.authorize!(self, :admin, :effective_orders)
 
         unless @order.refund?
-          flash[:danger] = 'Unable to process refund with a non-negative total'
-          redirect_to effective_orders.admin_order_path(@order)
+          flash[:danger] = 'Unable to process refund order with a positive total'
+          redirect_to effective_orders.order_path(@order)
           return
         end
 
-        @order.assign_attributes(refund_params.except(:payment, :payment_provider, :payment_card))
+        flash[:success] = EffectiveOrders.refund[:success].presence
 
         order_purchased(
-          payment: refund_params[:payment],
-          provider: refund_params[:payment_provider],
-          card: refund_params[:payment_card],
-          email: @order.send_mark_as_paid_email_to_buyer?,
-          skip_buyer_validations: true,
-          purchased_url: params[:purchased_url].presence || effective_orders.admin_order_path(@order),
-          declined_url: params[:declined_url].presence || effective_orders.admin_order_path(@order)
+          payment: 'refund. no payment required.',
+          provider: 'refund',
+          purchased_url: refund_params[:purchased_url],
+          declined_url: refund_params[:declined_url]
         )
       end
 
       def refund_params
-        params.require(:effective_order).permit(
-          :payment, :payment_provider, :payment_card, :note_to_buyer, :send_mark_as_paid_email_to_buyer
-        )
+        params.require(:refund).permit(:purchased_url, :declined_url)
       end
 
     end

data/app/helpers/effective_orders_helper.rb

@@ -49,7 +49,7 @@ module EffectiveOrdersHelper
     when :pretend
       'Purchase Order (skip payment processor)'
     when :refund
-      'Complete Refund'
+      'Accept Refund'
     when :stripe
       'Checkout with Credit Card'
     else

data/app/mailers/effective/orders_mailer.rb

@@ -52,6 +52,16 @@ module Effective
       mail(to: @order.user.email, subject: @subject)
     end
 
+    # This is sent to admin when someone Accepts Refund
+    def refund_notification_to_admin(order_param)
+      @order = (order_param.kind_of?(Effective::Order) ? order_param : Effective::Order.find(order_param))
+      @user = @order.user
+
+      @subject = subject_for(@order, :refund_notification_to_admin, "New Refund: ##{@order.to_param}")
+
+      mail(to: EffectiveOrders.mailer[:admin_email], subject: @subject)
+    end
+
     # Sent by the invoice.payment_succeeded webhook event
     def subscription_payment_succeeded(customer_param)
       return true unless EffectiveOrders.mailer[:send_subscription_payment_succeeded]

data/app/models/effective/order.rb

@@ -76,7 +76,7 @@ module Effective
       validates :total, presence: true, numericality: {
         greater_than_or_equal_to: EffectiveOrders.minimum_charge.to_i,
         message: "must be $#{'%0.2f' % (EffectiveOrders.minimum_charge.to_i / 100.0)} or more. Please add additional items."
-      }, unless: -> { (free? && EffectiveOrders.free?) || (refund? && EffectiveOrders.refunds?) }
+      }, unless: -> { (free? && EffectiveOrders.free?) || (refund? && EffectiveOrders.refund?) }
     end
 
     # User validations -- An admin skips these when working in the admin/ namespace
@@ -343,6 +343,7 @@ module Effective
 
       raise "Failed to purchase order: #{error || errors.full_messages.to_sentence}" unless error.nil?
 
+      send_refund_notification! if email && refund?
       send_order_receipts! if email
 
       run_purchasable_callbacks(:after_purchase)
@@ -405,6 +406,10 @@ module Effective
       send_email(:pending_order_invoice_to_buyer, to_param) unless purchased?
     end
 
+    def send_refund_notification!
+      send_email(:refund_notification_to_admin, to_param) if purchased? && refund?
+    end
+
     def skip_qb_sync!
       defined?(EffectiveQbSync) ? EffectiveQbSync.skip_order!(self) : true
     end

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

@@ -10,8 +10,8 @@
   - if EffectiveOrders.free? && order.free?
     = render partial: '/effective/orders/free/form', locals: provider_locals
 
-  - elsif EffectiveOrders.refunds? && order.refund?
-    -# Nothing
+  - elsif EffectiveOrders.refund? && order.refund?
+    = render partial: '/effective/orders/refund/form', locals: provider_locals
 
   - else
     - if EffectiveOrders.pretend? && EffectiveOrders.pretend_message.present?
@@ -33,10 +33,7 @@
       = render partial: '/effective/orders/cheque/form', locals: provider_locals
 
   - if EffectiveOrders.authorized?(controller, :admin, :effective_orders) && order.user != current_user
-    - if EffectiveOrders.refunds? && order.refund?
-      .effective-order-admin-purchase-actions
-        = render partial: '/effective/orders/refund/form', locals: provider_locals
-    - elsif EffectiveOrders.mark_as_paid?
+    - if EffectiveOrders.mark_as_paid?
       .effective-order-admin-purchase-actions
         = render partial: '/effective/orders/mark_as_paid/form', locals: provider_locals
 

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

@@ -1,5 +1,5 @@
 = effective_form_with(scope: :free, url: effective_orders.free_order_path(order), method: :post) do |f|
-  = hidden_field_tag(:purchased_url, purchased_url)
-  = hidden_field_tag(:declined_url, declined_url)
+  = f.hidden_field :purchased_url, value: purchased_url
+  = f.hidden_field :declined_url, value: declined_url
 
-  = f.submit order_checkout_label(:free), border: false
+  = f.submit order_checkout_label(:free), center: true, border: false

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

@@ -1,26 +1,5 @@
-.card
-  .card-body
-    %h2 Admin: Complete 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
 
-    = effective_form_with(model: order, url: effective_orders.refund_order_path(order), method: :post) do |f|
-      = hidden_field_tag(:purchased_url, purchased_url)
-      = hidden_field_tag(:declined_url, declined_url)
-
-      = f.select :payment_provider, EffectiveOrders.payment_providers, required: true
-
-      = f.text_field :payment_card,
-        label: 'Payment card type, cheque or transaction number',
-        placeholder: 'visa',
-        hint: 'Full credit card numbers should not be entered here, or anywhere.'
-
-      = f.text_area :payment,
-        label: 'Additional details',
-        input_html: { value: f.object.payment.kind_of?(Hash) ? f.object.payment[:details] : f.object.payment.presence }
-
-      = f.check_box :send_mark_as_paid_email_to_buyer,
-        label: 'Yes, send an refund receipt email to the buyer.',
-        input_html: { checked: (f.object.send_mark_as_paid_email_to_buyer.nil? ? EffectiveOrders.mailer[:send_order_receipts_when_mark_as_paid] : f.object.send_mark_as_paid_email_to_buyer?) }
-
-      = f.text_area :note_to_buyer, hint: 'This is displayed to the buyer on all order receipts.'
-
-      = f.submit order_checkout_label(:refund)
+  = f.submit order_checkout_label(:refund), center: true, border: false

data/app/views/effective/orders_mailer/refund_notification_to_admin.html.haml

@@ -0,0 +1,15 @@
+%p.effective-orders-receipt-info A new refund has been created!
+
+%p Please sign in to your payment processor and issue the following refund:
+
+%p
+  Refund
+  = price_to_currency(@order.total)
+  to
+  = @order.billing_name
+  = @order.user.email
+
+
+%p Thanks and have a great day!
+
+= render(@order, no_order_actions: true)

data/config/effective_orders.rb

@@ -98,11 +98,6 @@ EffectiveOrders.setup do |config|
   # This is accessed via the admin screens only. Must have can?(:admin, :effective_orders)
   config.mark_as_paid_enabled = false
 
-  # Refunds
-  # Allow admins to create orders with a negative total
-  # Refunds don't perform any kind of refund action with the payment processor. This just changes the validations.
-  config.refunds_enabled = false
-
   # Pretend Purchase
   # Display a 'Purchase order' button on the Checkout screen allowing the user
   # to purchase an Order without going through the payment processor.
@@ -150,6 +145,7 @@ EffectiveOrders.setup do |config|
     subject_for_order_receipt_to_buyer: '',
     subject_for_payment_request_to_buyer: '',
     subject_for_pending_order_invoice_to_buyer: '',
+    subject_for_refund_notification_to_admin: '',
 
     # Procs yield an Effective::Customer object
     subject_for_subscription_created: '',
@@ -165,7 +161,7 @@ EffectiveOrders.setup do |config|
     layout: 'effective_orders_mailer_layout',
 
     default_from: 'info@example.com',
-    admin_email: 'admin@example.com',
+    admin_email: 'admin@example.com',   # Refund notifications will also be sent here
 
     deliver_method: nil  # When nil, will use deliver_later if active_job is configured, otherwise deliver_now
   }
@@ -228,6 +224,17 @@ EffectiveOrders.setup do |config|
   #   }
   # end
 
+
+  # 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 notify_email with instructions to issue a refund
+  config.refund = false
+
+  # config.refund = {
+  #   success: 'Thank you! Your refund will be processed in the next few business days.'
+  # }
+
   # Stripe
   config.stripe = false
 

data/config/routes.rb

@@ -10,7 +10,7 @@ EffectiveOrders::Engine.routes.draw do
         post :mark_as_paid if EffectiveOrders.mark_as_paid?
         post :pay_by_cheque if EffectiveOrders.cheque?
         post :pretend if EffectiveOrders.pretend?
-        post :refund if EffectiveOrders.refunds?
+        post :refund if EffectiveOrders.refund?
         post :stripe if EffectiveOrders.stripe?
       end
 

data/lib/effective_orders.rb

@@ -54,7 +54,6 @@ module EffectiveOrders
   # Features
   mattr_accessor :free_enabled
   mattr_accessor :mark_as_paid_enabled
-  mattr_accessor :refunds_enabled
   mattr_accessor :pretend_enabled
   mattr_accessor :pretend_message
 
@@ -62,6 +61,7 @@ module EffectiveOrders
   mattr_accessor :cheque
   mattr_accessor :moneris
   mattr_accessor :paypal
+  mattr_accessor :refund
   mattr_accessor :stripe
   mattr_accessor :subscriptions  # Stripe subscriptions
   mattr_accessor :trial          # Trial mode
@@ -121,8 +121,8 @@ module EffectiveOrders
     pretend_enabled == true
   end
 
-  def self.refunds?
-    refunds_enabled == true
+  def self.refund?
+    refund.kind_of?(Hash)
   end
 
   def self.stripe?
@@ -144,11 +144,12 @@ module EffectiveOrders
   # The Effective::Order.payment_provider value must be in this collection
   def self.payment_providers
     [
-      ('cheque' if cheque?),
+      ('cheque' if cheque? || mark_as_paid?),
       ('free' if free?),
       ('moneris' if moneris?),
       ('paypal' if paypal?),
       ('pretend' if pretend?),
+      ('refund' if refund?),
       ('stripe' if stripe?),
       ('credit card' if mark_as_paid?),
       ('other' if mark_as_paid?),

data/lib/effective_orders/engine.rb

@@ -27,6 +27,14 @@ module EffectiveOrders
       Rails.application.config.assets.precompile += ['effective_orders/*']
     end
 
+    initializer 'effective_orders.refund', after: :load_config_initializers do
+      if EffectiveOrders.refund?
+        unless (EffectiveOrders.mailer[:admin_email].to_s.include?('@') rescue false)
+          raise("config.mailer[:admin_email] must be present when refunds enabled.")
+        end
+      end
+    end
+
     initializer 'effective_orders.stripe', after: :load_config_initializers do
       if EffectiveOrders.stripe?
         begin

data/lib/effective_orders/version.rb

@@ -1,3 +1,3 @@
 module EffectiveOrders
-  VERSION = '4.3.2'.freeze
+  VERSION = '4.4.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: effective_orders
 version: !ruby/object:Gem::Version
-  version: 4.3.2
+  version: 4.4.0
 platform: ruby
 authors:
 - Code and Effect
@@ -162,7 +162,6 @@ files:
 - app/models/effective/order.rb
 - app/models/effective/order_item.rb
 - app/models/effective/product.rb
-- app/models/effective/providers/stripe_charge.rb
 - app/models/effective/sold_out_validator.rb
 - app/models/effective/subscripter.rb
 - app/models/effective/subscription.rb
@@ -225,6 +224,7 @@ files:
 - app/views/effective/orders_mailer/order_receipt_to_buyer.html.haml
 - app/views/effective/orders_mailer/payment_request_to_buyer.html.haml
 - app/views/effective/orders_mailer/pending_order_invoice_to_buyer.html.haml
+- app/views/effective/orders_mailer/refund_notification_to_admin.html.haml
 - app/views/effective/orders_mailer/subscription_canceled.html.haml
 - app/views/effective/orders_mailer/subscription_created.html.haml
 - app/views/effective/orders_mailer/subscription_event_to_admin.html.haml

data/app/models/effective/providers/stripe_charge.rb

@@ -1,24 +0,0 @@
-# This is an object for the stripe charge form
-module Effective::Providers
-  class StripeCharge
-    include ActiveModel::Model
-
-    attr_accessor :effective_order_id, :order, :stripe_token # For our form
-
-    validates :effective_order_id, presence: true
-    validates :stripe_token, presence: true
-
-    def persisted?
-      false
-    end
-
-    def effective_order_id
-      @effective_order_id || (order.to_param if order)
-    end
-
-    def order_items
-      order.order_items if order
-    end
-
-  end
-end