feat: removes "type" parameter from "validate" call signature

BREAKING CHANGE: Calling "gavel.validate" no longer requires the "type" parameter.
apiaryio · May 31, 2019 · 3e1097e · 3e1097e
1 parent 2eff11a
commit 3e1097e
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 51 deletions.
diff --git a/bin/gavel b/bin/gavel
@@ -24,25 +24,19 @@ process.stdin.on('end', function() {
 
     var realHttp = curlParser.parseBack(stdin);
 
-    var realRequest = httpParser.parseRequest(realHttp['request']);
-    var realResponse = httpParser.parseResponse(realHttp['response']);
+    var realRequest = httpParser.parseRequest(realHttp.request);
+    var realResponse = httpParser.parseResponse(realHttp.response);
 
-    var expectedRequest = httpParser.parseRequest(expectedHttp['request']);
-    var expectedResponse = httpParser.parseResponse(expectedHttp['response']);
+    var expectedRequest = httpParser.parseRequest(expectedHttp.request);
+    var expectedResponse = httpParser.parseResponse(expectedHttp.response);
 
     var requestResult = false;
     var responseResult = false;
 
-    gavel.validate(realRequest, expectedRequest, 'request', function(
-      err,
-      result
-    ) {
+    gavel.validate(realRequest, expectedRequest, function(err, result) {
       requestResult = result;
 
-      gavel.validate(realResponse, expectedResponse, 'response', function(
-        err,
-        result
-      ) {
+      gavel.validate(realResponse, expectedResponse, function(err, result) {
         responseResult = result;
       });
     });

diff --git a/lib/next/validate.js b/lib/next/validate.js
@@ -5,16 +5,9 @@ const { validateMessage } = require('./validateMessage');
  * a legacy-compliant validation results.
  * @param {Object} real
  * @param {Object} expected
- * @param {'request'|'response'} type
  * @param {(error: Error, result: Object) => void} callback
  */
-function validate(real, expected, type, callback) {
-  if (type !== 'request' && type !== 'response') {
-    throw new Error(
-      `Can't validate: expected transaction "type" to be "request" or "response", but got: ${type}.`
-    );
-  }
-
+function validate(real, expected, callback) {
   let results;
 
   try {

diff --git a/test/cucumber/support/world.js b/test/cucumber/support/world.js
@@ -109,7 +109,7 @@ class World {
   }
 
   validate(callback) {
-    return gavel.validate(this.real, this.expected, 'response', callback);
+    return gavel.validate(this.real, this.expected, callback);
   }
 
   parseHeaders(headersString) {

diff --git a/test/unit/validate-test.js b/test/unit/validate-test.js
@@ -50,16 +50,11 @@ describe('Gavel proxies to functions with callbacks', () => {
           let error = null;
 
           before((done) => {
-            validate(
-              cloneHttpMessage,
-              baseHttpMessage,
-              variant,
-              (err, result) => {
-                error = err;
-                results = result;
-                done();
-              }
-            );
+            validate(cloneHttpMessage, baseHttpMessage, (err, result) => {
+              error = err;
+              results = result;
+              done();
+            });
           });
 
           it('should call the callback without any errors', () =>
@@ -72,16 +67,11 @@ describe('Gavel proxies to functions with callbacks', () => {
           let error = null;
 
           before((done) => {
-            validate(
-              similarHttpMessage,
-              baseHttpMessage,
-              variant,
-              (err, result) => {
-                error = err;
-                results = result;
-                done();
-              }
-            );
+            validate(similarHttpMessage, baseHttpMessage, (err, result) => {
+              error = err;
+              results = result;
+              done();
+            });
           });
 
           it('should call the callback without any errors', () =>
@@ -94,16 +84,11 @@ describe('Gavel proxies to functions with callbacks', () => {
           let error = null;
 
           before((done) => {
-            validate(
-              differentHttpMessage,
-              baseHttpMessage,
-              variant,
-              (err, result) => {
-                error = err;
-                results = result;
-                done();
-              }
-            );
+            validate(differentHttpMessage, baseHttpMessage, (err, result) => {
+              error = err;
+              results = result;
+              done();
+            });
           });
 
           it('should call the callback without any errors', () =>