workarea-google_tag_manager 4.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e62fb8271ea1777685547babd1b71cb82f66a5fc39a02e576602c2774a0c82a
+  data.tar.gz: 75c64904c8445a2700f744b4f20df741dd3f05dff0c56c778057d5f0e89778d9
+SHA512:
+  metadata.gz: 8b57ca62a985a5d564eb0cc1a03258daa3294ba174e8a76adbd749beb6afe220238f6212bcbc6375d15f107041d3123a37a620efe4b5e2304c35388b369e23f8
+  data.tar.gz: 9c1499a0b53f85743e5c3c86a32046ac23621d0cade420b18b71c78f17a9101acce7ef9d6e392480144b618fa239fdc94632468c39d3b6a4157a394967d4f81c

data/.gitignore

@@ -0,0 +1,11 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+Gemfile.lock
+test/dummy/public/*
+.DS_STORE

data/.rubocop.yml

@@ -0,0 +1,37 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-05-02 15:21:42 -0400 using RuboCop version 0.46.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 24
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+AllCops:
+  Exclude:
+    - 'Rakefile'
+    - 'test/dummy/**/*'
+    - 'lib/workarea/google_tag_manager.rb'
+    - 'lib/workarea/google_tag_manager/**/*'
+
+Metrics/LineLength:
+  Exclude:
+    - 'workarea-google_tag_manager.gemspec'
+
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: use_perl_names, use_english_names
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'workarea-google_tag_manager.gemspec'
+
+# Offense count: 1
+Metrics/LineLength:
+  Exclude:
+    - 'workarea-google_tag_manager.gemspec'

data/CHANGELOG.md

@@ -0,0 +1,100 @@
+Workarea Google Tag Manager 4.3.1 (2019-08-21)
+--------------------------------------------------------------------------------
+
+*   Open Source!
+
+
+
+Workarea Google Tag Manager 4.3.0 (2019-05-28)
+--------------------------------------------------------------------------------
+
+*   Move GTM script to the site head
+
+    Move GTM script portion into its own partial.
+    Rename no script partial.
+    Update append points. Script will now be appended to the head.
+
+    WLGTM-13
+    James Dobson
+
+
+
+Workarea Google Tag Manager 4.2.6 (2019-04-16)
+--------------------------------------------------------------------------------
+
+*   Update for v3.4 compatibility
+
+    * Add CI scripts
+    * update gemfile for v3.4
+    * Fix ESlint errors
+    * Update rubocop configuration and get the cops passing
+    * Add keepfile for test/dummy/tmp/screenshots
+
+    WLGTM-12
+    Jake Beresford
+
+
+
+Workarea Google Tag Manager 4.2.5 (2019-02-19)
+--------------------------------------------------------------------------------
+
+*   Correct casing of productQuickview adapter callback function name
+
+    WLGTM-11
+    Jake Beresford
+
+
+
+Workarea Google Tag Manager 4.2.4 (2018-12-11)
+--------------------------------------------------------------------------------
+
+*   Remove unecessary tests causing issues in builds
+
+    WLGTM-10
+    Eric Pigeon
+
+
+
+Workarea Google Tag Manager 4.2.3 (2018-10-30)
+--------------------------------------------------------------------------------
+
+*   Update implementation of container ID to use configuration rather than secrets
+
+    This change allows much easier per-site configuration of GTM for multi-site applications.
+
+    * Includes a fallback to secrets for configuration but prefers apps to use configuration over secrets
+
+    WLGTM-9
+    Jake Beresford
+
+
+
+Workarea Google Tag Manager 4.2.2 (2018-04-11)
+--------------------------------------------------------------------------------
+
+*   Remove duplicate closing script tag
+
+    WLGTM-8
+    Kristin Henson
+
+
+Workarea Google Tag Manager 4.2.1 (2018-01-11)
+--------------------------------------------------------------------------------
+
+*   Prevent GTM making external requests in test
+
+    WLGTM-6
+    Jake Beresford
+
+
+Workarea Google Tag Manager 4.2.0 (2017-10-13)
+--------------------------------------------------------------------------------
+
+Developers - note that this change moves configuration of GTM container ID from
+Workarea.config in to application secrets, you will need to update your secrets
+file when taking this change. See README for instructions.
+
+*   Use secrets to configure Google Tag Manager
+
+    WLGTM-3
+    Jake Beresford

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in tag_manager.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+gem 'workarea', source: 'https://gems.weblinc.com'

data/README.md

@@ -0,0 +1,339 @@
+# Workarea Tag Manager
+
+Google Tag Manager plugin for the Workarea platform.
+Including Enhanced ecommerce configuration.
+
+Do not use this plugin for Google Analytics, workarea-google-analytics is well maintained and provides more functionality for GA specifically.
+
+Tag manager Sets up a dataLayer on the window and pushes all data to the dataLayer. This is read by GTM and can be used in custom variables.
+
+## Configuring Google Tag Manager
+
+In your applications workarea.rb initializer add the following configuration
+
+```ruby
+Workarea.config.google_tag_manager.container_id = 'your-container-id'
+```
+
+## Shared Events
+
+These Events are re-used by many of the events detailed in the Summary of events below
+
+### Checkout Step
+
+'step' is a number equal to the checkout step
+
+1. Cart
+2. Addresses
+3. Shipping
+4. Payment
+
+dataLayer:
+
+    'event': 'checkout',
+    'ecommerce': {
+        'checkout': {
+            'actionField': { 'step': step },
+            'products': [
+                {
+                    'id': "4559F84840",
+                    'name': "Slim Ankle Pants",
+                    'category': "Women's Pants",
+                    'variant': "292205283-4",
+                    'price': 31.56,
+                    'quantity': 1
+                }
+            ]
+        }
+    }
+
+## Summary of Events
+
+### Category View
+
+Sent on category show pages (aka product browse)
+
+dataLayer:
+
+    'event': 'categoryView',
+    'name': 'Category Name',
+    'sort': "top_sellers",
+    'page': 1
+
+---
+
+### searchResultsView
+
+Sent on search results page
+
+dataLayer:
+
+    'event': 'searchResultsView',
+    'terms': 'red shirt',
+    'sort': 'relevance',
+    'page': 1
+
+---
+
+### Product List
+
+Sent anywhere there are lists of products, including: product browse, search results, cart page, product recommendations, category summary content block, product list content block.
+
+dataLayer:
+    'ecommerce': {
+        'impressions': [
+            {
+                'id': "4559F84840",
+                'price': 31.56,
+                'name': "Slim Ankle Pants",
+                'category': "Women's Pants",
+                'variant': "292205283-4",
+                'list': "Slim Ankle Pants",
+                'position': 1
+            }
+        ]
+    }
+
+---
+
+### Product Click
+
+Triggered when a user clicks on any product summary in the storefront.
+
+dataLayer:
+
+    'event': 'productClick',
+    'ecommerce': {
+        'click': {
+            'actionField': {'list': "Women's Pants"},
+            'products': [{
+                'name': "Slim Ankle Pants",
+                'id': "4559F84840",
+                'price': 31.56,
+                'category': "Women's Pants",
+                'variant': "292205283-4",
+                'position': 1
+            }]
+        }
+    }
+
+---
+
+### Product Quick View
+
+Triggered when a user opens a product quickview
+
+dataLayer:
+
+    'event': 'quickview',
+    'ecommerce': {
+        'detail': {
+            'actionField': '',
+            'products': [{
+                'name': "Slim Ankle Pants",
+                'id': "4559F84840",
+                'price': 31.56,
+                'category': "Women's Pants",
+                'variant': "292205283-4",
+            }]
+        }
+    }
+
+---
+
+### Product View
+
+Triggered when a user visits the product detail page
+
+dataLayer:
+
+    'ecommerce': {
+        'detail': {
+            'actionField': '',
+            'products': [{
+                'name': "Slim Ankle Pants",
+                'id': "4559F84840",
+                'price': 31.56,
+                'category': "Women's Pants",
+                'variant': "292205283-4",
+            }]
+        }
+    }
+
+---
+
+### Add To Cart
+
+Triggered when add to cart button is clicked
+
+dataLayer:
+
+    'event': 'addToCart',
+    'ecommerce': {
+        'add': {
+            'products': [{
+                'id': "4559F84840",
+                'name': "Slim Ankle Pants",
+                'category': "Women's Pants",
+                'variant': "292205283-4",
+                'price': 31.56,
+                'quantity': 1
+            }]
+        }
+    }
+
+---
+
+### Remove From Cart
+
+Triggered when a product is removed from the cart
+
+dataLayer:
+
+    'event': 'removeFromCart',
+    'ecommerce': {
+        'remove': {
+            'products': [{
+                'id': "4559F84840",
+                'name': "Slim Ankle Pants",
+                'category': "Women's Pants",
+                'variant': "292205283-4",
+                'price': 31.56,
+                'quantity': 1
+            }]
+        }
+    }
+
+---
+
+### Cart View
+
+Triggered when the cart page is opened, including cart summaries (drawer or dropdown)
+
+Uses Checkout Step shared function
+
+---
+
+### Checkout Addresses View
+
+Triggered on the Addresses step of checkout
+
+Uses Checkout Step shared function
+
+---
+
+### Checkout Shipping View
+
+Triggered on the Shipping step of checkout
+
+Uses Checkout Step shared function
+
+---
+
+### Checkout Shipping Service Selected
+
+Triggered when the user changes the shipping option on the Shipping step of checkout
+
+dataLayer:
+
+    'event': 'checkoutOption',
+    'ecommerce': {
+        'checkout_option': {
+            'actionField': {'step': 4, 'option': 'FEDEX Ground'}
+        }
+    }
+
+---
+
+### Checkout Payment View
+
+Triggered on the Payment step of checkout
+
+Uses Checkout Step shared function
+
+---
+
+### Checkout Payment Selected
+
+Triggered when the user changes the payment method on the Payment step of checkout
+
+dataLayer:
+
+    'event': 'checkoutOption',
+    'ecommerce': {
+        'checkout_option': {
+            'actionField': {'step': 5, 'option': 'new_card'}
+        }
+    }
+
+---
+
+### Checkout Order Placed
+
+Triggered on the order confirmation page of checkout
+
+dataLayer:
+
+    'ecommerce': {
+        'purchase': {
+            'actionField': {
+                'id': 'CF6D17E28B',
+                'affiliation': 'Site Name',
+                'revenue': 39.50,
+                'tax': 1.94,
+                'shipping': 7.00,
+                'coupon': 'promocode1, promocode2'
+            },
+            'products': [
+                {
+                    'name': "Slim Ankle Pants",
+                    'id': "4559F84840",
+                    'price': 31.56,
+                    'category': "Women's Pants",
+                    'variant': "292205283-4",
+                    'quantity': 1
+                }
+            ]
+        }
+    }
+
+## Getting Started
+
+This gem contains a rails engine that must be mounted onto a host Rails application.
+
+You must have access to a WebLinc gems server to use this gem. Add your gems server credentials to Bundler:
+
+    bundle config gems.weblinc.com my_username:my_password
+
+Or set the appropriate environment variable in a shell startup file:
+
+    export BUNDLE_GEMS__WEBLINC__COM='my_username:my_password'
+
+Then add the gem to your application's Gemfile specifying the source:
+
+    # ...
+    gem 'workarea-google_tag_manager', source: 'https://gems.weblinc.com'
+    # ...
+
+Or use a source block:
+
+    # ...
+    source 'https://gems.weblinc.com' do
+      gem 'workarea-google_tag_manager'
+    end
+    # ...
+
+Update your application's bundle.
+
+    cd path/to/application
+    bundle
+
+## Workarea Platform Documentation
+
+See [http://developer.weblinc.com](http://developer.weblinc.com) for Workarea platform documentation.
+
+## Copyright & Licensing
+
+Copyright Workarea 2015. All rights reserved.
+
+For licensing, contact sales@workarea.com.