Rust reqwest code gen

Author: Dhwaneet Bhatt

.gitignore

@@ -64,8 +64,11 @@ typings/
 # next.js build output
 .next
 
-out/
+# Cargo
+target/
 
+# Newman test generated files
+out/
 newmanResponses.json
 dummyFile*.txt
 dummyBinaryFile

README.md

@@ -36,15 +36,16 @@ List of supported code generators:
 | NodeJs | Unirest |
 | Objective-C| NSURLSession|
 | OCaml | Cohttp | 
-|PHP | cURL |
-|PHP | Guzzle |
-|PHP | pecl_http |
-|PHP | HTTP_Request2 |
+| PHP | cURL |
+| PHP | Guzzle |
+| PHP | pecl_http |
+| PHP | HTTP_Request2 |
 | PowerShell | RestMethod | 
 | Python | http.client |
 | Python | Requests |
 | R | httr |
 | R | RCurl |
+| Rust | Reqwest |
 | Ruby | Net:HTTP |
 | Shell | Httpie |
 | Shell | wget |

codegens/rust-reqwest/.gitignore

@@ -0,0 +1,72 @@
+.DS_Store
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Prevent IDE stuff
+.idea
+.vscode
+*.sublime-*
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+.coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+out/
+
+# Cargo
+target/
+src/
+Cargo.toml
+Cargo.lock

codegens/rust-reqwest/README.md

@@ -0,0 +1,79 @@
+# Code-Gen: Postman SDK Request -> Rust Snippet Converter
+
+This module is used to convert Postman SDK-Request object into a Rust code snippet.
+
+#### Prerequisites
+To run this repository, ensure that you have NodeJS >= v12.
+
+## Using the Module
+This module exposes two function `convert()` and `getOptions()`
+
+### Convert
+ 
+Convert function sanitizes the inputs, overrides options with the default ones if not provided and return the code snippet in the desired format.
+
+It requires 3 mandatory parameters `request`, `callback` and `options`
+
+* `request` - postman SDK-request object
+
+* `options` is an object with the following properties
+
+    * `indentType` : can be `Tab` or `Space` (default: 'Space')
+    * `indentCount` : Integer denoting the number of tabs/spaces required for indentation, range 0-8 (default : for indentType Tab : 2, for indentType Space : 4)
+    * `trimRequestBody` : Trim request body fields (default: false)
+    These plugin options will be used if no options are passed to the convert function.
+
+* `callback` : callback function with `error` and `snippet` parameters where snippet is the desired output
+
+#### Example
+```javascript
+const sdk = require('postman-collection');
+
+const request = sdk.Request('http://www.google.com'),
+    options = {indentType: 'Tab', indentCount: 4, trimRequestBody: true};
+
+convert(request, options, function (err, snippet) {
+    if (err) {
+        // perform desired action of logging the error
+    }
+    // perform action with the snippet
+});
+```
+
+### getOptions function
+
+This function returns a list of options supported by this codegen.
+
+#### Example
+```js
+const options = getOptions();
+
+console.log(options);
+// output
+// [
+//       {
+//         name: 'Set indentation count',
+//         id: 'indentCount',
+//         type: 'positiveInteger',
+//         default: 2,
+//         description: 'Set the number of indentation characters to add per code level'
+//       },
+//       ...
+// ]
+```
+
+### Notes
+
+* This module supports all request types of requests which are present in the Postman App.
+
+* Does not handle cookies or proxies and generates a snippet for the base request.
+
+* Snippet generated is supported for Rust 1.0+ versions.
+
+* Does not support if the request body is passed by means of a binary file.
+
+* User ◊needs to enter the absolute path of the file in the snippet. This just picks the relative path in case of file upload in form data body.
+
+### Resources
+
+* [Rust](https://www.rust-lang.org/) official documentation 

codegens/rust-reqwest/index.js

@@ -0,0 +1 @@
+module.exports = require('./lib');

codegens/rust-reqwest/lib/index.js

@@ -0,0 +1,4 @@
+module.exports = {
+  convert: require('./reqwest').convert,
+  getOptions: require('./reqwest').getOptions
+};

codegens/rust-reqwest/lib/reqwest.js

@@ -0,0 +1,138 @@
+const _ = require('lodash'),
+  sanitizeOptions = require('./util/sanitize').sanitizeOptions,
+  { parseHeader, parseBody } = require('./util/parseRequest'),
+  { addDefaultContentType, formatFormData } = require('./util/formatRequest');
+
+/**
+ * Returns snippet for Rust reqwest by parsing data from Postman-SDK request object
+ *
+ * @param {Object} request - Postman SDK request object
+ * @param {String} indentation - indentation required for code snippet
+ * @param {Object} options - Options for code generation
+ *
+ * @returns {String} - Rust reqwest code snippet for given request object
+ */
+function makeSnippet (request, indentation, options) {
+  // Build the client - set timeout and redirect policy
+  let snippet = '#[tokio::main]\n';
+  snippet += 'async fn main() -> Result<(), Box<dyn std::error::Error>> {\n';
+  snippet += `${indentation}let client = reqwest::Client::builder()\n`;
+
+  // Disable redirects if option is set
+  if (_.get(request, 'protocolProfileBehavior.followRedirects', options.followRedirect) === false) {
+    snippet += `${indentation.repeat(2)}.redirect(reqwest::redirect::Policy::none())\n`;
+  }
+
+  snippet += `${indentation.repeat(2)}.build()?;\n\n`;
+
+  addDefaultContentType(request);
+  request.body && request.body.mode === 'formdata' && formatFormData(request);
+
+  const body = request.body && request.body.toJSON(),
+    contentType = request.headers.get('Content-Type'),
+    { headerSnippet, requestHeaderSnippet } = parseHeader(request, indentation),
+    { bodySnippet, requestBodySnippet } = parseBody(body, options.trimRequestBody, indentation, contentType);
+
+  snippet += headerSnippet;
+  snippet += bodySnippet;
+
+  // Create the request and add headers and body
+  let requestSnippet = `${indentation}let method = "${request.method}";\n`;
+  requestSnippet += `${indentation}let request = client.request(reqwest::Method::from_bytes(method.as_bytes())?, `;
+  requestSnippet += `"${request.url.toString()}")\n`;
+  requestSnippet += requestHeaderSnippet;
+  requestSnippet += requestBodySnippet;
+
+  // Set request timeout
+  if (options.requestTimeout !== 0) {
+    requestSnippet += `${indentation.repeat(2)}.timeout(std::time::Duration::from_millis(${options.requestTimeout}))\n`;
+  }
+
+  requestSnippet = requestSnippet.slice(0, -1) + ';\n\n';
+
+  snippet += requestSnippet;
+  snippet += `${indentation}let response = request.send().await?;\n`;
+  snippet += `${indentation}let body = response.text().await?;\n\n`;
+
+  snippet += `${indentation}println!("{}", body);\n\n`;
+  snippet += `${indentation}Ok(())\n}`;
+
+  return snippet;
+}
+
+const self = module.exports = {
+  /**
+     * Used to return options which are specific to a particular plugin
+     *
+     * @returns {Array}
+     */
+  getOptions: function () {
+    return [
+      {
+        name: 'Set indentation count',
+        id: 'indentCount',
+        type: 'positiveInteger',
+        default: 4,
+        description: 'Set the number of indentation characters to add per code level'
+      },
+      {
+        name: 'Set indentation type',
+        id: 'indentType',
+        type: 'enum',
+        availableOptions: ['Tab', 'Space'],
+        default: 'Space',
+        description: 'Select the character used to indent lines of code'
+      },
+      {
+        name: 'Set request timeout',
+        id: 'requestTimeout',
+        type: 'positiveInteger',
+        default: 0,
+        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: 'Trim request body fields',
+        id: 'trimRequestBody',
+        type: 'boolean',
+        default: false,
+        description: 'Remove white space and additional lines that may affect the server\'s response'
+      }];
+  },
+
+  /**
+    * Used to convert the postman sdk-request object to rust snippet
+    *
+    * @param  {Object} request - postman SDK-request object
+    * @param  {Object} options
+    * @param  {String} options.indentType - type of indentation eg: Space / Tab (default: Space)
+    * @param  {Number} options.indentCount - frequency of indent (default: 4 for indentType: Space,
+                                                                    default: 1 for indentType: Tab)
+    * @param {Number} options.requestTimeout : time in milli-seconds after which request will bail out
+                                                (default: 0 -> never bail out)
+    * @param {Boolean} options.trimRequestBody : whether to trim request body fields (default: false)
+    * @param {Boolean} options.followRedirect : whether to allow redirects of a request
+    * @param  {Function} callback - function with parameters (error, snippet)
+    */
+  convert: function (request, options, callback) {
+    if (!_.isFunction(callback)) {
+      throw new Error('Rust~reqwest-convert: Callback is not a function');
+    }
+    options = sanitizeOptions(options, self.getOptions());
+
+    //  String representing value of indentation required
+    let indentString;
+
+    indentString = options.indentType === 'Tab' ? '\t' : ' ';
+    indentString = indentString.repeat(options.indentCount);
+
+    return callback(null, makeSnippet(request, indentString, options));
+  }
+};