update test case

Author: Bossa573

lib/index.js

@@ -36,35 +36,69 @@
 	}
 
 	/**
-	 * get token
-	 * @param callback {function(Object, Object=)} - callback
+	 * get 1 token
+	 * callback:
+	 *    err: errors
+	 *    result: {
+	 * 		limit: rate limit within duration,
+	 *		remaining: number of token remaining,
+	 *		reset: seconds left to reset the rate
+	 * 	}
+	 * @param callback {function(Object, Object=)} - finish callback
 	 */
 	R3Limiter.prototype.get = function(callback) {
 
 		var _this = this;
 
 		if (this._lua_sha1) {
-			this.executeFunction(callback);
+			this._executeFunction(callback);
 		} else {
 			this.redis_client.script('load', this._lua_string, function(err, sha1) {
 				_this._lua_sha1 = sha1;
-				_this.executeFunction(callback);
+				_this._executeFunction(callback);
 			});
 		}
 	};
 
+
 	/**
-	 *
+	 * A helper for getting token and fire the callback
+	 * if rate limit reached, it will try to get token again until token available.
+	 * callback:
+	 *    err: error
+	 * @param callback {function(Object=)} - finish callback
+	 */
+	R3Limiter.prototype.run = function(callback) {
+		var _this = this;
+		this.get(function(err, result) {
+			if (err || !result) {
+				callback(err);
+			} else {
+				if (result.remaining === -1) {
+					setTimeout(function(){
+						_this.run(callback);
+					}, 1000 * (result.reset + 1));
+				} else {
+					callback();
+				}
+			}
+		});
+	};
+
+	/**
+	 * execute lua function
 	 * @param callback
+	 * @private
 	 */
-	R3Limiter.prototype.executeFunction = function(callback) {
+	R3Limiter.prototype._executeFunction = function(callback) {
 
 		var _this = this;
 
 		this.redis_client.evalsha(this._lua_sha1, 3, this.key, this.limit, this.duration, function(err, result) {
 			if (err) {
 				callback(err);
 			} else {
+				var error = null;
 				try {
 					result = JSON.parse(result);
 					result = {
@@ -73,10 +107,11 @@
 						reset: parseInt(result[1])
 					};
 				} catch (e) {
+					error = 'limiter_json_error';
 					result = null;
 				}
 
-				callback(null, result);
+				callback(error, result);
 			}
 		});
 	};

test/index.js

@@ -1,3 +1,5 @@
+/*global describe,beforeEach,it,should */
+
 require('should');
 var Limiter = require('../lib/');
 var redis = require('redis');
@@ -7,8 +9,12 @@ var redis_client = redis.createClient();
 describe('Limiter', function() {
 	beforeEach(function(done) {
 		redis_client.keys('limit:*', function(err, keys) {
-			if (err) return done(err);
-			if (!keys.length) return done();
+			if (err) {
+				return done(err);
+			}
+			if (!keys.length) {
+				return done();
+			}
 			var args = keys.concat(done);
 			redis_client.del.apply(redis_client, args);
 		});
@@ -105,7 +111,7 @@ describe('Limiter', function() {
 					res.remaining.should.equal(0);
 					setTimeout(function() {
 						limiter.get(function(err, res) {
-							console.log(res.reset);
+							//console.log(res.reset);
 							res.reset.should.be.below(2000);
 							res.remaining.should.equal(-1);
 							done();
@@ -224,4 +230,34 @@ describe('Limiter', function() {
 			});
 		});
 	});
+
+
+	describe('test run helper', function() {
+		it('should return no errors', function(done) {
+			this.timeout(7000);
+
+			var limiter = new Limiter({
+				limit: 2,
+				duration: 1,
+				key: 'something',
+				redis_client: redis_client
+			});
+
+			limiter.run(function(err) {
+				(!err).should.equal(true);
+			});
+			limiter.run(function(err) {
+				(!err).should.equal(true);
+			});
+			limiter.run(function(err) {
+				(!err).should.equal(true);
+			});
+			limiter.run(function(err) {
+				(!err).should.equal(true);
+				done();
+			});
+
+		});
+	});
+
 });