@readme/httpsnippet 2.5.0 → 3.0.2

package/src/targets/shell/curl.js

@@ -8,83 +8,109 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-const util = require('util')
-const helpers = require('./helpers')
-const headerHelpers = require('../../helpers/headers')
-const CodeBuilder = require('../../helpers/code-builder')
+const { format } = require('util');
+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 = {
     indent: '  ',
     short: false,
     binary: false,
-    globOff: false
-  }, options)
+    globOff: false,
+    escapeBrackets: false,
+    ...options,
+  };
+
+  const code = new CodeBuilder(opts.indent, opts.indent !== false ? ` \\\n${opts.indent}` : ' ');
 
-  const code = new CodeBuilder(opts.indent, opts.indent !== false ? ' \\\n' + opts.indent : ' ')
+  const globOption = opts.short ? '-g' : '--globoff';
+  const requestOption = opts.short ? '-X' : '--request';
+  let formattedUrl = helpers.quote(source.fullUrl);
 
-  const globOption = opts.short ? '-g' : '--globoff'
-  const requestOption = opts.short ? '-X' : '--request'
-  let formattedUrl = helpers.quote(source.fullUrl)
+  if (opts.escapeBrackets) {
+    formattedUrl = formattedUrl.replace(/\[/g, '\\[').replace(/\]/g, '\\]');
+  }
 
-  code.push('curl %s %s', requestOption, source.method)
+  code.push('curl %s %s', requestOption, source.method);
   if (opts.globOff) {
-    formattedUrl = unescape(formattedUrl)
-    code.push(globOption)
+    formattedUrl = unescape(formattedUrl);
+    code.push(globOption);
   }
-  code.push(util.format('%s%s', opts.short ? '' : '--url ', formattedUrl))
+  code.push(format('%s%s', opts.short ? '' : '--url ', formattedUrl));
 
   if (source.httpVersion === 'HTTP/1.0') {
-    code.push(opts.short ? '-0' : '--http1.0')
+    code.push(opts.short ? '-0' : '--http1.0');
+  }
+
+  // if multipart form data, we want to remove the boundary
+  if (source.postData.mimeType === 'multipart/form-data') {
+    const contentTypeHeaderName = headerHelpers.getHeaderName(source.headersObj, 'content-type');
+    const contentTypeHeader = source.headersObj[contentTypeHeaderName];
+
+    if (contentTypeHeaderName && contentTypeHeader) {
+      // remove the leading semi colon and boundary
+      // up to the next semi colon or the end of string
+      const noBoundary = contentTypeHeader.replace(/; boundary.+?(?=(;|$))/, '');
+
+      // replace the content-type header with no boundary in both headersObj and allHeaders
+      source.headersObj[contentTypeHeaderName] = noBoundary; // eslint-disable-line no-param-reassign
+      source.allHeaders[contentTypeHeaderName] = noBoundary; // eslint-disable-line no-param-reassign
+    }
   }
 
   // construct headers
-  Object.keys(source.headersObj).sort().forEach(function (key) {
-    const header = util.format('%s: %s', key, source.headersObj[key])
-    code.push('%s %s', opts.short ? '-H' : '--header', helpers.quote(header))
-  })
+  Object.keys(source.headersObj)
+    .sort()
+    .forEach(function (key) {
+      const header = format('%s: %s', key, source.headersObj[key]);
+      code.push('%s %s', opts.short ? '-H' : '--header', helpers.quote(header));
+    });
 
   if (source.allHeaders.cookie) {
-    code.push('%s %s', opts.short ? '-b' : '--cookie', helpers.quote(source.allHeaders.cookie))
+    code.push('%s %s', opts.short ? '-b' : '--cookie', helpers.quote(source.allHeaders.cookie));
   }
 
   // construct post params
   switch (source.postData.mimeType) {
     case 'multipart/form-data':
-      source.postData.params.forEach(function (param) {
-        let post = ''
-        if (param.fileName) {
-          post = util.format('%s=@%s', param.name, param.fileName)
-        } else {
-          post = util.format('%s=%s', param.name, param.value)
-        }
+      if (source.postData.params) {
+        source.postData.params.forEach(function (param) {
+          let post = '';
+          if (param.fileName) {
+            post = format('%s=@%s', param.name, param.fileName);
+          } else {
+            post = format('%s=%s', param.name, param.value);
+          }
 
-        code.push('%s %s', opts.short ? '-F' : '--form', helpers.quote(post))
-      })
-      break
+          code.push('%s %s', opts.short ? '-F' : '--form', helpers.quote(post));
+        });
+      }
+      break;
 
     case 'application/x-www-form-urlencoded':
       if (source.postData.params) {
         source.postData.params.forEach(function (param) {
           code.push(
-            '%s %s', opts.binary ? '--data-binary' : (opts.short ? '-d' : '--data'),
-            helpers.quote(util.format('%s=%s', param.name, param.value))
-          )
-        })
+            '%s %s',
+            opts.binary ? '--data-binary' : opts.short ? '-d' : '--data',
+            helpers.quote(format('%s=%s', param.name, param.value))
+          );
+        });
       } else {
         code.push(
-          '%s %s', opts.binary ? '--data-binary' : (opts.short ? '-d' : '--data'),
+          '%s %s',
+          opts.binary ? '--data-binary' : opts.short ? '-d' : '--data',
           helpers.quote(source.postData.text)
-        )
+        );
       }
-      break
+      break;
 
     default:
       // raw request body
       if (source.postData.text) {
-        let builtPayload = false
+        let builtPayload = false;
 
         // If we're dealing with a JSON variant, and our payload is JSON let's make it look a little nicer.
         if (headerHelpers.isMimeTypeJson(source.postData.mimeType)) {
@@ -92,18 +118,18 @@ module.exports = function (source, options) {
           // overly lengthy
           if (source.postData.text.length > 20) {
             try {
-              const jsonPayload = JSON.parse(source.postData.text)
+              const jsonPayload = JSON.parse(source.postData.text);
 
               // If the JSON object has a single quote we should prepare it inside of a HEREDOC because the single
               // quote in something like `string's` can't be escaped when used with `--data`.
               //
               // Basically this boils down to `--data @- <<EOF...EOF` vs `--data '...'`.
-              builtPayload = true
+              builtPayload = true;
               code.push(
                 source.postData.text.indexOf("'") > 0 ? '%s @- <<EOF\n%s\nEOF' : "%s '\n%s\n'",
-                opts.binary ? '--data-binary' : (opts.short ? '-d' : '--data'),
+                opts.binary ? '--data-binary' : opts.short ? '-d' : '--data',
                 JSON.stringify(jsonPayload, null, opts.indent)
-              )
+              );
             } catch (err) {
               // no-op
             }
@@ -112,19 +138,20 @@ module.exports = function (source, options) {
 
         if (!builtPayload) {
           code.push(
-            '%s %s', opts.binary ? '--data-binary' : (opts.short ? '-d' : '--data'),
+            '%s %s',
+            opts.binary ? '--data-binary' : opts.short ? '-d' : '--data',
             helpers.quote(source.postData.text)
-          )
+          );
         }
       }
   }
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'curl',
   title: 'cURL',
   link: 'http://curl.haxx.se/',
-  description: 'cURL is a command line tool and library for transferring data with URL syntax'
-}
+  description: 'cURL is a command line tool and library for transferring data with URL syntax',
+};

package/src/targets/shell/helpers.js

@@ -1,6 +1,4 @@
-'use strict'
-
-const util = require('util')
+const { format } = require('util');
 
 module.exports = {
   /**
@@ -9,17 +7,17 @@ module.exports = {
    * http://wiki.bash-hackers.org/syntax/quoting#strong_quoting
    */
   quote: function (value) {
-    const safe = /^[a-z0-9-_/.@%^=:]+$/i
+    const safe = /^[a-z0-9-_/.@%^=:]+$/i;
 
     // Unless `value` is a simple shell-safe string, quote it.
     if (!safe.test(value)) {
-      return util.format('\'%s\'', value.replace(/'/g, "'\\''"))
+      return format("'%s'", value.replace(/'/g, "'\\''"));
     }
 
-    return value
+    return value;
   },
 
   escape: function (value) {
-    return value.replace(/\r/g, '\\r').replace(/\n/g, '\\n')
-  }
-}
+    return value.replace(/\r/g, '\\r').replace(/\n/g, '\\n');
+  },
+};

package/src/targets/shell/httpie.js

@@ -8,14 +8,12 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-const util = require('util')
-const shell = require('./helpers')
-const CodeBuilder = require('../../helpers/code-builder')
+const { format } = require('util');
+const shell = require('./helpers');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  const opts = Object.assign({
+  const opts = {
     body: false,
     cert: false,
     headers: false,
@@ -27,97 +25,105 @@ module.exports = function (source, options) {
     style: false,
     timeout: false,
     verbose: false,
-    verify: false
-  }, options)
+    verify: false,
+    ...options,
+  };
 
-  const code = new CodeBuilder(opts.indent, opts.indent !== false ? ' \\\n' + opts.indent : ' ')
+  const code = new CodeBuilder(opts.indent, opts.indent !== false ? ` \\\n${opts.indent}` : ' ');
 
-  let raw = false
-  const flags = []
+  let raw = false;
+  const flags = [];
 
   if (opts.headers) {
-    flags.push(opts.short ? '-h' : '--headers')
+    flags.push(opts.short ? '-h' : '--headers');
   }
 
   if (opts.body) {
-    flags.push(opts.short ? '-b' : '--body')
+    flags.push(opts.short ? '-b' : '--body');
   }
 
   if (opts.verbose) {
-    flags.push(opts.short ? '-v' : '--verbose')
+    flags.push(opts.short ? '-v' : '--verbose');
   }
 
   if (opts.print) {
-    flags.push(util.format('%s=%s', opts.short ? '-p' : '--print', opts.print))
+    flags.push(format('%s=%s', opts.short ? '-p' : '--print', opts.print));
   }
 
   if (opts.verify) {
-    flags.push(util.format('--verify=%s', opts.verify))
+    flags.push(format('--verify=%s', opts.verify));
   }
 
   if (opts.cert) {
-    flags.push(util.format('--cert=%s', opts.cert))
+    flags.push(format('--cert=%s', opts.cert));
   }
 
   if (opts.pretty) {
-    flags.push(util.format('--pretty=%s', opts.pretty))
+    flags.push(format('--pretty=%s', opts.pretty));
   }
 
   if (opts.style) {
-    flags.push(util.format('--style=%s', opts.pretty))
+    flags.push(format('--style=%s', opts.pretty));
   }
 
   if (opts.timeout) {
-    flags.push(util.format('--timeout=%s', opts.timeout))
+    flags.push(format('--timeout=%s', opts.timeout));
   }
 
   // construct query params
   if (opts.queryParams) {
-    const queryStringKeys = Object.keys(source.queryObj)
+    const queryStringKeys = Object.keys(source.queryObj);
 
     queryStringKeys.forEach(function (name) {
-      const value = source.queryObj[name]
+      const value = source.queryObj[name];
 
       if (Array.isArray(value)) {
         value.forEach(function (val) {
-          code.push('%s==%s', name, shell.quote(val))
-        })
+          code.push('%s==%s', name, shell.quote(val));
+        });
       } else {
-        code.push('%s==%s', name, shell.quote(value))
+        code.push('%s==%s', name, shell.quote(value));
       }
-    })
+    });
   }
 
   // construct headers
-  Object.keys(source.allHeaders).sort().forEach(function (key) {
-    code.push('%s:%s', key, shell.quote(source.allHeaders[key]))
-  })
+  Object.keys(source.allHeaders)
+    .sort()
+    .forEach(function (key) {
+      code.push('%s:%s', key, shell.quote(source.allHeaders[key]));
+    });
 
   if (source.postData.mimeType === 'application/x-www-form-urlencoded') {
     // construct post params
     if (source.postData.params && source.postData.params.length) {
-      flags.push(opts.short ? '-f' : '--form')
+      flags.push(opts.short ? '-f' : '--form');
 
       source.postData.params.forEach(function (param) {
-        code.push('%s=%s', param.name, shell.quote(param.value))
-      })
+        code.push('%s=%s', param.name, shell.quote(param.value));
+      });
     }
   } else {
-    raw = true
+    raw = true;
   }
 
-  code.unshift('http %s%s %s', flags.length ? flags.join(' ') + ' ' : '', source.method, shell.quote(opts.queryParams ? source.url : source.fullUrl))
+  code.unshift(
+    'http %s%s %s',
+    flags.length ? `${flags.join(' ')} ` : '',
+    source.method,
+    shell.quote(opts.queryParams ? source.url : source.fullUrl)
+  );
 
   if (raw && source.postData.text) {
-    code.unshift('echo %s | ', shell.quote(source.postData.text))
+    code.unshift('echo %s | ', shell.quote(source.postData.text));
   }
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'httpie',
   title: 'HTTPie',
   link: 'http://httpie.org/',
-  description: 'a CLI, cURL-like tool for humans'
-}
+  description: 'a CLI, cURL-like tool for humans',
+};

package/src/targets/shell/index.js

@@ -1,14 +1,13 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'shell',
     title: 'Shell',
     extname: '.sh',
-    default: 'curl'
+    default: 'curl',
+    cli: '%s',
   },
 
   curl: require('./curl'),
   httpie: require('./httpie'),
-  wget: require('./wget')
-}
+  wget: require('./wget'),
+};

package/src/targets/shell/wget.js

@@ -8,47 +8,45 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-const util = require('util')
-const helpers = require('./helpers')
-const CodeBuilder = require('../../helpers/code-builder')
+const { format } = require('util');
+const helpers = require('./helpers');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  const opts = Object.assign({
+  const opts = {
     indent: '  ',
     short: false,
-    verbose: false
-  }, options)
+    verbose: false,
+    ...options,
+  };
 
-  const code = new CodeBuilder(opts.indent, opts.indent !== false ? ' \\\n' + opts.indent : ' ')
+  const code = new CodeBuilder(opts.indent, opts.indent !== false ? ` \\\n${opts.indent}` : ' ');
 
   if (opts.verbose) {
-    code.push('wget %s', opts.short ? '-v' : '--verbose')
+    code.push('wget %s', opts.short ? '-v' : '--verbose');
   } else {
-    code.push('wget %s', opts.short ? '-q' : '--quiet')
+    code.push('wget %s', opts.short ? '-q' : '--quiet');
   }
 
-  code.push('--method %s', helpers.quote(source.method))
+  code.push('--method %s', helpers.quote(source.method));
 
   Object.keys(source.allHeaders).forEach(function (key) {
-    const header = util.format('%s: %s', key, source.allHeaders[key])
-    code.push('--header %s', helpers.quote(header))
-  })
+    const header = format('%s: %s', key, source.allHeaders[key]);
+    code.push('--header %s', helpers.quote(header));
+  });
 
   if (source.postData.text) {
-    code.push('--body-data ' + helpers.escape(helpers.quote(source.postData.text)))
+    code.push(`--body-data ${helpers.escape(helpers.quote(source.postData.text))}`);
   }
 
-  code.push(opts.short ? '-O' : '--output-document')
-    .push('- %s', helpers.quote(source.fullUrl))
+  code.push(opts.short ? '-O' : '--output-document').push('- %s', helpers.quote(source.fullUrl));
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'wget',
   title: 'Wget',
   link: 'https://www.gnu.org/software/wget/',
-  description: 'a free software package for retrieving files using HTTP, HTTPS'
-}
+  description: 'a free software package for retrieving files using HTTP, HTTPS',
+};

package/src/targets/swift/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,24 +7,25 @@ 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 concatArray (arr, pretty, indentation, indentLevel) {
-  const currentIndent = buildString(indentLevel, indentation)
-  const closingBraceIndent = buildString(indentLevel - 1, indentation)
-  const join = pretty ? ',\n' + currentIndent : ', '
+function concatArray(arr, pretty, indentation, indentLevel) {
+  const currentIndent = buildString(indentLevel, indentation);
+  const closingBraceIndent = buildString(indentLevel - 1, indentation);
+  const join = pretty ? `,\n${currentIndent}` : ', ';
 
   if (pretty) {
-    return '[\n' + currentIndent + arr.join(join) + '\n' + closingBraceIndent + ']'
-  } else {
-    return '[' + arr.join(join) + ']'
+    return `[\n${currentIndent}${arr.join(join)}\n${closingBraceIndent}]`;
   }
+
+  return `[${arr.join(join)}]`;
 }
 
 module.exports = {
@@ -39,7 +38,7 @@ module.exports = {
    * @return {string}
    */
   literalDeclaration: function (name, parameters, opts) {
-    return util.format('let %s = %s', name, this.literalRepresentation(parameters, opts))
+    return format('let %s = %s', name, this.literalRepresentation(parameters, opts));
   },
 
   /**
@@ -50,41 +49,45 @@ 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]': {
         // Don't prettify arrays nto not take too much space
-        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 concatArray(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 concatArray(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 concatArray(keyValuePairs, opts.pretty && keyValuePairs.length > 1, opts.indent, indentLevel)
+        return concatArray(keyValuePairs, opts.pretty && keyValuePairs.length > 1, opts.indent, indentLevel);
       }
 
       case '[object Boolean]':
-        return value.toString()
+        return value.toString();
 
       default:
         if (value === null || value === undefined) {
-          return ''
+          return '';
         }
-        return '"' + value.toString().replace(/"/g, '\\"') + '"'
+        return `"${value.toString().replace(/"/g, '\\"')}"`;
     }
-  }
-}
+  },
+};

package/src/targets/swift/index.js

@@ -1,12 +1,10 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'swift',
     title: 'Swift',
     extname: '.swift',
-    default: 'nsurlsession'
+    default: 'nsurlsession',
   },
 
-  nsurlsession: require('./nsurlsession')
-}
+  nsurlsession: require('./nsurlsession'),
+};