feat: Add support for sending files as response

The new option `sendFile` lets you sends the file as response instead of returning the file content.

Closes #11

README.md

@@ -11,6 +11,8 @@
 
 > Build a fake backend by providing the content of JSON files or JavaScript objects through configurable routes.
 
+*It actually can serve the content of other file types as well as sending the files itself as response.*
+
 Comes as a Node.js server. Useful for mocking, testing and developing independent of the »real« backend.
 
 ## Example
@@ -93,6 +95,36 @@ module.exports = SetupEndpoint({
 });
 ```
 
+#### Advanced Example
+
+`/server/api/anotherExample.js`:
+
+```js
+module.exports = SetupEndpoint({
+    name: 'anotherExample',
+    urls: [{
+        params: '/read',
+        requests: [{
+            method: 'GET',
+            response: '/response-files/anotherExample.json'
+        }]
+    }, {
+        params: '/update/{id}',
+        requests: [{
+            method: ['PUT', 'PATCH'],
+            response: {
+                success: true
+            }
+        }, {
+            method: 'DELETE',
+            response: {
+                deleted: true
+            }
+        }]
+    }, ]
+});
+```
+
 #### Serving different content types
 
 `/server/api/fileTypes.js`:
@@ -115,38 +147,13 @@ module.exports = SetupEndpoint({
         params: '/html',
         requests: [{
             response: '/response-files/example.html',
-            statusCode: 201,
             mimeType: 'text/html'
         }]
-    }]
-});
-```
-
-#### Advanced Example
-
-`/server/api/anotherExample.js`:
-
-```js
-module.exports = SetupEndpoint({
-    name: 'anotherExample',
-    urls: [{
-        params: '/read',
-        requests: [{
-            method: 'GET',
-            response: '/response-files/anotherExample.json'
-        }]
     }, {
-        params: '/update/{id}',
+        params: '/pdf',
         requests: [{
-            method: ['PUT', 'PATCH'],
-            response: {
-                success: true
-            }
-        }, {
-            method: 'DELETE',
-            response: {
-                deleted: true
-            }
+            response: '/response-files/example.pdf',
+            sendFile: true
         }]
     }]
 });
@@ -213,16 +220,19 @@ The configuration object in Detail:
     * `string`, or `array` of strings.
     * is used to define the http method(s) to which the endpoint will listen.
 * `urls.requests.response` 
-  * Could be a string pointing to a JSON template:
+  * Could be a string pointing to a file:
     *   `response: '/response-files/articles.json'`
   * Or just a JavaScript object:
     * `response: { success: true }`
 * `urls.requests.mimeType` 
-  * optional (string). Defaults to `application/json`.
-  * is used to set the `content-type` response header. 
+  * Optional (string). Defaults to `application/json`.
+  * Is used to set the `content-type` response header. 
+* `urls.requests.sendFile`
+  * Optional (boolean). Defaults to `false`.
+  * Sends the file as response instead of returning the file content.
 * `urls.requests.statusCode` 
-  * Optional
-  * A status code (number)
+  * Optional (boolean). Defaults to `200`
+  * The HTTP status code of the response.
   * Will return: 
     * a status code with a self defined response if you provide a response property
     * a status code with a predefined error object provided by [boom](https://github.com/hapijs/boom) if you dont provide a response property for that request.

server/api/fileTypes.js

@@ -22,5 +22,11 @@ module.exports = SetupEndpoint({
             statusCode: 201,
             mimeType: 'text/html'
         }]
+    }, {
+        params: '/pdf',
+        requests: [{
+            response: '/response-files/example.pdf',
+            sendFile: true
+        }]
     }]
 });

server/api/setup/lib/getContentDisposition.js

@@ -0,0 +1,7 @@
+'use strict';
+
+module.exports = function (filePath) {
+
+    const fileName = /\/([^\/]+\.\S+)$/g.exec(filePath);
+    return 'attachment; filename=' + fileName[1];
+};

server/api/setup/supportedMethod.js

@@ -4,10 +4,14 @@ const Boom = require('boom');
 const Fs = require('fs');
 const Path = require('path');
 
+const GetContentDisposition = require('./lib/getContentDisposition.js');
+
 module.exports = function (server, proposedRequest, settings, params, path) {
 
     const method = proposedRequest.method || 'GET';
-    const mimeType = proposedRequest.mimeType || 'application/json';
+    const sendFile = proposedRequest.sendFile | false;
+    const isFile = typeof proposedRequest.response === 'string';
+    const mimeType = proposedRequest.mimeType || (sendFile ? 'application/octet-stream' : 'application/json');
 
     return {
         method,
@@ -36,13 +40,21 @@ module.exports = function (server, proposedRequest, settings, params, path) {
             }
 
             if (proposedRequest.statusCode && proposedRequest.response) {
+
+                if (sendFile && isFile) {
+                    return reply(response).code(proposedRequest.statusCode).type(mimeType).header('Content-Disposition', GetContentDisposition(proposedRequest.response));
+                }
                 return reply(response).code(proposedRequest.statusCode).type(mimeType);
             }
 
             if (response.isBoom === true) {
                 return reply(response);
             }
 
+            if (sendFile && isFile) {
+                return reply(response).type(mimeType).header('Content-Disposition', GetContentDisposition(proposedRequest.response));
+            }
+
             return reply(response).type(mimeType);
         }
     };

test/server/api/fileTypes.js

@@ -28,6 +28,20 @@ const Endpoint = SetupEndpoint({
             statusCode: 201,
             mimeType: 'text/html'
         }]
+    }, {
+        params: '/pdf',
+        requests: [{
+            response: '/response-files/example.pdf',
+            sendFile: true
+        }]
+    }, {
+        params: '/pdf/tweaked',
+        requests: [{
+            response: '/response-files/example.pdf',
+            sendFile: true,
+            statusCode: 201,
+            mimeType: 'application/pdf'
+        }]
     }]
 });
 
@@ -60,52 +74,96 @@ lab.experiment('Different file types', () => {
     });
 
 
-    lab.test('content-type header defaults to `application/json`', (done) => {
+    lab.experiment('send file contents ', () => {
 
-        request = {
-            method: 'GET',
-            url: apiUrlPrefix + '/fileTypes/json'
-        };
+        lab.test('content-type header defaults to `application/json`', (done) => {
 
-        server.inject(request, (response) => {
+            request = {
+                method: 'GET',
+                url: apiUrlPrefix + '/fileTypes/json'
+            };
 
-            Code.expect(response.headers['content-type']).to.equal('application/json; charset=utf-8');
+            server.inject(request, (response) => {
 
-            done();
+                Code.expect(response.headers['content-type']).to.equal('application/json; charset=utf-8');
+
+                done();
+            });
         });
-    });
 
-    lab.test('return text files with the defined content-type header`', (done) => {
+        lab.test('return text files with the defined content-type header`', (done) => {
+
+            request = {
+                method: 'GET',
+                url: apiUrlPrefix + '/fileTypes/text'
+            };
+
+            server.inject(request, (response) => {
+
+                Code.expect(response.headers['content-type']).to.equal('text/plain; charset=utf-8');
+                Code.expect(response.result).to.equal('This is just a plain old text file.\n');
+
+                done();
+            });
+        });
+
+        lab.test('return with the defined content-type header and custom status code`', (done) => {
 
-        request = {
-            method: 'GET',
-            url: apiUrlPrefix + '/fileTypes/text'
-        };
+            request = {
+                method: 'GET',
+                url: apiUrlPrefix + '/fileTypes/html'
+            };
 
-        server.inject(request, (response) => {
+            server.inject(request, (response) => {
 
-            Code.expect(response.headers['content-type']).to.equal('text/plain; charset=utf-8');
-            Code.expect(response.result).to.equal('This is just a plain old text file.\n');
+                Code.expect(response.headers['content-type']).to.equal('text/html; charset=utf-8');
+                Code.expect(response.result).to.equal('<a href="https://github.com">GitHub</a>\n');
+                Code.expect(response.statusCode).to.equal(201);
 
-            done();
+                done();
+            });
         });
+
     });
 
-    lab.test('return with the defined content-type header and custom status code`', (done) => {
 
-        request = {
-            method: 'GET',
-            url: apiUrlPrefix + '/fileTypes/html'
-        };
 
-        server.inject(request, (response) => {
+    lab.experiment('send files ', () => {
+
+        lab.test('send files with the default content-type and the correct name`', (done) => {
 
-            Code.expect(response.headers['content-type']).to.equal('text/html; charset=utf-8');
-            Code.expect(response.result).to.equal('<a href="https://github.com">GitHub</a>\n');
-            Code.expect(response.statusCode).to.equal(201);
+            request = {
+                method: 'GET',
+                url: apiUrlPrefix + '/fileTypes/pdf'
+            };
 
-            done();
+            server.inject(request, (response) => {
+
+                Code.expect(response.headers['content-type']).to.equal('application/octet-stream');
+                Code.expect(response.headers['content-disposition']).to.equal('attachment; filename=example.pdf');
+                Code.expect(response.statusCode).to.equal(200);
+
+                done();
+            });
         });
+
+        lab.test('send files with a defined content-type and a custom status code`', (done) => {
+
+            request = {
+                method: 'GET',
+                url: apiUrlPrefix + '/fileTypes/pdf/tweaked'
+            };
+
+            server.inject(request, (response) => {
+
+                Code.expect(response.headers['content-type']).to.equal('application/pdf');
+                Code.expect(response.headers['content-disposition']).to.equal('attachment; filename=example.pdf');
+                Code.expect(response.statusCode).to.equal(201);
+
+                done();
+            });
+        });
+
     });