Merge pull request #398 from postmanlabs/someshkoli-fix/quoteOption

Adds additional option to curl codegen

Author: umeshp7

codegens/curl/README.md

@@ -13,14 +13,15 @@ Convert function takes three parameters
 
 * `request` - Postman-SDK Request Object
 
-* `options` - options is an object which hsa following properties
+* `options` - options is an object which has following properties
     * `indentType` - String denoting type of indentation for code snippet. eg: 'Space', 'Tab'
     * `indentCount` - The number of indentation characters to add per code level
     * `trimRequestBody` - Trim request body fields
     * `followRedirect` - Boolean denoting whether to redirect a request
     * `requestTimeout` - Integer denoting time after which the request will bail out in milli-seconds
     * `multiLine` - Boolean denoting whether to output code snippet with multi line breaks
     * `longFormat` - Boolean denoting whether to use longform cURL options in snippet
+    * `quoteType` - String denoting the quote type to use (single or double) for URL
 
 * `callback` - callback function with first parameter as error and second parameter as string for code snippet
 
@@ -34,7 +35,8 @@ var request = new sdk.Request('www.google.com'),  //using postman sdk to create
         trimRequestBody: true,
         multiLine: true,
         followRedirect: true,
-        longFormat: true
+        longFormat: true,
+        quoteType: 'single'
     };
 convert(request, options, function(error, snippet) {
     if (error) {

codegens/curl/lib/index.js

@@ -15,14 +15,15 @@ self = module.exports = {
     options = sanitizeOptions(options, self.getOptions());
 
     var indent, trim, headersData, body, redirect, timeout, multiLine,
-      format, snippet, silent, url;
+      format, snippet, silent, url, quoteType;
 
     redirect = options.followRedirect;
     timeout = options.requestTimeout;
     multiLine = options.multiLine;
     format = options.longFormat;
     trim = options.trimRequestBody;
     silent = options.silent;
+    quoteType = options.quoteType === 'single' ? '\'' : '"';
 
     snippet = silent ? `curl ${form('-s', format)}` : 'curl';
     if (redirect) {
@@ -40,10 +41,10 @@ self = module.exports = {
     }
     url = getUrlStringfromUrlObject(request.url);
     if (request.method === 'HEAD') {
-      snippet += ` ${form('-I', format)} '${url}'`;
+      snippet += ` ${form('-I', format)} ${quoteType + url + quoteType}`;
     }
     else {
-      snippet += ` ${form('-X', format)} ${request.method} '${url}'`;
+      snippet += ` ${form('-X', format)} ${request.method} ${quoteType + url + quoteType}`;
     }
 
     if (request.body && !request.headers.has('Content-Type')) {
@@ -186,6 +187,15 @@ self = module.exports = {
         description: 'Set a character used to mark the continuation of a statement on the next line ' +
           '(generally, \\ for OSX/Linux, ^ for Windows)'
       },
+      {
+        name: 'Quote Type',
+        id: 'quoteType',
+        availableOptions: ['single', 'double'],
+        type: 'string',
+        default: 'single',
+        description: 'String denoting the quote type to use (single or double) for URL ' +
+          '(Use double quotes when running curl in cmd.exe and single quotes for the rest)'
+      },
       {
         name: 'Set request timeout',
         id: 'requestTimeout',

codegens/curl/test/newman/newman.test.js

@@ -11,7 +11,8 @@ describe('Convert for different types of request', function () {
       followRedirect: true,
       longFormat: true,
       silent: true,
-      lineContinuationCharacter: '\\'
+      lineContinuationCharacter: '\\',
+      quoteType: 'single'
     };
 
   runNewmanTest(convert, options, testConfig);

codegens/curl/test/unit/convert.test.js

@@ -33,6 +33,48 @@ describe('curl convert function', function () {
         }
       });
     });
+    it('should return snippet with url in single quote(\')', function () {
+      request = new sdk.Request({
+        'method': 'POST',
+        'header': [],
+        'body': {
+          'mode': 'raw',
+          'raw': ''
+        }
+      });
+      options = {
+        quoteType: 'single'
+      };
+      convert(request, options, function (error, snippet) {
+        if (error) {
+          expect.fail(null, null, error);
+        }
+
+        snippetArray = snippet.split(' ');
+        expect(snippetArray[4][0]).to.equal('\'');
+      });
+    });
+    it('should return snippet with url in double quote(")', function () {
+      request = new sdk.Request({
+        'method': 'POST',
+        'header': [],
+        'body': {
+          'mode': 'raw',
+          'raw': ''
+        }
+      });
+      options = {
+        quoteType: 'double'
+      };
+      convert(request, options, function (error, snippet) {
+        if (error) {
+          expect.fail(null, null, error);
+        }
+
+        snippetArray = snippet.split(' ');
+        expect(snippetArray[4][0]).to.equal('"');
+      });
+    });
 
     it('should parse header with string value properly', function () {
       request = new sdk.Request({

test/codegen/structure.test.js

@@ -67,6 +67,13 @@ const expectedOptions = {
       type: 'boolean',
       default: false,
       description: 'Modifies code snippet to incorporate ES6 (EcmaScript) features'
+    },
+    quoteType: {
+      name: 'Quote Type',
+      type: 'string',
+      default: 'single',
+      description: 'String denoting the quote type to use (single or double) for URL ' +
+          '(Use double quotes when running curl in cmd.exe and single quotes for the rest)'
     }
   },
   // Standard array of ids that should be used for options ids. Any new option should be updated here.
@@ -83,7 +90,8 @@ const expectedOptions = {
     'lineContinuationCharacter',
     'protocol',
     'useMimeType',
-    'ES6_enabled'
+    'ES6_enabled',
+    'quoteType'
   ],
   CODEGEN_ABS_PATH = `./codegens/${codegen}`;
 describe('Code-gen repository ' + codegen, function () {