@readme/httpsnippet 3.1.3 → 4.0.0

package/src/targets/java/unirest.js

@@ -1,57 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for Java using Unirest.
- *
- * @author
- * @shashiranjan84
- *
- * 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,
-  };
-
-  const code = new CodeBuilder(opts.indent);
-
-  const methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'];
-
-  if (methods.indexOf(source.method.toUpperCase()) === -1) {
-    code.push(
-      'HttpResponse<String> response = Unirest.customMethod("%s","%s")',
-      source.method.toUpperCase(),
-      source.fullUrl
-    );
-  } else {
-    code.push('HttpResponse<String> response = Unirest.%s("%s")', source.method.toLowerCase(), source.fullUrl);
-  }
-
-  // Add headers, including the cookies
-  const headers = Object.keys(source.allHeaders);
-
-  // construct headers
-  if (headers.length) {
-    headers.forEach(function (key) {
-      code.push(1, '.header("%s", "%s")', key, source.allHeaders[key]);
-    });
-  }
-
-  if (source.postData.text) {
-    code.push(1, '.body(%s)', JSON.stringify(source.postData.text));
-  }
-
-  code.push(1, '.asString();');
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'unirest',
-  title: 'Unirest',
-  link: 'http://unirest.io/java.html',
-  description: 'Lightweight HTTP Request Client Library',
-};

package/src/targets/javascript/axios.js

@@ -1,101 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for Javascript & Node.js using Axios.
- *
- * @author
- * @rohit-gohri
- *
- * 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);
-
-  code.push('import axios from "axios";').blank();
-
-  const reqOpts = {
-    method: source.method,
-    url: source.url,
-  };
-
-  if (Object.keys(source.queryObj).length) {
-    reqOpts.params = source.queryObj;
-  }
-
-  if (Object.keys(source.allHeaders).length) {
-    reqOpts.headers = source.allHeaders;
-  }
-
-  switch (source.postData.mimeType) {
-    case 'application/x-www-form-urlencoded':
-      code.push('const encodedParams = new URLSearchParams();');
-      source.postData.params.forEach(function (param) {
-        code.push(`encodedParams.set('${param.name}', '${param.value}');`);
-      });
-
-      code.blank();
-
-      reqOpts.data = 'encodedParams';
-      break;
-
-    case 'application/json':
-      if (source.postData.jsonObj) {
-        reqOpts.data = source.postData.jsonObj;
-      }
-      break;
-
-    case 'multipart/form-data':
-      if (source.postData.params) {
-        code.push('const form = new FormData();');
-
-        source.postData.params.forEach(function (param) {
-          code.push(
-            'form.append(%s, %s);',
-            JSON.stringify(param.name),
-            JSON.stringify(param.value || param.fileName || '')
-          );
-        });
-
-        code.blank();
-
-        reqOpts.data = '[form]';
-      }
-      break;
-
-    default:
-      if (source.postData.text) {
-        reqOpts.data = source.postData.text;
-      }
-  }
-
-  code
-    .push(
-      'const options = %s;',
-      stringifyObject(reqOpts, { indent: '  ', inlineCharacterLimit: 80 }).replace('"[form]"', 'form')
-    )
-    .blank();
-
-  code
-    .push('axios.request(options).then(function (response) {')
-    .push(1, 'console.log(response.data);')
-    .push('}).catch(%s', 'function (error) {')
-    .push(1, 'console.error(error);')
-    .push('});');
-
-  return code.join().replace(/'encodedParams'/, 'encodedParams,');
-};
-
-module.exports.info = {
-  key: 'axios',
-  title: 'Axios',
-  link: 'https://github.com/axios/axios',
-  description: 'Promise based HTTP client for the browser and node.js',
-};

package/src/targets/javascript/fetch.js

@@ -1,129 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for fetch
- *
- * @author
- * @pmdroid
- *
- * 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');
-const { getHeaderName } = require('../../helpers/headers');
-
-module.exports = function (source, options) {
-  const opts = {
-    indent: '  ',
-    credentials: null,
-    ...options,
-  };
-
-  const code = new CodeBuilder(opts.indent);
-
-  const reqOptions = {
-    method: source.method,
-  };
-
-  if (Object.keys(source.allHeaders).length) {
-    reqOptions.headers = source.allHeaders;
-  }
-
-  if (opts.credentials !== null) {
-    reqOptions.credentials = opts.credentials;
-  }
-
-  switch (source.postData.mimeType) {
-    case 'application/x-www-form-urlencoded':
-      reqOptions.body = source.postData.paramsObj ? source.postData.paramsObj : source.postData.text;
-      break;
-
-    case 'application/json':
-      if (source.postData.jsonObj) {
-        reqOptions.body = source.postData.jsonObj;
-      }
-      break;
-
-    case 'multipart/form-data':
-      if (source.postData.params) {
-        // The FormData API automatically adds a `Content-Type` header for `multipart/form-data`
-        // content and if we add our own here data won't be correctly transmitted.
-        if (reqOptions.headers) {
-          const contentTypeHeader = getHeaderName(reqOptions.headers, 'content-type');
-          if (contentTypeHeader) {
-            delete reqOptions.headers[contentTypeHeader];
-          }
-        }
-
-        code.push('const form = new FormData();');
-
-        source.postData.params.forEach(function (param) {
-          code.push(
-            'form.append(%s, %s);',
-            JSON.stringify(param.name),
-            JSON.stringify(param.value || param.fileName || '')
-          );
-        });
-
-        code.blank();
-      }
-      break;
-
-    default:
-      if (source.postData.text) {
-        reqOptions.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 (reqOptions.headers && !Object.keys(reqOptions.headers).length) {
-    delete reqOptions.headers;
-  }
-
-  code
-    .push(
-      'const options = %s;',
-      stringifyObject(reqOptions, {
-        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') {
-            if (source.postData.mimeType === 'application/x-www-form-urlencoded') {
-              return `new URLSearchParams(${originalResult})`;
-            } else if (source.postData.mimeType === 'application/json') {
-              return `JSON.stringify(${originalResult})`;
-            }
-          }
-
-          return originalResult;
-        },
-      })
-    )
-    .blank();
-
-  if (source.postData.mimeType === 'multipart/form-data') {
-    if (source.postData.params) {
-      code.push('options.body = form;').blank();
-    }
-  }
-
-  code
-    .push("fetch('%s', options)", source.fullUrl)
-    .push(1, '.then(response => response.json())')
-    .push(1, '.then(response => console.log(response))')
-    .push(1, '.catch(err => console.error(err));');
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'fetch',
-  title: 'fetch',
-  link: 'https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch',
-  description: 'Perform asynchronous HTTP requests with the Fetch API',
-};

package/src/targets/javascript/index.js

@@ -1,13 +0,0 @@
-module.exports = {
-  info: {
-    key: 'javascript',
-    title: 'JavaScript',
-    extname: '.js',
-    default: 'xhr',
-  },
-
-  jquery: require('./jquery'),
-  fetch: require('./fetch'),
-  xhr: require('./xhr'),
-  axios: require('./axios'),
-};

package/src/targets/javascript/jquery.js

@@ -1,89 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for native XMLHttpRequest
- *
- * @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');
-const helpers = require('../../helpers/headers');
-
-module.exports = function (source, options) {
-  const opts = {
-    indent: '  ',
-    ...options,
-  };
-
-  const code = new CodeBuilder(opts.indent);
-
-  const settings = {
-    async: true,
-    crossDomain: true,
-    url: source.fullUrl,
-    method: source.method,
-    headers: source.allHeaders,
-  };
-
-  switch (source.postData.mimeType) {
-    case 'application/x-www-form-urlencoded':
-      settings.data = source.postData.paramsObj ? source.postData.paramsObj : source.postData.text;
-      break;
-
-    case 'application/json':
-      settings.processData = false;
-      settings.data = source.postData.text;
-      break;
-
-    case 'multipart/form-data':
-      if (source.postData.params) {
-        code.push('const form = new FormData();');
-
-        source.postData.params.forEach(function (param) {
-          code.push(
-            'form.append(%s, %s);',
-            JSON.stringify(param.name),
-            JSON.stringify(param.value || param.fileName || '')
-          );
-        });
-
-        settings.processData = false;
-        settings.contentType = false;
-        settings.mimeType = 'multipart/form-data';
-        settings.data = '[form]';
-
-        // remove the contentType header
-        if (helpers.hasHeader(settings.headers, 'content-type')) {
-          if (helpers.getHeader(settings.headers, 'content-type').indexOf('boundary')) {
-            delete settings.headers[helpers.getHeaderName(settings.headers, 'content-type')];
-          }
-        }
-
-        code.blank();
-      }
-      break;
-
-    default:
-      if (source.postData.text) {
-        settings.data = source.postData.text;
-      }
-  }
-
-  code
-    .push(`const settings = ${JSON.stringify(settings, null, opts.indent).replace('"[form]"', 'form')};`)
-    .blank()
-    .push('$.ajax(settings).done(function (response) {')
-    .push(1, 'console.log(response);')
-    .push('});');
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'jquery',
-  title: 'jQuery',
-  link: 'http://api.jquery.com/jquery.ajax/',
-  description: 'Perform an asynchronous HTTP (Ajax) requests with jQuery',
-};

package/src/targets/javascript/xhr.js

@@ -1,86 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for native XMLHttpRequest
- *
- * @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');
-const helpers = require('../../helpers/headers');
-
-module.exports = function (source, options) {
-  const opts = {
-    indent: '  ',
-    cors: true,
-    ...options,
-  };
-
-  const code = new CodeBuilder(opts.indent);
-
-  switch (source.postData.mimeType) {
-    case 'application/json':
-      code.push('const data = JSON.stringify(%s);', JSON.stringify(source.postData.jsonObj, null, opts.indent)).blank();
-      break;
-
-    case 'multipart/form-data':
-      if (source.postData.params) {
-        code.push('const data = new FormData();');
-
-        source.postData.params.forEach(function (param) {
-          code.push(
-            'data.append(%s, %s);',
-            JSON.stringify(param.name),
-            JSON.stringify(param.value || param.fileName || '')
-          );
-        });
-
-        // remove the contentType header
-        if (helpers.hasHeader(source.allHeaders, 'content-type')) {
-          if (helpers.getHeader(source.allHeaders, 'content-type').indexOf('boundary')) {
-            // eslint-disable-next-line no-param-reassign
-            delete source.allHeaders[helpers.getHeaderName(source.allHeaders, 'content-type')];
-          }
-        }
-
-        code.blank();
-      }
-      break;
-
-    default:
-      code.push('const data = %s;', JSON.stringify(source.postData.text || null)).blank();
-  }
-
-  code.push('const xhr = new XMLHttpRequest();');
-
-  if (opts.cors) {
-    code.push('xhr.withCredentials = true;');
-  }
-
-  code
-    .blank()
-    .push('xhr.addEventListener("readystatechange", function () {')
-    .push(1, 'if (this.readyState === this.DONE) {')
-    .push(2, 'console.log(this.responseText);')
-    .push(1, '}')
-    .push('});')
-    .blank()
-    .push('xhr.open(%s, %s);', JSON.stringify(source.method), JSON.stringify(source.fullUrl));
-
-  Object.keys(source.allHeaders).forEach(function (key) {
-    code.push('xhr.setRequestHeader(%s, %s);', JSON.stringify(key), JSON.stringify(source.allHeaders[key]));
-  });
-
-  code.blank().push('xhr.send(data);');
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'xhr',
-  title: 'XMLHttpRequest',
-  link: 'https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest',
-  description: 'W3C Standard API that provides scripted client functionality',
-};

package/src/targets/kotlin/index.js

@@ -1,10 +0,0 @@
-module.exports = {
-  info: {
-    key: 'kotlin',
-    title: 'Kotlin',
-    extname: '.kt',
-    default: 'okhttp',
-  },
-
-  okhttp: require('./okhttp'),
-};

package/src/targets/kotlin/okhttp.js

@@ -1,78 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for Kotlin using OkHttp.
- *
- * @author
- * @seanghay
- *
- * 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,
-  };
-
-  const code = new CodeBuilder(opts.indent);
-
-  const methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD'];
-
-  const methodsWithBody = ['POST', 'PUT', 'DELETE', 'PATCH'];
-
-  code.push('val client = OkHttpClient()').blank();
-
-  if (source.postData.text) {
-    if (source.postData.boundary) {
-      code.push(
-        'val mediaType = MediaType.parse("%s; boundary=%s")',
-        source.postData.mimeType,
-        source.postData.boundary
-      );
-    } else {
-      code.push('val mediaType = MediaType.parse("%s")', source.postData.mimeType);
-    }
-    code.push('val body = RequestBody.create(mediaType, %s)', JSON.stringify(source.postData.text));
-  }
-
-  code.push('val request = Request.Builder()');
-  code.push(1, '.url("%s")', source.fullUrl);
-  if (methods.indexOf(source.method.toUpperCase()) === -1) {
-    if (source.postData.text) {
-      code.push(1, '.method("%s", body)', source.method.toUpperCase());
-    } else {
-      code.push(1, '.method("%s", null)', source.method.toUpperCase());
-    }
-  } else if (methodsWithBody.indexOf(source.method.toUpperCase()) >= 0) {
-    if (source.postData.text) {
-      code.push(1, '.%s(body)', source.method.toLowerCase());
-    } else {
-      code.push(1, '.%s(null)', source.method.toLowerCase());
-    }
-  } else {
-    code.push(1, '.%s()', source.method.toLowerCase());
-  }
-
-  // Add headers, including the cookies
-  const headers = Object.keys(source.allHeaders);
-
-  // construct headers
-  if (headers.length) {
-    headers.forEach(function (key) {
-      code.push(1, '.addHeader("%s", "%s")', key, source.allHeaders[key]);
-    });
-  }
-
-  code.push(1, '.build()').blank().push('val response = client.newCall(request).execute()');
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'okhttp',
-  title: 'OkHttp',
-  link: 'http://square.github.io/okhttp/',
-  description: 'An HTTP Request Client Library',
-};

package/src/targets/node/axios.js

@@ -1,76 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for Javascript & Node.js using Axios.
- *
- * @author
- * @rohit-gohri
- *
- * 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);
-
-  code.push('const axios = require("axios").default;');
-
-  const reqOpts = {
-    method: source.method,
-    url: source.fullUrl,
-  };
-
-  if (Object.keys(source.allHeaders).length) {
-    reqOpts.headers = source.allHeaders;
-  }
-
-  switch (source.postData.mimeType) {
-    case 'application/x-www-form-urlencoded':
-      code.push("const { URLSearchParams } = require('url');");
-      code.blank();
-
-      code.push('const encodedParams = new URLSearchParams();');
-      source.postData.params.forEach(function (param) {
-        code.push(`encodedParams.set('${param.name}', '${param.value}');`);
-      });
-
-      reqOpts.data = 'encodedParams';
-      break;
-
-    case 'application/json':
-      if (source.postData.jsonObj) {
-        reqOpts.data = source.postData.jsonObj;
-      }
-      break;
-
-    default:
-      if (source.postData.text) {
-        reqOpts.data = source.postData.text;
-      }
-  }
-
-  code.blank();
-  code.push('const options = %s;', stringifyObject(reqOpts, { indent: '  ', inlineCharacterLimit: 80 })).blank();
-
-  code
-    .push('axios.request(options).then(function (response) {')
-    .push(1, 'console.log(response.data);')
-    .push('}).catch(%s', 'function (error) {')
-    .push(1, 'console.error(error);')
-    .push('});');
-
-  return code.join().replace(/'encodedParams'/, 'encodedParams,');
-};
-
-module.exports.info = {
-  key: 'axios',
-  title: 'Axios',
-  link: 'https://github.com/axios/axios',
-  description: 'Promise based HTTP client for the browser and node.js',
-};