workarea-google_tag_manager 4.3.1

data/test/dummy/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.session_store :cookie_store, key: '_dummy_session'

data/test/dummy/config/initializers/workarea.rb

@@ -0,0 +1,5 @@
+Workarea.configure do |config|
+  # Basic site info
+  config.site_name = 'Workarea Google Tag Manager'
+  config.host = 'www.example.com'
+end

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#   self.include_root_in_json = true
+# end

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,23 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/test/dummy/config/puma.rb

@@ -0,0 +1,47 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum, this matches the default thread size of Active Record.
+#
+threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }.to_i
+threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests, default is 3000.
+#
+port        ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked webserver processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory. If you use this option
+# you need to make sure to reconnect any threads in the `on_worker_boot`
+# block.
+#
+# preload_app!
+
+# The code in the `on_worker_boot` will be called if you are using
+# clustered mode by specifying a number of `workers`. After each worker
+# process is booted this block will be run, if you are using `preload_app!`
+# option you will want to use this block to reconnect to any threads
+# or connections that may have been created at application boot, Ruby
+# cannot share connections between processes.
+#
+# on_worker_boot do
+#   ActiveRecord::Base.establish_connection if defined?(ActiveRecord)
+# end
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/test/dummy/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  mount Workarea::Core::Engine => '/'
+  mount Workarea::Admin::Engine => '/admin', as: 'admin'
+  mount Workarea::Storefront::Engine => '/', as: 'storefront'
+end

data/test/dummy/config/secrets.yml

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rails secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: 270afb934659470d02c777e8ca1bc0abd7f127b3b6bcdea6e2c93a32ad0bbd97fd591af5bd730a560cb9576a1512b8af19f83d532e6a19cb043a578ae4f3ba3a
+
+test:
+  secret_key_base: 744d8b81e1f24bba29f0cd9601b59daff7a0c58a3be4db9a79923ac8f1438e95f286be4f08aa088ba6aaa97027a41d673b577e9cc5674bedb09e4bd2b0ffe73b
+
+# Do not keep production secrets in the repository,
+# instead read values from the environment.
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/test/dummy/config/spring.rb

@@ -0,0 +1,6 @@
+%w(
+  .ruby-version
+  .rbenv-vars
+  tmp/restart.txt
+  tmp/caching-dev.txt
+).each { |path| Spring.watch(path) }

data/test/javascripts/fixtures/payloads.js

@@ -0,0 +1,231 @@
+/*eslint no-unused-vars: 0 */
+function productListPayload() {
+    return {
+        "name": "Electronics",
+        "page": 1,
+        "per_page": 20,
+        "impressions": [
+            {
+                "id": "4AF99AB7C8",
+                "name": "Heavy Duty Iron Bag",
+                "sku": "288457637-1",
+                "sale": false,
+                "price": 19.77,
+                "category": "Automotive",
+                "position": 0
+            },
+            {
+                "id": "A77BE95FD8",
+                "name": "Gorgeous Linen Computer",
+                "sku": "087096987-0",
+                "sale": false,
+                "price": 0.42,
+                "category": "Automotive",
+                "position": 1
+            },
+            {
+                "id": "CD2B8085BE",
+                "name": "Sleek Linen Gloves",
+                "sku": "441641257-6",
+                "sale": false,
+                "price": 18.67,
+                "category": "Automotive",
+                "position": 2
+            },
+            {
+                "id": "3034884ECA",
+                "name": "Durable Wool Hat",
+                "sku": "610796205-0",
+                "sale": false,
+                "price": 63.16,
+                "category": "Automotive",
+                "position": 3
+            },
+            {
+                "id": "3B35A19DFF",
+                "name": "Lightweight Rubber Coat",
+                "sku": "124560496-1",
+                "sale": false,
+                "price": 13.15,
+                "category": "Automotive",
+                "position": 4
+            },
+            {
+                "id": "F7BBD9B1D2",
+                "name": "Rustic Paper Keyboard",
+                "sku": "243345833-1",
+                "sale": false,
+                "price": 7.77,
+                "category": "Automotive",
+                "position": 5
+            },
+            {
+                "id": "5286E1F9EA",
+                "name": "Incredible Cotton Shirt",
+                "sku": "873666584-3",
+                "sale": false,
+                "price": 45.11,
+                "category": "Automotive",
+                "position": 6
+            },
+            {
+                "id": "E538866CFC",
+                "name": "Small Bronze Hat",
+                "sku": "710835615-5",
+                "sale": false,
+                "price": 12.34,
+                "category": "Automotive",
+                "position": 7
+            },
+            {
+                "id": "952B3D844B",
+                "name": "Aerodynamic Paper Clock",
+                "sku": "392558208-8",
+                "sale": false,
+                "price": 22.59,
+                "category": "Automotive",
+                "position": 8
+            },
+            {
+                "id": "B6BD620005",
+                "name": "Durable Iron Table",
+                "sku": "795417242-2",
+                "sale": false,
+                "price": 23.07,
+                "category": "Automotive",
+                "position": 9
+            },
+            {
+                "id": "546CB731CB",
+                "name": "Fantastic Leather Hat",
+                "sku": "857899444-2",
+                "sale": false,
+                "price": 29.59,
+                "category": "Automotive",
+                "position": 10
+            },
+            {
+                "id": "9FF7028768",
+                "name": "Gorgeous Leather Knife",
+                "sku": "887139418-6",
+                "sale": false,
+                "price": 42.41,
+                "category": "Automotive",
+                "position": 11
+            },
+            {
+                "id": "9F729D69C6",
+                "name": "Synergistic Copper Coat",
+                "sku": "423424193-8",
+                "sale": false,
+                "price": 29.59,
+                "category": "Automotive",
+                "position": 12
+            },
+            {
+                "id": "4011335B6B",
+                "name": "Intelligent Wool Clock",
+                "sku": "464990513-3",
+                "sale": false,
+                "price": 31.2,
+                "category": "Automotive",
+                "position": 13
+            },
+            {
+                "id": "B28798CDAD",
+                "name": "Durable Bronze Bag",
+                "sku": "547390027-5",
+                "sale": false,
+                "price": 12.46,
+                "category": "Automotive",
+                "position": 14
+            },
+            {
+                "id": "84EACAB9F7",
+                "name": "Lightweight Leather Bottle",
+                "sku": "027837187-6",
+                "sale": false,
+                "price": 17.47,
+                "category": "Automotive",
+                "position": 15
+            },
+            {
+                "id": "C02747F6C6",
+                "name": "Practical Wooden Coat",
+                "sku": "181342040-8",
+                "sale": false,
+                "price": 42.33,
+                "category": "Automotive",
+                "position": 16
+            },
+            {
+                "id": "44459088C3",
+                "name": "Gorgeous Linen Computer",
+                "sku": "226387489-5",
+                "sale": false,
+                "price": 24.9,
+                "category": "Automotive",
+                "position": 17
+            },
+            {
+                "id": "F1EDB5846B",
+                "name": "Mediocre Bronze Chair",
+                "sku": "380482668-7",
+                "sale": false,
+                "price": 20.55,
+                "category": "Automotive",
+                "position": 18
+            },
+            {
+                "id": "1A05D231CB",
+                "name": "Incredible Rubber Bag",
+                "sku": "050606049-7",
+                "sale": false,
+                "price": 10.02,
+                "category": "Automotive",
+                "position": 19
+            }
+        ]
+    };
+}
+
+function orderPayload() {
+    return  {
+        "site_name": "Dummy App",
+        "id": "6705E78231",
+        "promo_codes": ['promo_1', 'promo_2'],
+        "shipping_service": "Ground",
+        "shipping_total": 7.0,
+        "tax_total": 0.0,
+        "total_price": 152.92,
+        "tenders": [],
+        "items": [
+            {
+                "id": "5964ef7d9d1fa2f1d0626c86",
+                "product_id": "4AF99AB7C8",
+                "product_name": "Heavy Duty Iron Bag",
+                "sku": "288457637-1",
+                "options": {
+                    "Size": "Medium",
+                    "Color": "Silver"
+                },
+                "price": 80.76,
+                "quantity": 1,
+                "category": "Automotive"
+            },
+            {
+                "id": "595fbf819d1fa2b3a0c4bd00",
+                "product_id": "F7BBD9B1D2",
+                "product_name": "Rustic Paper Keyboard",
+                "sku": "517371131-0",
+                "options": {
+                    "Size": "Small",
+                    "Color": "Fuchsia"
+                },
+                "price": 65.16,
+                "quantity": 1,
+                "category": "Automotive"
+            }
+        ]
+    };
+}

data/test/javascripts/google_tag_manager_spec.js

@@ -0,0 +1,382 @@
+/* global productListPayload, orderPayload */
+(function () {
+    'use strict';
+
+    function teardown() {
+        window.dataLayer = [];
+    }
+
+    describe('WORKAREA.googleTagManager', function () {
+        describe('setup', function () {
+            it('Adds a dataLayer to the window', function () {
+                expect(window.dataLayer).to.be.an('array');
+            });
+        });
+
+        describe('categoryView', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('categoryView',
+                    {
+                        "name" : "Games",
+                        "sort" : "top_sellers",
+                        "page" : 1,
+                        "filters" : {}
+                    }
+                );
+            });
+
+            it('pushes the category view event to the dataLayer', function () {
+                expect(window.dataLayer[0].event).to.eq('categoryView');
+            });
+
+            it('adds the payload to the dataLayer', function () {
+                expect(window.dataLayer[0].name).to.eq('Games');
+                expect(window.dataLayer[0].sort).to.eq('top_sellers');
+                expect(window.dataLayer[0].page).to.eq(1);
+            });
+
+            after(teardown);
+        });
+
+        describe('searchResultsView', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('searchResultsView',
+                    {
+                        "terms" : "query string",
+                        "sort" : "relevance",
+                        "page" : 1,
+                    }
+                );
+            });
+
+            it('pushes the searchResultsView event to the dataLayer', function () {
+                expect(window.dataLayer[0].event).to.eq('searchResultsView');
+            });
+
+            it('adds the payload to the dataLayer', function () {
+                expect(window.dataLayer[0].terms).to.eq('query string');
+                expect(window.dataLayer[0].sort).to.eq('relevance');
+                expect(window.dataLayer[0].page).to.eq(1);
+            });
+
+            after(teardown);
+        });
+
+        describe('productList', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('productList', productListPayload());
+            });
+
+            it('pushes an ecommerce event for impressions to the dataLayer', function () {
+                expect(window.dataLayer[0].ecommerce.impressions).to.exist;
+                expect(window.dataLayer[0].ecommerce.impressions.length).to.eq(20);
+            });
+
+            after(teardown);
+        });
+
+
+        describe('productClick', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('productClick',
+                    {
+                        'category' : "Automotive",
+                        'id' : "4AF99AB7C8",
+                        'list' : "Movies & Shoes",
+                        'name' : "Heavy Duty Iron Bag",
+                        'position' : 0,
+                        'price' : 19.77,
+                        'sale' : false,
+                        'sku' : "288457637-1"
+                    }
+                );
+            });
+
+            it('pushes the productClick event to the dataLayer', function () {
+                expect(window.dataLayer[0].event).to.eq('productClick');
+            });
+
+            it('announces ecommerce event to the dataLayer with correct data', function () {
+                var ecommerceEvent = window.dataLayer[0].ecommerce,
+                    product = ecommerceEvent.click.products[0];
+
+                expect(ecommerceEvent).to.exist;
+
+                expect(ecommerceEvent.click.actionField.list).to.eq('Movies & Shoes');
+                expect(product.name).to.eq('Heavy Duty Iron Bag');
+                expect(product.id).to.eq('4AF99AB7C8');
+                expect(product.price).to.eq(19.77);
+                expect(product.category).to.eq('Automotive');
+                expect(product.variant).to.eq('288457637-1');
+                expect(product.position).to.eq(0);
+            });
+
+            after(teardown);
+        });
+
+
+        describe('productQuickView', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('productQuickView',
+                    {
+                        "terms" : "query string",
+                        "sort" : "top_sellers",
+                        "page" : 1,
+                    }
+                );
+            });
+
+            it('pushes the quickview event to the dataLayer', function () {
+                expect(window.dataLayer[0].event).to.eq('quickview');
+            });
+
+            after(teardown);
+        });
+
+
+        describe('productView', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('productView',
+                    {
+                        'category' : 'Automotive',
+                        'id' : '4AF99AB7C8',
+                        'name' : 'Heavy Duty Iron Bag',
+                        'price' : 80.76,
+                        'quantity' : '1',
+                        'sale' : false,
+                        'sku' : '288457637-1'
+                    }
+                );
+            });
+
+            it('pushes an ecommerce detail event to the dataLayer', function () {
+                expect(window.dataLayer[0].ecommerce.detail).to.exist;
+            });
+
+            it('announces the products details in the ecommerce event', function () {
+                var product = window.dataLayer[0].ecommerce.detail.products[0];
+                expect(product.name).to.eq('Heavy Duty Iron Bag');
+                expect(product.id).to.eq('4AF99AB7C8');
+                expect(product.price).to.eq(80.76);
+                expect(product.category).to.eq('Automotive');
+                expect(product.variant).to.eq('288457637-1');
+            });
+
+            after(teardown);
+        });
+
+        describe('addToCart', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('addToCart',
+                    {
+                        'category' : 'Automotive',
+                        'id' : '4AF99AB7C8',
+                        'name' : 'Heavy Duty Iron Bag',
+                        'price' : 80.76,
+                        'quantity' : '1',
+                        'sale' : false,
+                        'sku' : '288457637-1'
+                    }
+                );
+            });
+
+            it('pushes the addToCart event to the dataLayer', function () {
+                expect(window.dataLayer[0].event).to.eq('addToCart');
+            });
+
+            it('announces an ecommerce add event with product data to the dataLayer', function () {
+                expect(window.dataLayer[0].ecommerce.add).to.exist;
+            });
+
+            it('adds correct product data in dataLayer', function () {
+                var product = window.dataLayer[0].ecommerce.add.products[0];
+                expect(product.name).to.eq('Heavy Duty Iron Bag');
+                expect(product.id).to.eq('4AF99AB7C8');
+                expect(product.category).to.eq('Automotive');
+                expect(product.variant).to.eq('288457637-1');
+                expect(product.price).to.eq(80.76);
+                expect(product.quantity).to.eq('1');
+            });
+
+            after(teardown);
+        });
+
+        describe('removeFromCart', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('removeFromCart',
+                    {
+                        'category' : 'Automotive',
+                        'id' : '4AF99AB7C8',
+                        'name' : 'Heavy Duty Iron Bag',
+                        'price' : 80.76,
+                        'quantity' : '1',
+                        'sale' : false,
+                        'sku' : '288457637-1'
+                    }
+                );
+            });
+
+            it('pushes the removeFromCart event to the dataLayer', function () {
+                expect(window.dataLayer[0].event).to.eq('removeFromCart');
+            });
+
+            it('announces an ecommerce add event with product data to the dataLayer', function () {
+                expect(window.dataLayer[0].ecommerce.remove).to.exist;
+            });
+
+            it('adds correct product data in dataLayer', function () {
+                var product = window.dataLayer[0].ecommerce.remove.products[0];
+                expect(product.name).to.eq('Heavy Duty Iron Bag');
+                expect(product.id).to.eq('4AF99AB7C8');
+                expect(product.category).to.eq('Automotive');
+                expect(product.variant).to.eq('288457637-1');
+                expect(product.price).to.eq(80.76);
+                expect(product.quantity).to.eq('1');
+            });
+
+            after(teardown);
+        });
+
+        describe('cartView', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('cartView', orderPayload());
+            });
+
+            it('announces a checkout event in the dataLayer', function () {
+                expect(window.dataLayer[0].event).to.eq('checkout');
+            });
+
+            it('announces a checkout enhanced ecommerce event in the dataLayer', function () {
+                expect(window.dataLayer[0].ecommerce.checkout).to.exist;
+            });
+
+            it('announces step 1 of checkout in the dataLayer', function () {
+                var step = window.dataLayer[0].ecommerce.checkout.actionField.step;
+                expect(step).to.eq(1);
+            });
+
+            after(teardown);
+        });
+
+        describe('checkoutAddressesView', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('checkoutAddressesView',orderPayload());
+            });
+
+            it('announces a checkout event in the dataLayer', function () {
+                expect(window.dataLayer[0].event).to.eq('checkout');
+            });
+
+            it('announces step 2 of checkout in the dataLayer', function () {
+                var step = window.dataLayer[0].ecommerce.checkout.actionField.step;
+                expect(step).to.eq(2);
+            });
+
+            after(teardown);
+        });
+
+        describe('checkoutShippingView', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('checkoutShippingView', orderPayload());
+            });
+
+            it('announces a checkout event in the dataLayer', function () {
+                expect(window.dataLayer[0].event).to.eq('checkout');
+            });
+
+            it('announces step 3 of checkout in the dataLayer', function () {
+                var step = window.dataLayer[0].ecommerce.checkout.actionField.step;
+                expect(step).to.eq(3);
+            });
+
+            after(teardown);
+        });
+
+        describe('checkoutShippingServiceSelected', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('checkoutShippingServiceSelected',
+                    {
+                        "name" : "Ground",
+                        'price' : 7
+                    }
+                );
+            });
+
+            it('announces a checkoutOption event in the dataLayer', function () {
+                expect(window.dataLayer[0].event).to.eq('checkoutOption');
+            });
+
+            it('adds the shipping service to the dataLayer', function () {
+                var actionField = window.dataLayer[0].ecommerce.checkout_option.actionField;
+
+                expect(actionField.step).to.eq(3);
+                expect(actionField.option).to.eq('Ground');
+            });
+
+            after(teardown);
+        });
+
+        describe('checkoutPaymentView', function() {
+            before(function(){
+                WORKAREA.analytics.fireCallback('checkoutPaymentView',orderPayload());
+            });
+
+            it('announces a checkout event in the dataLayer', function () {
+                expect(window.dataLayer[0].event).to.eq('checkout');
+            });
+
+            it('announces step 4 of checkout in the dataLayer', function () {
+                var step = window.dataLayer[0].ecommerce.checkout.actionField.step;
+                expect(step).to.eq(4);
+            });
+
+            after(teardown);
+        });
+
+        describe('checkoutPaymentSelected', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('checkoutPaymentSelected',
+                    {
+                        "type" : "new_card"
+                    }
+                );
+            });
+
+            it('announces a checkoutOption event in the dataLayer', function () {
+                expect(window.dataLayer[0].event).to.eq('checkoutOption');
+            });
+
+            it('adds the payment method to the dataLayer', function () {
+                var actionField = window.dataLayer[0].ecommerce.checkout_option.actionField;
+
+                expect(actionField.step).to.eq(4);
+                expect(actionField.option).to.eq('new_card');
+            });
+
+            after(teardown);
+        });
+
+        describe('checkoutOrderPlaced', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('checkoutOrderPlaced', orderPayload());
+            });
+
+            it('announces an ecommerce purchase event in the dataLayer', function () {
+                expect(window.dataLayer[0].ecommerce.purchase).to.exist;
+            });
+
+            it('announces transaction data in dataLayer', function() {
+                var actionField = window.dataLayer[0].ecommerce.purchase.actionField;
+
+                expect(actionField.id).to.eq('6705E78231');
+                expect(actionField.affiliation).to.eq('Dummy App');
+                expect(actionField.revenue).to.eq(152.92);
+                expect(actionField.tax).to.eq(0.00);
+                expect(actionField.shipping).to.eq(7.00);
+                expect(actionField.coupon).to.eq('promo_1,promo_2');
+            });
+
+            after(teardown);
+        });
+    });
+}());