urlEncodePathParser

README.md

@@ -586,6 +586,7 @@ Currently available middlewares:
 - [`http-partial-response`](/packages/http-partial-response): Filter response objects attributes based on query string parameters.
 - [`http-security-headers`](/packages/http-security-headers): Applies best practice security headers to responses. It's a simplified port of HelmetJS.
 - [`http-urlencode-body-parser`](/packages/http-urlencode-body-parser): Automatically parses HTTP requests with URL encoded body (typically the result of a form submit).
+- [`http-urlencode-path-parser`](/packages/http-urlencode-path-parser): Automatically parses HTTP requests with URL encoded path.
 - [`s3-key-normalizer`](/packages/s3-key-normalizer): Normalizes key names in s3 events.
 - [`secrets-manager`](/packages/secrets-manager): Fetches parameters from [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html).
 - [`ssm`](/packages/ssm): Fetches parameters from [AWS Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html).

packages/http-urlencode-path-parser/README.md

@@ -0,0 +1,92 @@
+# Middy http-urlencode-body-parser middleware
+
+<div align="center">
+  <img alt="Middy logo" src="https://github.com/middyjs/middy/master/img/middy-logo.png"/>
+</div>
+
+<div align="center">
+  <p><strong>HTTP URLencode body parser middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
+</div>
+
+<div align="center">
+<p>
+  <a href="http://badge.fury.io/js/%40middy%2Fhttp-urlencode-path-parser">
+    <img src="https://badge.fury.io/js/%40middy%2Fhttp-urlencode-path-parser.svg" alt="npm version" style="max-width:100%;">
+  </a>
+  <a href="https://snyk.io/test/github/middyjs/middy">
+    <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
+  </a>
+  <a href="https://standardjs.com/">
+    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  </a>
+  <a href="https://greenkeeper.io/">
+    <img src="https://badges.greenkeeper.io/middyjs/middy.svg" alt="Greenkeeper badge"  style="max-width:100%;">
+  </a>
+  <a href="https://gitter.im/middyjs/Lobby">
+    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter"  style="max-width:100%;">
+  </a>
+</p>
+</div>
+
+This middleware automatically parses HTTP requests with URL-encoded paths. This can happen when using path variables (ie `/{name}/`) for an endpoint and the UI `encodeURIComponent` the values before making the request.
+
+
+## Install
+
+To install this middleware you can use NPM:
+
+```bash
+npm install --save @middy/http-urlencode-path-parser
+```
+
+
+## Options
+
+None
+
+
+## Sample usage
+
+```javascript
+const middy = require('@middy/core')
+const httpUrlEncodePathParser = require('@middy/http-urlencode-path-parser')
+
+const handler = middy((event, context, cb) => {
+  cb(null, event.body) // propagates the body as response
+})
+
+handler.use(httpUrlEncodePathParser({extended: false}))
+
+// When Lambda runs the handler with a sample event...
+const event = {
+
+  pathParameters: {
+    name: encodeURIComponent('Mîddy')
+  }
+}
+
+handler(event, {}, (_, body) => {
+  expect(body).toEqual({
+    name: 'Mîddy'
+  })
+})
+```
+
+
+## Middy documentation and examples
+
+For more documentation and examples, refers to the main [Middy monorepo on GitHub](https://github.com/middyjs/middy) or [Middy official website](https://middy.js.org).
+
+
+## Contributing
+
+Everyone is very welcome to contribute to this repository. Feel free to [raise issues](https://github.com/middyjs/middy/issues) or to [submit Pull Requests](https://github.com/middyjs/middy/pulls).
+
+
+## License
+
+Licensed under [MIT License](LICENSE). Copyright (c) 2017-2018 Luciano Mammino and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
+
+<a href="https://app.fossa.io/projects/git%2Bgithub.51.al%2Fmiddyjs%2Fmiddy?ref=badge_large">
+  <img src="https://app.fossa.io/api/projects/git%2Bgithub.51.al%2Fmiddyjs%2Fmiddy.svg?type=large" alt="FOSSA Status"  style="max-width:100%;">
+</a>

packages/http-urlencode-path-parser/__tests__/index.js

@@ -0,0 +1,25 @@
+const middy = require('../../core')
+const urlEncodePathParser = require('../')
+
+describe('📦 Middleware URL Encoded Path Parser', () => {
+  test('It should decode simple url encoded requests', () => {
+    const handler = middy((event, context, cb) => {
+      cb(null, event.pathParameters) // propagates the body as response
+    })
+
+    handler.use(urlEncodePathParser())
+
+    // invokes the handler
+    const event = {
+      pathParameters: {
+        char: encodeURIComponent('Mîddy')
+      }
+    }
+
+    handler(event, {}, (_, body) => {
+      expect(body).toEqual({
+        char: 'Mîddy'
+      })
+    })
+  })
+})

packages/http-urlencode-path-parser/index.d.ts

@@ -0,0 +1,5 @@
+import middy from '../core'
+
+declare function urlEncodePathParser(): middy.IMiddyMiddlewareObject;
+
+export default urlEncodePathParser

packages/http-urlencode-path-parser/index.js

@@ -0,0 +1,15 @@
+module.exports = () => ({
+  before: (handler, next) => {
+    if (handler.event.pathParameters) {
+      for (let key in handler.event.pathParameters) {
+        try {
+          handler.event.pathParameters[key] = decodeURIComponent(handler.event.pathParameters[key])
+        } catch (e) {
+          console.error(e)
+        }
+      }
+    }
+
+    next()
+  }
+})