spree_analytics_trackers 1.1.0 → 2.0.0.rc1

data/app/overrides/add_products_searched_to_products_list.rb

@@ -1,9 +1,9 @@
 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',
+    virtual_path: 'spree/products/index',
     name: 'add_products_searched_to_products_list',
-    insert_before: "[data-hook='products_search_results_heading']",
+    insert_before: '[data-hook="search_results"]',
     partial: 'spree/shared/trackers/segment/products_searched.js',
     original: '8b47dddca9dfaaacca3d462459c6c1ef06c09926' 
   )

data/app/overrides/add_segment_initializer_to_layout.rb

@@ -3,8 +3,16 @@ unless spree_version >= Gem::Version.create('3.3.0') && spree_version < Gem::Ver
   Deface::Override.new(
     virtual_path: 'spree/layouts/spree_application',
     name: 'add_segment_initializer_to_layout',
-    insert_top: "[data-hook='body']",
+    insert_bottom: '[data-hook="inside_head"]',
     partial: 'spree/shared/trackers/segment/initializer.js',
-    original: '26b91c1073b75c93c9e9c89b1f0a6f52ef29a8f9'
+    original: '6841b819babbe4df1f03d0bc8e05dc81bf0d45ad'
+  )
+
+  Deface::Override.new(
+    virtual_path: 'spree/layouts/checkout',
+    name: 'add_segment_initializer_to_spree_checkout',
+    insert_bottom: '[data-hook="inside_head"]',
+    partial: 'spree/shared/trackers/segment/initializer.js',
+    original: '6841b819babbe4df1f03d0bc8e05dc81bf0d45ad'
   )
 end

data/app/overrides/add_segment_page_viewed_to_layout.rb

@@ -0,0 +1,18 @@
+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_page_tracker_to_body',
+    insert_bottom: "[data-hook='body']",
+    partial: 'spree/shared/trackers/segment/page_viewed.js',
+    original: '6841b819babbe4df1f03d0bc8e05dc81bf0d45ad'
+  )
+
+  Deface::Override.new(
+    virtual_path: 'spree/layouts/checkout',
+    name: 'add_segment_page_tracker_to_spree_checkout',
+    insert_bottom: "[data-hook='body']",
+    partial: 'spree/shared/trackers/segment/page_viewed.js',
+    original: '6841b819babbe4df1f03d0bc8e05dc81bf0d45ad'
+  )
+end

data/app/presenters/spree_analytics_trackers/base_presenter.rb

@@ -0,0 +1,14 @@
+module SpreeAnalyticsTrackers
+  class BasePresenter
+    include Rails.application.routes.url_helpers
+
+    def initialize(resource = {}, options = {})
+      @resource = resource
+      @options = options
+    end
+
+    def to_json
+      serialize_resource(@resource, @options).to_json
+    end
+  end
+end

data/app/presenters/spree_analytics_trackers/segment/order_presenter.rb

@@ -0,0 +1,32 @@
+module SpreeAnalyticsTrackers
+  module Segment
+    class OrderPresenter < SpreeAnalyticsTrackers::BasePresenter
+      private
+
+      def serialize_resource(resource, options = {})
+        {
+          order_id: resource.number.to_s,
+          total: resource.total&.to_f,
+          shipping: resource.shipment_total&.to_f,
+          tax: resource.additional_tax_total&.to_f,
+          discount: resource.promo_total&.to_f,
+          coupon: resource.promo_code,
+          currency: resource.currency,
+          products: resource.line_items.map { |li| serialize_line_item(li) }
+        }
+      end
+
+      private
+
+      def serialize_line_item(line_item)
+        {
+          product_id: line_item.product_id&.to_s,
+          sku: line_item.sku&.to_s,
+          name: line_item.name,
+          price: line_item.price&.to_f,
+          quantity: line_item.quantity
+        }
+      end
+    end
+  end
+end

data/app/presenters/spree_analytics_trackers/segment/product_presenter.rb

@@ -0,0 +1,40 @@
+module SpreeAnalyticsTrackers
+  module Segment
+    class ProductPresenter < SpreeAnalyticsTrackers::BasePresenter
+      private
+
+      def serialize_resource(resource, options = {})
+        {
+          resource_id: resource.id.to_s,
+          sku: resource.sku&.to_s,
+          category: resource.category&.name,
+          name: resource.name,
+          brand: brand_name,
+          price: resource.price_in(current_currency).amount&.to_f,
+          currency: current_currency,
+          url: resource_url(resource)
+        }.tap do |hash|
+          hash[:image_url] = segment_image_url(hash, options)
+        end.merge(options)
+      end
+
+      def segment_image_url(hash, options)
+        
+      end
+
+      def brand_name
+        resource.vendor.name if defined?(SpreeMultiVendor) && resource.defined?(:vendor) && resource.vendor.present?
+        
+        resource.brand&.name
+      end
+
+      def current_currency
+        @current_currency ||= options[:current_currency]
+      end
+
+      def locale
+        @locale ||= options[:locale]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+<% if @order.present? && !@order.completed? && Spree::Tracker.current(:google_analytics) %>
+  <script>
+    if (typeof gtag !== 'undefined') {
+      gtag('event', 'checkout_progress', {
+        checkout_step: '<%= (@order.checkout_steps.index(@order.state) + 1) %>',
+        items: [
+          <% @order.line_items.each do |line_item| %>
+            <%= ga_line_item(line_item) %>,
+          <% end %>
+        ],
+
+        coupon: '<%= @order.promo_code %>',
+      });
+
+      gtag('event', 'set_checkout_option', {
+        'checkout_step': '<%= (@order.checkout_steps.index(@order.state) + 1) %>',
+        'checkout_option': '<%= @order.state %>'
+      });
+    };
+  </script>
+<% end %>

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

@@ -0,0 +1,11 @@
+<% if tracker = Spree::Tracker.current(:google_analytics) %>
+  <!-- Global site tag (gtag.js) - Google Analytics -->
+  <script async src="https://www.googletagmanager.com/gtag/js?id=<%= tracker.analytics_id %>"></script>
+  <script>
+    window.dataLayer = window.dataLayer || [];
+    function gtag(){dataLayer.push(arguments);}
+    gtag('js', new Date());
+
+    gtag('config', '<%= tracker.analytics_id %>', { 'send_page_view': false });
+  </script>
+<% end %>

data/app/views/spree/shared/trackers/google_analytics/_page_viewed.js.erb

@@ -0,0 +1,13 @@
+<% if tracker = Spree::Tracker.current(:google_analytics) %>
+  <script>
+    if (typeof gtag !== 'undefined') {
+      <% if user_id = try_spree_current_user.try(:id) %>
+        gtag('config', '<%= tracker.analytics_id %>', {
+          'user_id': '<%= user_id %>'
+        });
+      <% else %>
+        gtag('config', '<%= tracker.analytics_id %>');
+      <% end %>
+    }
+  </script>
+<% end %>

data/app/views/spree/shared/trackers/google_analytics/_purchase.js.erb

@@ -0,0 +1,19 @@
+<% if @order.present? && order_just_completed?(@order) && Spree::Tracker.current(:google_analytics) %>
+  <script>
+    if (typeof gtag !== 'undefined') {
+      gtag('event', 'purchase', {
+        transaction_id: '<%= @order.number %>',
+        value: <%= @order.total&.to_f %>,
+        currency: '<%= @order.currency %>',
+        tax: <%= @order.tax_total&.to_f %>,
+        shipping: <%= @order.shipment_total&.to_f %>,
+        coupon: '<%= @order.promo_code %>',
+        items: [
+          <% @order.line_items.each do |line_item| %>
+            <%= ga_line_item(line_item) %>,
+          <% end %>
+        ]
+      });
+    }
+  </script>
+<% end %>

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

@@ -1,22 +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 %>
-      ]
-    });
+<% if @order.present? && !@order.complete? && Spree::Tracker.current(:segment) %>
+  <script>
+    if (typeof analytics !== 'undefined') {
+      var segmentCartJson = {
+        cart_id: '<%= @order.number %>',
+        products: [
+        <% @order.line_items.each_with_index do |line_item, index| %>
+          <%= product_for_segment(
+            line_item.product, 
+            position: index+1, 
+            quantity: line_item.quantity, 
+            image: default_image_for_product_or_variant(line_item.variant)
+          ) %>,
+        <% 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>
+      analytics.track('Cart Viewed', segmentCartJson);
+      analytics.page('Cart Viewed', segmentCartJson);
+    }
+  </script>
+<% end %>

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

@@ -1,12 +1,14 @@
-<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>
+<% if @order.present? && !@order.completed? && Spree::Tracker.current(:segment) %>
+  <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>
+<% end %>  

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

@@ -1,8 +1,7 @@
 <% 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()
+      analytics.load('<%=tracker.analytics_id%>'.replace(/^\s+|\s+$/g, ''));
     }}();
   </script>
 <% end %>

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

@@ -1,48 +1,8 @@
-<% if order_just_completed?(@order) %>
+<% if @order.present? && order_just_completed?(@order) && Spree::Tracker.current(:segment) %>
+  <% order_json = SpreeAnalyticsTrackers::Segment::OrderPresenter.new(@order).to_json %>
   <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 %>
-        ]
-      });
-
+      analytics.page('Order Completed', <%= order_json.html_safe %>);
     }
   </script>
 <% end %>

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

@@ -0,0 +1,7 @@
+<% if tracker = Spree::Tracker.current(:segment) %>
+  <script>
+    if (typeof analytics !== 'undefined') {
+      analytics.page();
+    }
+  </script>
+<% end %>

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

@@ -1,32 +1,21 @@
-<% if params[:search].present? %>
+<% if any_filtering_params? && Spree::Tracker.current(:segment) %>
   <script>
     if (typeof analytics !== 'undefined') {
-      analytics.track('Product List Filtered', {
+      var segmentProductListFilteredJson = {
         filters: [
-          <% params[:search].to_unsafe_h.each do |type, value| %>
+          <% filtering_params_with_values.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) %>,
+          <%= product_for_segment(product, position: index+1) %>,
         <% 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 %>
-        ]
-      });
+      }
 
+      analytics.track('Product List Filtered', segmentProductListFilteredJson);
+      analytics.page('Product List Filtered', segmentProductListFilteredJson);
     }
   </script>
 <% end %>

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

@@ -1,22 +1,17 @@
-<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 %>
-      ]
-    });
+<% if defined?(products) && products.present? && Spree::Tracker.current(:segment) %>
+  <script>
+    if (typeof analytics !== 'undefined') {
+      var segmentProductListViewedJson = {
+        category: '<%= @taxon&.name %>',
+        products: [
+        <% products.each_with_index do |product, index| %>
+          <%= product_for_segment(product, position: index+1, image: default_image_for_product_or_variant(product)) %>,
+        <% 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>
+      analytics.track('Product List Viewed', segmentProductListViewedJson);
+      analytics.page('Product List Viewed', segmentProductListViewedJson);
+    }
+  </script>
+<% end %>

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

@@ -1,6 +1,10 @@
-<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>
+<% if @product.present? && Spree::Tracker.current(:segment) %>
+  <script>
+    if (typeof analytics !== 'undefined') {
+      var segmentProductViewed = <%= product_for_segment(@product, image: default_image_for_product_or_variant(@product)) %>;
+
+      analytics.page('Product Viewed', segmentProductViewed);
+      analytics.track('Product Viewed', segmentProductViewed);
+    }
+  </script>
+<% end %>