Merge pull request #6 from PLG-Works/release-1.0

Release 1.0.2

Author: kedarchandrayan

CHANGELOG.md

@@ -3,3 +3,6 @@
 
 ## Cache v1.0.1
 - First time cache set intermittent issue fixed for memcached.
+
+## Cache v1.0.2
+- `redis` NPM version updated to 3.1.1 for fixing `Potential exponential regex in monitor mode` security vulnerability.

README.md

@@ -1,17 +1,11 @@
-#Cache
+# Cache
 
 [![Latest version](https://img.shields.io/npm/v/@plgworks/cache.svg?maxAge=3600)][npm]
-[![Downloads per month](https://img.shields.io/npm/dm/@plgworks/cache.svg?maxAge=3600)][npm]
 
 [npm]: https://www.npmjs.com/package/@plgworks/cache
 
-Cache is the central cache implementation module for several modules. 
-It contains three caching engines. The decision of which caching engine to use is governed while creating the cache object. 
-The caching engines implemented are:
-
-* [Memcached](https://memcached.org/)
-* [Redis](https://redis.io/docs/)
-* In-memory (use with single threaded process in development mode only)
+Cache NPM implements wrapper over multiple caching engines - [Memcached](https://memcached.org/), [Redis](https://redis.io/docs/) and In-memory (use with single threaded process in development mode only).
+The decision of which caching engine to use is governed while creating the Cache NPM object. 
 
 ## Why Cache?
  Core packages of different caching systems do not have a common interface, i.e. they have the same functionality implemented with different method signatures.
@@ -29,11 +23,23 @@ npm install @plgworks/cache --save
 
 ## Initialize
 
-### Cache Initialization Params
+```js
+const Cache = require('@plgworks/cache');
+
+const configStrategy = {}; // Refer the next section for detailed documentation on configStrategy
+const cache = Cache.getInstance(configStrategy);
+
+const cacheImplementer = cache.cacheInstance;
+```
+
+**Note**: To print detailed logs, add `CACHE_DEBUG_ENABLED = '1'` in your env variables.
+
+### Config Strategy
 **`configStrategy`** is a mandatory parameter which specifies the configuration strategy to be used for a particular cache engine.
- An example of the configStrategy is:
+
+An example of the configStrategy is:
 ```js
-configStrategy = {
+const configStrategy = {
   cache: {
     engine: "none/redis/memcached",
     host: "",
@@ -58,11 +64,10 @@ configStrategy = {
 - **namespace**: It is in-memory cache namespace.
 
 
-<b>Below are the examples of configStrategies:</b>
-* Redis 
-
+#### Redis Example
+Following is an example of redis engine config strategy to be used in initializing Cache.
 ```js
-configStrategy = {
+const configStrategy = {
   cache: {
     engine: "redis",
     host: "localhost",
@@ -74,10 +79,10 @@ configStrategy = {
   }
 }
 ````
-* Memcached 
-
+#### Memcache Example
+Following is an example of memcache engine config strategy to be used in initializing Cache.
 ```js
-configStrategy = {
+const configStrategy = {
   cache: {
     engine: "memcached",
     servers: ["127.0.0.1:11211"],
@@ -86,9 +91,10 @@ configStrategy = {
   }
 }
 ````
-* In-memory 
+#### In-memory Example
+Following is an example of in-memory engine config strategy to be used in initializing Cache.
 ```js
-configStrategy = {
+const configStrategy = {
   cache: {
     engine: "none",
     namespace: "A",
@@ -98,20 +104,10 @@ configStrategy = {
 }
 ```
 
-### Create Cache Object:
-
-```js
-Cache = require('@plgworks/cache');
-cache = Cache.getInstance(configStrategy);
-
-cacheImplementer = cache.cacheInstance;
-```
-Note: To print detailed logs, add `CACHE_DEBUG_ENABLED = '1'` in your env variables.
-
-## Examples:
+## `cacheImplementer` methods
+Irrespective of the caching engine, the methods exposed in `cacheImplementer` have the consistent signature.
 
 ### Store and retrieve data in cache using `set` and `get`:
-
 ```js
 const resolvePromise = function(cacheResponse){
                            if (cacheResponse.isSuccess()) {
@@ -162,41 +158,35 @@ cacheImplementer.decrement('testCounterKey', 5).then(resolvePromise);
 
 ```js
 cacheImplementer.set('testKey', "testData").then(console.log);
-cacheImplementer.touch('testKey', 10).then(function(cacheResponse){
-    if (cacheResponse.isSuccess()) {
-      console.log(cacheResponse.data.response);
-    } else {
-      console.log(cacheResponse);
-    }
-  });
+cacheImplementer.touch('testKey', 10).then(resolvePromise);
 ```
 
 ## Running test cases
 ### Set environment variables of particular cache engine for which you want to run the tests.
 
 * Redis
-````
+```shell script
 source test/env/redis.sh
-````
+```
 * Memcached
-```` 
+```shell script
 source test/env/memcached.sh
-````
+```
 * In-memory 
-````
+```shell script
 source test/env/inMemory.sh
-````
+```
 ### Cache engines must be running on the specified ports.
 
 * Redis (6380,6381)
-````
+```shell script
 redis-server --port 6380
-````
+```
 * Memcached (11212,11213,11214,11215)
-````
+```shell script
 memcached -p 11212 -d
-````
+```
 ### Run tests
-````
+```shell script
 ./node_modules/.bin/mocha --recursive "./test/*.js"
-````
+```

VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plgworks/cache",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Cache is the central cache implementation for several modules.",
   "main": "index.js",
   "scripts": {
@@ -26,7 +26,7 @@
   "homepage": "https://github.com/PLG-Works/cache#readme",
   "dependencies": {
     "memcached": "2.2.2",
-    "redis": "3.0.2",
+    "redis": "3.1.1",
     "@plgworks/base": "^1.0.0"
   },
   "devDependencies": {