@readme/httpsnippet 3.0.3 → 3.1.0

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.0",
   "name": "@readme/httpsnippet",
   "description": "HTTP Request snippet generator for *most* languages",
   "homepage": "https://github.com/readmeio/httpsnippet",

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/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',
-};