Release 1.0.0

.github/ISSUE_TEMPLATE/Pull_request.md

@@ -0,0 +1,18 @@
+ **What this PR does**
+<< Please describe briefly what this PR is trying to solve >>
+
+**Changes you made**
+<< List all the changes you made >>
+
+**Screenshot/ CodeSnippet**
+<< Attach relevant screenshots or code snippets related to this PR >>
+
+**Test Configuration**:
+<< Please describe the tests that you ran to verify your changes >>
+
+**Follow up**
+<< Anything you want to share >>
+
+
+
+*Thanks for contributing!* ❤️

.gitignore

@@ -66,4 +66,5 @@ typings/
 
 out/
 
-newmanResponses.json
+newmanResponses.json
+dummyFile*.txt

CHANGELOG.md

@@ -0,0 +1,4 @@
+v1.0.0 (May 29, 2020)
+- Add axios framework support
+- Add ES6 syntax support for NodeJS Request, NodeJS Native and NodeJS Unirest
+- Fix snippet generation for powershell and jquery, where form data params had no type field

CONTRIBUTING.md

@@ -10,7 +10,7 @@
   - [Pull request guidelines](#pull-request-guidelines)
   - [Tests](#tests)
   - [Build Failures](build-failures)
-  - [Security guildelines](security-guidelines)
+  - [Security guidelines](security-guidelines)
 
 ## Getting Started Quick
 
@@ -33,7 +33,7 @@ Installs all `dependencies` of all the codegens. This runs the command `npm inst
 The script associated with `npm test` will run all tests that ensures that your commit does not break anything in the
 repository. Additional requirements to run these tests have been listed down in [ADDITIONAL_DEPENDENCIES](/ADDITIONAL_DEPENDENCIES.md)
 
-* `npm test`: Runs strucutre, unit, newman and system tests for all codegens
+* `npm test`: Runs structure, unit, newman and system tests for all codegens
 * `npm run test <codegen-name>`: Runs tests for a particular codegen.
 
 
@@ -86,7 +86,7 @@ One of the following two contributions are possible for postman-code-generators:
   - All pull requests should be to the develop branch. 
   - Every pull request should have associated issue(s) on our [issue tracker](https://github.com/postmanlabs/postman-code-generators/issues).
   - For any non-trivial fixes, regression tests should be added as well. For a bug, we also recommend adding a request to the `testCollection.json` found inside `test/codegen/newman/fixtures` to run the request using common newman tests.
-  - For a new language to be added as a part of postman-code-generators, we will need some level of community support before we are able to accept the pull request. Feel free to add links to any sort of report/statistics from trusted sources that might help us understand the relavance and popularity of this language among users.
+  - For a new language to be added as a part of postman-code-generators, we will need some level of community support before we are able to accept the pull request. Feel free to add links to any sort of report/statistics from trusted sources that might help us understand the relevance and popularity of this language among users.
 
 
 ## Tests

README.md

@@ -17,6 +17,7 @@ List of supported code generators:
 
 | Language | Variant        |
 |-----------|---------------|
+| C | libcurl |
 | C# | RestSharp | 
 | cURL | cURL | 
 | Go | Native | 
@@ -25,7 +26,8 @@ List of supported code generators:
 | Java | Unirest |
 | JavaScript | Fetch | 
 | JavaScript | jQuery | 
-| JavaScript | XHR | 
+| JavaScript | XHR |
+| NodeJs | Axios | 
 | NodeJs | Native |
 | NodeJs | Request |
 | NodeJs | Unirest |
@@ -35,6 +37,8 @@ List of supported code generators:
 |PHP | pecl_http |
 |PHP | HTTP_Request2 |
 | PowerShell | RestMethod | 
+| Python | http.client |
+| Python | Requests |
 | Ruby | Net:HTTP |
 | Shell | Httpie |
 | Shell | wget |
@@ -104,7 +108,7 @@ var codegen = require('postman-code-generators'), // require postman-code-genera
 
 This function takes in three parameters and returns a callback  with error and supported options of that code generator.
 
-* `language` - langugage key from the language list returned from getLanguageList function
+* `language` - language key from the language list returned from getLanguageList function
 * `variant` - variant key provided by getLanguageList function
 * `callback` - callback function with first parameter as error and second parameter as array of options supported by the codegen.
 
@@ -153,15 +157,16 @@ This function takes in five parameters and returns a callback with error and gen
 * `language` - lang key from the language list returned from getLanguageList function
 * `variant` - variant key provided by getLanguageList function
 * `request` - [Postman-SDK](https://github.com/postmanlabs/postman-collection) Request Object
-* `options` - Options that can be used to configure generated code snippet. Defaults will be used for the  
+* `options` - Options that can be used to configure generated code snippet. Defaults will be used for the unspecified attributes  
 * `callback` - callback function with first parameter as error and second parameter as string for code snippet
 
 ##### Example:
 ```js
 var codegen = require('postman-code-generators'), // require postman-code-generators in your project
-    request = new sdk.Request('www.google.com'),  //using postman sdk to create request 
+    sdk = require('postman-collection'), // require postman-collection in your project
+    request = new sdk.Request('https://www.google.com'),  //using postman sdk to create request 
     language = 'nodejs',
-    variant = 'requests',
+    variant = 'request',
     options = {
         indentCount: 3,
         indentType: 'Space',

codegens/csharp-restsharp/lib/parseRequest.js

@@ -96,7 +96,7 @@ function parseBody (request, trimFields) {
 /**
  * Parses header in Postman-SDK request and returns code snippet of csharp-restsharp for adding headers
  *
- * @param {Object} requestJson - Postman SDK reqeust object
+ * @param {Object} requestJson - Postman SDK request object
  * @returns {String} code snippet for adding headers in csharp-restsharp
  */
 function parseHeader (requestJson) {
@@ -106,7 +106,12 @@ function parseHeader (requestJson) {
 
   return requestJson.header.reduce((headerSnippet, header) => {
     if (!header.disabled) {
-      headerSnippet += `request.AddHeader("${sanitize(header.key, true)}", "${sanitize(header.value)}");\n`;
+      if (sanitize(header.key, true).toLowerCase() === 'user-agent') {
+        headerSnippet += `client.UserAgent = "${sanitize(header.value)}";\n`;
+      }
+      else {
+        headerSnippet += `request.AddHeader("${sanitize(header.key, true)}", "${sanitize(header.value)}");\n`;
+      }
     }
     return headerSnippet;
   }, '');

codegens/csharp-restsharp/lib/restsharp.js

@@ -172,7 +172,7 @@ self = module.exports = {
      * @param {String} options.indentType - type for indentation eg: Space, Tab (default: Space)
      * @param {String} options.indentCount - number of spaces or tabs for indentation. (default: 4 for indentType:
                                                                          Space, default: 1 for indentType: Tab)
-     * @param {Boolean} [options.includeBoilerplate] - indicates whether to include class defination in C#
+     * @param {Boolean} [options.includeBoilerplate] - indicates whether to include class definition in C#
      * @param {Boolean} options.followRedirect - whether to enable followredirect
      * @param {Boolean} options.trimRequestBody - whether to trim fields in request body or not (default: false)
      * @param {Number} options.requestTimeout - time in milli-seconds after which request will bail out

codegens/csharp-restsharp/npm/test-lint.js

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
-require('shelljs/global');
-
-var chalk = require('chalk'),
+var shell = require('shelljs'),
+  chalk = require('chalk'),
   async = require('async'),
   ESLintCLIEngine = require('eslint').CLIEngine,
 
@@ -56,4 +55,4 @@ module.exports = function (exit) {
 };
 
 // ensure we run this script exports if this is a direct stdin.tty run
-!module.parent && module.exports(exit);
+!module.parent && module.exports(shell.exit);

codegens/csharp-restsharp/npm/test-newman.js

@@ -4,10 +4,10 @@
 // This script is intended to execute all newman tests.
 // ---------------------------------------------------------------------------------------------------------------------
 
-require('shelljs/global');
+var shell = require('shelljs'),
 
-// set directories and files for test and coverage report
-var path = require('path'),
+  // set directories and files for test and coverage report
+  path = require('path'),
 
   NYC = require('nyc'),
   chalk = require('chalk'),
@@ -20,8 +20,8 @@ module.exports = function (exit) {
   // banner line
   console.info(chalk.yellow.bold('Running newman tests using mocha on node...'));
 
-  test('-d', COV_REPORT_PATH) && rm('-rf', COV_REPORT_PATH);
-  mkdir('-p', COV_REPORT_PATH);
+  shell.test('-d', COV_REPORT_PATH) && shell.rm('-rf', COV_REPORT_PATH);
+  shell.mkdir('-p', COV_REPORT_PATH);
 
   var Mocha = require('mocha'),
     nyc = new NYC({
@@ -56,4 +56,4 @@ module.exports = function (exit) {
 };
 
 // ensure we run this script exports if this is a direct stdin.tty run
-!module.parent && module.exports(exit);
+!module.parent && module.exports(shell.exit);

codegens/csharp-restsharp/npm/test-unit.js

@@ -4,10 +4,10 @@
 // This script is intended to execute all unit tests.
 // ---------------------------------------------------------------------------------------------------------------------
 
-require('shelljs/global');
+var shell = require('shelljs'),
 
-// set directories and files for test and coverage report
-var path = require('path'),
+  // set directories and files for test and coverage report
+  path = require('path'),
 
   NYC = require('nyc'),
   chalk = require('chalk'),
@@ -20,8 +20,8 @@ module.exports = function (exit) {
   // banner line
   console.info(chalk.yellow.bold('Running unit tests using mocha on node...'));
 
-  test('-d', COV_REPORT_PATH) && rm('-rf', COV_REPORT_PATH);
-  mkdir('-p', COV_REPORT_PATH);
+  shell.test('-d', COV_REPORT_PATH) && shell.rm('-rf', COV_REPORT_PATH);
+  shell.mkdir('-p', COV_REPORT_PATH);
 
   var Mocha = require('mocha'),
     nyc = new NYC({
@@ -56,4 +56,4 @@ module.exports = function (exit) {
 };
 
 // ensure we run this script exports if this is a direct stdin.tty run
-!module.parent && module.exports(exit);
+!module.parent && module.exports(shell.exit);

codegens/csharp-restsharp/test/unit/convert.test.js

@@ -162,6 +162,36 @@ describe('csharp restsharp function', function () {
         expect(snippet).to.include('request.AddFile("invalid src", "/path/to/file"');
       });
     });
+
+    it('should use client.UserAgent instead of AddHeader function', function () {
+      const sampleUA = 'Safari/605.1.15',
+        expectValue = `client.UserAgent = "${sampleUA}";`;
+
+      var request = new sdk.Request({
+        'method': 'GET',
+        'header': [
+          {
+            'key': 'User-Agent',
+            'value': sampleUA
+          }
+        ],
+        'url': {
+          'raw': 'https://google.com',
+          'protocol': 'https',
+          'host': [
+            'google',
+            'com'
+          ]
+        }
+      });
+      convert(request, {}, function (error, snippet) {
+        if (error) {
+          expect.fail(null, null, error);
+        }
+        expect(snippet).to.be.a('string');
+        expect(snippet).to.include(expectValue);
+      });
+    });
   });
 
   describe('getOptions function', function () {

codegens/curl/npm/test-lint.js

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
-require('shelljs/global');
-
-var chalk = require('chalk'),
+var shell = require('shelljs'),
+  chalk = require('chalk'),
   async = require('async'),
   ESLintCLIEngine = require('eslint').CLIEngine,
 
@@ -56,4 +55,4 @@ module.exports = function (exit) {
 };
 
 // ensure we run this script exports if this is a direct stdin.tty run
-!module.parent && module.exports(exit);
+!module.parent && module.exports(shell.exit);

codegens/curl/npm/test-newman.js

@@ -4,10 +4,10 @@
 // This script is intended to execute all newman tests.
 // ---------------------------------------------------------------------------------------------------------------------
 
-require('shelljs/global');
+var shell = require('shelljs'),
 
-// set directories and files for test and coverage report
-var path = require('path'),
+  // set directories and files for test and coverage report
+  path = require('path'),
 
   NYC = require('nyc'),
   chalk = require('chalk'),
@@ -20,8 +20,8 @@ module.exports = function (exit) {
   // banner line
   console.info(chalk.yellow.bold('Running newman tests using mocha on node...'));
 
-  test('-d', COV_REPORT_PATH) && rm('-rf', COV_REPORT_PATH);
-  mkdir('-p', COV_REPORT_PATH);
+  shell.test('-d', COV_REPORT_PATH) && shell.rm('-rf', COV_REPORT_PATH);
+  shell.mkdir('-p', COV_REPORT_PATH);
 
   var Mocha = require('mocha'),
     nyc = new NYC({
@@ -56,4 +56,4 @@ module.exports = function (exit) {
 };
 
 // ensure we run this script exports if this is a direct stdin.tty run
-!module.parent && module.exports(exit);
+!module.parent && module.exports(shell.exit);

codegens/curl/npm/test-unit.js

@@ -4,10 +4,10 @@
 // This script is intended to execute all unit tests.
 // ---------------------------------------------------------------------------------------------------------------------
 
-require('shelljs/global');
+var shell = require('shelljs'),
 
-// set directories and files for test and coverage report
-var path = require('path'),
+  // set directories and files for test and coverage report
+  path = require('path'),
 
   NYC = require('nyc'),
   chalk = require('chalk'),
@@ -20,8 +20,8 @@ module.exports = function (exit) {
   // banner line
   console.info(chalk.yellow.bold('Running unit tests using mocha on node...'));
 
-  test('-d', COV_REPORT_PATH) && rm('-rf', COV_REPORT_PATH);
-  mkdir('-p', COV_REPORT_PATH);
+  shell.test('-d', COV_REPORT_PATH) && shell.rm('-rf', COV_REPORT_PATH);
+  shell.mkdir('-p', COV_REPORT_PATH);
 
   var Mocha = require('mocha'),
     nyc = new NYC({
@@ -56,4 +56,4 @@ module.exports = function (exit) {
 };
 
 // ensure we run this script exports if this is a direct stdin.tty run
-!module.parent && module.exports(exit);
+!module.parent && module.exports(shell.exit);

codegens/golang/npm/test-lint.js

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
-require('shelljs/global');
-
-var chalk = require('chalk'),
+var shell = require('shelljs'),
+  chalk = require('chalk'),
   async = require('async'),
   ESLintCLIEngine = require('eslint').CLIEngine,
 
@@ -56,4 +55,4 @@ module.exports = function (exit) {
 };
 
 // ensure we run this script exports if this is a direct stdin.tty run
-!module.parent && module.exports(exit);
+!module.parent && module.exports(shell.exit);

codegens/golang/npm/test-newman.js

@@ -4,10 +4,10 @@
 // This script is intended to execute all newman tests.
 // ---------------------------------------------------------------------------------------------------------------------
 
-require('shelljs/global');
+var shell = require('shelljs'),
 
-// set directories and files for test and coverage report
-var path = require('path'),
+  // set directories and files for test and coverage report
+  path = require('path'),
 
   NYC = require('nyc'),
   chalk = require('chalk'),
@@ -20,8 +20,8 @@ module.exports = function (exit) {
   // banner line
   console.info(chalk.yellow.bold('Running newman tests using mocha on node...'));
 
-  test('-d', COV_REPORT_PATH) && rm('-rf', COV_REPORT_PATH);
-  mkdir('-p', COV_REPORT_PATH);
+  shell.test('-d', COV_REPORT_PATH) && shell.rm('-rf', COV_REPORT_PATH);
+  shell.mkdir('-p', COV_REPORT_PATH);
 
   var Mocha = require('mocha'),
     nyc = new NYC({
@@ -56,4 +56,4 @@ module.exports = function (exit) {
 };
 
 // ensure we run this script exports if this is a direct stdin.tty run
-!module.parent && module.exports(exit);
+!module.parent && module.exports(shell.exit);