@readme/httpsnippet 4.0.0 → 4.0.3

package/src/targets/node/request/client.ts

@@ -1,130 +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.
- */
-
-import type { Client } from '../../targets';
-import stringifyObject from 'stringify-object';
-
-import { CodeBuilder } from '../../../helpers/code-builder';
-
-export const request: Client = {
-  info: {
-    key: 'request',
-    title: 'Request',
-    link: 'https://github.com/request/request',
-    description: 'Simplified HTTP request client',
-  },
-  convert: ({ method, url, fullUrl, postData, headersObj, cookies }, options) => {
-    const opts = {
-      indent: '  ',
-      ...options,
-    };
-
-    let includeFS = false;
-    const { push, blank, join, unshift, addPostProcessor } = new CodeBuilder({ indent: opts.indent });
-
-    push("const request = require('request');");
-    blank();
-
-    const reqOpts: Record<string, any> = {
-      method,
-      url: fullUrl,
-    };
-
-    if (Object.keys(headersObj).length) {
-      reqOpts.headers = headersObj;
-    }
-
-    switch (postData.mimeType) {
-      case 'application/x-www-form-urlencoded':
-        reqOpts.form = postData.paramsObj;
-        break;
-
-      case 'application/json':
-        if (postData.jsonObj) {
-          reqOpts.body = postData.jsonObj;
-          reqOpts.json = true;
-        }
-        break;
-
-      case 'multipart/form-data':
-        if (!postData.params) {
-          break;
-        }
-
-        reqOpts.formData = {};
-
-        postData.params.forEach(param => {
-          if (!param.fileName && !param.fileName && !param.contentType) {
-            reqOpts.formData[param.name] = param.value;
-            return;
-          }
-
-          let attachment: {
-            value?: string;
-            options?: {
-              filename: string;
-              contentType: string | null;
-            };
-          } = {};
-
-          if (param.fileName) {
-            includeFS = true;
-            attachment = {
-              value: `fs.createReadStream(${param.fileName})`,
-              options: {
-                filename: param.fileName,
-                contentType: param.contentType ? param.contentType : null,
-              },
-            };
-          } else if (param.value) {
-            attachment.value = param.value;
-          }
-
-          reqOpts.formData[param.name] = attachment;
-        });
-
-        addPostProcessor(code => code.replace(/'fs\.createReadStream\((.*)\)'/, "fs.createReadStream('$1')"));
-        break;
-
-      default:
-        if (postData.text) {
-          reqOpts.body = postData.text;
-        }
-    }
-
-    // construct cookies argument
-    if (cookies.length) {
-      reqOpts.jar = 'JAR';
-
-      push('const jar = request.jar();');
-
-      cookies.forEach(({ name, value }) => {
-        push(`jar.setCookie(request.cookie('${encodeURIComponent(name)}=${encodeURIComponent(value)}'), '${url}');`);
-      });
-      blank();
-      addPostProcessor(code => code.replace(/'JAR'/, 'jar'));
-    }
-
-    if (includeFS) {
-      unshift("const fs = require('fs');");
-    }
-
-    push(`const options = ${stringifyObject(reqOpts, { indent: '  ', inlineCharacterLimit: 80 })};`);
-    blank();
-
-    push('request(options, function (error, response, body) {');
-    push('if (error) throw new Error(error);', 1);
-    blank();
-    push('console.log(body);', 1);
-    push('});');
-
-    return join();
-  },
-};

package/src/targets/node/request/fixtures/application-form-encoded.js

@@ -1,14 +0,0 @@
-const request = require('request');
-
-const options = {
-  method: 'POST',
-  url: 'https://httpbin.org/anything',
-  headers: {'content-type': 'application/x-www-form-urlencoded'},
-  form: {foo: 'bar', hello: 'world'}
-};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/application-json.js

@@ -1,22 +0,0 @@
-const request = require('request');
-
-const options = {
-  method: 'POST',
-  url: 'https://httpbin.org/anything',
-  headers: {'content-type': 'application/json'},
-  body: {
-    number: 1,
-    string: 'f"oo',
-    arr: [1, 2, 3],
-    nested: {a: 'b'},
-    arr_mix: [1, 'a', {arr_mix_nested: {}}],
-    boolean: false
-  },
-  json: true
-};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/cookies.js

@@ -1,13 +0,0 @@
-const request = require('request');
-
-const jar = request.jar();
-jar.setCookie(request.cookie('foo=bar'), 'https://httpbin.org/cookies');
-jar.setCookie(request.cookie('bar=baz'), 'https://httpbin.org/cookies');
-
-const options = {method: 'GET', url: 'https://httpbin.org/cookies', jar: jar};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/custom-method.js

@@ -1,9 +0,0 @@
-const request = require('request');
-
-const options = {method: 'PROPFIND', url: 'https://httpbin.org/anything'};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/full.js

@@ -1,22 +0,0 @@
-const request = require('request');
-
-const jar = request.jar();
-jar.setCookie(request.cookie('foo=bar'), 'https://httpbin.org/anything');
-jar.setCookie(request.cookie('bar=baz'), 'https://httpbin.org/anything');
-
-const options = {
-  method: 'POST',
-  url: 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value',
-  headers: {
-    accept: 'application/json',
-    'content-type': 'application/x-www-form-urlencoded'
-  },
-  form: {foo: 'bar'},
-  jar: jar
-};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/headers.js

@@ -1,13 +0,0 @@
-const request = require('request');
-
-const options = {
-  method: 'GET',
-  url: 'https://httpbin.org/headers',
-  headers: {accept: 'application/json', 'x-foo': 'Bar', 'x-bar': 'Foo'}
-};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/http-insecure.js

@@ -1,9 +0,0 @@
-const request = require('request');
-
-const options = {method: 'GET', url: 'http://httpbin.org/anything'};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/jsonObj-multiline.js

@@ -1,15 +0,0 @@
-const request = require('request');
-
-const options = {
-  method: 'POST',
-  url: 'https://httpbin.org/anything',
-  headers: {'content-type': 'application/json'},
-  body: {foo: 'bar'},
-  json: true
-};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/jsonObj-null-value.js

@@ -1,15 +0,0 @@
-const request = require('request');
-
-const options = {
-  method: 'POST',
-  url: 'https://httpbin.org/anything',
-  headers: {'content-type': 'application/json'},
-  body: {foo: null},
-  json: true
-};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/multipart-data.js

@@ -1,21 +0,0 @@
-const fs = require('fs');
-const request = require('request');
-
-const options = {
-  method: 'POST',
-  url: 'https://httpbin.org/anything',
-  headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
-  formData: {
-    foo: {
-      value: fs.createReadStream('src/fixtures/files/hello.txt'),
-      options: {filename: 'src/fixtures/files/hello.txt', contentType: 'text/plain'}
-    },
-    bar: 'Bonjour le monde'
-  }
-};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/multipart-file.js

@@ -1,20 +0,0 @@
-const fs = require('fs');
-const request = require('request');
-
-const options = {
-  method: 'POST',
-  url: 'https://httpbin.org/anything',
-  headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
-  formData: {
-    foo: {
-      value: fs.createReadStream('src/fixtures/files/hello.txt'),
-      options: {filename: 'src/fixtures/files/hello.txt', contentType: 'text/plain'}
-    }
-  }
-};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/multipart-form-data-no-params.js

@@ -1,13 +0,0 @@
-const request = require('request');
-
-const options = {
-  method: 'POST',
-  url: 'https://httpbin.org/anything',
-  headers: {'Content-Type': 'multipart/form-data'}
-};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/multipart-form-data.js

@@ -1,14 +0,0 @@
-const request = require('request');
-
-const options = {
-  method: 'POST',
-  url: 'https://httpbin.org/anything',
-  headers: {'Content-Type': 'multipart/form-data; boundary=---011000010111000001101001'},
-  formData: {foo: 'bar'}
-};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/nested.js

@@ -1,12 +0,0 @@
-const request = require('request');
-
-const options = {
-  method: 'GET',
-  url: 'https://httpbin.org/anything?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value'
-};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/query-encoded.js

@@ -1,12 +0,0 @@
-const request = require('request');
-
-const options = {
-  method: 'GET',
-  url: 'https://httpbin.org/anything?startTime=2019-06-13T19%3A08%3A25.455Z&endTime=2015-09-15T14%3A00%3A12-04%3A00'
-};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/query.js

@@ -1,12 +0,0 @@
-const request = require('request');
-
-const options = {
-  method: 'GET',
-  url: 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value'
-};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/short.js

@@ -1,9 +0,0 @@
-const request = require('request');
-
-const options = {method: 'GET', url: 'https://httpbin.org/anything'};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/request/fixtures/text-plain.js

@@ -1,14 +0,0 @@
-const request = require('request');
-
-const options = {
-  method: 'POST',
-  url: 'https://httpbin.org/anything',
-  headers: {'content-type': 'text/plain'},
-  body: 'Hello World'
-};
-
-request(options, function (error, response, body) {
-  if (error) throw new Error(error);
-
-  console.log(body);
-});

package/src/targets/node/target.ts

@@ -1,23 +0,0 @@
-import type { Target } from '../targets';
-import { axios } from './axios/client';
-import { fetch } from './fetch/client';
-import { native } from './native/client';
-import { request } from './request/client';
-import { unirest } from './unirest/client';
-
-export const node: Target = {
-  info: {
-    key: 'node',
-    title: 'Node.js',
-    extname: '.js',
-    default: 'native',
-    cli: 'node %s',
-  },
-  clientsById: {
-    native,
-    request,
-    unirest,
-    axios,
-    fetch,
-  },
-};

package/src/targets/node/unirest/client.ts

@@ -1,129 +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.
- */
-
-import type { Client } from '../../targets';
-import stringifyObject from 'stringify-object';
-
-import { CodeBuilder } from '../../../helpers/code-builder';
-
-export const unirest: Client = {
-  info: {
-    key: 'unirest',
-    title: 'Unirest',
-    link: 'http://unirest.io/nodejs.html',
-    description: 'Lightweight HTTP Request Client Library',
-  },
-  convert: ({ method, url, cookies, queryObj, postData, headersObj }, options) => {
-    const opts = {
-      indent: '  ',
-      ...options,
-    };
-
-    let includeFS = false;
-    const { addPostProcessor, blank, join, push, unshift } = new CodeBuilder({
-      indent: opts.indent,
-    });
-
-    push("const unirest = require('unirest');");
-    blank();
-    push(`const req = unirest('${method}', '${url}');`);
-    blank();
-
-    if (cookies.length) {
-      push('const CookieJar = unirest.jar();');
-
-      cookies.forEach(cookie => {
-        push(`CookieJar.add('${encodeURIComponent(cookie.name)}=${encodeURIComponent(cookie.value)}', '${url}');`);
-      });
-
-      push('req.jar(CookieJar);');
-      blank();
-    }
-
-    if (Object.keys(queryObj).length) {
-      push(`req.query(${stringifyObject(queryObj, { indent: opts.indent })});`);
-      blank();
-    }
-
-    if (Object.keys(headersObj).length) {
-      push(`req.headers(${stringifyObject(headersObj, { indent: opts.indent })});`);
-      blank();
-    }
-
-    switch (postData.mimeType) {
-      case 'application/x-www-form-urlencoded':
-        if (postData.paramsObj) {
-          push(`req.form(${stringifyObject(postData.paramsObj, { indent: opts.indent })});`);
-          blank();
-        }
-        break;
-
-      case 'application/json':
-        if (postData.jsonObj) {
-          push("req.type('json');");
-          push(`req.send(${stringifyObject(postData.jsonObj, { indent: opts.indent })});`);
-          blank();
-        }
-        break;
-
-      case 'multipart/form-data': {
-        if (!postData.params) {
-          break;
-        }
-
-        const multipart: Record<string, string>[] = [];
-
-        postData.params.forEach(param => {
-          const part: Record<string, string> = {};
-
-          if (param.fileName && !param.value) {
-            includeFS = true;
-
-            part.body = `fs.createReadStream('${param.fileName}')`;
-            addPostProcessor(code => code.replace(/'fs\.createReadStream\(\\'(.+)\\'\)'/, "fs.createReadStream('$1')"));
-          } else if (param.value) {
-            part.body = param.value;
-          }
-
-          if (part.body) {
-            if (param.contentType) {
-              part['content-type'] = param.contentType;
-            }
-
-            multipart.push(part);
-          }
-        });
-
-        push(`req.multipart(${stringifyObject(multipart, { indent: opts.indent })});`);
-        blank();
-        break;
-      }
-
-      default:
-        if (postData.text) {
-          push(`req.send(${stringifyObject(postData.text, { indent: opts.indent })});`);
-          blank();
-        }
-    }
-
-    if (includeFS) {
-      unshift("const fs = require('fs');");
-    }
-
-    push('req.end(function (res) {');
-    push('if (res.error) throw new Error(res.error);', 1);
-    blank();
-
-    push('console.log(res.body);', 1);
-    push('});');
-
-    return join();
-  },
-};

package/src/targets/node/unirest/fixtures/application-form-encoded.js

@@ -1,18 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('POST', 'https://httpbin.org/anything');
-
-req.headers({
-  'content-type': 'application/x-www-form-urlencoded'
-});
-
-req.form({
-  foo: 'bar',
-  hello: 'world'
-});
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/application-json.js

@@ -1,35 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('POST', 'https://httpbin.org/anything');
-
-req.headers({
-  'content-type': 'application/json'
-});
-
-req.type('json');
-req.send({
-  number: 1,
-  string: 'f"oo',
-  arr: [
-    1,
-    2,
-    3
-  ],
-  nested: {
-    a: 'b'
-  },
-  arr_mix: [
-    1,
-    'a',
-    {
-      arr_mix_nested: {}
-    }
-  ],
-  boolean: false
-});
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/cookies.js

@@ -1,14 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('GET', 'https://httpbin.org/cookies');
-
-const CookieJar = unirest.jar();
-CookieJar.add('foo=bar', 'https://httpbin.org/cookies');
-CookieJar.add('bar=baz', 'https://httpbin.org/cookies');
-req.jar(CookieJar);
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/custom-method.js

@@ -1,9 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('PROPFIND', 'https://httpbin.org/anything');
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/full.js

@@ -1,32 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('POST', 'https://httpbin.org/anything');
-
-const CookieJar = unirest.jar();
-CookieJar.add('foo=bar', 'https://httpbin.org/anything');
-CookieJar.add('bar=baz', 'https://httpbin.org/anything');
-req.jar(CookieJar);
-
-req.query({
-  foo: [
-    'bar',
-    'baz'
-  ],
-  baz: 'abc',
-  key: 'value'
-});
-
-req.headers({
-  accept: 'application/json',
-  'content-type': 'application/x-www-form-urlencoded'
-});
-
-req.form({
-  foo: 'bar'
-});
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});