Release/1.0.2

CHANGELOG.md

@@ -1,3 +1,11 @@
+v1.0.2 (Oct 15, 2020)
+* Fixed spaces around variables and arguments in Python codgen to comply with PEP 8.
+* Added Content-Length header to generated HTTP snippets.
+* Switched to multiline strings for Raw bodies in Go.
+* Stopped manually encoding response bodes in `utf8` for Python-requests.
+* Removed unnecessary semicolons at the end of statements in Ruby.
+* Fixed wrong name of HTTP codegen in README
+
 v1.0.1 (Jun 29, 2020)
 - Fix for - [8674](https://github.com/postmanlabs/postman-app-support/issues/8674): Add URL sanitization for quotes in cURL, Java Unirest, NodeJS Native, Python http.client, and Swift. 
 

codegens/golang/lib/index.js

@@ -1,5 +1,6 @@
 var _ = require('./lodash'),
   sanitize = require('./util').sanitize,
+  sanitizeMultiline = require('./util').sanitizeMultiline,
   sanitizeOptions = require('./util').sanitizeOptions,
   addFormParam = require('./util').addFormParam,
   isFile = false,
@@ -13,7 +14,7 @@ var _ = require('./lodash'),
  */
 function parseRawBody (body, trim) {
   var bodySnippet;
-  bodySnippet = `payload := strings.NewReader("${sanitize(body.toString(), trim)}")`;
+  bodySnippet = `payload := strings.NewReader(\`${sanitizeMultiline(body.toString(), trim)}\`)`;
   return bodySnippet;
 }
 
@@ -78,8 +79,9 @@ function parseFormData (body, trim, indent) {
          errFile${index + 1} := writer.CreateFormFile("${sanitize(data.key, trim)}",` +
                         `filepath.Base("${data.src}"))\n`;
         bodySnippet += `${indent}_, errFile${index + 1} = io.Copy(part${index + 1}, file)\n`;
-        bodySnippet += `${indent}if errFile${index + 1} !=nil {
-          \n${indent.repeat(2)}fmt.Println(errFile${index + 1})\n${indent}}\n`;
+        bodySnippet += `${indent}if errFile${index + 1} != nil {` +
+          `\n${indent.repeat(2)}fmt.Println(errFile${index + 1})\n` +
+          `${indent.repeat(2)}return\n${indent}}\n`;
       }
       else {
         bodySnippet += `${indent}_ = writer.WriteField("${sanitize(data.key, trim)}",`;
@@ -88,7 +90,8 @@ function parseFormData (body, trim, indent) {
     }
   });
   bodySnippet += `${indent}err := writer.Close()\n${indent}if err != nil ` +
-  `{\n${indent.repeat(2)}fmt.Println(err)\n${indent}}\n`;
+  `{\n${indent.repeat(2)}fmt.Println(err)\n` +
+  `${indent.repeat(2)}return\n${indent}}\n`;
   return bodySnippet;
 }
 
@@ -257,7 +260,8 @@ self = module.exports = {
     else {
       codeSnippet += `${indent}req, err := http.NewRequest(method, url, nil)\n\n`;
     }
-    codeSnippet += `${indent}if err != nil {\n${indent.repeat(2)}fmt.Println(err)\n${indent}}\n`;
+    codeSnippet += `${indent}if err != nil {\n${indent.repeat(2)}fmt.Println(err)\n`;
+    codeSnippet += `${indent.repeat(2)}return\n${indent}}\n`;
     if (request.body && !request.headers.has('Content-Type')) {
       if (request.body.mode === 'file') {
         request.addHeader({
@@ -280,7 +284,11 @@ self = module.exports = {
       codeSnippet += `${indent}req.Header.Set("Content-Type", writer.FormDataContentType())\n`;
     }
     responseSnippet = `${indent}res, err := client.Do(req)\n`;
-    responseSnippet += `${indent}defer res.Body.Close()\n${indent}body, err := ioutil.ReadAll(res.Body)\n\n`;
+    responseSnippet += `${indent}if err != nil {\n${indent.repeat(2)}fmt.Println(err)\n`;
+    responseSnippet += `${indent.repeat(2)}return\n${indent}}\n`;
+    responseSnippet += `${indent}defer res.Body.Close()\n\n${indent}body, err := ioutil.ReadAll(res.Body)\n`;
+    responseSnippet += `${indent}if err != nil {\n${indent.repeat(2)}fmt.Println(err)\n`;
+    responseSnippet += `${indent.repeat(2)}return\n${indent}}\n`;
     responseSnippet += `${indent}fmt.Println(string(body))\n}`;
 
     codeSnippet += responseSnippet;

codegens/golang/lib/util.js

@@ -16,6 +16,23 @@ module.exports = {
 
   },
 
+  /**
+     * sanitizes input string by handling escape characters eg: converts '''' to '\'\''
+     * and trim input if required
+     *
+     * @param {String} inputString
+     * @param {Boolean} [trim] - indicates whether to trim string or not
+     * @returns {String}
+     */
+  sanitizeMultiline: function (inputString, trim) {
+    if (typeof inputString !== 'string') {
+      return '';
+    }
+    inputString = inputString.replace(/`/g, '`+"`"+`');
+    return trim ? inputString.trim() : inputString;
+
+  },
+
   /**
     * sanitizes input options
     *

codegens/golang/test/unit/convert.test.js

@@ -165,5 +165,54 @@ describe('Golang convert function', function () {
         expect(snippet).to.include('writer.CreateFormFile("invalid src",filepath.Base("/path/to/file"))');
       });
     });
+
+    it('should add error handling code everytime an error is possible', function () {
+      var requests = [];
+      requests.push(new sdk.Request({
+        'method': 'GET',
+        'header': [
+          {
+            'key': 'foo',
+            'value': 'bar'
+          }
+        ],
+        'url': {
+          'raw': 'https://example.com',
+          'protocol': 'http',
+          'host': [
+            'example',
+            'com'
+          ]
+        }
+      }));
+      requests.push(new sdk.Request({
+        'method': 'POST',
+        'header': [],
+        'body': {
+          'mode': 'raw',
+          'raw': 'hello world'
+        },
+        'url': {
+          'raw': 'https://postman-echo.com/post',
+          'protocol': 'https',
+          'host': [
+            'postman-echo',
+            'com'
+          ],
+          'path': [
+            'post'
+          ]
+        }
+      }));
+      requests.forEach(function (request) {
+        convert(request, {}, function (error, snippet) {
+          if (error) {
+            expect.fail(null, null, error);
+          }
+          expect(snippet).to.be.a('string');
+          expect(snippet.match('err := ').length).to.be.equal(snippet.match('if err != nil {').length);
+        });
+      });
+    });
   });
 });

codegens/http/README.md

@@ -1,6 +1,6 @@
 # codegen-http
 
-> Converts Postman-SDK Request into code snippet for cURL.
+> Converts Postman-SDK Request into code snippet for RAW HTTP request.
 
 #### Prerequisites
 To run Code-Gen, ensure that you have NodeJS >= v8. A copy of the NodeJS installable can be downloaded from 

codegens/http/lib/code-http-converter.js

@@ -27,7 +27,8 @@ function getOptions () {
  * @returns {Function} returns the snippet with the callback function.
  */
 function convert (request, options, callback) {
-  let snippet = '';
+  let snippet = '',
+    body;
   options = utils.sanitizeOptions(options, getOptions());
   utils.parseURLVariable(request);
   snippet = `${request.method} ${utils.getEndPoint(request)} HTTP/1.1\n`;
@@ -46,6 +47,7 @@ function convert (request, options, callback) {
       });
     }
   }
+
   // The following code handles multiple files in the same formdata param.
   // It removes the form data params where the src property is an array of filepath strings
   // Splits that array into different form data params with src set as a single filepath string
@@ -87,9 +89,15 @@ function convert (request, options, callback) {
       formdata: formdataArray
     });
   }
+  body = utils.getBody(request, options.trimRequestBody);
+  if (body && body.length !== 0 && !request.headers.has('Content-Length')) {
+    request.addHeader({
+      key: 'Content-Length',
+      value: body.length
+    });
+  }
   snippet += `${utils.getHeaders(request)}\n`;
-  snippet += `\n${utils.getBody(request, options.trimRequestBody)}`;
-
+  snippet += `\n${body}`;
   return callback(null, snippet);
 }
 

codegens/http/lib/util.js

@@ -203,7 +203,7 @@ function getHeaders (request) {
   });
   headers = convertPropertyListToString(request.headers, '\n', false);
   if (request.body && request.body.mode === 'formdata' && contentTypeIndex < 0) {
-    headers += `Content-Type: ${formDataHeader}`;
+    headers += `\nContent-Type: ${formDataHeader}`;
   }
   return headers;
 }