zn-router v0.1.0

zn-router

Routing for Zengine backend services (unofficial and experimental).

Install

$ npm install zn-router

Use

You could create a file where you register your routes, e.g. my-service-router.js

var znRouter = require('zn-router');

// Register routes

znRouter.get('/', function(request, response) {
  // ...
});

znRouter.get('/apples', function(request, response) {
  // ...
});

znRouter.post('/apples', function(request, response) {
  // ...
});

// This will be used by plugin.js
module.exports = znRouter.dispatch;

Every action is injected with request and response. Those are basically eventData.request and eventData.response.

Every action should return a promise. When the promise is resolved, znRouter will make your service respond. The response status and data is based on whether the promise was fulfilled or rejected.

To bind the router to your service, add this to your plugin.js

var dispatch = require('./src/my-service-router.js');

exports.run = function(eventData) {
  dispatch(eventData);
};

GET Requests

// GET: /workspaces/123/pluginNamespace/serviceName

znRouter.get('/', function(request, response) {

  var workspaceId = request.params.workspaceId;

  // getSomething should return a promise
  // If promise is fulfilled,
  // service will respond with status 200 and promise response as json response
  // If promise is rejected,
  // service will respond with status 500 (unless you specify otherwise – see below)
  return getSomething(workspaceId);

});

POST Requests

// POST: /workspaces/123/pluginNamespace/serviceName/webhooks

znRouter.post('/webhooks', function(request, response) {

	var body = request.body;
	var data = body.data[0];

	var activityId = data.id;
	var workspaceId = data.workspace.id;
	var webhookSecret = request.headers['x-zengine-webhook-key'];

	var info = {
		activityId: activityId,
		workspaceId: workspaceId,
		webhookSecret: webhookSecret
	};

	return processWebhook(info);
});

Error handling

For both get and post registration, you can catch errors before they are handled by znRouter.

znRouter.get('/apples', function(request, response) {

  var onError = function(err) {
  
    // You can catch specific errors and return a different status code and response
    if (err.message === 'SomeKnownError') {
      response.status(400).send({
        message: 'Bad Request'
      });
      // don't forget to return
      return;
    }
    
    // Unknown error: Re-throw, so znRouter handles that for you
    throw err;
  };

  return getApples().catch(onError);

});