**Breaking** Added instantiation so a single cache could be used for multiple frameworks or usages.

Author: four43

README.md

@@ -16,13 +16,14 @@ This will cache the response for 30 seconds, as described by the expires header.
 ```javascript
 // Express.js Web Server
 var app = require('express')(),
-    crispHttpCache = require('crisp-http-cache');
-    
-app.use(crispHttpCache({
-    cacheOptions: {
-        maxSize: 50
-    }
-}));
+    CrispHttpCache = require('crisp-http-cache');
+
+var cache = new CrispHttpCache({
+   cacheOptions: {
+       maxSize: 50
+   }
+});
+app.use(cache.getExpressMiddleware());
 
 app.get('/hello', function (req, res) {
     res.set('expires', new Date(Date.now() + 30000).toUTCString());
@@ -38,6 +39,8 @@ var listener = app.listen(9001, function() {
 
 ## Options
 
+`crisp-http-cache` should be instantiated and the following options can be passed in an object to configure the cache. The middleware can be accessed by calling the getter corresponding to your desired framework.
+
 | Option | Type | Default | Description |
 | ------ | ---- | ------- | ----------- |
 | `enabled` | (boolean) | `true` | A master switch of if we should cache or not, useful to set this to `false` while debugging. |

demo/demo-server.js

@@ -1,13 +1,15 @@
-var crispHttpCache = require('../main'),
+var CrispHttpCache = require('../main'),
 	express = require('express');
 
 var app = express();
 
-app.use(crispHttpCache({
+var cache = new CrispHttpCache({
 	cacheOptions: {
 		maxSize: 50
 	}
-}));
+});
+
+app.use(cache.getExpressMiddleware());
 
 app.get('/hello', function(req, res) {
 	res.set('expires', new Date(Date.now() + 30000));

main.js

@@ -19,7 +19,7 @@ var CrispCache = require('crisp-cache'),
  *
  * @return {crispHttpCache~middleware}
  */
-function crispHttpCache(options) {
+function CrispHttpCache(options) {
 	if (options === undefined) {
 		options = {};
 	}
@@ -39,7 +39,9 @@ function crispHttpCache(options) {
 		}
 	}
 	this.cache = new CrispCache(this.cacheOptions);
+}
 
+CrispHttpCache.prototype.getExpressMiddleware = function () {
 	return function (req, res, next) {
 		if (this.enabled) {
 			this.shouldCache(req, res, function (err, shouldCache) {
@@ -73,15 +75,15 @@ function crispHttpCache(options) {
 									}
 									else {
 										debug("Cache values did not pass compareCache, re-running.");
-										interceptRes(req, res, key, this.getTtl, this.cache, this.transformHeaders);
+										this._interceptRes(req, res, key, this.getTtl, this.cache, this.transformHeaders);
 										return next();
 									}
-								});
+								}.bind(this));
 
 							}
 							else {
 								debug("Cache miss for: " + key);
-								interceptRes(req, res, key, this.getTtl, this.cache, this.transformHeaders);
+								this._interceptRes(req, res, key, this.getTtl, this.cache, this.transformHeaders);
 								return next();
 							}
 						}.bind(this));
@@ -91,21 +93,21 @@ function crispHttpCache(options) {
 					//shouldCache function said we should skip caching.
 					return next();
 				}
-			});
+			}.bind(this));
 		}
 		else {
 			//Caching disabled, skip
 			return next();
 		}
 	}.bind(this);
-}
+};
 
-function interceptRes(req, res, key, getTtl, cache) {
+CrispHttpCache.prototype._interceptRes = function(req, res, key, getTtl, cache) {
 	saveBody(res);
-	preFinish(res, function(res, data, cb) {
+	preFinish(res, function (res, data, cb) {
 		this.transformHeaders(res);
 		cb(null, res);
-	});
+	}.bind(this));
 	onFinished(res, function (err, res) {
 		if (res.statusCode < 200 || res.statusCode >= 300) {
 			debug("Non 2XX status code, not saving");
@@ -122,19 +124,21 @@ function interceptRes(req, res, key, getTtl, cache) {
 		getTtl(req, res, function (err, ttl) {
 			debug(" - With TTL: " + ttl);
 			// If we didn't get a hangup, we can cache it.
-			if(res.body && res.body.length) {
+			if (res.body && res.body.length) {
 				cache.set(key, cachedEntry, {size: res.body.length, expiresTtl: ttl});
 			}
 		});
 	});
-}
+};
+
+module.exports = CrispHttpCache;
 
 function preFinish(res, cb) {
 	var origSend = res.send;
 
-	res.send = function(data) {
+	res.send = function (data) {
 		var sendArgs = arguments;
-		cb(res, data, function(err, res) {
+		cb(res, data, function (err, res) {
 			origSend.apply(res, sendArgs);
 		});
 	}
@@ -337,12 +341,12 @@ function _transformHeaders(res, estExpiresInterval) {
 }
 
 function _parseDateString(date) {
-	if(date === 'Infinity') {
+	if (date === 'Infinity') {
 		return Infinity;
 	}
-	else if(!isNaN(parseInt(date))) {
+	else if (!isNaN(parseInt(date))) {
 		return parseFloat(date);
-	} else if(!isNaN(Date.parse(date))) {
+	} else if (!isNaN(Date.parse(date))) {
 		return new Date(date);
 	}
 	else {
@@ -362,8 +366,6 @@ function _parseContentTypeCharset(contentTypeString) {
 	return false;
 }
 
-module.exports = crispHttpCache;
-
 /**
  * A function that is provided with the current context of the request
  * @callback crispHttpCache~contextCallback

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-crisp-http-cache",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Middleware providing a crispy fresh cache for HTTP responses. ",
   "main": "main.js",
   "scripts": {

test/frameworks/expressjs.js

@@ -1,6 +1,6 @@
 var assert = require('assert'),
 	async = require('async'),
-	crispHttpCache = require('../../main'),
+	CrispHttpCache = require('../../main'),
 	express = require('express'),
 	request = require('supertest'),
 	sinon = require('sinon');
@@ -106,11 +106,14 @@ describe("Express Middleware", function () {
 });
 
 function setupExpress(app) {
-	app.use(crispHttpCache({
+
+	var cache = new CrispHttpCache({
 		cacheOptions: {
 			maxSize: 50
 		}
-	}));
+	});
+
+	app.use(cache.getExpressMiddleware());
 
 	app.get('/hello', function (req, res) {
 		res.set('expires', new Date(Date.now() + 30000).toUTCString());