nodetoo

Express + MVC = {nodetoo}

npm install nodetoo
16 downloads in the last week
32 downloads in the last month

{nodetoo}

Inspired by Express mvc example, nodetoo is a MVC framework built on top of Express.

Installation

$ npm install -g nodetoo

Quick Start

Assuming you have created a project with Express, please refer here for the guide.

  • Create the app
$ cd /project
$ npm install nodetoo
$ nodetoo
  • Bootstrap nodetoo:
var express = require('express');
var nodetoo = require('nodetoo');
var app = express();

app.configure(function(){
  ...

  // boostrap nodetoo
  nodetoo.bootstrap(app);

  app.use(app.router);
  ...
});

// remove any existing route
...

app.listen(3000);
  • Start the server:
$ node app

Project Structure

nodetoo only work on the app/ and config/ folder

app/
  controllers/
    home/
      index.js
  models/
      user.js
  views/
    home/
      index.jade
config/
    injections/
    plugins/
    routes.js
    setting.js

Models

Each js file under models/ is a model, nodetoo will bootstrap all of them automatically.

models/
  user.js
  post.js
  comment.js

Controllers

Each folder under controllers/ is a controller, index.js represent the js file.
Let's take a look at the controllers/home/index.js file.

exports.actions = {

  index: function (req, res) {
    res.render('home/index');
  },

  about: function (req, res) {
    res.render('home/about');
  },
}

Filters are middlewares that run before the action function.

Exports as a function before.

exports.before = function (req, res, next) {

  console.log('[BEFORE]: ' + req.url);
  next();
}

exports.actions = {

  index: function (req, res) {
    res.render('home/index');
  }
}

Exports as an object before, support injection.

exports.before = {

  all: [
    {
      middlewares: ['logger'],
      except: ['login']
    }
  ],
  only: [
    { 
      middlewares: ['watcher'],
      actions: ['login']
    }
  ]
};
All actions will use `logger` except `login` action.
Only `login` action will use `watcher`.

Define at action and it will be given priority.

exports.actions = {

  index: {
    before: ['watcher', 'logger'],
    action: function (req, res) {
      res.render('home/index');
    }
  }
}

Here is the injections

config/
    injections/
        logger.js
        watcher.js

Roles are use in Authentication process.

Exports as an object roles.

exports.roles = {

  all: [
    {
      roles: ['*'],
      except: ['login']
    }
  ],
  only: [
    {
      roles: ['user'],
      actions: ['createUser']
    },
    {
      roles: ['admin'],
      actions: ['createUser']
    },
  ]
};
All actions has role `*` except `login` action.
Only `createUser` action has role `user`.
Only `createUser` action has role `admin`.

PS: Role * apply to any roles, but it depend on how you write the authenticator.

Define at action and it will be given priority.

exports.actions = {

  index: {
    roles: ['*'],
    action: function (req, res) {
      res.render('home/index');
    }
  }
}

Actions

Action is a controller method and represent as [controller].[method].

home.index
home.about

Routes

Routes are defined in the config/routes.js file

module.exports = [
    ['/'                        ,'get'  ,'home.index']
  , ['/about'                   ,'get'  ,'home.about']
]

Authentication

When roles is configured, {nodetoo} will ask for an authenticator via injection.

config/
    injections/
        authenticator.js
module.exports = function(roles) {
  return function (req, res, next) {
    // retrieve user from session
    var user = req.session.user;
    if (user === undefined) {
      res.status(401).render('401');
    } 
    // asterisk skip authorization
    else if (!_.contains(roles, '*') 
          && !_.intersection(user.roles, roles).length > 0) {
      res.status(401).render('401');
    } else next();
  }
}

But how you write the authenticator, it is really up to you. Please refer to the example.

Injections

Any module under injections/ folder can be inject with the module filename without the extension.

config/
    injections/
        module.js
var module = inject('module');

PS: Actually nothing special with the injection, it is just a global function as require.

Examples

Clone the nodetoo repo, then install the dev dependencies:

$ git clone git://github.com/fliptoo/nodetoo.git --depth 1
$ cd nodetoo
$ npm install

and run whichever examples you want:

$ cd examples/basic
$ node app

Credits

License

(The MIT License)

Copyright (c) 2013 Fliptoo <fliptoo.studio@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.

npm loves you