Merge branch 'release/0.1.0'

Author: Thomas Deinhamer

.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = tab
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = false
+
+[{package,bower}.json]
+indent_style = space
+indent_size = 2

.gitattributes

@@ -0,0 +1 @@
+* text=auto

.gitignore

@@ -0,0 +1,2 @@
+# Development
+/node_modules/

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+## [next]
+
+## [0.1.0] - 2016-02-04
+
+### Added
+- Initial release
+
+[next]: https://github.com/thasmo/gaoo.js/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/thasmo/gaoo.js/compare/6a775835e85ecf763257abe3322b282ba171b5ad...v0.1.0

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Thomas "Thasmo" Deinhamer
+
+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.

README.md

@@ -0,0 +1,63 @@
+# gaoo.js
+
+> Simple Google Analytics Opt-Out helper.
+
+`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.
+
+## Usage
+
+```js
+// Initialize on page load. This needs to be called before ga.js is executed.
+window.gaoo('UA-123456-1');
+
+// Actively opt-out from Google Analytics tracking.
+window.gaoo('UA-123456-1').enable();
+
+// Actively opt-in to Google Analytics tracking, again.
+window.gaoo('UA-123456-1').disable();
+
+// Check if currently opted out.
+if(window.gaoo('UA-123456-1').check()) {
+  window.console.log('Currently opted out.');
+}
+
+// Get opt-out identification string.
+var identifier = window.gaoo('UA-123456-1').identifier;
+```
+
+### Examples
+
+**jQuery Example**
+```html
+<button class="opt-out">Opt-Out now.</button>
+<button class="opt-in">Opt-in again.</button>
+
+<script>
+  // Initialize gaoo.js and create a reference.
+  var helper = window.gaoo('UA-123456-1');
+  
+  $('.opt-out').on('click', function(event) {
+    helper.enable();
+    event.preventDefault();
+  });
+  
+  $('.opt-in').on('click', function(event) {
+    helper.disable();
+    event.preventDefault();
+  });
+</script>
+```
+
+## FAQ
+
+**Which browsers does `gaoo.js` support?**  
+Supported are all browsers which implement local storage.
+
+**Can multiple Google Analytics properties be configured?**  
+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.

dist/gaoo.min.js

@@ -0,0 +1,56 @@
+// gulpfile.js
+
+var gulp = require('gulp');
+var $ = require('gulp-load-plugins')();
+
+var watch = {};
+var helper = {
+	error: $.notify.onError({
+		title: '<%= error.plugin %>',
+		message: '<%= error.message %>'
+	}),
+
+	success: function (task, message) {
+		$.notify.logLevel(1);
+
+		return $.notify({
+			title: task,
+			message: message || 'Task finished.',
+			onLast: true
+		});
+	},
+
+	watch: function(glob, tasks) {
+		var hash = glob + tasks.join();
+
+		if(!$.util.env.watch && !$.util.env.w || watch[hash]) {
+			return;
+		}
+
+		watch[hash] = true;
+		gulp.watch(glob, tasks);
+
+		$.util.log(
+			'Watching',
+			'\'' + $.util.colors.cyan(glob) + '\'',
+			'for tasks',
+			'\'' + $.util.colors.cyan(tasks.join(',')) + '\'',
+			'...'
+		);
+	}
+};
+
+// Default
+gulp.task('default', function() {
+	var name = 'Default';
+
+	helper.watch('src/*.js', ['default']);
+
+	return gulp.src('src/*.js')
+		.pipe($.plumber(helper.error))
+		.pipe($.xo({quiet: true}))
+		.pipe($.uglify())
+		.pipe($.rename({extname: '.min.js'}))
+		.pipe(gulp.dest('dist/'))
+		.pipe(helper.success(name));
+});

gulpfile.js

@@ -0,0 +1,25 @@
+{
+  "name": "gaoo.js",
+  "description": "Simple Google Analytics Opt-Out helper.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "http://github.com/thasmo/gaoo.js"
+  },
+  "devDependencies": {
+    "gulp": "~3.9",
+    "gulp-util": "~3.0",
+    "gulp-plumber": "~1.0",
+    "gulp-load-plugins": "~1.1",
+    "gulp-uglify": "~1.5",
+    "gulp-rename": "~1.2",
+    "gulp-notify": "~2.2",
+    "gulp-xo": "~0.7",
+    "del": "~2.1",
+    "require-dir": "~0.3",
+    "run-sequence": "~1.1"
+  },
+  "xo": {
+    "envs": ["browser"]
+  }
+}

package.json

@@ -0,0 +1,33 @@
+(function (window) {
+	'use strict';
+
+	var gaoo = function (key) {
+		var identifier = 'ga-disable-' + key;
+		var storageKey = 'gaoo';
+
+		var enable = function () {
+			window[identifier] = true;
+			window.localStorage.setItem(storageKey, true);
+		};
+
+		var disable = function () {
+			window[identifier] = false;
+			window.localStorage.removeItem(storageKey);
+		};
+
+		var check = function () {
+			return window.localStorage.getItem(storageKey) !== null;
+		};
+
+		window[identifier] = window[identifier] || check();
+
+		return {
+			enable: enable,
+			disable: disable,
+			check: check,
+			identifier: identifier
+		};
+	};
+
+	window.gaoo = gaoo;
+})(window);