effective_orders 5.7.4 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccd5fb4a32b778af10466e4b8eab1fd40de1c9c7bf6033960ae1b72ea8254ea8
-  data.tar.gz: c32de9af51826855c96fc33364be02fb0c7efbeee78206de5268dd1636f388fe
+  metadata.gz: 7ef5017c01d659fbcc95d0f7b69568175c7bbe76540b2d57ec6f0ea6ac87d44d
+  data.tar.gz: 570d1894364ff47516f213d9fa29b139597c8f702de4da8277857eac9fe8140a
 SHA512:
-  metadata.gz: e191aad0d3e26a3f0f1f221c196e3351c269cd3f7dc19d21f77b45de3a8b52f65a6f5428099d376f59d9463d03720828c0634b1c3bea40aed482cc99e983e3c3
-  data.tar.gz: d97326c36979460db32c854ee210fdec62eb1ff21a2e344163040f66dff1cc163241ac344af41e4e58dae2a3e203aeaa77e244e755cd6e3c63df4fee8fdf277e
+  metadata.gz: 66297faebffcc406116d3bb394a5572e5127796bd34bbaabb7832785061280bd0e6fd4e06b3509013ab98f6c3a88a47c36eec27e12f20b6859970d5f7dc18a55
+  data.tar.gz: 92dc17259f946aa1ff2d49521e40ab2db17f0d6888f52ff6d7567ded95f6d022532f13959b408bbe9ccfb905066fe05adcee2919e2063684da43ce3fe2965233

data/app/controllers/effective/orders_controller.rb

@@ -4,6 +4,7 @@ module Effective
     include Concerns::Purchase
 
     include Providers::Cheque
+    include Providers::Etransfer
     include Providers::Free
     include Providers::MarkAsPaid
     include Providers::Moneris

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

@@ -0,0 +1,24 @@
+module Effective
+  module Providers
+    module Etransfer
+      extend ActiveSupport::Concern
+
+      def etransfer
+        raise('etransfer provider is not available') unless EffectiveOrders.etransfer?
+
+        @order ||= Order.find(params[:id])
+
+        EffectiveResources.authorize!(self, :update, @order)
+
+        flash[:success] = EffectiveOrders.etransfer[:success]
+
+        order_deferred(provider: 'etransfer', deferred_url: etransfer_params[:deferred_url])
+      end
+
+      def etransfer_params
+        params.require(:etransfer).permit(:deferred_url)
+      end
+
+    end
+  end
+end

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

@@ -38,7 +38,8 @@ module Effective
 
       def validate_stripe_payment(payment_intent_id)
         begin
-          intent = ::Stripe::PaymentIntent.retrieve(payment_intent_id)
+          intent = EffectiveOrders.with_stripe { ::Stripe::PaymentIntent.retrieve(payment_intent_id) }
+
           raise('status is not succeeded') unless intent.status == 'succeeded'
           raise('charges are not present') unless intent.charges.present?
 

data/app/controllers/effective/webhooks_controller.rb

@@ -16,7 +16,8 @@ module Effective
     after_action :run_subscribable_buyer_callbacks!
 
     def stripe
-      @event = (Stripe::Webhook.construct_event(request.body.read, request.env['HTTP_STRIPE_SIGNATURE'], EffectiveOrders.subscriptions[:webhook_secret]) rescue nil)
+      @event = EffectiveOrders.with_stripe { ::Stripe::Webhook.construct_event(request.body.read, request.env['HTTP_STRIPE_SIGNATURE'], EffectiveOrders.subscriptions[:webhook_secret]) rescue nil }
+
       (head(:ok) and return) if request.get? && @event.blank?
       (head(:bad_request) and return) unless @event
 

data/app/datatables/admin/effective_orders_datatable.rb

@@ -63,6 +63,8 @@ class Admin::EffectiveOrdersDatatable < Effective::Datatable
       collection.where(id: Effective::OrderItem.where('name ILIKE ?', "%#{term}%").select('order_id'))
     end
 
+    col :payment_method
+
     col :subtotal, as: :price, visible: false
     col :tax, as: :price, visible: false
 

data/app/helpers/effective_orders_helper.rb

@@ -36,6 +36,8 @@ module EffectiveOrdersHelper
     case processor
     when :cheque
       'Pay by Cheque'
+    when :etransfer
+      'Pay by E-transfer'
     when :free
       'Checkout Free'
     when :mark_as_paid

data/app/helpers/effective_stripe_helper.rb

@@ -75,11 +75,11 @@ module EffectiveStripeHelper
 
     intent = begin
       Rails.logger.info "[STRIPE] create payment intent : #{payment}"
-      Stripe::PaymentIntent.create(payment)
+      EffectiveOrders.with_stripe { ::Stripe::PaymentIntent.create(payment) }
     rescue Stripe::CardError => e
       token_required = true
       Rails.logger.info "[STRIPE] (error) get payment intent : #{e.error.payment_intent.id}"
-      Stripe::PaymentIntent.retrieve(e.error.payment_intent.id)
+      EffectiveOrders.with_stripe { ::Stripe::PaymentIntent.retrieve(e.error.payment_intent.id) }
     end
 
     payload = {

data/app/models/effective/customer.rb

@@ -39,7 +39,7 @@ module Effective
 
       Rails.logger.info "[STRIPE] create customer: #{user.email}"
 
-      self.stripe_customer = Stripe::Customer.create(email: user.email, description: user.to_s, metadata: { user_id: user.id })
+      self.stripe_customer = EffectiveOrders.with_stripe { ::Stripe::Customer.create(email: user.email, description: user.to_s, metadata: { user_id: user.id }) }
       self.stripe_customer_id = stripe_customer.id
 
       save!
@@ -48,21 +48,21 @@ module Effective
     def stripe_customer
       @stripe_customer ||= if stripe_customer_id.present?
         Rails.logger.info "[STRIPE] get customer: #{stripe_customer_id}"
-        ::Stripe::Customer.retrieve(stripe_customer_id)
+        EffectiveOrders.with_stripe { ::Stripe::Customer.retrieve(stripe_customer_id) }
       end
     end
 
     def invoices
       @invoices ||= if stripe_customer_id.present?
         Rails.logger.info "[STRIPE] list invoices: #{stripe_customer_id}"
-        ::Stripe::Invoice.list(customer: stripe_customer_id) rescue nil
+        EffectiveOrders.with_stripe { ::Stripe::Invoice.list(customer: stripe_customer_id) rescue nil }
       end
     end
 
     def upcoming_invoice
       @upcoming_invoice ||= if stripe_customer_id.present?
         Rails.logger.info "[STRIPE] get upcoming invoice: #{stripe_customer_id}"
-        ::Stripe::Invoice.upcoming(customer: stripe_customer_id) rescue nil
+        EffectiveOrders.with_stripe { ::Stripe::Invoice.upcoming(customer: stripe_customer_id) rescue nil }
       end
     end
 
@@ -89,5 +89,6 @@ module Effective
         'Please update or confirm your card details to continue.'
       end.html_safe
     end
+
   end
 end

data/app/models/effective/order.rb

@@ -326,7 +326,7 @@ module Effective
     def payment_method
       return nil unless purchased?
 
-      provider = payment_provider if ['cheque', 'phone'].include?(payment_provider)
+      provider = payment_provider if ['cheque', 'etransfer', 'phone'].include?(payment_provider)
 
       # Normalize payment card
       card = case payment_card.to_s.downcase.gsub(' ', '').strip

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

@@ -0,0 +1,4 @@
+= effective_form_with(scope: :etransfer, url: effective_orders.etransfer_order_path(order), method: :post) do |f|
+  = f.hidden_field :deferred_url, value: deferred_url
+
+  = f.submit order_checkout_label(:etransfer), center: true, border: false, 'data-confirm': EffectiveOrders.etransfer[:confirm]

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

@@ -10,14 +10,13 @@
       = f.select :payment_provider, EffectiveOrders.admin_payment_providers, required: true
 
       = f.text_field :payment_card,
-        label: 'Payment card type, cheque or transaction number',
+        label: 'Payment card type, cheque, e-transfer or transaction number',
         hint: 'Do not enter credit card numbers here, or anywhere.'
 
       = 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
           = f.text_area :note_to_buyer, hint: 'This message will be displayed to the buyer on the receipt.'

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

@@ -6,8 +6,8 @@
 
 %p #{link_to('Click here', effective_orders.order_url(@order))} to review your order and pay online with a credit card.
 
-- if EffectiveOrders.cheque?
-  %p We also accept cheques via the mail, and we will manually mark your order paid upon receiving it.
+- if EffectiveOrders.deferred_providers.present?
+  - providers = EffectiveOrders.deferred_providers.to_sentence()
+  %p We also accept #{providers}. We will mark your order paid upon receiving it.
 
 = render(@order, no_order_actions: true)
-

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

@@ -6,8 +6,8 @@
 
 %p #{link_to('Click here', effective_orders.order_url(@order))} to review your order online.
 
-- if EffectiveOrders.cheque?
-  %p When we receive your cheque in the mail we will mark your order paid.
+- if EffectiveOrders.deferred_providers.present?
+  - providers = EffectiveOrders.deferred_providers.to_sentence(last_word_connector: ', or', two_words_connector: ' or ')
+  %p When we receive your #{providers} we will mark your order paid.
 
 = render(@order, no_order_actions: true)
-

data/config/effective_orders.rb

@@ -61,6 +61,7 @@ EffectiveOrders.setup do |config|
   # Mark as Paid
   # Mark an order as paid without going through a processor
   # This is accessed via the admin screens only. Must have can?(:admin, :effective_orders)
+  # Should be true when using deferred payment providers
   config.mark_as_paid_enabled = false
 
   # Pretend Purchase
@@ -117,6 +118,15 @@ EffectiveOrders.setup do |config|
   #   success: 'Thank you! You have indicated that this order will be purchased by cheque. Please send us a cheque and a copy of this invoice at your earliest convenience.'
   # }
 
+  # E-transfer
+  # This is an deferred payment
+  config.etransfer = false
+
+  # config.etransfer = {
+  #   confirm: 'Proceed with pay by e-transfer?',
+  #   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'
+  # }
+
   # Moneris
   config.moneris = false
 

data/config/routes.rb

@@ -7,9 +7,10 @@ EffectiveOrders::Engine.routes.draw do
         get :declined
         post :send_buyer_receipt
 
+        post :cheque
+        post :etransfer
         post :free
         post :mark_as_paid
-        post :cheque
         post :moneris_checkout
         post :phone
         post :pretend

data/lib/effective_orders/engine.rb

@@ -33,7 +33,6 @@ module EffectiveOrders
       if EffectiveOrders.stripe?
         begin
           require 'stripe'
-          ::Stripe.api_key = EffectiveOrders.stripe[:secret_key]
         rescue Exception
           raise "unable to load stripe. Plese add gem 'stripe' to your Gemfile and then 'bundle install'"
         end

data/lib/effective_orders/version.rb

@@ -1,3 +1,3 @@
 module EffectiveOrders
-  VERSION = '5.7.4'.freeze
+  VERSION = '5.8.0'.freeze
 end

data/lib/effective_orders.rb

@@ -7,7 +7,7 @@ module EffectiveOrders
   # Order states
   PENDING = 'pending'        # New orders are created in a pending state
   CONFIRMED = 'confirmed'    # Once the order has passed checkout step 1
-  DEFERRED = 'deferred'      # Deferred providers. Cheque or Phone was selected.
+  DEFERRED = 'deferred'      # Deferred providers. cheque, etransfer or phone was selected.
   PURCHASED = 'purchased'    # Purchased by provider
   DECLINED = 'declined'      # Declined by provider
   ABANDONED = 'abandoned'    # Not set by this gem. Can be set outside it.
@@ -53,7 +53,7 @@ module EffectiveOrders
       :free_enabled, :mark_as_paid_enabled, :pretend_enabled, :pretend_message,
 
       # Payment processors. false or Hash
-      :cheque, :moneris, :moneris_checkout, :paypal, :phone, :refund, :stripe, :subscriptions, :trial
+      :cheque, :etransfer, :moneris, :moneris_checkout, :paypal, :phone, :refund, :stripe, :subscriptions, :trial
     ]
   end
 
@@ -72,6 +72,10 @@ module EffectiveOrders
     cheque.kind_of?(Hash)
   end
 
+  def self.etransfer?
+    etransfer.kind_of?(Hash)
+  end
+
   def self.free?
     free_enabled == true
   end
@@ -129,6 +133,7 @@ module EffectiveOrders
     [
       ('cheque' if cheque?),
       ('credit card' if mark_as_paid?),
+      ('etransfer' if etransfer?),
       ('free' if free?),
       ('moneris' if moneris?),
       ('moneris_checkout' if moneris_checkout?),
@@ -147,6 +152,7 @@ module EffectiveOrders
     [
       ('cheque' if mark_as_paid?),
       ('credit card' if mark_as_paid?),
+      ('etransfer' if etransfer?),
       #('free' if free?),
       ('moneris' if moneris?),
       ('moneris_checkout' if moneris_checkout?),
@@ -161,7 +167,7 @@ module EffectiveOrders
   end
 
   def self.deferred_providers
-    [('cheque' if cheque?), ('phone' if phone?)].compact
+    [('cheque' if cheque?), ('etransfer' if etransfer?), ('phone' if phone?)].compact
   end
 
   def self.qb_sync?
@@ -184,6 +190,17 @@ module EffectiveOrders
     true
   end
 
+  def self.with_stripe(&block)
+    raise('expected stripe to be enabled') unless stripe?
+
+    begin
+      ::Stripe.api_key = stripe[:secret_key]
+      yield
+    ensure
+      ::Stripe.api_key = nil
+    end
+  end
+
   def self.stripe_plans
     return [] unless (stripe? && subscriptions?)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_orders
 version: !ruby/object:Gem::Version
-  version: 5.7.4
+  version: 5.8.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-27 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -193,6 +193,7 @@ files:
 - app/controllers/effective/customers_controller.rb
 - app/controllers/effective/orders_controller.rb
 - app/controllers/effective/providers/cheque.rb
+- app/controllers/effective/providers/etransfer.rb
 - app/controllers/effective/providers/free.rb
 - app/controllers/effective/providers/mark_as_paid.rb
 - app/controllers/effective/providers/moneris.rb
@@ -271,6 +272,7 @@ files:
 - app/views/effective/orders/deferred.html.haml
 - app/views/effective/orders/deferred/_form.html.haml
 - 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/index.html.haml
 - app/views/effective/orders/mark_as_paid/_form.html.haml