Merge pull request #666 from dhwaneetbhatt/develop

Do not add HTTP method explicitly in curl when not required

Author: Dhwaneet Bhatt

codegens/curl/lib/index.js

@@ -3,6 +3,7 @@ var sanitize = require('./util').sanitize,
   getUrlStringfromUrlObject = require('./util').getUrlStringfromUrlObject,
   addFormParam = require('./util').addFormParam,
   form = require('./util').form,
+  shouldAddHttpMethod = require('./util').shouldAddHttpMethod,
   _ = require('./lodash'),
   self;
 
@@ -44,12 +45,14 @@ self = module.exports = {
     else {
       indent = ' ';
     }
+
     if (request.method === 'HEAD') {
-      snippet += ` ${form('-I', format)} ${quoteType + url + quoteType}`;
+      snippet += ` ${form('-I', format)}`;
     }
-    else {
-      snippet += ` ${form('-X', format)} ${request.method} ${quoteType + url + quoteType}`;
+    if (shouldAddHttpMethod(request, options)) {
+      snippet += ` ${form('-X', format)} ${request.method}`;
     }
+    snippet += ` ${quoteType + url + quoteType}`;
 
     if (request.body && !request.headers.has('Content-Type')) {
       if (request.body.mode === 'file') {
@@ -236,6 +239,13 @@ self = module.exports = {
         default: true,
         description: 'Automatically follow HTTP redirects'
       },
+      {
+        name: 'Follow original HTTP method',
+        id: 'followOriginalHttpMethod',
+        type: 'boolean',
+        default: false,
+        description: 'Redirect with the original HTTP method instead of the default behavior of redirecting with GET'
+      },
       {
         name: 'Trim request body fields',
         id: 'trimRequestBody',

codegens/curl/lib/util.js

@@ -1,3 +1,5 @@
+const _ = require('./lodash');
+
 var self = module.exports = {
   /**
      * sanitizes input string by handling escape characters eg: converts '''' to '\'\'', (" to \"  and \ to \\ )
@@ -199,5 +201,78 @@ var self = module.exports = {
         contentType: contentType
       });
     }
+  },
+
+  /**
+   * @param {Object} body
+   * @returns {boolean}
+   *
+   * Determines if a request body is actually empty.
+   * This is needed because body.isEmpty() returns false for formdata
+   * and urlencoded when they contain only disabled params which will not
+   * be a part of the curl request.
+   */
+  isBodyEmpty (body) {
+    if (!body) {
+      return true;
+    }
+
+    if (body.isEmpty()) {
+      return true;
+    }
+
+    if (body.mode === 'formdata' || body.mode === 'urlencoded') {
+      let memberCount = 0;
+      body[body.mode] && body[body.mode].members && body[body.mode].members.forEach((param) => {
+        if (!param.disabled) {
+          memberCount += 1;
+        }
+      });
+
+      return memberCount === 0;
+    }
+
+    return false;
+  },
+
+  /**
+   * Decide whether we should add the HTTP method explicitly to the cURL command.
+   *
+   * @param {Object} request
+   * @param {Object} options
+   *
+   * @returns {Boolean}
+   */
+  shouldAddHttpMethod: function (request, options) {
+    const followRedirect = _.get(request, 'protocolProfileBehavior.followRedirects', options.followRedirect),
+      followOriginalHttpMethod =
+      _.get(request, 'protocolProfileBehavior.followOriginalHttpMethod', options.followOriginalHttpMethod),
+      disableBodyPruning = _.get(request, 'protocolProfileBehavior.disableBodyPruning', true),
+      isBodyEmpty = self.isBodyEmpty(request.body);
+
+    if (followRedirect && followOriginalHttpMethod) {
+      return true;
+    }
+
+    switch (request.method) {
+      case 'HEAD':
+        return false;
+      case 'GET':
+        // disableBodyPruning will generally not be present in the request
+        // the only time it will be present, its value will be _false_
+        // i.e. the user wants to prune the request body despite it being present
+        if (!isBodyEmpty && disableBodyPruning) {
+          return true;
+        }
+
+        return false;
+      case 'POST':
+        return isBodyEmpty;
+      case 'DELETE':
+      case 'PUT':
+      case 'PATCH':
+      default:
+        return true;
+    }
   }
 };