Initial commit

Author: mushishi78

.gitignore

@@ -0,0 +1 @@
+node_modules

.travis.yml

@@ -0,0 +1,3 @@
+language: node_js
+node_js:
+  - '0.12'

README.md

@@ -0,0 +1,53 @@
+# Jekll-Store/Google-Analytics
+
+[![Build Status](https://travis-ci.org/jekyll-store/google-analytics.svg?branch=master)](https://travis-ci.org/jekyll-store/google-analytics)
+
+Google analytics plugin for [Jekyll-Store Engine](https://github.com/jekyll-store/engine).
+
+## Usage
+
+Requires that the google analytics javascript file to be loaded:
+
+```html
+<script async src="//www.google-analytics.com/analytics.js"></script>
+```
+
+## Actions
+
+### setTrackingId
+
+Set's Google Analytics tracking ID.
+
+Example:
+
+```javascript
+JekyllStoreEngine.Actions.setTrackingId({ id: 'UA-62379004-1' });
+```
+
+### pageLoaded
+
+Declare the page loaded.
+
+Example:
+
+```javascript
+JekyllStoreEngine.Actions.pageLoaded();
+```
+
+### checkoutStep
+
+Declare the page a checkout step.
+
+Example:
+
+```javascript
+JekyllStoreEngine.Actions.checkoutStep({ step: 2 });
+```
+
+## Contributing
+
+1. [Fork it](https://github.com/jekyll-store/google-analytics/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

package.json

@@ -0,0 +1,29 @@
+{
+  "name": "jekyll-store-google-analytics",
+  "main": "./src/JekyllStoreGoogleAnalytics.js",
+  "version": "0.0.1",
+  "description": "Google analytics plugin for Jekyll-Store Engine",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jekyll-store/google-analytics.git"
+  },
+  "dependencies": {
+    "big.js": "^3.0.1",
+    "immutable": "^3.6.4",
+    "reflux": "^0.2.7",
+    "ga-browser": "^1.0.0"
+  },
+  "devDependencies": {
+    "chai": "^2.1.2",
+    "mocha": "^2.2.1",
+    "sinon": "^1.14.1"
+  },
+  "peerDependencies": {
+    "jekyll-store-engine": ">=0.1.3"
+  },
+  "scripts": {
+    "test": "mocha"
+  },
+  "author": "Max White",
+  "license": "ISC"
+}

src/GoogleAnalyticsStore.js

@@ -0,0 +1,65 @@
+// Includes
+var Reflux = require('reflux');
+var JSE = require('jekyll-store-engine');
+var listenAndMix = JSE.Mixins.listenAndMix;
+
+var GoogleAnalyticsStore = Reflux.createStore({
+  // Public
+  listenables: [JSE.Actions],
+  mixins: [
+    listenAndMix(JSE.Stores.Basket),
+    listenAndMix(JSE.Stores.Delivery),
+    listenAndMix(JSE.Stores.Order)
+  ],
+  onSetTrackingId: function(args) {
+    t.ga('create', args.id, 'auto');
+    t.ga('require', 'ec');
+  },
+  onPageLoaded: function() {
+    t.ga('send', 'pageview');
+  },
+  onVisit: function(args) {
+    t.ga('ec:addProduct', { 'name': args.name });
+    t.ga('ec:setAction', 'detail');
+  },
+  onSetItem: function(args) {
+    t.ga('ec:addProduct', { 'name': args.name, 'quantity': args.quantity });
+    t.ga('ec:setAction', 'add');
+    t.ga('send', 'event', 'UX', 'click', 'add to basket');
+  },
+  onRemoveItem: function(args) {
+    t.ga('ec:addProduct', { 'name': args.name });
+    t.ga('ec:setAction', 'remove');
+    t.ga('send', 'event', 'UX', 'click', 'remove from basket');
+  },
+  onCheckoutStep: function(args) {
+    t.addBasket();
+    t.ga('ec:setAction','checkout', { 'step': args.step });
+  },
+  onSetPaymentOptions: function(args) {
+    t.ga('set', '&cu', args.currency);
+  },
+  onCompleted: function(args) {
+    t.addBasket();
+    t.ga('ec:setAction', 'purchase', {
+      'id': args.number,
+      'revenue': t.order.getIn(['totals', 'order']).toString(),
+      'shipping': t.delivery.get('amount').toString()
+    });
+    t.ga('send', 'pageview');
+  },
+
+  // Private
+  ga: require('ga-browser')(),
+  addBasket: function() {
+    t.basket.forEach(function(item, name) {
+      t.ga('ec:addProduct', {
+        'name': name,
+        'price': item.get('price').toString(),
+        'quantity': item.get('quantity').toString()
+      });
+    });
+  }
+});
+
+var t = module.exports = GoogleAnalyticsStore;

src/JekyllStoreGoogleAnalytics.js

@@ -0,0 +1,8 @@
+var Reflux = require('reflux');
+var JSE = require('jekyll-store-engine');
+
+JSE.Actions.setTrackingId = Reflux.createAction();
+JSE.Actions.pageLoaded = Reflux.createAction();
+JSE.Actions.visit = JSE.Actions.visit || Reflux.createAction();
+JSE.Actions.checkoutStep = Reflux.createAction();
+JSE.Stores.GoogleAnalytics = require('./GoogleAnalyticsStore');

test/GoogleAnalyticsStore.spec.js

@@ -0,0 +1,49 @@
+var assert = require('chai').assert;
+var sinon = require('sinon');
+var I = require('immutable');
+var B = require('big.js');
+var GoogleAnalyticsStore = require('../src/GoogleAnalyticsStore');
+
+describe('GoogleAnalyticsStore', function() {
+  GoogleAnalyticsStore.ga = sinon.spy();
+
+  GoogleAnalyticsStore.basket = I.fromJS({
+    'Laser Sight': { name: 'Laser Sight', price: B(34.28), quantity: B(2) },
+    'Bayonet': { name: 'Bayonet', price: B(8.75), quantity: B(1) }
+  });
+
+  GoogleAnalyticsStore.delivery = I.fromJS({ name: 'UPS Extra', amount: B(4.50) });
+
+  GoogleAnalyticsStore.order = I.fromJS({
+    totals: { price: B(77.31), order: B(81.81) },
+    delivery: 'UPS Extra',
+    errors: [],
+    adjustments: [{ label: 'UPS Extra', amount: B(4.50) }]
+  });
+
+  it('adds basket and purchase action on completion', function() {
+    GoogleAnalyticsStore.onSetTrackingId({ id: 'UA-62379004-1' });
+    GoogleAnalyticsStore.onCompleted({ number: 'FHRUDH458DU' });
+    var expected = [
+      ['create', 'UA-62379004-1', 'auto'],
+      ['require', 'ec'],
+      ['ec:addProduct', {
+        'name': 'Laser Sight',
+        'price': '34.28',
+        'quantity': '2'
+      }],
+      ['ec:addProduct', {
+        'name': 'Bayonet',
+        'price': '8.75',
+        'quantity': '1'
+      }],
+      ['ec:setAction', 'purchase', {
+        'id': 'FHRUDH458DU',
+        'revenue': '81.81',
+        'shipping': '4.5'
+      }],
+      ['send', 'pageview' ]
+    ]
+    assert.deepEqual(GoogleAnalyticsStore.ga.args, expected);
+  });
+});