@readme/httpsnippet 3.1.3 → 4.0.0

package/src/targets/ruby/native.js

@@ -1,71 +0,0 @@
-const CodeBuilder = require('../../helpers/code-builder');
-
-module.exports = function (source) {
-  const code = new CodeBuilder();
-
-  code.push("require 'uri'").push("require 'net/http'");
-
-  if (source.uriObj.protocol === 'https:') {
-    code.push("require 'openssl'");
-  }
-
-  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
-  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('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.blank().push('request = Net::HTTP::%s.new(url)', capMethod);
-
-  const headers = Object.keys(source.allHeaders);
-  if (headers.length) {
-    headers.forEach(function (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.blank().push('response = http.request(request)').push('puts response.read_body');
-
-  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',
-};

package/src/targets/shell/curl.js

@@ -1,157 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for the Shell using cURL.
- *
- * @author
- * @AhmadNassri
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-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 = {
-    indent: '  ',
-    short: false,
-    binary: false,
-    globOff: false,
-    escapeBrackets: false,
-    ...options,
-  };
-
-  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);
-
-  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');
-  }
-
-  // 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 = 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));
-  }
-
-  // construct post params
-  switch (source.postData.mimeType) {
-    case 'multipart/form-data':
-      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;
-
-    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(format('%s=%s', param.name, param.value))
-          );
-        });
-      } else {
-        code.push(
-          '%s %s',
-          opts.binary ? '--data-binary' : opts.short ? '-d' : '--data',
-          helpers.quote(source.postData.text)
-        );
-      }
-      break;
-
-    default:
-      // raw request body
-      if (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();
-};
-
-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',
-};

package/src/targets/shell/helpers.js

@@ -1,23 +0,0 @@
-const { format } = require('util');
-
-module.exports = {
-  /**
-   * Use 'strong quoting' using single quotes so that we only need
-   * to deal with nested single quote characters.
-   * http://wiki.bash-hackers.org/syntax/quoting#strong_quoting
-   */
-  quote: function (value) {
-    const safe = /^[a-z0-9-_/.@%^=:]+$/i;
-
-    // Unless `value` is a simple shell-safe string, quote it.
-    if (!safe.test(value)) {
-      return format("'%s'", value.replace(/'/g, "'\\''"));
-    }
-
-    return value;
-  },
-
-  escape: function (value) {
-    return value.replace(/\r/g, '\\r').replace(/\n/g, '\\n');
-  },
-};

package/src/targets/shell/httpie.js

@@ -1,129 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for the Shell using HTTPie.
- *
- * @author
- * @AhmadNassri
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const { format } = require('util');
-const shell = require('./helpers');
-const CodeBuilder = require('../../helpers/code-builder');
-
-module.exports = function (source, options) {
-  const opts = {
-    body: false,
-    cert: false,
-    headers: false,
-    indent: '  ',
-    pretty: false,
-    print: false,
-    queryParams: false,
-    short: false,
-    style: false,
-    timeout: false,
-    verbose: false,
-    verify: false,
-    ...options,
-  };
-
-  const code = new CodeBuilder(opts.indent, opts.indent !== false ? ` \\\n${opts.indent}` : ' ');
-
-  let raw = false;
-  const flags = [];
-
-  if (opts.headers) {
-    flags.push(opts.short ? '-h' : '--headers');
-  }
-
-  if (opts.body) {
-    flags.push(opts.short ? '-b' : '--body');
-  }
-
-  if (opts.verbose) {
-    flags.push(opts.short ? '-v' : '--verbose');
-  }
-
-  if (opts.print) {
-    flags.push(format('%s=%s', opts.short ? '-p' : '--print', opts.print));
-  }
-
-  if (opts.verify) {
-    flags.push(format('--verify=%s', opts.verify));
-  }
-
-  if (opts.cert) {
-    flags.push(format('--cert=%s', opts.cert));
-  }
-
-  if (opts.pretty) {
-    flags.push(format('--pretty=%s', opts.pretty));
-  }
-
-  if (opts.style) {
-    flags.push(format('--style=%s', opts.pretty));
-  }
-
-  if (opts.timeout) {
-    flags.push(format('--timeout=%s', opts.timeout));
-  }
-
-  // construct query params
-  if (opts.queryParams) {
-    const queryStringKeys = Object.keys(source.queryObj);
-
-    queryStringKeys.forEach(function (name) {
-      const value = source.queryObj[name];
-
-      if (Array.isArray(value)) {
-        value.forEach(function (val) {
-          code.push('%s==%s', name, shell.quote(val));
-        });
-      } else {
-        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]));
-    });
-
-  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');
-
-      source.postData.params.forEach(function (param) {
-        code.push('%s=%s', param.name, shell.quote(param.value));
-      });
-    }
-  } else {
-    raw = true;
-  }
-
-  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));
-  }
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'httpie',
-  title: 'HTTPie',
-  link: 'http://httpie.org/',
-  description: 'a CLI, cURL-like tool for humans',
-};

package/src/targets/shell/index.js

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

package/src/targets/shell/wget.js

@@ -1,52 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for the Shell using Wget.
- *
- * @author
- * @AhmadNassri
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const { format } = require('util');
-const helpers = require('./helpers');
-const CodeBuilder = require('../../helpers/code-builder');
-
-module.exports = function (source, options) {
-  const opts = {
-    indent: '  ',
-    short: false,
-    verbose: false,
-    ...options,
-  };
-
-  const code = new CodeBuilder(opts.indent, opts.indent !== false ? ` \\\n${opts.indent}` : ' ');
-
-  if (opts.verbose) {
-    code.push('wget %s', opts.short ? '-v' : '--verbose');
-  } else {
-    code.push('wget %s', opts.short ? '-q' : '--quiet');
-  }
-
-  code.push('--method %s', helpers.quote(source.method));
-
-  Object.keys(source.allHeaders).forEach(function (key) {
-    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(opts.short ? '-O' : '--output-document').push('- %s', helpers.quote(source.fullUrl));
-
-  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',
-};

package/src/targets/swift/helpers.js

@@ -1,93 +0,0 @@
-const { format } = require('util');
-
-/**
- * Create an string of given length filled with blank spaces
- *
- * @param {number} length Length of the array to return
- * @param {string} str String to pad out with
- * @return {string}
- */
-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}` : ', ';
-
-  if (pretty) {
-    return `[\n${currentIndent}${arr.join(join)}\n${closingBraceIndent}]`;
-  }
-
-  return `[${arr.join(join)}]`;
-}
-
-module.exports = {
-  /**
-   * Create a string corresponding to a valid declaration and initialization of a Swift array or dictionary literal
-   *
-   * @param {string} name Desired name of the instance
-   * @param {Object} parameters Key-value object of parameters to translate to a Swift object litearal
-   * @param {Object} opts Target options
-   * @return {string}
-   */
-  literalDeclaration: function (name, parameters, opts) {
-    return format('let %s = %s', name, this.literalRepresentation(parameters, opts));
-  },
-
-  /**
-   * Create a valid Swift string of a literal value according to its type.
-   *
-   * @param {*} value Any JavaScript literal
-   * @param {Object} opts Target options
-   * @return {string}
-   */
-  literalRepresentation: function (value, opts, indentLevel) {
-    // eslint-disable-next-line no-param-reassign
-    indentLevel = indentLevel === undefined ? 1 : indentLevel + 1;
-
-    switch (Object.prototype.toString.call(value)) {
-      case '[object Number]':
-        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);
-      }
-
-      case '[object Object]': {
-        const keyValuePairs = [];
-        // eslint-disable-next-line guard-for-in, no-restricted-syntax
-        for (const k in value) {
-          keyValuePairs.push(format('"%s": %s', k, this.literalRepresentation(value[k], opts, indentLevel)));
-        }
-        return concatArray(keyValuePairs, opts.pretty && keyValuePairs.length > 1, opts.indent, indentLevel);
-      }
-
-      case '[object Boolean]':
-        return value.toString();
-
-      default:
-        if (value === null || value === undefined) {
-          return '';
-        }
-        return `"${value.toString().replace(/"/g, '\\"')}"`;
-    }
-  },
-};

package/src/targets/swift/index.js

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