boqs

A nice way to model data in redis. Pronounce "box".

Usage

Before we can store anything, we need to model our data. All we have to do is show boqs how to create an object:

var boqs = require('boqs')();

var User = boqs.construct('users', function (user) {
  return {
    username: String(user.username),
    password: String(user.password),
    age: Number(user.age)
  };
});

It's pretty much that easy all the time. Notice how we cast our parameters to the types we want. That's because of the way that redis stores data behind the scenes. This was also a design decision made to force your construct functions to explicitly state the structure of the model.

Of course, we could do something a little more fancy (like hashing the user's password), but just keep in mind that construct functions not only used for storing the data, they are also used when the data is pulled out.:

var User = boqs.construct('users', function (user) {

  if (user.salt) {
    // This user has already been created, so we'll just use the existing
    // password value
    return {
      username: String(user.username),
      password: String(user.password),
      salt: String(user.salt),
      age: Number(user.age)
    };
  } else {
    // This is a new user, let's give them a salt and hash the password
    var salt = generateSalt();
    return {
      username: String(user.username),
      password: String(user.password, salt),
      salt: String(salt),
      age: Number(user.age)
    };
  }

});

While this methodology works, and may be useful, it is not the prettiest solution in my opinion. I recommend keeping your construct functions simple, putting the more intense logic in other parts of your model, and then just calling it when you go to save the object.

Create

To create some new data, we just pass an object to our construct function and save it like so:

var user = new User({
  username: 'person',
  password: 'pass',
  age: 20
});
user.save(function (err, user) {
  if (err) throw err;
  console.log(user);
  //=> {id: 1, username: "person", password: "hashed", salt: "abc123", age: 20}
});

Read

To find an object by id:

User.find(1, function (err, user) {
  if (err) throw err;
  console.log(user);
  //=> {id: 1, username: "person", password: "hashed", salt: "abc123", age: 20}
});

To get all objects in a collection:

User.find(function (err, users) {
  if (err) throw err;
  console.log(users);
  //=> [{id: 1, username: "person", password: "hashed", salt: "abc123", age: 20}]
});

Update

A very simple update function:

User.update(1, {username: 'person2'}, function (err, user) {
  if (err) throw err;
  console.log(user);
  //=> {id: 1, username: "person2", password: "hashed", salt: "abc123", age: 20}
});

Delete

A simple delete call:

User.delete(1, function (err) {
  if (err) throw err;
  // user with id 1 deleted
});

License

The MIT License (MIT)

Copyright (c) 2015 Paul Dilyard

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.