Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
erkie committed Nov 13, 2015
1 parent 003536b commit 662e0e0
Show file tree
Hide file tree
Showing 8 changed files with 338 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules/
115 changes: 115 additions & 0 deletions .jshintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
{
// --------------------------------------------------------------------
// JSHint Configuration, Strict Edition
// --------------------------------------------------------------------
//
// This is a options template for [JSHint][1], using [JSHint example][2]
// and [Ory Band's example][3] as basis and setting config values to
// be most strict:
//
// * set all enforcing options to true
// * set all relaxing options to false
// * set all environment options to false, except the browser value
// * set all JSLint legacy options to false
//
// [1]: http://www.jshint.com/
// [2]: https://github.com/jshint/node-jshint/blob/master/example/config.json
// [3]: https://github.com/oryband/dotfiles/blob/master/jshintrc
//
// @author http://michael.haschke.biz/
// @license http://unlicense.org/

// == Enforcing Options ===============================================
//
// These options tell JSHint to be more strict towards your code. Use
// them if you want to allow only a safe subset of JavaScript, very
// useful when your codebase is shared with a big number of developers
// with different skill levels.

"bitwise" : false, // Prohibit bitwise operators (&, |, ^, etc.).
"curly" : true, // Require {} for every new block or scope.
"eqeqeq" : true, // Require triple equals i.e. `===`.
"forin" : true, // Tolerate `for in` loops without `hasOwnPrototype`.
"immed" : true, // Require immediate invocations to be wrapped in parens e.g. `( function(){}() );`
"latedef" : true, // Prohibit variable use before definition.
"newcap" : true, // Require capitalization of all constructor functions e.g. `new F()`.
"noarg" : true, // Prohibit use of `arguments.caller` and `arguments.callee`.
"noempty" : true, // Prohibit use of empty blocks.
"nonew" : true, // Prohibit use of constructors for side-effects.
"plusplus" : true, // Prohibit use of `++` & `--`.
"regexp" : true, // Prohibit `.` and `[^...]` in regular expressions.
"undef" : true, // Require all non-global variables be declared before they are used.
"strict" : true, // Require `use strict` pragma in every file.
"trailing" : true, // Prohibit trailing whitespaces.

// == Relaxing Options ================================================
//
// These options allow you to suppress certain types of warnings. Use
// them only if you are absolutely positive that you know what you are
// doing.

"asi" : false, // Tolerate Automatic Semicolon Insertion (no semicolons).
"boss" : false, // Tolerate assignments inside if, for & while. Usually conditions & loops are for comparison, not assignments.
"debug" : false, // Allow debugger statements e.g. browser breakpoints.
"eqnull" : false, // Tolerate use of `== null`.
"es5" : false, // Allow EcmaScript 5 syntax.
"esnext" : false, // Allow ES.next specific features such as `const` and `let`.
"evil" : false, // Tolerate use of `eval`.
"expr" : false, // Tolerate `ExpressionStatement` as Programs.
"funcscope" : false, // Tolerate declarations of variables inside of control structures while accessing them later from the outside.
"globalstrict" : false, // Allow global "use strict" (also enables 'strict').
"iterator" : false, // Allow usage of __iterator__ property.
"lastsemic" : false, // Tolerat missing semicolons when the it is omitted for the last statement in a one-line block.
"laxbreak" : false, // Tolerate unsafe line breaks e.g. `return [\n] x` without semicolons.
"laxcomma" : false, // Suppress warnings about comma-first coding style.
"loopfunc" : false, // Allow functions to be defined within loops.
"multistr" : false, // Tolerate multi-line strings.
"onecase" : false, // Tolerate switches with just one case.
"proto" : false, // Tolerate __proto__ property. This property is deprecated.
"regexdash" : false, // Tolerate unescaped last dash i.e. `[-...]`.
"scripturl" : false, // Tolerate script-targeted URLs.
"smarttabs" : false, // Tolerate mixed tabs and spaces when the latter are used for alignmnent only.
"shadow" : false, // Allows re-define variables later in code e.g. `var x=1; x=2;`.
"sub" : false, // Tolerate all forms of subscript notation besides dot notation e.g. `dict['key']` instead of `dict.key`.
"supernew" : false, // Tolerate `new function () { ... };` and `new Object;`.
"validthis" : false, // Tolerate strict violations when the code is running in strict mode and you use this in a non-constructor function.

// == Environments ====================================================
//
// These options pre-define global variables that are exposed by
// popular JavaScript libraries and runtime environments—such as
// browser or node.js.

"browser" : true, // Standard browser globals e.g. `window`, `document`.
"couch" : false, // Enable globals exposed by CouchDB.
"devel" : false, // Allow development statements e.g. `console.log();`.
"dojo" : false, // Enable globals exposed by Dojo Toolkit.
"jquery" : false, // Enable globals exposed by jQuery JavaScript library.
"mootools" : false, // Enable globals exposed by MooTools JavaScript framework.
"node" : false, // Enable globals available when code is running inside of the NodeJS runtime environment.
"nonstandard" : false, // Define non-standard but widely adopted globals such as escape and unescape.
"prototypejs" : false, // Enable globals exposed by Prototype JavaScript framework.
"rhino" : false, // Enable globals available when your code is running inside of the Rhino runtime environment.
"wsh" : false, // Enable globals available when your code is running as a script for the Windows Script Host.

// == JSLint Legacy ===================================================
//
// These options are legacy from JSLint. Aside from bug fixes they will
// not be improved in any way and might be removed at any point.

"nomen" : false, // Prohibit use of initial or trailing underbars in names.
"onevar" : false, // Allow only one `var` statement per function.
"passfail" : false, // Stop on first error.
"white" : false, // Check against strict whitespace and indentation rules.

// == Undocumented Options ============================================
//
// While I've found these options in [example1][2] and [example2][3]
// they are not described in the [JSHint Options documentation][4].
//
// [4]: http://www.jshint.com/options/

"maxerr" : 100, // Maximum errors before stopping.
"predef" : [],
"indent" : 4 // Specify indentation spacing
}
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,38 @@
# GlimrSDK-JS
JavaScript SDK for glimr.io

JavaScript SDK for glimr.io.

The current version can be access from here:

https://storage.googleapis.com/glimr-static/glimrsdk-js/1.0.1/glimr.min.js
https://storage.googleapis.com/glimr-static/glimrsdk-js/1.0.1/glimr.js

## Usage

### .getTags

Fetch all tags associated with the current browser client.

```js
Glimr.getTags("YOUR_CLIENT_ID", function(tags) {
console.log("Tags for client:", tags);
});
```

_Note:_ The `getTags`-call is cached for the duration of the page load. So calling it multiple times will only result in one call to the Glimr servers. The cache is cleared on page refresh.

## Development

### Installation

```bash
git clone git@github.com:KatalysatorAB/GlimrSDK-JS.git
cd GlimrSDK-JS
npm install
```

### Building for production

```bash
npm run build # will output to dist/glimr.min.js
```
1 change: 1 addition & 0 deletions dist/glimr.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 20 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"name": "GlimrSDK-JS",
"version": "1.0.1",
"description": "JavaScript SDK for glimr.io",
"homepage": "https://glimr.io",
"keywords": [
"glimr"
],
"devDependencies": {
"jshint": "latest",
"uglify-js": "latest"
},
"scripts": {
"lint": "$(npm bin)/jshint --config .jshintrc src/**",
"prebuild:js": "npm run lint",
"build:js": "$(npm bin)/uglifyjs --compress --mangle --reserved=Glimr src/glimr.js > dist/glimr.min.js",
"build": "npm run build:js",
"server": "php -S 0.0.0.0:8080 -t test/"
}
}
136 changes: 136 additions & 0 deletions src/glimr.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
(function(window) {
"use strict";

var GLIMR_URL = "//pixel.glimr.io/v3/iptags/:id/";

var Glimr = {
_loadedTags: {},
_loadingTags: {},

JSONP: function(url, callback) {
var timestamp = new Date().getTime();
var generatedFunction = "glmrjsonp" + Math.round(timestamp + Math.random() * 1000001);

window[generatedFunction] = function(json){
callback(json);

try {
delete window[generatedFunction];
} catch(e) {
window[generatedFunction] = undefined;
}

try {
jsonpScript.parentNode.removeChild(jsonpScript);
} catch (e) { }
};

url += (url.indexOf("?") === -1) ? "?" : "&";
url += "callback=" + generatedFunction;

var jsonpScript = document.createElement("script");
if (typeof jsonpScript.addEventListener === "function") {
jsonpScript.addEventListener("error", function() {
callback(false);
}, false);
}
jsonpScript.setAttribute("src", url);
document.getElementsByTagName("head")[0].appendChild(jsonpScript);
},

createCookie: function(name, value, days) {
var domainPieces = document.location.hostname.split(".");
var domain = domainPieces.slice(domainPieces.length - 2, domainPieces.length).join(".");

var expires = "";

if (days) {
var date = new Date();
date.setTime(date.getTime() + (days * 24 * 60 * 60 * 1000));
expires = "; expires=" + date.toGMTString();
}

document.cookie = name + "=" + value + expires + "; path=/; domain=" + domain;
},

readCookie: function(name) {
var nameEQ = name + "=";
var ca = document.cookie.split(';');
for (var i = 0; i < ca.length; i += 1) {
var c = ca[i];
while (c.charAt(0) === ' ') {
c = c.substring(1, c.length);
}

if (c.indexOf(nameEQ) === 0) {
return c.substring(nameEQ.length, c.length);
}
}
return null;
},

generateUUID: function() {
var d = new Date().getTime();
return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
var r = (d + Math.random() * 16) % 16 | 0;
d = Math.floor(d/16);
return (c === 'x' ? r : (r & 0x3 | 0x8)).toString(16);
});
},

initGlimrId: function() {
Glimr.glimrId = Glimr.readCookie("__glmrid");
if (!Glimr.glimrId) {
Glimr.glimrId = Glimr.generateUUID();
Glimr.setCookie();
}
},

setCookie: function() {
Glimr.createCookie("__glmrid", Glimr.glimrId);
},

getTags: function(pixelId, callback) {
if (typeof Glimr._loadedTags[pixelId] !== "undefined") {
callback(Glimr._loadedTags[pixelId]);
return;
}

if (typeof Glimr._loadingTags[pixelId] !== "undefined") {
Glimr._loadingTags[pixelId].push(callback);
return;
}

Glimr._loadingTags[pixelId] = [];

try {
Glimr.initGlimrId();

Glimr.JSONP(GLIMR_URL.replace(":id", pixelId) + "?id=" + Glimr.glimrId, function(data) {
var tags = [];
if (data && data.tags) {
tags = data.tags;
}

Glimr._loadedTags[pixelId] = tags;

var callbacks = Glimr._loadingTags[pixelId];
for (var i = 0; i < callbacks.length; i += 1) {
callbacks[i](tags);
}

delete Glimr._loadingTags[pixelId];

if (typeof data.id === "string" && data.id !== Glimr.glimrId) {
Glimr.glimrId = data.id;
Glimr.setCookie();
}
});
} catch (e) {
callback([]);
}
}
};

window.Glimr = Glimr;
})(window);
11 changes: 11 additions & 0 deletions test/glimr.min.js.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

$dist_file = "../dist/glimr.min.js";
// $dist_file = "../src/glimr.js";

if (file_exists($dist_file)) {
echo file_get_contents($dist_file);
} else { ?>
alert("Build glimr.min.js with `npm run build`");
<?php
}
17 changes: 17 additions & 0 deletions test/index.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!DOCTYPE html>
<head>
<title></title>
</head>
<body>
<script src="glimr.min.js.php"></script>
<h1 id="foo"></h1>
<script>
for (var i = 0; i < 10; i++) {
Glimr.getTags("TESTCLIENTID", function(tags) {
document.getElementById("foo").innerHTML += "Got tags: <br>[" + tags.join(", ") + "]<br>";
});
}
</script>
</body>

0 comments on commit 662e0e0

Please sign in to comment.