[#21] Track events on Google Analytics

analytics.js

@@ -0,0 +1,53 @@
+'use strict';
+
+var ua = require('universal-analytics');
+var url = require('url');
+var extend = require('extend');
+var config = require('./config');
+
+function pageview(options) {
+  return function(req, res, next) {
+    var defaults = {
+      dp: req.path,
+      dh: _getUrl(req),
+      dr: req.get('Referer'),
+      uip: req.ip,
+      ua: req.get('User-Agent'),
+    };
+
+    if (req.visitor) {
+      req.visitor
+         .pageview(extend(defaults, options))
+         .send();
+    }
+
+    next();
+  };
+}
+
+function sendEvent(req, category, action, label, value, options) {
+  var defaults = {
+    t: 'event',
+    ni: true,
+    ec: category,
+    ea: action,
+    el: label,
+    ev: value,
+  };
+
+  pageview(extend(defaults, options))(req, {}, function(){});
+}
+
+function _getUrl(req) {
+  return url.format({
+    protocol: req.protocol,
+    host: req.get('host'),
+  });
+}
+
+module.exports = {
+  trackingId: config.analytics.tracking_id,
+  middleware: ua.middleware,
+  pageview: pageview,
+  sendEvent: sendEvent,
+};

app.js

@@ -10,6 +10,8 @@ var errorHandler = require('errorhandler');
 
 var config = require('./config');
 var db = require('./db');
+var analytics = require('./analytics');
+
 var indexRoute = require('./routes/index');
 var roomsRoute = require('./routes/rooms');
 
@@ -30,6 +32,10 @@ if (config.env == 'development') {
     res.locals.isDev = true;
     next();
   });
+} else {
+  if (analytics.trackingId) {
+    app.use(analytics.middleware(analytics.trackingId));
+  }
 }
 
 app.use('/', indexRoute);

config.js

@@ -17,3 +17,7 @@ config.mongodb = {
 config.cache = {
   ttl: 3600,
 };
+
+config.analytics = {
+  tracking_id: process.env.GOOGLE_ANALYTICS_TID,
+};

package.json

@@ -14,6 +14,7 @@
     "browserify": "11.2.0",
     "errorhandler": "1.4.2",
     "express": "4.13.3",
+    "extend": "3.0.0",
     "gulp": "3.9.0",
     "gulp-minify-css": "1.2.1",
     "gulp-rename": "1.2.2",
@@ -24,6 +25,7 @@
     "node-cache": "3.0.0",
     "socket.io": "1.3.7",
     "socket.io-client": "^1.3.7",
+    "universal-analytics": "0.3.9",
     "vinyl-source-stream": "^1.1.0"
   },
   "devDependencies": {

routes/index.js

@@ -1,11 +1,13 @@
 'use strict';
 
 var express = require('express');
+var analytics = require('../analytics');
 var router = express.Router();
 
 /* GET home page. */
 router.get('/', function(req, res, next) {
-  res.render('index', { title: 'Express' });
-});
+  res.render('index');
+  next();
+}, analytics.pageview());
 
 module.exports = router;

routes/rooms.js

@@ -1,6 +1,7 @@
 'use strict';
 
 var express = require('express');
+var analytics = require('../analytics');
 var router = express.Router();
 var roomPrefix;
 var io;
@@ -11,19 +12,28 @@ var roomsModel;
 router.get('/:room', function(req, res, next) {
   res.render('room');
   next();
-});
+}, analytics.pageview());
 
 /* POST room. */
 router.post('/:room', function(req, res, next) {
   authorizeOrDie(req, res, function() {
     var room = req.url;
     var size = JSON.parse(req.body.size);
     var message = req.body.message;
+    var analyticsEventOptions = {};
 
     io.sockets.in(room).emit('size', size);
     io.sockets.in(room).emit('message', message);
 
     roomsModel.push(room, size, message);
+
+    if (size.rows && size.cols) {
+      // Use screenResolution as the terminal's size.
+      analyticsEventOptions.sr = size.rows + 'x' + size.cols;
+    }
+    analytics.sendEvent(req, 'rooms', 'write', room, message.length,
+                        analyticsEventOptions);
+
     res.sendStatus(200);
   });
 });
@@ -32,8 +42,8 @@ router.post('/:room', function(req, res, next) {
 router.delete('/:room', function(req, res, next) {
   authorizeOrDie(req, res, function() {
     var room = req.url;
-    roomsModel.drop(room, function(err, col) {
-    });
+    roomsModel.drop(room);
+    analytics.sendEvent(req, 'rooms', 'delete', room);
     res.sendStatus(202);
   });
 });
@@ -45,8 +55,10 @@ function authorizeOrDie(req, res, callback) {
   // FIXME: secret might be empty
   authorizationModel.isAuthorized(room, secret, function(authorized) {
     if (!authorized) {
+      analytics.sendEvent(req, 'rooms', 'authorization', 'failure');
       res.sendStatus(401);
     } else {
+      analytics.sendEvent(req, 'rooms', 'authorization', 'success');
       callback();
     }
   });