model-redis 0.1.3 → 0.2.1

package/README.md

@@ -1,23 +1,23 @@
 # Model Redis
 
-Simple ORM model for redis in NodsJS. The only external dependence is `redis`.
-This provides a simple ORM interface, with schema, for redis. This is not meant 
+Simple ORM model for Redis in NodsJS. The only external dependence is `redis`.
+This provides a simple ORM interface, with schema, for Redis. This is not meant 
 for large data sets and is geared more for small, internal infrastructure based
 projects that do not require complex data model.
 
 
 ## Getting started
 
-`setUpTable([object])` -- *Function* to bind the redis connection
+`setUpTable([object])` -- *Function* to bind the Redis connection
 	object to the ORM table. It takes an optional connected redis client object
-	or configuration for the redis module. This will return a `Table` class we
+	or configuration for the Redis module. This will return a `Table` class we
 	can use later for our model.
 
 It is recommend you place this in a utility or lib file with in your project
 and require it when needed.
 
 The simplest way to use this is to pass nothing to the `setUpTable` function.
-this will create a connected client to redis using the default settings:
+this will create a connected client to Redis using the default settings:
 
 ```javascript
 'use strict';
@@ -29,14 +29,14 @@ const Table = setUpTable();
 module.exports = Table;
 ```
 
-You can also pass your own configuration options to the redis client. See the
+You can also pass your own configuration options to the Redis client. See the
 redis [client configuration guide](https://github.com/redis/node-redis/blob/master/docs/client-configuration.md)
 for available options:
 
 ```javascript
 'use strict';
 
-const {setUpTable} = require('model-redis')
+const {setUpTable} = require('model-redis');
 
 const conf = {
 	socket: {
@@ -45,7 +45,7 @@ const conf = {
 	},
 	username: admin,
 	password: hunter42
-}
+};
 
 const Table = setUpTable({redisConf: conf});
 
@@ -53,12 +53,12 @@ module.exports = Table;
 ```
 
 It can also take a Redis client object, if you would like to have more control
-or use a custom version on redis.
+or use a custom version on Redis.
 
 ```javascript
 'use strict';
 
-const {setUpTable} = require('model-redis')
+const {setUpTable} = require('model-redis');
 
 const {createClient} = require('redis');
 const client = createClient();
@@ -70,6 +70,23 @@ module.exports = Table;
 
 ```
 
+### Prefix key
+
+At some point, the Redis package removed the option to prefix a string to the
+keys. This functionally has been added back with this package
+
+```javascript
+'use strict';
+
+const {setUpTable} = require('model-redis');
+
+const Table = setUpTable({
+	prefix: 'auth_app'
+});
+
+module.exports = Table;
+```
+
 Once we have have our table object, we can start building using the ORM!
 
 ## ORM API

package/index.js

@@ -15,7 +15,7 @@ function setUpTable(obj){
 
 	// test client connection
 	
-	return table(client);
+	return table(client, obj.prefix);
 }
 
 module.exports = {client, setUpTable};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "model-redis",
-  "version": "0.1.3",
+  "version": "0.2.1",
   "description": "Simple ORM model for redis in NodsJS",
   "main": "index.js",
   "scripts": {
@@ -22,6 +22,6 @@
   },
   "homepage": "https://github.com/wmantly/model-redis#readme",
   "dependencies": {
-    "redis": "^4.0.1"
+    "redis": "^4.6.10"
   }
 }

package/src/redis_model.js

@@ -3,7 +3,12 @@
 const objValidate = require('./object_validate');
 
 
-function setUpTable(client){
+
+function setUpTable(client, prefix=''){
+
+	function redisPrefix(key){
+		return `${prefix}${key}`;
+	}
 
 	class Table{
 		static _indexed = [];
@@ -21,7 +26,11 @@ function setUpTable(client){
 					index = index[this._key]
 				}
 
-				let result = await client.HGETALL(`${this.prototype.constructor.name}_${index}`);
+				console.log('get', redisPrefix(`${this.prototype.constructor.name}_${index}`))
+
+				let result = await client.HGETALL(
+					redisPrefix(`${this.prototype.constructor.name}_${index}`)
+				);
 
 				if(Object.keys(result).length === 0){
 					let error = new Error('EntryNotFound');
@@ -57,13 +66,21 @@ function setUpTable(client){
 			// return a list of all the index keys for this table.
 			try{
 
+
+				console.log('here')
+
 				if(index_key && !this._indexed.includes(index_key)) return [];
+				console.log('here2', redisPrefix(`${this.prototype.constructor.name}_${index_key}_${value}`))
 
 				if(index_key && this._indexed.includes(index_key)){
-					return await client.SMEMBERS(`${this.prototype.constructor.name}_${index_key}_${value}`);
+					return await client.SMEMBERS(
+						redisPrefix(`${this.prototype.constructor.name}_${index_key}_${value}`)
+					);
 				}
+				console.log('here3', redisPrefix(this.prototype.constructor.name))
 
-				return await client.SMEMBERS(this.prototype.constructor.name);
+				return await client.SMEMBERS(
+					redisPrefix(this.prototype.constructor.name));
 
 			}catch(error){
 				throw error;
@@ -99,19 +116,25 @@ function setUpTable(client){
 				}
 
 				// Add the key to the members for this redis table
-				await client.SADD(this.prototype.constructor.name, String(data[this._key]));
+				await client.SADD(
+					redisPrefix(this.prototype.constructor.name),
+					String(data[this._key])
+				);
 
 				// Create index keys lists
 				for(let index of this._indexed){
 					if(data[index]) await client.SADD(
-						`${this.prototype.constructor.name}_${index}_${data[index]}`,
+						redisPrefix(`${this.prototype.constructor.name}_${index}_${data[index]}`),
 						String(data[this._key]
 					));
 				}
 
 				// Add the values for this entry.
 				for(let key of Object.keys(data)){
-					await client.HSET(`${this.prototype.constructor.name}_${data[this._key]}`, key, objValidate.parseToString(data[key]));
+					await client.HSET(
+						redisPrefix(`${this.prototype.constructor.name}_${data[this._key]}`),
+						key, objValidate.parseToString(data[key])
+					);
 				}
 
 				// return the created redis entry as entry instance.
@@ -147,12 +170,12 @@ function setUpTable(client){
 					for(let index of this.constructor._indexed){
 						if(data[index]){
 							await client.SREM(
-								`${this.constructor.name}_${index}_${this[index]}`,
+								redisPrefix(`${this.constructor.name}_${index}_${this[index]}`),
 								String(this[this.constructor._key])
 							);
 
 							await client.SADD(
-								`${this.constructor.name}_${index}_${data[index]}`,
+								redisPrefix(`${this.constructor.name}_${index}_${data[index]}`),
 								String(data[this.constructor._key] || this[this.constructor._key])
 							);
 						}
@@ -161,7 +184,10 @@ function setUpTable(client){
 					// Loop over the data fields and apply them to redis
 					for(let key of Object.keys(data)){
 						this[key] = data[key];
-						await client.HSET(`${this.constructor.name}_${this[this.constructor._key]}`, key, data[key]);
+						await client.HSET(
+							redisPrefix(`${this.constructor.name}_${this[this.constructor._key]}`),
+							key, data[key]
+						);
 					}
 				}
 
@@ -179,14 +205,23 @@ function setUpTable(client){
 			try{
 				// Remove the index key from the tables members list.
 
-				await client.SREM(this.constructor.name, this[this.constructor._key]);
+				await client.SREM(
+					redisPrefix(this.constructor.name),
+					this[this.constructor._key]
+				);
 
 				for(let index of this.constructor._indexed){
-					await client.SREM(`${this.constructor.name}_${index}_${data[value]}`, data[this.constructor._key]);
+					await client.SREM(
+						redisPrefix(`${this.constructor.name}_${index}_${data[value]}`),
+						data[this.constructor._key]
+					);
 				}
 
 				// Remove the entries hash values.
-				let count = await client.DEL(`${this.constructor.name}_${this[this.constructor._key]}`);
+				let count = await client.DEL(
+					redisPrefix(
+						`${this.constructor.name}_${this[this.constructor._key]}`)
+					);
 
 				// Return the number of removed values to the caller.
 				return count;
@@ -195,8 +230,9 @@ function setUpTable(client){
 				throw error;
 			}
 		};
-
 	}
+
+	return Table;
 }
 
 module.exports = setUpTable;