changes to constructor

Author: pasupulaphani

README.md

@@ -1,8 +1,8 @@
-[![npm version](http://img.shields.io/npm/v/simple-redis-store.svg)](https://npmjs.org/package/simple-redis-store)
+[![npm version](http://img.shields.io/npm/v/simple-redis-store.svg?style=flat-square)](https://npmjs.org/package/simple-redis-store)
 [![Build Status](https://travis-ci.org/pasupulaphani/simple-redis-store.svg?branch=master)](https://travis-ci.org/pasupulaphani/simple-redis-store)
 [![Coverage Status](https://coveralls.io/repos/github/pasupulaphani/simple-redis-store/badge.svg?branch=master)](https://coveralls.io/github/pasupulaphani/simple-redis-store?branch=master)
-[![dependencies Status](https://david-dm.org/pasupulaphani/simple-redis-store/status.svg)](https://david-dm.org/pasupulaphani/simple-redis-store)
-[![Gratipay donate button](https://img.shields.io/badge/gratipay-donate-yellow.svg)](https://gratipay.com/simple-redis-store/)
+[![Dependency Status](https://www.versioneye.com/user/projects/583c5221d2fd570034b96f95/badge.svg?style=flat-square)](https://www.versioneye.com/user/projects/583c5221d2fd570034b96f95)
+[![Gratipay donate button](https://img.shields.io/badge/gratipay-donate-yellow.svg?style=flat-square)](https://gratipay.com/simple-redis-store/)
 
 # simple-redis-store
 Redis store ready to scale with node-pool support
@@ -11,7 +11,7 @@ Redis store ready to scale with node-pool support
 
 ## Prerequisites
 
-This module requires nodejs v4 or above as it has dependencies on constious es6 components such as Map, Set, Promise etc.
+This module requires nodejs v4 or above as it has dependencies on es6 components such as Map, Set, Promise etc.
 
 ### Getting started
 
@@ -23,6 +23,20 @@ This module requires nodejs v4 or above as it has dependencies on constious es6
     // set
     store.set("key", "value");
 
+#### API
+
+- RedisStore([options])
+
+#### `options` object properties
+
+| Property  | Default   | Description |
+|-----------|-----------|-------------|
+| name      | Random unique string | Name your pool |
+| redisOptions      | ```{url: redis://127.0.0.1:6379}```      | opts from  https://github.com/NodeRedis/node_redis#options-object-properties |
+| poolOptions      | null      | opts from https://github.com/coopernurse/node-pool#createpool |
+| logger       | null      | Inject your custom logger |
+
+
 ### Run tests
 
     bash test.sh

lib/logger.js

@@ -0,0 +1,12 @@
+module.exports = function (logger) {
+  if (!logger) {
+    logger = {};
+  }
+
+  return Object.assign({
+    log: function () {},
+    info: function () {},
+    warn: function () {},
+    error: function () {}
+  }, logger);
+};

lib/redis_store.js

@@ -2,68 +2,93 @@ const RedisPool = require("simple-redis-pool");
 
 const debug = require("debug")("simpleRedisStore");
 
-var RedisStore = module.exports = function (name, redisOptions, poolOptions) {
-
-  // set default pool options
-  poolOptions = Object.assign({
-    acquireTimeoutMillis: 50
-  }, poolOptions || {});
-
-  this.name = name;
-  this.redisOptions = redisOptions;
-  this.poolOptions = poolOptions;
-  this.pool = new RedisPool(name, redisOptions, poolOptions);
-  debug("Redis store created.", this.pool.status());
-
-  this.getName = this.pool.getName;
-  this.getRedisDB = this.pool.getRedisDB;
-  this.getPoolStatus = this.pool.status;
-};
 
-RedisStore.prototype.executeCmd = function (cmd) {
-  return this.pool.acquire()
-    .then(conn => cmd(conn)
-        .then(result => {
-          this.pool.release(conn);
-          return result;
-        })
-        .catch(err => {
-          this.pool.release(conn);
+const RedisStore = module.exports = function (options) {
+
+  this.name = options.name || `redisStore-${Math.random().toString(36).substr(2, 10)}`;
+  this.redisOptions = options.redisOptions;
+  this.poolOptions = Object.assign({
+    acquireTimeoutMillis: 200
+  }, options.poolOptions || {});
+  this.logger = require("./logger")(options.logger);
+
+  this.pool = null;
+  try {
+    this.pool = new RedisPool({
+      name: this.name,
+      redisOptions: this.redisOptions,
+      poolOptions: this.poolOptions,
+      logger: this.logger
+    });
+
+    this.ping()
+      .then(resp => {
+        if (resp === "PONG") {
+          debug("Redis store created.", this.pool.status());
+        } else {
+          debug("expected PONG but got", resp);
+          const err = new Error("UNKNOWN_PING_RESPONSE");
+          err.message = "expected PONG but got : " + resp;
           throw err;
-        }));
+        }
+      });
+
+  } catch (e) {
+    debug("Failed to create", e);
+    this.pool = null;
+    throw e;
+  }
+};
+
+
+RedisStore.prototype.getName = function () {
+  return this.pool.getName();
+};
+
+RedisStore.prototype.getRedisOptions = function () {
+  return this.pool.getRedisOptions();
+};
+
+RedisStore.prototype.getPoolOptions = function () {
+  return this.pool.getPoolOptions();
+};
+
+// verify if the connection is successful or not
+RedisStore.prototype.ping = function () {
+  return this.pool.sendCommand("ping");
 };
 
 RedisStore.prototype.get = function (key) {
-  return this.executeCmd(conn => conn.getAsync(key));
+  return this.pool.sendCommand("get", key);
 };
 
 RedisStore.prototype.set = function (key, value, ttlInSeconds) {
 
   if (ttlInSeconds) {
-    return this.executeCmd(conn => conn.setexAsync(key, ttlInSeconds, value));
+    return this.pool.sendCommand("setex", [key, ttlInSeconds, value]);
   } else {
-    return this.executeCmd(conn => conn.setAsync(key, value));
+    return this.pool.sendCommand("set", [key, value]);
   }
 };
 
 RedisStore.prototype.del = function (keys) {
-  return this.executeCmd(conn => conn.delAsync(keys));
+  return this.pool.sendCommand("del", keys);
 };
 
 RedisStore.prototype.expire = function (key, ttlInSeconds) {
-  return this.executeCmd(conn => conn.expireAsync(key, ttlInSeconds));
+  return this.pool.sendCommand("expire", [key, ttlInSeconds]);
 };
 
 RedisStore.prototype.ttlInSeconds = function (key) {
-  return this.executeCmd(conn => conn.ttlAsync(key));
+  return this.pool.sendCommand("ttl", key);
 };
 
 RedisStore.prototype.keys = function (pattern) {
   if (!pattern || pattern === "") {
     pattern = "*";
   }
 
-  return this.executeCmd(conn => conn.keysAsync(pattern));
+  return this.pool.sendCommand("keys", pattern);
 };
 
 RedisStore.prototype.deleteAll = function (pattern) {

package.json

@@ -33,16 +33,16 @@
     "coveralls": "npm run cover -- --report lcovonly && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"
   },
   "dependencies": {
-    "debug": "^2.2.0",
-    "simple-redis-pool": "^1.0.0"
+    "debug": "^2.3.3",
+    "simple-redis-pool": "^2.0.0"
   },
   "devDependencies": {
     "bluebird": "^3.4.6",
-    "coveralls": "^2.11.14",
-    "eslint": "^3.9.1",
+    "coveralls": "^2.11.15",
+    "eslint": "^3.11.0",
     "istanbul": "^0.4.5",
-    "mocha": "^3.1.0",
+    "mocha": "^3.2.0",
     "mocha-lcov-reporter": "^1.2.0",
-    "should": "^11.1.0"
+    "should": "^11.1.1"
   }
 }

test/redis_store.js

@@ -5,11 +5,12 @@ const RedisStore = require("../lib/redis_store");
 describe("redisStore", () => {
 
   const name = "testStore";
-  const redisOptions = Object.assign({
-    host: process.env.REDIS_HOST || "127.0.0.1"
-  });
 
-  const store = new RedisStore(name, redisOptions);
+  const store = new RedisStore({
+    name: name,
+    redisOptions: {
+      host: process.env.REDIS_HOST || "127.0.0.1"
+    }});
 
   describe("getName", () => {
     it("should return with given name", () => {