@readme/httpsnippet 3.1.1 → 4.0.0

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

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

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

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

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

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

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

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

@@ -0,0 +1,15 @@
+const unirest = require('unirest');
+
+const req = unirest('GET', 'https://httpbin.org/headers');
+
+req.headers({
+  accept: 'application/json',
+  'x-foo': 'Bar',
+  'x-bar': 'Foo'
+});
+
+req.end(function (res) {
+  if (res.error) throw new Error(res.error);
+
+  console.log(res.body);
+});

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

@@ -0,0 +1,9 @@
+const unirest = require('unirest');
+
+const req = unirest('GET', 'http://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/jsonObj-multiline.js

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

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

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

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

@@ -0,0 +1,23 @@
+const unirest = require('unirest');
+
+const req = unirest('POST', 'https://httpbin.org/anything');
+
+req.headers({
+  'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
+});
+
+req.multipart([
+  {
+    body: 'Hello World',
+    'content-type': 'text/plain'
+  },
+  {
+    body: 'Bonjour le monde'
+  }
+]);
+
+req.end(function (res) {
+  if (res.error) throw new Error(res.error);
+
+  console.log(res.body);
+});

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

@@ -0,0 +1,21 @@
+const fs = require('fs');
+const unirest = require('unirest');
+
+const req = unirest('POST', 'https://httpbin.org/anything');
+
+req.headers({
+  'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
+});
+
+req.multipart([
+  {
+    body: fs.createReadStream('src/fixtures/files/hello.txt'),
+    'content-type': 'text/plain'
+  }
+]);
+
+req.end(function (res) {
+  if (res.error) throw new Error(res.error);
+
+  console.log(res.body);
+});

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

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

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

@@ -0,0 +1,19 @@
+const unirest = require('unirest');
+
+const req = unirest('POST', 'https://httpbin.org/anything');
+
+req.headers({
+  'Content-Type': 'multipart/form-data; boundary=---011000010111000001101001'
+});
+
+req.multipart([
+  {
+    body: 'bar'
+  }
+]);
+
+req.end(function (res) {
+  if (res.error) throw new Error(res.error);
+
+  console.log(res.body);
+});

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

@@ -0,0 +1,15 @@
+const unirest = require('unirest');
+
+const req = unirest('GET', 'https://httpbin.org/anything');
+
+req.query({
+  'foo[bar]': 'baz,zap',
+  fiz: 'buz',
+  key: 'value'
+});
+
+req.end(function (res) {
+  if (res.error) throw new Error(res.error);
+
+  console.log(res.body);
+});

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

@@ -0,0 +1,14 @@
+const unirest = require('unirest');
+
+const req = unirest('GET', 'https://httpbin.org/anything');
+
+req.query({
+  startTime: '2019-06-13T19%3A08%3A25.455Z',
+  endTime: '2015-09-15T14%3A00%3A12-04%3A00'
+});
+
+req.end(function (res) {
+  if (res.error) throw new Error(res.error);
+
+  console.log(res.body);
+});

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

@@ -0,0 +1,18 @@
+const unirest = require('unirest');
+
+const req = unirest('GET', 'https://httpbin.org/anything');
+
+req.query({
+  foo: [
+    'bar',
+    'baz'
+  ],
+  baz: 'abc',
+  key: 'value'
+});
+
+req.end(function (res) {
+  if (res.error) throw new Error(res.error);
+
+  console.log(res.body);
+});

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

@@ -0,0 +1,9 @@
+const unirest = require('unirest');
+
+const req = unirest('GET', '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/text-plain.js

@@ -0,0 +1,15 @@
+const unirest = require('unirest');
+
+const req = unirest('POST', 'https://httpbin.org/anything');
+
+req.headers({
+  'content-type': 'text/plain'
+});
+
+req.send('Hello World');
+
+req.end(function (res) {
+  if (res.error) throw new Error(res.error);
+
+  console.log(res.body);
+});

package/src/targets/objc/helpers.ts

@@ -0,0 +1,60 @@
+/**
+ * Create a string corresponding to a valid declaration and initialization of an Objective-C object literal.
+ *
+ * @param nsClass Class of the litteral
+ * @param name Desired name of the instance
+ * @param parameters Key-value object of parameters to translate to an Objective-C object litearal
+ * @param indent If true, will declare the litteral by indenting each new key/value pair.
+ * @return 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" };
+ */
+export const nsDeclaration = (nsClass: string, name: string, parameters: Record<string, any>, indent?: boolean) => {
+  const opening = `${nsClass} *${name} = `;
+  const literal = 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
+ */
+export const literalRepresentation = (value: any, indentation?: number): string => {
+  const join = indentation === undefined ? ', ' : `,\n   ${' '.repeat(indentation)}`;
+
+  switch (Object.prototype.toString.call(value)) {
+    case '[object Number]':
+      return `@${value}`;
+
+    case '[object Array]': {
+      const valuesRepresentation = value.map((val: any) => literalRepresentation(val));
+      return `@[ ${valuesRepresentation.join(join)} ]`;
+    }
+
+    case '[object Object]': {
+      const keyValuePairs: string[] = [];
+      Object.keys(value).forEach(key => {
+        keyValuePairs.push(`@"${key}": ${literalRepresentation(value[key])}`);
+      });
+      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/nsurlsession/client.test.ts

@@ -0,0 +1,36 @@
+import type { Request } from '../../..';
+import full from '../../../fixtures/requests/full';
+import jsonNullValue from '../../../fixtures/requests/jsonObj-null-value';
+import short from '../../../fixtures/requests/short';
+import { runCustomFixtures } from '../../../fixtures/runCustomFixtures';
+
+runCustomFixtures({
+  targetId: 'objc',
+  clientId: 'nsurlsession',
+  tests: [
+    {
+      it: 'should support an indent option',
+      input: short.log.entries[0].request as Request,
+      options: { indent: '  ' },
+      expected: 'indent-option.m',
+    },
+    {
+      it: 'should support a timeout option',
+      input: short.log.entries[0].request as Request,
+      options: { timeout: 5 },
+      expected: 'timeout-option.m',
+    },
+    {
+      it: 'should support pretty option',
+      input: full.log.entries[0].request as Request,
+      options: { pretty: false },
+      expected: 'pretty-option.m',
+    },
+    {
+      it: 'should support json object with null value',
+      input: jsonNullValue as unknown as Request,
+      options: { pretty: false },
+      expected: 'json-with-null-value.m',
+    },
+  ],
+});