spree_analytics_trackers 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6428462a2ec00ca1334068af805efecf38b751293f86623e818aca577cb7df14
-  data.tar.gz: 1bd89f20f2f4d945ecafa7b843dbcb2a167811858cc7f6e2ab16a3fb59980d27
+  metadata.gz: e0b6411079e555367f446b09fa1a87c6d65ae92a91492864063597fda033d168
+  data.tar.gz: 817b4c0ad4564596b3e38813557d58f3eb68359d9fb388a8e4f65c6f9c6a4f10
 SHA512:
-  metadata.gz: c42aed4a692ede105d5b39335baa86a02aab94168186a6221dbce0edcb452d15eec696556639834d30c7dfefdca4408c3a9c116f6ea14f171f8520da0953b35e
-  data.tar.gz: d38032fb537f05202f967c7777e30d2ed2f696b2733a39bd20fe560c9ec2e4024f9588dcd9b0a4e1d9ddd30aa2d66712d6aced167e0e7b8948f732529125dc67
+  metadata.gz: 5cb572bed798cf004072d91cd33892302fec6a622fabaa03b0b30bbed97af66215450abfd9f99bb41147ad499656611070e9aa475961f931c5fa16dad00782b4
+  data.tar.gz: b8366a5461585d8f75ff2e6256b9f1b1ea6d5e2f22ae7940aafb9a3d147d63958ecbd8332e8f5ab1728840558d6eb4b2b16f829cf7e93c50f4749047234cc98e

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_JOBS: "8"

data/README.md

@@ -21,7 +21,7 @@ No additional development required.
 1. Add this extension to your Gemfile with this line:
 
   ```ruby
-  gem 'spree_analytics_trackers', '~> 2.0.0.rc1'
+  gem 'spree_analytics_trackers', '~> 2.0'
   ```
 
 2. Install the gem using Bundler:

data/app/assets/javascripts/spree/frontend/add_to_cart_analytics.js

@@ -1,17 +1,21 @@
 //= require spree/frontend
 
 function gaAddToCart(variant, quantity) {
+  clearGAplugins();
+  var price = typeof variant.price === 'object' ? variant.price.amount : variant.price
   gtag(
     'event',
     'add_to_cart',
     {
-      id: variant.sku,
-      name: variant.name,
-      category: variant.category,
-      variant: variant.options_text,
-      brand: variant.brand,
-      price: variant.price,
-      quantity: quantity
+      items: [{
+        id: variant.sku,
+        name: variant.name,
+        category: variant.category,
+        variant: variant.options_text,
+        brand: variant.brand,
+        price: price,
+        quantity: quantity
+      }]
     }
   );
 }

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

@@ -1,6 +1,14 @@
 module Spree
   module Admin
     class TrackersController < ResourceController
+      before_action :load_data
+
+      private
+
+      def load_data
+        @engines = Spree::Tracker.engines.keys.sort.map { |k| [k.humanize, k] }
+        @stores = Spree::Store.all
+      end
     end
   end
 end

data/app/models/spree/tracker.rb

@@ -5,20 +5,26 @@ module Spree
 
     after_commit :clear_cache
 
-    validates :analytics_id, presence: true, uniqueness: { scope: :engine, case_sensitive: false }
+    validates :analytics_id, presence: true, uniqueness: { scope: [:engine, :store_id], case_sensitive: false }
+    validates :store, presence: true
 
     scope :active, -> { where(active: true) }
 
-    def self.current(engine = TRACKING_ENGINES.first)
-      tracker = Rails.cache.fetch("current_tracker/#{engine}") do
-        send(engine).active.first
+    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}")
+        Rails.cache.delete("current_tracker/#{engine}/#{store_id}")
       end
     end
   end

data/app/overrides/add_google_analytics_page_view_to_spree_application.rb

@@ -1,17 +1,9 @@
 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',
+    virtual_path: 'spree/shared/_head',
     name: 'add_google_analytics_page_viewed_to_spree_application',
-    insert_bottom: "[data-hook='body']",
-    partial: 'spree/shared/trackers/google_analytics/page_viewed.js',
-    original: '6841b819babbe4df1f03d0bc8e05dc81bf0d45ad'
-  )
-
-  Deface::Override.new(
-    virtual_path: 'spree/layouts/checkout',
-    name: 'add_google_analytics_page_viewed_to_spree_checkout',
-    insert_bottom: "[data-hook='body']",
+    insert_before: 'meta',
     partial: 'spree/shared/trackers/google_analytics/page_viewed.js',
     original: '6841b819babbe4df1f03d0bc8e05dc81bf0d45ad'
   )

data/app/overrides/add_google_analytics_to_spree_application.rb

@@ -1,17 +1,9 @@
 if Gem.loaded_specs['spree_core'].version >= Gem::Version.create('3.5.0.alpha')
   Deface::Override.new(
-    virtual_path: 'spree/layouts/spree_application',
+    virtual_path: 'spree/shared/_head',
     name: 'add_google_analytics_initializer_to_spree_application',
-    insert_top: '[data-hook="inside_head"]',
+    insert_before: 'meta',
     partial: 'spree/shared/trackers/google_analytics/initializer.js',
     original: 'cfa30a2831d9a41394c03229cd28b3c7eee69585'
   )
-
-  Deface::Override.new(
-    virtual_path: 'spree/layouts/checkout',
-    name: 'add_google_analytics_initializer_to_spree_checkout',
-    insert_top: '[data-hook="inside_head"]',
-    partial: 'spree/shared/trackers/google_analytics/initializer.js',
-    original: 'ca3d46a134b93856baf937cf2e473da66d9d8efc'
-  )
 end

data/app/overrides/add_segment_initializer_to_layout.rb

@@ -1,17 +1,9 @@
 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',
+    virtual_path: 'spree/shared/_head',
     name: 'add_segment_initializer_to_layout',
-    insert_bottom: '[data-hook="inside_head"]',
-    partial: 'spree/shared/trackers/segment/initializer.js',
-    original: '6841b819babbe4df1f03d0bc8e05dc81bf0d45ad'
-  )
-
-  Deface::Override.new(
-    virtual_path: 'spree/layouts/checkout',
-    name: 'add_segment_initializer_to_spree_checkout',
-    insert_bottom: '[data-hook="inside_head"]',
+    insert_before: 'meta',
     partial: 'spree/shared/trackers/segment/initializer.js',
     original: '6841b819babbe4df1f03d0bc8e05dc81bf0d45ad'
   )

data/app/overrides/add_segment_page_viewed_to_layout.rb

@@ -1,17 +1,9 @@
 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',
+    virtual_path: 'spree/shared/_head',
     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']",
+    insert_before: 'meta',
     partial: 'spree/shared/trackers/segment/page_viewed.js',
     original: '6841b819babbe4df1f03d0bc8e05dc81bf0d45ad'
   )

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

@@ -2,7 +2,7 @@
   <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, Spree::Tracker.engines.keys.sort.map { |k| [k.humanize, k] }, {}, { class: 'select2' } %>
+      <%= f.select :engine, @engines, {}, { class: 'select2' } %>
       <%= f.error_message_on :engine %>
     <% end %>
   </div>
@@ -30,6 +30,12 @@
       <%= 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>
 

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

@@ -12,6 +12,7 @@
       <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>
@@ -21,6 +22,7 @@
         <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>

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

@@ -1,6 +1,7 @@
-<% if @order.present? && !@order.completed? && Spree::Tracker.current(:google_analytics) %>
+<% if @order.present? && !@order.completed? && Spree::Tracker.current(:google_analytics, current_store) %>
   <script>
     if (typeof gtag !== 'undefined') {
+      clearGAplugins();
       gtag('event', 'checkout_progress', {
         checkout_step: '<%= (@order.checkout_steps.index(@order.state) + 1) %>',
         items: [
@@ -10,11 +11,7 @@
         ],
 
         coupon: '<%= @order.promo_code %>',
-      });
-
-      gtag('event', 'set_checkout_option', {
-        'checkout_step': '<%= (@order.checkout_steps.index(@order.state) + 1) %>',
-        'checkout_option': '<%= @order.state %>'
+        checkout_option: '<%= @order.state %>'
       });
     };
   </script>

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

@@ -1,4 +1,4 @@
-<% if tracker = Spree::Tracker.current(:google_analytics) %>
+<% if tracker = Spree::Tracker.current(:google_analytics, current_store) %>
   <!-- Global site tag (gtag.js) - Google Analytics -->
   <script async src="https://www.googletagmanager.com/gtag/js?id=<%= tracker.analytics_id %>"></script>
   <script>
@@ -7,5 +7,19 @@
     gtag('js', new Date());
 
     gtag('config', '<%= 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 %>

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

@@ -1,4 +1,4 @@
-<% if tracker = Spree::Tracker.current(:google_analytics) %>
+<% if tracker = Spree::Tracker.current(:google_analytics, current_store) %>
   <script>
     if (typeof gtag !== 'undefined') {
       <% if user_id = try_spree_current_user.try(:id) %>

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

@@ -1,6 +1,7 @@
-<% if @order.present? && order_just_completed?(@order) && Spree::Tracker.current(:google_analytics) %>
+<% if @order.present? && order_just_completed?(@order) && Spree::Tracker.current(:google_analytics, current_store) %>
   <script>
     if (typeof gtag !== 'undefined') {
+      clearGAplugins();
       gtag('event', 'purchase', {
         transaction_id: '<%= @order.number %>',
         value: <%= @order.total&.to_f %>,

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

@@ -1,4 +1,4 @@
-<% if @order.present? && !@order.complete? && Spree::Tracker.current(:segment) %>
+<% if @order.present? && !@order.complete? && Spree::Tracker.current(:segment, current_store) %>
   <script>
     if (typeof analytics !== 'undefined') {
       var segmentCartJson = {

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

@@ -1,4 +1,4 @@
-<% if @order.present? && !@order.completed? && Spree::Tracker.current(:segment) %>
+<% if @order.present? && !@order.completed? && Spree::Tracker.current(:segment, current_store) %>
   <script>
     if (typeof analytics !== 'undefined') {
       analytics.track('Checkout Step Viewed', {

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

@@ -1,4 +1,4 @@
-<% if tracker = Spree::Tracker.current(:segment) %>
+<% if tracker = Spree::Tracker.current(:segment, current_store) %>
   <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, ''));

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

@@ -1,4 +1,4 @@
-<% if @order.present? && order_just_completed?(@order) && Spree::Tracker.current(:segment) %>
+<% if @order.present? && order_just_completed?(@order) && Spree::Tracker.current(:segment, current_store) %>
   <% order_json = SpreeAnalyticsTrackers::Segment::OrderPresenter.new(@order).to_json %>
   <script>
     if (typeof analytics !== 'undefined') {

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

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

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

@@ -1,4 +1,4 @@
-<% if any_filtering_params? && Spree::Tracker.current(:segment) %>
+<% if any_filtering_params? && Spree::Tracker.current(:segment, current_store) %>
   <script>
     if (typeof analytics !== 'undefined') {
       var segmentProductListFilteredJson = {

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

@@ -1,4 +1,4 @@
-<% if defined?(products) && products.present? && Spree::Tracker.current(:segment) %>
+<% if defined?(products) && products.present? && Spree::Tracker.current(:segment, current_store) %>
   <script>
     if (typeof analytics !== 'undefined') {
       var segmentProductListViewedJson = {

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

@@ -1,4 +1,4 @@
-<% if @product.present? && Spree::Tracker.current(:segment) %>
+<% if @product.present? && Spree::Tracker.current(:segment, current_store) %>
   <script>
     if (typeof analytics !== 'undefined') {
       var segmentProductViewed = <%= product_for_segment(@product, image: default_image_for_product_or_variant(@product)) %>;

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

@@ -1,4 +1,4 @@
-<% if params.key?(:keywords) && params[:keywords].present? && Spree::Tracker.current(:segment) %>
+<% if params.key?(:keywords) && params[:keywords].present? && Spree::Tracker.current(:segment, current_store) %>
   <script>
     if (typeof analytics !== 'undefined') {
       analytics.track('Products Searched', {

data/db/migrate/20200721163729_add_store_id_to_spree_trackers.rb

@@ -0,0 +1,14 @@
+class AddStoreIdToSpreeTrackers < ActiveRecord::Migration[6.0]
+  def change
+    add_column :spree_trackers, :store_id, :integer
+    add_index :spree_trackers, :store_id
+
+    Spree::Tracker.reset_column_information
+
+    default_store = Spree::Store.default
+    Spree::Tracker.all.each do |tracker|
+      tracker.store = default_store
+      tracker.save
+    end
+  end
+end

data/lib/spree_analytics_trackers/factories.rb

@@ -4,6 +4,7 @@ unless FactoryBot.factories.registered?(:tracker)
       analytics_id { 'A100' }
       active { true }
       engine { :google_analytics }
+      store { Spree::Store.default || create(:store) }
     end
   end
 end

data/lib/spree_analytics_trackers/version.rb

@@ -11,8 +11,7 @@ module SpreeAnalyticsTrackers
     MAJOR = 2
     MINOR = 0
     TINY  = 0
-    PRE   = 'rc1'
 
-    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
   end
 end

data/spec/features/admin/configuration/analytics_tracker_spec.rb

@@ -3,10 +3,13 @@ require 'spec_helper'
 describe 'Analytics Tracker', type: :feature do
   stub_authorization!
 
+  let!(:default_store) { Spree::Store.default }
+  let!(:another_store) { create(:store, name: 'Eurozone') }
+
   context 'index' do
     before(:each) do
-      create(:tracker)
-      create(:tracker, analytics_id: 'A200')
+      create(:tracker, store: default_store)
+      create(:tracker, analytics_id: 'A200', store: another_store)
       visit spree.admin_trackers_path
     end
 
@@ -18,13 +21,15 @@ describe 'Analytics Tracker', type: :feature do
       within_row(1) do
         expect(column_text(1)).to eq('A100')
         expect(column_text(2)).to eq('Google analytics')
-        expect(column_text(3)).to eq('Yes')
+        expect(column_text(3)).to eq(default_store.name)
+        expect(column_text(4)).to eq('Yes')
       end
 
       within_row(2) do
         expect(column_text(1)).to eq('A200')
         expect(column_text(2)).to eq('Google analytics')
-        expect(column_text(3)).to eq('Yes')
+        expect(column_text(3)).to eq('Eurozone')
+        expect(column_text(4)).to eq('Yes')
       end
     end
   end
@@ -34,18 +39,22 @@ describe 'Analytics Tracker', type: :feature do
       visit spree.admin_trackers_path
     end
 
-    it 'should be able to create a new analytics tracker' do
+    it 'should be able to create a new analytics tracker', js: true do
       within('.content-header') do
         click_link 'admin_new_tracker_link'
       end
       fill_in 'tracker_analytics_id', with: 'A100'
+
+      select2 default_store.name, from: 'Store'
+
       click_button 'Create'
 
       expect(page).to have_content('successfully created!')
       within_row(1) do
         expect(column_text(1)).to eq('A100')
         expect(column_text(2)).to eq('Google analytics')
-        expect(column_text(3)).to eq('Yes')
+        expect(column_text(3)).to eq(default_store.name)
+        expect(column_text(4)).to eq('Yes')
       end
     end
   end

data/spec/models/spree/tracker_spec.rb

@@ -13,5 +13,20 @@ describe Spree::Tracker, type: :model do
       tracker.clear_cache
       expect(Spree::Tracker.current).to be_nil
     end
+
+    context 'multi-store' do
+      let(:default_store) { Spree::Store.default }
+      let(:euro_store) { create(:store, code: :eu, name: 'eurozone') }
+      let!(:default_tracker) { create(:tracker, store: default_store, engine: :google_analytics) }
+      let!(:euro_tracker) { create(:tracker, store: euro_store, engine: :google_analytics) }
+
+      it 'returns default tracker from default store' do
+        expect(Spree::Tracker.current).to eq(default_tracker)
+      end
+
+      it 'returns tracker from a specified store' do
+        expect(Spree::Tracker.current(:google_analytics, euro_store)).to eq(euro_tracker)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_analytics_trackers
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0
 platform: ruby
 authors:
 - Spark Solutions
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
@@ -98,6 +98,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundle/config"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -152,6 +153,7 @@ files:
 - config/locales/zh-TW.yml
 - config/routes.rb
 - db/migrate/20171013160337_create_spree_trackers.rb
+- db/migrate/20200721163729_add_store_id_to_spree_trackers.rb
 - gemfiles/.bundle/config
 - gemfiles/spree_4_1.gemfile
 - gemfiles/spree_master.gemfile
@@ -172,7 +174,7 @@ homepage: https://github.com/spree-contrib/spree_analytics_trackers
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -183,13 +185,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements:
 - none
 rubygems_version: 3.1.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Adds analytics trackers functionality to Spree
 test_files: