workarea-segment_analytics 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b63311948bf8b091926cca0496c0502f4bd7093a94f11667a251183711b993a4
+  data.tar.gz: f7739b2422619785b8934267bf3c39ae53a146a3b481484c2c95900fd19c7215
+SHA512:
+  metadata.gz: 8f03ef7cbae1463b91c7e2d545530310d4e551362f8da36584fdc05bf015b73eed4c3328b8033e4752d85ccc61e0714cd9ce9ff3a1e3e2670085171146179713
+  data.tar.gz: 3ff6a1baaac585224810578e11d5a38f5a01924dc579513af50576163f608aeda66ac8f0603d8ac1232ef79685310361d274796d8faf1ff65b0e72f8bb3152b5

data/.eslintrc

@@ -0,0 +1,35 @@
+{
+    "extends": "eslint:recommended",
+    "rules": {
+      "semi": ["error", "always"],
+      "eqeqeq": ["error", "always"]
+    },
+    "globals": {
+      "window": true,
+      "document": true,
+      "WORKAREA": true,
+      "$": true,
+      "jQuery": true,
+      "_": true,
+      "feature": true,
+      "JST": true,
+      "Turbolinks": true,
+      "I18n": true,
+      "Chart": true,
+      "Dropzone": true,
+      "strftime": true,
+      "Waypoint": true,
+      "wysihtml": true,
+      "LocalTime": true,
+      "describe": true,
+      "after": true,
+      "afterEach": true,
+      "before": true,
+      "beforeEach": true,
+      "it": true,
+      "expect": true,
+      "sinon": true,
+      "fixture": true,
+      "chai": true
+    }
+}

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_gem:
+  workarea-ci: rubocop.yml
+
+AllCops:
+  Exclude:
+    - 'test/dummy/**/*'
+    - 'lib/workarea/segment_analytics.rb'
+    - 'lib/workarea/segment_analytics/**/*'

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+Workarea Segment Analytics 1.0.2 (2019-08-21)
+--------------------------------------------------------------------------------
+
+* Open Source!
+
+
+
+Workarea Segment Analytics 1.0.1 (2019-03-19)
+--------------------------------------------------------------------------------
+
+*   Update for v3.4 compatibility
+
+    * Add CI build scripts
+    * Update gemfile
+    * Add default rubocop.yml configuration
+    * Update ESLint configuration and fix some linting errors
+    * Add keepfile for test/dummy/tmp/screenshots
+
+    SEGMENT-6
+    Jake Beresford
+
+
+
+Workarea Segment Analytics 1.0.0 (2018-01-11)
+--------------------------------------------------------------------------------
+
+To clean up your release notes, add your project's Jira key to the Changelog Rake task!
+*   Bump version for v1.0.0 release
+    Jake Beresford
+
+To clean up your release notes, add your project's Jira key to the Changelog Rake task!
+*   Fetch teaspoon stubs after renaming plugin
+
+    SEGMENT-5
+    Jake Beresford
+
+To clean up your release notes, add your project's Jira key to the Changelog Rake task!
+*   Rename plugin to workarea-segment_analytics
+
+    This plugin was renamed due to a name conflict with the Workarea::Segment class in workarea-segmentation.
+
+    SEGMENT-4
+    Jake Beresford
+
+
+Workarea Segment 0.1.0 (2017-10-13)
+--------------------------------------------------------------------------------

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in segment_analytics.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 'byebug', group: [:development, :test]
+
+gem 'workarea', source: 'https://gems.weblinc.com'

data/README.md

@@ -0,0 +1,91 @@
+Workarea Segment Analytics
+================================================================================
+
+Segment plugin for the Workarea platform.
+
+Integration with segment https://segment.com/
+API docs: https://segment.com/docs/sources/
+
+This plugin implements segment's client side tracking API via their 'analytics.js' script.
+Before installing and configuring this plugin you should set up & configure your segment account with a Website / Javascript source.
+
+Configuration
+--------------------------------------------------------------------------------
+
+To configure segment in your application you must add the segment write key to your application secrets.
+You can find the write key by logging in to the segment admin and visiting this URL https://segment.com/weblinc/sources/javascript/settings/keys
+
+    segment_analytics:
+      write_key: alongstringgoeshere
+
+You will also need to update your application views to include an additional analytics payload for checkout started. To do this add the checkoutStarted event & payload to any links to checkout_path, for example in your cart/show.html.haml view.
+
+snippet to add:
+    data: { analytics:  checkout_started_analytics_data(@cart).to_json
+
+#### Compatability with other plugins
+
+If you are using the workarea-share plugin you should also add the following to your share links in workarea/storefront/shares/_share_buttons.html.haml
+
+     data: { analytics: share_analytics_data('*share service name goes here*', share_url, message).to_json }
+
+example:
+
+     data: { analytics: share_analytics_data('facebook', share_url, message).to_json }
+     
+Testing and debugging
+--------------------------------------------------------------------------------
+To confirm this plugin is functioning you should check the JS console in development mode, the
+adapter for this plugin includes a logger which should show multiple console logs in your browser's JS console.
+All segment logger events begin with 'Segment:'
+
+Once you have verified there are events firing in the console you should confirm that the data received by segment is error-free.
+Segment provide an excellent debugger via their admin console, log in and visit this URL: https://segment.com/weblinc/sources/javascript/debugger
+
+
+Getting Started
+--------------------------------------------------------------------------------
+
+This gem contains a rails engine that must be mounted onto a host Rails application.
+
+To access Workarea gems and source code, you must be an employee of WebLinc or a licensed retailer or partner.
+
+Workarea gems are hosted privately at https://gems.weblinc.com/.
+You must have individual or team credentials to install gems from this server. 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-segment', source: 'https://gems.weblinc.com'
+    # ...
+
+Or use a source block:
+
+    # ...
+    source 'https://gems.weblinc.com' do
+      gem 'workarea-segment'
+    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 WebLinc 2017. All rights reserved.
+
+For licensing, contact sales@workarea.com.

data/Rakefile

@@ -0,0 +1,60 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Segment Analytics'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/segment_analytics/version'
+
+desc "Release version #{Workarea::SegmentAnalytics::VERSION} of the gem"
+task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
+  #Rake::Task['workarea:changelog'].execute
+  #system 'git add CHANGELOG.md'
+  #system 'git commit -m "Update CHANGELOG"'
+  #system 'git push origin HEAD'
+
+  system "git tag -a v#{Workarea::SegmentAnalytics::VERSION} -m 'Tagging #{Workarea::SegmentAnalytics::VERSION}'"
+  system 'git push --tags'
+
+  system "gem build workarea-segment_analytics.gemspec"
+  system "gem push workarea-segment_analytics-#{Workarea::SegmentAnalytics::VERSION}.gem"
+  system "gem push workarea-segment_analytics-#{Workarea::SegmentAnalytics::VERSION}.gem --host #{host}"
+  system "rm workarea-segment_analytics-#{Workarea::SegmentAnalytics::VERSION}.gem"
+end
+
+desc 'Run the JavaScript tests'
+ENV['TEASPOON_RAILS_ENV'] = File.expand_path('../test/dummy/config/environment', __FILE__)
+task teaspoon: 'app:teaspoon'
+
+desc 'Start a server at http://localhost:3000/teaspoon for JavaScript tests'
+task :teaspoon_server do
+  Dir.chdir("test/dummy")
+  teaspoon_env = File.expand_path('../test/teaspoon_env.rb', __FILE__)
+  system "RAILS_ENV=test TEASPOON_ENV=#{teaspoon_env} rails s"
+end

data/app/assets/javascripts/workarea/storefront/segment_analytics/dependencies/analytics.js.erb

@@ -0,0 +1,3 @@
+!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("SegmentAnalytics 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){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment_analytics.com/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="4.0.0";
+analytics.load('<%= Workarea::SegmentAnalytics.write_key %>');
+}}();

data/app/assets/javascripts/workarea/storefront/segment_analytics/modules/login_events.js

@@ -0,0 +1,40 @@
+/**
+ * @namespace WORKAREA.loginEvents
+ */
+WORKAREA.registerModule('loginEvents', (function () {
+    'use strict';
+
+    var userStateIsSet = function () {
+            return !_.isEmpty(window.sessionStorage.getItem('segmentAnalyticsLoginState'));
+        },
+
+        setUserState = function (userData) {
+            window.sessionStorage.setItem('segmentAnalyticsLoginState', userData.logged_in);
+        },
+
+        compare = function (userData) {
+            if (userData.logged_in.toString() !== window.sessionStorage.getItem('segmentAnalyticsLoginState')) {
+                if ( userData.logged_in ) {
+                    WORKAREA.analytics.fireCallback('justLoggedIn');
+                } else {
+                    WORKAREA.analytics.fireCallback('justLoggedOut');
+                }
+
+                setUserState(userData);
+            }
+        },
+
+        setupCallbacks = function () {
+            if ( userStateIsSet() ) {
+                WORKAREA.currentUser.gettingUserData.done(compare);
+            } else {
+                WORKAREA.currentUser.gettingUserData.done(setUserState);
+            }
+        },
+
+        init = _.once(setupCallbacks);
+
+    return {
+        init: init
+    };
+}()));

data/app/assets/javascripts/workarea/storefront/segment_analytics/modules/segment_analytics.js

@@ -0,0 +1,47 @@
+/**
+ * @namespace WORKAREA.segmentAnalytics
+ */
+WORKAREA.registerModule('segmentAnalytics', (function () {
+    'use strict';
+    /*global analytics*/
+
+    var logger = function () {
+            if (WORKAREA.analytics.debug && window.console) {
+                window.console.log('SegmentAnalytics: ', Array.prototype.slice.call(arguments));
+            }
+        },
+
+        track = function (eventType, data) {
+            analytics.track(eventType, data);
+            logger('Track', eventType, data);
+        },
+
+        reset = function () {
+            analytics.reset();
+            logger('Reset');
+        },
+
+        identify = function (userId, data) {
+            analytics.identify(userId, data);
+            logger('Identify', userId, data);
+        },
+
+        page = function (payload) {
+            if (_.isUndefined(payload)) {
+                analytics.page();
+            } else if (payload.category) {
+                analytics.page(payload.category, payload.name);
+            } else {
+                analytics.page(payload.name);
+            }
+
+            logger('Page', payload);
+        };
+
+  return {
+      track: track,
+      page: page,
+      reset: reset,
+      identify: identify
+  };
+}()));

data/app/assets/javascripts/workarea/storefront/segment_analytics/modules/segment_analytics_adapter.js

@@ -0,0 +1,235 @@
+/**
+ * @namespace WORKAREA.segmentAnalytics
+ * @requires WORKAREA.currentUser
+ *
+ *    1. userData.checkout_id and order.id are the same number from
+ *       different sources.  interchangable with cart_id in workarea
+ *
+ *    2.  analytics_helper refers to these differently depending on whether
+ *        order_item_analytics_data or product_analytics_data is used.
+ */
+WORKAREA.analytics.registerAdapter('segmentAnalyticsAdapter', function () {
+    'use strict';
+
+    var pageViewSent = false,
+
+        /**
+         *  PageView event functions
+         */
+
+        isLoaded = function () {
+            var scripts = _.toArray(document.scripts),
+
+            loaded = _.some(scripts, function (script) {
+                return script.src.match(/segment_analytics\.com.+analytics.+\.js/i);
+            });
+
+            return loaded;
+        },
+
+        tryPageView = function (payload) {
+            if (pageViewSent) { return; }
+
+            if (isLoaded()) {
+                WORKAREA.segmentAnalytics.page(payload);
+                pageViewSent = true;
+            } else {
+                window.setTimeout(tryPageView(payload), 500);
+            }
+        },
+
+        /**
+         *  Data manipulation functions
+         */
+
+        productData = function(product) {
+            var data = {
+                category: product.category,
+                name: product.name || product.product_name, /* [2] */
+                position: product.position,
+                price: product.price,
+                product_id: product.product_id || product.id, /* [2] */
+                quantity: product.quantity,
+                variant: product.sku
+            };
+
+            return _.omit(data, _.isEmpty);
+        },
+
+        joinPromoCodes = function(promo_codes) {
+            if (Array.isArray(promo_codes)){
+                return promo_codes.join(',');
+            }
+            return promo_codes;
+        },
+
+        orderData = function (order) {
+            var data = {
+                affiliation: order.site_name,
+                checkout_id: order.id, /* [1] */
+                discount: joinPromoCodes(order.promo_codes),
+                payment_method: order.tenders,
+                revenue: order.total_price,
+                shipping: order.shipping_total,
+                tax: order.tax_total
+            };
+            
+
+            if ( !_.isEmpty(order.items) ) {  /* [2] */
+                data.products = _.map(order.items, productData);
+            } else if ( !_.isEmpty(order.products) ) {  /* [2] */
+                data.products = _.map(order.products, productData);
+            }
+
+            return _.omit(data, _.isEmpty);
+        };
+
+    return {
+        'pageView': tryPageView,
+
+        'categoryView': function (payload) {
+            // Send pageview with additional payload data
+            tryPageView({
+                category: payload.name
+            });
+            
+            WORKAREA.segmentAnalytics.track('Product Category Viewed', {
+                filters: payload.filters,
+                name: payload.name,
+                page: payload.page,
+                sort: payload.sort
+            });
+        },
+
+        'searchResultsView': function (payload) {
+            WORKAREA.segmentAnalytics.track('Products Searched', {
+                query: payload.terms
+            });
+        },
+
+        'productList': function (payload) {
+            var data = {
+                list_id: payload.name,
+                products: _.map(payload.impressions, productData)
+            };
+
+            WORKAREA.segmentAnalytics.track('Product List Viewed', data);
+        },
+
+        'productClick': function (payload) {
+            WORKAREA.segmentAnalytics.track('Product Clicked', productData(payload));
+        },
+
+        'productView': function (payload) {
+            // Send pageview with additional payload data
+            tryPageView({
+                category: payload.category
+            });
+
+            WORKAREA.segmentAnalytics.track('Product Viewed', productData(payload));
+        },
+
+        'addToCart': function (payload) {
+            WORKAREA.currentUser.gettingUserData.done(function(userData){
+                var data = {
+                    cart_id: userData.checkout_id /* [1] */
+                };
+
+                _.assign(data, productData(payload));
+
+                WORKAREA.segmentAnalytics.track('Product Added', data);
+            });
+        },
+
+        'removeFromCart': function (payload) {
+            WORKAREA.currentUser.gettingUserData.done(function(userData){
+                var data = {
+                    cart_id: userData.checkout_id /* [1] */
+                };
+
+                _.assign(data, productData(payload));
+
+                WORKAREA.segmentAnalytics.track('Product Removed', data);
+            });
+        },
+
+        'cartView': function (payload) {
+            WORKAREA.currentUser.gettingUserData.done(function(userData){
+                var data = {
+                    cart_id: userData.checkout_id, /* [1] */
+                    products: _.map(payload.items, productData)
+                };
+
+                WORKAREA.segmentAnalytics.track('Cart Viewed', data);
+                WORKAREA.segmentAnalytics.track('Viewed Checkout Step', _.assign({ step: 1 }, data));
+            });
+        },
+
+        'checkoutStarted': function (payload) {
+            var data = orderData(payload);
+
+            WORKAREA.segmentAnalytics.track('Checkout Started', data);
+        },
+
+        'checkoutAddressesView': function (payload) {
+            var data = orderData(payload);
+
+            WORKAREA.segmentAnalytics.track('Checkout Step Completed', _.assign({ step: 1 }, data));
+            WORKAREA.segmentAnalytics.track('Checkout Step Viewed', _.assign({ step: 2 }, data));
+        },
+
+        'checkoutShippingView': function (payload) {
+            var data = orderData(payload);
+
+            WORKAREA.segmentAnalytics.track('Checkout Step Completed', _.assign({ step: 2 }, data));
+            WORKAREA.segmentAnalytics.track('Checkout Step Viewed', _.assign({ step: 3 }, data));
+        },
+
+        'checkoutPaymentView': function (payload) {
+            var data = orderData(payload);
+
+            WORKAREA.segmentAnalytics.track('Checkout Step Completed', _.assign({ step: 3 }, data));
+            WORKAREA.segmentAnalytics.track('Checkout Step Viewed', _.assign({ step: 4 }, data));
+        },
+
+        'checkoutPaymentSelected': function (payload) {
+            var data = orderData(payload);
+
+            WORKAREA.segmentAnalytics.track('Payment Info Entered', _.assign({ step: 4 }, data));
+        },
+
+        'checkoutOrderPlaced': function (payload) {
+            var data = orderData(payload);
+
+            WORKAREA.segmentAnalytics.track('Checkout Step Completed', _.assign({ step: 4 }, data));
+            WORKAREA.segmentAnalytics.track('Order Completed', data);
+        },
+
+        'justLoggedOut': function () {
+            WORKAREA.segmentAnalytics.reset();
+        },
+
+        'justLoggedIn': function () {
+            WORKAREA.currentUser.gettingUserData.done(function (userData){
+                var data = {
+                    email: userData.user_email,
+                    name: userData.user_name
+                };
+
+                WORKAREA.segmentAnalytics.identify(userData.user_id, data);
+            });
+        },
+
+        'share': function (payload) {
+            var data = {
+                recipient: payload.recipient,
+                share_via: payload.type,
+                share_message: payload.message
+            };
+
+            _.assign(data, productData(payload));
+
+            WORKAREA.segmentAnalytics.track('Product Shared', data);
+        }
+    };
+});