spree_analytics_trackers 1.0.0 → 2.1.0

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

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

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

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

@@ -0,0 +1,27 @@
+<% if segment_enabled? && @order.present? && !@order.complete? %>
+  <script>
+    window.addEventListener('turbolinks:load', function() {
+      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.track('Cart Viewed', segmentCartJson);
+        analytics.page('Cart Viewed', segmentCartJson);
+      }
+    });
+  </script>
+<% end %>
+

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

@@ -0,0 +1,21 @@
+<% if segment_enabled? && @order.present? && !@order.completed? %>
+  <script>
+    window.addEventListener('turbolinks:load', function() {
+      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

@@ -0,0 +1,7 @@
+<% if segment_enabled? %>
+  <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('<%=segment_tracker.analytics_id%>'.replace(/^\s+|\s+$/g, ''));
+    }}();
+  </script>
+<% end %>

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

@@ -0,0 +1,11 @@
+<% if segment_enabled? && @order.present? && order_just_completed?(@order) %>
+  <% order_json = SpreeAnalyticsTrackers::Segment::OrderPresenter.new(@order).to_json %>
+  <script>
+    window.addEventListener('turbolinks:load', function() {
+      if (typeof analytics !== 'undefined') {
+        analytics.page('Order Completed', <%= order_json.html_safe %>);
+        analytics.track('Order Completed', <%= order_json.html_safe %>);
+      }
+    });
+  </script>
+<% end %>

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

@@ -0,0 +1,7 @@
+<% if segment_enabled? %>
+  <script>
+    if (typeof analytics !== 'undefined') {
+      analytics.page();
+    }
+  </script>
+<% end %>

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

@@ -0,0 +1,23 @@
+<% if segment_enabled? && any_filtering_params? %>
+  <script>
+    window.addEventListener('turbolinks:load', function() {
+      if (typeof analytics !== 'undefined') {
+        var segmentProductListFilteredJson = {
+          filters: [
+            <% 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) %>,
+            <% 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

@@ -0,0 +1,19 @@
+<% if segment_enabled? && defined?(products) && products.present? %>
+  <script>
+    window.addEventListener('turbolinks:load', function() {
+      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.track('Product List Viewed', segmentProductListViewedJson);
+        analytics.page('Product List Viewed', segmentProductListViewedJson);
+      }
+    });
+  </script>
+<% end %>

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

@@ -0,0 +1,12 @@
+<% if segment_enabled? && @product.present? %>
+  <script>
+    window.addEventListener('turbolinks:load', function() {
+      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 %>

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

@@ -0,0 +1,10 @@
+<% if segment_enabled? && params.key?(:keywords) && params[:keywords].present? %>
+  <script>
+    window.addEventListener('turbolinks:load', function() {
+      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,18 @@
+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!

data/config/locales/zh-TW.yml

@@ -0,0 +1,19 @@
+zh-TW:
+  activerecord:
+    attributes:
+      spree/tracker:
+        one: 追蹤器
+        other: 追蹤器
+  spree:
+    analytics_engine: 分析引擎
+    analytics_trackers: 分析追蹤器
+    new_tracker: 新增追蹤器
+    google_analytics: Google 分析
+    google_analytics_id: Google 追蹤器代碼
+    analytics_desc_header_1: Spree 分析
+    analytics_desc_header_2: 新增即時分析到 Spree 的後台
+    analytics_desc_list_1: 獲得即時銷售數據
+    analytics_desc_list_2: 免費安裝
+    analytics_desc_list_3: 不需要寫任何代碼安裝
+    analytics_desc_list_4: 完全免費！
+

data/config/routes.rb

@@ -0,0 +1,5 @@
+Spree::Core::Engine.add_routes do
+  namespace :admin, path: Spree.admin_path do
+    resources :trackers
+  end
+end

data/db/migrate/20171013160337_create_spree_trackers.rb

@@ -0,0 +1,20 @@
+class CreateSpreeTrackers < SpreeExtension::Migration[4.2]
+  def change
+    if table_exists?(:spree_trackers)
+      add_index :spree_trackers, :active unless index_exists?(:spree_trackers, :active)
+      remove_column :spree_trackers, :environment if column_exists?(:spree_trackers, :environment)
+      unless column_exists?(:spree_trackers, :engine)
+        add_column :spree_trackers, :kind, :integer, default: 0, null: false, index: true unless column_exists?(:spree_trackers, :kind)
+        rename_column :spree_trackers, :kind, :engine if column_exists?(:spree_trackers, :kind)
+      end
+    else
+      create_table :spree_trackers do |t|
+        t.string 'analytics_id'
+        t.boolean 'active', default: true, index: true
+        t.datetime 'created_at', null: false
+        t.datetime 'updated_at', null: false
+        t.integer 'engine', default: 0, null: false, index: true
+      end
+    end
+  end
+end

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/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/spree_4_1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "spree", "~> 4.1.0"
+gem "spree_auth_devise", "~> 4.1.0"
+gem "rails-controller-testing"
+
+gemspec path: "../"

data/gemfiles/spree_master.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "spree", github: "spree/spree", branch: "master"
+gem "spree_auth_devise", github: "spree/spree_auth_devise", branch: "master"
+gem "rails-controller-testing"
+
+gemspec path: "../"

data/lib/generators/spree_analytics_trackers/install/install_generator.rb

@@ -0,0 +1,28 @@
+module SpreeAnalyticsTrackers
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_javascripts
+        javascripts_path = 'vendor/assets/javascripts/spree/frontend/all.js'
+        return unless File.file?(javascripts_path)
+
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/add_to_cart_analytics\n"
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/remove_from_cart_analytics\n"
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_analytics_trackers'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_analytics_trackers.rb

@@ -0,0 +1,5 @@
+require 'spree_core'
+require 'spree_extension'
+require 'spree_analytics_trackers/engine'
+require 'spree_analytics_trackers/version'
+require 'deface'

data/lib/spree_analytics_trackers/engine.rb

@@ -0,0 +1,20 @@
+module SpreeAnalyticsTrackers
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_analytics_trackers'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    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
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_analytics_trackers/factories.rb

@@ -0,0 +1,10 @@
+unless FactoryBot.factories.registered?(:tracker)
+  FactoryBot.define do
+    factory :tracker, class: Spree::Tracker do
+      analytics_id { 'A100' }
+      active { true }
+      engine { :google_analytics }
+      store { Spree::Store.default || create(:store) }
+    end
+  end
+end

data/lib/spree_analytics_trackers/version.rb

@@ -0,0 +1,17 @@
+module SpreeAnalyticsTrackers
+  module_function
+
+  # Returns the version of the currently loaded SpreeAnalyticsTrackers as a
+  # <tt>Gem::Version</tt>.
+  def version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 2
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
+  end
+end

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

@@ -0,0 +1,61 @@
+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, store: default_store)
+      create(:tracker, analytics_id: 'A200', store: another_store)
+      visit spree.admin_trackers_path
+    end
+
+    it 'should have the right content' do
+      expect(page).to have_content('Analytics Trackers')
+    end
+
+    it 'should have the right tabular values displayed' 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(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('Eurozone')
+        expect(column_text(4)).to eq('Yes')
+      end
+    end
+  end
+
+  context 'create' do
+    before(:each) do
+      visit spree.admin_trackers_path
+    end
+
+    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(default_store.name)
+        expect(column_text(4)).to eq('Yes')
+      end
+    end
+  end
+end