spree_dash 0.70.7 → 1.0.0.rc1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007-2011, Rails Dog LLC and other contributors
+Copyright (c) 2007-2011, Spree Commerce, Inc. and other contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
@@ -23,4 +23,4 @@ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,7 +1,7 @@
 Overview Dashboard
 ==================
 
-Core extension to display basic graphs and charts on store activity. Can be deleted if you don't require the dashboard.
+Core extension to display Spree Analytics
 
 Testing
 -------

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

@@ -0,0 +1,15 @@
+module Spree
+  class Admin::OverviewController < Admin::BaseController
+
+    def index
+    end
+
+    def preferences
+      [:app_id, :site_id, :token].each do |key|
+        Spree::Dash::Config[key] = params[key]
+      end
+      redirect_to admin_path
+    end
+
+  end
+end

data/app/controllers/spree/base_controller_decorator.rb

@@ -0,0 +1,3 @@
+Spree::BaseController.class_eval do
+  helper 'spree/analytics'
+end

data/app/helpers/spree/analytics_helper.rb

@@ -0,0 +1,69 @@
+module Spree
+  module AnalyticsHelper
+
+    def spree_analytics
+      render :partial => 'analytics/header'
+    end
+
+    def analytics_tags
+      tags = { :id => Spree::Dash::Config.site_id.to_s }
+      tags.merge! product_analytics_tags
+      tags.merge! taxon_analytics_tags
+      tags.merge! keywords_analytics_tags
+      tags.merge! cart_analytics_tags
+      tags.merge! completed_analytics_tags
+    end
+
+    def product_analytics_tags
+      return {} unless @product
+      { :product => { :name => @product.name,
+                      :price => @product.price,
+                      :sku => @product.sku,
+                      :categories => @product.taxons.map { |t| t.permalink }
+                    }
+      }
+    end
+
+    def taxon_analytics_tags
+      return {} unless @taxon
+      { :category => { :name => @taxon.permalink } }
+    end
+
+    def keywords_analytics_tags
+      return {} unless params[:keywords]
+      { :search => { :keyword => params[:keywords] } }
+    end
+
+    def cart_analytics_tags
+      return {} unless @order and @order.cart?
+      { :cart => { :total => @order.total,
+                   :products => products_for_order }
+      }
+    end
+
+    def completed_analytics_tags
+      return {} unless @order and @order.complete?
+      { :confirm => { :orderid => @order.number,
+                      :total => @order.total,
+                      :shipping => @order.ship_total,
+                      :tax => @order.tax_total,
+                      :discount => @order.adjustment_total,
+                      :subtotal => @order.item_total,
+                      :products => products_for_order }
+      }
+    end
+
+    def products_for_order
+      @order.line_items.map do |line_item|
+        variant = line_item.variant
+        { :name => variant.name,
+          :qty => line_item.quantity,
+          :price => variant.price,
+          :sku => variant.sku,
+          :categories => variant.product.taxons.map { |t| t.permalink }
+        }
+      end
+    end
+
+  end
+end

data/app/models/spree/dash_configuration.rb

@@ -0,0 +1,11 @@
+module Spree
+  class DashConfiguration < Preferences::Configuration
+    preference :app_id, :string
+    preference :site_id, :string
+    preference :token, :string
+
+    def configured?
+      preferred_app_id.present? and preferred_site_id.present? and preferred_token.present?
+    end
+  end
+end

data/app/overrides/analytics_header.rb

@@ -0,0 +1,4 @@
+Deface::Override.new(:virtual_path => "spree/layouts/spree_application",
+                     :name => "add_analytics_header",
+                     :insert_bottom => "[data-hook='inside_head']",
+                     :partial => "spree/analytics/header")

data/app/views/spree/admin/overview/_form.html.erb

@@ -0,0 +1,23 @@
+<h2><%= t(:spree_analytics_token) %></h2>
+
+<%= form_tag admin_dash_preferences_path, :method => :put  do %>
+  <table data-hook="dash_preferences">
+    <tr data-hook="app_id">
+      <td><%= t(:analytics_app_id) %>:</td>
+      <td><%= text_field_tag :app_id, Spree::Dash::Config.app_id, :size => 50 %></td>
+    </tr>
+    <tr data-hook="site_id">
+      <td><%= t(:analytics_site_id) %>:</td>
+      <td><%= text_field_tag :site_id, Spree::Dash::Config.site_id, :size => 50 %></td>
+    </tr>
+    <tr data-hook="token">
+      <td><%= t(:analytics_token) %>:</td>
+      <td><%= text_field_tag :token, Spree::Dash::Config.token, :size => 50 %></td>
+    </tr>
+  </table>
+
+  <p class="form-buttons" data-hook="buttons">
+  <%= button t(:update) %> <%= link_to t(:cancel), admin_path %>
+  </p>
+
+<% end %>

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

@@ -0,0 +1,37 @@
+<% content_for :head do %>
+  <link type="text/css" rel="stylesheet" href="https://api.jirafe.com/dashboard/css/spree_ui.css" media="all" />
+  <script type="text/javascript" src="https://api.jirafe.com/dashboard/js/spree_ui.js"></script>
+<% end %>
+
+<h1><%= t(:overview) %></h1>
+
+<% if params[:dash_edit] %>
+  <%= render 'form' %>
+<% else %>
+  <% if Spree::Dash::Config.configured? %>
+    <div id="jirafe"></div>
+    <script type="text/javascript" defer="defer">
+        if (typeof jQuery != 'undefined') { 
+            (function($) {
+             $('#jirafe').jirafe({
+                api_url:    'https://api.jirafe.com/v1',
+                api_token:  '<%= Spree::Dash::Config.token %>',
+                app_id:     '<%= Spree::Dash::Config.app_id %>',
+                version:    'spree-v0.1.0'
+                });
+             })(jQuery);
+        }
+        setTimeout(function() {
+                if ($('mod-jirafe') == undefined){
+                $('messages').insert ("<ul class=\"messages\"><li class=\"error-msg\">We're unable to connect with the Jirafe service for the moment. Please wait a few minutes and refresh this page later.</li></ul>");
+                }
+                }, 10000);
+    </script>
+  <% else %>
+    <%= image_tag 'analytics_dashboard_preview.png' %>
+  <% end %>
+  <br>
+  <%= link_to t(:enter_token), admin_path(:dash_edit => true) %>
+<% end %>
+
+

data/app/views/spree/analytics/_header.html.erb

@@ -0,0 +1,12 @@
+<% if Spree::Dash::Config.configured? %>
+  <script type='text/javascript'>
+    var jirafe= <%= raw analytics_tags.to_json %>;
+    (function(){
+    var d=document,g=d.createElement('script'),s=d.getElementsByTagName('script')[0];
+    g.type='text/javascript',g.defer=g.async=true;g.src=d.location.protocol+'//c.jirafe.com/jirafe.js';
+    s.parentNode.insertBefore(g, s);
+    })();
+  </script>
+<% else %>
+  <!-- Spree Analytics has not been initialized correctly -->
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1 @@
+en:

data/config/routes.rb

@@ -1,4 +1,4 @@
-Rails.application.routes.draw do
+Spree::Core::Engine.routes.prepend do
   match '/admin' => 'admin/overview#index', :as => :admin
-  match '/admin/overview/get_report_data' => 'admin/overview#get_report_data'
+  match '/admin/dash_preferences' => 'admin/overview#preferences', :as => :admin_dash_preferences
 end

data/lib/spree/dash.rb

@@ -0,0 +1,9 @@
+require 'spree_core'
+
+module Spree
+  module Dash
+
+  end
+end
+
+require 'spree/dash/engine'

data/lib/spree/dash/engine.rb

@@ -0,0 +1,24 @@
+module Spree
+  module Dash
+    class Engine < Rails::Engine
+      isolate_namespace Spree
+      engine_name 'spree_dash'
+
+      initializer "spree.dash.environment", :before => :load_config_initializers do |app|
+        Spree::Dash::Config = Spree::DashConfiguration.new
+      end
+
+      def self.activate
+        Dir.glob(File.join(File.dirname(__FILE__), "../../../app/**/*_decorator*.rb")) do |c|
+          Rails.configuration.cache_classes ? require(c) : load(c)
+        end
+
+        Dir.glob(File.join(File.dirname(__FILE__), "../../app/overrides/*.rb")) do |c|
+          Rails.application.config.cache_classes ? require(c) : load(c)
+        end
+      end
+      config.to_prepare &method(:activate).to_proc
+
+    end
+  end
+end

data/lib/spree_dash.rb

@@ -1,7 +1 @@
-require 'spree_core'
-
-module SpreeDash
-  class Engine < Rails::Engine
-    engine_name 'spree_dash'
-  end
-end
+require 'spree/dash'

metadata

@@ -1,13 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: spree_dash
 version: !ruby/object:Gem::Version 
-  hash: 265
-  prerelease: 
+  hash: 15424055
+  prerelease: 6
   segments: 
+  - 1
   - 0
-  - 70
-  - 7
-  version: 0.70.7
+  - 0
+  - rc
+  - 1
+  version: 1.0.0.rc1
 platform: ruby
 authors: 
 - Brian Quinn
@@ -15,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-08 00:00:00 Z
+date: 2011-12-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -23,12 +25,14 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 265
+        hash: 15424055
         segments: 
+        - 1
+        - 0
         - 0
-        - 70
-        - 7
-        version: 0.70.7
+        - rc
+        - 1
+        version: 1.0.0.rc1
   requirement: *id001
   type: :runtime
   prerelease: false
@@ -44,25 +48,20 @@ extra_rdoc_files: []
 files: 
 - LICENSE
 - README.md
-- app/assets/javascripts/admin/dashboard.js
-- app/assets/javascripts/admin/spree_dash.js
-- app/assets/javascripts/store/spree_dash.js
-- app/assets/stylesheets/admin/dashboard.css.erb
-- app/assets/stylesheets/admin/spree_dash.css
-- app/assets/stylesheets/store/spree_dash.css
-- app/controllers/admin/overview_controller.rb
-- app/views/admin/overview/index.html.erb
+- app/assets/images/analytics_dashboard_preview.png
+- app/controllers/spree/admin/overview_controller.rb
+- app/controllers/spree/base_controller_decorator.rb
+- app/helpers/spree/analytics_helper.rb
+- app/models/spree/dash_configuration.rb
+- app/overrides/analytics_header.rb
+- app/views/spree/admin/overview/_form.html.erb
+- app/views/spree/admin/overview/index.html.erb
+- app/views/spree/analytics/_header.html.erb
+- config/locales/en.yml
 - config/routes.rb
+- lib/spree/dash/engine.rb
+- lib/spree/dash.rb
 - lib/spree_dash.rb
-- vendor/assets/javascripts/jqPlot/excanvas.min.js
-- vendor/assets/javascripts/jqPlot/jquery.jqplot.min.js
-- vendor/assets/javascripts/jqPlot/plugins/jqplot.canvasAxisLabelRenderer.min.js
-- vendor/assets/javascripts/jqPlot/plugins/jqplot.canvasAxisTickRenderer.min.js
-- vendor/assets/javascripts/jqPlot/plugins/jqplot.canvasTextRenderer.min.js
-- vendor/assets/javascripts/jqPlot/plugins/jqplot.categoryAxisRenderer.min.js
-- vendor/assets/javascripts/jqPlot/plugins/jqplot.dateAxisRenderer.min.js
-- vendor/assets/javascripts/jqPlot/plugins/jqplot.highlighter.min.js
-- vendor/assets/javascripts/jqPlot/plugins/jqplot.pieRenderer.min.js
 homepage: http://spreecommerce.com
 licenses: []
 
@@ -85,15 +84,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: 
 - none
-rubyforge_project: spree_dash
+rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3

data/app/assets/javascripts/admin/dashboard.js

@@ -1,144 +0,0 @@
-function number_with_delimiter(number, delimiter, separator) {
-  try {
-    var delimiter = delimiter || ",";
-    var separator = separator || ".";
-
-    var parts = number.toString().split('.');
-    parts[0] = parts[0].replace(/(\d)(?=(\d\d\d)+(?!\d))/g, "$1" + delimiter);
-    formatted_number = parts.join(separator);
-
-    if(formatted_number.length>=6 && formatted_number.length<=9){
-      var arr = formatted_number.split(",");
-      return arr[0] + " k";
-    }else if(formatted_number.length==10){
-      var arr = formatted_number.split(",");
-      return arr[0] + " m";
-    }else{
-      return formatted_number
-    }
-  } catch(e) {
-    return number
-  }
-}
-
-function handle_orders_by_day(r){
-  var new_points = eval(r);
-
-  if(new_points[0].length>0){
-    orders_by_day_settings.axes.xaxis.min = new_points[0][0][0].replace(/-/g, "/");
-    orders_by_day_settings.axes.xaxis.max = new_points[0][new_points[0].length -1][0].replace(/-/g, "/");
-  }
-
-  orders_by_day_settings.axes.yaxis.label = jQuery("#orders_by_day_value :selected").val();
-
-  jQuery("#order_by_day_title").text(orders + " " + jQuery("#orders_by_day_value :selected").val() + " " + by_day + " (" + jQuery("#orders_by_day_reports :selected").text() + ")");
-
-  jQuery('#orders_by_day').empty();
-  jQuery.jqplot('orders_by_day', new_points, orders_by_day_settings);
-
-}
-
-function handle_orders_total(r){
-  var values = eval(r);
-  
-  jQuery('#orders_total').text(number_with_delimiter(values[0].orders_total));
-  jQuery('#orders_line_total').text(number_with_delimiter(values[0].orders_line_total));
-  jQuery('#orders_adjustment_total').text(number_with_delimiter(values[0].orders_adjustment_total));
-  jQuery('#orders_adjustment_total').text(number_with_delimiter(values[0].orders_adjustment_total));
-}
-
-jQuery(document).ready(function(){  
-
-  if(typeof(orders_by_day_points)=="object"){
-    orders_by_day_settings = {
-      title: {
-        textColor: '#476D9B',
-        fontSize: '12pt',
-      }, 
-      grid: {background:'#fff', gridLineColor:'#fff',borderColor: '#476D9B'},
-      axes:{
-        yaxis:{
-          label:'Order (Count)',
-          labelRenderer: jQuery.jqplot.CanvasAxisLabelRenderer,						
-          autoscale:true, 
-          tickOptions:{
-            formatString:'%d',
-            fontSize: '10pt',
-            textColor: '#476D9B'
-          },
-          min: 0
-        },	
-        xaxis:{	 
-          renderer:jQuery.jqplot.DateAxisRenderer,
-          rendererOptions:{tickRenderer:jQuery.jqplot.CanvasAxisTickRenderer},
-          tickOptions:{
-            formatString:'%b %#d, %y',
-            angle: -30,
-            fontSize: '10pt',
-            textColor: '#476D9B'
-          },
-          min: orders_by_day_points[0][0][0].replace(/-/g, "/"), 
-          max: orders_by_day_points[0][orders_by_day_points[0].length -1][0].replace(/-/g, "/")//,
-          //tickInterval: '1 day'
-        }
-      },
-      series:[{lineWidth:3, color: '#0095DA', fillAndStroke: true, fill: true, fillColor: '#E6F7FF'}],
-      highlighter: {
-        formatString: "Date: %s <br />Value: %s ",
-        sizeAdjust: 7.5
-      }
-    };
-
-
-    jQuery.jqplot('orders_by_day', orders_by_day_points, orders_by_day_settings);
-
-    jQuery("div#orders_by_day_options select").change(function(){
-      var report = jQuery("#orders_by_day_reports :selected").val();
-      var value = jQuery("#orders_by_day_value :selected").val();
-
-      jQuery.ajax({
-           type: 'GET',
-           url: 'admin/overview/get_report_data',
-           data: ({report: 'orders_by_day', name: report, value: value, authenticity_token: AUTH_TOKEN}),
-           success: handle_orders_by_day
-      });
-
-      jQuery.ajax({
-           type: 'GET',
-           url: 'admin/overview/get_report_data',
-           data: ({report: 'orders_totals', name: report, authenticity_token: AUTH_TOKEN}),
-           success: handle_orders_total
-      });
-    });
-
-    best_selling_variants = jQuery.jqplot('best_selling_products', [best_selling_variants_points], {
-      grid: {background:'#fff',borderWidth: 0, borderColor: '#fff', shadow: false},
-      seriesDefaults:{
-        renderer:jQuery.jqplot.PieRenderer, 
-        rendererOptions:{padding:6,sliceMargin:0}
-      },
-      seriesColors: pie_colors
-    });
-
-
-    top_grossing_variants = jQuery.jqplot('top_grossing_products', [top_grossing_variants_points], {
-      grid: {background:'#fff',borderWidth: 0, borderColor: '#fff', shadow: false},
-      seriesDefaults:{
-        renderer:jQuery.jqplot.PieRenderer, 
-        rendererOptions:{padding:6,sliceMargin:0}
-      },
-
-      seriesColors: pie_colors
-    });
-
-    tbest_selling_taxons = jQuery.jqplot('best_selling_taxons', [best_selling_taxons_points], {
-      grid: {background:'#fff',borderWidth: 0, borderColor: '#fff', shadow: false},
-      seriesDefaults:{
-        renderer:jQuery.jqplot.PieRenderer, 
-        rendererOptions:{padding:6,sliceMargin:0}
-      },
-
-      seriesColors: pie_colors
-    });
-  }
-});