Merge pull request #61 from notonthehighstreet/prefer-status

support preferred status code as response
Aconex · Jun 30, 2015 · c2c85ad · c2c85ad
2 parents c23a70d + 3f9eec9
commit c2c85ad
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -166,7 +166,7 @@ Due to protagonist parsing being async, we need to setup the middleware with an
 
 **Q:** If I have multiple requests/responses on the same API endpoint, which response will I get?
 
-**A:** Drakov will respond first with any responses that have a JSON schema with the first response matching the request body for that API endpoint.
+**A:** Drakov will respond first with any responses that have a JSON schema with the first response matching the request body for that API endpoint. You can request a specific response by adding a `Prefer` header to the request in the form `Prefer:status=XXX` where `XXX` is the status code of the desired response.
 
 
 **Q:** If I have multiple responses on a single request, which response will I get?

diff --git a/lib/content.js b/lib/content.js
@@ -21,8 +21,29 @@ function getMediaTypeFromSpecReq( specReq ) {
 }
 
 function getMediaTypeFromHttpReq( httpReq ) {
-    if( 'content-type' in httpReq.headers ) {
-        return getMediaType( httpReq.headers['content-type'] );
+    var contentTypeHeader = getHeaderFromHttpReq( httpReq, 'content-type' );
+    if( contentTypeHeader ) {
+        return getMediaType( contentTypeHeader );
+    }
+    return null;
+}
+
+function getPreferHeaderFromHttpReq( httpReq, preference ) {
+    var preferHeader = getHeaderFromHttpReq( httpReq, 'prefer' );
+    var preferenceRegExp = new RegExp(preference + '=(.*)', 'i');
+    var matchedStatus;
+    if ( preferHeader ) {
+        matchedStatus = preferHeader.match(preferenceRegExp);
+        if (matchedStatus) {
+            return matchedStatus[1];
+        }
+    }
+    return null;
+}
+
+function getHeaderFromHttpReq( httpReq, header ) {
+    if ( header in httpReq.headers ) {
+        return httpReq.headers[header];
     }
     return null;
 }
@@ -123,16 +144,28 @@ function areContentTypesSame(httpMediaType, specMediaType) {
     return false;
 }
 
-exports.matches = function( httpReq, specReq ) {
+function isPreferredStatus(spec, preferredStatus) {
+    return spec.response.name === preferredStatus;
+}
+
+exports.matches = function( httpReq, spec ) {
+    var specReq = spec.request;
     var httpMediaType = getMediaTypeFromHttpReq( httpReq );
     var specMediaType = getMediaTypeFromSpecReq( specReq );
-    if ( areContentTypesSame(httpMediaType, specMediaType) ) {
-        if ( !hasHeaders( httpReq, specReq ) ){
-            return false;
-        }
+    var preferredStatus = getPreferHeaderFromHttpReq( httpReq, 'status' );
+
+    if ( !preferredStatus || isPreferredStatus(spec, preferredStatus) ) {
+        if (areContentTypesSame(httpMediaType, specMediaType)) {
+            if (!hasHeaders(httpReq, specReq)) {
+                return false;
+            }
+
+            if (isBodyEqual(httpReq, specReq, httpMediaType)) {
+                return true;
+            } else {
+                return false;
+            }
 
-        if ( isBodyEqual( httpReq, specReq, httpMediaType ) ) {
-            return true;
         } else {
             return false;
         }

diff --git a/lib/route.js b/lib/route.js
@@ -20,7 +20,7 @@ exports.getRouteHandlers = function (method, parsedUrl, action) {
             };
 
             var matchRequests= function (specPair){
-                if (content.matches(req, specPair.request)) {
+                if (content.matches(req, specPair)) {
                     logger.log('[DRAKOV]'.red, action.method.green, parsedUrl.uriTemplate.yellow, (specPair.request && specPair.request.description ? specPair.request.description : action.name).blue);
 
                     specPair.response.headers.forEach(function (header) {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "drakov",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "Mock server that implements the API Blueprint specification",
   "main": "./lib/drakov.js",
   "bin": {

diff --git a/test/api/multiple-examples-api-test.js b/test/api/multiple-examples-api-test.js
@@ -29,6 +29,15 @@ describe('/api/multiple', function(){
                 .expect({'second': 'response'})
                 .end(helper.endCb(done));
         });
+
+        it('should respond with preferred status code', function(done) {
+            request.get('/api/multiple')
+                .set('Prefer', 'status=400')
+                .expect(400)
+                .expect('Content-type', 'application/json;charset=UTF-8')
+                .expect({'error': 'Bad request'})
+                .end(helper.endCb(done));
+        });
     });
 
     describe('POST', function(){

diff --git a/test/example/md/multiple-examples-api.md b/test/example/md/multiple-examples-api.md
@@ -38,7 +38,15 @@ Second GET example with header
     + Body
 
             {"second": "response"}
-            
+
+### Retrieve from GET [GET]
+Get examples with a specific status code (eg. 400)
+
++ Response 400 (application/json;charset=UTF-8)
+
+    + Body
+
+            {"error": "Bad request"}
 
 ### Post to the first example [POST]