solidus_admin_insights 2.1.0

data/app/helpers/spree/admin/base_helper_decorator.rb

@@ -0,0 +1,17 @@
+Spree::BaseHelper.class_eval do
+  def selected?(path)
+    path == 'spree/admin/insights'
+  end
+
+  def form_action(insight, insight_type)
+    insight ? admin_insight_path(id: @report_name, type: insight_type) : 'javascript:void(0)'
+  end
+
+  def page_selector_options
+    [5, 10, 15, 30, 45, 60]
+  end
+
+  def pdf_logo(image_path = Spree::Config[:logo])
+    wicked_pdf_image_tag image_path, class: 'logo'
+  end
+end

data/app/models/spree/app_configuration_decorator.rb

@@ -0,0 +1,3 @@
+Spree::AppConfiguration.class_eval do
+  preference :records_per_page, :integer, default: 5
+end

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,3 @@
+Spree::Product.class_eval do
+  has_many :page_view_events, -> { viewed.product }, class_name: 'Spree::PageEvent', foreign_key: :target_id
+end

data/app/models/spree/promotion_action_decorator.rb

@@ -0,0 +1,3 @@
+Spree::PromotionAction.class_eval do
+  has_one :adjustment, -> { promotion }, class_name: 'Spree::Adjustment', foreign_key: :source_id
+end

data/app/models/spree/return_authorization_decorator.rb

@@ -0,0 +1,4 @@
+Spree::ReturnAuthorization.class_eval do
+  has_many :variants, through: :inventory_units
+  has_many :products, through: :variants
+end

data/app/permissions/spree/permission_sets/insight_display.rb

@@ -0,0 +1,9 @@
+module Spree
+  module PermissionSets
+    class InsightDisplay < PermissionSets::Base
+      def activate!
+        can [:admin, :display, :download], :insights
+      end
+    end
+  end
+end

data/app/reports/spree/best_selling_products_report.rb

@@ -0,0 +1,42 @@
+module Spree
+  class BestSellingProductsReport < Spree::Report
+    DEFAULT_SORTABLE_ATTRIBUTE = :sold_count
+    HEADERS                    = { sku: :string, product_name: :string, sold_count: :integer }
+    SEARCH_ATTRIBUTES          = { start_date: :orders_completed_from, end_date: :orders_completed_to }
+    SORTABLE_ATTRIBUTES        = [:product_name, :sku, :sold_count]
+
+    deeplink product_name: { template: %Q{<a href="/admin/products/{%# o.product_slug %}" target="_blank">{%# o.product_name %}</a>} }
+
+    class Result < Spree::Report::Result
+      class Observation < Spree::Report::Observation
+        observation_fields [:product_name, :product_slug, :sku, :sold_count]
+
+        def sku
+          @sku.presence || @product_name
+        end
+      end
+    end
+
+    def report_query
+      Spree::LineItem
+        .joins(:order)
+        .joins(:variant)
+        .joins(:product)
+        .where(Spree::Product.arel_table[:name].matches(search_name))
+        .where(spree_orders: { state: 'complete' })
+        .where(spree_orders: { completed_at: reporting_period })
+        .group(:variant_id, :product_name, :product_slug, 'spree_variants.sku')
+        .select(
+          'spree_products.name as product_name',
+          'spree_products.slug as product_slug',
+          'spree_variants.sku  as sku',
+          'sum(quantity)       as sold_count'
+        )
+    end
+
+    private def search_name
+      search[:name].present? ? "%#{ search[:name] }%" : '%'
+    end
+
+  end
+end

data/app/reports/spree/cart_additions_report.rb

@@ -0,0 +1,36 @@
+module Spree
+  class CartAdditionsReport < Spree::Report
+    DEFAULT_SORTABLE_ATTRIBUTE = :product_name
+    HEADERS                    = { sku: :string, product_name: :string, additions: :integer, quantity_change: :integer }
+    SEARCH_ATTRIBUTES          = { start_date: :product_added_from, end_date: :product_added_to }
+    SORTABLE_ATTRIBUTES        = [:product_name, :sku, :additions, :quantity_change]
+
+    deeplink product_name: { template: %Q{<a href="/admin/products/{%# o.product_slug %}" target="_blank">{%# o.product_name %}</a>} }
+
+    class Result < Spree::Report::Result
+      class Observation < Spree::Report::Observation
+        observation_fields [:product_name, :product_slug, :additions, :quantity_change, :sku]
+
+        def sku
+          @sku.presence || @product_name
+        end
+      end
+    end
+
+    def report_query
+      Spree::CartEvent
+        .added
+        .joins(:variant)
+        .joins(:product)
+        .where(created_at: reporting_period)
+        .group('product_name', 'product_slug', 'spree_variants.sku')
+        .select(
+          'spree_products.name             as product_name',
+          'spree_products.slug             as product_slug',
+          'spree_variants.sku              as sku',
+          'count(spree_products.name)      as additions',
+          'sum(spree_cart_events.quantity) as quantity_change'
+        )
+    end
+  end
+end

data/app/reports/spree/cart_removals_report.rb

@@ -0,0 +1,36 @@
+module Spree
+  class CartRemovalsReport < Spree::Report
+    DEFAULT_SORTABLE_ATTRIBUTE = :product_name
+    HEADERS                    = { sku: :string, product_name: :string, removals: :integer, quantity_change: :integer }
+    SEARCH_ATTRIBUTES          = { start_date: :product_removed_from, end_date: :product_removed_to }
+    SORTABLE_ATTRIBUTES        = [:product_name, :sku, :removals, :quantity_change]
+
+    deeplink product_name: { template: %Q{<a href="/admin/products/{%# o.product_slug %}" target="_blank">{%# o.product_name %}</a>} }
+
+    class Result < Spree::Report::Result
+      class Observation < Spree::Report::Observation
+        observation_fields [:product_name, :product_slug, :removals, :quantity_change, :sku]
+
+        def sku
+          @sku.presence || @product_name
+        end
+      end
+    end
+
+    def report_query
+      Spree::CartEvent
+        .removed
+        .joins(:variant)
+        .joins(:product)
+        .where(created_at: reporting_period)
+        .group('product_name', 'product_slug', 'spree_variants.sku')
+        .select(
+          'spree_products.name             as product_name',
+          'spree_products.slug             as product_slug',
+          'spree_variants.sku              as sku',
+          'count(spree_products.name)      as removals',
+          'sum(spree_cart_events.quantity) as quantity_change'
+        )
+    end
+  end
+end

data/app/reports/spree/cart_updations_report.rb

@@ -0,0 +1,40 @@
+module Spree
+  class CartUpdationsReport < Spree::Report
+    DEFAULT_SORTABLE_ATTRIBUTE = :product_name
+    HEADERS                    = { sku: :string, product_name: :string, updations: :integer, quantity_increase: :integer, quantity_decrease: :integer }
+    SEARCH_ATTRIBUTES          = { start_date: :product_updated_from, end_date: :product_updated_to }
+    SORTABLE_ATTRIBUTES        = [:product_name, :sku, :updations, :quantity_increase, :quantity_decrease]
+
+    deeplink product_name: { template: %Q{<a href="/admin/products/{%# o.product_slug %}" target="_blank">{%# o.product_name %}</a>} }
+
+    class Result < Spree::Report::Result
+      class Observation < Spree::Report::Observation
+        observation_fields [:product_name, :product_slug, :updations, :quantity_increase, :sku, :quantity_decrease]
+
+        def sku
+          @sku.presence || @product_name
+        end
+      end
+    end
+
+    def report_query
+      quantity_increase_sql = "CASE WHEN quantity > 0 then spree_cart_events.quantity ELSE 0 END"
+      quantity_decrease_sql = "CASE WHEN quantity < 0 then spree_cart_events.quantity ELSE 0 END"
+
+      Spree::CartEvent
+        .updated
+        .joins(:variant)
+        .joins(:product)
+        .where(created_at: reporting_period)
+        .group('product_name', 'product_slug', 'spree_variants.sku')
+        .select(
+          'spree_products.name              as product_name',
+          'spree_products.slug              as product_slug',
+          'spree_variants.sku               as sku',
+          'count(spree_products.name)       as updations',
+          "SUM(#{ quantity_increase_sql })  as quantity_increase",
+          "SUM(#{ quantity_decrease_sql })  as quantity_decrease"
+        )
+    end
+  end
+end

data/app/reports/spree/payment_method_transactions_conversion_rate_report.rb

@@ -0,0 +1,74 @@
+module Spree
+  class PaymentMethodTransactionsConversionRateReport < Spree::Report
+    DEFAULT_SORTABLE_ATTRIBUTE = :payment_method_name
+    HEADERS                    = { payment_method_name: :string, payment_state: :string, months_name: :string, count: :integer }
+    SEARCH_ATTRIBUTES          = { start_date: :payments_created_from, end_date: :payments_created_to }
+    SORTABLE_ATTRIBUTES        = [:payment_method_name, :successful_payments_count, :failed_payments_count, :pending_payments_count, :invalid_payments_count]
+
+    class Result < Spree::Report::TimedResult
+      charts PaymentMethodStateDistributionChart
+
+      def build_empty_observations
+        super
+        @_payment_methods = @results.collect { |result| result['payment_method_name'] }.uniq
+        @observations = @_payment_methods.collect do |payment_method_name|
+          payment_states = @results
+                             .select  { |result| result['payment_method_name'] == payment_method_name }
+                             .collect { |result| result['payment_state'] }
+                             .uniq
+
+          payment_states.collect do |state|
+            @observations.collect do |observation|
+              _d_observation = observation.dup
+              _d_observation.payment_method_name =  payment_method_name
+              _d_observation.payment_state = state
+              _d_observation.count = 0
+              _d_observation
+            end
+          end
+        end.flatten
+      end
+
+      class Observation < Spree::Report::TimedObservation
+        observation_fields [:payment_method_name, :payment_state, :count]
+
+        def payment_state
+          if @payment_state == 'pending'
+            @payment_state
+          else
+            "capturing #{ @payment_state }"
+          end
+        end
+
+        def describes?(result, time_scale)
+          (result['payment_method_name'] == payment_method_name && result['payment_state'] == @payment_state) && super
+        end
+      end
+    end
+
+    def report_query
+      Spree::Report::QueryFragments
+        .from_subquery(payment_methods)
+        .group(*time_scale_columns_to_s, 'payment_method_name', 'payment_state')
+        .order(*time_scale_columns)
+        .project(
+          *time_scale_columns,
+          'payment_method_name',
+          'payment_state',
+          'COUNT(payment_method_id) as count'
+        )
+    end
+
+    private def payment_methods
+      Spree::PaymentMethod
+        .joins(:payments)
+        .where(spree_payments: { created_at: reporting_period })
+        .select(
+          'spree_payment_methods.id as payment_method_id',
+          'name as payment_method_name',
+          'state as payment_state',
+          *time_scale_selects('spree_payments')
+        )
+    end
+  end
+end

data/app/reports/spree/payment_method_transactions_conversion_rate_report/payment_method_state_distribution_chart.rb

@@ -0,0 +1,39 @@
+class Spree::PaymentMethodTransactionsConversionRateReport::PaymentMethodStateDistributionChart
+  attr_accessor :chart_data
+
+  def initialize(result)
+    @time_dimension = result.time_dimension
+    @grouped_by_payment_method = result.observations.group_by(&:payment_method_name)
+    @time_series = []
+    @time_series = @grouped_by_payment_method.values.first.collect { |observation| observation.send(@time_dimension) } if @grouped_by_payment_method.first.present?
+  end
+
+  def to_h
+    @grouped_by_payment_method.collect do |method_name, observations|
+      {
+        id: 'payment-state-' + method_name,
+        json: {
+          chart: { type: 'column' },
+          title: {
+            useHTML: true,
+            text: %Q(<span class='chart-title'>#{ method_name } Conversion Status</span>
+                     <span class='fa fa-question-circle' data-toggle='tooltip' title=' Tracks the status of Payments made from different payment methods such as CC, Check etc.'></span>)
+          },
+
+          xAxis: { categories: @time_series },
+          yAxis: {
+            title: { text: 'Count' }
+          },
+          tooltip: { valuePrefix: '#' },
+          legend: {
+            layout: 'vertical',
+            align: 'right',
+            verticalAlign: 'middle',
+            borderWidth: 0
+          },
+          series: observations.group_by(&:payment_state).map { |key, value| { name: key, data: value.map(&:count) } }
+        }
+      }
+    end
+  end
+end

data/app/reports/spree/payment_method_transactions_report.rb

@@ -0,0 +1,60 @@
+module Spree
+  class PaymentMethodTransactionsReport < Spree::Report
+    DEFAULT_SORTABLE_ATTRIBUTE = :payment_method_name
+    HEADERS                    = { payment_method_name: :string, payment_amount: :integer }
+    SEARCH_ATTRIBUTES          = { start_date: :payments_created_from, end_date: :payments_created_till }
+    SORTABLE_ATTRIBUTES        = []
+
+    class Result < Spree::Report::TimedResult
+      charts PaymentMethodRevenueDistributionChart
+
+      def build_empty_observations
+        super
+        @_payment_methods = @results.collect { |result| result['payment_method_name'] }.uniq
+        @observations = @_payment_methods.collect do |payment_method_name|
+          @observations.collect do |observation|
+            _d_observation = observation.dup
+            _d_observation.payment_amount = 0
+            _d_observation.payment_method_name = payment_method_name
+            _d_observation
+          end
+        end.flatten
+      end
+
+      class Observation < Spree::Report::TimedObservation
+        observation_fields [:payment_method_name, :payment_amount]
+
+        def describes?(result, time_scale)
+          (result['payment_method_name'] == payment_method_name) && super
+        end
+
+        def payment_amount
+          @payment_amount.to_f
+        end
+      end
+    end
+
+    def report_query
+      Spree::Report::QueryFragments
+        .from_subquery(payments)
+        .group(*time_scale_columns_to_s, 'payment_method_name')
+        .order(*time_scale_columns)
+        .project(
+          *time_scale_columns,
+          'payment_method_name',
+          'SUM(payment_amount) as payment_amount'
+        )
+    end
+
+    private def payments
+      Spree::PaymentMethod
+        .joins(:payments)
+        .where(spree_payments: { created_at: reporting_period })
+        .select(
+          *time_scale_selects('spree_payments'),
+          'spree_payment_methods.name  as payment_method_name',
+          'spree_payments.amount       as payment_amount',
+        )
+    end
+  end
+end

data/app/reports/spree/payment_method_transactions_report/payment_method_revenue_distribution_chart.rb

@@ -0,0 +1,36 @@
+class Spree::PaymentMethodTransactionsReport::PaymentMethodRevenueDistributionChart
+  def initialize(result)
+    @time_dimension = result.time_dimension
+    @grouped_by_payment_method = result.observations.group_by(&:payment_method_name)
+    @time_series = []
+    if @grouped_by_payment_method.values.first.present?
+      @time_series = @grouped_by_payment_method.values.first.collect { |observation| observation.send(@time_dimension) }
+    end
+  end
+
+  def to_h
+    {
+      id: 'payment-methods',
+      json: {
+        chart: { type: 'column' },
+        title: {
+          useHTML: true,
+          text: "<span class='chart-title'>Payment Methods</span><span class='fa fa-question-circle' data-toggle='tooltip' title=' Compare the revenue generated by different Payment methods such as CC, Check etc.'></span>"
+        },
+        xAxis: { categories: @time_series },
+        yAxis: {
+          title: { text: 'value($)' }
+        },
+        tooltip: { valuePrefix: '$' },
+        legend: {
+          layout: 'vertical',
+          align: 'right',
+          verticalAlign: 'middle',
+          borderWidth: 0
+        },
+        series: @grouped_by_payment_method.collect { |key, value| { name: key, data: value.map(&:payment_amount) }
+        }
+      }
+    }
+  end
+end

data/app/reports/spree/product_views_report.rb

@@ -0,0 +1,46 @@
+module Spree
+  class ProductViewsReport < Spree::Report
+    DEFAULT_SORTABLE_ATTRIBUTE = :product_name
+    HEADERS = { product_name: :string, views: :integer, users: :integer, guest_sessions: :integer }
+    SEARCH_ATTRIBUTES = { start_date: :product_view_from, end_date: :product_view_till, name: :name}
+    SORTABLE_ATTRIBUTES = [:product_name, :views, :users, :guest_sessions]
+
+    deeplink product_name: { template: %Q{<a href="/admin/products/{%# o.product_slug %}" target="_blank">{%# o.product_name %}</a>} }
+
+    class Result < Spree::Report::Result
+      class Observation < Spree::Report::Observation
+        observation_fields [:product_name, :product_slug, :views, :users, :guest_sessions]
+      end
+    end
+
+    def report_query
+      viewed_events =
+        Spree::Product
+          .where(Spree::Product.arel_table[:name].matches(search_name))
+          .joins(:page_view_events)
+          .where(spree_page_events: { created_at: reporting_period })
+          .group('product_name', 'product_slug', 'spree_page_events.actor_id', 'spree_page_events.session_id')
+          .select(
+            'spree_products.name           as product_name',
+            'spree_products.slug           as product_slug',
+            'COUNT(*)                      as total_views_per_session',
+            'spree_page_events.session_id  as session_id',
+            'spree_page_events.actor_id    as actor_id'
+          )
+      Spree::Report::QueryFragments
+        .from_subquery(viewed_events)
+        .group('product_name', 'product_slug')
+        .project(
+          'product_name',
+          'product_slug',
+          'SUM(total_views_per_session)                    as views',
+          'COUNT(DISTINCT actor_id)                        as users',
+          '(COUNT(DISTINCT session_id) - COUNT(actor_id))  as guest_sessions'
+        )
+    end
+
+    private def search_name
+      search[:name].present? ? "%#{ search[:name] }%" : '%'
+    end
+  end
+end