@readme/httpsnippet 3.1.3 → 4.0.2

package/src/targets/node/fetch.js

@@ -1,145 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for Node.js using node-fetch.
- *
- * @author
- * @hirenoble
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const headerHelpers = require('../../helpers/headers');
-const stringifyObject = require('stringify-object');
-const CodeBuilder = require('../../helpers/code-builder');
-
-module.exports = function (source, options) {
-  const opts = {
-    indent: '  ',
-    ...options,
-  };
-
-  let includeFS = false;
-  const code = new CodeBuilder(opts.indent);
-
-  code.push("const fetch = require('node-fetch');");
-  const url = source.fullUrl;
-  const reqOpts = {
-    method: source.method,
-  };
-
-  if (Object.keys(source.allHeaders).length) {
-    reqOpts.headers = source.allHeaders;
-  }
-
-  switch (source.postData.mimeType) {
-    case 'application/x-www-form-urlencoded':
-      code.unshift("const { URLSearchParams } = require('url');");
-      code.push('const encodedParams = new URLSearchParams();');
-      code.blank();
-
-      source.postData.params.forEach(function (param) {
-        code.push(`encodedParams.set('${param.name}', '${param.value}');`);
-      });
-
-      reqOpts.body = 'encodedParams';
-      break;
-
-    case 'application/json':
-      if (source.postData.jsonObj) {
-        reqOpts.body = source.postData.jsonObj;
-      }
-      break;
-
-    case 'multipart/form-data':
-      if (source.postData.params) {
-        // The `form-data` library automatically adds a `Content-Type` header for
-        // `multipart/form-data` content and if we add our own here, data won't be correctly
-        // transferred.
-        if (reqOpts.headers) {
-          const contentTypeHeader = headerHelpers.getHeaderName(reqOpts.headers, 'content-type');
-          if (contentTypeHeader) {
-            delete reqOpts.headers[contentTypeHeader];
-          }
-        }
-
-        code.unshift("const FormData = require('form-data');");
-        code.push('const formData = new FormData();');
-        code.blank();
-
-        source.postData.params.forEach(function (param) {
-          if (!param.fileName && !param.contentType) {
-            code.push(`formData.append('${param.name}', '${param.value}');`);
-            return;
-          }
-
-          if (param.fileName) {
-            includeFS = true;
-            code.push(`formData.append('${param.name}', fs.createReadStream('${param.fileName}'));`);
-          }
-        });
-      }
-      break;
-
-    default:
-      if (source.postData.text) {
-        reqOpts.body = source.postData.text;
-      }
-  }
-
-  // If we ultimately don't have any headers to send then we shouldn't add an empty object into
-  // the request options.
-  if (reqOpts.headers && !Object.keys(reqOpts.headers).length) {
-    delete reqOpts.headers;
-  }
-
-  code.blank();
-  code.push(`const url = '${url}';`);
-  code
-    .push(
-      'const options = %s;',
-      stringifyObject(reqOpts, {
-        indent: opts.indent,
-        inlineCharacterLimit: 80,
-
-        // The Fetch API body only accepts string parameters, but stringified JSON can be difficult to
-        // read, so we keep the object as a literal and use this transform function to wrap the literal
-        // in a `JSON.stringify` call.
-        transform: (object, property, originalResult) => {
-          if (property === 'body' && source.postData.mimeType === 'application/json') {
-            return `JSON.stringify(${originalResult})`;
-          }
-
-          return originalResult;
-        },
-      })
-    )
-    .blank();
-
-  if (includeFS) {
-    code.unshift("const fs = require('fs');");
-  }
-
-  if (source.postData.mimeType === 'multipart/form-data') {
-    if (source.postData.params) {
-      code.push('options.body = formData;').blank();
-    }
-  }
-
-  code
-    .push('fetch(url, options)')
-    .push(1, '.then(res => res.json())')
-    .push(1, '.then(json => console.log(json))')
-    .push(1, ".catch(err => console.error('error:' + err));");
-
-  return code
-    .join()
-    .replace(/'encodedParams'/, 'encodedParams')
-    .replace(/"fs\.createReadStream\(\\"(.+)\\"\)"/, 'fs.createReadStream("$1")');
-};
-
-module.exports.info = {
-  key: 'fetch',
-  title: 'Fetch',
-  link: 'https://github.com/bitinn/node-fetch',
-  description: 'Simplified HTTP node-fetch client',
-};

package/src/targets/node/index.js

@@ -1,15 +0,0 @@
-module.exports = {
-  info: {
-    key: 'node',
-    title: 'Node.js',
-    extname: '.js',
-    default: 'native',
-    cli: 'node %s',
-  },
-
-  native: require('./native'),
-  request: require('./request'),
-  unirest: require('./unirest'),
-  axios: require('./axios'),
-  fetch: require('./fetch'),
-};

package/src/targets/node/native.js

@@ -1,92 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for native Node.js.
- *
- * @author
- * @AhmadNassri
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const stringifyObject = require('stringify-object');
-const CodeBuilder = require('../../helpers/code-builder');
-
-module.exports = function (source, options) {
-  const opts = {
-    indent: '  ',
-    ...options,
-  };
-
-  const code = new CodeBuilder(opts.indent);
-
-  const reqOpts = {
-    method: source.method,
-    hostname: source.uriObj.hostname,
-    port: source.uriObj.port,
-    path: source.uriObj.path,
-    headers: source.allHeaders,
-  };
-
-  code.push('const http = require("%s");', source.uriObj.protocol.replace(':', ''));
-
-  code
-    .blank()
-    .push('const options = %s;', JSON.stringify(reqOpts, null, opts.indent))
-    .blank()
-    .push('const req = http.request(options, function (res) {')
-    .push(1, 'const chunks = [];')
-    .blank()
-    .push(1, 'res.on("data", function (chunk) {')
-    .push(2, 'chunks.push(chunk);')
-    .push(1, '});')
-    .blank()
-    .push(1, 'res.on("end", function () {')
-    .push(2, 'const body = Buffer.concat(chunks);')
-    .push(2, 'console.log(body.toString());')
-    .push(1, '});')
-    .push('});')
-    .blank();
-
-  switch (source.postData.mimeType) {
-    case 'application/x-www-form-urlencoded':
-      if (source.postData.paramsObj) {
-        code.unshift('const qs = require("querystring");');
-        code.push(
-          'req.write(qs.stringify(%s));',
-          stringifyObject(source.postData.paramsObj, {
-            indent: '  ',
-            inlineCharacterLimit: 80,
-          })
-        );
-      }
-      break;
-
-    case 'application/json':
-      if (source.postData.jsonObj) {
-        code.push(
-          'req.write(JSON.stringify(%s));',
-          stringifyObject(source.postData.jsonObj, {
-            indent: '  ',
-            inlineCharacterLimit: 80,
-          })
-        );
-      }
-      break;
-
-    default:
-      if (source.postData.text) {
-        code.push('req.write(%s);', JSON.stringify(source.postData.text, null, opts.indent));
-      }
-  }
-
-  code.push('req.end();');
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'native',
-  title: 'HTTP',
-  link: 'http://nodejs.org/api/http.html#http_http_request_options_callback',
-  description: 'Node.js native HTTP interface',
-};

package/src/targets/node/request.js

@@ -1,126 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for Node.js using Request.
- *
- * @author
- * @AhmadNassri
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const stringifyObject = require('stringify-object');
-const CodeBuilder = require('../../helpers/code-builder');
-
-module.exports = function (source, options) {
-  const opts = {
-    indent: '  ',
-    ...options,
-  };
-
-  let includeFS = false;
-  const code = new CodeBuilder(opts.indent);
-
-  code.push("const request = require('request');").blank();
-
-  const reqOpts = {
-    method: source.method,
-    url: source.fullUrl,
-  };
-
-  if (Object.keys(source.headersObj).length) {
-    reqOpts.headers = source.headersObj;
-  }
-
-  switch (source.postData.mimeType) {
-    case 'application/x-www-form-urlencoded':
-      reqOpts.form = source.postData.paramsObj;
-      break;
-
-    case 'application/json':
-      if (source.postData.jsonObj) {
-        reqOpts.body = source.postData.jsonObj;
-        reqOpts.json = true;
-      }
-      break;
-
-    case 'multipart/form-data':
-      if (source.postData.params) {
-        reqOpts.formData = {};
-
-        source.postData.params.forEach(function (param) {
-          const attachment = {};
-
-          if (!param.fileName && !param.contentType) {
-            reqOpts.formData[param.name] = param.value;
-            return;
-          }
-
-          if (param.fileName) {
-            includeFS = true;
-
-            attachment.value = `fs.createReadStream("${param.fileName}")`;
-          } else if (param.value) {
-            attachment.value = param.value;
-          }
-
-          if (param.fileName) {
-            attachment.options = {
-              filename: param.fileName,
-              contentType: param.contentType ? param.contentType : null,
-            };
-          }
-
-          reqOpts.formData[param.name] = attachment;
-        });
-      }
-      break;
-
-    default:
-      if (source.postData.text) {
-        reqOpts.body = source.postData.text;
-      }
-  }
-
-  // construct cookies argument
-  if (source.allHeaders.cookie) {
-    reqOpts.jar = 'JAR';
-
-    code.push('const jar = request.jar();');
-
-    const url = source.url;
-
-    // Cookies are already encoded within `source.allHeaders` so we can pull them out of that instead of doing our
-    // own encoding work.
-    source.allHeaders.cookie.split('; ').forEach(function (cookie) {
-      const [name, value] = cookie.split('=');
-      code.push("jar.setCookie(request.cookie('%s=%s'), '%s');", name, value, url);
-    });
-    code.blank();
-  }
-
-  if (includeFS) {
-    code.unshift("const fs = require('fs');");
-  }
-
-  code.push('const options = %s;', stringifyObject(reqOpts, { indent: '  ', inlineCharacterLimit: 80 })).blank();
-
-  code
-    .push('request(options, function (error, response, body) {')
-    .push(1, 'if (error) throw new Error(error);')
-    .blank()
-    .push(1, 'console.log(body);')
-    .push('});')
-    .blank();
-
-  return code
-    .join()
-    .replace("'JAR'", 'jar')
-    .replace(/'fs\.createReadStream\("(.+)"\)'/g, "fs.createReadStream('$1')");
-};
-
-module.exports.info = {
-  key: 'request',
-  title: 'Request',
-  link: 'https://github.com/request/request',
-  description: 'Simplified HTTP request client',
-};

package/src/targets/node/unirest.js

@@ -1,120 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for Node.js using Unirest.
- *
- * @author
- * @AhmadNassri
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const CodeBuilder = require('../../helpers/code-builder');
-
-module.exports = function (source, options) {
-  const opts = {
-    indent: '  ',
-    ...options,
-  };
-
-  let includeFS = false;
-  const code = new CodeBuilder(opts.indent);
-
-  code
-    .push('const unirest = require("unirest");')
-    .blank()
-    .push('const req = unirest("%s", "%s");', source.method, source.url)
-    .blank();
-
-  if (source.allHeaders.cookie) {
-    code.push('const CookieJar = unirest.jar();');
-
-    // Cookies are already encoded within `source.allHeaders` so we can pull them out of that instead of doing our
-    // own encoding work.
-    source.allHeaders.cookie.split('; ').forEach(function (cookie) {
-      const [name, value] = cookie.split('=');
-      code.push('CookieJar.add("%s=%s","%s");', name, value, source.url);
-    });
-
-    code.push('req.jar(CookieJar);').blank();
-  }
-
-  if (Object.keys(source.queryObj).length) {
-    code.push('req.query(%s);', JSON.stringify(source.queryObj, null, opts.indent)).blank();
-  }
-
-  if (Object.keys(source.headersObj).length) {
-    code.push('req.headers(%s);', JSON.stringify(source.headersObj, null, opts.indent)).blank();
-  }
-
-  switch (source.postData.mimeType) {
-    case 'application/x-www-form-urlencoded':
-      if (source.postData.paramsObj) {
-        code.push('req.form(%s);', JSON.stringify(source.postData.paramsObj, null, opts.indent)).blank();
-      }
-      break;
-
-    case 'application/json':
-      if (source.postData.jsonObj) {
-        code
-          .push('req.type("json");')
-          .push('req.send(%s);', JSON.stringify(source.postData.jsonObj, null, opts.indent))
-          .blank();
-      }
-      break;
-
-    case 'multipart/form-data': {
-      if (source.postData.params) {
-        const multipart = [];
-
-        source.postData.params.forEach(function (param) {
-          const part = {};
-
-          if (param.fileName && !param.value) {
-            includeFS = true;
-
-            part.body = `fs.createReadStream("${param.fileName}")`;
-          } else if (param.value) {
-            part.body = param.value;
-          }
-
-          if (part.body) {
-            if (param.contentType) {
-              part['content-type'] = param.contentType;
-            }
-
-            multipart.push(part);
-          }
-        });
-
-        code.push('req.multipart(%s);', JSON.stringify(multipart, null, opts.indent)).blank();
-      }
-      break;
-    }
-
-    default:
-      if (source.postData.text) {
-        code.push('req.send(%s);', JSON.stringify(source.postData.text, null, opts.indent)).blank();
-      }
-  }
-
-  if (includeFS) {
-    code.unshift('const fs = require("fs");');
-  }
-
-  code
-    .push('req.end(function (res) {')
-    .push(1, 'if (res.error) throw new Error(res.error);')
-    .blank()
-    .push(1, 'console.log(res.body);')
-    .push('});')
-    .blank();
-
-  return code.join().replace(/"fs\.createReadStream\(\\"(.+)\\"\)"/, 'fs.createReadStream("$1")');
-};
-
-module.exports.info = {
-  key: 'unirest',
-  title: 'Unirest',
-  link: 'http://unirest.io/nodejs.html',
-  description: 'Lightweight HTTP Request Client Library',
-};

package/src/targets/objc/helpers.js

@@ -1,80 +0,0 @@
-const { format } = require('util');
-
-module.exports = {
-  /**
-   * Create an string of given length filled with blank spaces
-   *
-   * @param {number} length Length of the array to return
-   * @return {string}
-   */
-  blankString: function (length) {
-    // eslint-disable-next-line prefer-spread
-    return Array.apply(null, new Array(length)).map(String.prototype.valueOf, ' ').join('');
-  },
-
-  /**
-   * Create a string corresponding to a valid declaration and initialization of an Objective-C object literal.
-   *
-   * @param {string} nsClass Class of the litteral
-   * @param {string} name Desired name of the instance
-   * @param {Object} parameters Key-value object of parameters to translate to an Objective-C object litearal
-   * @param {boolean} indent If true, will declare the litteral by indenting each new key/value pair.
-   * @return {string} A valid Objective-C declaration and initialization of an Objective-C object litteral.
-   *
-   * @example
-   *   nsDeclaration('NSDictionary', 'params', {a: 'b', c: 'd'}, true)
-   *   // returns:
-   *   NSDictionary *params = @{ @"a": @"b",
-   *                             @"c": @"d" };
-   *
-   *   nsDeclaration('NSDictionary', 'params', {a: 'b', c: 'd'})
-   *   // returns:
-   *   NSDictionary *params = @{ @"a": @"b", @"c": @"d" };
-   */
-  nsDeclaration: function (nsClass, name, parameters, indent) {
-    const opening = `${nsClass} *${name} = `;
-    const literal = this.literalRepresentation(parameters, indent ? opening.length : undefined);
-    return `${opening + literal};`;
-  },
-
-  /**
-   * Create a valid Objective-C string of a literal value according to its type.
-   *
-   * @param {*} value Any JavaScript literal
-   * @return {string}
-   */
-  literalRepresentation: function (value, indentation) {
-    const join = indentation === undefined ? ', ' : `,\n   ${this.blankString(indentation)}`;
-
-    switch (Object.prototype.toString.call(value)) {
-      case '[object Number]':
-        return `@${value}`;
-
-      case '[object Array]': {
-        const valuesRepresentation = value.map(
-          function (v) {
-            return this.literalRepresentation(v);
-          }.bind(this)
-        );
-        return `@[ ${valuesRepresentation.join(join)} ]`;
-      }
-
-      case '[object Object]': {
-        const keyValuePairs = [];
-        Object.keys(value).forEach(k => {
-          keyValuePairs.push(format('@"%s": %s', k, this.literalRepresentation(value[k])));
-        });
-        return `@{ ${keyValuePairs.join(join)} }`;
-      }
-
-      case '[object Boolean]':
-        return value ? '@YES' : '@NO';
-
-      default:
-        if (value === null || value === undefined) {
-          return '';
-        }
-        return `@"${value.toString().replace(/"/g, '\\"')}"`;
-    }
-  },
-};

package/src/targets/objc/index.js

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