Adding options, skip followRedirect tests, updating ci-requirements

Author: erfemega

codegens/r-httr/lib/options.js

@@ -31,21 +31,6 @@ const options = [
     description:
       'Set number of milliseconds the request should wait for a response' +
       ' before timing out (use 0 for infinity)'
-  },
-  {
-    name: 'Follow redirects',
-    id: 'followRedirect',
-    type: 'boolean',
-    default: true,
-    description: 'Automatically follow HTTP redirects'
-  },
-  {
-    name: 'Set communication type',
-    id: 'asyncType',
-    type: 'enum',
-    availableOptions: ['async', 'sync'],
-    default: 'async',
-    description: 'Set if the requests will be asynchronous or synchronous'
   }
 ];
 

codegens/r-httr/lib/rHttr.js

@@ -169,15 +169,17 @@ function getEncodeSnippetByMode (mode) {
   * @param  {boolean} hasHeaders - wheter or not include the headers
   * @param  {string} methodUC - The method upper cased
   * @param  {string} mode - the request body mode
+  * @param  {number} requestTimeout - The request timeout in the options
   * @returns {String} - returns generated snippet
   */
-function getSnippetPostPutOrPatchForm (url, hasParams, hasHeaders, methodUC, mode) {
+function getSnippetPostPutOrPatchForm (url, hasParams, hasHeaders, methodUC, mode, requestTimeout = 0) {
   let paramsSnippet = hasParams ? ', body = body' : '',
     headersSnippet = hasHeaders ? ', add_headers(headers)' : '',
-    encodeSnippet = getEncodeSnippetByMode(mode);
+    encodeSnippet = getEncodeSnippetByMode(mode),
+    timeoutSnippet = requestTimeout ? `, timeout(${requestTimeout})` : '';
 
   return `res <- ${methodUC}("${url}"` +
-    `${paramsSnippet}${headersSnippet}${encodeSnippet})\n`;
+    `${paramsSnippet}${headersSnippet}${encodeSnippet}${timeoutSnippet})\n`;
 }
 
 /**
@@ -188,33 +190,36 @@ function getSnippetPostPutOrPatchForm (url, hasParams, hasHeaders, methodUC, mod
   * @param  {string} url - string url of the service
   * @param  {string} hasHeaders - wheter or not include the headers
   * @param  {string} methodUC - the request method upper cased
+  * @param  {number} requestTimeout - the request timeout from options
   * @returns {String} - returns generated snippet
   */
-function getSnippetGetOrDeleteURL (url, hasHeaders, methodUC) {
-  let headersSnippet = hasHeaders ? ', add_headers(headers)' : '';
-  return `res <- ${methodUC}("${url}"${headersSnippet})\n`;
+function getSnippetGetOrDeleteURL (url, hasHeaders, methodUC, requestTimeout = 0) {
+  let headersSnippet = hasHeaders ? ', add_headers(headers)' : '',
+    requestTimeoutSnippet = requestTimeout === 0 ? '' : `, timeout(${requestTimeout})`;
+  return `res <- ${methodUC}("${url}"${headersSnippet}${requestTimeoutSnippet})\n`;
 }
 
 /**
   * Creates the snippet request for either get ulr or post form
   *
   * @module convert
   *
-  * @param  {string} url - string url of the service
-  * @param  {string} method - request http method
-  * @param  {boolean} hasParams - wheter or not include the params
-  * @param  {boolean} hasHeaders - wheter or not include the headers
-  * @param  {string} mode - the request body mode
+  * @param  {object} requestData - an object that includes:
+  * {string} method - request http method
+  * {boolean} hasParams - wheter or not include the params
+  * {boolean} hasHeaders - wheter or not include the headers
+  * {string} mode - the request body mode
+  * {number} requestTimeout - The request timeout from the options
   * @returns {String} - returns generated snippet
   */
-function getSnippetRequest (url, method, hasParams, hasHeaders, mode) {
+function getSnippetRequest ({url, method, hasParams, hasHeaders, mode, requestTimeout}) {
   const methodUC = method.toUpperCase();
   let snippetRequest = '';
   if (methodUC === 'GET' || methodUC === 'DELETE') {
-    snippetRequest = getSnippetGetOrDeleteURL(url, hasHeaders, methodUC);
+    snippetRequest = getSnippetGetOrDeleteURL(url, hasHeaders, methodUC, requestTimeout);
   }
   if (methodUC === 'POST' || methodUC === 'PUT' || methodUC === 'PATCH') {
-    snippetRequest = getSnippetPostPutOrPatchForm(url, hasParams, hasHeaders, methodUC, mode);
+    snippetRequest = getSnippetPostPutOrPatchForm(url, hasParams, hasHeaders, methodUC, mode, requestTimeout);
   }
   return snippetRequest;
 }
@@ -258,7 +263,14 @@ function convert (request, options, callback) {
     snippetHeader = getSnippetHeader(),
     snippetFooter = getSnippetFooter(),
     snippetbody = parseBody(request.body, indentation, getBodyTrim(options), request.headers.get('Content-Type')),
-    snippetRequest = getSnippetRequest(url, method, snippetbody !== '', snippetHeaders !== '', mode);
+    snippetRequest = getSnippetRequest({
+      url: url,
+      method: method,
+      hasParams: snippetbody !== '',
+      hasHeaders: snippetHeaders !== '',
+      mode: mode,
+      requestTimeout: options.requestTimeout
+    });
 
   snippet += snippetHeader;
   snippet += snippetHeaders;
@@ -283,5 +295,6 @@ module.exports = {
   getSnippetHeaders,
   getSnippetPostPutOrPatchForm,
   getSnippetGetOrDeleteURL,
-  getSnippetRequest
+  getSnippetRequest,
+  getIndentation
 };

codegens/r-httr/lib/util/parseBody.js

@@ -178,24 +178,6 @@ function buildFormDataParamFile (data, indentation, bodyTrim) {
   return `${indentation}'${sanitizeString(data.key, bodyTrim)}' = upload_file('${getContentFileFormData(data)}')`;
 }
 
-/**
- * Groups the params in the request by form, in case that there are multiple forms and multiple files
- *
- * @param {array} paramsList The params in the request
- */
-function groupParamsByForm (paramsList) {
-  let forms = {};
-  paramsList.forEach((param) => {
-    if (forms.hasOwnProperty(param.key)) {
-      forms[param.key].push(param);
-    }
-    else {
-      forms[param.key] = [param];
-    }
-  });
-  return Object.values(forms);
-}
-
 /**
  * builds a data param
  *

codegens/r-httr/test/newman/newman.test.js

@@ -12,7 +12,8 @@ describe('r-httr Converter', function () {
         // filename along with the appropriate version of the file. This file will be used to run the snippet.
         fileName: 'snippet.r',
         // Run script required to run the generated code snippet
-        runScript: 'RScript snippet.r'
+        runScript: 'RScript snippet.r',
+        skipCollections: ['redirectCollection']
       };
     runNewmanTest(convert, options, testConfig);
   });

codegens/r-httr/test/unit/rHttr.test.js

@@ -7,7 +7,8 @@ var expect = require('chai').expect,
     getSnippetHeaders,
     getSnippetPostPutOrPatchForm,
     getSnippetGetOrDeleteURL,
-    getSnippetRequest
+    getSnippetRequest,
+    getIndentation
   } = require('../../lib/rHttr');
 
 describe('convert function', function () {
@@ -27,6 +28,22 @@ describe('convert function', function () {
     done();
   });
 
+  it('should convert a simple get request with timeout', function (done) {
+    const collection = new sdk.Collection(JSON.parse(
+      fs.readFileSync(path.resolve(__dirname, './fixtures/sample_collection.json').toString())));
+    // collection.items.members.forEach((item) => {
+    convert(collection.items.members[1].request, { requestTimeout: 3 }, function (err, snippet) {
+      if (err) {
+        console.error(err);
+      }
+      expect(snippet).to.not.be.empty;
+      expect(snippet.includes('timeout(3)')).to.be.true;
+      fs.writeFileSync(path.join(__dirname, './fixtures/snippet.r'), snippet);
+    });
+    // });
+    done();
+  });
+
   it('should convert a post request with formdata', function (done) {
     const collection = new sdk.Collection(JSON.parse(
       fs.readFileSync(path.resolve(__dirname, './fixtures/sample_collection.json').toString())));
@@ -172,7 +189,27 @@ describe('getSnippetPostPutOrPatchForm function', function () {
   it('should generate postForm snippet without params with headers and post style', function () {
     const expected = 'res <- POST("https://postman-echo.com/post"' +
       ', add_headers(headers), encode = \'form\')\n',
-      res = getSnippetPostPutOrPatchForm('https://postman-echo.com/post', false, true, 'POST', 'urlencoded');
+      res = getSnippetPostPutOrPatchForm(
+        'https://postman-echo.com/post',
+        false,
+        true,
+        'POST',
+        'urlencoded'
+      );
+    expect(res).to.equal(expected);
+  });
+
+  it('should generate postForm snippet without params with headers and post style', function () {
+    const expected = 'res <- POST("https://postman-echo.com/post"' +
+      ', add_headers(headers), encode = \'form\', timeout(3))\n',
+      res = getSnippetPostPutOrPatchForm(
+        'https://postman-echo.com/post',
+        false,
+        true,
+        'POST',
+        'urlencoded',
+        3
+      );
     expect(res).to.equal(expected);
   });
 
@@ -191,20 +228,60 @@ describe('getSnippetGetOrDeleteURL function', function () {
       res = getSnippetGetOrDeleteURL('https://postman-echo.com/headers', false, 'GET');
     expect(res).to.equal(expected);
   });
+
+  it('should generate GET snippet with timeout', function () {
+    const expected = 'res <- GET("https://postman-echo.com/headers", timeout(3))\n',
+      res = getSnippetGetOrDeleteURL('https://postman-echo.com/headers', false, 'GET', 3);
+    expect(res).to.equal(expected);
+  });
 });
 
 describe('getSnippetRequest function', function () {
 
   it('should generate snippet method GET with headers', function () {
     const expected = 'res <- GET("https://postman-echo.com/headers", add_headers(headers))\n',
-      res = getSnippetRequest('https://postman-echo.com/headers', 'GET', false, true);
+      res = getSnippetRequest({
+        url: 'https://postman-echo.com/headers',
+        method: 'GET',
+        hasParams: false,
+        hasHeaders: true
+      });
     expect(res).to.equal(expected);
   });
 
   it('should generate snippet method GET without headers', function () {
     const expected = 'res <- GET("https://postman-echo.com/headers")\n',
-      res = getSnippetRequest('https://postman-echo.com/headers', 'GET', false, false);
+      res = getSnippetRequest({
+        url: 'https://postman-echo.com/headers',
+        method: 'GET',
+        hasParams: false,
+        hasHeaders: false
+      });
     expect(res).to.equal(expected);
   });
 
+  it('should generate snippet method GET without headers and timeout', function () {
+    const expected = 'res <- GET("https://postman-echo.com/headers", timeout(3))\n',
+      res = getSnippetRequest({
+        url: 'https://postman-echo.com/headers',
+        method: 'GET',
+        hasParams: false,
+        hasHeaders: false,
+        requestTimeout: 3
+      });
+    expect(res).to.equal(expected);
+  });
+
+});
+
+describe('getIndentation method', function () {
+  it('should return two spaces', function () {
+    const options = {
+        indentType: 'Space',
+        indentCount: 2
+      },
+      expected = '  ',
+      result = getIndentation(options);
+    expect(result).to.be.equal(expected);
+  });
 });

npm/ci-requirements.sh

@@ -81,3 +81,12 @@ echo "Installing dependencies required for tests in codegens/php-guzzle"
   php -r "unlink('composer-setup.php');"
   sudo mv composer.phar /usr/bin/composer
   composer global require guzzlehttp/guzzle:7.4.1
+
+echo "Installing dependencies required for tests in codegens/r-rCurl and r-httr Installing R"
+  sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys E298A3A825C0D65DFD57CBB651716619E084DAB9
+  sudo add-apt-repository 'deb [arch=amd64,i386] https://cran.rstudio.com/bin/linux/ubuntu xenial-cran40/'
+  sudo apt-get update
+  sudo apt-get install r-base
+
+echo "Installing httr"
+R --vanilla -e 'install.packages("httr", version="1.4.2", repos="http://cran.us.r-project.org")'