@readme/httpsnippet 3.0.3 → 3.1.2

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Mashape (https://www.mashape.com)
+Copyright (c) 2022 ReadMe (https://readme.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -160,6 +160,7 @@ The main difference between this library and the upstream [httpsnippet](https://
 * Contains a `harIsAlreadyEncoded` option on the core library to disable [escaping](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) of cookies and query strings in URLs. Helpful if the HAR being supplied already has them escaped.
 * PHP Guzzle snippets come with `require_once('vendor/autoload.php');` at the top of them.
 * A full integration suite for testing out snippets the library creates.
+* This library does not ship a Python client for [http.client](https://docs.python.org/3/library/http.client.html) due to its limitations in supporting file uploads.
 
 ### Running the integration suite
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.0.3",
+  "version": "3.1.2",
   "name": "@readme/httpsnippet",
   "description": "HTTP Request snippet generator for *most* languages",
   "homepage": "https://github.com/readmeio/httpsnippet",
@@ -55,8 +55,8 @@
   "devDependencies": {
     "@readme/eslint-config": "^8.0.2",
     "eslint": "^8.3.0",
-    "glob": "^7.1.7",
-    "jest": "^27.2.0",
+    "glob": "^8.0.1",
+    "jest": "^28.0.3",
     "prettier": "^2.5.0",
     "require-directory": "^2.1.1"
   },

package/src/targets/javascript/axios.js

@@ -36,7 +36,14 @@ module.exports = function (source, options) {
 
   switch (source.postData.mimeType) {
     case 'application/x-www-form-urlencoded':
-      reqOpts.data = source.postData.paramsObj;
+      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':
@@ -83,7 +90,7 @@ module.exports = function (source, options) {
     .push(1, 'console.error(error);')
     .push('});');
 
-  return code.join();
+  return code.join().replace(/'encodedParams'/, 'encodedParams,');
 };
 
 module.exports.info = {

package/src/targets/javascript/fetch.js

@@ -10,6 +10,7 @@
 
 const stringifyObject = require('stringify-object');
 const CodeBuilder = require('../../helpers/code-builder');
+const { getHeaderName } = require('../../helpers/headers');
 
 module.exports = function (source, options) {
   const opts = {
@@ -45,6 +46,15 @@ module.exports = function (source, options) {
 
     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) {
@@ -65,6 +75,12 @@ module.exports = function (source, options) {
       }
   }
 
+  // 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;',

package/src/targets/node/axios.js

@@ -33,9 +33,9 @@ module.exports = function (source, options) {
   switch (source.postData.mimeType) {
     case 'application/x-www-form-urlencoded':
       code.push("const { URLSearchParams } = require('url');");
-      code.push('const encodedParams = new URLSearchParams();');
       code.blank();
 
+      code.push('const encodedParams = new URLSearchParams();');
       source.postData.params.forEach(function (param) {
         code.push(`encodedParams.set('${param.name}', '${param.value}');`);
       });
@@ -65,7 +65,7 @@ module.exports = function (source, options) {
     .push(1, 'console.error(error);')
     .push('});');
 
-  return code.join().replace(/'encodedParams'/, 'encodedParams');
+  return code.join().replace(/'encodedParams'/, 'encodedParams,');
 };
 
 module.exports.info = {

package/src/targets/node/fetch.js

@@ -27,18 +27,6 @@ module.exports = function (source, options) {
     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.allHeaders).length) {
     reqOpts.headers = source.allHeaders;
   }
@@ -64,6 +52,16 @@ module.exports = function (source, options) {
 
     case 'multipart/form-data':
       if (source.postData.params) {
+        // 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 (reqOpts.headers) {
+          const contentTypeHeader = headerHelpers.getHeaderName(reqOpts.headers, 'content-type');
+          if (contentTypeHeader) {
+            delete reqOpts.headers[contentTypeHeader];
+          }
+        }
+
         code.unshift("const FormData = require('form-data');");
         code.push('const formData = new FormData();');
         code.blank();
@@ -88,6 +86,12 @@ module.exports = function (source, options) {
       }
   }
 
+  // If we ultimately don't have any headers to send then we shouldn't add an empty object into
+  // the request options.
+  if (reqOpts.headers && !Object.keys(reqOpts.headers).length) {
+    delete reqOpts.headers;
+  }
+
   code.blank();
   code.push(`const url = '${url}';`);
   code

package/src/targets/php/guzzle.js

@@ -129,7 +129,7 @@ module.exports = function (source, options) {
 
 module.exports.info = {
   key: 'guzzle',
-  title: 'Guzzle v7',
+  title: 'Guzzle',
   link: 'http://docs.guzzlephp.org/en/stable/',
-  description: 'PHP with guzzle v7',
+  description: 'PHP with guzzle',
 };

package/src/targets/python/index.js

@@ -3,10 +3,9 @@ module.exports = {
     key: 'python',
     title: 'Python',
     extname: '.py',
-    default: 'python3',
+    default: 'requests',
     cli: 'python3 %s',
   },
 
-  python3: require('./python3'),
   requests: require('./requests'),
 };

package/src/targets/python/requests.js

@@ -11,6 +11,7 @@
 const { format } = require('util');
 const CodeBuilder = require('../../helpers/code-builder');
 const helpers = require('./helpers');
+const headerHelpers = require('../../helpers/headers');
 
 module.exports = function (source, options) {
   const opts = {
@@ -28,28 +29,74 @@ module.exports = function (source, options) {
   // Set URL
   code.push('url = "%s"', source.fullUrl).blank();
 
+  const headers = source.allHeaders;
+
   // Construct payload
+  let payload;
+  let hasFiles = false;
   let hasPayload = false;
   let jsonPayload = false;
-  if (source.postData.mimeType === 'application/json') {
-    if (source.postData.jsonObj) {
-      code.push('payload = %s', helpers.literalRepresentation(source.postData.jsonObj, opts));
-      jsonPayload = true;
-      hasPayload = true;
-    }
-  } else {
-    const payload = JSON.stringify(source.postData.text);
-    if (payload) {
-      code.push('payload = %s', payload);
-      hasPayload = true;
-    }
+  switch (source.postData.mimeType) {
+    case 'application/json':
+      if (source.postData.jsonObj) {
+        code.push('payload = %s', helpers.literalRepresentation(source.postData.jsonObj, opts));
+        jsonPayload = true;
+        hasPayload = true;
+      }
+      break;
+
+    case 'multipart/form-data':
+      if (source.postData.params) {
+        const files = {};
+        payload = {};
+
+        source.postData.params.forEach(p => {
+          if (p.fileName) {
+            files[p.name] = `open('${p.fileName}', 'rb')`;
+            hasFiles = true;
+          } else {
+            payload[p.name] = p.value;
+            hasPayload = true;
+          }
+        });
+
+        if (hasFiles) {
+          code.push('files = %s', helpers.literalRepresentation(files, opts));
+
+          if (hasPayload) {
+            code.push('payload = %s', helpers.literalRepresentation(payload, opts));
+          }
+
+          // The requests library will only automatically add a `multipart/form-data` header if
+          // there are files being sent. If we're **only** sending form data we still need to send
+          // the boundary ourselves.
+          delete headers[headerHelpers.getHeaderName(headers, 'content-type')];
+        } else {
+          payload = JSON.stringify(source.postData.text);
+          if (payload) {
+            code.push('payload = %s', payload);
+            hasPayload = true;
+          }
+        }
+      }
+      break;
+
+    default:
+      payload = JSON.stringify(source.postData.text);
+      if (payload) {
+        code.push('payload = %s', payload);
+        hasPayload = true;
+      }
   }
 
   // Construct headers
-  const headers = source.allHeaders;
   const headerCount = Object.keys(headers).length;
 
-  if (headerCount === 1) {
+  if (!headerCount && (hasPayload || hasFiles)) {
+    // If we don't have any heads but we do have a payload we should put a blank line here between
+    // that payload consturction and our execution of the requests library.
+    code.blank();
+  } else if (headerCount === 1) {
     Object.keys(headers).forEach(header => {
       code.push('headers = {"%s": "%s"}', header, headers[header]).blank();
     });
@@ -72,7 +119,13 @@ module.exports = function (source, options) {
 
   // Construct request
   const method = source.method;
-  let request = format('response = requests.request("%s", url', method);
+  let request;
+  // Method list pulled from their api reference https://docs.python-requests.org/en/latest/api/#requests.head
+  if (['HEAD', 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'].includes(method)) {
+    request = format('response = requests.%s(url', method.toLowerCase());
+  } else {
+    request = format('response = requests.request("%s", url', method);
+  }
 
   if (hasPayload) {
     if (jsonPayload) {
@@ -82,6 +135,10 @@ module.exports = function (source, options) {
     }
   }
 
+  if (hasFiles) {
+    request += ', files=files';
+  }
+
   if (headerCount > 0) {
     request += ', headers=headers';
   }
@@ -90,7 +147,12 @@ module.exports = function (source, options) {
 
   code.push(request).blank().push('print(response.text)');
 
-  return code.join();
+  return (
+    code
+      .join()
+      // The `open()` call must be a literal in the code snippet.
+      .replace(/"open\('(.+)', 'rb'\)"/g, 'open("$1", "rb")')
+  );
 };
 
 module.exports.info = {

package/src/targets/r/httr.js

@@ -75,24 +75,20 @@ module.exports = function (source) {
   }
 
   // Construct headers
-  const headers = source.allHeaders;
-  let headerCount = 0;
-  let header = '';
+  const headers = [];
   let cookies;
   let accept;
 
-  Object.keys(headers).forEach(head => {
-    if (head.toLowerCase() === 'accept') {
-      accept = `, accept("${headers[head]}")`;
-      headerCount += 1;
-    } else if (head.toLowerCase() === 'cookie') {
-      cookies = `, set_cookies(\`${headers[head].replace(/;/g, '", `').replace(/` /g, '`').replace(/=/g, '` = "')}")`;
-      headerCount += 1;
-    } else if (head.toLowerCase() !== 'content-type') {
-      header = `${header + head.replace('-', '_')} = '${headers[head]}`;
-      if (headerCount > 1) {
-        header += "', ";
-      }
+  Object.keys(source.allHeaders).forEach(header => {
+    if (header.toLowerCase() === 'accept') {
+      accept = `, accept("${source.allHeaders[header]}")`;
+    } else if (header.toLowerCase() === 'cookie') {
+      cookies = `, set_cookies(\`${source.allHeaders[header]
+        .replace(/;/g, '", `')
+        .replace(/` /g, '`')
+        .replace(/=/g, '` = "')}")`;
+    } else if (header.toLowerCase() !== 'content-type') {
+      headers.push(`'${header}' = '${source.allHeaders[header]}'`);
     }
   });
 
@@ -104,8 +100,8 @@ module.exports = function (source) {
     request += ', body = payload';
   }
 
-  if (header !== '') {
-    request += `, add_headers(${header}')`;
+  if (headers.length) {
+    request += `, add_headers(${headers.join(', ')})`;
   }
 
   if (source.queryString.length) {

package/src/targets/python/python3.js

@@ -1,80 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for native Python3.
- *
- * @author
- * @montanaflynn
- *
- * 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) {
-  const code = new CodeBuilder();
-  // Start Request
-  code.push('import http.client').blank();
-
-  // Check which protocol to be used for the client connection
-  const protocol = source.uriObj.protocol;
-  if (protocol === 'https:') {
-    code.push('conn = http.client.HTTPSConnection("%s")', source.uriObj.host).blank();
-  } else {
-    code.push('conn = http.client.HTTPConnection("%s")', source.uriObj.host).blank();
-  }
-
-  // Create payload string if it exists
-  const payload = JSON.stringify(source.postData.text);
-  if (payload) {
-    code.push('payload = %s', payload).blank();
-  }
-
-  // Create Headers
-  const headers = source.allHeaders;
-  const headerCount = Object.keys(headers).length;
-  if (headerCount === 1) {
-    Object.keys(headers).forEach(header => {
-      code.push('headers = { \'%s\': "%s" }', header, headers[header]).blank();
-    });
-  } else if (headerCount > 1) {
-    let count = 1;
-
-    code.push('headers = {');
-
-    Object.keys(headers).forEach(header => {
-      // eslint-disable-next-line no-plusplus
-      if (count++ !== headerCount) {
-        code.push('    \'%s\': "%s",', header, headers[header]);
-      } else {
-        code.push('    \'%s\': "%s"', header, headers[header]);
-      }
-    });
-
-    code.push('    }').blank();
-  }
-
-  // Make Request
-  const method = source.method;
-  const path = source.uriObj.path;
-  if (payload && headerCount) {
-    code.push('conn.request("%s", "%s", payload, headers)', method, path);
-  } else if (payload && !headerCount) {
-    code.push('conn.request("%s", "%s", payload)', method, path);
-  } else if (!payload && headerCount) {
-    code.push('conn.request("%s", "%s", headers=headers)', method, path);
-  } else {
-    code.push('conn.request("%s", "%s")', method, path);
-  }
-
-  // Get Response
-  code.blank().push('res = conn.getresponse()').push('data = res.read()').blank().push('print(data.decode("utf-8"))');
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'python3',
-  title: 'http.client',
-  link: 'https://docs.python.org/3/library/http.client.html',
-  description: 'Python3 HTTP Client',
-};