node package manager
Loosely couple your services. Use Orgs to version and reuse your code. Create a free org »

rest-parser

rest-parser

A request parser that enforces REST style for any db model. Simply implement the required methods for the underlying object. The model object only needs to implement the methods .post, .get, .put, and .delete.

NPM

build status

Why?

We want to separate the request and authentication handlers from the database model code. This makes it easy to change backends without having to change your http routes. It's also great for exposing the same API over http for all of your database models without extra code.

Installation

This module is installed via npm:

$ npm install rest-parser

Usage

Example database connection object that uses simple in-memory dictionaries for application storage.

function Book(key) {
  this.db = {}
  this.key = key
}
 
Book.prototype.post = function (data, opts, cb) {
  if(!data) {
    return cb('Need values to save')
  }
  var key = data[this.key]
  this.db[key] = data
  return cb(null, key)
}
 
Book.prototype.get = function (opts, cb){
  if(!opts.id) {
    var values = []
    for (id in this.db) {
      values.push(this.db[id])
    }
    return cb(null, values)
  }
  var val = this.db[opts.id]
  if (!val) {
    return cb('NotFound')
  }
  return cb(null, this.db[opts.id])
}
 
Book.prototype.put = function (data, opts, cb) {
  if(!opts.id) {
    return cb('Need a opts.id')
  }
  this.db[opts.id] = data
  return cb(null, opts.id)
}
 
 
Book.prototype.delete = function (opts, cb) {
  if(!opts.id) {
    return cb('Need a opts.id')
  }
  delete this.db[opts.id]
  return cb(null)
}
 

Create a server

var RestParser = require('rest-parser')
var Book = require('./book.js')
 
// make the book model 
var bookDB = new Book()
var REST = new RestParser(bookDB)
 
// Wire up API endpoints 
router.addRoute('/api/book/:id?', function(req, res, opts) {
    var id = parseInt(opts.params.id) || opts.params.id
    REST.dispatch(req, { id: id }, function (err, data) {
      res.end(JSON.stringify(data))
    })
  })
})
 
var server = http.createServer(router)
server.listen(8000)

The server will now have these routes available:

GET /book
GET /book/:id
POST /book
PUT /book/:id
DELETE /book/:id

Advanced: auth, custom routes

Sometimes, you want control over the individual routes to expose only a subset, to require authentication, or some other query logic. It's easy to do with rest-parser -- just use the underlying handler methods:

var RestParser = require('rest-parser')
var Book = require('./book.js')
 
// make the book model 
var bookDB = new Book()
var REST = new RestParser(book)
 
// Wire up API endpoints 
router.addRoute({
  GET: '/api/book/:id', function(req, res, opts) {
    var id = parseInt(opts.params.id) || opts.params.id
    REST.get(req, { id: id }, function (err, data) {
      res.end(JSON.stringify(data))
    })
  }),
  POST: '/api/book/:id', function(req, res, opts) {
    var id = parseInt(opts.params.id) || opts.params.id
    if (!req.userid) {
      res.statusCode = 401
      res.end('Unauthorized!')
      return
    }
 
    REST.post(req, { id: id }, function (err, data) {
      res.end(JSON.stringify(data))
    })
  })
})
 
var server = http.createServer(router)
server.listen(8000)

API

RestParser(model)

Instantiates the parser with a given model.

The model object should have the following method signature:

  • model#put(data, opts, cb)
  • model#post(data, opts, cb)
  • model#delete(opts, cb)
  • model#get(opts, cb)

The parser will take the request object and route to the corresponding model method.

RestParser#post(req, opts, cb)

Does not enforce an id -- it is assumed that the id will be generated upon creation or otherwise will be handled by the model.

RestParser#put(req, opts, cb)

Parses the request body using getBodyData and passes to model.put.

RestParser#delete(req, opts, cb)

Passes to model.delete.

RestParser#get(req, opts, cb)

Passes to model.get

RestParser#dispatch(req, opts, cb)

This parses the req.method to dispatch appropriately to one of the above methods.

Examples

Create a new book

$ curl -x POST 'http://localhost:8000/api/book' -d {'author': 'Mark Twain', 'name': 'N/A'}
1

Update a book

$ curl -x PUT 'http://localhost:8000/api/book/1' -d {'author': 'Mark Twain', 'name': 'Life on the Mississippi'}
1

Get all books

$ curl 'http://localhost:8000/api/book'
[
  {
    'id': 1,
    'author': 'Mark Twain',
    'name': 'Life on the Mississippi'
  },
  etc...
]

Get a single book

$ curl 'http://localhost:8000/api/book/1'
{
  'id': 1,
  'author': 'Mark Twain',
  'name': 'Life on the Mississippi'
}

Delete a book

$ curl -x DELETE 'http://localhost:8000/api/book/1'

Get all books (none remain)

$ curl 'http://localhost:8000/api/book'
[]

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.