wgu-cache

Redis based distributed cache plugin for the WGU Service layer

Install

Run the following command in the root of your wgu-service-template cloned directory

npm install wgu-cache --save

Usage

This is a plugin for the wgu-service-template. All that is needed to use this is to make sure you have installed the package wgu-cache and added the package and version to the package.json found in the root of the application.

Once installed this module will instantiate an instance of WguCache which makes a connection to a remote redis client. It will then attach the instantiated WguCache object to the server as well as add the methods getAndCache, putBustCache, postBustCache, and delBustCache to the server.

Example: (code should be in the routes file index.js of the proper service folder)

module.exports = function( server )
{
	server.getAndCache('/hello', function( req, res, next )
	{
		//like a call to get but caches the results for 10 seconds
    	res.send({ msg: 'hello'}, 10);
	}); 
	
	server.putBustCache('/hello', function( req, res, next )
	{
		//like a call to put but busts any cached results
		res.send({ msg: 'cache busted result'});
	});
	server.postBustCache('/hello', function( req, res, next )
	{
		//like a call to post but busts any cached results
		res.send({ msg: 'cache busted result'});
	});
	server.delBustCache('/hello', function( req, res, next )
	{
		//like a call to del but busts any cached results
		res.send({ msg: 'cache busted result'});
	});
};

When sending a response via the restify res.send you must include a second parameter that represents the amount of seconds that this data should be cached.

There is no need to require the module in the routes file. Just installing it in the project will allow it to attach itself to the server object at runtime.

##Environment Variables

Redis Url

REDISCLOUD_URL or REDISTOGO_URL or OPENREDIS_URL or REDISGREEN_URL

Exports

WguCache

An object definition that will be instantiated and attached to the server at runtime.