Giter VIP home page Giter VIP logo

trooba-router's Introduction

trooba-router

codecov Build Status NPM Downloads Known Vulnerabilities

The module provides a generic router for Trooba framework

It is mostly based on very fast find-my-way router and adjusted to trooba pipeline API.

The router matching is based on the pipeline context information:

  • operation (optional) defines operation, which in http case it would be set to one of http methods (GET, POST, PUT, etc.)
  • path (required) defines a specific route

The above parameters are expected to be set by a transport to pipe.context to make sure router works correctly.

Install

$ npm install trooba-router -S

Usage

Http server

const Trooba = require('trooba');
const router = require('trooba-router');

Trooba
.use('http')
.use('trooba-router', {
    'GET /path/to/resource': pipe => {
        pipe.on('request', request => {
            pipe.respond({
                status: 200,
                body: 'hello world'
            });
        })
    },
    'GET /path/to/pipe': () => {
        return Trooba.use('handler1')
            .use('handler2')
            .use(pipe => {
                pipe.respond({
                    status: 200,
                    body: 'response from other pipe'
                });
            })
            .build();
    }
})

Routing service calls

One can also use router in non-service pipelines, for example, in service invocation pipelines. This can make invocation of multiple services starting from the same point and is based on some context to match the route.

const Trooba = require('trooba');
const router = require('trooba-router');

const pipe = Trooba
.use(router, {
    'OP1 /path/to/http': pipe => {
        return Trooba
            .use('handler1')
            .use('handler2')
            .use('http', {
                hostname: 'rest.service'
            })
            .build();
    },
    'OP2 /path/to/soap': pipe => {
        return Trooba
            .use('handler1')
            .use('handler2')
            .use('soap', {
                hostname: 'soap.service'
            })
            .build();
    }
})
.build();

Routing metadata

As a pipeline grows some modules may need to know the target route before it reaches the router pipe point. For example, one would like to attach metadata to the specific route that acts as a route configuration that some middleware/handler may use during their execution.

const Trooba = require('trooba');
const router = require('trooba-router');

Trooba
.use('http')
// will attach route information to pipe.context.$route
// and handler to pipe.context.$route.handler
.use('trooba-router/match', {
    'GET /path/to/resource': {
        handler: pipe => {
            pipe.on('request', request => {
                pipe.respond({
                    status: 200,
                    body: 'hello world'
                });
            })
        },
        securityPolicy: 'authenticate',
        validateRequest: true
    },
    'GET /path/to/pipe': {
        handler: () => {
            return Trooba.use('handler1')
                .use('handler2')
                .use(pipe => {
                    pipe.respond({
                        status: 200,
                        body: 'response from other pipe'
                    });
                })
                .build();
        },
        securityPolicy: 'none'
    }
})
.use('security')
.use('validation')
// will execute route handler attached to pipe.context.$route.handler
.use('trooba-router/execute');

trooba-router's People

Contributors

dimichgh avatar

Stargazers

Mukunda Modell avatar

Watchers

James Cloos avatar  avatar

trooba-router's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.