feat(targets) Powershell's RestMethod support (Kong#133)

* feat(target) support for powershell's invoke-restmethod

* test(target) Powershell output tests
* test(target) updated available-targets test
* test(powershell) updated fixtures

Author: karol-maciaszek

src/targets/powershell/common.js

@@ -0,0 +1,54 @@
+'use strict'
+
+var CodeBuilder = require('../../helpers/code-builder')
+
+module.exports = function (command) {
+  return function (source, options) {
+    var code = new CodeBuilder()
+    var methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS']
+
+    if (methods.indexOf(source.method.toUpperCase()) === -1) {
+      return 'Method not supported'
+    }
+
+    var commandOptions = []
+
+    // Add headers, including the cookies
+    var headers = Object.keys(source.headersObj)
+
+    // construct headers
+    if (headers.length) {
+      code.push('$headers=@{}')
+      headers.forEach(function (key) {
+        if (key !== 'connection') { // Not allowed
+          code.push('$headers.Add("%s", "%s")', key, source.headersObj[key])
+        }
+      })
+      commandOptions.push('-Headers $headers')
+    }
+
+    // construct cookies
+    if (source.cookies.length) {
+      code.push('$session = New-Object Microsoft.PowerShell.Commands.WebRequestSession')
+
+      source.cookies.forEach(function (cookie) {
+        code.push('$cookie = New-Object System.Net.Cookie')
+
+        code.push("$cookie.Name = '%s'", cookie.name)
+        code.push("$cookie.Value = '%s'", cookie.value)
+        code.push("$cookie.Domain = '%s'", source.uriObj.host)
+
+        code.push('$session.Cookies.Add($cookie)')
+      })
+      commandOptions.push('-WebSession $session')
+    }
+
+    if (source.postData.text) {
+      commandOptions.push("-ContentType '" + source.allHeaders['content-type'] + "'")
+      commandOptions.push("-Body '" + source.postData.text + "'")
+    }
+
+    code.push("$response = %s -Uri '%s' -Method %s %s", command, source.fullUrl, source.method, commandOptions.join(' '))
+    return code.join()
+  }
+}

src/targets/powershell/index.js

@@ -8,5 +8,6 @@ module.exports = {
     default: 'webrequest'
   },
 
-  webrequest: require('./webrequest')
+  webrequest: require('./webrequest'),
+  restmethod: require('./restmethod')
 }

src/targets/powershell/restmethod.js

@@ -0,0 +1,10 @@
+'use strict'
+
+module.exports = require('./common')('Invoke-RestMethod')
+
+module.exports.info = {
+  key: 'restmethod',
+  title: 'Invoke-RestMethod',
+  link: 'https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-RestMethod',
+  description: 'Powershell Invoke-RestMethod client'
+}

src/targets/powershell/webrequest.js

@@ -1,55 +1,6 @@
 'use strict'
 
-var CodeBuilder = require('../../helpers/code-builder')
-
-module.exports = function (source, options) {
-  var code = new CodeBuilder()
-  var methods = [ 'GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS' ]
-
-  if (methods.indexOf(source.method.toUpperCase()) === -1) {
-    return 'Method not supported'
-  }
-
-  var commandOptions = []
-
-  // Add headers, including the cookies
-  var headers = Object.keys(source.headersObj)
-
-  // construct headers
-  if (headers.length) {
-    code.push('$headers=@{}')
-    headers.forEach(function (key) {
-      if (key !== 'connection') { // Not allowed
-        code.push('$headers.Add("%s", "%s")', key, source.headersObj[key])
-      }
-    })
-    commandOptions.push('-Headers $headers')
-  }
-
-  // construct cookies
-  if (source.cookies.length) {
-    code.push('$session = New-Object Microsoft.PowerShell.Commands.WebRequestSession')
-
-    source.cookies.forEach(function (cookie) {
-      code.push('$cookie = New-Object System.Net.Cookie')
-
-      code.push("$cookie.Name = '%s'", cookie.name)
-      code.push("$cookie.Value = '%s'", cookie.value)
-      code.push("$cookie.Domain = '%s'", source.uriObj.host)
-
-      code.push('$session.Cookies.Add($cookie)')
-    })
-    commandOptions.push('-WebSession $session')
-  }
-
-  if (source.postData.text) {
-    commandOptions.push("-ContentType '" + source.allHeaders['content-type'] + "'")
-    commandOptions.push("-Body '" + source.postData.text + "'")
-  }
-
-  code.push("$response = Invoke-WebRequest -Uri '%s' -Method %s %s", source.fullUrl, source.method, commandOptions.join(' '))
-  return code.join()
-}
+module.exports = require('./common')('Invoke-WebRequest')
 
 module.exports.info = {
   key: 'webrequest',

test/fixtures/available-targets.json

@@ -260,6 +260,12 @@
         "key": "webrequest",
         "link": "https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-WebRequest",
         "title": "Invoke-WebRequest"
+      },
+      {
+        "description": "Powershell Invoke-RestMethod client",
+        "key": "restmethod",
+        "link": "https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-RestMethod",
+        "title": "Invoke-RestMethod"
       }
     ]
   }

test/fixtures/output/powershell/restmethod/application-form-encoded.ps1

@@ -0,0 +1,3 @@
+$headers=@{}
+$headers.Add("content-type", "application/x-www-form-urlencoded")
+$response = Invoke-RestMethod -Uri 'http://mockbin.com/har' -Method POST -Headers $headers -ContentType 'application/x-www-form-urlencoded' -Body 'foo=bar&hello=world'

test/fixtures/output/powershell/restmethod/application-json.ps1

@@ -0,0 +1,3 @@
+$headers=@{}
+$headers.Add("content-type", "application/json")
+$response = Invoke-RestMethod -Uri 'http://mockbin.com/har' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"number":1,"string":"f\"oo","arr":[1,2,3],"nested":{"a":"b"},"arr_mix":[1,"a",{"arr_mix_nested":{}}],"boolean":false}'

test/fixtures/output/powershell/restmethod/cookies.ps1

@@ -0,0 +1,12 @@
+$session = New-Object Microsoft.PowerShell.Commands.WebRequestSession
+$cookie = New-Object System.Net.Cookie
+$cookie.Name = 'foo'
+$cookie.Value = 'bar'
+$cookie.Domain = 'mockbin.com'
+$session.Cookies.Add($cookie)
+$cookie = New-Object System.Net.Cookie
+$cookie.Name = 'bar'
+$cookie.Value = 'baz'
+$cookie.Domain = 'mockbin.com'
+$session.Cookies.Add($cookie)
+$response = Invoke-RestMethod -Uri 'http://mockbin.com/har' -Method POST -WebSession $session

test/fixtures/output/powershell/restmethod/custom-method.ps1

@@ -0,0 +1 @@
+Method not supported

test/fixtures/output/powershell/restmethod/full.ps1

@@ -0,0 +1,15 @@
+$headers=@{}
+$headers.Add("accept", "application/json")
+$headers.Add("content-type", "application/x-www-form-urlencoded")
+$session = New-Object Microsoft.PowerShell.Commands.WebRequestSession
+$cookie = New-Object System.Net.Cookie
+$cookie.Name = 'foo'
+$cookie.Value = 'bar'
+$cookie.Domain = 'mockbin.com'
+$session.Cookies.Add($cookie)
+$cookie = New-Object System.Net.Cookie
+$cookie.Name = 'bar'
+$cookie.Value = 'baz'
+$cookie.Domain = 'mockbin.com'
+$session.Cookies.Add($cookie)
+$response = Invoke-RestMethod -Uri 'http://mockbin.com/har?foo=bar&foo=baz&baz=abc&key=value' -Method POST -Headers $headers -WebSession $session -ContentType 'application/x-www-form-urlencoded' -Body 'foo=bar'