Merge pull request #13 from jkyberneees/allow-router-override

Allow router override (v2.7.0)

README.md

@@ -32,6 +32,7 @@ const service = require('restana')({
 
 ### Configuration
 - `server`: Allows to override the HTTP server instance to be used.
+- `routerFactory`: Router factory function to allow default `find-my-way` router override. 
 - `prioRequestsProcessing`: If `TRUE`, HTTP requests processing/handling is prioritized using `setImmediate`. Default value: `TRUE`
 - `ignoreTrailingSlash`: If `TRUE`, trailing slashes on routes are ignored. Default value: `FALSE`
 - `allowUnsafeRegex`: If `TRUE`, potentially catastrophic exponential-time regular expressions are disabled. Default value: `FALSE`
@@ -45,7 +46,19 @@ const service = require('restana')({
 });
 ```
 
-### Creating the micro-service interface
+#### Providing a router factory method:
+> In this example we use `anumargak` router instead of `find-my-way`.
+```js 
+const anumargak = require('anumargak')
+const service = require('restana')({
+  routerFactory: (options) => {
+    return anumargak(options)
+  }
+})
+...
+```
+
+### Creating a micro-service
 ```js
 const bodyParser = require('body-parser');
 service.use(bodyParser.json());
@@ -86,12 +99,12 @@ Supported HTTP methods:
 const methods = ['get', 'delete', 'put', 'patch', 'post', 'head', 'options', 'trace'];
 ```
 
-### Starting the service
+#### Starting the service
 ```js
 service.start(3000).then((server) => {});
 ```
 
-### Stopping the service
+#### Stopping the service
 ```js
 service.close().then(()=> {});
 ```

demos/router-factory.js

@@ -0,0 +1,13 @@
+const anumargak = require('anumargak')
+
+const service = require('./../index')({
+  routerFactory: (options) => {
+    console.log('creating anumargak router...')
+    return anumargak(options)
+  }
+})
+
+service.get('/hi', (req, res) => {
+  res.send('Hello World!')
+})
+service.start()

index.js

@@ -49,8 +49,8 @@ module.exports = (options = {}) => {
     })
   }
 
-  // creating request router instance
-  const router = requestRouter(options)
+  // creating request router instance, considers custom router override
+  const router = options.routerFactory ? options.routerFactory(options) : requestRouter(options)
   // routes holder
   const routes = {}
   // global middlewares holder

package.json

@@ -1,6 +1,6 @@
 {
   "name": "restana",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "Super fast and minimalist web framework for building REST micro-services.",
   "main": "index.js",
   "scripts": {
@@ -37,6 +37,7 @@
     "find-my-way": "^1.17.0"
   },
   "devDependencies": {
+    "anumargak": "^2.0.2",
     "chai": "^4.2.0",
     "express": "^4.16.4",
     "fastify": "^1.13.3",

specs/router-factory.test.js

@@ -0,0 +1,31 @@
+/* global describe, it */
+const request = require('supertest')
+
+describe('Router Factory - overriding find-my-way router with "anumargak"', () => {
+  let server
+  const anumargak = require('anumargak')
+
+  const service = require('../index')({
+    routerFactory: (options) => {
+      console.log('creating anumargak router...')
+      return anumargak(options)
+    }
+  })
+  service.get('/hello', (req, res) => {
+    res.send(200)
+  })
+
+  it('should start the service with "anumargak" router', async () => {
+    server = await service.start(~~process.env.PORT)
+  })
+
+  it('should GET 200 on /hello', async () => {
+    await request(server)
+      .get('/hello')
+      .expect(200)
+  })
+
+  it('should successfully terminate the service', async () => {
+    await service.close()
+  })
+})