spree_analytics_trackers 1.0.0 → 2.1.0

data/app/models/spree/tracker.rb

@@ -0,0 +1,31 @@
+module Spree
+  class Tracker < Spree::Base
+    TRACKING_ENGINES = %i(google_analytics segment).freeze
+    enum engine: TRACKING_ENGINES
+
+    after_commit :clear_cache
+
+    validates :analytics_id, presence: true, uniqueness: { scope: [:engine, :store_id], case_sensitive: false }
+    validates :store, presence: true
+
+    scope :active, -> { where(active: true) }
+
+    belongs_to :store
+
+    def self.current(engine = nil, store = nil)
+      engine ||= TRACKING_ENGINES.first
+      store  ||= Spree::Store.default
+
+      tracker = Rails.cache.fetch("current_tracker/#{engine}/#{store.id}") do
+        active.find_by(store: store, engine: engine)
+      end
+      tracker.analytics_id.present? ? tracker : nil if tracker
+    end
+
+    def clear_cache
+      TRACKING_ENGINES.each do |engine|
+        Rails.cache.delete("current_tracker/#{engine}/#{store_id}")
+      end
+    end
+  end
+end

data/app/models/spree_analytics_trackers/user_decorator.rb

@@ -0,0 +1,9 @@
+module SpreeAnalyticsTrackers
+  module UserDecorator
+    def analytics_id
+      id
+    end
+  end
+end
+
+::Spree.user_class.prepend(::SpreeAnalyticsTrackers::UserDecorator)

data/app/overrides/add_analytics_to_admin_sidebar.rb

@@ -0,0 +1,8 @@
+if Gem.loaded_specs['spree_core'].version >= Gem::Version.create('3.5.0')
+  Deface::Override.new(
+    virtual_path: 'spree/admin/shared/sub_menu/_configuration',
+    name: 'add_analytics_to_admin_sidebar',
+    insert_bottom: '[data-hook="admin_configurations_sidebar_menu"]',
+    partial: 'spree/admin/shared/analytics_sidebar_menu'
+  )
+end

data/app/overrides/add_cart_viewed_to_orders_edit.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/orders/edit',
+    name: 'add_cart_viewed_to_orders_edit',
+    insert_top: '[data-hook="cart_container"]',
+    partial: 'spree/shared/trackers/segment/cart_viewed.js',
+    original: 'e0a3dcdf759c4ec9fad085cd8a5360c8d68167f5'
+  )
+end

data/app/overrides/add_checkout_step_viewed_to_checkout_edit.rb

@@ -0,0 +1,18 @@
+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/checkout/edit',
+    name: 'add_segment_checkout_step_viewed_to_checkout_edit',
+    insert_after: '[data-hook="checkout_content"]',
+    partial: 'spree/shared/trackers/segment/checkout_step_viewed.js',
+    original: '806d2120a1ca1050fb093962fee10363c0944b0a'
+  )
+
+  Deface::Override.new(
+    virtual_path: 'spree/checkout/edit',
+    name: 'add_ga_checkout_step_viewed_to_checkout_edit',
+    insert_after: '[data-hook="checkout_content"]',
+    partial: 'spree/shared/trackers/google_analytics/checkout_step_viewed.js',
+    original: '0ac5c18a2db215bf8ba30470a0e5d69e00d0313a'
+  )
+end

data/app/overrides/add_google_analytics_page_view_to_spree_application.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/shared/_head',
+    name: 'add_google_analytics_page_viewed_to_spree_application',
+    insert_before: 'meta',
+    partial: 'spree/shared/trackers/google_analytics/page_viewed.js',
+    original: '6841b819babbe4df1f03d0bc8e05dc81bf0d45ad'
+  )
+end

data/app/overrides/add_google_analytics_to_spree_application.rb

@@ -0,0 +1,9 @@
+if Gem.loaded_specs['spree_core'].version >= Gem::Version.create('3.5.0.alpha')
+  Deface::Override.new(
+    virtual_path: 'spree/shared/_head',
+    name: 'add_google_analytics_initializer_to_spree_application',
+    insert_after: 'title',
+    partial: 'spree/shared/trackers/google_analytics/initializer.js',
+    original: 'cfa30a2831d9a41394c03229cd28b3c7eee69585'
+  )
+end

data/app/overrides/add_google_purchase_to_orders_show.rb

@@ -0,0 +1,9 @@
+if Gem.loaded_specs['spree_core'].version >= Gem::Version.create('3.5.0')
+  Deface::Override.new(
+    virtual_path: 'spree/orders/show',
+    name: 'add_google_purchase_to_orders_show',
+    insert_before: "#order_summary",
+    partial: 'spree/shared/trackers/google_analytics/purchase.js',
+    original: 'ac7f302922a3c1bb080095296ccc20e42bab2967' 
+  )
+end

data/app/overrides/add_order_complete_to_orders_show.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')
+  Deface::Override.new(
+    virtual_path: 'spree/orders/show',
+    name: 'add_order_complete_to_orders_show',
+    insert_before: "#order_summary",
+    partial: 'spree/shared/trackers/segment/order_complete.js',
+    original: 'ac7f302922a3c1bb080095296ccc20e42bab2967' 
+  )
+end

data/app/overrides/add_product_list_filtered_to_taxons_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/taxons/_header',
+    name: 'add_product_list_filtered_to_taxons_show',
+    insert_before: ".taxon-title",
+    original: '2d71d85f4cb141a6ff90264e48915493d6856e9b',
+    partial: 'spree/shared/trackers/segment/product_list_filtered.js'
+  )
+end

data/app/overrides/add_product_list_viewed_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_product_list_viewed_to_products_list',
+    insert_before: '[data-hook="homepage_products"]',
+    partial: 'spree/shared/trackers/segment/product_list_viewed.js',
+    original: '8b47dddca9dfaaacca3d462459c6c1ef06c09926' 
+  )
+end

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_bottom: '[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/products/index',
+    name: 'add_products_searched_to_products_list',
+    insert_before: '[data-hook="search_results"]',
+    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/shared/_head',
+    name: 'add_segment_initializer_to_layout',
+    insert_after: 'title',
+    partial: 'spree/shared/trackers/segment/initializer.js',
+    original: '6841b819babbe4df1f03d0bc8e05dc81bf0d45ad'
+  )
+end

data/app/overrides/add_segment_page_viewed_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/shared/_head',
+    name: 'add_segment_page_tracker_to_body',
+    insert_before: 'meta',
+    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/admin/shared/_analytics_sidebar_menu.html.erb

@@ -0,0 +1,3 @@
+<%= configurations_sidebar_menu_item(
+    Spree.t(:analytics), spree.admin_trackers_path
+  ) if can? :manage, Spree::Config %>

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

@@ -0,0 +1,42 @@
+<div data-hook="admin_tracker_form_fields" class="row">
+  <div class="col-12 col-lg-6" 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, @engines, {}, { class: 'select2' } %>
+      <%= f.error_message_on :engine %>
+    <% end %>
+  </div>
+  <div class="col-12 col-lg-6">
+    <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-12 col-lg-6" 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 class="col-12 col-lg-6">
+    <div data-hook="store" class="form-group">
+      <%= label_tag :tracker_store, Spree.t(:store) %>
+      <%= collection_select(:tracker, :store_id, @stores, :id, :name, { include_blank: true }, {id: 'store_id', class: 'select2'}) %>
+    </div>
+  </div>
+  <div class="col-12 col-lg-6" 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,42 @@
+<% 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">
+    <thead>
+      <tr data-hook="admin_trackers_index_headers">
+        <th><%= Spree.t(:google_analytics_id) %></th>
+        <th><%= Spree.t(:analytics_engine) %></th>
+        <th><%= Spree.t(:store) %></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><%= tracker.store&.name %></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-info">
+    <%= 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/trackers/google_analytics/_checkout_step_viewed.js.erb

@@ -0,0 +1,19 @@
+<% if ga_enabled? && @order.present? && !@order.completed? %>
+  <script>
+    window.addEventListener('turbolinks:load', function() {
+      if (typeof gtag !== 'undefined') {
+        clearGAplugins();
+        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 %>',
+          checkout_option: '<%= @order.state %>'
+        });
+      };
+    });
+  </script>
+<% end %>

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

@@ -0,0 +1,25 @@
+<% if ga_enabled? %>
+  <!-- Global site tag (gtag.js) - Google Analytics -->
+  <script async src="https://www.googletagmanager.com/gtag/js?id=<%= ga_tracker.analytics_id %>"></script>
+  <script>
+    window.dataLayer = window.dataLayer || [];
+    function gtag(){dataLayer.push(arguments);}
+    gtag('js', new Date());
+
+    gtag('config', '<%= ga_tracker.analytics_id %>', { 'send_page_view': false });
+    gtag('set', 'allow_google_signals', true )
+    gtag('set', 'allow_ad_personalization_signals', true );
+
+    function clearGAplugins() {
+      if (typeof ga !== "undefined" && typeof ga.getAll === "function") {
+        var trackingDom = ga.getAll()[0].get('trackingId');
+        if (trackingDom !== undefined) {
+          var trackingId = trackingDom.split('-').join('_')
+          if (trackingId !== undefined && ga.o !== undefined && ga.o["gtag_" + trackingId] !== undefined) {
+            delete ga.o["gtag_" + trackingId].plugins_
+          }
+        }
+      }
+    }
+  </script>
+<% end %>