@readme/httpsnippet 2.5.0 → 3.0.2

package/src/targets/javascript/axios.js

@@ -7,83 +7,88 @@
  *
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
-'use strict'
 
-const util = require('util')
-const stringifyObject = require('stringify-object')
-const CodeBuilder = require('../../helpers/code-builder')
+const stringifyObject = require('stringify-object');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  const opts = Object.assign({
-    indent: '  '
-  }, options)
+  const opts = {
+    indent: '  ',
+    ...options,
+  };
 
-  const code = new CodeBuilder(opts.indent)
+  const code = new CodeBuilder(opts.indent);
 
-  code.push('import axios from "axios";')
-    .blank()
+  code.push('import axios from "axios";').blank();
 
   const reqOpts = {
     method: source.method,
-    url: source.url
-  }
+    url: source.url,
+  };
 
   if (Object.keys(source.queryObj).length) {
-    reqOpts.params = source.queryObj
+    reqOpts.params = source.queryObj;
   }
 
   if (Object.keys(source.allHeaders).length) {
-    reqOpts.headers = source.allHeaders
+    reqOpts.headers = source.allHeaders;
   }
 
   switch (source.postData.mimeType) {
     case 'application/x-www-form-urlencoded':
-      reqOpts.data = source.postData.paramsObj
-      break
+      reqOpts.data = source.postData.paramsObj;
+      break;
 
     case 'application/json':
       if (source.postData.jsonObj) {
-        reqOpts.data = source.postData.jsonObj
+        reqOpts.data = source.postData.jsonObj;
       }
-      break
+      break;
 
     case 'multipart/form-data':
-      code.push('const form = new FormData();')
+      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 || '')
-        )
-      })
+        source.postData.params.forEach(function (param) {
+          code.push(
+            'form.append(%s, %s);',
+            JSON.stringify(param.name),
+            JSON.stringify(param.value || param.fileName || '')
+          );
+        });
 
-      code.blank()
+        code.blank();
 
-      reqOpts.data = '[form]'
-      break
+        reqOpts.data = '[form]';
+      }
+      break;
 
     default:
       if (source.postData.text) {
-        reqOpts.data = source.postData.text
+        reqOpts.data = source.postData.text;
       }
   }
 
-  code.push('const options = %s;', stringifyObject(reqOpts, { indent: '  ', inlineCharacterLimit: 80 }).replace('"[form]"', 'form'))
-    .blank()
+  code
+    .push(
+      'const options = %s;',
+      stringifyObject(reqOpts, { indent: '  ', inlineCharacterLimit: 80 }).replace('"[form]"', 'form')
+    )
+    .blank();
 
-  code.push(util.format('axios.request(options).then(%s', 'function (response) {'))
+  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('});')
+    .push('});');
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'axios',
   title: 'Axios',
   link: 'https://github.com/axios/axios',
-  description: 'Promise based HTTP client for the browser and node.js'
-}
+  description: 'Promise based HTTP client for the browser and node.js',
+};

package/src/targets/javascript/fetch.js

@@ -8,108 +8,106 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-const stringifyObject = require('stringify-object')
-const CodeBuilder = require('../../helpers/code-builder')
+const stringifyObject = require('stringify-object');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  const opts = Object.assign(
-    {
-      indent: '  ',
-      credentials: null
-    },
-    options
-  )
-
-  const code = new CodeBuilder(opts.indent)
-
-  options = {
-    method: source.method
-  }
+  const opts = {
+    indent: '  ',
+    credentials: null,
+    ...options,
+  };
+
+  const code = new CodeBuilder(opts.indent);
+
+  const reqOptions = {
+    method: source.method,
+  };
 
   if (Object.keys(source.allHeaders).length) {
-    options.headers = source.allHeaders
+    reqOptions.headers = source.allHeaders;
   }
 
   if (opts.credentials !== null) {
-    options.credentials = opts.credentials
+    reqOptions.credentials = opts.credentials;
   }
 
   switch (source.postData.mimeType) {
     case 'application/x-www-form-urlencoded':
-      options.body = source.postData.paramsObj
-        ? source.postData.paramsObj
-        : source.postData.text
-      break
+      reqOptions.body = source.postData.paramsObj ? source.postData.paramsObj : source.postData.text;
+      break;
 
     case 'application/json':
       if (source.postData.jsonObj) {
-        options.body = opts.useObjectBody ? source.postData.jsonObj : JSON.stringify(source.postData.jsonObj)
+        reqOptions.body = source.postData.jsonObj;
       }
-      break
+      break;
 
     case 'multipart/form-data':
-      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
+      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();
+      }
+      break;
 
     default:
       if (source.postData.text) {
-        options.body = source.postData.text
+        reqOptions.body = source.postData.text;
       }
   }
 
-  code.push('const options = %s;', stringifyObject(options, {
-    indent: opts.indent,
-    inlineCharacterLimit: 80,
-
-    // The Fetch API body only accepts string parameters, but stringified JSON can be difficult to
-    // read, so if you pass the `useObjectBody` option 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})`
-        }
-
-        if (opts.useObjectBody) {
-          if (source.postData.mimeType === 'application/json') {
-            return 'JSON.stringify(' + originalResult + ')'
+  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()
+          return originalResult;
+        },
+      })
+    )
+    .blank();
 
   if (source.postData.mimeType === 'multipart/form-data') {
-    code.push('options.body = form;')
-      .blank()
+    if (source.postData.params) {
+      code.push('options.body = form;').blank();
+    }
   }
 
-  code.push("fetch('%s', options)", source.fullUrl)
+  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));')
+    .push(1, '.catch(err => console.error(err));');
 
-  return code.join()
-}
+  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'
-}
+  description: 'Perform asynchronous HTTP requests with the Fetch API',
+};

package/src/targets/javascript/index.js

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

package/src/targets/javascript/jquery.js

@@ -8,76 +8,82 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-const CodeBuilder = require('../../helpers/code-builder')
-const helpers = require('../../helpers/headers')
+const CodeBuilder = require('../../helpers/code-builder');
+const helpers = require('../../helpers/headers');
 
 module.exports = function (source, options) {
-  const opts = Object.assign({
-    indent: '  '
-  }, options)
+  const opts = {
+    indent: '  ',
+    ...options,
+  };
 
-  const code = new CodeBuilder(opts.indent)
+  const code = new CodeBuilder(opts.indent);
 
   const settings = {
     async: true,
     crossDomain: true,
     url: source.fullUrl,
     method: source.method,
-    headers: source.allHeaders
-  }
+    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
+      settings.data = source.postData.paramsObj ? source.postData.paramsObj : source.postData.text;
+      break;
 
     case 'application/json':
-      settings.processData = false
-      settings.data = source.postData.text
-      break
+      settings.processData = false;
+      settings.data = source.postData.text;
+      break;
 
     case 'multipart/form-data':
-      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')]
+      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
+        code.blank();
+      }
+      break;
 
     default:
       if (source.postData.text) {
-        settings.data = source.postData.text
+        settings.data = source.postData.text;
       }
   }
 
-  code.push('const settings = ' + JSON.stringify(settings, null, opts.indent).replace('"[form]"', 'form') + ';')
+  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('});')
+    .push('});');
 
-  return code.join()
-}
+  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'
-}
+  description: 'Perform an asynchronous HTTP (Ajax) requests with jQuery',
+};

package/src/targets/javascript/xhr.js

@@ -8,75 +8,79 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-const CodeBuilder = require('../../helpers/code-builder')
-const helpers = require('../../helpers/headers')
+const CodeBuilder = require('../../helpers/code-builder');
+const helpers = require('../../helpers/headers');
 
 module.exports = function (source, options) {
-  const opts = Object.assign({
+  const opts = {
     indent: '  ',
-    cors: true
-  }, options)
+    cors: true,
+    ...options,
+  };
 
-  const code = new CodeBuilder(opts.indent)
+  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))
-        .push(null)
-      break
+      code.push('const data = JSON.stringify(%s);', JSON.stringify(source.postData.jsonObj, null, opts.indent)).blank();
+      break;
 
     case 'multipart/form-data':
-      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')) {
-          delete source.allHeaders[helpers.getHeaderName(source.allHeaders, 'content-type')]
+      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
+        code.blank();
+      }
+      break;
 
     default:
-      code.push('const data = %s;', JSON.stringify(source.postData.text || null))
-        .blank()
+      code.push('const data = %s;', JSON.stringify(source.postData.text || null)).blank();
   }
 
-  code.push('const xhr = new XMLHttpRequest();')
+  code.push('const xhr = new XMLHttpRequest();');
 
   if (opts.cors) {
-    code.push('xhr.withCredentials = true;')
+    code.push('xhr.withCredentials = true;');
   }
 
-  code.blank()
+  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))
+    .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.push('xhr.setRequestHeader(%s, %s);', JSON.stringify(key), JSON.stringify(source.allHeaders[key]));
+  });
 
-  code.blank()
-    .push('xhr.send(data);')
+  code.blank().push('xhr.send(data);');
 
-  return code.join()
-}
+  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'
-}
+  description: 'W3C Standard API that provides scripted client functionality',
+};

package/src/targets/kotlin/index.js

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