Initial files

jhvst · Jan 2, 2013 · 443d90e · 443d90e
1 parent 2d3d717
commit 443d90e
Show file tree

Hide file tree

Showing 6 changed files with 390 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,106 @@
-no-js-analytics
-===============
+#no-js-analytics
 
-Really basic visitor analytics for speed demons using express.
+no-js-analytics is really basic visitor analytics for people not so interested in nice graphs and stuff like that, but ho would like to instead trade those few requests and page loading time for something more useful. no-js-analytics works even if a visitor does not have javascript enabled, which some may find self esteem improving, since all those security paranoids running noscript will be caught too. no-js-analytics requires no database, since all visitor information is held in **object**, genuinely named as db. This makes no-js-analytics easy to adopt and the basic fundamental of speed is met, as also the fact that visitor data will be lost in case of server crash or restart. Anyhow, the object containing the visitor statics is saved every two hours (by default) into logs, but no-js-analytics also provides an easy way to expose that data in nice JSON format to anywhere you like using the analytics.stats() method. Below is an example output:
+
+```
+{
+  "Chrome": {
+    "views": 17
+  },
+  "Linux": {
+    "views": 20
+  },
+  "desktop": {
+    "views": 39
+  },
+  "/": {
+    "views": 41
+  },
+  "overall": {
+    "views": 49
+  },
+  "en-US": {
+    "views": 49
+  },
+  "/analytics": {
+    "views": 8
+  },
+  "Firefox": {
+    "views": 11
+  },
+  "Safari": {
+    "views": 19
+  },
+  "iPad": {
+    "views": 4
+  },
+  "mobile": {
+    "views": 10
+  },
+  "IE": {
+    "views": 2
+  },
+  "Microsoft Windows": {
+    "views": 2
+  },
+  "unknown": {
+    "views": 9
+  },
+  "Android": {
+    "views": 6
+  },
+  "Apple Mac": {
+    "views": 8
+  }
+}
+```
+
+##Tests
+   I made two tests locally on the default express page and below are the results.
+   [google analytics](http://snag.gy/WFO8T.jpg)
+   [no-js-analytics](http://snag.gy/qctlQ.jpg)
+
+##Installation:   
+1. ```$ npm install jaudu```
+
+##Usage:
+```javascript
+var analytics = require('no-js-analytics');
+
+app.configure(function(){
+  ... (all your express configuration)
+  app.use(analytics);
+});
+```
+
+##Methods
+###analytics.save()
+   Writes the current data of db object into a new .txt file in ./analytics-logs
+###analytics.stats()
+   Renders the current data of db object in JSON format. For an example, you might want to show the data in /analytics page, which can easily be achieved as below.
+   ```
+   app.get('/analytics', function(req, res){
+   res.send(200, analytics.stats());
+   });
+   ```
+
+Top of these methods no-js-analytics automatically saves visitor information into a text file every two hours, as declared in milliseconds in lib/middleware.js on line 114. Below it you can also find the default interval of db flush, which is set to happen once in a day.
+
+###Contributing
+   Feel free to contribute new features, bug fixes or to my code syntax.
+
+###To-do
+1. Returning and new visitor counters
+2. Some nice way to represent the data and more robust data structure
+3. More analytic features
+4. Spread to additional frameworks and languages
+5. World domination and bye-bye to formal javascript analytics
+
+###License (MIT)
+   Copyright (c) 2013 Juuso Haavisto <juuso@mail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md~ b/README.md~
@@ -0,0 +1,106 @@
+#no-js-analytics
+
+no-js-analytics is really basic visitor analytics for people not so interested in nice graphs and stuff like that, but ho would like to instead trade those few requests and page loading time for something more useful. no-js-analytics works even if a visitor does not have javascript enabled, which some may find self esteem improving, since all those security paranoids running noscript will be caught too. no-js-analytics requires no database, since all visitor information is held in **object**, genuinely named as db. This makes no-js-analytics easy to adopt and the basic fundamental of speed is met, as also the fact that visitor data will be lost in case of server crash or restart. Anyhow, the object containing the visitor statics is saved every two hours (by default) into logs, but no-js-analytics also provides an easy way to expose that data in nice JSON format to anywhere you like using the analytics.stats() method. Below is an example output:
+
+```
+{
+  "Chrome": {
+    "views": 17
+  },
+  "Linux": {
+    "views": 20
+  },
+  "desktop": {
+    "views": 39
+  },
+  "/": {
+    "views": 41
+  },
+  "overall": {
+    "views": 49
+  },
+  "en-US": {
+    "views": 49
+  },
+  "/analytics": {
+    "views": 8
+  },
+  "Firefox": {
+    "views": 11
+  },
+  "Safari": {
+    "views": 19
+  },
+  "iPad": {
+    "views": 4
+  },
+  "mobile": {
+    "views": 10
+  },
+  "IE": {
+    "views": 2
+  },
+  "Microsoft Windows": {
+    "views": 2
+  },
+  "unknown": {
+    "views": 9
+  },
+  "Android": {
+    "views": 6
+  },
+  "Apple Mac": {
+    "views": 8
+  }
+}
+```
+
+##Tests
+   I made two tests locally on the default express page and below are the results.
+   [google analytics](http://snag.gy/WFO8T.jpg)
+   [no-js-analytics](http://snag.gy/qctlQ.jpg)
+
+##Installation:   
+1. ```$ npm install jaudu```
+
+##Usage:
+```javascript
+var analytics = require('no-js-analytics');
+
+app.configure(function(){
+  ... (all your express configuration)
+  app.use(analytics);
+});
+```
+
+##Methods
+###analytics.save()
+   Writes the current data of db object into a new .txt file in ./analytics-logs
+###analytics.stats()
+   Renders the current data of db object in JSON format. For an example, you might want to show the data in /analytics page, which can easily be achieved as below.
+   ```
+   app.get('/analytics', function(req, res){
+   res.send(200, analytics.stats());
+   });
+   ```
+
+Top of these methods no-js-analytics automatically saves visitor information into a text file every two hours, as declared in milliseconds in lib/middleware.js on line 114. Below it you can also find the default interval of db flush, which is set to happen once in a day.
+
+###Contributing
+   Feel free to contribute new features, bug fixes or to my code syntax.
+
+###To-do
+1. Returning and new visitor counters
+2. Some nice way to represent the data
+3. More analytic features
+4. Spread to additional frameworks and languages
+5. World domination and bye-bye to formal javascript analytics
+
+###License (MIT)
+   Copyright (c) 2013 Juuso Haavisto <juuso@mail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/index.js b/index.js
@@ -0,0 +1 @@
+module.exports = require('./lib/middleware');
diff --git a/lib/middleware.js b/lib/middleware.js
@@ -0,0 +1,126 @@
+/**
+ * Module dependencies.
+ */
+
+var express = require('express')
+  , app = express()
+  , fs = require('fs')
+  , moment = require('moment')
+  , useragent = require('express-useragent');
+
+/**
+ * Initialize
+ */
+
+fs.mkdir('./analytics-logs');
+
+var db = {}
+  , pageviews = 1;
+
+/**
+ * Middleware
+ */
+
+var middleware = function (req, res, next) {
+
+  ua = useragent.parse(req.headers['user-agent']);
+
+  function checkType () {
+    if (ua.isMobile === true) {
+      return 'mobile'
+    }
+    else {
+      return 'desktop'
+    }
+  }
+
+  records(ua.Browser, ua.Platform, checkType(), req.url, req.headers['accept-language'].split(',')[0]);
+
+  next();
+
+};
+
+/**
+ * Records
+ */
+
+function records (browser, platform, type, path, language) {
+
+  db[browser] = {
+    'views': counter(browser)
+  }
+
+  db[platform] = {
+    'views': counter(platform)
+  }
+
+  db[type] = {
+    'views': counter(type)
+  }
+
+  db[path] = {
+    'views': counter(path)
+  } 
+
+  db.overall = {
+    'views': pageviews++
+  }
+
+  db[language] = {
+    'views': counter(language)
+  }
+
+  console.log(db)
+
+}
+
+/**
+ * Counter
+ */
+
+function counter (index) {
+
+  if (db[index] === undefined) {
+    return 1;
+  }
+  else {
+    db[index].views++
+    return db[index].views++
+  }
+
+}
+
+/**
+ * Save and export db object
+ */
+
+var save = function () {
+  fs.writeFile('./analytics-logs/' + moment().format('LL') + '.txt', JSON.stringify(db), function (err) {
+    if (err) throw err;
+    console.log('Analytics saved to file ./analytics-logs/' + moment().format('LL') + '.txt');
+  });
+};
+
+var stats = function () {
+  return db;
+}
+
+/**
+ * Automatically save db object once in every two hours
+ */
+
+setInterval(function() {
+  save();
+}, 7200000);
+
+/**
+ * Flush all data once in a day
+ */
+
+setInterval(function() {
+  var db = {};
+}, 86400000);
+
+module.exports = middleware;
+module.exports.save = save;
+module.exports.stats = stats;
diff --git a/package.json b/package.json
@@ -0,0 +1,26 @@
+{
+  "name": "no-js analytics",
+  "version": "0.1.0",
+  "author": "Juuso Haavisto <juuso@mail.com>",
+  "description": "Really basic visitor analytics for speed demons using express.",
+  "main": "./lib/middleware",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Jhsto/no-js-analytics.git"
+  },
+  "keywords": [
+    "analytics",
+    "middleware",
+    "express",
+    "nojs"
+  ],
+  "dependencies" : {
+    "express"  :  "3.0.x",
+    "moment"   :  "1.7.2",
+    "express-useragent" :  "0.0.7"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=0.6"
+  }
+}