spree_reports 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 115b2468f528c98184477a62985580afb9690021
+  data.tar.gz: 3c8ae48b20a1cbb8366782d453a63873122cf306
+SHA512:
+  metadata.gz: a66840a9351e4b2b19ab7aa7bc84a129dea27e97f88919647780eaacb793ee7f351301e55f5829a4581ed43611cef662f1d981be759ebf4eac8e8c00caf8028a
+  data.tar.gz: be812cdede4ffae1f9ad2ace302df8ed07f959f3fe6548020675967d4c306b9ace52ff17a8f47442d22072bdfbe6cee3174533631bb6e7f7f4a152eea4f99441

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Mike Lieser
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SpreeReports'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/stylesheets/spree_reports/spree_reports.css.scss

@@ -0,0 +1,61 @@
+.spree_reports.report {
+  
+  text-align: center;
+  padding-bottom: 30px;
+  
+  h1 {
+    margin-bottom: 20px;
+    margin-top: 20px;
+    font-size: 28px;
+  }
+  
+  h2 {
+    margin-top: 50px;
+  }
+  
+  form.options {
+    margin-bottom: 25px;
+    
+    .option {
+      margin-right: 12px;
+    }
+    
+    select {
+      max-width: 150px;
+    }
+    
+    input[type=submit] {
+      padding: 1px 6px 1px 6px;
+      font-size: 12px;
+      border-radius: 5px;
+    }
+  }
+    
+  table.data {
+    margin-top:30px;
+    
+    th.help {
+      cursor:help;
+    }
+  }
+  
+  div.permalink {
+    h2 {
+      font-weight:bold;
+      margin-bottom:15px;
+    }
+    
+    #spree_reports_permalink {
+      font-size:13px;
+      font-weight:bold;
+      width:700px;
+      text-align:center;
+    }
+    
+    a {
+      display: block;
+      margin-top: 12px;
+    }
+  }
+  
+}

data/app/controllers/spree/admin/reports_controller_decorator.rb

@@ -0,0 +1,23 @@
+Spree::Admin::ReportsController.class_eval do
+  before_filter :spree_reports_setup, only: [:index]
+
+  def orders_by_period
+    @report = SpreeReports::Reports::OrdersByPeriod.new(params)
+    respond_to do |format|
+      format.html
+      format.csv {
+        return head :unauthorized unless SpreeReports.csv_export
+        send_data @report.to_csv, filename: @report.csv_filename, type: "text/csv"
+      }
+    end 
+  end
+
+  protected
+
+  def spree_reports_setup
+    SpreeReports.reports.each do |report|
+      Spree::Admin::ReportsController.add_available_report! report
+    end
+  end
+  
+end

data/app/controllers/spree/api/spree_reports_controller.rb

@@ -0,0 +1,19 @@
+module Spree
+  module Api
+    class SpreeReportsController < Spree::Api::BaseController
+      before_filter :requires_admin
+
+      def orders_by_period
+        @report = SpreeReports::Reports::OrdersByPeriod.new(params)
+        render json: @report.data
+      end
+      
+      private
+        def requires_admin
+          return if @current_user_roles.include?(SpreeReports.api_user_role)
+          unauthorized and return
+        end
+        
+    end
+  end
+end

data/app/views/spree/admin/reports/orders_by_period.html.erb

@@ -0,0 +1,138 @@
+<%= stylesheet_link_tag 'spree_reports/spree_reports', media: 'all' %>
+<%= javascript_include_tag "//www.google.com/jsapi", "chartkick" %>
+
+<div class="spree_reports report">
+  
+  <h1>Orders Per Period</h1>
+  
+  <div class="options">
+    
+    <%= form_tag "", method: :get, class: "options" do %>
+  
+      <span class="option">
+        group by:
+        <%= select_tag "group_by", options_for_select(@report.group_by_list, selected: @report.group_by) %>
+      </span>
+    
+      <span class="option">
+        <span title="<%= @report.date_start ? "date_start: #{l(@report.date_start.to_date)}" : "" %>">months:</span>
+        <%= select_tag "months", options_for_select(SpreeReports.report_months, selected: @report.months) %>
+      </span>
+    
+      <span class="option">
+        state:
+        <%= select_tag "state", options_for_select(@report.states, selected: @report.state) %>
+      </span>
+    
+      <% if @report.currencies.size > 1 %>
+        <span class="option">
+          currency:
+          <%= select_tag "currency", options_for_select(@report.currencies, selected: @report.currency) %>
+        </span>
+      <% end %>
+  
+      <% if @report.stores.size > 2 %>
+        <span class="option">
+          store:
+          <%= select_tag "store", options_for_select(@report.stores, selected: @report.store) %>
+        </span>
+      <% end %>
+  
+      <%= submit_tag 'reload' %>
+  
+    <% end %>
+    
+  </div>
+  
+  <div class="table">
+    
+    <table class="data" border="1">
+      <tr>
+        <th><%= @report.group_by.capitalize %></th>
+        <th>Orders</th>
+        <th class="help" title="Item Count Total">ICT</th>
+        <th class="help" title="Items per Order">IPO</th>
+        <th class="help" title="Average Total">Avg. T.</th>
+        <th class="help" title="Total">Total</th>
+        <th class="help" title="Item Total">Item T.</th>
+        <th class="help" title="Adjustment Total">Adjustment T.</th>
+        <th class="help" title="Shipment Total">Shipment T.</th>
+        <th class="help" title="Promo Total">Promo T.</th>
+        <th class="help" title="Included Tax Total">Included Tax T.</th>
+      </tr>
+  
+      <% @report.data.each do |item| %>
+        <tr>
+          <td><%= item[:date_formatted] %></td>
+          <td><%= number_with_delimiter(item[:count]) %></td>
+          <td><%= number_with_delimiter(item[:item_count_total]) %></td>
+          <td><%= number_with_precision(item[:items_per_order], precision: 2) %></td>
+          <td><%= Spree::Money.new(item[:avg_total], :currency => @report.currency).to_s %></td>
+          <td><%= Spree::Money.new(item[:total], :currency => @report.currency).to_s %></td>
+          <td><%= Spree::Money.new(item[:item_total], :currency => @report.currency).to_s %></td>
+          <td><%= Spree::Money.new(item[:adjustment_total], :currency => @report.currency).to_s %></td>
+          <td><%= Spree::Money.new(item[:shipment_total], :currency => @report.currency).to_s %></td>
+          <td><%= Spree::Money.new(item[:promo_total], :currency => @report.currency).to_s %></td>
+          <td><%= Spree::Money.new(item[:included_tax_total], :currency => @report.currency).to_s %></td>
+        </tr>
+      <% end %>
+  
+    </table>
+  
+  </div>
+
+  <div class="charts">
+     
+     <h2>Order Count</h2>
+     <div class="chart">
+       <%= column_chart Hash[@report.data.collect { |i| [i[:date_formatted], i[:count]] }] %>
+     </div>
+  
+     <h2>Item Count Total</h2>
+     <div class="chart">
+       <%= column_chart Hash[@report.data.collect { |i| [i[:date_formatted], i[:item_count_total]] }] %>
+     </div>
+  
+     <h2>Items per Order</h2>
+     <div class="chart">
+       <%= column_chart Hash[@report.data.collect { |i| [i[:date_formatted], i[:items_per_order]] }] %>
+     </div>
+     
+     <h2>Average Total</h2>
+     <div class="chart">
+       <%= column_chart Hash[@report.data.collect { |i| [i[:date_formatted], i[:avg_total]] }] %>
+     </div>
+          
+     <h2>Total & Item Total</h2>
+     <div class="chart">
+       <%=
+         column_chart [
+           { name: "Total", data: Hash[@report.data.collect { |i| [i[:date_formatted], i[:total]] }] },
+           { name: "Item Total", data: Hash[@report.data.collect { |i| [i[:date_formatted], i[:item_total]] }] }
+         ]
+       %>
+     </div>
+     
+     <h2>Misc Totals</h2>
+     <div class="chart">
+       <%=
+         column_chart [
+           { name: "Shipment Total", data: Hash[@report.data.collect { |i| [i[:date_formatted], i[:shipment_total]] }] },
+           { name: "Included Tax Total", data: Hash[@report.data.collect { |i| [i[:date_formatted], i[:included_tax_total]] }] },
+           { name: "Adjustment Total", data: Hash[@report.data.collect { |i| [i[:date_formatted], i[:adjustment_total]] }] },
+           { name: "Promo Total", data: Hash[@report.data.collect { |i| [i[:date_formatted], i[:promo_total]] }] }
+         ]
+       %>
+     </div>
+     
+  </div>
+  
+  <div class="permalink">
+    <h2>Permalink</h2>
+    <input id="spree_reports_permalink" type="text" value="<%= request.url.split('?').first + "?" + params.except(:utf8, :commit, :action, :controller).to_query %>" onclick="$(this).select();return;">
+    <% if SpreeReports.csv_export %>
+      <%= link_to 'Download as CSV', params.except(:utf8, :commit).merge(format: "csv") %>
+    <% end %>
+  </div>
+  
+</div>

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  spree:
+    orders_by_period: "Orders per period"
+    orders_by_period_description: "Orders for a specific time range per period"
+    
+    spree_reports:
+      test: "TEST"
+      

data/config/routes.rb

@@ -0,0 +1,23 @@
+Spree::Core::Engine.routes.draw do
+  
+  namespace :admin do
+    resources :reports, :only => [] do
+      collection do
+        SpreeReports.reports.each do |report|
+          get report
+        end
+      end
+    end
+  end
+  
+  namespace :api do
+    resources :spree_reports, :only => [] do
+      collection do
+        SpreeReports.reports.each do |report|
+          get report
+        end
+      end
+    end
+  end
+  
+end

data/lib/spree_reports.rb

@@ -0,0 +1,52 @@
+require 'spree_core'
+require "spree_reports/engine"
+
+module SpreeReports
+  
+  # list of visible reports
+  mattr_accessor :reports
+  
+  # time zone
+  mattr_accessor :time_zone
+  
+  # start of week
+  mattr_accessor :week_start
+  
+  # export
+  mattr_accessor :csv_export
+  
+  # available months to select in reports
+  mattr_accessor :report_months
+  
+  # default months selection in reports
+  mattr_accessor :default_months
+  
+  # check if the api user has this role
+  mattr_accessor :api_user_role
+  
+  # date formats for different group_by settings
+  mattr_accessor :date_formats
+   
+end
+
+# default configuration, overrideable in config/initializer spree_reports.rb
+
+SpreeReports.reports = [
+  :orders_by_period
+]
+
+# :orders_by_payment_type
+# :orders_by_value_range
+
+SpreeReports.time_zone = "Pacific Time (US & Canada)"
+SpreeReports.week_start = :mon
+SpreeReports.csv_export = true
+SpreeReports.report_months = %w{1 3 6 12 24 36 48 all}
+SpreeReports.default_months = 6
+SpreeReports.api_user_role = "admin"
+SpreeReports.date_formats = {
+  year: "%Y",
+  month: "%m.%Y",
+  week: "%W/%Y",
+  day: "%m.%d.%y"
+}

data/lib/spree_reports/engine.rb

@@ -0,0 +1,27 @@
+require 'spree/core'
+
+module SpreeReports
+  class Engine < ::Rails::Engine
+    isolate_namespace Spree
+    engine_name "spree_reports"
+    
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+    
+    # apply decorators
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+      
+      Rails.application.config.assets.precompile += %w( spree_reports/spree_reports.css )
+    end
+
+    config.to_prepare &method(:activate).to_proc
+
+  end
+end

data/lib/spree_reports/helper.rb

@@ -0,0 +1,20 @@
+module SpreeReports
+  class Helper
+    
+    def self.divide(a, b)
+      return nil if b == 0
+      a / b
+    end
+
+    def self.round(a)
+      return a.round(2) if a
+      a
+    end
+
+    def self.date_formatted(date, group_by)
+      date_format = SpreeReports.date_formats[group_by]
+      date.strftime(date_format)
+    end
+    
+  end
+end