effective_orders 6.0.1 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 962e704970c3ca1f08dba05993e31abd30c20cdf4e6b18669a7df4a13e8d0893
-  data.tar.gz: d26a74b26fb06f4840a01c1fef8723b6e8f16cca1d2e0148326f38e34bdc03af
+  metadata.gz: baba1d8301ce1a4cafcd81d4bf87c4c88d99f003e850aae91aff2f23bd17b50e
+  data.tar.gz: 34f2dd677e1a3a62acc726e6c6210e5645d721bf96df9d9572333bef1039094f
 SHA512:
-  metadata.gz: aa72c2a7664bfac304b7950f50461f71820b15d7c4854405c9d2c71c0eea372e104bff9e2af0cdb7d38f7aa1d88819e129ac9d263c57f4030930466a6fd8e882
-  data.tar.gz: 878903576b4aef842dbe1bef169a4ae5565ed6df7ca61c018591bcb69bbd6b14626c461e7e53a8de6aa77eefa68578e30b9677188deebe35b2b2e11f03bd196b
+  metadata.gz: 0bb85d2c07857a4d7c07de089fd85a9b7d6247d0a4bd56aa3f90f88bd3658679f6086bbb7d58acbf2e17850900704d914e299be70f51ae4a5ec5d786ace30ec0
+  data.tar.gz: e648b6df06efae5b2050fa701130c3a9b00d1ecac7b2c03345a1c04a997d2dc76c2eeb9b48c1046b040b25be3e9c6efe20a72c174426416e184b4144dc7de6dd

data/README.md

@@ -362,6 +362,14 @@ In addition to the above, the following permissions allow access to the `/admin`
 
 ```ruby
 can :admin, :effective_orders # Can access the admin screens
+
+can :index, :report_transactions
+can :index, :report_grouped_transactions
+can :index, :report_payment_providers
+
+can :index, Admin::ReportTransactionsDatatable
+can :index, Admin::ReportGroupedTransactionsDatatable
+can :index, Admin::ReportPaymentProvidersDatatable
 ```
 
 ## Whats Included

data/app/controllers/admin/order_reports_controller.rb

@@ -0,0 +1,36 @@
+module Admin
+  class OrderReportsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_orders) }
+
+    include Effective::CrudController
+
+    def transactions
+      @page_title = 'Revenue: Individual Transactions'
+      @datatable = Admin::ReportTransactionsDatatable.new
+
+      authorize! :index, :report_transactions
+
+      render 'index'
+    end
+
+    def grouped_transactions
+      @page_title = 'Revenue: Grouped Transactions'
+      @datatable = Admin::ReportGroupedTransactionsDatatable.new
+
+      authorize! :index, :report_grouped_transactions
+
+      render 'index'
+    end
+
+    def payment_providers
+      @page_title = 'Revenue: Payment Providers'
+      @datatable = Admin::ReportPaymentProvidersDatatable.new
+
+      authorize! :index, :report_payment_providers
+
+      render 'index'
+    end
+
+  end
+end

data/app/datatables/admin/effective_customers_datatable.rb

@@ -1,26 +1,28 @@
-class Admin::EffectiveCustomersDatatable < Effective::Datatable
-   datatable do
+module Admin
+  class EffectiveCustomersDatatable < Effective::Datatable
+    datatable do
 
-    col :id, visible: false
+      col :id, visible: false
 
-    col :user, search: :string
+      col :user, search: :string
 
-    col :email do |customer|
-      customer.user.email
-    end
+      col :email do |customer|
+        customer.user.email
+      end
 
-    if EffectiveOrders.stripe?
-      col :stripe_customer_id
-      col :active_card
-    end
+      if EffectiveOrders.stripe?
+        col :stripe_customer_id
+        col :active_card
+      end
 
-    actions_col do |customer|
-      link_to('Manage', "https://dashboard.stripe.com/#{'test/' if Rails.env.development?}customers/#{customer.stripe_customer_id}")
-    end
+      actions_col do |customer|
+        link_to('Manage', "https://dashboard.stripe.com/#{'test/' if Rails.env.development?}customers/#{customer.stripe_customer_id}")
+      end
 
-  end
+    end
 
-  collection do
-    Effective::Customer.includes(:user).all
+    collection do
+      Effective::Customer.includes(:user).all
+    end
   end
 end

data/app/datatables/admin/effective_orders_datatable.rb

@@ -1,119 +1,121 @@
-class Admin::EffectiveOrdersDatatable < Effective::Datatable
-  bulk_actions do
-    bulk_action(
-    'Send payment request email to selected orders',
-      effective_orders.bulk_send_payment_request_admin_orders_path,
-      data: { confirm: 'Send payment request emails?' }
-    )
-
-    bulk_action(
-    'Send receipt email to selected purchased orders',
-      effective_orders.bulk_send_buyer_receipt_orders_path,
-      data: { confirm: 'Send receipt emails?' }
-    )
-  end
+module Admin
+  class EffectiveOrdersDatatable < Effective::Datatable
+    bulk_actions do
+      bulk_action(
+      'Send payment request email to selected orders',
+        effective_orders.bulk_send_payment_request_admin_orders_path,
+        data: { confirm: 'Send payment request emails?' }
+      )
+
+      bulk_action(
+      'Send receipt email to selected purchased orders',
+        effective_orders.bulk_send_buyer_receipt_orders_path,
+        data: { confirm: 'Send receipt emails?' }
+      )
+    end
 
-  filters do
-    unless attributes[:skip_filters]
-      scope :all
-      scope :purchased
+    filters do
+      unless attributes[:skip_filters]
+        scope :all
+        scope :purchased
 
-      scope :deferred if EffectiveOrders.deferred_providers.present?
+        scope :deferred if EffectiveOrders.deferred_providers.present?
 
-      scope :pending_refunds if EffectiveOrders.refund && !EffectiveOrders.buyer_purchases_refund?
-      scope :refunds if EffectiveOrders.refund
+        scope :pending_refunds if EffectiveOrders.refund && !EffectiveOrders.buyer_purchases_refund?
+        scope :refunds if EffectiveOrders.refund
 
-      scope :not_purchased
+        scope :not_purchased
+      end
     end
-  end
 
-  datatable do
-    order :updated_at
+    datatable do
+      order :updated_at
 
-    bulk_actions_col
+      bulk_actions_col
 
-    col :created_at, visible: false
-    col :updated_at, visible: false
+      col :created_at, visible: false
+      col :updated_at, visible: false
 
-    col :id, label: 'Number' do |order|
-      '#' + order.to_param
-    end
+      col :id, label: 'Number' do |order|
+        '#' + order.to_param
+      end
 
-    col :purchased_at do |order|
-      order.purchased_at&.strftime('%F %H:%M') || ('pending refund' if order.pending_refund?) || ("pending #{order.payment_provider}" if order.deferred?) || 'not purchased'
-    end
+      col :purchased_at do |order|
+        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?
-      col :user, search: :string
-      col :billing_name, visible: false
-      col :email, visible: false
-    end
+      if attributes[:user_id].blank?
+        col :user, search: :string
+        col :billing_name, visible: false
+        col :email, visible: false
+      end
 
-    col :parent, visible: false, search: :string
+      col :parent, visible: false, search: :string
 
-    col :cc, visible: false
+      col :cc, visible: false
 
-    if EffectiveOrders.billing_address
-      col :billing_address, visible: false
-    end
+      if EffectiveOrders.billing_address
+        col :billing_address, visible: false
+      end
 
-    if EffectiveOrders.shipping_address
-      col :shipping_address, visible: false
-    end
+      if EffectiveOrders.shipping_address
+        col :shipping_address, visible: false
+      end
 
-    col(:order_items, search: :string).search do |collection, term|
-      collection.where(id: Effective::OrderItem.where('name ILIKE ?', "%#{term}%").select('order_id'))
-    end
+      col(:order_items, search: :string).search do |collection, term|
+        collection.where(id: Effective::OrderItem.where('name ILIKE ?', "%#{term}%").select('order_id'))
+      end
 
-    col :payment_method
-    col :payment_provider, label: 'Provider', visible: false, search: { collection: EffectiveOrders.admin_payment_providers }
-    col :payment_card, label: 'Card', visible: false
+      col :payment_method
+      col :payment_provider, label: 'Provider', visible: false, search: { collection: EffectiveOrders.admin_payment_providers }
+      col :payment_card, label: 'Card', visible: false
 
-    col :subtotal, as: :price, visible: false
+      col :subtotal, as: :price, visible: false
 
-    col :tax, as: :price, visible: false
-    col(:tax_rate, visible: false) { |order| rate_to_percentage(order.tax_rate) }
+      col :tax, as: :price, visible: false
+      col(:tax_rate, visible: false) { |order| rate_to_percentage(order.tax_rate) }
 
-    col :surcharge, as: :price, visible: false
-    col(:surcharge_percent, visible: false) { |order| rate_to_percentage(order.surcharge_percent) }
+      col :surcharge, as: :price, visible: false
+      col(:surcharge_percent, visible: false) { |order| rate_to_percentage(order.surcharge_percent) }
 
-    col :total, as: :price
+      col :total, as: :price
 
-    if EffectiveOrders.collect_note
-      col :note, visible: false
-    end
+      if EffectiveOrders.collect_note
+        col :note, visible: false
+      end
 
-    col :note_to_buyer, visible: false
-    col :note_internal, visible: false
+      col :note_to_buyer, visible: false
+      col :note_internal, visible: false
 
-    actions_col partial: 'admin/orders/datatable_actions', partial_as: :order
+      actions_col partial: 'admin/orders/datatable_actions', partial_as: :order
+
+      unless attributes[:total] == false
+        aggregate :total
+      end
 
-    unless attributes[:total] == false
-      aggregate :total
     end
 
-  end
+    collection do
+      scope = Effective::Order.all.deep
 
-  collection do
-    scope = Effective::Order.all.deep
+      if EffectiveOrders.orders_collection_scope.respond_to?(:call)
+        scope = EffectiveOrders.orders_collection_scope.call(scope)
+      end
 
-    if EffectiveOrders.orders_collection_scope.respond_to?(:call)
-      scope = EffectiveOrders.orders_collection_scope.call(scope)
-    end
+      if attributes[:user_id].present?
+        user_klass = (attributes[:user_type].constantize if attributes[:user_type].present?)
+        user_klass ||= current_user.class
 
-    if attributes[:user_id].present?
-      user_klass = (attributes[:user_type].constantize if attributes[:user_type].present?)
-      user_klass ||= current_user.class
+        user = user_klass.find(attributes[:user_id])
+        scope = scope.where(user: user)
+      end
 
-      user = user_klass.find(attributes[:user_id])
-      scope = scope.where(user: user)
-    end
+      if attributes[:parent_id].present? && attributes[:parent_type].present?
+        scope = scope.where(parent_id: attributes[:parent_id], parent_type: attributes[:parent_type])
+      end
 
-    if attributes[:parent_id].present? && attributes[:parent_type].present?
-      scope = scope.where(parent_id: attributes[:parent_id], parent_type: attributes[:parent_type])
+      scope
     end
 
-    scope
   end
-
 end

data/app/datatables/admin/report_grouped_transactions_datatable.rb

@@ -0,0 +1,78 @@
+# Revenue: Grouped Transactions
+
+module Admin
+  class ReportGroupedTransactionsDatatable < Effective::Datatable
+    filters do
+      filter :start_date, nil, as: :date
+      filter :end_date, nil, as: :date
+    end
+
+    datatable do
+      length 250
+
+      col :item
+      col :subtotal, as: :price
+      col :tax, as: :price
+      col :total, as: :price
+
+      payment_providers.each do |provider|
+        col(provider, as: :price)
+      end
+
+      col :orders_count
+
+      col :orders
+      col :users
+
+      col :start_date, as: :date, search: false, sort: false, visible: false do
+        date_range.begin&.strftime('%F')
+      end
+
+      col :end_date, as: :date, search: false, sort: false, visible: false do
+        date_range.end&.strftime('%F')
+      end
+
+      aggregate :total
+    end
+
+    collection do
+      start_date = date_range.begin&.strftime('%F')
+      end_date = date_range.end&.strftime('%F')
+
+      orders = Effective::Order.purchased.where(purchased_at: date_range).where('total != 0')
+      order_items = Effective::OrderItem.where(order_id: orders).includes(:purchasable, order: :user)
+
+      items = order_items.group_by(&:to_s).map do |name, items|
+        row = [
+          name,
+          items.sum { |item| item.subtotal }.to_i,
+          items.sum { |item| item.tax }.to_i,
+          items.sum { |item| item.total }.to_i,
+        ]
+
+        row += payment_providers.map do |payment_provider|
+          items.sum { |item| (item.order.payment_provider == payment_provider) ? item.total : 0 }.to_i
+        end
+
+        row += [
+          items.map(&:order_id).uniq.length,
+          items.map { |item| item.order },
+          items.map { |item| item.order.user },
+          start_date,
+          end_date
+        ]
+
+        row
+      end
+    end
+
+    def payment_providers
+      @payment_providers ||= EffectiveOrders.payment_providers - ['free', 'pretend']
+    end
+
+    def date_range
+      @date_range ||= (filters[:start_date].presence)..(filters[:end_date].presence)
+    end
+
+  end
+end

data/app/datatables/admin/report_payment_providers_datatable.rb

@@ -0,0 +1,60 @@
+# Revenue: Payment Providers
+
+module Admin
+  class ReportPaymentProvidersDatatable < Effective::Datatable
+    filters do
+      filter :start_date, nil, as: :date
+      filter :end_date, nil, as: :date
+    end
+
+    datatable do
+      length 250
+
+      col :payment_provider
+
+      col :sales, as: :price
+      col :returns, as: :price
+      col :total, as: :price
+
+      col :start_date, as: :date, search: false, sort: false, visible: false do
+        date_range.begin&.strftime('%F')
+      end
+
+      col :end_date, as: :date, search: false, sort: false, visible: false do
+        date_range.end&.strftime('%F')
+      end
+
+      aggregate :total
+    end
+
+    collection do
+      start_date = date_range.begin&.strftime('%F')
+      end_date = date_range.end&.strftime('%F')
+
+      orders = Effective::Order.purchased.where(purchased_at: date_range).where('total != 0')
+      order_items = Effective::OrderItem.where(order_id: orders).includes(:purchasable, order: :user)
+
+      payment_providers.map do |provider|
+        items = order_items.select { |item| item.order.payment_provider == provider }
+
+        [
+          provider,
+          items.sum { |item| (item.total > 0 ? item.total : 0) }.to_i,
+          items.sum { |item| (item.total < 0 ? item.total : 0) }.to_i,
+          items.sum { |item| item.total }.to_i,
+          start_date,
+          end_date
+        ]
+      end
+    end
+
+    def payment_providers
+      @payment_providers ||= EffectiveOrders.payment_providers - ['free', 'pretend']
+    end
+
+    def date_range
+      @date_range ||= (filters[:start_date].presence)..(filters[:end_date].presence)
+    end
+
+  end
+end

data/app/datatables/admin/report_transactions_datatable.rb

@@ -0,0 +1,63 @@
+# Revenue: Individual Transactions
+
+module Admin
+  class ReportTransactionsDatatable < Effective::Datatable
+
+    filters do
+      filter :start_date, nil, as: :date
+      filter :end_date, nil, as: :date
+    end
+
+    datatable do
+      order :id, :desc
+      length 250
+
+      col :created_at, visible: false
+
+      col :id, label: 'Order' do |order|
+        link_to(order.to_param, effective_orders.admin_order_path(order))
+      end
+
+      col :purchased_at
+      col :user
+      col :order_items
+
+      col :subtotal, as: :price
+      col :tax, as: :price
+      col(:tax_rate) { |order| rate_to_percentage(order.tax_rate) }.aggregate { nil }
+
+      col :amount_owing, as: :price
+
+      if EffectiveOrders.surcharge?
+        col :surcharge, as: :price
+        col(:surcharge_percent) { |order| rate_to_percentage(order.surcharge_percent) }.aggregate { nil }
+      end
+
+      col :total, as: :price
+
+      col :start_date, as: :date, search: false, sort: false, visible: false do
+        date_range.begin&.strftime('%F')
+      end
+
+      col :end_date, as: :date, search: false, sort: false, visible: false do
+        date_range.end&.strftime('%F')
+      end
+
+      aggregate :total
+
+      actions_col
+    end
+
+    collection do
+      Effective::Order.purchased
+        .where(purchased_at: date_range)
+        .where('total != 0')
+        .includes(:user, [order_items: :purchasable])
+    end
+
+    def date_range
+      @date_range ||= (filters[:start_date].presence)..(filters[:end_date].presence)
+    end
+
+  end
+end

data/app/models/effective/order_item.rb

@@ -59,6 +59,10 @@ module Effective
       (subtotal * order.tax_rate / 100.0).round(0).to_i
     end
 
+    def amount_owing
+      total
+    end
+
     def total
       return subtotal if tax_exempt?
       raise 'parent Effective::Order must have a tax_rate to compute order item total' unless order.try(:tax_rate).present?

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

@@ -0,0 +1,3 @@
+%h1.effective-admin-heading= @page_title
+
+= render_datatable(@datatable)

data/config/routes.rb

@@ -63,6 +63,15 @@ EffectiveOrders::Engine.routes.draw do
     post 'orders/:id', to: 'orders#update'
 
     resources :order_items, only: [:index]
+
+    resources :order_reports, only: [] do
+      collection do
+        get :transactions
+        get :grouped_transactions
+        get :payment_providers
+      end
+    end
+
   end
 end
 

data/lib/effective_orders/version.rb

@@ -1,3 +1,3 @@
 module EffectiveOrders
-  VERSION = '6.0.1'.freeze
+  VERSION = '6.1.0'.freeze
 end

data/lib/effective_orders.rb

@@ -188,6 +188,10 @@ module EffectiveOrders
     use_effective_qb_online && defined?(EffectiveQbOnline)
   end
 
+  def self.surcharge?
+    credit_card_surcharge_percent.to_f > 0.0
+  end
+
   def self.mailer_class
     mailer&.constantize || Effective::OrdersMailer
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_orders
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.1.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2022-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -187,6 +187,7 @@ files:
 - app/assets/stylesheets/effective_orders/_order.scss
 - app/controllers/admin/customers_controller.rb
 - app/controllers/admin/order_items_controller.rb
+- app/controllers/admin/order_reports_controller.rb
 - app/controllers/admin/orders_controller.rb
 - app/controllers/effective/carts_controller.rb
 - app/controllers/effective/concerns/purchase.rb
@@ -207,6 +208,9 @@ files:
 - app/controllers/effective/webhooks_controller.rb
 - app/datatables/admin/effective_customers_datatable.rb
 - app/datatables/admin/effective_orders_datatable.rb
+- app/datatables/admin/report_grouped_transactions_datatable.rb
+- app/datatables/admin/report_payment_providers_datatable.rb
+- app/datatables/admin/report_transactions_datatable.rb
 - app/datatables/effective_orders_datatable.rb
 - app/helpers/effective_carts_helper.rb
 - app/helpers/effective_moneris_checkout_helper.rb
@@ -233,6 +237,7 @@ files:
 - app/views/admin/customers/index.html.haml
 - app/views/admin/customers/show.html.haml
 - app/views/admin/order_items/index.html.haml
+- app/views/admin/order_reports/index.html.haml
 - app/views/admin/orders/_datatable_actions.html.haml
 - app/views/admin/orders/_form.html.haml
 - app/views/admin/orders/_form_note_internal.html.haml