Merge pull request #183 from amarzavery/release

validating examples for parameters in formData

.npmignore

@@ -0,0 +1,29 @@
+# Node #
+node_modules
+
+# vs code #
+.vscode/
+
+# Git #
+.git*
+
+# Tests #
+test/
+tests/
+
+# Tools and dev scripts #
+tools/
+tasks/
+scripts/
+gruntfile.js
+gulpfile.js
+gulpFile.js
+
+# Nuget packages #
+.nuget/
+packages/
+packages.config
+
+# VS #
+.ntvs_analysis.*
+*.sln

.travis.yml

@@ -1,4 +1,4 @@
 language: node_js
 sudo: false
 node_js:
-  - "6"
+  - "8"

ChangeLog.md

@@ -1,3 +1,6 @@
+### 11/20/2017 0.4.19
+- Added support for validating examples for parameters `"in": "formData"`.
+
 ### 11/09/2017 0.4.18
 - Ensure scheme, host and basePath are used to construct the base url #180.
 

lib/validators/specValidator.js

@@ -568,6 +568,7 @@ class SpecValidator {
     let parameters = operation.getParameters();
     let result = { request: null, validationResult: { errors: [], warnings: [] } }, foundIssues = false;
     let options = {};
+    let formDataFiles = null;
     if (operation.pathObject && operation.pathObject.api && operation.pathObject.api.host) {
       let scheme = 'https';
       let basePath = '';
@@ -638,6 +639,31 @@ class SpecValidator {
       } else if (location === 'header') {
         if (!options.headers) options.headers = {};
         options.headers[parameter.name] = parameterValue;
+      } else if (location === 'formData') {
+        // helper function
+        function isFormUrlEncoded(consumes) {
+          return consumes.some((contentType) => {
+            return contentType === 'application/x-www-form-urlencoded';
+          });
+        }
+
+        if (!options.formData) options.formData = {};
+        options.formData[parameter.name] = parameterValue;
+
+        // set Content-Type correctly
+        if (operation.consumes && isFormUrlEncoded(operation.consumes)) {
+          if (!options.headers) options.headers = {};
+          options.headers['Content-Type'] = 'application/x-www-form-urlencoded';
+        } else {
+          // default to formData
+          options.headers['Content-Type'] = 'multipart/form-data';
+        }
+        // keep track of parameter type 'file' as sway expects such parameter types to be set
+        // differently in the request object given for validation.
+        if (parameter.type === 'file') {
+          if (!formDataFiles) formDataFiles = {};
+          formDataFiles[parameter.name] = parameterValue;
+        }
       }
     }
 
@@ -661,8 +687,14 @@ class SpecValidator {
       try {
         request = new HttpRequest()
         request = request.prepare(options);
-        self.sampleRequest = request;
+        // set formData in the way sway expects it.
+        if (formDataFiles) {
+          request.files = formDataFiles;
+        } else if (options.formData) {
+          request.body = options.formData;
+        }
         validationResult = operation.validateRequest(request);
+        self.sampleRequest = request;
       } catch (err) {
         request = null;
         let e = self.constructErrorObject(ErrorCodes.ErrorInPreparingRequest, err.message, [err]);