@readme/httpsnippet 3.1.1 → 4.0.0

package/src/index.js

@@ -1,361 +0,0 @@
-const es = require('event-stream');
-const MultiPartForm = require('form-data');
-const qs = require('qs');
-const reducer = require('./helpers/reducer');
-const helpers = require('./helpers/headers');
-const targets = require('./targets');
-const url = require('url');
-const validate = require('har-validator/lib/async');
-
-const { formDataIterator, isBlob } = require('./helpers/form-data');
-
-// constructor
-const HTTPSnippet = function (data, opts = {}) {
-  let entries;
-  const self = this;
-  const input = { ...data };
-
-  const options = {
-    harIsAlreadyEncoded: false,
-    ...opts,
-  };
-
-  // prep the main container
-  self.requests = [];
-
-  // is it har?
-  if (input.log && input.log.entries) {
-    entries = input.log.entries;
-  } else {
-    entries = [
-      {
-        request: input,
-      },
-    ];
-  }
-
-  entries.forEach(function (entry) {
-    const request = { ...entry.request };
-
-    // add optional properties to make validation successful
-    request.httpVersion = request.httpVersion || 'HTTP/1.1';
-    request.queryString = request.queryString || [];
-    request.headers = request.headers || [];
-    request.cookies = request.cookies || [];
-    request.postData = request.postData || {};
-    request.postData.mimeType = request.postData.mimeType || 'application/octet-stream';
-
-    request.bodySize = 0;
-    request.headersSize = 0;
-    request.postData.size = 0;
-
-    validate.request(request, function (err, valid) {
-      if (!valid) {
-        throw err;
-      }
-
-      self.requests.push(self.prepare(request, options));
-    });
-  });
-};
-
-HTTPSnippet.prototype.prepare = function (request, options) {
-  // construct utility properties
-  request.queryObj = {};
-  request.headersObj = {};
-  request.cookiesObj = {};
-  request.allHeaders = {};
-  request.postData.jsonObj = false;
-  request.postData.paramsObj = false;
-
-  // construct query objects
-  if (request.queryString && request.queryString.length) {
-    request.queryObj = request.queryString.reduce(reducer, {});
-  }
-
-  // construct headers objects
-  if (request.headers && request.headers.length) {
-    const http2VersionRegex = /^HTTP\/2/;
-    request.headersObj = request.headers.reduce(function (headers, header) {
-      let headerName = header.name;
-      if (request.httpVersion.match(http2VersionRegex)) {
-        headerName = headerName.toLowerCase();
-      }
-
-      // eslint-disable-next-line no-param-reassign
-      headers[headerName] = header.value;
-      return headers;
-    }, {});
-  }
-
-  // construct headers objects
-  if (request.cookies && request.cookies.length) {
-    request.cookiesObj = request.cookies.reduceRight(function (cookies, cookie) {
-      // eslint-disable-next-line no-param-reassign
-      cookies[cookie.name] = cookie.value;
-      return cookies;
-    }, {});
-  }
-
-  // construct Cookie header
-  const cookies = request.cookies.map(function (cookie) {
-    if (options.harIsAlreadyEncoded) {
-      return `${cookie.name}=${cookie.value}`;
-    }
-
-    return `${encodeURIComponent(cookie.name)}=${encodeURIComponent(cookie.value)}`;
-  });
-
-  if (cookies.length) {
-    request.allHeaders.cookie = cookies.join('; ');
-  }
-
-  switch (request.postData.mimeType) {
-    case 'multipart/mixed':
-    case 'multipart/related':
-    case 'multipart/form-data':
-    case 'multipart/alternative':
-      // reset values
-      request.postData.text = '';
-      request.postData.mimeType = 'multipart/form-data';
-
-      if (request.postData.params) {
-        const form = new MultiPartForm();
-
-        // The `form-data` module returns one of two things: a native FormData object, or its own polyfill. Since the
-        // polyfill does not support the full API of the native FormData object, when this library is running in a
-        // browser environment it'll fail on two things:
-        //
-        //  - The API for `form.append()` has three arguments and the third should only be present when the second is a
-        //    Blob or USVString.
-        //  - `FormData.pipe()` isn't a function.
-        //
-        // Since the native FormData object is iterable, we easily detect what version of `form-data` we're working
-        // with here to allow `multipart/form-data` requests to be compiled under both browser and Node environments.
-        //
-        // This hack is pretty awful but it's the only way we can use this library in the browser as if we code this
-        // against just the native FormData object, we can't polyfill that back into Node because Blob and File objects,
-        // which something like `formdata-polyfill` requires, don't exist there.
-        const isNativeFormData = typeof form[Symbol.iterator] === 'function';
-
-        // easter egg
-        const boundary = '---011000010111000001101001';
-        if (!isNativeFormData) {
-          form._boundary = boundary;
-        }
-
-        request.postData.params.forEach(function (param) {
-          const name = param.name;
-          const value = param.value || '';
-          const filename = param.fileName || null;
-
-          if (isNativeFormData) {
-            if (isBlob(value)) {
-              form.append(name, value, filename);
-            } else {
-              form.append(name, value);
-            }
-          } else {
-            form.append(name, value, {
-              filename: filename,
-              contentType: param.contentType || null,
-            });
-          }
-        });
-
-        if (isNativeFormData) {
-          // eslint-disable-next-line no-restricted-syntax
-          for (const data of formDataIterator(form, boundary)) {
-            request.postData.text += data;
-          }
-        } else {
-          form.pipe(
-            // eslint-disable-next-line array-callback-return
-            es.map(function (data) {
-              request.postData.text += data;
-            })
-          );
-        }
-
-        request.postData.boundary = boundary;
-
-        // Since headers are case-sensitive we need to see if there's an existing `Content-Type` header that we can
-        // override.
-        const contentTypeHeader = helpers.hasHeader(request.headersObj, 'content-type')
-          ? helpers.getHeaderName(request.headersObj, 'content-type')
-          : 'content-type';
-
-        request.headersObj[contentTypeHeader] = `multipart/form-data; boundary=${boundary}`;
-      }
-      break;
-
-    case 'application/x-www-form-urlencoded':
-      if (!request.postData.params) {
-        request.postData.text = '';
-      } else {
-        request.postData.paramsObj = request.postData.params.reduce(reducer, {});
-
-        // always overwrite
-        request.postData.text = qs.stringify(request.postData.paramsObj);
-      }
-      break;
-
-    case 'text/json':
-    case 'text/x-json':
-    case 'application/json':
-    case 'application/x-json':
-      request.postData.mimeType = 'application/json';
-
-      if (request.postData.text) {
-        try {
-          request.postData.jsonObj = JSON.parse(request.postData.text);
-        } catch (e) {
-          // force back to text/plain
-          // if headers have proper content-type value, then this should also work
-          request.postData.mimeType = 'text/plain';
-        }
-      }
-      break;
-
-    default:
-    // no-op
-  }
-
-  // create allHeaders object
-  request.allHeaders = Object.assign(request.allHeaders, request.headersObj);
-
-  // deconstruct the uri
-  // eslint-disable-next-line node/no-deprecated-api
-  request.uriObj = url.parse(request.url, true, true);
-
-  // merge all possible queryString values
-  request.queryObj = Object.assign(request.queryObj, request.uriObj.query);
-
-  // reset uriObj values for a clean url
-  request.uriObj.query = null;
-  request.uriObj.search = null;
-  request.uriObj.path = request.uriObj.pathname;
-
-  // keep the base url clean of queryString
-  request.url = url.format(request.uriObj);
-
-  // update the uri object
-  request.uriObj.query = request.queryObj;
-  if (options.harIsAlreadyEncoded) {
-    request.uriObj.search = qs.stringify(request.queryObj, {
-      encode: false,
-      indices: false,
-    });
-  } else {
-    request.uriObj.search = qs.stringify(request.queryObj, {
-      indices: false,
-    });
-  }
-
-  if (request.uriObj.search) {
-    request.uriObj.path = `${request.uriObj.pathname}?${request.uriObj.search}`;
-  }
-
-  // construct a full url
-  request.fullUrl = url.format(request.uriObj);
-
-  return request;
-};
-
-HTTPSnippet.prototype.convert = function (target, client, opts) {
-  if (!opts && client) {
-    // eslint-disable-next-line no-param-reassign
-    opts = client;
-  }
-
-  const func = this._matchTarget(target, client);
-  if (func) {
-    const results = this.requests.map(function (request) {
-      return func(request, opts);
-    });
-
-    return results.length === 1 ? results[0] : results;
-  }
-
-  return false;
-};
-
-HTTPSnippet.prototype._matchTarget = function (target, client) {
-  // does it exist?
-  // eslint-disable-next-line no-prototype-builtins
-  if (!targets.hasOwnProperty(target)) {
-    return false;
-  }
-
-  // shorthand
-  if (typeof client === 'string' && typeof targets[target][client] === 'function') {
-    return targets[target][client];
-  }
-
-  // default target
-  return targets[target][targets[target].info.default];
-};
-
-// exports
-module.exports = HTTPSnippet;
-
-module.exports.addTarget = function (target) {
-  if (!('info' in target)) {
-    throw new Error('The supplied custom target must contain an `info` object.');
-  } else if (
-    !('key' in target.info) ||
-    !('title' in target.info) ||
-    !('extname' in target.info) ||
-    !('default' in target.info)
-  ) {
-    throw new Error(
-      'The supplied custom target must have an `info` object with a `key`, `title`, `extname`, and `default` property.'
-    );
-    // eslint-disable-next-line no-prototype-builtins
-  } else if (targets.hasOwnProperty(target.info.key)) {
-    throw new Error('The supplied custom target already exists.');
-  } else if (Object.keys(target).length === 1) {
-    throw new Error('A custom target must have a client defined on it.');
-  }
-
-  targets[target.info.key] = target;
-};
-
-module.exports.addTargetClient = function (target, client) {
-  // eslint-disable-next-line no-prototype-builtins
-  if (!targets.hasOwnProperty(target)) {
-    throw new Error(`Sorry, but no ${target} target exists to add clients to.`);
-  } else if (!('info' in client)) {
-    throw new Error('The supplied custom target client must contain an `info` object.');
-  } else if (!('key' in client.info) || !('title' in client.info)) {
-    throw new Error('The supplied custom target client must have an `info` object with a `key` and `title` property.');
-    // eslint-disable-next-line no-prototype-builtins
-  } else if (targets[target].hasOwnProperty(client.info.key)) {
-    throw new Error('The supplied custom target client already exists, please use a different key');
-  }
-
-  targets[target][client.info.key] = client;
-};
-
-module.exports.availableTargets = function () {
-  return Object.keys(targets).map(function (key) {
-    const target = { ...targets[key].info };
-    const clients = Object.keys(targets[key])
-      .filter(function (prop) {
-        return !['info', 'index'].includes(prop);
-      })
-      .map(function (client) {
-        return targets[key][client].info;
-      });
-
-    if (clients.length) {
-      target.clients = clients;
-    }
-
-    return target;
-  });
-};
-
-module.exports.extname = function (target) {
-  return targets[target] ? targets[target].info.extname : '';
-};

package/src/targets/c/index.js

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

package/src/targets/c/libcurl.js

@@ -1,45 +0,0 @@
-const CodeBuilder = require('../../helpers/code-builder');
-
-module.exports = function (source) {
-  const code = new CodeBuilder();
-
-  code
-    .push('CURL *hnd = curl_easy_init();')
-    .blank()
-    .push('curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "%s");', source.method.toUpperCase())
-    .push('curl_easy_setopt(hnd, CURLOPT_URL, "%s");', source.fullUrl);
-
-  // Add headers, including the cookies
-  const headers = Object.keys(source.headersObj);
-
-  // construct headers
-  if (headers.length) {
-    code.blank().push('struct curl_slist *headers = NULL;');
-
-    headers.forEach(function (key) {
-      code.push('headers = curl_slist_append(headers, "%s: %s");', key, source.headersObj[key]);
-    });
-
-    code.push('curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);');
-  }
-
-  // construct cookies
-  if (source.allHeaders.cookie) {
-    code.blank().push('curl_easy_setopt(hnd, CURLOPT_COOKIE, "%s");', source.allHeaders.cookie);
-  }
-
-  if (source.postData.text) {
-    code.blank().push('curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, %s);', JSON.stringify(source.postData.text));
-  }
-
-  code.blank().push('CURLcode ret = curl_easy_perform(hnd);');
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'libcurl',
-  title: 'Libcurl',
-  link: 'http://curl.haxx.se/libcurl/',
-  description: 'Simple REST and HTTP API Client for C',
-};

package/src/targets/clojure/clj_http.js

@@ -1,176 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for Clojure using clj-http.
- *
- * @author
- * @tggreene
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const CodeBuilder = require('../../helpers/code-builder');
-const helpers = require('../../helpers/headers');
-
-const Keyword = function (name) {
-  this.name = name;
-};
-
-Keyword.prototype.toString = function () {
-  return `:${this.name}`;
-};
-
-const File = function (path) {
-  this.path = path;
-};
-
-File.prototype.toString = function () {
-  return `(clojure.java.io/file "${this.path}")`;
-};
-
-const jsType = function (x) {
-  return typeof x !== 'undefined' ? x.constructor.name.toLowerCase() : null;
-};
-
-const objEmpty = function (x) {
-  return jsType(x) === 'object' ? Object.keys(x).length === 0 : false;
-};
-
-const filterEmpty = function (m) {
-  Object.keys(m)
-    .filter(function (x) {
-      return objEmpty(m[x]);
-    })
-    .forEach(function (x) {
-      // eslint-disable-next-line no-param-reassign
-      delete m[x];
-    });
-
-  return m;
-};
-
-const padBlock = function (x, s) {
-  // eslint-disable-next-line prefer-spread
-  const padding = Array.apply(null, new Array(x))
-    .map(function () {
-      return ' ';
-    })
-    .join('');
-
-  return s.replace(/\n/g, `\n${padding}`);
-};
-
-const jsToEdn = function (js) {
-  switch (jsType(js)) {
-    case 'string':
-      return `"${js.replace(/"/g, '\\"')}"`;
-    case 'file':
-      return js.toString();
-    case 'keyword':
-      return js.toString();
-    case 'null':
-      return 'nil';
-    case 'regexp':
-      return `#"${js.source}"`;
-
-    // simple vertical format
-    case 'object': {
-      const obj = Object.keys(js)
-        .reduce(function (acc, key) {
-          const val = padBlock(key.length + 2, jsToEdn(js[key]));
-          return `${acc}:${key} ${val}\n `;
-        }, '')
-        .trim();
-      return `{${padBlock(1, obj)}}`;
-    }
-
-    // simple horizontal format
-    case 'array': {
-      const arr = js
-        .reduce(function (acc, val) {
-          return `${acc} ${jsToEdn(val)}`;
-        }, '')
-        .trim();
-      return `[${padBlock(1, arr)}]`;
-    }
-
-    // 'number' 'boolean'
-    default:
-      return js.toString();
-  }
-};
-
-module.exports = function (source, options) {
-  const code = new CodeBuilder(options);
-  const methods = ['get', 'post', 'put', 'delete', 'patch', 'head', 'options'];
-
-  if (methods.indexOf(source.method.toLowerCase()) === -1) {
-    return code.push('Method not supported').join();
-  }
-
-  const params = {
-    headers: source.allHeaders,
-    'query-params': source.queryObj,
-  };
-
-  // eslint-disable-next-line default-case
-  switch (source.postData.mimeType) {
-    case 'application/json':
-      params['content-type'] = new Keyword('json');
-      params['form-params'] = source.postData.jsonObj;
-      delete params.headers[helpers.getHeaderName(params.headers, 'content-type')];
-      break;
-    case 'application/x-www-form-urlencoded':
-      params['form-params'] = source.postData.paramsObj;
-      delete params.headers[helpers.getHeaderName(params.headers, 'content-type')];
-      break;
-    case 'text/plain':
-      params.body = source.postData.text;
-      delete params.headers[helpers.getHeaderName(params.headers, 'content-type')];
-      break;
-    case 'multipart/form-data':
-      if (source.postData.params) {
-        params.multipart = source.postData.params.map(function (x) {
-          if (x.fileName && !x.value) {
-            return {
-              name: x.name,
-              content: new File(x.fileName),
-            };
-          }
-
-          return {
-            name: x.name,
-            content: x.value,
-          };
-        });
-        delete params.headers[helpers.getHeaderName(params.headers, 'content-type')];
-      }
-      break;
-  }
-
-  if (helpers.getHeader(params.headers, 'accept') === 'application/json') {
-    params.accept = new Keyword('json');
-    delete params.headers[helpers.getHeaderName(params.headers, 'accept')];
-  }
-
-  code.push("(require '[clj-http.client :as client])\n");
-
-  if (objEmpty(filterEmpty(params))) {
-    code.push('(client/%s "%s")', source.method.toLowerCase(), source.url);
-  } else {
-    code.push(
-      '(client/%s "%s" %s)',
-      source.method.toLowerCase(),
-      source.url,
-      padBlock(11 + source.method.length + source.url.length, jsToEdn(filterEmpty(params)))
-    );
-  }
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'clj_http',
-  title: 'clj-http',
-  link: 'https://github.com/dakrone/clj-http',
-  description: 'An idiomatic clojure http client wrapping the apache client.',
-};

package/src/targets/clojure/index.js

@@ -1,10 +0,0 @@
-module.exports = {
-  info: {
-    key: 'clojure',
-    title: 'Clojure',
-    extname: '.clj',
-    default: 'clj_http',
-  },
-
-  clj_http: require('./clj_http'),
-};