spree_analytics_trackers 1.0.0 → 1.0.1

data/app/overrides/add_product_viewed_to_products_show.rb

@@ -0,0 +1,10 @@
+spree_version = Gem.loaded_specs['spree_core'].version
+unless spree_version >= Gem::Version.create('3.4.0') && spree_version < Gem::Version.create('3.5.0')
+  Deface::Override.new(
+    virtual_path: 'spree/products/show',
+    name: 'add_product_viewed_to_products_show',
+    insert_before: "[data-hook='product_show']",
+    partial: 'spree/shared/trackers/segment/product_viewed.js',
+    original: '5426c263ccfe477b270b55024abebc77cf951c91' 
+  )
+end

data/app/overrides/add_products_searched_to_products_list.rb

@@ -0,0 +1,10 @@
+spree_version = Gem.loaded_specs['spree_core'].version
+unless spree_version >= Gem::Version.create('3.4.0') && spree_version < Gem::Version.create('3.5.0')
+  Deface::Override.new(
+    virtual_path: 'spree/shared/_products',
+    name: 'add_products_searched_to_products_list',
+    insert_before: "[data-hook='products_search_results_heading']",
+    partial: 'spree/shared/trackers/segment/products_searched.js',
+    original: '8b47dddca9dfaaacca3d462459c6c1ef06c09926' 
+  )
+end

data/app/overrides/add_segment_initializer_to_layout.rb

@@ -0,0 +1,10 @@
+spree_version = Gem.loaded_specs['spree_core'].version
+unless spree_version >= Gem::Version.create('3.3.0') && spree_version < Gem::Version.create('3.5.0') && spree_version != Gem::Version.create('3.5.0.alpha')
+  Deface::Override.new(
+    virtual_path: 'spree/layouts/spree_application',
+    name: 'add_segment_initializer_to_layout',
+    insert_top: "[data-hook='body']",
+    partial: 'spree/shared/trackers/segment/initializer.js',
+    original: '26b91c1073b75c93c9e9c89b1f0a6f52ef29a8f9'
+  )
+end

data/app/views/spree/admin/shared/_analytics_sidebar_menu.html.erb

@@ -0,0 +1,5 @@
+<% if can? :admin, Spree::Tracker %>
+  <ul class="nav nav-sidebar">
+    <%= tab :analytic_trackers, url: spree.admin_trackers_path, icon: 'tasks' %>
+  </ul>
+<% end %>

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

@@ -0,0 +1,36 @@
+<div data-hook="admin_tracker_form_fields" class="row">
+  <div class="col-xs-12 col-md-4" data-hook="analytics_engine">
+    <%= f.field_container :engine, class: ["form-group"], "data-hook" => "analytics_engine" do %>
+      <%= f.label :engine, Spree.t(:analytics_engine) %>
+      <%= f.select :engine, Spree::Tracker.engines.keys.sort.map { |k| [k.humanize, k] }, {}, { class: 'select2' } %>
+      <%= f.error_message_on :engine %>
+    <% end %>
+  </div>
+  <div class="col-xs-12 col-md-8">
+    <div data-hook="active" class="form-group">
+      <%= label_tag nil, Spree.t(:active) %>
+      <div class="radio">
+        <%= label_tag :tracker_active_true do %>
+          <%= radio_button(:tracker, :active, true) %>
+          <%= Spree.t(:say_yes) %>
+        <% end %>
+      </div>
+      <div class="radio">
+        <%= label_tag :tracker_active_false do %>
+          <%= radio_button(:tracker, :active, false) %>
+          <%= Spree.t(:say_no) %>
+        <% end %>
+      </div>
+    </div>
+  </div>
+  <div class="col-xs-12 col-md-4" data-hook="analytics_id">
+    <%= f.field_container :analytics_id, class: ["form-group"], "data-hook" => "analytics_id" do %>
+      <%= f.label :analytics_id, Spree.t(:google_analytics_id) %>
+      <%= f.text_field :analytics_id, class: 'form-control' %>
+      <%= f.error_message_on :analytics_id %>
+    <% end %>
+  </div>
+  <div data-hook="additional_tracker_fields"></div>
+</div>
+<div data-hook="admin_tracker_form_fields" class="row">
+</div>

data/app/views/spree/admin/trackers/edit.html.erb

@@ -0,0 +1,13 @@
+<% content_for :page_title do %>
+  <%= link_to Spree.t(:analytics_trackers), spree.admin_trackers_url %> /
+  <%= @tracker.analytics_id %>
+<% end %>
+
+<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @tracker } %>
+
+<%= form_for [:admin, @tracker] do |f| %>
+  <fieldset>
+    <%= render partial: 'form', locals: { f: f } %>
+    <%= render partial: 'spree/admin/shared/edit_resource_links' %>
+  </fieldset>
+<% end %>

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

@@ -0,0 +1,44 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:analytics_trackers) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <%= button_link_to Spree.t(:new_tracker), new_object_url, class: "btn-success", icon: 'add', id: 'admin_new_tracker_link' %>
+<% end if can? :create, Spree::Tracker %>
+
+<% if @trackers.any? %>
+  <table class="table">
+    <colgroup>
+      <col style="width: 30%">
+      <col style="width: 40%">
+      <col style="width: 15%">
+      <col style="width: 15%">
+    </colgroup>
+    <thead>
+      <tr data-hook="admin_trackers_index_headers">
+        <th><%= Spree.t(:google_analytics_id) %></th>
+        <th><%= Spree.t(:analytics_engine) %></th>
+        <th class="text-center"><%= Spree.t(:active) %></th>
+        <th class="actions"></th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @trackers.each do |tracker|%>
+        <tr id="<%= spree_dom_id tracker %>" data-hook="admin_trackers_index_rows">
+          <td><%= tracker.analytics_id %></td>
+          <td><%= tracker.engine.humanize %></td>
+          <td class="text-center"><%= tracker.active ? Spree.t(:say_yes) : Spree.t(:say_no) %></td>
+          <td class="actions text-right">
+            <%= link_to_edit(tracker, no_text: true) if can? :edit, tracker %>
+            <%= link_to_delete(tracker, no_text: true) if can? :delete, tracker %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% else %>
+  <div class="alert alert-warning">
+    <%= Spree.t(:no_resource_found, resource: plural_resource_name(Spree::Tracker)) %>,
+    <%= link_to(Spree.t(:add_one), new_object_url) if can? :create, Spree::Tracker %>!
+  </div>
+<% end %>

data/app/views/spree/admin/trackers/new.html.erb

@@ -0,0 +1,13 @@
+<% content_for :page_title do %>
+  <%= link_to Spree.t(:analytics_trackers), spree.admin_trackers_url %> /
+  <%= Spree.t(:new_tracker) %>
+<% end %>
+
+<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @tracker } %>
+
+<%= form_for [:admin, @tracker] do |f| %>
+  <fieldset>
+    <%= render partial: 'form', locals: { f: f } %>
+    <%= render partial: 'spree/admin/shared/new_resource_links' %>
+  </fieldset>
+<% end %>

data/app/views/spree/shared/_google_add_items.html.erb

@@ -0,0 +1,13 @@
+if (typeof ga !== 'undefined') {
+  <% @order.line_items.each do |line_item| %>
+  ga('ec:addProduct', {               // Provide product details in a productFieldObject.
+    'id': '<%= j (line_item.sku.present? ? line_item.sku : line_item.variant_id.to_s) %>',  // Product ID (string).
+    'name': '<%= j line_item.name %>', // Product name (string).
+    'category': '<%= j line_item.category.try(:name) %>',            // Product category (string).
+    'brand': '<%= j line_item.brand.try(:name) %>',                // Product brand (string).
+    'variant': '<%= j line_item.options_text %>',               // Product variant (string).
+    'price': '<%= line_item.price %>',
+    'quantity': <%= line_item.quantity %>
+  });
+  <% end %>
+}

data/app/views/spree/shared/_google_analytics.html.erb

@@ -0,0 +1,18 @@
+<% if tracker = Spree::Tracker.current(:google_analytics) %>
+  <script>
+    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+    (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+    m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+    })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+    <% if user_analytics_id = try_spree_current_user.try(:analytics_id) %>
+      ga('create', { 'trackingId': '<%= tracker.analytics_id %>', 'cookieDomain': 'auto', 'userId': '<%= user_analytics_id %>' });
+    <% else %>
+      ga('create', '<%= tracker.analytics_id %>', 'auto');
+    <% end %>
+
+    ga('require', 'displayfeatures');
+    <%= yield :google_analytics %>
+    ga('send', 'pageview');
+  </script>
+<% end %>

data/app/views/spree/shared/_google_checkout.html.erb

@@ -0,0 +1,14 @@
+<%# more info: https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce %>
+<script>
+  if (typeof ga !== 'undefined') {
+    ga('require', 'ec');
+    ga('set', '&cu', '<%= current_currency %>');
+
+    <%= render partial: 'spree/shared/google_add_items', locals: { order: @order } %>
+
+    // Add the step number and additional info about the checkout to the action.
+    ga('ec:setAction','checkout', {
+      'step': <%= (@order.checkout_steps.index(@order.state) + 1) %>
+    });
+  }
+</script>

data/app/views/spree/shared/_google_purchase.html.erb

@@ -0,0 +1,19 @@
+<% if order_just_completed?(@order) %>
+  <script>
+  <%# more info: https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce %>
+  if (typeof ga !== 'undefined') {
+    ga('require', 'ec');
+    ga('set', '&cu', '<%= current_currency %>');
+
+    <%= render partial: 'spree/shared/google_add_items', locals: { order: @order } %>
+
+    ga('ec:setAction', 'purchase', { // Transaction details are provided in an actionFieldObject.
+      'id': '<%= j @order.number %>', // Transaction ID. Required.
+      'affiliation': '<%= current_store.name %>', // Affiliation (string).
+      'revenue': '<%= @order.total %>',   // Revenue (currency).
+      'tax': '<%= @order.tax_total %>',   // Tax.
+      'shipping': '<%= @order.ship_total %>' // Shipping.
+    });
+  }
+  </script>
+<% end %>

data/app/views/spree/shared/trackers/segment/_cart_viewed.js.erb

@@ -0,0 +1,22 @@
+<script>
+  if (typeof analytics !== 'undefined') {
+    analytics.track('Cart Viewed', {
+      cart_id: '<%= @order.number %>',
+      products: [
+      <% @order.line_items.each_with_index do |line_item, index| %>
+        <%= product_for_segment(line_item, position: index+1, quantity: line_item.quantity) %>,
+      <% end %>
+      ]
+    });
+
+    analytics.page('Cart Viewed', {
+      cart_id: '<%= @order.number %>',
+      products: [
+      <% @order.line_items.each_with_index do |line_item, index| %>
+        <%= product_for_segment(line_item, position: index+1, quantity: line_item.quantity) %>,
+      <% end %>
+      ]
+    });
+
+  }
+</script>

data/app/views/spree/shared/trackers/segment/_checkout_step_viewed.js.erb

@@ -0,0 +1,12 @@
+<script>
+  if (typeof analytics !== 'undefined') {
+    analytics.track('Checkout Step Viewed', {
+      checkout_id: '<%= @order.number %>',
+      step: '<%= (@order.checkout_steps.index(@order.state) + 1) %>'
+    });
+    analytics.page('Checkout Step Viewed', {
+      checkout_id: '<%= @order.number %>',
+      step: '<%= (@order.checkout_steps.index(@order.state) + 1) %>'
+    });
+  }
+</script>

data/app/views/spree/shared/trackers/segment/_initializer.js.erb

@@ -0,0 +1,8 @@
+<% if tracker = Spree::Tracker.current(:segment) %>
+  <script>
+    !function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t,e){var n=document.createElement("script");n.type="text/javascript";n.async=!0;n.src="https://cdn.segment.com/analytics.js/v1/"+t+"/analytics.min.js";var a=document.getElementsByTagName("script")[0];a.parentNode.insertBefore(n,a);analytics._loadOptions=e};analytics.SNIPPET_VERSION="4.1.0";
+    analytics.load('<%=tracker.analytics_id%>'.replace(/^\s+|\s+$/g, ''));
+    analytics.page()
+    }}();
+  </script>
+<% end %>

data/app/views/spree/shared/trackers/segment/_order_complete.js.erb

@@ -0,0 +1,48 @@
+<% if order_just_completed?(@order) %>
+  <script>
+    if (typeof analytics !== 'undefined') {
+      analytics.track('Order Completed', {
+        order_id: '<%= @order.number %>',
+        total: <%= @order.total %>,
+        shipping: <%= @order.shipment_total %>,
+        tax: <%= @order.additional_tax_total %>,
+        discount: <%= @order.promo_total %>,
+        coupon: '<%= @order.promo_code %>',
+        currency: '<%= @order.currency %>',
+        products: [
+        <% @order.line_items.each do |line_item| %>
+          {
+            product_id: '<%= line_item.product.id %>',
+            sku: '<%= line_item.variant.sku %>',
+            name: '<%= line_item.product.name %>',
+            price: <%= line_item.price %>,
+            quantity: <%= line_item.quantity %>
+          },
+        <% end %>
+        ]
+      });
+
+      analytics.page('Order Completed', {
+        order_id: '<%= @order.number %>',
+        total: <%= @order.total %>,
+        shipping: <%= @order.shipment_total %>,
+        tax: <%= @order.additional_tax_total %>,
+        discount: <%= @order.promo_total %>,
+        coupon: '<%= @order.promo_code %>',
+        currency: '<%= @order.currency %>',
+        products: [
+        <% @order.line_items.each do |line_item| %>
+          {
+            product_id: '<%= line_item.product.id %>',
+            sku: '<%= line_item.variant.sku %>',
+            name: '<%= line_item.product.name %>',
+            price: <%= line_item.price %>,
+            quantity: <%= line_item.quantity %>
+          },
+        <% end %>
+        ]
+      });
+
+    }
+  </script>
+<% end %>

data/app/views/spree/shared/trackers/segment/_product_added.js.erb

@@ -0,0 +1,9 @@
+<% if @variant %>
+  <script>
+    if (typeof analytics !== 'undefined') {
+      analytics.track('Product Added', <%= product_for_segment(@variant.product, cart_id: @order.number) %>);
+      analytics.page('Product Added', <%= product_for_segment(@variant.product, cart_id: @order.number) %>);
+
+    }
+  </script>
+<% end %>

data/app/views/spree/shared/trackers/segment/_product_list_filtered.js.erb

@@ -0,0 +1,32 @@
+<% if params[:search].present? %>
+  <script>
+    if (typeof analytics !== 'undefined') {
+      analytics.track('Product List Filtered', {
+        filters: [
+          <% params[:search].to_unsafe_h.each do |type, value| %>
+            <%= { type: type, value: value } .to_json.html_safe %>,
+          <% end %>
+        ],
+        products: [
+        <% @products.each_with_index do |product, index| %>
+          <%= product_for_segment(product, position: index+1, image: product.images.first) %>,
+        <% end %>
+        ]
+      });
+
+      analytics.page('Product List Filtered', {
+        filters: [
+          <% params[:search].to_unsafe_h.each do |type, value| %>
+            <%= { type: type, value: value } .to_json.html_safe %>,
+          <% end %>
+        ],
+        products: [
+        <% @products.each_with_index do |product, index| %>
+          <%= product_for_segment(product, position: index+1, image: product.images.first) %>,
+        <% end %>
+        ]
+      });
+
+    }
+  </script>
+<% end %>

data/app/views/spree/shared/trackers/segment/_product_list_viewed.js.erb

@@ -0,0 +1,22 @@
+<script>
+  if (typeof analytics !== 'undefined') {
+    analytics.track('Product List Viewed', {
+      category: '<%= @taxon.try(:name) %>',
+      products: [
+      <% products.each_with_index do |product, index| %>
+        <%= product_for_segment(product, position: index+1, image: product.images.first) %>,
+      <% end %>
+      ]
+    });
+
+    analytics.page('Product List Viewed', {
+      category: '<%= @taxon.try(:name) %>',
+      products: [
+      <% products.each_with_index do |product, index| %>
+        <%= product_for_segment(product, position: index+1, image: product.images.first) %>,
+      <% end %>
+      ]
+    });
+
+  }
+</script>

data/app/views/spree/shared/trackers/segment/_product_viewed.js.erb

@@ -0,0 +1,6 @@
+<script>
+  if (typeof analytics !== 'undefined') {
+    analytics.track('Product Viewed', <%= product_for_segment(@product, image: @product.images.first) %>);
+    analytics.page('Product Viewed', <%= product_for_segment(@product, image: @product.images.first) %>);
+  }
+</script>

data/app/views/spree/shared/trackers/segment/_products_searched.js.erb

@@ -0,0 +1,12 @@
+<% if params.key?(:keywords) %>
+  <script>
+    if (typeof analytics !== 'undefined') {
+      analytics.track('Products Searched', {
+        query: '<%= params[:keywords] %>',
+      });
+      analytics.page('Products Searched', {
+        query: '<%= params[:keywords] %>',
+      });
+    }
+  </script>
+<% end %>

data/bin/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_analytics_trackers/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en.yml

@@ -0,0 +1,20 @@
+en:
+  activerecord:
+    attributes:
+      spree/tracker:
+        one: Tracker
+        other: Trackers
+  spree:
+    analytics_engine: Analytics Engine
+    analytics_trackers: Analytics Trackers
+    new_tracker: New Tracker
+    google_analytics: Google Analytics
+    google_analytics_id: Analytics ID
+    analytics_desc_header_1: Spree Analytics
+    analytics_desc_header_2: Live analytics integrated into your Spree dashboard
+    analytics_desc_list_1: Get live sales information as it happens
+    analytics_desc_list_2: Requires only a free Spree account to activate
+    analytics_desc_list_3: Absolutely no code to install
+    analytics_desc_list_4: It's completely free!
+    analytics_engine: Analytics Engine
+    analytics_trackers: Analytics Trackers