node package manager

level-restful

level-restful

A simple plug and play REST wrapper for leveldb, as a simple extension to level-orm

NPM

build status

Installation

This module is installed via npm:

$ npm install level-restful

Usage

Basic example

You extend the base class to give you REST post, put, delete, and get. You specify a list of fields to ensure validation of your object so the database stays safe from any pesky clients.

var http = require('http');
var level = require('level');
var db = level('/tmp/db', { valueEncoding: 'json' });
var RestModel = require('level-restful');
 
function Users(db) {
 
  var fields = [
    {
      'name': 'handle',
      'type': 'string'
    },
    {
      'name': 'email',
      'type': 'string',
      'index': true
    },
    {
      'name': 'address',
      'type': 'string'
    },
    {
      'name': 'age',
      'type': 'number',
      'optional': true
    }
  ];
 
  // users is the sublevel name to user 
  // handle is the primary key 
  RestModels.call(this, db, 'users', 'handle', fields);
}
 
// make it inherit from RestModel 
util.inherits(Users, RestModel);

Wire up your models to your server

The below example is just one of the many ways of wiring up your models to the server. Because this is a tool, not a framework, we leave it up to you to tailor it to your use case.

models = {
  'users': Users
};
 
var Router = require('routes-router');
var router = Router();
 
// Wire up API endpoints 
router.addRoute('/api/:model/:id?', function(req, res, opts) {
  var id = parseInt(opts.params.id) || opts.params.id || ''
  var model = models[opts.params.model]
  if (!model) {
    return cb(new Error('no model'))
  }
  model.dispatch(req, res, id, cb)
});
 
var server = http.createServer(router)''
server.listen(8000)''

note: this uses res.end() under the hood.

Auto incremented keys

You can use a keyfn to set auto incremented keys on your models. Do not put the key in your fields list, it will be generated upon save by eugeneware/level-orm.

var timestamp = require('monotonic-timestamp')
 
function Book(db) {
  fields = [
    {
      'name': 'owner_id',
      'type': 'number'
    },
    {
      'name': 'name',
      'type': 'string'
    }
  ];
  // Call the parent constructor. id is the primary key, but we 
  // don't have to define that in the object's schema. It'll be created 
  // automagically by level-orm when a keyfn is provided. (see below) 
  RestModels.call(this, db, 'book', 'id', fields);
}
 
// make it inherit from RestModels 
util.inherits(Book, RestModels);
 
// id is auto incremented by the unique timestamp. 
// could be more sophisticated. 
Book.prototype.keyfn = timestamp;

Secondary indexing

You can create a secondary index on any of your models by adding index: true to the validation schema

var timestamp = require('monotonic-timestamp')
 
function Book(db) {
  fields = [
    {
      'name': 'owner_id',
      'type': 'number'
    },
    {
      'name': 'author',
      'type': 'string'
    }
    {
      'name': 'name',
      'type': 'string',
      'index': true
    }
  ];
  RestModels.call(this, db, 'book', 'id', fields);
}

Now, a REST consumer can call the api to filter on one of the indexed fields. NOTE, at this time you can only filter on one field.

$ curl 'http://localhost:8000/api/book?name=Moby%20Dick'
{
  'owner_id': 4,
  'author': 'Mark Twain',
  'name': 'Moby Dick'
}

Compound Keys and Shared Containers

This library extends from eugeneware/level-orm, which has examples of Compound Keys and Shared Containers.

License

Copyright (c) 2014, Karissa McKelvey All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.