add .putToken()

Author: Lars-Magnus Skog

README.md

@@ -4,18 +4,55 @@ This is the token manager for the http://revisit.link project.
 
 ## Usage
 
-    var RevisitToken = require('revisit-token');
-    var rt = new RevisitToken();
-
-    // Generate a new token
-    rt.generate(function (err, tk) {
-      console.log(tk);
-    });
-
-    // Check if a token still exists
-    rt.getToken(token, function (err, tk) {
-      if (err) {
-        // Token has expired
-        console.log(err);
-      }
-    });
+```js
+var RevisitToken = require('revisit-token');
+var rt = new RevisitToken();
+
+// Generate a new uuid token
+t.generate(function (err, tk) {
+  console.log(tk);
+});
+
+// Custom tokens with custom ttl
+t.putToken('wooohoo', 56000, function (err, tk) {
+  console.log(tk);
+});
+
+// Check if a token still exists
+rt.getToken(token, function (err, tk) {
+  if (err) {
+    // Token has expired
+    console.log(err);
+  }
+});
+```
+
+## Api
+
+### `RevisitToken([options])`
+
+Constructor with optional options object, which takes the following properties:
+
+* `db` *(string)* Path to db. Defaults to `'./db-tokens'`.
+* `ttl` *(number | string)* TTL in milliseconds. Defaults to 24 hours.
+* `frequency` *(number | string)* Interval in milliseconds how often the tokens should be checked. Defaults to 10 seconds.
+
+### `.generate(cb)`
+
+Generates an uuid token with a ttl set to the value set in the constructor. Calls back with `(err, token)`.
+
+### `.putToken(token[, ttl], cb)`
+
+As `generate()` but enables storing custom tokens with a custom ttl. Calls back with `(err, token)`.
+
+* `token` *(string)* Token to store.
+* `ttl` *(number | string)* Optional TTL in milliseconds. Defaults to the ttl value set in the constructor.
+
+### `.getToken(token, cb)`
+
+Retrieves a token. Calls back with `(err, token)`. If `err` is set the token has expired.
+
+* `token` *(string)* Token to retrieve.
+
+## License
+BSD

index.js

@@ -7,12 +7,16 @@ var ttl = require('level-ttl');
 var TTL_LIMIT = 1000 * 60 * 60 * 24; // 24 hours
 
 var RevisitToken = function (options) {
+  if (!(this instanceof RevisitToken)) {
+    return new RevisitToken(options);
+  }
+
   if (!options) {
     options = {};
   }
 
   var dbPath = options.db || './db-tokens';
-  var limit = parseInt(options.ttl, 10) || TTL_LIMIT;
+  var defaultTTL = parseInt(options.ttl, 10) || TTL_LIMIT;
   var frequency = parseInt(options.frequency, 10) || 10000;
 
   var db = level(dbPath, {
@@ -23,14 +27,20 @@ var RevisitToken = function (options) {
   db = ttl(db, { checkFrequency: frequency || 10000 });
 
   this.generate = function (next) {
-    var token = uuid.v4();
+    this.putToken(uuid.v4(), next);
+  };
+
+  this.putToken = function (token, ttl, next) {
+    if (typeof ttl == 'function') {
+      next = ttl;
+      ttl = defaultTTL;
+    }
 
     db.put('token!' + token, token, {
-      ttl: limit
+      ttl: ttl
     }, function (err) {
       if (err) {
-        next(err);
-        return;
+        return next(err);
       }
 
       next(null, token);
@@ -40,8 +50,7 @@ var RevisitToken = function (options) {
   this.getToken = function (token, next) {
     db.get('token!' + token, function (err, token) {
       if (err || !token) {
-        next(new Error('No token found'));
-        return;
+        return next(new Error('No token found'));
       }
 
       next(null, token);

test/test.index.js

@@ -8,7 +8,7 @@ var child = require('child_process');
 var RevisitToken = require('../index');
 var rt = new RevisitToken({
   db: './test/db-token',
-  ttl: 500,
+  ttl: 50,
   frequency: 1
 });
 
@@ -26,7 +26,39 @@ describe('RevisitToken', function () {
           should.exist(err);
           done();
         });
-      }, 1500);
+      }, 100);
     });
   });
+
+  it('should handle custom tokens', function (done) {
+    var customToken = 'wearetheknightswhosay';
+    rt.putToken(customToken, function (err, token) {
+      should.exist(token);
+      should.equal(token, customToken);
+
+      setTimeout(function () {
+        rt.getToken(token, function (err) {
+          should.exist(err);
+          done();
+        });
+      }, 100);
+    });
+  });
+
+  it('should handle custom tokens with custom ttl', function (done) {
+    var customToken = 'wearenolongertheknightswhosay';
+    rt.putToken(customToken, 300, function (err, token) {
+      should.exist(token);
+      should.equal(token, customToken);
+
+      setTimeout(function () {
+        rt.getToken(customToken, function (err, token) {
+          should.not.exist(err);
+          should.equal(token, customToken);
+          done();
+        });
+      }, 100);
+    });
+  });
+
 });