@readme/httpsnippet 2.4.5 → 3.0.1

package/src/targets/r/httr.js

@@ -8,147 +8,134 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
+const { format } = require('util');
+const CodeBuilder = require('../../helpers/code-builder');
 
-var util = require('util')
-var CodeBuilder = require('../../helpers/code-builder')
-
-module.exports = function (source, options) {
+module.exports = function (source) {
   // Start snippet
-  var code = new CodeBuilder()
+  const code = new CodeBuilder();
 
   // Import httr
-  code.push('library(httr)')
-    .blank()
+  code.push('library(httr)').blank();
 
   // Set URL
-  code.push('url <- "%s"', source.url)
-    .blank()
+  code.push('url <- "%s"', source.url).blank();
 
   // Construct query string
-  var query
-  var qs = source.queryObj
-  var queryCount = Object.keys(qs).length
-  delete source.queryObj['key']
+  const qs = source.queryObj;
+  const queryCount = Object.keys(qs).length;
+  // eslint-disable-next-line no-param-reassign
+  delete source.queryObj.key;
 
   if (source.queryString.length === 1) {
-    code.push('queryString <- list(%s = "%s")', Object.keys(qs), Object.values(qs).toString())
-      .blank()
+    code.push('queryString <- list(%s = "%s")', Object.keys(qs), Object.values(qs).toString()).blank();
   } else if (source.queryString.length > 1) {
-    var count = 1
+    let count = 1;
 
-    code.push('queryString <- list(')
+    code.push('queryString <- list(');
 
-    for (query in qs) {
+    Object.keys(qs).forEach(query => {
+      // eslint-disable-next-line no-plusplus
       if (count++ !== queryCount - 1) {
-        code.push('  %s = "%s",', query, qs[query].toString())
+        code.push('  %s = "%s",', query, qs[query].toString());
       } else {
-        code.push('  %s = "%s"', query, qs[query].toString())
+        code.push('  %s = "%s"', query, qs[query].toString());
       }
-    }
+    });
 
-    code.push(')')
-      .blank()
+    code.push(')').blank();
   }
 
   // Construct payload
-  var payload = JSON.stringify(source.postData.text)
+  const payload = JSON.stringify(source.postData.text);
 
   if (payload) {
-    code.push('payload <- %s', payload)
-      .blank()
+    code.push('payload <- %s', payload).blank();
   }
 
   // Define encode
   if (source.postData.text || source.postData.jsonObj || source.postData.params) {
     switch (source.postData.mimeType) {
       case 'application/x-www-form-urlencoded':
-        code.push('encode <- "form"')
-          .blank()
-        break
+        code.push('encode <- "form"').blank();
+        break;
 
       case 'application/json':
-        code.push('encode <- "json"')
-          .blank()
-        break
+        code.push('encode <- "json"').blank();
+        break;
 
       case 'multipart/form-data':
-        code.push('encode <- "multipart"')
-          .blank()
-        break
+        code.push('encode <- "multipart"').blank();
+        break;
 
       default:
-        code.push('encode <- "raw"')
-          .blank()
-        break
+        code.push('encode <- "raw"').blank();
+        break;
     }
   }
 
   // Construct headers
-  var head
-  var headers = source.allHeaders
-  var headerCount = Object.keys(headers).length
-  var header = ''
-  var cookies
-  var accept
-
-  for (head in headers) {
+  const headers = source.allHeaders;
+  let headerCount = 0;
+  let header = '';
+  let cookies;
+  let accept;
+
+  Object.keys(headers).forEach(head => {
     if (head.toLowerCase() === 'accept') {
-      accept = ', accept("' + headers[head] + '")'
-      headerCount = headerCount - 1
+      accept = `, accept("${headers[head]}")`;
+      headerCount += 1;
     } else if (head.toLowerCase() === 'cookie') {
-      cookies = ', set_cookies(`' + headers[head].replace(/;/g, '", `').replace(/` /g, '`').replace(/=/g, '` = "') + '")'
-      headerCount = headerCount - 1
+      cookies = `, set_cookies(\`${headers[head].replace(/;/g, '", `').replace(/` /g, '`').replace(/=/g, '` = "')}")`;
+      headerCount += 1;
     } else if (head.toLowerCase() !== 'content-type') {
-      header = header + head.replace('-', '_') + " = '" + headers[head]
-      if (headerCount > 1) { header = header + "', " }
+      header = `${header + head.replace('-', '_')} = '${headers[head]}`;
+      if (headerCount > 1) {
+        header += "', ";
+      }
     }
-  }
+  });
 
   // Construct request
-  var method = source.method
-  var request = util.format('response <- VERB("%s", url', method)
+  const method = source.method;
+  let request = format('response <- VERB("%s", url', method);
 
   if (payload) {
-    request += ', body = payload'
+    request += ', body = payload';
   }
 
   if (header !== '') {
-    request += ', add_headers(' + header + "')"
+    request += `, add_headers(${header}')`;
   }
 
   if (source.queryString.length) {
-    request += ', query = queryString'
+    request += ', query = queryString';
   }
 
-  request += ', content_type("' + source.postData.mimeType + '")'
+  request += `, content_type("${source.postData.mimeType}")`;
 
   if (typeof accept !== 'undefined') {
-    request += accept
+    request += accept;
   }
 
   if (typeof cookies !== 'undefined') {
-    request += cookies
+    request += cookies;
   }
 
   if (source.postData.text || source.postData.jsonObj || source.postData.params) {
-    request += ', encode = encode'
+    request += ', encode = encode';
   }
 
-  request += ')'
-
-  code.push(request)
-    .blank()
+  request += ')';
 
-  // Print response
-    .push('content(response, "text")')
+  code.push(request).blank().push('content(response, "text")');
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'httr',
   title: 'httr',
   link: 'https://cran.r-project.org/web/packages/httr/vignettes/quickstart.html',
-  description: 'httr: Tools for Working with URLs and HTTP'
-}
+  description: 'httr: Tools for Working with URLs and HTTP',
+};

package/src/targets/r/index.js

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

package/src/targets/ruby/index.js

@@ -1,12 +1,10 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'ruby',
     title: 'Ruby',
     extname: '.rb',
-    default: 'native'
+    default: 'native',
   },
 
-  native: require('./native')
-}
+  native: require('./native'),
+};

package/src/targets/ruby/native.js

@@ -1,65 +1,71 @@
-'use strict'
+const CodeBuilder = require('../../helpers/code-builder');
 
-var CodeBuilder = require('../../helpers/code-builder')
+module.exports = function (source) {
+  const code = new CodeBuilder();
 
-module.exports = function (source, options) {
-  var code = new CodeBuilder()
-
-  code.push('require \'uri\'')
-      .push('require \'net/http\'')
+  code.push("require 'uri'").push("require 'net/http'");
 
   if (source.uriObj.protocol === 'https:') {
-    code.push('require \'openssl\'')
+    code.push("require 'openssl'");
   }
 
-  code.blank()
+  code.blank();
 
   // To support custom methods we check for the supported methods
   // and if doesn't exist then we build a custom class for it
-  var method = source.method.toUpperCase()
-  var methods = ['GET', 'POST', 'HEAD', 'DELETE', 'PATCH', 'PUT', 'OPTIONS', 'COPY', 'LOCK', 'UNLOCK', 'MOVE', 'TRACE']
-  var capMethod = method.charAt(0) + method.substring(1).toLowerCase()
+  const method = source.method.toUpperCase();
+  const methods = [
+    'GET',
+    'POST',
+    'HEAD',
+    'DELETE',
+    'PATCH',
+    'PUT',
+    'OPTIONS',
+    'COPY',
+    'LOCK',
+    'UNLOCK',
+    'MOVE',
+    'TRACE',
+  ];
+  const capMethod = method.charAt(0) + method.substring(1).toLowerCase();
   if (methods.indexOf(method) < 0) {
-    code.push('class Net::HTTP::%s < Net::HTTPRequest', capMethod)
-        .push('  METHOD = \'%s\'', method.toUpperCase())
-        .push('  REQUEST_HAS_BODY = \'%s\'', source.postData.text ? 'true' : 'false')
-        .push('  RESPONSE_HAS_BODY = true')
-        .push('end')
-        .blank()
+    code
+      .push('class Net::HTTP::%s < Net::HTTPRequest', capMethod)
+      .push("  METHOD = '%s'", method.toUpperCase())
+      .push("  REQUEST_HAS_BODY = '%s'", source.postData.text ? 'true' : 'false')
+      .push('  RESPONSE_HAS_BODY = true')
+      .push('end')
+      .blank();
   }
 
-  code.push('url = URI("%s")', source.fullUrl)
-      .blank()
-      .push('http = Net::HTTP.new(url.host, url.port)')
+  code.push('url = URI("%s")', source.fullUrl).blank().push('http = Net::HTTP.new(url.host, url.port)');
 
   if (source.uriObj.protocol === 'https:') {
-    code.push('http.use_ssl = true')
+    code.push('http.use_ssl = true');
   }
 
-  code.blank()
-      .push('request = Net::HTTP::%s.new(url)', capMethod)
+  code.blank().push('request = Net::HTTP::%s.new(url)', capMethod);
 
-  var headers = Object.keys(source.allHeaders)
+  const headers = Object.keys(source.allHeaders);
   if (headers.length) {
     headers.forEach(function (key) {
-      code.push('request["%s"] = \'%s\'', key, source.allHeaders[key])
-    })
+      code.push('request["%s"] = \'%s\'', key, source.allHeaders[key]);
+    });
   }
 
   if (source.postData.text) {
-    code.push('request.body = %s', JSON.stringify(source.postData.text))
+    code.push('request.body = %s', JSON.stringify(source.postData.text));
   }
 
-  code.blank()
-      .push('response = http.request(request)')
-      .push('puts response.read_body')
+  code.blank().push('response = http.request(request)').push('puts response.read_body');
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'native',
   title: 'net::http',
   link: 'http://ruby-doc.org/stdlib-2.2.1/libdoc/net/http/rdoc/Net/HTTP.html',
-  description: 'Ruby HTTP client'
-}
+  description: 'Ruby HTTP client',
+};

package/src/targets/shell/curl.js

@@ -8,85 +8,150 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-var util = require('util')
-var helpers = require('../../helpers/shell')
-var 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) {
-  var opts = Object.assign({
+  const opts = {
     indent: '  ',
     short: false,
-    binary: false
-  }, options)
+    binary: false,
+    globOff: false,
+    escapeBrackets: false,
+    ...options,
+  };
+
+  const code = new CodeBuilder(opts.indent, opts.indent !== false ? ` \\\n${opts.indent}` : ' ');
 
-  var 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);
 
-  code.push('curl %s %s', opts.short ? '-X' : '--request', source.method)
-      .push(util.format('%s%s', opts.short ? '' : '--url ', helpers.quote(source.fullUrl)))
+  if (opts.escapeBrackets) {
+    formattedUrl = formattedUrl.replace(/\[/g, '\\[').replace(/\]/g, '\\]');
+  }
+
+  code.push('curl %s %s', requestOption, source.method);
+  if (opts.globOff) {
+    formattedUrl = unescape(formattedUrl);
+    code.push(globOption);
+  }
+  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) {
-    var 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.map(function (param) {
-        var 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.map(function (param) {
+        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) {
-        code.push(
-          '%s %s', opts.binary ? '--data-binary' : (opts.short ? '-d' : '--data'),
-          helpers.quote(source.postData.text)
-        )
+        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)) {
+          // If our postData is less than 20 characters, let's keep it all on one line so as to not make the snippet
+          // overly lengthy
+          if (source.postData.text.length > 20) {
+            try {
+              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;
+              code.push(
+                source.postData.text.indexOf("'") > 0 ? '%s @- <<EOF\n%s\nEOF' : "%s '\n%s\n'",
+                opts.binary ? '--data-binary' : opts.short ? '-d' : '--data',
+                JSON.stringify(jsonPayload, null, opts.indent)
+              );
+            } catch (err) {
+              // no-op
+            }
+          }
+        }
+
+        if (!builtPayload) {
+          code.push(
+            '%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/{helpers/shell.js → targets/shell/helpers.js}

@@ -1,6 +1,4 @@
-'use strict'
-
-var 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) {
-    var 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');
+  },
+};