Merge pull request #1 from jkyberneees/supporting-accept-version-header

supporting routing versions

Author: jkyberneees

.travis.yml

@@ -0,0 +1,8 @@
+language: node_js
+node_js:
+  - "8"
+
+before_install:
+# package-lock.json was introduced in npm@5
+- '[[ $(node -v) =~ ^v9.*$ ]] || npm install -g npm@latest' # skipped when using node 9
+install: npm install

README.md

@@ -41,8 +41,8 @@ Execute middleware only if routing restrictions matches:
 const app = require('express')()
 app.use(middleware.iff([
   {
-      methods: ['POST', 'DELETE', 'PUT', 'PATCH'],
-      url: '/tasks/:id'
+    methods: ['POST', 'DELETE', 'PUT', 'PATCH'],
+    url: '/tasks/:id'
   }
 ]))
 
@@ -79,6 +79,10 @@ const iu = require('middleware-if-unless')(
   function(opts){}
 )
 ```
+### Known compatible routers:
+- https://www.npmjs.com/package/find-my-way
+- https://www.npmjs.com/package/anumargak
+
 ## iff / unless
 Both methods share the same configuration format:
 
@@ -105,4 +109,20 @@ middleware.unless({ endpoints: [
     url: '/tasks/:id/*'
   }
 ]})
-```
+```
+#### Supporting Accept-Version header
+Optionally, you can also restrict your middleware execution to specific versions using the `Accept-Version` header:
+> The `version` value should follow the [semver](https://semver.org/) specification.
+```js
+middleware.iff({ endpoints: [
+  {
+    methods: ['GET'],
+    url: '/tasks/:id',
+    version: '2.0.0'
+  }
+]})
+```
+In the example, a `GET /tasks/:id` request will only execute the middleware if the `Accept-Version` header matches `2.0.0`. For example:
+- Accept-Version=2.0.0
+- Accept-Version=2.x
+- Accept-Version=2.0.x

index.js

@@ -13,8 +13,12 @@ module.exports = function (routerOpts = {}, routerFactory) {
     const opts = typeof options === 'function' ? { custom: options } : (Array.isArray(options) ? { endpoints: options } : options)
     if (opts.endpoints && opts.endpoints.length) {
       // setup matching router
-      opts.endpoints.map(endpoint => typeof endpoint === 'string' ? { methods: ['GET'], url: endpoint } : endpoint).forEach(({ methods, url }) => {
-        router.on(methods, url, op)
+      opts.endpoints.map(endpoint => typeof endpoint === 'string' ? { methods: ['GET'], url: endpoint } : endpoint).forEach(({ methods, url, version }) => {
+        if (version) {
+          router.on(methods, url, { version }, op)
+        } else {
+          router.on(methods, url, op)
+        }
       })
     }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "middleware-if-unless",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Invokes connect-like middleware if / unless routing criteria matches. Inspired on express-unless module.",
   "main": "index.js",
   "scripts": {

tests.js

@@ -24,13 +24,23 @@ describe('middleware-if-unless', () => {
       .iff(req => req.url.startsWith('/pets'))
       .iff([
         '/pets/*',
-        '/pets/:id'
-      ]).unless([
+        '/pets/:id',
+        {
+          methods: ['GET'],
+          url: '/pets/:id',
+          version: '3.0.0'
+        }
+      ])
+      .unless([
         '/pets/groups/list',
         {
           url: '/pets/:id', methods: ['DELETE']
         }
-      ]).unless(req => req.url.endsWith('.js'))
+      ])
+      .unless(req => req.url.endsWith('.js'))
+      .unless([{
+        url: '/pets/:id', methods: ['GET'], version: '2.x'
+      }])
     )
 
     server = await service.start(~~process.env.PORT)
@@ -78,6 +88,24 @@ describe('middleware-if-unless', () => {
           expect(response.text).to.equal('')
         })
     })
+
+    it('should skip middleware on GET /pets/:id using accept-version 2.x', async () => {
+      await request(server)
+        .get('/pets/0')
+        .set('accept-version', '2.0.1')
+        .then((response) => {
+          expect(response.text).to.equal('')
+        })
+    })
+
+    it('should hit middleware on GET /pets/:id using accept-version 3.x', async () => {
+      await request(server)
+        .get('/pets/0')
+        .set('accept-version', '3.x')
+        .then((response) => {
+          expect(response.text).to.equal('hit')
+        })
+    })
   })
 
   it('should successfully terminate the service', async () => {