model-redis 0.1.2 → 0.2.0

package/README.md

@@ -93,14 +93,13 @@ class User extends Table{
 		'updated_on': {default: function(){return (new Date).getTime()}, always: true},
 		'username': {isRequired: true, type: 'string', min: 3, max: 500},
 		'password': {isRequired: true, type: 'string', min: 3, max: 500},
-	}
+	};
 
 	static async add(data) {
 		try{
 			data['password'] = await bcrypt.hash(data['password'], saltRounds);
 
-			return await super.add(data)
-
+			return await super.add(data);
 		}catch(error){
 			throw error;
 		}
@@ -118,12 +117,11 @@ class User extends Table{
 
 	static async login(data){
 		try{
-
 			let user = await User.get(data);
 			let auth = await bcrypt.compare(data.password, user.password);
 
 			if(auth){
-				return user
+				return user;
 			}else{
 				throw new Error("LogginFailed");
 			}
@@ -142,13 +140,13 @@ module.exports = {User};
 The table schema a required aspect of using this module. The schema is defined
 with `_key`, `_indexed` and `_keyMap`
 
-`static _key` *string* is required and is basically the primary key for this
+* `static _key` *string* is required and is basically the primary key for this
 	table. It MUST match one of the keys in the `_keyMap` schema
 
-`static _indexed` *array* is optional list of keys to be indexed. Indexed keys
+* `static _indexed` *array* is optional list of keys to be indexed. Indexed keys
 can be searched by with the `list()` and `listDetial()` methods.
 
-`static _keyMap` *object* is required and defines the allowed schema for the
+* `static _keyMap` *object* is required and defines the allowed schema for the
 table. Validation will be enforced based on what is defined in the schema.
 
 The `_keyMap` schema is an object where the key is the name of the field and the
@@ -162,10 +160,12 @@ value is an object with the options for that field:
 
 * `type` *string* Required The native type this field will be checked for, valid
 	types are:
-		* `string`
-		* `number` 
-		* `boolean`
-		* `object`
+	
+	* `string`
+	* `number` 
+	* `boolean`
+	* `object`
+
 * `isRequired` *boolean* If this is set to true, this must be set when a new
 	entry is created. This has no effect on updates.
 * `default` *field type or function* if nothing is passed, this will be used be
@@ -174,6 +174,8 @@ value is an object with the options for that field:
 * `always` *boolean* If this is set, the `default` is set, then its value will
 	always be used when calling update. This is useful for setting an updated on
 	field or access count.
+* `min` *number* Used with *string* or *number* type to define the lower limit
+* `max` *number* Used with *string* or *number* type to define the max limit 
 
 Once we have defined a `_keyMap` schema, the table can be used.
 

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.2",
+  "version": "0.2.0",
   "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;