mortimer = MOngoose ResT

Gist

Mortimer is an extendible REST interface for mongoose models, designed for the entire project lifecycle: from fast prototyping to advanced custom functionality.

Status

Indicator
documentation	topliceanu.github.io/mortimer hosted on coffedoc.info
continuous integration
dependency management
code coverage
examples	/examples
development management
change log	CHANGELOG Releases

Features

• Focus on extensibility. Fully plugable!
• Does not depend on mongoose or express packages. It just builds arrays of middleware functions.
• Easy to bootstrap a basic REST API for your models.
• Supports filtering, pagination, sorting, property selection.

Install

npm install mortimer

Quick Example

var bodyParser = require('body-parser');
var express = require('express');
var mongoose = require('mongoose');
var mortimer = require('mortimer');
 
 
// Handle connection to mongodb and data modeling.
mongoose.connect('mongodb://localhost:27017/examples');
 
var BookSchema = new mongoose.Schema({
    'title': {type: String},
    'author': {type: String}
});
 
var Book = mongoose.model('Book', BookSchema);
 
 
// Setup http server with express.
var app = express();
app.set('query parser', 'simple');
app.use(bodyParser.json());
 
 
// Setup mortimer endpoints.
var resource = new mortimer.Resource(Book);
app.post('/books', resource.createDoc());
app.get('/books', resource.readDocs());
app.get('/books/count', resource.countDocs());
app.patch('/books', resource.patchDocs());
app.delete('/books', resource.removeDocs());
app.get('/books/:bookId', resource.readDoc());
app.patch('/books/:bookId', resource.patchDoc());
app.put('/books/:bookId', resource.putDoc());
app.delete('/books/:bookId', resource.removeDoc());
 
 
// Start the http server on http://localhost:3000/
app.listen(3000, 'localhost');

More Examples

See more in the /examples directory. All examples have instructions on how to run and test them.

• if you want to quickly bootstrap a rest api, check out this example. You can rapidly define your own routes and let mortimer handle the requests.
• if you want to add middleware in front of every endpoint, check out this example. This can be usefull to add authentication, rate limiting, payload validation, output sanitation, etc. Mortimer is a backbone for all that.
• if you want to add custom functionality to just one middleware, check out this example

Contributing

1. Contributions to this project are more than welcomed!
   • Anything from improving docs, code cleanup to advanced functionality is greatly appreciated.
   • Before you start working on an ideea, please open an issue and describe in detail what you want to do and why it's important.
   • You will get an answer in max 12h depending on your timezone.
2. Fork the repo!
3. If you use vagrant then simply clone the repo into a folder then issue $ vagrant up
   • if you don't use it, please consider learning it, it's easy to install and to get started with.
   • If you don't use it, then you have to:
     • install mongodb and have it running on localhost:27017.
     • install node.js and all node packages required in development using $ npm install
     • For reference, see ./vagrant_boostrap.sh for instructions on how to setup all dependencies on a fresh ubuntu 14.04 machine.
   • Run the tests to make sure you have a correct setup: $ npm run test
4. Create a new branch and implement your feature.

• make sure you add tests for your feature. In the end all tests have to pass! To run test suite $ npm run test.
• make sure test coverage does not decrease. Run $ npm run coverage to open a browser window with the coverage report.
• make sure you document your code and generated code looks ok. Run $ npm run doc to re-generate the documentation.
• make sure code is linted (and tests too). Run $ npm run lint
• submit a pull request with your code.
• hit me up for a code review!

1. Have my kindest thanks for making this project better!

Licence

(The MIT License)

Copyright (c) Alexandru Topliceanu (alexandru.topliceanu@gmail.com)

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.