@readme/httpsnippet 2.5.0 → 3.0.2

package/src/targets/kotlin/okhttp.js

@@ -8,71 +8,71 @@
  * 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 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);
 
-  const methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD']
+  const methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD'];
 
-  const methodsWithBody = ['POST', 'PUT', 'DELETE', 'PATCH']
+  const methodsWithBody = ['POST', 'PUT', 'DELETE', 'PATCH'];
 
-  code.push('val client = OkHttpClient()')
-    .blank()
+  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)
+      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 mediaType = MediaType.parse("%s")', source.postData.mimeType);
     }
-    code.push('val body = RequestBody.create(mediaType, %s)', JSON.stringify(source.postData.text))
+    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)
+  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())
+      code.push(1, '.method("%s", body)', source.method.toUpperCase());
     } else {
-      code.push(1, '.method("%s", null)', source.method.toUpperCase())
+      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())
+      code.push(1, '.%s(body)', source.method.toLowerCase());
     } else {
-      code.push(1, '.%s(null)', source.method.toLowerCase())
+      code.push(1, '.%s(null)', source.method.toLowerCase());
     }
   } else {
-    code.push(1, '.%s()', source.method.toLowerCase())
+    code.push(1, '.%s()', source.method.toLowerCase());
   }
 
   // Add headers, including the cookies
-  const headers = Object.keys(source.allHeaders)
+  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, '.addHeader("%s", "%s")', key, source.allHeaders[key]);
+    });
   }
 
-  code.push(1, '.build()')
-    .blank()
-    .push('val response = client.newCall(request).execute()')
+  code.push(1, '.build()').blank().push('val response = client.newCall(request).execute()');
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'okhttp',
   title: 'OkHttp',
   link: 'http://square.github.io/okhttp/',
-  description: 'An HTTP Request Client Library'
-}
+  description: 'An HTTP Request Client Library',
+};

package/src/targets/node/axios.js

@@ -7,67 +7,70 @@
  *
  * 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('var axios = require("axios").default;')
-    .blank()
+  code.push('const axios = require("axios").default;');
 
   const reqOpts = {
     method: source.method,
-    url: source.url
-  }
-
-  if (Object.keys(source.queryObj).length) {
-    reqOpts.params = source.queryObj
-  }
+    url: source.fullUrl,
+  };
 
   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
+      code.push("const { URLSearchParams } = require('url');");
+      code.push('const encodedParams = new URLSearchParams();');
+      code.blank();
+
+      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
+        reqOpts.data = source.postData.jsonObj;
       }
-      break
+      break;
 
     default:
       if (source.postData.text) {
-        reqOpts.data = source.postData.text
+        reqOpts.data = source.postData.text;
       }
   }
 
-  code.push('var options = %s;', stringifyObject(reqOpts, { indent: '  ', inlineCharacterLimit: 80 }))
-    .blank()
+  code.blank();
+  code.push('const options = %s;', stringifyObject(reqOpts, { indent: '  ', inlineCharacterLimit: 80 })).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().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'
-}
+  description: 'Promise based HTTP client for the browser and node.js',
+};

package/src/targets/node/fetch.js

@@ -8,128 +8,134 @@
  * 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 headerHelpers = require('../../helpers/headers');
+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,
+  };
 
-  let includeFS = false
-  const code = new CodeBuilder(opts.indent)
+  let includeFS = false;
+  const code = new CodeBuilder(opts.indent);
 
-  code.push('const fetch = require(\'node-fetch\');')
-  const url = source.fullUrl
+  code.push("const fetch = require('node-fetch');");
+  const url = source.fullUrl;
   const reqOpts = {
-    method: source.method
+    method: source.method,
+  };
+
+  // The `form-data` library automatically adds a `Content-Type` header for `multipart/form-data` content and if we
+  // add our own here, data won't be correctly transferred.
+  if (source.postData.mimeType === 'multipart/form-data') {
+    if (source.postData.params) {
+      const contentTypeHeader = headerHelpers.getHeaderName(source.allHeaders, 'content-type');
+      if (contentTypeHeader) {
+        // eslint-disable-next-line no-param-reassign
+        delete source.allHeaders[contentTypeHeader];
+      }
+    }
   }
 
-  if (Object.keys(source.headersObj).length) {
-    reqOpts.headers = source.headersObj
+  if (Object.keys(source.allHeaders).length) {
+    reqOpts.headers = source.allHeaders;
   }
 
   switch (source.postData.mimeType) {
     case 'application/x-www-form-urlencoded':
-      code.unshift('const { URLSearchParams } = require(\'url\');')
-      code.push('const encodedParams = new URLSearchParams();')
-      code.blank()
+      code.unshift("const { URLSearchParams } = require('url');");
+      code.push('const encodedParams = new URLSearchParams();');
+      code.blank();
 
       source.postData.params.forEach(function (param) {
-        code.push('encodedParams.set(\'' + param.name + '\', \'' + param.value + '\');')
-      })
+        code.push(`encodedParams.set('${param.name}', '${param.value}');`);
+      });
 
-      reqOpts.body = 'encodedParams'
-      break
+      reqOpts.body = 'encodedParams';
+      break;
 
     case 'application/json':
       if (source.postData.jsonObj) {
-        reqOpts.body = options.useObjectBody ? source.postData.jsonObj : JSON.stringify(source.postData.jsonObj)
+        reqOpts.body = source.postData.jsonObj;
       }
-      break
+      break;
 
     case 'multipart/form-data':
-      code.unshift('const FormData = require(\'form-data\');')
-      code.push('const formData = new FormData();')
-      code.blank()
-
-      source.postData.params.forEach(function (param) {
-        if (!param.fileName && !param.fileName && !param.contentType) {
-          code.push('formData.append(\'' + param.name + '\', \'' + param.value + '\');')
-          return
-        }
-
-        if (param.fileName) {
-          includeFS = true
-          code.push('formData.append(\'' + param.name + '\', fs.createReadStream(\'' + param.fileName + '\'));')
-        }
-      })
-      break
+      if (source.postData.params) {
+        code.unshift("const FormData = require('form-data');");
+        code.push('const formData = new FormData();');
+        code.blank();
+
+        source.postData.params.forEach(function (param) {
+          if (!param.fileName && !param.contentType) {
+            code.push(`formData.append('${param.name}', '${param.value}');`);
+            return;
+          }
+
+          if (param.fileName) {
+            includeFS = true;
+            code.push(`formData.append('${param.name}', fs.createReadStream('${param.fileName}'));`);
+          }
+        });
+      }
+      break;
 
     default:
       if (source.postData.text) {
-        reqOpts.body = source.postData.text
+        reqOpts.body = source.postData.text;
       }
   }
 
-  // construct cookies argument
-  if (source.cookies.length) {
-    let cookies = ''
-    source.cookies.forEach(function (cookie) {
-      cookies = cookies + encodeURIComponent(cookie.name) + '=' + encodeURIComponent(cookie.value) + '; '
-    })
-
-    if (reqOpts.headers) {
-      reqOpts.headers.cookie = cookies
-    } else {
-      reqOpts.headers = {}
-      reqOpts.headers.cookie = cookies
-    }
-  }
-
-  code.blank()
-  code.push('const url = \'' + url + '\';')
-  code.push('const options = %s;', stringifyObject(reqOpts, {
-    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' && opts.useObjectBody && source.postData.mimeType === 'application/json') {
-        return 'JSON.stringify(' + originalResult + ')'
-      }
-
-      return originalResult
-    }
-  }))
-    .blank()
+  code.blank();
+  code.push(`const url = '${url}';`);
+  code
+    .push(
+      'const options = %s;',
+      stringifyObject(reqOpts, {
+        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' && source.postData.mimeType === 'application/json') {
+            return `JSON.stringify(${originalResult})`;
+          }
+
+          return originalResult;
+        },
+      })
+    )
+    .blank();
 
   if (includeFS) {
-    code.unshift('const fs = require(\'fs\');')
+    code.unshift("const fs = require('fs');");
   }
 
   if (source.postData.mimeType === 'multipart/form-data') {
-    code.push('options.body = formData;')
-      .blank()
+    if (source.postData.params) {
+      code.push('options.body = formData;').blank();
+    }
   }
 
-  code.push('fetch(url, options)')
+  code
+    .push('fetch(url, options)')
     .push(1, '.then(res => res.json())')
     .push(1, '.then(json => console.log(json))')
-    .push(1, '.catch(err => console.error(\'error:\' + err));')
+    .push(1, ".catch(err => console.error('error:' + err));");
 
-  return code.join()
+  return code
+    .join()
     .replace(/'encodedParams'/, 'encodedParams')
-    .replace(/"fs\.createReadStream\(\\"(.+)\\"\)"/, 'fs.createReadStream("$1")')
-}
+    .replace(/"fs\.createReadStream\(\\"(.+)\\"\)"/, 'fs.createReadStream("$1")');
+};
 
 module.exports.info = {
   key: 'fetch',
   title: 'Fetch',
   link: 'https://github.com/bitinn/node-fetch',
-  description: 'Simplified HTTP node-fetch client'
-}
+  description: 'Simplified HTTP node-fetch client',
+};

package/src/targets/node/index.js

@@ -1,16 +1,15 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'node',
     title: 'Node.js',
     extname: '.js',
-    default: 'native'
+    default: 'native',
+    cli: 'node %s',
   },
 
   native: require('./native'),
   request: require('./request'),
   unirest: require('./unirest'),
   axios: require('./axios'),
-  fetch: require('./fetch')
-}
+  fetch: require('./fetch'),
+};

package/src/targets/node/native.js

@@ -8,29 +8,29 @@
  * 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: '  '
-  }, options)
+  const opts = {
+    indent: '  ',
+    ...options,
+  };
 
-  const code = new CodeBuilder(opts.indent)
+  const code = new CodeBuilder(opts.indent);
 
   const reqOpts = {
     method: source.method,
     hostname: source.uriObj.hostname,
     port: source.uriObj.port,
     path: source.uriObj.path,
-    headers: source.allHeaders
-  }
+    headers: source.allHeaders,
+  };
 
-  code.push('const http = require("%s");', source.uriObj.protocol.replace(':', ''))
+  code.push('const http = require("%s");', source.uriObj.protocol.replace(':', ''));
 
-  code.blank()
+  code
+    .blank()
     .push('const options = %s;', JSON.stringify(reqOpts, null, opts.indent))
     .blank()
     .push('const req = http.request(options, function (res) {')
@@ -45,42 +45,48 @@ module.exports = function (source, options) {
     .push(2, 'console.log(body.toString());')
     .push(1, '});')
     .push('});')
-    .blank()
+    .blank();
 
   switch (source.postData.mimeType) {
     case 'application/x-www-form-urlencoded':
       if (source.postData.paramsObj) {
-        code.unshift('const qs = require("querystring");')
-        code.push('req.write(qs.stringify(%s));', stringifyObject(source.postData.paramsObj, {
-          indent: '  ',
-          inlineCharacterLimit: 80
-        }))
+        code.unshift('const qs = require("querystring");');
+        code.push(
+          'req.write(qs.stringify(%s));',
+          stringifyObject(source.postData.paramsObj, {
+            indent: '  ',
+            inlineCharacterLimit: 80,
+          })
+        );
       }
-      break
+      break;
 
     case 'application/json':
       if (source.postData.jsonObj) {
-        code.push('req.write(JSON.stringify(%s));', stringifyObject(source.postData.jsonObj, {
-          indent: '  ',
-          inlineCharacterLimit: 80
-        }))
+        code.push(
+          'req.write(JSON.stringify(%s));',
+          stringifyObject(source.postData.jsonObj, {
+            indent: '  ',
+            inlineCharacterLimit: 80,
+          })
+        );
       }
-      break
+      break;
 
     default:
       if (source.postData.text) {
-        code.push('req.write(%s);', JSON.stringify(source.postData.text, null, opts.indent))
+        code.push('req.write(%s);', JSON.stringify(source.postData.text, null, opts.indent));
       }
   }
 
-  code.push('req.end();')
+  code.push('req.end();');
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'native',
   title: 'HTTP',
   link: 'http://nodejs.org/api/http.html#http_http_request_options_callback',
-  description: 'Node.js native HTTP interface'
-}
+  description: 'Node.js native HTTP interface',
+};