workarea-google_analytics 2.1.5

data/app/assets/javascripts/workarea/storefront/google_analytics/modules/adapter.js

@@ -0,0 +1,314 @@
+/* eslint no-console: "off" */
+/* global console, ga */
+
+/**
+ * @namespace WORKAREA.googleAnalytics
+ */
+WORKAREA.analytics.registerAdapter('googleAnalytics', function () {
+    'use strict';
+
+    var propertyId = $('meta[property="ga-tracking-id"]').attr('content'),
+        send = function () {
+            if (WORKAREA.analytics.debug) {
+                console.log(arguments);
+            }
+
+            if (!WORKAREA.environment.isTest) {
+              ga.apply(ga, arguments);
+            }
+        };
+
+    send('create', propertyId, 'auto');
+    send('require', 'ec');
+
+    return {
+        'pageView': function() {
+            send('send', 'pageview');
+        },
+
+        'categoryView': function (payload) {
+            send('send', 'event', 'category', 'view', payload.name, {
+                'nonInteraction': true
+            });
+            send('send', 'event', 'category', 'view', payload.sort, {
+                'nonInteraction': true
+            });
+            send('send', 'event', 'category', 'view', 'page:' + payload.page, {
+                'nonInteraction': true
+            });
+            _.forEach(payload.filters, function (values, name) {
+                _.forEach(values, function (value) {
+                    send('send', 'event', 'category', 'view', name + ':' + value, {
+                        'nonInteraction': true
+                    });
+                });
+            });
+        },
+
+        'searchResultsView': function (payload) {
+            send('send', 'event', 'search results', 'view', payload.terms, {
+                'nonInteraction': true
+            });
+            send('send', 'event', 'search results', 'view', payload.sort, {
+                'nonInteraction': true
+            });
+            send('send', 'event', 'search results', 'view', 'page:' + payload.page, {
+                'nonInteraction': true
+            });
+            _.forEach(payload.filters, function (values, name) {
+                _.forEach(values, function (value) {
+                    send('send', 'event', 'search results', 'view', name + ':' + value, {
+                        'nonInteraction': true
+                    });
+                });
+            });
+        },
+
+        'productList': function (payload) {
+            _.each(payload.impressions, function (impression) {
+                send('ec:addImpression', {
+                    'id': impression.id,
+                    'name': impression.name,
+                    'category': impression.category,
+                    'variant': impression.sku,
+                    'list': payload.name,
+                    'position': impression.position
+                });
+            });
+        },
+
+        'productClick': function (payload) {
+            send('ec:addProduct', {
+                'id': payload.id,
+                'name': payload.name,
+                'category': payload.category,
+                'variant': payload.sku,
+                'position': payload.position
+            });
+
+            send('ec:setAction', 'click', { list: payload.list });
+            send('send', 'event', 'product', 'click', payload.list);
+        },
+
+        'productQuickView': function (payload) {
+            send('ec:addProduct', {
+                'id': payload.id,
+                'name': payload.name,
+                'category': payload.category,
+                'variant': payload.sku
+            });
+
+            send('ec:setAction', 'detail');
+            send('send', 'event', 'product', 'quickview');
+        },
+
+        'productView': function (payload) {
+            send('ec:addProduct', {
+                'id': payload.id,
+                'name': payload.name,
+                'category': payload.category,
+                'variant': payload.sku,
+                'nonInteraction': true
+            });
+
+            send('ec:setAction', 'detail');
+        },
+
+        'addToCart': function (payload) {
+            send('ec:addProduct', {
+                'id': payload.id,
+                'name': payload.name,
+                'category': payload.category,
+                'variant': payload.sku,
+                'price': payload.price,
+                'quantity': payload.quantity
+            });
+
+            send('ec:setAction', 'add');
+            send('send', 'event', 'product', 'click', 'add to cart');
+        },
+
+        'cartView': function (payload) {
+            _.each(payload.items, function (impression) {
+                send('ec:addProduct', {
+                    'id': impression.product_id,
+                    'name': impression.product_name,
+                    'category': impression.category,
+                    'variant': impression.sku,
+                    'price': impression.price,
+                    'quantity': impression.quantity,
+                    'nonInteraction': true
+                });
+            });
+
+            send('ec:setAction', 'checkout', { 'step': 1 });
+        },
+
+        'updateCartItem': function () {
+            send('send', 'event', 'product', 'click', 'update cart');
+        },
+
+        'addToCartConfirmation': function() {
+            send('send', 'event', 'Add To Cart', 'confirm', 'item added');
+        },
+
+        'removeFromCart': function (payload) {
+            send('ec:addProduct', {
+                'id': payload.product_id,
+                'name': payload.product_name,
+                'category': payload.category,
+                'variant': payload.sku,
+                'price': payload.price,
+                'quantity': payload.quantity
+            });
+
+            send('ec:setAction', 'remove');
+            send('send', 'event', 'product', 'click', 'remove from cart');
+        },
+
+        'checkoutLogin': function () {
+            send('send', 'event', 'checkout', 'start', 'login');
+        },
+
+        'checkoutGuest': function () {
+            send('send', 'event', 'checkout', 'start', 'guest');
+        },
+
+        'checkoutAddressesView': function (payload) {
+            _.each(payload.items, function (impression) {
+                send('ec:addProduct', {
+                    'id': impression.product_id,
+                    'name': impression.product_name,
+                    'category': impression.category,
+                    'variant': impression.sku,
+                    'price': impression.price,
+                    'quantity': impression.quantity,
+                    'nonInteraction': true
+                });
+            });
+
+            send('ec:setAction', 'checkout', { 'step': 2 });
+        },
+
+        'checkoutShippingView': function (payload) {
+            _.each(payload.items, function (impression) {
+                send('ec:addProduct', {
+                    'id': impression.product_id,
+                    'name': impression.product_name,
+                    'category': impression.category,
+                    'variant': impression.sku,
+                    'price': impression.price,
+                    'quantity': impression.quantity,
+                    'nonInteraction': true
+                });
+            });
+
+            send('ec:setAction', 'checkout', { 'step': 3 });
+        },
+
+        'checkoutShippingMethodSelected': function (payload) {
+            send('ec:setAction', 'checkout_option', {
+                'step': 3,
+                'option': payload.name
+            });
+
+            send('send', 'event', 'checkout', 'click', 'select shipping method');
+        },
+
+        'checkoutPaymentView': function (payload) {
+            _.each(payload.items, function (impression) {
+                send('ec:addProduct', {
+                    'id': impression.product_id,
+                    'name': impression.product_name,
+                    'category': impression.category,
+                    'variant': impression.sku,
+                    'price': impression.price,
+                    'quantity': impression.quantity,
+                    'nonInteraction': true
+                });
+            });
+
+            send('ec:setAction', 'checkout', { 'step': 4 });
+        },
+
+        'checkoutPaymentSelected': function (payload) {
+            send('ec:setAction', 'checkout_option', {
+                'step': 4,
+                'option': payload.type
+            });
+
+            send('send', 'event', 'checkout', 'click', 'select payment');
+        },
+
+        'checkoutOrderPlaced': function (payload) {
+            _.each(payload.items, function (impression) {
+                send('ec:addProduct', {
+                    'id': impression.product_id,
+                    'name': impression.product_name,
+                    'category': impression.category,
+                    'variant': impression.sku,
+                    'price': impression.price,
+                    'quantity': impression.quantity
+                });
+            });
+
+            send('ec:setAction', 'purchase', {
+                'id': payload.id,
+                'affiliation': payload.site_name,
+                'revenue': payload.total_price,
+                'tax': payload.tax_total,
+                'shipping': payload.shipping_total,
+                'coupon': payload.promo_codes.join(',')
+            });
+        },
+
+        'checkoutSignup': function () {
+            send('send', 'event', 'checkout', 'signup');
+        },
+
+        'login': function () {
+            send('send', 'event', 'account', 'login');
+        },
+
+        'logout': function () {
+            send('send', 'event', 'account', 'logout');
+        },
+
+        'forgotPassword': function () {
+            send('send', 'event', 'account', 'forgot password');
+        },
+
+        'signup': function () {
+            send('send', 'event', 'account', 'signup');
+        },
+
+        'share': function (payload) {
+            send('send', 'event', 'share', 'click', payload.type);
+        },
+
+        'emailSignup': function () {
+            send('send', 'event', 'email', 'signup');
+        },
+
+        'primaryNavigationClick': function(payload) {
+            send('send', 'event', 'nav', 'select', payload.name);
+        },
+
+        'checkoutEdit': function(payload) {
+            send('send', 'event', 'Edit Button', 'Click', payload.type);
+        },
+
+        'flashMessage': function(payload) {
+            send('send', 'event', 'Flash Messaging', 'Flash Messaging Triggered', payload.type);
+        },
+
+        'validationError': function(payload) {
+            var location = 'application';
+
+            if (!_.isEmpty(payload.model)) {
+                location = 'checkout - ' + payload.model;
+            }
+            send('send', 'event', 'JavaScript Validaton Error', 'JavaScript Validation Error Triggered', location);
+        }
+    };
+});

data/app/views/workarea/storefront/analytics/_google_analytics.html.haml

@@ -0,0 +1,6 @@
+%meta{ property: 'ga-tracking-id', content: Workarea.config.google_analytics_tracking_id }
+:javascript
+  (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');

data/bin/rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/workarea/google_analytics', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'action_mailer/railtie'
+require 'rails/test_unit/railtie'
+require 'sprockets/railtie'
+
+require 'rails/engine/commands'

data/config/initializers/appends.rb

@@ -0,0 +1,9 @@
+Workarea.append_javascripts(
+  'storefront.modules',
+  'workarea/storefront/google_analytics/modules/adapter'
+)
+
+Workarea.append_partials(
+  'storefront.document_head',
+  'workarea/storefront/analytics/google_analytics'
+)

data/config/initializers/configuration.rb

@@ -0,0 +1 @@
+Workarea.config.google_analytics_tracking_id = 'TODO'

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/tasks/google_analytics_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :google_analytics do
+#   # Task goes here
+# end

data/lib/workarea/google_analytics/engine.rb

@@ -0,0 +1,8 @@
+module Workarea
+  module GoogleAnalytics
+    class Engine < ::Rails::Engine
+      include Plugin
+      isolate_namespace GoogleAnalytics
+    end
+  end
+end

data/lib/workarea/google_analytics/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module GoogleAnalytics
+    VERSION = '2.1.5'.freeze
+  end
+end

data/lib/workarea/google_analytics.rb

@@ -0,0 +1,10 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+
+require 'workarea/google_analytics/engine'
+
+module Workarea
+  module GoogleAnalytics
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/test/dummy/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,21 @@
+require_relative 'boot'
+
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+require 'sprockets/railtie'
+require 'rails/test_unit/railtie'
+require 'workarea'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    I18n.enforce_available_locales = false
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/cable.yml

@@ -0,0 +1,9 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: redis://localhost:6379/1

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!