JSPM

#### Directory based autoloader for hapi.js routes

1. Introduction
2. Installation
3. Usage
4. Example
5. Testing
6. Contribution
7. Next Steps
8. License

Introduction

wurst is a directory based autoloader for hapi.js routes. Just set up your desired directory structure, export your route files, register the plugin and get your final prefixed routes based on the provided directory structure. For example it is perfect for manage the various versions of your API. wurst is the German translation for sausage - just throw anything in a pot and in the end you'll be satisfied ;-)

This plugin is implemented in ECMAScript 6. Therefore the development dependencies are based on babel. Additionally eslint and mocha are used to grant a high quality implementation.

Installation

For installation use the Node Package Manager:

// production version with ES5 syntax
$ npm install --save wurst

or clone the repository:

// development version with ES6 syntax
$ git clone https://github.com/felixheck/wurst

Usage

Import

First you have to import the module:

const wurst = require('wurst');

Create hapi server

Afterwards create your hapi server and the corresponding connection if not already done:

const server = new Hapi.Server();

server.connection({
  port: 8888,
  host: 'localhost',
});

Registration

Finally register the plugin and set the correct options:

server.register({
  register: wurst,
  options: {
    routes: path.join(__dirname, 'routes'),
    ignore: 'foo/**/*.js',
    log: true
  },
}, function(err) {
  if (err) {
    throw err;
  }
});

It is possible to register the plugin many times, but it is suggested to use options.routes which are not nested in each other.

Options

routes: string
Optional. Default: __dirname
The absolute path to the routes directory.

ignore: string | Array.<?string>
Optional
The glob pattern or an array of patterns to exclude route files.

log: boolean
Optional. Default: false
If true, the plugins logs the prefixed routes into console.
For example:

Wurst prefixed the following routes
  [GET]   /foo/bar/foobar
  [POST]  /foo/foo

Example

The following file structure is the base of this example:

src/
..routes/
....routes.js
....bar/
......routes.js
......foo/
........routes.js
..index.js

The route files **/routes.js have to provide a single route object or a list of route objects via module.exports and could look like:

const routes = [
  {
    method: 'GET',
    path: '/',
    handler(request, reply) {
        reply('foo');
    }
  },
  {
    method: 'GET',
    path: '/42',
    handler(request, reply) {
        reply('42');
    }
  }
];

module.exports = routes;

After starting the server the following routes are available. Trailing slashes - excepted at / - will be removed automatically.

[GET] /
[GET] /42

[GET] /bar
[GET] /bar/42

[GET] /bar/foo
[GET] /bar/foo/42

Testing

First you have to install all dependencies:

$ npm install

To execute all unit tests once, use:

$ npm test

or to run tests based on file watcher, use:

$ npm start

To get information about the test coverage, use:

$ npm run coverage

Contribution

Fork this repository and push in your ideas.

Do not forget to add corresponding tests to keep up 100% test coverage.

Next Steps

License

The MIT License

Copyright (c) 2016 Felix Heck

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.