Initial import

README.md

@@ -1,4 +1,47 @@
 xoauth2
 =======
 
-XOAuth2 token generation with node.js
+XOAuth2 token generation with node.js
+
+## Installation
+
+    npm install xoauth2
+
+## Usage
+
+xoauth2 generates XOAUTH2 login tokens from provided Client and User credentials
+
+User xoauth2.createXOAuth2Generator(options) to initialize Token Generator
+
+Possible options values:
+
+  * **user** User e-mail address
+  * **accessUrl** Optional Endpoint for token genration (defaults to *https://accounts.google.com/o/oauth2/token*)
+  * **clientId** Client ID value
+  * **clientSecret** Client secret value
+  * **refreshToken** Refresh token for an user
+
+See https://developers.google.com/accounts/docs/OAuth2WebServer#offline for generating the required credentials
+
+### Example
+
+    var xoauth2 = require("xoauth2"),
+        xoauth2gen;
+
+    xoauth2gen = xoauth2.createXOAuth2Generator({
+        user: "user@gmail.com",
+        clientId: "{Client ID}",
+        clientId: "{Client Secret}",
+        refreshToken: "{User Refresh Token}"
+    });
+
+    xoauth2gen.getToken(function(err, token){
+        if(err){
+            return console.log(err);
+        }
+        console.log("Base64 encoded XOAUTH2 auth string: " + token);
+    });
+
+## License
+
+**MIT**

index.js

@@ -0,0 +1,117 @@
+var requestlib = require("request");
+
+/**
+ * Wrapper for new XOAuth2Generator.
+ *
+ * Usage:
+ *
+ *     var xoauthgen = createXOAuth2Generator({});
+ *     xoauthgen.getToken(function(err, xoauthtoken){
+ *         socket.send("AUTH XOAUTH2 " + xoauthtoken);
+ *     });
+ *
+ * @param {Object} options See XOAuth2Generator for details
+ * @return {Object}
+ */
+module.exports.createXOAuth2Generator = function(options){
+    return new XOAuth2Generator(options);
+}
+
+/**
+ * XOAUTH2 access_token generator for Gmail. 
+ * Create client ID for web applications in Google API console to use it.
+ * See Offline Access for receiving the needed refreshToken for an user
+ * https://developers.google.com/accounts/docs/OAuth2WebServer#offline
+ *
+ * @constructor
+ * @param {Object} options Client information for token generation
+ * @param {String} options.user User e-mail address
+ * @param {String} [options.accessUrl="https://accounts.google.com/o/oauth2/token"] Endpoint for token genration
+ * @param {String} options.clientId Client ID value
+ * @param {String} options.clientSecret Client secret value
+ * @param {String} options.refreshToken Refresh token for an user
+ */
+function XOAuth2Generator(options){
+    this.options = options || {};
+
+    this.options.accessUrl = this.options.accessUrl || "https://accounts.google.com/o/oauth2/token";
+
+    this.status = false;
+    this.token = false;
+    this.timeout = 0;  
+}
+
+/**
+ * Returns or generates (if previous has expired) a XOAuth2 token
+ *
+ * @param {Function} callback Callback function with error object and token string
+ */
+XOAuth2Generator.prototype.getToken = function(callback){
+    if(this.timeout > Date.now() && this.token){
+        return callback(null, this.token);
+    }
+    this.generateToken(callback);
+}
+
+/**
+ * Generates a new XOAuth2 token with the credentials provided at initialization
+ *
+ * @param {Function} callback Callback function with error object and token string
+ */
+XOAuth2Generator.prototype.generateToken = function(callback){
+    var urlOptions = {
+        client_id: this.options.clientId || "",
+        client_secret: this.options.clientSecret || "",
+        refresh_token: this.options.refreshToken,
+        grant_type: "refresh_token"
+    }
+
+    requestlib({
+            method: "POST",
+            url: this.options.accessUrl, 
+            form: urlOptions
+        }, (function(error, response, body){
+            var data;
+
+            if(error){
+                return callback(error);
+            }
+            try{
+                data = JSON.parse(body.toString());
+            }catch(E){
+                return callback(E);
+            }
+
+            if(!data || typeof data != "object"){
+                return callback(new Error("Invalid authentication response"));
+            }
+
+            if(data.error){
+                this.status = "error";
+                return callback(data.error);
+            }
+
+            if(data.access_token){
+                this.status = "ok";
+                this.timeout = Date.now() + ((Number(data.expires_in) || 0) - 1) * 1000;
+                this.token = this.buildXOAuth2Token(data.access_token);
+                return callback(null, this.token);
+            }
+
+        }).bind(this));
+}
+
+/**
+ * Converts an access_token and user id into a base64 encoded XOAuth2 token
+ * 
+ * @param {String} accessToken Access token string
+ * @return {String} Base64 encoded token for IMAP or SMTP login
+ */
+XOAuth2Generator.prototype.buildXOAuth2Token = function(accessToken){
+    var authData = [
+        "user=" + (this.options.user || ""),
+        "auth=Bearer " + accessToken,
+        "",
+        ""];
+    return new Buffer(authData.join("\x01"), "utf-8").toString("base64");
+}

package.json

@@ -0,0 +1,22 @@
+{
+  "name": "xoauth2",
+  "version": "0.1.0",
+  "description": "XOAuth2 token generation for accessing GMail SMTP and IMAP",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/andris9/xoauth2.git"
+  },
+  "keywords": [
+    "XOAUTH",
+    "XOAUTH2",
+    "GMail",
+    "SMTP",
+    "IMAP"
+  ],
+  "author": "Andris Reinman",
+  "license": "MIT"
+}