spree_admin_insights 3.2.0

data/app/reports/spree/unique_purchases_report.rb

@@ -0,0 +1,39 @@
+module Spree
+  class UniquePurchasesReport < Spree::Report
+    DEFAULT_SORTABLE_ATTRIBUTE = :product_name
+    HEADERS                    = { sku: :string, product_name: :string, sold_count: :integer, users: :integer }
+    SEARCH_ATTRIBUTES          = { start_date: :orders_completed_from, end_date: :orders_completed_till }
+    SORTABLE_ATTRIBUTES        = [:product_name, :sku, :sold_count, :users]
+
+    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, :users]
+
+        def sku
+          @sku.presence || @product_name
+        end
+      end
+    end
+
+    def report_query
+      user_count_sql = '(COUNT(DISTINCT(spree_orders.user_id)) + COUNT(spree_orders.id) - COUNT(spree_orders.user_id))'
+      purchases_by_variant =
+        Spree::LineItem
+          .joins(:order)
+          .joins(:variant)
+          .joins(:product)
+          .where(spree_orders: { state: 'complete', completed_at: reporting_period })
+          .group('variant_id', 'spree_variants.sku', 'spree_products.slug', 'spree_products.name')
+          .select(
+            'spree_variants.sku   as sku',
+            'spree_products.slug  as product_slug',
+            'spree_products.name  as product_name',
+            'SUM(quantity)        as sold_count',
+            "#{ user_count_sql }  as users"
+          )
+    end
+
+  end
+end

data/app/reports/spree/user_pool_report.rb

@@ -0,0 +1,66 @@
+module Spree
+  class UserPoolReport < Spree::Report
+    HEADERS             = { guest_users: :integer, active_users: :integer, new_sign_ups: :integer }
+    SEARCH_ATTRIBUTES   = { start_date: :users_created_from, end_date: :users_created_till }
+    SORTABLE_ATTRIBUTES = []
+
+    class Result < Spree::Report::TimedResult
+      charts DistributionColumnChart
+
+      class Observation < Spree::Report::TimedObservation
+        observation_fields active_users: 0, guest_users: 0, new_sign_ups: 0
+      end
+    end
+
+    def report_query
+      Report::QueryFragments
+        .from_union(grouped_sign_ups, grouped_visitors)
+        .group(*time_scale_columns)
+        .order(*time_scale_columns_to_s)
+        .project(
+          *time_scale_columns,
+          'SUM(active_users)  as active_users',
+          'SUM(guest_users)   as guest_users',
+          'SUM(new_sign_ups)  as new_sign_ups'
+        )
+    end
+
+    private def grouped_sign_ups
+      sign_ups = Spree::User.where(created_at: reporting_period).select(:id, *time_scale_selects)
+
+      Report::QueryFragments.from_subquery(sign_ups)
+        .group(*time_scale_columns, 'guest_users', 'active_users')
+        .order(*time_scale_columns_to_s)
+        .project(
+          *time_scale_columns,
+          '0          as guest_users',
+          '0          as active_users',
+          'COUNT(id)  as new_sign_ups'
+        )
+    end
+
+    private def grouped_visitors
+      guest_count_sql = '(COUNT(DISTINCT(session)) - COUNT(DISTINCT(user)))'
+      Report::QueryFragments.from_subquery(visitors)
+        .group(*time_scale_columns, 'new_sign_ups')
+        .order(*time_scale_columns_to_s)
+        .project(
+          *time_scale_columns,
+          "#{ guest_count_sql }   as guest_users",
+          'COUNT(DISTINCT(user))  as active_users',
+          '0                      as new_sign_ups'
+        )
+    end
+
+    private def visitors
+      Spree::PageEvent
+        .where(created_at: reporting_period)
+        .select(
+          *time_scale_selects,
+          'actor_id    as user',
+          'session_id  as session'
+        )
+    end
+
+  end
+end

data/app/reports/spree/user_pool_report/distribution_column_chart.rb

@@ -0,0 +1,65 @@
+class Spree::UserPoolReport::DistributionColumnChart
+  def initialize(result)
+    @chart_data = {
+      active_users: [],
+      guest_users: [],
+      new_sign_ups: []
+    }
+    @time_dimension = result.time_dimension
+    @chart_data[@time_dimension] = []
+    @result = result
+    process_chart_data
+  end
+
+  def process_chart_data
+    chart_keys = @chart_data.keys
+    @result.observations.each do |observation|
+      chart_keys.each do |key|
+        @chart_data[key] << observation.public_send(key)
+      end
+    end
+  end
+
+  def to_h
+    {
+      id: 'user-pool',
+      json: {
+        chart: { type: 'column' },
+        title: {
+          useHTML: true,
+          text: %Q(
+                         <span class="chart-title">User Pool</span>
+                         <span class="fa fa-question-circle"
+                               data-toggle="tooltip"
+                               title=" Keep a track of different type of users such as guest users, registered users and newly signed up users">
+                         </span>
+                         )
+        },
+        xAxis: { categories: @chart_data[@time_dimension] },
+        yAxis: {
+          title: { text: 'Count' }
+        },
+        legend: {
+          layout: 'vertical',
+          align: 'right',
+          verticalAlign: 'middle',
+          borderWidth: 0
+        },
+        series: [
+          {
+            name: Spree.t('user_pool.new_sign_ups'),
+            data: @chart_data[:new_sign_ups].map(&:to_i)
+          },
+          {
+            name: Spree.t('user_pool.active_users'),
+            data: @chart_data[:active_users].map(&:to_i)
+          },
+          {
+            name: Spree.t('user_pool.guest_users'),
+            data: @chart_data[:guest_users].map(&:to_i)
+          }
+        ]
+      }
+    }
+  end
+end

data/app/reports/spree/users_not_converted_report.rb

@@ -0,0 +1,48 @@
+module Spree
+  class UsersNotConvertedReport < Spree::Report
+    DEFAULT_SORTABLE_ATTRIBUTE = :user_email
+    HEADERS                    = { user_email: :string, signup_date: :date }
+    SEARCH_ATTRIBUTES          = { start_date: :users_created_from, end_date: :users_created_till, email_cont: :email }
+    SORTABLE_ATTRIBUTES        = [:user_email, :signup_date]
+
+    def paginated?
+      true
+    end
+
+    class Result < Spree::Report::Result
+      class Observation < Spree::Report::Observation
+        observation_fields [:user_email, :signup_date]
+
+        def signup_date
+          @signup_date.to_date.strftime("%B %d, %Y")
+        end
+      end
+    end
+
+    def paginated_report_query
+      report_query
+        .limit(records_per_page)
+        .offset(current_page)
+    end
+
+    def record_count_query
+      Spree::Report::QueryFragments.from_subquery(report_query).project(Arel.star.count)
+    end
+
+    def report_query
+      Spree::User
+        .where(created_at: reporting_period)
+        .where(Spree::User.arel_table[:email].matches(email_search))
+        .left_joins(:spree_orders)
+        .where(spree_orders: { completed_at: nil, number: nil })
+        .select(
+          "spree_users.email       as  user_email",
+          "spree_users.created_at  as signup_date")
+    end
+
+    private def email_search
+      search[:email_cont].present? ? "%#{ search[:email_cont] }%" : '%'
+    end
+
+  end
+end

data/app/reports/spree/users_who_recently_purchased_report.rb

@@ -0,0 +1,69 @@
+module Spree
+  class UsersWhoRecentlyPurchasedReport < Spree::Report
+    DEFAULT_SORTABLE_ATTRIBUTE = :user_email
+    HEADERS                    = { user_email: :string, purchase_count: :integer, last_purchase_date: :date, last_purchased_order_number: :string }
+    SEARCH_ATTRIBUTES          = { start_date: :start_date, end_date: :end_date, email_cont: :email }
+    SORTABLE_ATTRIBUTES        = [:user_email, :purchase_count, :last_purchase_date]
+
+    def paginated?
+      true
+    end
+
+    class Result < Spree::Report::Result
+      class Observation < Spree::Report::Observation
+        observation_fields [:user_email, :last_purchased_order_number, :last_purchase_date, :purchase_count]
+
+        def last_purchase_date
+          @last_purchase_date.to_date.strftime("%B %d, %Y")
+        end
+      end
+    end
+
+    def record_count_query
+      Spree::Report::QueryFragments.from_subquery(report_query).project(Arel.star.count)
+    end
+
+    def report_query
+      Spree::Report::QueryFragments
+        .from_subquery(all_orders_with_users)
+        .project(
+          "user_email",
+          "last_purchased_order_number",
+          "last_purchase_date",
+          "COUNT(user_email) as purchase_count")
+        .group(
+          "user_email",
+          "last_purchased_order_number",
+          "last_purchase_date"
+        )
+    end
+
+
+    def paginated_report_query
+      report_query
+        .take(records_per_page)
+        .skip(current_page)
+    end
+
+    private def all_orders_with_users
+      Spree::User
+        .where(Spree::User.arel_table[:email].matches(email_search))
+        .left_joins(:spree_orders)
+        .where(spree_orders: { completed_at: reporting_period })
+        .order("spree_orders.completed_at desc")
+        .select(
+          "spree_users.email          as user_email",
+          "spree_orders.number        as last_purchased_order_number",
+          "spree_orders.completed_at  as last_purchase_date"
+        ).group(
+          'user_email',
+          "spree_orders.number",
+          "spree_orders.completed_at"
+        )
+    end
+
+    private def email_search
+      search[:email_cont].present? ? "%#{ search[:email_cont] }%" : '%'
+    end
+  end
+end

data/app/services/spree/report_generation_service.rb

@@ -0,0 +1,27 @@
+module Spree
+  class ReportGenerationService
+
+    class << self
+      delegate :reports, :report_exists?, :reports_for_category, :default_report_category, to: :configuration
+      delegate :configuration, to: SpreeAdminInsights::Config
+    end
+
+    def self.generate_report(report_name, options)
+      klass = Spree.const_get((report_name.to_s + '_report').classify)
+      resource = klass.new(options)
+      dataset = resource.generate
+    end
+
+    def self.download(report, options = {})
+      headers = report.headers
+      stats = report.observations
+      ::CSV.generate(options) do |csv|
+        csv << headers.map { |head| head[:name] }
+        stats.each do |record|
+          csv << headers.map { |head| record.public_send(head[:value]) }
+        end
+      end
+    end
+
+  end
+end

data/app/views/spree/admin/insights/_chart.html.erb

@@ -0,0 +1,4 @@
+<script src="https://code.highcharts.com/highcharts.js"></script>
+<script src="https://code.highcharts.com/modules/exporting.js"></script>
+
+<div id="chart-container" style="margin: 0 auto" class='hidden'></div>

data/app/views/spree/admin/insights/download.pdf.erb

@@ -0,0 +1,27 @@
+<div class='spree-head'>
+  <figure>
+    <%= pdf_logo %>
+  </figure>
+</div>
+<h3 id="report-head">
+  <%= Spree.t(@report_name) %>
+</h3>
+
+<table class="table table-bordered" id="admin-insight" data-hook>
+  <thead>
+    <tr>
+      <% @report.headers.each do |_header_| %>
+        <th><%= Spree.t(_header_[:value], scope: [:insight, @report_name], default: _header_[:name]) %></th>
+      <% end %>
+    </tr>
+  </thead>
+  <tbody>
+    <% @report.observations.each do |stat| %>
+      <tr>
+        <% @report.headers.each do |head|%>
+          <td><%= stat.public_send(head[:value]) %></td>
+        <% end %>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/spree/admin/insights/index.html.erb

@@ -0,0 +1,91 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:heading, type: params[:report_category].to_s.titleize, scope: :insight) %>
+<% end %>
+
+<% content_for :title do %>
+  <%= Spree.t(:heading, type: params[:report_category].to_s.titleize, scope: :insight) %>
+<% end %>
+
+<div id='insights-div' class='container-fluid' >
+  <div class="row">
+    <%= select_tag :reports, options_for_select(@reports.map { |report_name| [ Spree.t(:title, scope: [:insight, report_name]), report_name, data: { url: admin_insight_url(report_name, report_category: params[:report_category]) }] }.unshift(['Select a report', '', data: { url: admin_insights_url(report_category: params[:report_category]) }, disabled: true]), @report_name || ''), class: 'select2' %>
+  </div>
+</div>
+<%= content_tag :div, class: 'hidden report-data', data: { report_data: @report_data_json } {} %>
+
+<div id='report-container'>
+  <div id='search-div' class='hide'>
+    <div class="filter-wrap row">
+      <div class="col-sm-12">
+        <div class="input-group index-filter-button">
+          <span class="input-group-btn">
+            <button class="btn btn-default js-show-index-filters" type="button">
+              <span class="icon icon-chevron-right"></span>
+              <%= Spree.t(:filter) %>
+            </button>
+          </span>
+          <%= form_tag form_action(@report_name, params[:report_category]), id: "quick-search" do %>
+            <%= text_field_tag :quick_search, nil, class: "form-control js-quick-search", placeholder: Spree.t(:quick_search) %>
+          <% end %>
+        </div>
+        <div id="table-filter" data-hook class="well filter-well">
+        </div>
+      </div>
+    </div>
+
+    <div class="table-active-filters js-filters"></div>
+  </div>
+
+  <%= render 'chart' %>
+
+  <div id="table-helpers" class="row pull-right hide">
+    <span id="page-selector">
+      <span class="select-box-slide pull-right">
+        <%= select_tag :per_page, options_for_select(page_selector_options, params[:per_page] || Spree::Config[:records_per_page]), class: 'form-control text-right pull-right page-select' %>
+      </span>
+      <span title="apply pagination" class="col-md-2 hide pull-right">
+        <%= link_to '#', class: 'btn btn-default', id: 'apply-pagination' do %>
+          <span class="glyphicon glyphicon-eye-open"></span>
+        <% end %>
+      </span>
+      <span title="remove pagination" class="col-md-2 pull-right">
+        <%= link_to '#', class: 'btn btn-default', id: 'remove-pagination' do %>
+          <span class="glyphicon glyphicon-eye-close"></span>
+        <% end %>
+      </span>
+    </span>
+    <span id='page-helpers'>
+      <span title="reset" class="col-md-2 pull-right">
+        <%= link_to '#', class: 'btn btn-default', id: 'reset' do %>
+          <span  class="glyphicon glyphicon-repeat"></span>
+        <% end %>
+      </span>
+      <span title="refresh" class="col-md-2 pull-right">
+        <%= link_to '#', class: 'btn btn-default', id: 'refresh' do %>
+          <span class="glyphicon glyphicon-refresh"></span>
+        <% end %>
+      </span>
+      <span title="download" class="col-md-2 pull-right">
+        <%= link_to '#', class: "btn btn-default dropdown-toggle", data: { toggle: 'dropdown' } do %>
+          <span class="glyphicon glyphicon-download"></span>
+        <% end %>
+        <ul class="dropdown-menu">
+          <li><%= link_to 'CSV', admin_insights_download_path(format: 'csv'), class: 'download-link', data: { url: admin_insights_download_path(format: 'csv') } %></li>
+          <li><%= link_to 'Excel', admin_insights_download_path(format: 'xls'), class: 'download-link',  data: { url: admin_insights_download_path(format: 'xls') }%></li>
+          <li><%= link_to 'Text', admin_insights_download_path(format: 'text'), class: 'download-link',  data: { url: admin_insights_download_path(format: 'text') }%></li>
+          <li><%= link_to 'PDF', admin_insights_download_path(format: 'pdf'), class: 'download-link', data: { url: admin_insights_download_path(format: 'pdf') }%></li>
+        </ul>
+      </span>
+    </div>
+  </div>
+
+  <div id='report-div'>
+  </div>
+
+  <div id='paginator-div'>
+  </div>
+</div>
+
+<%= render partial: 'spree/admin/templates/insights/show', formats: [:template] %>
+<%= render partial: 'spree/admin/templates/insights/paginator', formats: [:template] %>
+<%= render partial: 'spree/admin/templates/insights/search', formats: [:template] %>