@readme/httpsnippet 3.1.3 → 4.0.0

package/src/targets/php/http2.js

@@ -1,131 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for PHP using curl-ext.
- *
- * @author
- * @AhmadNassri
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const helpers = require('./helpers');
-const headerHelpers = require('../../helpers/headers');
-const CodeBuilder = require('../../helpers/code-builder');
-
-module.exports = function (source, options) {
-  const opts = {
-    closingTag: false,
-    indent: '  ',
-    noTags: false,
-    shortTags: false,
-    ...options,
-  };
-
-  const code = new CodeBuilder(opts.indent);
-  let hasBody = false;
-
-  if (!opts.noTags) {
-    code.push(opts.shortTags ? '<?' : '<?php').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;')
-        .push('$body->append(new http\\QueryString(%s));', helpers.convert(source.postData.paramsObj, opts.indent))
-        .blank();
-      hasBody = true;
-      break;
-
-    case 'multipart/form-data': {
-      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();
-
-        hasBody = true;
-      }
-      break;
-    }
-
-    default:
-      if (source.postData.text) {
-        code
-          .push('$body = new http\\Message\\Body;')
-          .push('$body->append(%s);', helpers.convert(source.postData.text))
-          .blank();
-        hasBody = true;
-      }
-  }
-
-  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();
-  }
-
-  if (Object.keys(source.queryObj).length) {
-    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();
-  }
-
-  if (Object.keys(source.cookiesObj).length) {
-    code.blank().push('$client->setCookies(%s);', helpers.convert(source.cookiesObj, opts.indent)).blank();
-  }
-
-  code
-    .push('$client->enqueue($request)->send();')
-    .push('$response = $client->getResponse();')
-    .blank()
-    .push('echo $response->getBody();');
-
-  if (!opts.noTags && opts.closingTag) {
-    code.blank().push('?>');
-  }
-
-  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',
-};

package/src/targets/php/index.js

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

package/src/targets/powershell/common.js

@@ -1,60 +0,0 @@
-const CodeBuilder = require('../../helpers/code-builder');
-const helpers = require('../../helpers/headers');
-
-module.exports = function (command) {
-  return function (source) {
-    const code = new CodeBuilder();
-    const methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'];
-
-    if (!methods.includes(source.method.toUpperCase())) {
-      return 'Method not supported';
-    }
-
-    const commandOptions = [];
-
-    // Add headers, including the cookies
-    const 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 '${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();
-  };
-};

package/src/targets/powershell/index.js

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

package/src/targets/powershell/restmethod.js

@@ -1,8 +0,0 @@
-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',
-};

package/src/targets/powershell/webrequest.js

@@ -1,8 +0,0 @@
-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',
-};

package/src/targets/python/helpers.js

@@ -1,85 +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 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}`;
-  }
-
-  return openingBrace + values.join(join) + closingBrace;
-}
-
-module.exports = {
-  /**
-   * Create a valid Python 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]': {
-        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 = [];
-        // 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 concatValues('object', keyValuePairs, opts.pretty && keyValuePairs.length > 1, opts.indent, indentLevel);
-      }
-
-      case '[object Null]':
-        return 'None';
-
-      case '[object Boolean]':
-        return value ? 'True' : 'False';
-
-      default:
-        if (value === null || value === undefined) {
-          return '';
-        }
-        return `"${value.toString().replace(/"/g, '\\"')}"`;
-    }
-  },
-};

package/src/targets/python/index.js

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

package/src/targets/python/requests.js

@@ -1,163 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for Python using Requests
- *
- * @author
- * @montanaflynn
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const { format } = require('util');
-const CodeBuilder = require('../../helpers/code-builder');
-const helpers = require('./helpers');
-const headerHelpers = require('../../helpers/headers');
-
-module.exports = function (source, options) {
-  const opts = {
-    indent: '    ',
-    pretty: true,
-    ...options,
-  };
-
-  // Start snippet
-  const code = new CodeBuilder(opts.indent);
-
-  // Import requests
-  code.push('import requests').blank();
-
-  // Set URL
-  code.push('url = "%s"', source.fullUrl).blank();
-
-  const headers = source.allHeaders;
-
-  // Construct payload
-  let payload;
-  let hasFiles = false;
-  let hasPayload = false;
-  let jsonPayload = false;
-  switch (source.postData.mimeType) {
-    case 'application/json':
-      if (source.postData.jsonObj) {
-        code.push('payload = %s', helpers.literalRepresentation(source.postData.jsonObj, opts));
-        jsonPayload = true;
-        hasPayload = true;
-      }
-      break;
-
-    case 'multipart/form-data':
-      if (source.postData.params) {
-        const files = {};
-        payload = {};
-
-        source.postData.params.forEach(p => {
-          if (p.fileName) {
-            files[p.name] = `open('${p.fileName}', 'rb')`;
-            hasFiles = true;
-          } else {
-            payload[p.name] = p.value;
-            hasPayload = true;
-          }
-        });
-
-        if (hasFiles) {
-          code.push('files = %s', helpers.literalRepresentation(files, opts));
-
-          if (hasPayload) {
-            code.push('payload = %s', helpers.literalRepresentation(payload, opts));
-          }
-
-          // The requests library will only automatically add a `multipart/form-data` header if
-          // there are files being sent. If we're **only** sending form data we still need to send
-          // the boundary ourselves.
-          delete headers[headerHelpers.getHeaderName(headers, 'content-type')];
-        } else {
-          payload = JSON.stringify(source.postData.text);
-          if (payload) {
-            code.push('payload = %s', payload);
-            hasPayload = true;
-          }
-        }
-      }
-      break;
-
-    default:
-      payload = JSON.stringify(source.postData.text);
-      if (payload) {
-        code.push('payload = %s', payload);
-        hasPayload = true;
-      }
-  }
-
-  // Construct headers
-  const headerCount = Object.keys(headers).length;
-
-  if (!headerCount && (hasPayload || hasFiles)) {
-    // If we don't have any heads but we do have a payload we should put a blank line here between
-    // that payload consturction and our execution of the requests library.
-    code.blank();
-  } else if (headerCount === 1) {
-    Object.keys(headers).forEach(header => {
-      code.push('headers = {"%s": "%s"}', header, headers[header]).blank();
-    });
-  } else if (headerCount > 1) {
-    let count = 1;
-
-    code.push('headers = {');
-
-    Object.keys(headers).forEach(header => {
-      // eslint-disable-next-line no-plusplus
-      if (count++ !== headerCount) {
-        code.push(1, '"%s": "%s",', header, headers[header]);
-      } else {
-        code.push(1, '"%s": "%s"', header, headers[header]);
-      }
-    });
-
-    code.push('}').blank();
-  }
-
-  // Construct request
-  const method = source.method;
-  let request;
-  // Method list pulled from their api reference https://docs.python-requests.org/en/latest/api/#requests.head
-  if (['HEAD', 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'].includes(method)) {
-    request = format('response = requests.%s(url', method.toLowerCase());
-  } else {
-    request = format('response = requests.request("%s", url', method);
-  }
-
-  if (hasPayload) {
-    if (jsonPayload) {
-      request += ', json=payload';
-    } else {
-      request += ', data=payload';
-    }
-  }
-
-  if (hasFiles) {
-    request += ', files=files';
-  }
-
-  if (headerCount > 0) {
-    request += ', headers=headers';
-  }
-
-  request += ')';
-
-  code.push(request).blank().push('print(response.text)');
-
-  return (
-    code
-      .join()
-      // The `open()` call must be a literal in the code snippet.
-      .replace(/"open\('(.+)', 'rb'\)"/g, 'open("$1", "rb")')
-  );
-};
-
-module.exports.info = {
-  key: 'requests',
-  title: 'Requests',
-  link: 'http://docs.python-requests.org/en/latest/api/#requests.request',
-  description: 'Requests HTTP library',
-};

package/src/targets/r/httr.js

@@ -1,134 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for R using httr
- *
- * @author
- * @gabrielakoreeda
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const { format } = require('util');
-const CodeBuilder = require('../../helpers/code-builder');
-
-module.exports = function (source) {
-  // Start snippet
-  const code = new CodeBuilder();
-
-  // Import httr
-  code.push('library(httr)').blank();
-
-  // Set URL
-  code.push('url <- "%s"', source.url).blank();
-
-  // Construct query string
-  const qs = source.queryObj;
-  // eslint-disable-next-line no-param-reassign
-  delete source.queryObj.key;
-
-  const queryCount = Object.keys(qs).length;
-  if (queryCount === 1) {
-    code.push('queryString <- list(%s = "%s")', Object.keys(qs), Object.values(qs).toString()).blank();
-  } else if (queryCount > 1) {
-    code.push('queryString <- list(');
-
-    Object.keys(qs).forEach((query, i) => {
-      if (i !== queryCount - 1) {
-        code.push('  %s = "%s",', query, qs[query].toString());
-      } else {
-        code.push('  %s = "%s"', query, qs[query].toString());
-      }
-    });
-
-    code.push(')').blank();
-  }
-
-  // Construct payload
-  const payload = JSON.stringify(source.postData.text);
-
-  if (payload) {
-    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;
-
-      case 'application/json':
-        code.push('encode <- "json"').blank();
-        break;
-
-      case 'multipart/form-data':
-        code.push('encode <- "multipart"').blank();
-        break;
-
-      default:
-        code.push('encode <- "raw"').blank();
-        break;
-    }
-  }
-
-  // Construct headers
-  const headers = [];
-  let cookies;
-  let accept;
-
-  Object.keys(source.allHeaders).forEach(header => {
-    if (header.toLowerCase() === 'accept') {
-      accept = `, accept("${source.allHeaders[header]}")`;
-    } else if (header.toLowerCase() === 'cookie') {
-      cookies = `, set_cookies(\`${source.allHeaders[header]
-        .replace(/;/g, '", `')
-        .replace(/` /g, '`')
-        .replace(/=/g, '` = "')}")`;
-    } else if (header.toLowerCase() !== 'content-type') {
-      headers.push(`'${header}' = '${source.allHeaders[header]}'`);
-    }
-  });
-
-  // Construct request
-  const method = source.method;
-  let request = format('response <- VERB("%s", url', method);
-
-  if (payload) {
-    request += ', body = payload';
-  }
-
-  if (headers.length) {
-    request += `, add_headers(${headers.join(', ')})`;
-  }
-
-  if (source.queryString.length) {
-    request += ', query = queryString';
-  }
-
-  request += `, content_type("${source.postData.mimeType}")`;
-
-  if (typeof accept !== 'undefined') {
-    request += accept;
-  }
-
-  if (typeof cookies !== 'undefined') {
-    request += cookies;
-  }
-
-  if (source.postData.text || source.postData.jsonObj || source.postData.params) {
-    request += ', encode = encode';
-  }
-
-  request += ')';
-
-  code.push(request).blank().push('content(response, "text")');
-
-  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',
-};

package/src/targets/r/index.js

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

package/src/targets/ruby/index.js

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