Merge branch 'release/0.2.0'

Author: Thomas Deinhamer

CHANGELOG.md

@@ -2,10 +2,16 @@
 
 ## [next]
 
+## [0.2.0] - 2016-02-21
+
+### Added
+- Add support for DNT.
+
 ## [0.1.0] - 2016-02-04
 
 ### Added
 - Initial release
 
-[next]: https://github.com/thasmo/gaoo.js/compare/v0.1.0...HEAD
+[next]: https://github.com/thasmo/gaoo.js/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/thasmo/gaoo.js/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/thasmo/gaoo.js/compare/6a775835e85ecf763257abe3322b282ba171b5ad...v0.1.0

README.md

@@ -4,15 +4,19 @@
 
 `gaoo.js` is a small helper script to [opt-out][ga-optout] from Google Analytics Tracking.
 
-It uses local storage to remember an opt-out and will set a `window`
-property which Google Analytics [inspects][ga-optout] to decide whether to track or not.
+It uses local storage to remember an opt-out and will set a `window` property which Google Analytics
+[inspects][ga-optout] to decide whether to track or not. It supports `DNT` and respects it by default,
+if not configured otherwise.
 
 ## Usage
 
 ```js
-// Initialize on page load. This needs to be called before ga.js is executed.
+// Initialize on page load with respect to DNT.
 window.gaoo('UA-123456-1');
 
+// ... initialize on page load and do not respect DNT.
+window.gaoo('UA-123456-1', false);
+
 // Actively opt-out from Google Analytics tracking.
 window.gaoo('UA-123456-1').enable();
 
@@ -21,11 +25,16 @@ window.gaoo('UA-123456-1').disable();
 
 // Check if currently opted out.
 if(window.gaoo('UA-123456-1').check()) {
-  window.console.log('Currently opted out.');
+  window.console.info('Currently opted out.');
+} else {
+  window.console.info('Tracking page-view now.');
 }
 
 // Get opt-out identification string.
 var identifier = window.gaoo('UA-123456-1').identifier;
+
+// Get DNT browser setting.
+window.console.log(window.gaoo('UA-123456-1').dnt()); // true or false
 ```
 
 ### Examples
@@ -61,3 +70,5 @@ Currently it's not possible to define multiple properties to opt-out from.
 
 **Can domains be configured to opt-out from?**  
 Opting out works for the current `protocol://host:port` combination only.
+
+[ga-optout]: https://developers.google.com/analytics/devguides/collection/analyticsjs/user-opt-out

bower.json

@@ -0,0 +1,19 @@
+{
+  "name": "gaoo.js",
+  "description": "Simple Google Analytics Opt-Out helper.",
+  "keywords": ["google", "analytics", "opt-out", "opt", "out", "tracking"],
+  "main": "src/gaoo.js",
+  "authors": [
+    "Thomas Deinhamer <thasmo@gmail.com>"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/thasmo/gaoo.js",
+  "moduleType": ["globals"],
+  "ignore": [
+    "**/.*",
+    "node_modules",
+    "bower_components",
+    "test",
+    "tests"
+  ]
+}

dist/gaoo.min.js

@@ -1,30 +1,57 @@
 (function (window) {
 	'use strict';
 
-	var gaoo = function (key) {
+	var gaoo = function (key, respectDNT) {
 		var identifier = 'ga-disable-' + key;
 		var storageKey = 'gaoo';
 
+		respectDNT = respectDNT || true;
+
+		var initialize = function () {
+			!loaded() && persist(respectDNT && dnt());
+			update(check());
+		};
+
+		var loaded = function () {
+			return window.localStorage.getItem(storageKey) !== null;
+		};
+
+		var persist = function (value) {
+			window.localStorage.setItem(storageKey, value);
+		};
+
+		var update = function (value) {
+			window[identifier] = value;
+		};
+
 		var enable = function () {
-			window[identifier] = true;
-			window.localStorage.setItem(storageKey, true);
+			update(true);
+			persist(true);
 		};
 
 		var disable = function () {
-			window[identifier] = false;
-			window.localStorage.removeItem(storageKey);
+			update(false);
+			persist(false);
 		};
 
 		var check = function () {
-			return window.localStorage.getItem(storageKey) !== null;
+			return window.localStorage.getItem(storageKey);
+		};
+
+		var dnt = function () {
+			return window.navigator.doNotTrack == '1' ||
+			       window.navigator.doNotTrack == 'yes' ||
+			       window.navigator.msDoNotTrack == '1' ||
+			       window.doNotTrack == '1';
 		};
 
-		window[identifier] = window[identifier] || check();
+		initialize();
 
 		return {
 			enable: enable,
 			disable: disable,
 			check: check,
+			dnt: dnt,
 			identifier: identifier
 		};
 	};