@readme/httpsnippet 2.5.1 → 3.0.3

package/src/targets/php/http1.js

@@ -8,89 +8,78 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-const helpers = require('./helpers')
-const CodeBuilder = require('../../helpers/code-builder')
+const helpers = require('./helpers');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  const opts = Object.assign({
+  const opts = {
     closingTag: false,
     indent: '  ',
     noTags: false,
-    shortTags: false
-  }, options)
+    shortTags: false,
+    ...options,
+  };
 
-  const code = new CodeBuilder(opts.indent)
+  const code = new CodeBuilder(opts.indent);
 
   if (!opts.noTags) {
-    code.push(opts.shortTags ? '<?' : '<?php')
-      .blank()
+    code.push(opts.shortTags ? '<?' : '<?php').blank();
   }
 
-  if (!~helpers.methods.indexOf(source.method.toUpperCase())) {
-    code.push('HttpRequest::methodRegister(\'%s\');', source.method)
+  if (!helpers.methods.includes(source.method.toUpperCase())) {
+    code.push("HttpRequest::methodRegister('%s');", source.method);
   }
 
-  code.push('$request = new HttpRequest();')
-    .push('$request->setUrl(%s);', helpers.convert(source.url))
+  code.push('$request = new HttpRequest();').push('$request->setUrl(%s);', helpers.convert(source.url));
 
-  if (~helpers.methods.indexOf(source.method.toUpperCase())) {
-    code.push('$request->setMethod(HTTP_METH_%s);', source.method.toUpperCase())
+  if (helpers.methods.includes(source.method.toUpperCase())) {
+    code.push('$request->setMethod(HTTP_METH_%s);', source.method.toUpperCase());
   } else {
-    code.push('$request->setMethod(HttpRequest::HTTP_METH_%s);', source.method.toUpperCase())
+    code.push('$request->setMethod(HttpRequest::HTTP_METH_%s);', source.method.toUpperCase());
   }
 
-  code.blank()
+  code.blank();
 
   if (Object.keys(source.queryObj).length) {
-    code.push('$request->setQueryData(%s);', helpers.convert(source.queryObj, opts.indent))
-      .blank()
+    code.push('$request->setQueryData(%s);', helpers.convert(source.queryObj, opts.indent)).blank();
   }
 
   if (Object.keys(source.headersObj).length) {
-    code.push('$request->setHeaders(%s);', helpers.convert(source.headersObj, opts.indent))
-      .blank()
+    code.push('$request->setHeaders(%s);', helpers.convert(source.headersObj, opts.indent)).blank();
   }
 
   if (Object.keys(source.cookiesObj).length) {
-    code.push('$request->setCookies(%s);', helpers.convert(source.cookiesObj, opts.indent))
-      .blank()
+    code.push('$request->setCookies(%s);', helpers.convert(source.cookiesObj, opts.indent)).blank();
   }
 
-  switch (source.postData.mimeType) {
-    case 'application/x-www-form-urlencoded':
-      code.push('$request->setContentType(%s);', helpers.convert(source.postData.mimeType))
-        .push('$request->setPostFields(%s);', helpers.convert(source.postData.paramsObj, opts.indent))
-        .blank()
-      break
-
-    default:
-      if (source.postData.text) {
-        code.push('$request->setBody(%s);', helpers.convert(source.postData.text))
-          .blank()
-      }
+  if (source.postData.mimeType === 'application/x-www-form-urlencoded') {
+    code
+      .push('$request->setContentType(%s);', helpers.convert(source.postData.mimeType))
+      .push('$request->setPostFields(%s);', helpers.convert(source.postData.paramsObj, opts.indent))
+      .blank();
+  } else if (source.postData.text) {
+    code.push('$request->setBody(%s);', helpers.convert(source.postData.text)).blank();
   }
 
-  code.push('try {')
+  code
+    .push('try {')
     .push(1, '$response = $request->send();')
     .blank()
     .push(1, 'echo $response->getBody();')
     .push('} catch (HttpException $ex) {')
     .push(1, 'echo $ex;')
-    .push('}')
+    .push('}');
 
   if (!opts.noTags && opts.closingTag) {
-    code.blank()
-      .push('?>')
+    code.blank().push('?>');
   }
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'http1',
   title: 'HTTP v1',
   link: 'http://php.net/manual/en/book.http.php',
-  description: 'PHP with pecl/http v1'
-}
+  description: 'PHP with pecl/http v1',
+};

package/src/targets/php/http2.js

@@ -8,125 +8,124 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-const helpers = require('./helpers')
-const headerHelpers = require('../../helpers/headers')
-const CodeBuilder = require('../../helpers/code-builder')
+const helpers = require('./helpers');
+const headerHelpers = require('../../helpers/headers');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  const opts = Object.assign({
+  const opts = {
     closingTag: false,
     indent: '  ',
     noTags: false,
-    shortTags: false
-  }, options)
+    shortTags: false,
+    ...options,
+  };
 
-  const code = new CodeBuilder(opts.indent)
-  let hasBody = false
+  const code = new CodeBuilder(opts.indent);
+  let hasBody = false;
 
   if (!opts.noTags) {
-    code.push(opts.shortTags ? '<?' : '<?php')
-      .blank()
+    code.push(opts.shortTags ? '<?' : '<?php').blank();
   }
 
-  code.push('$client = new http\\Client;')
-    .push('$request = new http\\Client\\Request;')
-    .blank()
+  code.push('$client = new http\\Client;').push('$request = new http\\Client\\Request;').blank();
 
   switch (source.postData.mimeType) {
     case 'application/x-www-form-urlencoded':
-      code.push('$body = new http\\Message\\Body;')
+      code
+        .push('$body = new http\\Message\\Body;')
         .push('$body->append(new http\\QueryString(%s));', helpers.convert(source.postData.paramsObj, opts.indent))
-        .blank()
-      hasBody = true
-      break
+        .blank();
+      hasBody = true;
+      break;
 
     case 'multipart/form-data': {
-      const files = []
-      const fields = {}
-
-      source.postData.params.forEach(function (param) {
-        if (param.fileName) {
-          files.push({
-            name: param.name,
-            type: param.contentType,
-            file: param.fileName,
-            data: param.value
-          })
-        } else if (param.value) {
-          fields[param.name] = param.value
-        }
-      })
-
-      code.push('$body = new http\\Message\\Body;')
-        .push('$body->addForm(%s, %s);',
-          Object.keys(fields).length ? helpers.convert(fields, opts.indent) : 'null',
-          files.length ? helpers.convert(files, opts.indent) : 'null'
-        )
-
-      // remove the contentType header
-      if (headerHelpers.hasHeader(source.headersObj, 'content-type')) {
-        if (headerHelpers.getHeader(source.headersObj, 'content-type').indexOf('boundary')) {
-          delete source.headersObj[headerHelpers.getHeaderName(source.headersObj, 'content-type')]
+      if (source.postData.params) {
+        const files = [];
+        const fields = {};
+
+        source.postData.params.forEach(function (param) {
+          if (param.fileName) {
+            files.push({
+              name: param.name,
+              type: param.contentType,
+              file: param.fileName,
+              data: param.value,
+            });
+          } else if (param.value) {
+            fields[param.name] = param.value;
+          }
+        });
+
+        code
+          .push('$body = new http\\Message\\Body;')
+          .push(
+            '$body->addForm(%s, %s);',
+            Object.keys(fields).length ? helpers.convert(fields, opts.indent) : 'null',
+            files.length ? helpers.convert(files, opts.indent) : 'null'
+          );
+
+        // remove the contentType header
+        if (headerHelpers.hasHeader(source.headersObj, 'content-type')) {
+          if (headerHelpers.getHeader(source.headersObj, 'content-type').includes('boundary')) {
+            // eslint-disable-next-line no-param-reassign
+            delete source.headersObj[headerHelpers.getHeaderName(source.headersObj, 'content-type')];
+          }
         }
-      }
 
-      code.blank()
+        code.blank();
 
-      hasBody = true
-      break
+        hasBody = true;
+      }
+      break;
     }
 
     default:
       if (source.postData.text) {
-        code.push('$body = new http\\Message\\Body;')
+        code
+          .push('$body = new http\\Message\\Body;')
           .push('$body->append(%s);', helpers.convert(source.postData.text))
-          .blank()
-        hasBody = true
+          .blank();
+        hasBody = true;
       }
   }
 
-  code.push('$request->setRequestUrl(%s);', helpers.convert(source.url))
-    .push('$request->setRequestMethod(%s);', helpers.convert(source.method))
+  code
+    .push('$request->setRequestUrl(%s);', helpers.convert(source.url))
+    .push('$request->setRequestMethod(%s);', helpers.convert(source.method));
 
   if (hasBody) {
-    code.push('$request->setBody($body);')
-      .blank()
+    code.push('$request->setBody($body);').blank();
   }
 
   if (Object.keys(source.queryObj).length) {
-    code.push('$request->setQuery(new http\\QueryString(%s));', helpers.convert(source.queryObj, opts.indent))
-      .blank()
+    code.push('$request->setQuery(new http\\QueryString(%s));', helpers.convert(source.queryObj, opts.indent)).blank();
   }
 
   if (Object.keys(source.headersObj).length) {
-    code.push('$request->setHeaders(%s);', helpers.convert(source.headersObj, opts.indent))
-      .blank()
+    code.push('$request->setHeaders(%s);', helpers.convert(source.headersObj, opts.indent)).blank();
   }
 
   if (Object.keys(source.cookiesObj).length) {
-    code.blank()
-      .push('$client->setCookies(%s);', helpers.convert(source.cookiesObj, opts.indent))
-      .blank()
+    code.blank().push('$client->setCookies(%s);', helpers.convert(source.cookiesObj, opts.indent)).blank();
   }
 
-  code.push('$client->enqueue($request)->send();')
+  code
+    .push('$client->enqueue($request)->send();')
     .push('$response = $client->getResponse();')
     .blank()
-    .push('echo $response->getBody();')
+    .push('echo $response->getBody();');
 
   if (!opts.noTags && opts.closingTag) {
-    code.blank()
-      .push('?>')
+    code.blank().push('?>');
   }
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'http2',
   title: 'HTTP v2',
   link: 'http://devel-m6w6.rhcloud.com/mdref/http',
-  description: 'PHP with pecl/http v2'
-}
+  description: 'PHP with pecl/http v2',
+};

package/src/targets/php/index.js

@@ -1,14 +1,14 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'php',
     title: 'PHP',
     extname: '.php',
-    default: 'curl'
+    default: 'curl',
+    cli: 'php %s',
   },
 
   curl: require('./curl'),
   http1: require('./http1'),
-  http2: require('./http2')
-}
+  http2: require('./http2'),
+  guzzle: require('./guzzle'),
+};

package/src/targets/powershell/common.js

@@ -1,55 +1,60 @@
-'use strict'
-
-const CodeBuilder = require('../../helpers/code-builder')
-const helpers = require('../../helpers/headers')
+const CodeBuilder = require('../../helpers/code-builder');
+const helpers = require('../../helpers/headers');
 
 module.exports = function (command) {
-  return function (source, options) {
-    const code = new CodeBuilder()
-    const methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS']
+  return function (source) {
+    const code = new CodeBuilder();
+    const methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'];
 
-    if (methods.indexOf(source.method.toUpperCase()) === -1) {
-      return 'Method not supported'
+    if (!methods.includes(source.method.toUpperCase())) {
+      return 'Method not supported';
     }
 
-    const commandOptions = []
+    const commandOptions = [];
 
     // Add headers, including the cookies
-    const headers = Object.keys(source.headersObj)
+    const headers = Object.keys(source.headersObj);
 
     // construct headers
     if (headers.length) {
-      code.push('$headers=@{}')
+      code.push('$headers=@{}');
       headers.forEach(function (key) {
-        if (key !== 'connection') { // Not allowed
-          code.push('$headers.Add("%s", "%s")', key, source.headersObj[key])
+        if (key !== 'connection') {
+          // Not allowed
+          code.push('$headers.Add("%s", "%s")', key, source.headersObj[key]);
         }
-      })
-      commandOptions.push('-Headers $headers')
+      });
+      commandOptions.push('-Headers $headers');
     }
 
     // construct cookies
     if (source.cookies.length) {
-      code.push('$session = New-Object Microsoft.PowerShell.Commands.WebRequestSession')
+      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 = 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("$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')
+        code.push('$session.Cookies.Add($cookie)');
+      });
+      commandOptions.push('-WebSession $session');
     }
 
     if (source.postData.text) {
-      commandOptions.push("-ContentType '" + helpers.getHeader(source.allHeaders, 'content-type') + "'")
-      commandOptions.push("-Body '" + source.postData.text + "'")
+      commandOptions.push(`-ContentType '${helpers.getHeader(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()
-  }
-}
+    code.push(
+      "$response = %s -Uri '%s' -Method %s %s",
+      command,
+      source.fullUrl,
+      source.method,
+      commandOptions.join(' ')
+    );
+    return code.join();
+  };
+};

package/src/targets/powershell/index.js

@@ -1,13 +1,11 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'powershell',
     title: 'Powershell',
     extname: '.ps1',
-    default: 'webrequest'
+    default: 'webrequest',
   },
 
   webrequest: require('./webrequest'),
-  restmethod: require('./restmethod')
-}
+  restmethod: require('./restmethod'),
+};

package/src/targets/powershell/restmethod.js

@@ -1,10 +1,8 @@
-'use strict'
-
-module.exports = require('./common')('Invoke-RestMethod')
+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'
-}
+  description: 'Powershell Invoke-RestMethod client',
+};

package/src/targets/powershell/webrequest.js

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

package/src/targets/python/helpers.js

@@ -1,6 +1,4 @@
-'use strict'
-
-const util = require('util')
+const { format } = require('util');
 
 /**
  * Create an string of given length filled with blank spaces
@@ -9,26 +7,27 @@ const util = require('util')
  * @param {string} str String to pad out with
  * @return {string}
  */
-function buildString (length, str) {
-  return Array.apply(null, new Array(length)).map(String.prototype.valueOf, str).join('')
+function buildString(length, str) {
+  // eslint-disable-next-line prefer-spread
+  return Array.apply(null, new Array(length)).map(String.prototype.valueOf, str).join('');
 }
 
 /**
  * Create a string corresponding to a Dictionary or Array literal representation with pretty option
  * and indentation.
  */
-function concatValues (concatType, values, pretty, indentation, indentLevel) {
-  const currentIndent = buildString(indentLevel, indentation)
-  const closingBraceIndent = buildString(indentLevel - 1, indentation)
-  const join = pretty ? ',\n' + currentIndent : ', '
-  const openingBrace = concatType === 'object' ? '{' : '['
-  const closingBrace = concatType === 'object' ? '}' : ']'
+function concatValues(concatType, values, pretty, indentation, indentLevel) {
+  const currentIndent = buildString(indentLevel, indentation);
+  const closingBraceIndent = buildString(indentLevel - 1, indentation);
+  const join = pretty ? `,\n${currentIndent}` : ', ';
+  const openingBrace = concatType === 'object' ? '{' : '[';
+  const closingBrace = concatType === 'object' ? '}' : ']';
 
   if (pretty) {
-    return openingBrace + '\n' + currentIndent + values.join(join) + '\n' + closingBraceIndent + closingBrace
-  } else {
-    return openingBrace + values.join(join) + closingBrace
+    return `${openingBrace}\n${currentIndent}${values.join(join)}\n${closingBraceIndent}${closingBrace}`;
   }
+
+  return openingBrace + values.join(join) + closingBrace;
 }
 
 module.exports = {
@@ -40,43 +39,47 @@ module.exports = {
    * @return {string}
    */
   literalRepresentation: function (value, opts, indentLevel) {
-    indentLevel = indentLevel === undefined ? 1 : indentLevel + 1
+    // eslint-disable-next-line no-param-reassign
+    indentLevel = indentLevel === undefined ? 1 : indentLevel + 1;
 
     switch (Object.prototype.toString.call(value)) {
       case '[object Number]':
-        return value
+        return value;
 
       case '[object Array]': {
-        let pretty = false
-        const valuesRepresentation = value.map(function (v) {
-          // Switch to prettify if the value is a dictionary with multiple keys
-          if (Object.prototype.toString.call(v) === '[object Object]') {
-            pretty = Object.keys(v).length > 1
-          }
-          return this.literalRepresentation(v, opts, indentLevel)
-        }.bind(this))
-        return concatValues('array', valuesRepresentation, pretty, opts.indent, indentLevel)
+        let pretty = false;
+        const valuesRepresentation = value.map(
+          function (v) {
+            // Switch to prettify if the value is a dictionary with multiple keys
+            if (Object.prototype.toString.call(v) === '[object Object]') {
+              pretty = Object.keys(v).length > 1;
+            }
+            return this.literalRepresentation(v, opts, indentLevel);
+          }.bind(this)
+        );
+        return concatValues('array', valuesRepresentation, pretty, opts.indent, indentLevel);
       }
 
       case '[object Object]': {
-        const keyValuePairs = []
+        const keyValuePairs = [];
+        // eslint-disable-next-line guard-for-in, no-restricted-syntax
         for (const k in value) {
-          keyValuePairs.push(util.format('"%s": %s', k, this.literalRepresentation(value[k], opts, indentLevel)))
+          keyValuePairs.push(format('"%s": %s', k, this.literalRepresentation(value[k], opts, indentLevel)));
         }
-        return concatValues('object', keyValuePairs, opts.pretty && keyValuePairs.length > 1, opts.indent, indentLevel)
+        return concatValues('object', keyValuePairs, opts.pretty && keyValuePairs.length > 1, opts.indent, indentLevel);
       }
 
       case '[object Null]':
-        return 'None'
+        return 'None';
 
       case '[object Boolean]':
-        return value ? 'True' : 'False'
+        return value ? 'True' : 'False';
 
       default:
         if (value === null || value === undefined) {
-          return ''
+          return '';
         }
-        return '"' + value.toString().replace(/"/g, '\\"') + '"'
+        return `"${value.toString().replace(/"/g, '\\"')}"`;
     }
-  }
-}
+  },
+};

package/src/targets/python/index.js

@@ -1,13 +1,12 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'python',
     title: 'Python',
     extname: '.py',
-    default: 'python3'
+    default: 'python3',
+    cli: 'python3 %s',
   },
 
   python3: require('./python3'),
-  requests: require('./requests')
-}
+  requests: require('./requests'),
+};