@readme/httpsnippet 3.1.3 → 4.0.0

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

@@ -0,0 +1,24 @@
+const http = require('https');
+
+const options = {
+  method: 'GET',
+  hostname: 'httpbin.org',
+  port: null,
+  path: '/anything?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value',
+  headers: {}
+};
+
+const req = http.request(options, function (res) {
+  const chunks = [];
+
+  res.on('data', function (chunk) {
+    chunks.push(chunk);
+  });
+
+  res.on('end', function () {
+    const body = Buffer.concat(chunks);
+    console.log(body.toString());
+  });
+});
+
+req.end();

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

@@ -0,0 +1,24 @@
+const http = require('https');
+
+const options = {
+  method: 'GET',
+  hostname: 'httpbin.org',
+  port: null,
+  path: '/anything?startTime=2019-06-13T19%3A08%3A25.455Z&endTime=2015-09-15T14%3A00%3A12-04%3A00',
+  headers: {}
+};
+
+const req = http.request(options, function (res) {
+  const chunks = [];
+
+  res.on('data', function (chunk) {
+    chunks.push(chunk);
+  });
+
+  res.on('end', function () {
+    const body = Buffer.concat(chunks);
+    console.log(body.toString());
+  });
+});
+
+req.end();

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

@@ -0,0 +1,24 @@
+const http = require('https');
+
+const options = {
+  method: 'GET',
+  hostname: 'httpbin.org',
+  port: null,
+  path: '/anything?foo=bar&foo=baz&baz=abc&key=value',
+  headers: {}
+};
+
+const req = http.request(options, function (res) {
+  const chunks = [];
+
+  res.on('data', function (chunk) {
+    chunks.push(chunk);
+  });
+
+  res.on('end', function () {
+    const body = Buffer.concat(chunks);
+    console.log(body.toString());
+  });
+});
+
+req.end();

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

@@ -0,0 +1,24 @@
+const http = require('https');
+
+const options = {
+  method: 'GET',
+  hostname: 'httpbin.org',
+  port: null,
+  path: '/anything',
+  headers: {}
+};
+
+const req = http.request(options, function (res) {
+  const chunks = [];
+
+  res.on('data', function (chunk) {
+    chunks.push(chunk);
+  });
+
+  res.on('end', function () {
+    const body = Buffer.concat(chunks);
+    console.log(body.toString());
+  });
+});
+
+req.end();

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

@@ -0,0 +1,27 @@
+const http = require('https');
+
+const options = {
+  method: 'POST',
+  hostname: 'httpbin.org',
+  port: null,
+  path: '/anything',
+  headers: {
+    'content-type': 'text/plain'
+  }
+};
+
+const req = http.request(options, function (res) {
+  const chunks = [];
+
+  res.on('data', function (chunk) {
+    chunks.push(chunk);
+  });
+
+  res.on('end', function () {
+    const body = Buffer.concat(chunks);
+    console.log(body.toString());
+  });
+});
+
+req.write('Hello World');
+req.end();

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

@@ -0,0 +1,130 @@
+/**
+ * @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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,14 @@
+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

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