workarea-segment_analytics 1.0.2

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/dummy/db/seeds.rb

@@ -0,0 +1,2 @@
+require 'workarea/seeds'
+Workarea::Seeds.run

data/test/dummy/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "dummy",
+  "private": true,
+  "dependencies": {}
+}

data/test/javascripts/fixtures/payloads.js

@@ -0,0 +1,232 @@
+/*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": 1.0,
+        "total_price": 152.92,
+        "tenders": 'Visa',
+        "email": 'test@weblinc.com',
+        "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/fixtures/stubs.js

@@ -0,0 +1,56 @@
+//= require workarea/storefront/spec_helper
+/*eslint no-unused-vars: 0 */
+
+var gettingUserData = WORKAREA.currentUser.gettingUserData;
+
+function stubSegmentMethods() {
+    // This is an aweful idea, but since WORKAREA.currentUser.gettingUserData
+    // is a promise, not a function it can't be stubbed with sinon.
+    var userData = {
+        "logged_in":true,
+        "cart_quantity":0,
+        "admin":true,
+        "user_id":"59b2f28fc254291234daf27b",
+        "checkout_id":"E2E1096C6A",
+        "user_name":"Ben Crouse",
+        "user_email":"user@workarea.com"
+    };
+
+    WORKAREA.currentUser.gettingUserData = $.Deferred().resolve(userData);
+
+    sinon.stub(WORKAREA.segmentAnalytics, 'page', function(payload) {
+        window.testData.push({
+            eventType: 'page',
+            data: payload
+        });
+    });
+
+    sinon.stub(WORKAREA.segmentAnalytics, 'track', function(eventType, data) {
+        window.testData.push({
+            eventType: eventType,
+            data: data
+        });
+    });
+
+    sinon.stub(WORKAREA.segmentAnalytics, 'identify', function(userId, data) {
+        window.testData.push({
+            eventType: 'identify',
+            userId: userId,
+            data: data
+        });
+    });
+
+    sinon.stub(WORKAREA.segmentAnalytics, 'reset', function() {
+        window.testData.push({
+            eventType: 'reset'
+        });
+    });
+}
+
+function resetStubs() {
+    WORKAREA.segmentAnalytics.page.reset();
+    WORKAREA.segmentAnalytics.track.reset();
+    WORKAREA.segmentAnalytics.identify.reset();
+    WORKAREA.segmentAnalytics.reset.reset();
+    WORKAREA.currentUser.gettingUserData = gettingUserData;
+}

data/test/javascripts/segment_analytics_spec.js

@@ -0,0 +1,311 @@
+//= require workarea/storefront/spec_helper
+
+/*global
+orderPayload productListPayload
+stubSegmentMethods resetStubs
+*/
+
+(function () {
+    'use strict';
+
+    before(function(){
+        window.testData = [];
+    });
+
+    function teardown() {
+        window.testData = [];
+    }
+
+    afterEach(teardown);
+
+    after(resetStubs);
+
+    describe('WORKAREA.segmentAnalyticsAdapter', function () {
+        stubSegmentMethods();
+
+        describe.skip('categoryView', function () {
+            beforeEach(function(){
+                WORKAREA.analytics.fireCallback('categoryView',
+                    {
+                        "name" : "Games",
+                        "sort" : "top_sellers",
+                        "page" : 1,
+                        "filters" : {}
+                    }
+                );
+            });
+
+            it('creates a page view event', function () {
+                //This should be true if isTest worked
+                expect(window.testData[0].eventType).to.eq('page');
+            });
+
+            it('adds the payload to segment', function () {
+                expect(window.testData[1].data.name).to.eq('Games');
+                expect(window.testData[1].data.sort).to.eq('top_sellers');
+                expect(window.testData[1].data.page).to.eq(1);
+            });
+        });
+
+        describe('justLoggedOut', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('justLoggedOut');
+            });
+
+            it('fires the reset event', function () {
+                //This should be true if isTest worked
+                expect(window.testData[0].eventType).to.eq('reset');
+            });
+        });
+
+        describe('productList', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('productList', productListPayload());
+            });
+
+            it('tacks a Product List Viewed event in segment', function () {
+                var payload = window.testData[0].data;
+                expect(window.testData[0].eventType).to.eq('Product List Viewed');
+                expect(payload.list_id).to.eq('Electronics');
+                expect(payload.products.length).to.eq(20);
+            });
+        });
+
+        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('announces a product click event to segment', function () {
+                var payload = window.testData[0].data;
+                expect(window.testData[0].eventType).to.eq('Product Clicked');
+
+                expect(payload.category).to.eq('Automotive');
+                expect(payload.name).to.eq('Heavy Duty Iron Bag');
+                expect(payload.position).to.eq(0);
+                expect(payload.price).to.eq(19.77);
+                expect(payload.product_id).to.eq('4AF99AB7C8');
+                expect(payload.variant).to.eq('288457637-1');
+
+                expect(window.testData[0].data.quantity).to.be.an('undefined');
+            });
+        });
+
+        describe('searchResultsView', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('searchResultsView',
+                    {
+                        "terms" : "query string",
+                        "sort" : "relevance",
+                        "page" : 1,
+                    }
+                );
+            });
+
+            it('tracks a Products Searched event in segment', function () {
+                expect(window.testData[0].eventType).to.eq('Products Searched');
+                expect(window.testData[0].data.query).to.eq('query string');
+            });
+        });
+
+        describe.skip('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('creates a page view event', function () {
+                //This should be true if isTest worked
+                expect(window.testData[0].eventType).to.eq('page');
+            });
+
+            it('announces the products details in the ecommerce event', function () {
+                var product = window.testData[1].data;
+                expect(product.name).to.eq('Heavy Duty Iron Bag');
+                expect(product.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');
+            });
+        });
+
+        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('tracks the product added event in segment', function () {
+                var product = window.testData[0].data;
+                expect(window.testData[0].eventType).to.eq('Product Added');
+
+                expect(product.category).to.eq('Automotive');
+                expect(product.name).to.eq('Heavy Duty Iron Bag');
+                expect(product.product_id).to.eq('4AF99AB7C8');
+                expect(product.price).to.eq(80.76);
+                expect(product.quantity).to.eq('1');
+                expect(product.variant).to.eq('288457637-1');
+            });
+        });
+
+        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('tracks the Product Removed event in segment', function () {
+                var product = window.testData[0].data;
+                expect(window.testData[0].eventType).to.eq('Product Removed');
+
+                expect(product.category).to.eq('Automotive');
+                expect(product.name).to.eq('Heavy Duty Iron Bag');
+                expect(product.product_id).to.eq('4AF99AB7C8');
+                expect(product.price).to.eq(80.76);
+                expect(product.quantity).to.eq('1');
+                expect(product.variant).to.eq('288457637-1');
+            });
+        });
+
+        describe('cartView', function () {
+            beforeEach(function(){
+                WORKAREA.analytics.fireCallback('cartView', orderPayload());
+            });
+
+            it('tracks a Cart Viewed event in segment', function () {
+                expect(window.testData[0].eventType).to.eq('Cart Viewed');
+            });
+
+            it('tracks a Checkout step 1 event in segment', function () {
+                var payload = window.testData[1].data;
+                expect(window.testData[1].eventType).to.eq('Viewed Checkout Step');
+                expect(payload.step).to.eq(1);
+            });
+        });
+
+        describe('checkoutAddressesView', function () {
+            beforeEach(function(){
+                WORKAREA.analytics.fireCallback('checkoutAddressesView', orderPayload());
+            });
+
+            it('tracks a Checkout Step Completed event in segment', function () {
+                expect(window.testData[0].eventType).to.eq('Checkout Step Completed');
+                expect(window.testData[0].data.step).to.eq(1);
+            });
+
+            it('tracks step 2 of checkout in segment', function () {
+                expect(window.testData[1].eventType).to.eq('Checkout Step Viewed');
+                expect(window.testData[1].data.step).to.eq(2);
+            });
+        });
+
+        describe('checkoutShippingView', function () {
+            beforeEach(function(){
+                WORKAREA.analytics.fireCallback('checkoutShippingView', orderPayload());
+            });
+
+            it('tracks Checkout Step 2 Completed event in segment', function () {
+                expect(window.testData[0].eventType).to.eq('Checkout Step Completed');
+                expect(window.testData[0].data.step).to.eq(2);
+            });
+
+            it('announces step 3 of checkout in segment', function () {
+            expect(window.testData[1].eventType).to.eq('Checkout Step Viewed');
+            expect(window.testData[1].data.step).to.eq(3);
+            });
+        });
+
+        describe('checkoutPaymentView', function() {
+            beforeEach(function(){
+                WORKAREA.analytics.fireCallback('checkoutPaymentView',orderPayload());
+            });
+
+            it('tracks Checkout Step 3 Completed event in segment', function () {
+                expect(window.testData[0].eventType).to.eq('Checkout Step Completed');
+                expect(window.testData[0].data.step).to.eq(3);
+            });
+
+            it('announces step 4 of checkout in segment', function () {
+                expect(window.testData[1].eventType).to.eq('Checkout Step Viewed');
+                expect(window.testData[1].data.step).to.eq(4);
+            });
+        });
+
+        describe('checkoutPaymentSelected', function () {
+            before(function(){
+                WORKAREA.analytics.fireCallback('checkoutPaymentSelected',
+                    {
+                        "type" : "new_card"
+                    }
+                );
+            });
+
+            it('announces a Payment Info Entered event in segment', function () {
+                expect(window.testData[0].eventType).to.eq('Payment Info Entered');
+                expect(window.testData[0].data.step).to.eq(4);
+            });
+        });
+
+        describe('checkoutOrderPlaced', function () {
+            beforeEach(function(){
+                WORKAREA.analytics.fireCallback('checkoutOrderPlaced', orderPayload());
+            });
+
+            it('tracks Checkout Step 4 Completed event in segment', function () {
+                expect(window.testData[0].eventType).to.eq('Checkout Step Completed');
+                expect(window.testData[0].data.step).to.eq(4);
+            });
+
+            it('tracks Order Completed event in segment', function() {
+                var payload = window.testData[1].data;
+                expect(window.testData[1].eventType).to.eq('Order Completed');
+
+                expect(payload.affiliation).to.eq('Dummy App');
+                expect(payload.checkout_id).to.eq('6705E78231');
+                expect(payload.discount).to.eq('promo_1,promo_2');
+                expect(payload.payment_method).to.eq('Visa');
+                expect(payload.revenue).to.eq(152.92);
+                expect(payload.shipping).to.eq(7.00);
+                expect(payload.tax).to.eq(1.00);
+            });
+        });
+    });
+}());