2 | {{ description }} 3 |
4 | -------------------------------------------------------------------------------- /benchmarks/views/layout.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |Hello
7 | {{{ body }}} 8 | 9 | 10 | -------------------------------------------------------------------------------- /cli/templates/app.js.template: -------------------------------------------------------------------------------- 1 | /** 2 | * A bogart application skeleton 3 | */ 4 | 5 | var bogart = require("bogart"); 6 | 7 | var homeRouter = bogart.router(function(get, post, put, del) { 8 | get("/", function() { 9 | return bogart.html("Hello World"); 10 | }); 11 | }); 12 | 13 | bogart.start(homeRouter); 14 | -------------------------------------------------------------------------------- /cli/templates/package.json.template: -------------------------------------------------------------------------------- 1 | { 2 | "author": "{{title}}
63 | 64 | {{{body}}} 65 | 66 | 67 | 68 | App (app.js): 69 | 70 | var bogart = require('bogart'); 71 | var viewEngine = bogart.viewEngine('mustache'); 72 | var router = bogart.router(); 73 | 74 | router.get('/hello/:firstName', function(req) { 75 | return viewEngine.respond('index.html', { 76 | locals: { title: 'Hello', firstName: req.params.firstName } 77 | }); 78 | }); 79 | 80 | bogart.start(router); 81 | 82 | Execute `node app.js` and visit [http://localhost:8080/hello/bogart](http://localhost:8080/hello/bogart). 83 | 84 | ### Jade Example 85 | 86 | Make sure to install bogart-jade from npm before running these examples. 87 | 88 | View (index.jade): 89 | 90 | Welcome #{firstName}! 91 | 92 | Layout (layout.jade): 93 | 94 | html 95 | head 96 | title #{title} 97 | body 98 | h1 #{title} 99 | !{body} 100 | 101 | App (app.js): 102 | 103 | var bogart = require('bogart'); 104 | var viewEngine = bogart.viewEngine('jade'); 105 | var router = bogart.router(); 106 | 107 | router.get('/hello/:firstName', function(req) { 108 | return viewEngine.respond('index', { 109 | locals: { title: 'Hello', firstName: req.params.firstName } 110 | }); 111 | }); 112 | 113 | bogart.start(router); 114 | 115 | Execute `node app.js` and visit [http://localhost:8080/hello/bogart](http://localhost:8080/hello/bogart). 116 | 117 | ## Partials 118 | 119 | Sometimes, especially with AJAX requests, it is desirable to return a view without rendering it inside of a 120 | layout even if a layout is present. To acccomodate this, the View Engine has a `partial` method. The `partial` 121 | method takes the same arguments as the `render` method but does not render its template insdie of 122 | a layout. 123 | 124 | var viewEngine = bogart.viewEngine('mustache'); 125 | viewEngine.partial('index.html'); 126 | 127 | -------------------------------------------------------------------------------- /engines/node/lib/fileWatcher.js: -------------------------------------------------------------------------------- 1 | exports.watchFile = require('fs').watchFile; -------------------------------------------------------------------------------- /examples/body-adapter.js: -------------------------------------------------------------------------------- 1 | var bogart = require('../lib/bogart') 2 | , util = require('util') 3 | , Stream = require('stream').Stream; 4 | 5 | function HelloWorldStream() { 6 | var self = this; 7 | 8 | Stream.call(this); 9 | 10 | this.readable = true; 11 | 12 | process.nextTick(function() { 13 | self.emit('data', '
');
26 | });
27 |
28 | var app = bogart.app();
29 | app.use(bogart.middleware.session({ secret: 'ABC123' }));
30 | app.use(bogart.middleware.directory(path.join(__dirname, 'public')));
31 | app.use(frontRouter);
32 | app.use(bogart.middleware.facebook(facebookConfig));
33 | app.use(router);
34 |
35 | app.start(PORT);
36 |
--------------------------------------------------------------------------------
/examples/facebook-authentication/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/nrstott/bogart/a6e3b01b2e6f1247dde697038101fd6fa94e76b0/examples/facebook-authentication/public/favicon.ico
--------------------------------------------------------------------------------
/examples/facebook-authentication/public/login-with-facebook.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/nrstott/bogart/a6e3b01b2e6f1247dde697038101fd6fa94e76b0/examples/facebook-authentication/public/login-with-facebook.png
--------------------------------------------------------------------------------
/examples/flash-test.js:
--------------------------------------------------------------------------------
1 | var bogart = require('../lib/bogart');
2 |
3 | var flashConfig = {
4 | encryptionKey: 'db0031e2-04e7-11e1-86ad-000c290196f7'
5 | };
6 |
7 | var router = bogart.router();
8 | router.get('/', function (req) {
9 | var html = 'Bogart Flash Middleware
'; 10 | html += 'A random number has been inserted into flash. ' + 11 | 'On the first request, the value should be undefined. Subsequent requests should ' + 12 | 'display the random number set on the previous request. ' + 13 | 'Refresh the page to see the flash value change.
' + 14 | 'Existing Flash: '+ req.flash('foo') +''; 15 | 16 | req.flash('foo', Math.random() * 10); 17 | 18 | return bogart.html(html); 19 | }); 20 | 21 | var app = bogart.app(); 22 | app.use(bogart.middleware.flash(flashConfig)); 23 | app.use(router); 24 | 25 | app.start(); 26 | -------------------------------------------------------------------------------- /examples/gzip-response.js: -------------------------------------------------------------------------------- 1 | var bogart = require('../lib/bogart'); 2 | 3 | var router = new bogart.router(); 4 | router.get('/', function() { 5 | return bogart.html('
This response is compressed by the Deflate middleware!
'); 6 | }); 7 | 8 | var app = bogart.app(); 9 | app.use(bogart.middleware.gzip); 10 | app.use(router); 11 | 12 | app.start(); -------------------------------------------------------------------------------- /examples/hello-world.js: -------------------------------------------------------------------------------- 1 | var bogart = require('../lib/bogart'); 2 | 3 | var router = bogart.router(); 4 | router.get('/', function(req) { 5 | return 'Hello Root'; 6 | }); 7 | 8 | router.get('/:name', function(req) { 9 | return 'Hello '+req.params.name; 10 | }); 11 | 12 | var app = bogart.app(); 13 | app.use(bogart.batteries({ secret: 'my-secret' })); 14 | app.use(router); 15 | 16 | app.start(); 17 | -------------------------------------------------------------------------------- /examples/multipart-form/app.js: -------------------------------------------------------------------------------- 1 | var bogart = require('../../lib/bogart') 2 | , util = require('util'); 3 | 4 | var router = bogart.router(); 5 | 6 | router.get('/', function(req) { 7 | var html = '' + 8 | '2 | {{ description }} 3 |
4 | -------------------------------------------------------------------------------- /examples/mustache-layout/views/layout.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |Hello
7 | {{{ body }}} 8 | 9 | 10 | -------------------------------------------------------------------------------- /examples/pipe-file.js: -------------------------------------------------------------------------------- 1 | var bogart = require('../lib/bogart'); 2 | var fs = require('fs'); 3 | var path = require('path'); 4 | 5 | var router = bogart.router(); 6 | 7 | router.get('/', function(req) { 8 | return bogart.html('
');
9 | });
10 |
11 | router.get('/image.jpg', function(req) {
12 | var filePath = path.join(__dirname, 'static-server', 'public', 'images', 'ninja-cat.jpg')
13 | , stat = fs.statSync(filePath);
14 |
15 | return bogart.pipe(fs.createReadStream(filePath), {
16 | headers: { 'Content-Type': 'image/jpeg', 'Content-Length': stat.size }
17 | });
18 | });
19 |
20 | router.get('/cat.jpg', function(req) {
21 | var filePath = path.join(__dirname, 'static-server', 'public', 'images', 'ninja-cat.jpg');
22 |
23 | return bogart.file(filePath);
24 | });
25 |
26 | var app = bogart.app();
27 | app.use(router);
28 |
29 | app.start();
30 |
--------------------------------------------------------------------------------
/examples/proxy.js:
--------------------------------------------------------------------------------
1 | var bogart = require('../lib/bogart');
2 |
3 | var router = bogart.router();
4 | router.get('/', function() {
5 | return bogart.proxy('http://google.com');
6 | });
7 |
8 | var app = bogart.app();
9 | app.use(router);
10 |
11 | app.start();
12 |
--------------------------------------------------------------------------------
/examples/session.js:
--------------------------------------------------------------------------------
1 | var bogart = require('../lib/bogart');
2 |
3 | var router = bogart.router();
4 |
5 | router.get('/', function (req) {
6 | var html = 'Session Values
'; 10 | html += '- ';
11 |
12 | req.session.keys().forEach(function (key) {
13 | html += '
- '+key+': '+req.session(key)+' '; 14 | }); 15 | 16 | html += '
Add to Session
'; 19 | html += 'Destroy Session
'; 27 | html += ''; 31 | html += '{{title}}
7 || Server Time | 10 |11 | |
|---|---|
| Server Object | 14 |15 | |
| Calling a Server-Provided Function | 18 |19 | |
");
8 | });
9 |
10 | var root = require("path").join(__dirname, "public");
11 |
12 | var app = bogart.app();
13 | app.use(bogart.middleware.directory(root));
14 | app.use(router);
15 |
16 | app.start();
17 |
--------------------------------------------------------------------------------
/examples/static-server/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "static-server-example",
3 | "version": "1.0.0",
4 | "author": "Nathan Stott",
5 | "email": "nathan.stott@whiteboard-it.com",
6 | "main": "./app.js",
7 | "directories": { "lib": "./lib" },
8 | "dependencies": {
9 | "promised-io": "v0.2.1",
10 | "jsgi": "v0.2.2",
11 | "mustache": "0.3.1-dev"
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/examples/static-server/public/images/ninja-cat.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/nrstott/bogart/a6e3b01b2e6f1247dde697038101fd6fa94e76b0/examples/static-server/public/images/ninja-cat.jpg
--------------------------------------------------------------------------------
/examples/task-list/app.js:
--------------------------------------------------------------------------------
1 | var bogart = require("../../lib/bogart")
2 | , path = require("path");
3 |
4 | // Mustache view engine, templates are located in the "task-list/templates" directory
5 | var viewEngine = bogart.viewEngine("mustache", path.join(__dirname, "templates"));
6 |
7 | // Tasks storage, replace with a database in a real application.
8 | var tasks = {};
9 |
10 | // Most Bogart applications will have a router. Router's generally contain the business logic
11 | // for the application.
12 | var router = bogart.router();
13 |
14 | router.get("/", function(req) {
15 | var
16 | errors = req.params.errors,
17 | taskList = [];
18 |
19 | // The template needs the tasks as an array, transform the tasks into an array
20 | for (var taskName in tasks) {
21 | taskList.push(tasks[taskName]);
22 | }
23 |
24 | // The index.html file is a mustache template located in the "templates" directory
25 | return viewEngine.respond("index.html", { locals: { tasks: taskList, errors: errors } });
26 | });
27 |
28 | router.post("/", function(req) {
29 | var
30 | task = { name: req.params.name, description: req.params.description },
31 | errors = [];
32 |
33 | if (!task.name || task.name.trim() === "") {
34 | errors.push("name is required");
35 | }
36 |
37 | // PRG pattern http://en.wikipedia.org/wiki/Post/Redirect/Get
38 | if (errors.length > 0) {
39 | return bogart.redirect("/?errors="+JSON.stringify(errors));
40 | }
41 |
42 | tasks[task.name] = task;
43 |
44 | return bogart.redirect("/");
45 | });
46 |
47 | router.del("/:name", function(req) {
48 | console.log('deleting '+req.params.name);
49 | console.log(tasks);
50 | delete tasks[req.params.name];
51 |
52 | return bogart.redirect("/");
53 | });
54 |
55 | // Create a Bogart Application. Application makes it easy for us to manage our JSGI appliances and routers.
56 | var app = bogart.app();
57 |
58 | // Frameworks are better when batteries are included. Put the batteries into this app!
59 | app.use(bogart.batteries, {
60 | session: {
61 | secret: "some secret key.."
62 | }
63 | });
64 |
65 | // Add our router to the app. NOTE: It is important to add batteries first.
66 | app.use(router);
67 |
68 | // Start the server
69 | app.start();
70 | console.log("Task Server Started!");
71 |
--------------------------------------------------------------------------------
/examples/task-list/templates/index.html:
--------------------------------------------------------------------------------
1 | Task List
2 | 3 |-
4 | {{#tasks}}
5 |
-
6 |
10 | Task Name: {{name}}
11 |
Description: {{description}}
12 |
13 | {{/tasks}}
14 |
Message:
'; 6 | 7 | if (config.showError) { 8 | if (typeof err === 'string') { 9 | message += err; 10 | } else if (err.message) { 11 | message += err.message; 12 | if (err.stack) { 13 | message += 'Stack Trace:
'; 14 | message += '';
15 | if(err.stack.join) {
16 | message += err.stack.join('
'); 17 | } else { 18 | message += err.stack.replace(/\r?\n/g, '
'); 19 | } 20 | message += '
';
21 | }
22 | }
23 | } else {
24 | message = '';
25 | }
26 |
27 | if (config.logError) {
28 | console.error('Error processing request', req.pathInfo, err);
29 | }
30 |
31 | return {
32 | status: 500,
33 | body: [''); 17 | } else { 18 | message += err.stack.replace(/\r?\n/g, '
'); 19 | } 20 | message += '
An error occurred.
', message, ''], 34 | headers: { 35 | 'content-type': 'text/html' 36 | } 37 | }; 38 | }; 39 | 40 | var defaultConfig = { 41 | showError: true, 42 | logError: true 43 | }; 44 | 45 | /** 46 | * Translates rejected promises to a JSGI error response. 47 | * 48 | * @param errorResponse {Function} Optional. A function that returns a JSGI response when passed an error. 49 | * @returns {Function} JSGI response. 50 | */ 51 | module.exports = function errorMiddleware(config, nextApp) { 52 | if (nextApp === undefined) { 53 | if (typeof config === 'function') { 54 | nextApp = config; 55 | config = {}; 56 | } else { 57 | return function (nextApp) { 58 | return errorMiddleware(config, nextApp); 59 | }; 60 | } 61 | } 62 | 63 | config = _.extend({}, defaultConfig, config); 64 | 65 | return function (req) { 66 | return q.whenCall(function() { return nextApp(req); }, function(val) { 67 | return val; 68 | }, function (err) { 69 | return errorResponse(config, req, err); 70 | }); 71 | }; 72 | }; 73 | -------------------------------------------------------------------------------- /lib/middleware/facebook.js: -------------------------------------------------------------------------------- 1 | var middleware = require('../middleware') 2 | , _ = require('underscore'); 3 | 4 | function parseFacebookProfile(body) { 5 | if (body){ 6 | var o = JSON.parse(body); 7 | var profile = { 8 | provider: 'facebook' 9 | }; 10 | profile.id = o.id; 11 | profile.username = o.username; 12 | profile.displayName = o.name; 13 | profile.name = { 14 | familyName: o.last_name, 15 | givenName: o.first_name, 16 | middleName: o.middle_name 17 | }; 18 | profile.gender = o.gender; 19 | profile.profileUrl = o.link; 20 | profile.emails = [ o.email ]; 21 | return profile; 22 | } 23 | return undefined; 24 | } 25 | 26 | module.exports = facebookMiddleware; 27 | 28 | function facebookMiddleware(config, nextApp) { 29 | if (nextApp === undefined) { 30 | return function (nextApp) { 31 | return facebookMiddleware(config, nextApp); 32 | }; 33 | } 34 | 35 | var facebook_strategy = { 36 | authorizationURL: 'https://www.facebook.com/dialog/oauth', 37 | tokenURL: 'https://graph.facebook.com/oauth/access_token', 38 | resourceURL: 'https://graph.facebook.com/me', 39 | parse: facebookMiddleware.parseFacebookProfile 40 | }; 41 | 42 | var oauth2Options = _.extend(facebook_strategy, config); 43 | 44 | return middleware.oauth2(oauth2Options, nextApp); 45 | }; 46 | 47 | facebookMiddleware.parseFacebookProfile = parseFacebookProfile; 48 | 49 | -------------------------------------------------------------------------------- /lib/middleware/flash.js: -------------------------------------------------------------------------------- 1 | var q = require('../q') 2 | , when = q.when 3 | , flashIdCookieProvider = require("../flash/flashIdCookieProvider") 4 | , flashCookieDataProvider = require("../flash/flashCookieDataProvider"); 5 | 6 | module.exports = function flash(config, nextApp) { 7 | if (nextApp === undefined) { 8 | if (typeof config === 'function') { 9 | nextApp = config; 10 | config = {}; 11 | } else { 12 | return function (nextApp) { 13 | return flash(config, nextApp); 14 | }; 15 | } 16 | } 17 | 18 | if (typeof nextApp !== 'function') { 19 | throw { 20 | message: 'flash middleware expects a nextApp as the last argument.', 21 | code: 'BOGART_FLASH_BAD_NEXTAPP' 22 | }; 23 | } 24 | 25 | config = config || {}; 26 | config.options = config.options || {}; 27 | 28 | config.flashIdProvider = config.flashIdProvider || new flashIdCookieProvider(config.options.idProvider || {}); 29 | config.flashDataProvider = config.flashDataProvider || new flashCookieDataProvider(config.options.dataProvider || {}); 30 | 31 | return function (req) { 32 | if (req.pathInfo === '/favicon.ico') { 33 | return nextApp(req); 34 | } 35 | var oldFlashId = config.flashIdProvider.getFlashId(req); 36 | 37 | // get a new id for the current request 38 | var newFlashId = config.flashIdProvider.newId(req); 39 | 40 | // make flash data from previous request available 41 | req.env = req.env || {}; 42 | var prevData = oldFlashId ? config.flashDataProvider.previousFlash(req, oldFlashId) : {}; 43 | 44 | return when(prevData, function (data) { 45 | req.env.flash = data || {}; 46 | // create the setter for new flash data 47 | var setter = config.flashDataProvider.setter(req, newFlashId); 48 | req.flash = function (key, val) { 49 | if (key && val) { 50 | var obj = {}; 51 | obj[key] = val; 52 | setter(obj); 53 | } else return req.env.flash[key]; 54 | } 55 | 56 | return when(nextApp(req), function (resp) { 57 | if (oldFlashId) { 58 | // clear old flash data 59 | resp = config.flashDataProvider.clear(req, resp, oldFlashId); 60 | // clear old flash id 61 | resp = config.flashIdProvider.clear(req, resp, oldFlashId); 62 | } 63 | 64 | // finalize the flashId provider for the current request 65 | resp = config.flashIdProvider.finalize(req, resp, newFlashId); 66 | // finalize the flash data provider for the current request 67 | resp = config.flashDataProvider.finalize(req, resp, newFlashId); 68 | 69 | return resp; 70 | }); 71 | }); 72 | }; 73 | }; -------------------------------------------------------------------------------- /lib/middleware/google.js: -------------------------------------------------------------------------------- 1 | var middleware = require('../middleware') 2 | , _ = require('underscore'); 3 | 4 | function parseGoogleProfile(body) { 5 | if (body) { 6 | o = JSON.parse(body); 7 | var profile = { 8 | provider: 'google' 9 | }; 10 | profile.id = o.id; 11 | profile.displayName = o.displayName; 12 | profile.name = o.name; 13 | profile.gender = o.gender; 14 | profile.profileUrl = o.url; 15 | if (o.emails) { 16 | profile.emails = o.emails; 17 | } 18 | return profile; 19 | } 20 | } 21 | 22 | module.exports = googleMiddleware; 23 | 24 | function googleMiddleware(config, nextApp) { 25 | if (nextApp === undefined) { 26 | return function (nextApp) { 27 | return googleMiddleware(config, nextApp); 28 | }; 29 | } 30 | 31 | var googleStrategy = { 32 | authorizationURL: 'https://accounts.google.com/o/oauth2/auth', 33 | tokenURL: 'https://accounts.google.com/o/oauth2/token', 34 | resourceURL: 'https://www.googleapis.com/plus/v1/people/me', 35 | authorizationParams: { 36 | scope: 'https://www.googleapis.com/auth/plus.profile.emails.read' 37 | }, 38 | parse: googleMiddleware.parseGoogleProfile 39 | }; 40 | 41 | var oauth2Options = _.extend(googleStrategy, config); 42 | 43 | return middleware.oauth2(oauth2Options, nextApp); 44 | }; 45 | 46 | googleMiddleware.parseGoogleProfile = parseGoogleProfile; 47 | -------------------------------------------------------------------------------- /lib/middleware/gzip.js: -------------------------------------------------------------------------------- 1 | var zlib = require('zlib') 2 | , bogart = require('../bogart') 3 | , middleware = require('../middleware') 4 | , q = require('../q'); 5 | 6 | function acceptsGzip(req) { 7 | var encodings; 8 | 9 | if (!req.headers || !req.headers['accept-encoding']) { 10 | return false; 11 | } 12 | 13 | encodings = req.headers['accept-encoding'].split(','); 14 | return encodings.filter(function(x) { 15 | return x === 'gzip'; 16 | }).length > 0; 17 | } 18 | 19 | function toForEachable(stream) { 20 | var forEachable = {} 21 | , deferred = q.defer() 22 | , buffer = [] 23 | , cb = null; 24 | 25 | forEachable.forEach = function(callback) { 26 | cb = callback; 27 | 28 | while (x = buffer.pop()) { 29 | cb(x); 30 | } 31 | 32 | return deferred.promise; 33 | }; 34 | 35 | stream.on('data', function(data) { 36 | if (cb === null) { buffer.push(data); } 37 | else { cb(data); } 38 | }); 39 | 40 | stream.on('end', function() { 41 | deferred.resolve(); 42 | }); 43 | 44 | return forEachable; 45 | } 46 | 47 | module.exports = middleware(function (req, nextApp) { 48 | var resp = nextApp(req); 49 | 50 | if (acceptsGzip(req)) { 51 | return q.when(resp, function(resp) { 52 | var gzip = zlib.createGzip(); 53 | resp.headers['content-encoding'] = 'gzip'; 54 | if (resp.headers['content-length']) { 55 | delete resp.headers['content-length']; 56 | } 57 | if (resp.headers['Content-Length']) { 58 | delete resp.headers['Content-Length']; 59 | } 60 | 61 | bogart.pump(resp.body, gzip); 62 | 63 | if(resp.status != 304) { 64 | resp.body = toForEachable(gzip); 65 | } 66 | return resp; 67 | }); 68 | } else { 69 | return resp; 70 | } 71 | }); 72 | -------------------------------------------------------------------------------- /lib/middleware/methodOverride.js: -------------------------------------------------------------------------------- 1 | var middleware = require('../middleware'); 2 | 3 | var HTTP_METHODS = { 4 | "GET": true, 5 | "HEAD": true, 6 | "PUT": true, 7 | "POST": true, 8 | "DELETE": true, 9 | "OPTIONS": true 10 | }; 11 | 12 | var METHOD_OVERRIDE_PARAM_KEY = "_method"; 13 | var HTTP_METHOD_OVERRIDE_HEADER = 'x-http-method-override'; 14 | 15 | /** 16 | * Provides Rails-style HTTP method overriding via the _method parameter or X-HTTP-METHOD-OVERRIDE header 17 | * http://code.google.com/apis/gdata/docs/2.0/basics.html#UpdatingEntry 18 | */ 19 | var methodOverride = middleware(function (req, nextApp) { 20 | 21 | if (req.body && typeof req.body == 'object') { 22 | 23 | if ((req.method.toUpperCase() == 'POST') && (req.headers['content-type'] && !req.headers['content-type'].match(/^multipart\/form-data/))) { 24 | var method = req.headers[HTTP_METHOD_OVERRIDE_HEADER] || req.body[METHOD_OVERRIDE_PARAM_KEY]; 25 | 26 | if (method && HTTP_METHODS[method.toUpperCase()] === true) { 27 | req.env.original_method = req.method; 28 | req.method = method.toUpperCase(); 29 | } 30 | } 31 | } 32 | return nextApp(req); 33 | }); 34 | 35 | methodOverride.METHOD_OVERRIDE_PARAM_KEY = METHOD_OVERRIDE_PARAM_KEY; 36 | methodOverride.HTTP_METHOD_OVERRIDE_HEADER = HTTP_METHOD_OVERRIDE_HEADER; 37 | 38 | module.exports = methodOverride; 39 | -------------------------------------------------------------------------------- /lib/middleware/oauth.js: -------------------------------------------------------------------------------- 1 | var q = require('../q') 2 | , oauth = require('oauth') 3 | , bogart = require('../bogart') 4 | , _ = require('underscore') 5 | , url = require('url'); 6 | 7 | module.exports = function oauthMiddleware(config, nextApp) { 8 | if (nextApp === undefined) { 9 | return function (nextApp) { 10 | return oauthMiddleware(config, nextApp); 11 | }; 12 | } 13 | 14 | var options = { 15 | loginRoute: '/auth/login', 16 | logoutRoute: '/auth/logout', 17 | callbackRoute: '/auth/callback', 18 | errorUrl: '/' 19 | }; 20 | options = _.extend(options, config); 21 | 22 | if (!options.host) { 23 | throw new Error('host is a required option') 24 | } 25 | 26 | if (!options.host.match(/^http/)) { 27 | throw new Error('host must include the protocal.'); 28 | } 29 | 30 | options.host = options.host.replace(/\/$/, ''); //remove trailing slash 31 | 32 | var OAuth = new oauth.OAuth(options.requestTokenURL, options.accessTokenURL, options.consumerKey, options.consumerSecret, '1.0A', null, 'HMAC-SHA1'); 33 | 34 | var authorized = function(req) { 35 | if (!req.session('profile')) { 36 | return bogart.redirect(options.loginRoute + '?returnUrl=' + req.pathInfo ); 37 | } 38 | req.auth = req.auth || {}; 39 | req.auth.profile = req.session('profile'); 40 | req.auth.access_token = req.session('access_token'); 41 | return nextApp(req); 42 | }; 43 | 44 | var router = bogart.router(authorized); 45 | 46 | router.get(options.loginRoute, function (req) { 47 | var deferred = q.defer(); 48 | var callbackRoute = options.host + options.callbackRoute; 49 | if (req.params.returnUrl) { 50 | callbackRoute += '?returnUrl=' + encodeURIComponent(req.params.returnUrl); 51 | } 52 | var params = { 53 | oauth_callback: callbackRoute 54 | }; 55 | OAuth.getOAuthRequestToken(params, function (error, token, tokenSecret, params) { 56 | if (error) { 57 | deferred.reject(error); 58 | } 59 | req.session('oauth_token_secret', tokenSecret); 60 | var parsed = url.parse(options.authorizationURL, true); 61 | parsed.query.oauth_token = token; 62 | var location = url.format(parsed); 63 | deferred.resolve(bogart.redirect(location)); 64 | }); 65 | return deferred.promise; 66 | }); 67 | 68 | router.get(options.logoutRoute, function (req) { 69 | req.session('profile', undefined); 70 | 71 | return bogart.redirect('/'); 72 | }); 73 | 74 | router.get(options.callbackRoute, function (req) { 75 | var deferred = q.defer(); 76 | var oAuthToken = req.params.oauth_token, 77 | oAuthVerifier = req.params.oauth_verifier, 78 | oAuthTokenSecret = req.session('oauth_token_secret'); 79 | OAuth.getOAuthAccessToken(oAuthToken, oAuthTokenSecret, oAuthVerifier, function (error, accessToken, tokenSecret, params) { 80 | if (error) { 81 | deferred.reject(error); 82 | } 83 | var parsed = url.parse(options.resourceURL, true); 84 | options.resourceURLParams.forEach(function (resourceUrlParam) { 85 | if (params[resourceUrlParam]) { 86 | parsed.query[resourceUrlParam] = params[resourceUrlParam]; 87 | } 88 | }); 89 | var location = url.format(parsed); 90 | OAuth.getProtectedResource(location, 'get', accessToken, tokenSecret, function (error, body, res) { 91 | if (error) { 92 | deferred.reject(error); 93 | } 94 | var profile = q(options.parse(body, req)).then(function (profile) { 95 | req.session('profile', profile); 96 | req.session('access_token', accessToken); 97 | return bogart.redirect(options.successUrl || req.params.returnUrl || '/'); 98 | }).fail(function (error) { 99 | var parsedUrl = url.parse(options.errorUrl, true); 100 | parsedUrl.query.message = error.message; 101 | var redirectUrl = url.format(parsedUrl); 102 | return bogart.redirect(redirectUrl); 103 | }); 104 | deferred.resolve(profile); 105 | }); 106 | }); 107 | return deferred.promise; 108 | }); 109 | 110 | return router(nextApp); 111 | }; 112 | -------------------------------------------------------------------------------- /lib/middleware/oauth2.js: -------------------------------------------------------------------------------- 1 | var q = require('../q') 2 | , oauth = require('oauth') 3 | , bogart = require('../bogart') 4 | , _ = require('underscore') 5 | , url = require('url'); 6 | 7 | module.exports = function oauth2Middleware(config, nextApp) { 8 | if (nextApp === undefined) { 9 | return function (nextApp) { 10 | return oauth2Middleware(config, nextApp); 11 | }; 12 | } 13 | 14 | var options = { 15 | loginRoute: '/auth/login', 16 | logoutRoute: '/auth/logout', 17 | callbackRoute: '/auth/callback', 18 | modalAuthRoute: '/auth/modalauth', 19 | errorUrl: '/' 20 | }; 21 | options = _.extend(options, config); 22 | 23 | if (!options.host) { 24 | throw new Error('host is a required option') 25 | } 26 | 27 | if (!options.host.match(/^http/)) { 28 | throw new Error('host must include the protocal.'); 29 | } 30 | 31 | options.host = options.host.replace(/\/$/, ''); //remove trailing slash 32 | 33 | var OAuth2 = new oauth.OAuth2(options.clientId, options.clientSecret, '', options.authorizationURL, options.tokenURL); 34 | 35 | var authd = function(req) { 36 | if (!req.session('profile')) { 37 | return bogart.redirect(options.loginRoute + '?returnUrl=' + req.pathInfo ); 38 | } 39 | req.auth = req.auth || {}; 40 | req.auth.profile = req.session('profile'); 41 | req.auth.access_token = req.session('access_token'); 42 | return nextApp(req); 43 | }; 44 | var router = bogart.router(authd); 45 | var callbackRoute = '' 46 | router.get(options.loginRoute, function (req) { 47 | 48 | callbackRoute = options.host + options.callbackRoute; 49 | if (req.params.returnUrl) { 50 | callbackRoute += '?returnUrl=' + encodeURIComponent(req.params.returnUrl); 51 | } 52 | 53 | var url = OAuth2.getAuthorizeUrl(_.extend({ 54 | response_type: 'code', 55 | redirect_uri: callbackRoute 56 | }, config.authorizationParams)); 57 | 58 | return bogart.redirect(url); 59 | }); 60 | 61 | router.get(options.logoutRoute, function (req) { 62 | req.session('profile', undefined); 63 | 64 | return bogart.redirect('/'); 65 | }); 66 | 67 | router.get(options.callbackRoute, function (req) { 68 | var deferred = q.defer(); 69 | 70 | if (req.params.code) { 71 | var code = req.params.code; 72 | // NOTE: The module oauth (0.9.5), which is a dependency, automatically adds 73 | // a 'type=web_server' parameter to the percent-encoded data sent in 74 | // the body of the access token request. This appears to be an 75 | // artifact from an earlier draft of OAuth 2.0 (draft 22, as of the 76 | // time of this writing). This parameter is not necessary, but its 77 | // presence does not appear to cause any issues. 78 | OAuth2.getOAuthAccessToken(code, { 79 | grant_type: 'authorization_code', 80 | redirect_uri: callbackRoute 81 | }, function (err, accessToken, refreshToken) { 82 | OAuth2.getProtectedResource(options.resourceURL, accessToken, function(err, body, res) { 83 | try { 84 | if (err) { 85 | console.log(err) 86 | deferred.reject(err); 87 | } 88 | 89 | var profile = q(options.parse(body, req)).then(function (profile) { 90 | req.session('profile', profile); 91 | req.session('access_token', accessToken); 92 | 93 | return bogart.redirect(options.successUrl || req.params.returnUrl || '/'); 94 | }).fail(function (error) { 95 | var parsedUrl = url.parse(options.errorUrl, true); 96 | parsedUrl.query.message = error.message; 97 | var redirectUrl = url.format(parsedUrl); 98 | return bogart.redirect(redirectUrl); 99 | }); 100 | deferred.resolve(profile); 101 | } catch (e) { 102 | deferred.reject(e); 103 | } 104 | }); 105 | }); 106 | } 107 | 108 | return deferred.promise; 109 | }); 110 | 111 | router.post(options.modalAuthRoute, function(req) { 112 | var deffered = q.defer() 113 | , accessToken = req.params.accessToken; 114 | 115 | OAuth2.getProtectedResource(options.resourceURL, accessToken, function (err, body, res) { 116 | try { 117 | var profile = options.parse(body) 118 | if (err) { 119 | deffered.reject(err); 120 | } 121 | 122 | req.session('profile', profile); 123 | req.session('access_token', accessToken); 124 | 125 | deffered.resolve(bogart.redirect(req.params.returnUrl || '/')); 126 | } catch (e) { 127 | deffered.reject(e); 128 | } 129 | }); 130 | 131 | return deffered.promise; 132 | }); 133 | 134 | return router(nextApp); 135 | }; 136 | -------------------------------------------------------------------------------- /lib/middleware/parseForm.js: -------------------------------------------------------------------------------- 1 | var q = require('../q') 2 | , middleware = require('../middleware') 3 | , forEachable = require('../forEachable') 4 | , querystring = require('querystring'); 5 | 6 | module.exports = middleware(function (req, nextApp) { 7 | var contentType = req.headers['content-type']; 8 | 9 | if (contentType) { 10 | if (contentType.indexOf(';')) { 11 | contentType = contentType.split(';')[0]; 12 | } 13 | 14 | if (contentType === 'application/x-www-form-urlencoded' && req.body) { 15 | 16 | return q.when(forEachable.join(req.body), function (body) { 17 | req.body = querystring.parse(body); 18 | 19 | return nextApp(req); 20 | }); 21 | } 22 | } 23 | 24 | return nextApp(req); 25 | }); 26 | -------------------------------------------------------------------------------- /lib/middleware/parseJson.js: -------------------------------------------------------------------------------- 1 | var middleware = require('../middleware') 2 | , forEachable = require('../forEachable') 3 | , q = require('../q'); 4 | 5 | module.exports = middleware(function (req, nextApp) { 6 | var contentType = req.headers['content-type']; 7 | 8 | if (contentType && req.body) { 9 | if (contentType === 'application/json') { 10 | 11 | return q.when(forEachable.join(req.body), function success(body) { 12 | req.body = JSON.parse(body); 13 | 14 | return nextApp(req); 15 | }); 16 | } 17 | } 18 | 19 | return nextApp(req); 20 | }); -------------------------------------------------------------------------------- /lib/middleware/parted.js: -------------------------------------------------------------------------------- 1 | var q = require('../q') 2 | , ForEachStream = require('../forEachStream') 3 | , parted = require('parted'); 4 | 5 | module.exports = function partedMiddleware(opts, nextApp) { 6 | if (nextApp === undefined) { 7 | if (typeof opts === 'function') { 8 | nextApp = opts; 9 | opts = undefined; 10 | } else { 11 | return function (nextApp) { 12 | return partedMiddleware(opts, nextApp); 13 | }; 14 | } 15 | } 16 | 17 | var fn = parted(opts); 18 | 19 | return function (req) { 20 | var deferred = q.defer() 21 | , oldBody = req.body 22 | , emitter; 23 | 24 | if (oldBody === undefined) { 25 | return nextApp(req); 26 | } 27 | 28 | emitter = new ForEachStream(oldBody); 29 | req.on = emitter.on.bind(emitter); 30 | req.pipe = emitter.pipe.bind(emitter); 31 | 32 | delete req.body; 33 | 34 | fn(req, null, function () { 35 | q.when(nextApp(req), function (resp) { 36 | deferred.resolve(resp); 37 | }, deferred.reject); 38 | }); 39 | 40 | return deferred.promise; 41 | }; 42 | }; -------------------------------------------------------------------------------- /lib/middleware/renderView.js: -------------------------------------------------------------------------------- 1 | var middleware = require('./middleware'); 2 | 3 | /* 4 | * Renders `template` using `viewEngine`. 5 | * ViewEngine#respond is called with the results of 6 | * the `next` apps response. 7 | * 8 | * Example: 9 | * 10 | * var router = bogart.router(); 11 | * router.get('/', bogart.middleware.renderView('index.html'), function (req) { 12 | * return { locals: { title: 'Bogart' }, layout: true }; 13 | * }); 14 | * 15 | * @param {ViewEngine} viewEngine 16 | * @param {String} template The template to render. 17 | */ 18 | function RenderView(viewEngine, template) { 19 | return middleware(req, next) { 20 | return next(req).then(function (renderOpts) { 21 | return viewEngine.respond(template, renderOpts); 22 | }); 23 | }; 24 | } 25 | 26 | module.exports = RenderView; 27 | -------------------------------------------------------------------------------- /lib/middleware/session/cookieDataProvider.js: -------------------------------------------------------------------------------- 1 | var uuid = require("node-uuid"), 2 | security = require("../../security"), 3 | util = require("../../util"), 4 | SESSION_DATA_COOKIE = "bogart_session_data", 5 | DEFAULT_SESSION_LIFETIME = 1800 /* 30 mins */; 6 | 7 | function CookieDataProvider(config) { 8 | config = config || {}; 9 | config.lifetime = config.lifetime || DEFAULT_SESSION_LIFETIME; 10 | 11 | if (!config.secret) { 12 | throw new Error('CookieDataProvider `secret` is required: new CookieDataProvider({ secret: "my-super-secret" })'); 13 | } 14 | 15 | this.encrypt = config.encrypt || security.encrypt; 16 | this.decrypt = config.decrypt || security.decrypt; 17 | 18 | this.config = config; 19 | this.cookieKey = encodeURIComponent(this.encrypt(SESSION_DATA_COOKIE, this.config.secret)); 20 | } 21 | 22 | /** 23 | * Called once at the beginning of the request 24 | */ 25 | CookieDataProvider.prototype.loadSession = function(req, sessionId) { 26 | var cookie = util.parseCookies(req)[this.cookieKey]; 27 | 28 | var decryptedCookie, session; 29 | try { 30 | decryptedCookie = this.decrypt(decodeURIComponent(cookie), this.config.secret); 31 | session = cookie ? JSON.parse(decryptedCookie) : {}; 32 | } catch (err) { 33 | session = {}; 34 | } 35 | 36 | return session; 37 | }; 38 | 39 | /** 40 | * Called once at the end of the request 41 | */ 42 | CookieDataProvider.prototype.save = function(req, res, sessionId) { 43 | return this.setCookie(req, res, sessionId, this.config.lifetime); 44 | }; 45 | 46 | CookieDataProvider.prototype.destroy = function (req, res, sessionId) { 47 | return this.setCookie(req, res, sessionId, -1); 48 | }; 49 | 50 | CookieDataProvider.prototype.setCookie = function (req, res, sessionId, expiresInSeconds) { 51 | var cookieKey = this.cookieKey; 52 | var secret = this.config.secret; 53 | 54 | res = res || {}; 55 | res.headers = res.headers || {}; 56 | res.headers["Set-Cookie"] = res.headers["Set-Cookie"] || []; 57 | 58 | var expires = new Date(); 59 | expires.setSeconds(expires.getSeconds() + expiresInSeconds); 60 | 61 | var sData = expiresInSeconds > 0 ? JSON.stringify(req.env.session) : '{}'; 62 | 63 | var cookie = cookieKey + "=" + encodeURIComponent(this.encrypt(sData, secret)) + "; Path=/; Expires=" + expires.toUTCString() + ";"; 64 | 65 | res = util.ensureSetCookieArray(res); 66 | res.headers["Set-Cookie"] = res.headers["Set-Cookie"].filter(function(el) { 67 | return !(new RegExp("^" + cookieKey + "=").test(el)); 68 | }); 69 | res.headers["Set-Cookie"].push(cookie); 70 | 71 | return res; 72 | } 73 | 74 | module.exports = CookieDataProvider; 75 | -------------------------------------------------------------------------------- /lib/middleware/session/idProvider.js: -------------------------------------------------------------------------------- 1 | var uuid = require("node-uuid"), 2 | security = require("../../security"), 3 | util = require("../../util"), 4 | format = require('util').format, 5 | SESSION_ID_COOKIE = "bogart_session_id", 6 | DEFAULT_SESSION_LIFETIME = 1800; 7 | 8 | exports.IdProvider = IdProvider; 9 | 10 | function IdProvider(config) { 11 | config = config || {}; 12 | config.lifetime = config.lifetime || DEFAULT_SESSION_LIFETIME; 13 | 14 | this.config = config; 15 | this.cookieKey = encodeURIComponent(security.encrypt(SESSION_ID_COOKIE, this.config.secret)); 16 | } 17 | 18 | /** 19 | * Called once at the beginning of each request. 20 | */ 21 | IdProvider.prototype.getSessionId = function(req) { 22 | var cookie = util.parseCookies(req)[this.cookieKey]; 23 | var id; 24 | if (!cookie) { 25 | id = uuid(); 26 | } else { 27 | id = security.decrypt(decodeURIComponent(cookie), this.config.secret); 28 | } 29 | return id; 30 | }; 31 | 32 | 33 | /** 34 | * Modifies the response to include the SessionId 35 | * 36 | * @param {Object} req JSGI Request 37 | * @param {Object} res JSGI Response 38 | * @param {String} sessionId Unique identifier of the Session. 39 | * 40 | * @returns {Object} JSGI Response 41 | */ 42 | IdProvider.prototype.save = function(req, res, sessionId) { 43 | return setCookie(req, res, sessionId, this.config.lifetime, this.config.secret, this.cookieKey); 44 | }; 45 | 46 | IdProvider.prototype.destroy = function (req, res, sessionId) { 47 | return setCookie(req, res, '', -1, this.config.secret, this.cookieKey); 48 | }; 49 | 50 | function setCookie(req, res, sessionId, expiresInSeconds, secret, cookieKey) { 51 | res = res || {}; 52 | res.headers = res.headers || {}; 53 | res.headers["Set-Cookie"] = res.headers["Set-Cookie"] || []; 54 | var expires = new Date(); 55 | expires.setSeconds(expires.getSeconds() + expiresInSeconds); 56 | 57 | var cookie = sessionCookie(sessionId, secret, expires, cookieKey); 58 | 59 | res = util.ensureSetCookieArray(res); 60 | res.headers["Set-Cookie"] = res.headers["Set-Cookie"].filter(isNotSessionIdCookie(cookieKey)); 61 | res.headers["Set-Cookie"].push(cookie); 62 | 63 | return res; 64 | } 65 | 66 | function isNotSessionIdCookie(cookieKey) { 67 | return function (el) { 68 | return !(new RegExp("^" + cookieKey + "=").test(el)); 69 | } 70 | } 71 | 72 | function sessionCookie(sessionId, secret, expires, cookieKey) { 73 | return format("%s=%s; Path=/; Expires=%s;", 74 | cookieKey, 75 | encodeSessionId(sessionId, secret), 76 | expires.toUTCString()); 77 | } 78 | 79 | function encodeSessionId(sessionId, secret) { 80 | return encodeURIComponent(security.encrypt(sessionId, secret)); 81 | } 82 | -------------------------------------------------------------------------------- /lib/middleware/session/session.js: -------------------------------------------------------------------------------- 1 | var Q = require('../../q'), 2 | when = Q.when, 3 | DefaultIdProvider = require('./idProvider').IdProvider, 4 | CookieDataProvider = require('./cookieDataProvider'); 5 | 6 | exports.Session = function (config, nextApp) { 7 | if (nextApp === undefined) { 8 | 9 | if (typeof config === 'function') { 10 | nextApp = config; 11 | config = {}; 12 | } else { 13 | return function (nextApp) { 14 | return exports.Session(config, nextApp); 15 | }; 16 | } 17 | } 18 | 19 | config = config || {}; 20 | config.options = config.options || {}; 21 | config.options.idProvider = config.options.idProvider || {}; 22 | config.options.store = config.options.store || {}; 23 | config.options.idProvider.lifetime = config.lifetime || undefined; 24 | config.options.store.lifetime = config.lifetime || undefined; 25 | 26 | if (config.encryptionKey) { 27 | warnConfigChange('encryptionKey', 'secret'); 28 | config.secret = config.encryptionKey; 29 | } 30 | 31 | if (config.dataProvider) { 32 | warnConfigChange('dataProvider', 'store'); 33 | config.store = config.dataProvider; 34 | } 35 | 36 | if (config.options.dataProvider) { 37 | warnConfigChange('options.dataProvider', 'options.store'); 38 | config.options.store = config.options.dataProvider; 39 | } 40 | 41 | if (config.secret) { 42 | config.options.idProvider.secret = config.secret; 43 | config.options.store.secret = config.secret; 44 | } 45 | 46 | var idProvider = config.idProvider || new DefaultIdProvider(config.options.idProvider); 47 | var dataProvider = config.store || new CookieDataProvider(config.options.store); 48 | 49 | return function (req) { 50 | var sessionId = idProvider.getSessionId(req); 51 | 52 | return when(dataProvider.loadSession(req, sessionId), function (session) { 53 | req.env = req.env || {}; 54 | req.env.session = session; 55 | 56 | // set up the session function 57 | req.session = function () { 58 | var args = Array.prototype.slice.call(arguments); 59 | if (args.length === 2) { 60 | session[args[0]] = args[1]; 61 | } else { 62 | return session[args[0]]; 63 | } 64 | }; 65 | 66 | req.session.keys = function () { 67 | return Object.keys(session); 68 | }; 69 | 70 | req.session.hasKey = function (key) { 71 | return this.keys().filter(function (k) { return k === key; }).length > 0; 72 | }; 73 | 74 | req.session.remove = function (key) { 75 | delete session[key]; 76 | }; 77 | 78 | req.session.destroy = function () { 79 | req.session._destroy = true; 80 | }; 81 | 82 | return when(nextApp(req), function (res) { 83 | if (req.session._destroy === true) { 84 | res = idProvider.destroy(req, res, sessionId) || res; 85 | return when(dataProvider.destroy(req, res, sessionId), function (dpResp) { 86 | return dpResp || res; 87 | }); 88 | } else { 89 | res = idProvider.save(req, res, sessionId) || res; 90 | 91 | return when(dataProvider.save(req, res, sessionId), function (dpResp) { 92 | return dpResp || res; 93 | }); 94 | } 95 | }); 96 | }); 97 | }; 98 | }; 99 | 100 | function warnConfigChange(oldProperty, newProperty) { 101 | console.warn('The bogart.session configuration `'+oldProperty+'` has been changed to `'+newProperty+'`. \ 102 | Please update your configuration.') 103 | } 104 | 105 | exports.Session.DefaultIdProvider = DefaultIdProvider; 106 | exports.Session.DefaultDataProvider = CookieDataProvider; -------------------------------------------------------------------------------- /lib/middleware/stringReturnAdapter.js: -------------------------------------------------------------------------------- 1 | var q = require('../q') 2 | , merge = require('../util').merge; 3 | 4 | module.exports = function stringReturnAdapter(responseDefaults, nextApp) { 5 | if (nextApp === undefined) { 6 | if (typeof responseDefaults === 'function') { 7 | nextApp = responseDefaults; 8 | responseDefaults = { 9 | status: 200, 10 | headers: { 'Content-Type': 'text/html' } 11 | }; 12 | } else { 13 | return function (nextApp) { 14 | return stringReturnAdapter(responseDefaults, nextApp); 15 | }; 16 | } 17 | } 18 | 19 | return function (req) { 20 | return q.when(nextApp(req), function (resp) { 21 | if (typeof resp === 'string') { 22 | return merge({}, responseDefaults, { body: [ resp ] }); 23 | } 24 | 25 | return resp; 26 | }); 27 | }; 28 | }; -------------------------------------------------------------------------------- /lib/middleware/twitter.js: -------------------------------------------------------------------------------- 1 | var middleware = require('../middleware') 2 | , _ = require('underscore'); 3 | 4 | function parseTwitterProfile(body) { 5 | if (body) { 6 | var o = JSON.parse(body), 7 | profile = { 8 | provider: 'twitter', 9 | id: o.id, 10 | userName: o.screen_name, 11 | email: o.screen_name, 12 | imageLocation: o.profile_image_url 13 | }; 14 | if (o.name) { 15 | var nameSplit = o.name.split(' '); 16 | profile.givenName = nameSplit[0]; 17 | profile.surName = nameSplit[1]; 18 | } 19 | if (o.location) { 20 | var locationSplit = o.location.split(','); 21 | profile.city = locationSplit[0]; 22 | profile.state = locationSplit[1].trim(); 23 | } 24 | return profile; 25 | } 26 | } 27 | 28 | module.exports = twitterMiddleware; 29 | 30 | function twitterMiddleware(config, nextApp) { 31 | if (nextApp === undefined) { 32 | return function (nextApp) { 33 | return twitterMiddleware(config, nextApp); 34 | }; 35 | } 36 | 37 | var twitter_strategy = { 38 | authorizationURL: 'https://api.twitter.com/oauth/authorize', 39 | requestTokenURL: 'https://api.twitter.com/oauth/request_token', 40 | accessTokenURL: 'https://api.twitter.com/oauth/access_token', 41 | resourceURL: 'https://api.twitter.com/1.1/users/show.json', 42 | parse: twitterMiddleware.parseTwitterProfile, 43 | resourceURLParams: [ 'user_id' ] 44 | }; 45 | 46 | var oauthOptions = _.extend(twitter_strategy, config); 47 | 48 | return middleware.oauth(oauthOptions, nextApp); 49 | }; 50 | 51 | twitterMiddleware.parseTwitterProfile = parseTwitterProfile; 52 | -------------------------------------------------------------------------------- /lib/middleware/validateResponse.js: -------------------------------------------------------------------------------- 1 | var q = require('../q') 2 | , middleware = require('../middleware'); 3 | 4 | /** 5 | * Validates that the response from nextApp is a valid JSGI response. 6 | * Rejects the promise if the response is invalid. 7 | * 8 | * @param {Function} nextApp The next application in the JSGI chain. 9 | * @returns {Function} JSGI response. 10 | */ 11 | module.exports = middleware(function (req, nextApp) { 12 | return q.whenCall(function() { return nextApp(req); }, function(resp) { 13 | if (!resp) { 14 | return q.reject('Response must be an object.'); 15 | } 16 | 17 | if (!resp.body) { 18 | return q.reject('Response must have a body property.'); 19 | } 20 | 21 | if (!resp.body.forEach) { 22 | return q.reject('Response body must have a forEach method.'); 23 | } 24 | 25 | if (typeof resp.body.forEach !== 'function') { 26 | return q.reject('Response body has a forEach method but the forEach method is not a function.'); 27 | } 28 | 29 | if (!resp.status) { 30 | return q.reject('Response must have a status property.'); 31 | } 32 | 33 | if (typeof resp.status.constructor !== '[Function: Number]') { 34 | return q.reject('Response has a status property but the status property must be a number.'); 35 | } 36 | 37 | return resp; 38 | }, function(err) { 39 | // Workaround for fact that whenCall calls rejectCallback even if one is not provided. 40 | throw err; 41 | }); 42 | }); -------------------------------------------------------------------------------- /lib/mimetypes.js: -------------------------------------------------------------------------------- 1 | 2 | // -- tlrobinson 3 | 4 | /** 5 | * @module 6 | */ 7 | 8 | /*whatsupdoc*/ 9 | 10 | // returns MIME type for extension, or fallback, or octet-steam 11 | /** 12 | * @param {String} extension a file extension, including the prefix 13 | * `"."`. 14 | * @param {String} fallback a MIME type to use if no MIME type 15 | * corresponds to the prefix. Defaults to 16 | * `"application/octet-stream"`. 17 | * @returns {String} a MIME type 18 | */ 19 | exports.mimeType = function (extension, fallback) { 20 | return exports.mimeTypes[extension.toLowerCase()] || 21 | fallback || 22 | "application/octet-stream"; 23 | }; 24 | 25 | // List of most common mime-types, stolen from Rack. 26 | /** 27 | * {Object * String} an object mapping file extensions to MIME types. 28 | */ 29 | exports.mimeTypes = { 30 | ".3gp" : "video/3gpp", 31 | ".a" : "application/octet-stream", 32 | ".ai" : "application/postscript", 33 | ".aif" : "audio/x-aiff", 34 | ".aiff" : "audio/x-aiff", 35 | ".asc" : "application/pgp-signature", 36 | ".asf" : "video/x-ms-asf", 37 | ".asm" : "text/x-asm", 38 | ".asx" : "video/x-ms-asf", 39 | ".atom" : "application/atom+xml", 40 | ".au" : "audio/basic", 41 | ".avi" : "video/x-msvideo", 42 | ".bat" : "application/x-msdownload", 43 | ".bin" : "application/octet-stream", 44 | ".bmp" : "image/bmp", 45 | ".bz2" : "application/x-bzip2", 46 | ".c" : "text/x-c", 47 | ".cab" : "application/vnd.ms-cab-compressed", 48 | ".cc" : "text/x-c", 49 | ".chm" : "application/vnd.ms-htmlhelp", 50 | ".class" : "application/octet-stream", 51 | ".com" : "application/x-msdownload", 52 | ".conf" : "text/plain", 53 | ".cpp" : "text/x-c", 54 | ".crt" : "application/x-x509-ca-cert", 55 | ".css" : "text/css", 56 | ".csv" : "text/csv", 57 | ".cxx" : "text/x-c", 58 | ".deb" : "application/x-debian-package", 59 | ".der" : "application/x-x509-ca-cert", 60 | ".diff" : "text/x-diff", 61 | ".djv" : "image/vnd.djvu", 62 | ".djvu" : "image/vnd.djvu", 63 | ".dll" : "application/x-msdownload", 64 | ".dmg" : "application/octet-stream", 65 | ".doc" : "application/msword", 66 | ".dot" : "application/msword", 67 | ".dtd" : "application/xml-dtd", 68 | ".dvi" : "application/x-dvi", 69 | ".ear" : "application/java-archive", 70 | ".eml" : "message/rfc822", 71 | ".eps" : "application/postscript", 72 | ".exe" : "application/x-msdownload", 73 | ".f" : "text/x-fortran", 74 | ".f77" : "text/x-fortran", 75 | ".f90" : "text/x-fortran", 76 | ".flv" : "video/x-flv", 77 | ".for" : "text/x-fortran", 78 | ".gem" : "application/octet-stream", 79 | ".gemspec" : "text/x-script.ruby", 80 | ".gif" : "image/gif", 81 | ".gz" : "application/x-gzip", 82 | ".h" : "text/x-c", 83 | ".hh" : "text/x-c", 84 | ".htm" : "text/html", 85 | ".html" : "text/html", 86 | ".ico" : "image/vnd.microsoft.icon", 87 | ".ics" : "text/calendar", 88 | ".ifb" : "text/calendar", 89 | ".iso" : "application/octet-stream", 90 | ".jar" : "application/java-archive", 91 | ".java" : "text/x-java-source", 92 | ".jnlp" : "application/x-java-jnlp-file", 93 | ".jpeg" : "image/jpeg", 94 | ".jpg" : "image/jpeg", 95 | ".js" : "application/javascript", 96 | ".json" : "application/json", 97 | ".log" : "text/plain", 98 | ".m3u" : "audio/x-mpegurl", 99 | ".m4v" : "video/mp4", 100 | ".man" : "text/troff", 101 | ".manifest": "text/cache-manifest", 102 | ".mathml" : "application/mathml+xml", 103 | ".mbox" : "application/mbox", 104 | ".mdoc" : "text/troff", 105 | ".me" : "text/troff", 106 | ".mid" : "audio/midi", 107 | ".midi" : "audio/midi", 108 | ".mime" : "message/rfc822", 109 | ".mml" : "application/mathml+xml", 110 | ".mng" : "video/x-mng", 111 | ".mov" : "video/quicktime", 112 | ".mp3" : "audio/mpeg", 113 | ".mp4" : "video/mp4", 114 | ".mp4v" : "video/mp4", 115 | ".mpeg" : "video/mpeg", 116 | ".mpg" : "video/mpeg", 117 | ".ms" : "text/troff", 118 | ".msi" : "application/x-msdownload", 119 | ".odp" : "application/vnd.oasis.opendocument.presentation", 120 | ".ods" : "application/vnd.oasis.opendocument.spreadsheet", 121 | ".odt" : "application/vnd.oasis.opendocument.text", 122 | ".ogg" : "application/ogg", 123 | ".p" : "text/x-pascal", 124 | ".pas" : "text/x-pascal", 125 | ".pbm" : "image/x-portable-bitmap", 126 | ".pdf" : "application/pdf", 127 | ".pem" : "application/x-x509-ca-cert", 128 | ".pgm" : "image/x-portable-graymap", 129 | ".pgp" : "application/pgp-encrypted", 130 | ".pkg" : "application/octet-stream", 131 | ".pl" : "text/x-script.perl", 132 | ".pm" : "text/x-script.perl-module", 133 | ".png" : "image/png", 134 | ".pnm" : "image/x-portable-anymap", 135 | ".ppm" : "image/x-portable-pixmap", 136 | ".pps" : "application/vnd.ms-powerpoint", 137 | ".ppt" : "application/vnd.ms-powerpoint", 138 | ".ps" : "application/postscript", 139 | ".psd" : "image/vnd.adobe.photoshop", 140 | ".py" : "text/x-script.python", 141 | ".qt" : "video/quicktime", 142 | ".ra" : "audio/x-pn-realaudio", 143 | ".rake" : "text/x-script.ruby", 144 | ".ram" : "audio/x-pn-realaudio", 145 | ".rar" : "application/x-rar-compressed", 146 | ".rb" : "text/x-script.ruby", 147 | ".rdf" : "application/rdf+xml", 148 | ".roff" : "text/troff", 149 | ".rpm" : "application/x-redhat-package-manager", 150 | ".rss" : "application/rss+xml", 151 | ".rtf" : "application/rtf", 152 | ".ru" : "text/x-script.ruby", 153 | ".s" : "text/x-asm", 154 | ".sgm" : "text/sgml", 155 | ".sgml" : "text/sgml", 156 | ".sh" : "application/x-sh", 157 | ".sig" : "application/pgp-signature", 158 | ".snd" : "audio/basic", 159 | ".so" : "application/octet-stream", 160 | ".svg" : "image/svg+xml", 161 | ".svgz" : "image/svg+xml", 162 | ".swf" : "application/x-shockwave-flash", 163 | ".t" : "text/troff", 164 | ".tar" : "application/x-tar", 165 | ".tbz" : "application/x-bzip-compressed-tar", 166 | ".tcl" : "application/x-tcl", 167 | ".tex" : "application/x-tex", 168 | ".texi" : "application/x-texinfo", 169 | ".texinfo" : "application/x-texinfo", 170 | ".text" : "text/plain", 171 | ".tif" : "image/tiff", 172 | ".tiff" : "image/tiff", 173 | ".torrent" : "application/x-bittorrent", 174 | ".tr" : "text/troff", 175 | ".txt" : "text/plain", 176 | ".vcf" : "text/x-vcard", 177 | ".vcs" : "text/x-vcalendar", 178 | ".vrml" : "model/vrml", 179 | ".war" : "application/java-archive", 180 | ".wav" : "audio/x-wav", 181 | ".wma" : "audio/x-ms-wma", 182 | ".wmv" : "video/x-ms-wmv", 183 | ".wmx" : "video/x-ms-wmx", 184 | ".wrl" : "model/vrml", 185 | ".wsdl" : "application/wsdl+xml", 186 | ".xbm" : "image/x-xbitmap", 187 | ".xhtml" : "application/xhtml+xml", 188 | ".xls" : "application/vnd.ms-excel", 189 | ".xml" : "application/xml", 190 | ".xpm" : "image/x-xpixmap", 191 | ".xsl" : "application/xml", 192 | ".xslt" : "application/xslt+xml", 193 | ".yaml" : "text/yaml", 194 | ".yml" : "text/yaml", 195 | ".zip" : "application/zip" 196 | }; 197 | 198 | -------------------------------------------------------------------------------- /lib/q.js: -------------------------------------------------------------------------------- 1 | var q = require('q') 2 | , slice = Array.prototype.slice; 3 | 4 | /** 5 | * Wraps a Node.JS style asynchronous function `function(err, result) {}` 6 | * to return a `Promise`. 7 | * 8 | * @param {Function} nodeAsyncFn A node style async function expecting a callback as its last parameter. 9 | * @param {Object} context Optional, if provided nodeAsyncFn is run with `this` being `context`. 10 | * 11 | * @returns {Function} A function that returns a promise. 12 | */ 13 | q.promisify = function(nodeAsyncFn, context) { 14 | return function() { 15 | var defer = q.defer() 16 | , args = slice.call(arguments); 17 | 18 | args.push(function(err, val) { 19 | if (err !== null) { 20 | return defer.reject(err); 21 | } 22 | 23 | return defer.resolve(val); 24 | }); 25 | 26 | nodeAsyncFn.apply(context || {}, args); 27 | 28 | return defer.promise; 29 | }; 30 | }; 31 | 32 | if (!q.execute) { 33 | /** 34 | * Runs a Node.JS style asynchronous function `function(err, result) {}`, but returns a Promise instead. 35 | * @param {Function} Node.JS compatible async function which takes a callback as its last argument 36 | * @returns {Promise} A promise for the return value from the callback from the function 37 | */ 38 | q.execute = function(asyncFunction){ 39 | var defer = q.defer() 40 | , args = slice.call(arguments, 1); 41 | 42 | args.push(function(err, result){ 43 | if(err !== null) { 44 | defer.reject(err); 45 | } 46 | else { 47 | if(arguments.length > 2){ 48 | // Return an array if multiple success values. 49 | Array.prototype.shift.call(arguments, 1); 50 | defer.resolve(arguments); 51 | } 52 | else{ 53 | defer.resolve(result); 54 | } 55 | } 56 | }); 57 | asyncFunction.apply(this, args); 58 | return defer.promise; 59 | }; 60 | } 61 | 62 | if (!q.resolve) { 63 | q.resolve = function(val) { 64 | var deferred = q.defer(); 65 | 66 | deferred.resolve(val); 67 | 68 | return deferred.promise; 69 | }; 70 | } 71 | 72 | if (!q.reject) { 73 | q.reject = function(reason) { 74 | var deferred = q.defer(); 75 | 76 | deferred.reject(reason); 77 | 78 | return deferred.promise; 79 | } 80 | } 81 | 82 | if (!q.whenCall) { 83 | q.whenCall = function(callback, resolvedCallback, errorCallback, progressCallback) { 84 | try { 85 | return q.when(callback(), resolvedCallback, errorCallback, progressCallback); 86 | } catch (err) { 87 | return errorCallback(err); 88 | } 89 | } 90 | } 91 | 92 | module.exports = q; 93 | -------------------------------------------------------------------------------- /lib/request.js: -------------------------------------------------------------------------------- 1 | 2 | var util = require('./util'); 3 | 4 | module.exports = function(jsgiReq) { 5 | return Object.create(jsgiReq, { 6 | search: getter(function() { 7 | return util.extractSearch(jsgiReq); 8 | }), 9 | isXMLHttpRequest: getter(function() { 10 | return !util.no(this.headers['x-requested-with']); 11 | }), 12 | routeParams: { 13 | value: {}, 14 | enumerable: true 15 | }, 16 | params: getter(function() { 17 | return util.merge({}, this.routeParams, this.search, this.body); 18 | }) 19 | }); 20 | }; 21 | 22 | /** 23 | * Helper function to create property descriptor that is enumerable 24 | * and has a getter. 25 | * 26 | * @param fn {Function} The getter function. 27 | * @api private 28 | */ 29 | function getter(fn) { 30 | return { 31 | get: fn, 32 | enumerable: true 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /lib/router.js: -------------------------------------------------------------------------------- 1 | var 2 | util = require('./util'), 3 | EventEmitter = require('events').EventEmitter, 4 | Q = require('./q'), 5 | when = Q.when, 6 | inherits = require('util').inherits, 7 | slice = Array.prototype.slice, 8 | _ = require('underscore'); 9 | 10 | var 11 | httpMethod = { 12 | GET: "get", 13 | POST: "post", 14 | PUT: "put", 15 | DELETE: "delete" 16 | }, 17 | restMethod = { 18 | SHOW: httpMethod.GET, 19 | CREATE: httpMethod.POST, 20 | UPDATE: httpMethod.PUT, 21 | DESTROY: httpMethod.DELETE 22 | }, 23 | PATH_PARAMETER_REPLACEMENT = "([^\/\?]+)", 24 | PATH_PARAMETERS = /:([\w\d]+)/g; 25 | 26 | exports.bogartEvent = { 27 | BEFORE_ADD_ROUTE: "beforeAddRoute", 28 | AFTER_ADD_ROUTE: "afterAddRoute" 29 | }; 30 | 31 | function defaultNotFoundApp(req) { 32 | var body = 'Not Found'; 33 | if (req.pathInfo) { 34 | body += ': ' + req.pathInfo; 35 | } 36 | 37 | return { 38 | status: 404, 39 | body: [body], 40 | headers: { 'Content-Length': Buffer.byteLength(body, 'utf-8'), 'Content-Type': 'text/html' } 41 | }; 42 | } 43 | 44 | exports.Router = Router; 45 | function Router() { 46 | if (!this.respond) { 47 | return new Router(); 48 | } 49 | 50 | var settings = {} 51 | 52 | var app = function (notFoundApp) { 53 | if (notFoundApp) { 54 | if (typeof notFoundApp !== 'function') { 55 | throw new Error('Invalid argument: router expects a function.') 56 | } 57 | 58 | app.nextApp = notFoundApp; 59 | } else { 60 | app.nextApp = app.nextApp || defaultNotFoundApp; 61 | } 62 | 63 | return function (req) { 64 | return when(req, function(req) { 65 | try { 66 | return app.respond(require('./request')(req)); 67 | } catch (err) { 68 | return Q.reject(err); 69 | } 70 | }); 71 | }; 72 | }; 73 | 74 | app.routes = {}; 75 | app.beforeCallbacks = []; 76 | app.afterCallbacks = []; 77 | 78 | app.setting = function(name, val) { 79 | if (val === undefined) { 80 | return settings[name]; 81 | } 82 | 83 | settings[name] = val; 84 | return this; 85 | }; 86 | 87 | EventEmitter.call(app); 88 | 89 | _.extend(app, this.__proto__); 90 | _.extend(app, this.__proto__.__proto__); 91 | 92 | return app; 93 | } 94 | 95 | inherits(Router, EventEmitter); 96 | 97 | /** 98 | * Register a callback to happen before bogart handlers are invoked to 99 | * handle a request. Multiple 'before' callbacks may be registered. 100 | * 101 | * @param {Function} cb Callback to happen before route handler is invoked. 102 | */ 103 | Router.prototype.before = function(cb) { 104 | this.beforeCallbacks.push(cb); 105 | }; 106 | 107 | /** 108 | * Register a callback to happen after bogart handlers are invoked to 109 | * handle a request. Multiple 'after' callbacks may be registered. 110 | * 111 | * @param {Function} cb Callback to happen after route handler is invoked. 112 | */ 113 | Router.prototype.after = function(cb) { 114 | this.afterCallbacks.push(cb); 115 | }; 116 | 117 | /** 118 | * Register a route 119 | * @param {String} method Http Verb e.g. 'GET', 'POST', 'PUT', 'DELETE' 120 | * @param {String} path Path for the route 121 | * @param {Function} handler Function to execute when the route is accessed 122 | */ 123 | Router.prototype.route = function(method, path /*, handlers... */) { 124 | var paramNames, route, originalPath = path 125 | , args = slice.call(arguments); 126 | 127 | method = args.shift(); 128 | path = args.shift(); 129 | apps = args; 130 | 131 | if (path.constructor === String) { 132 | paramNames = path.match(PATH_PARAMETERS) || []; 133 | paramNames = paramNames.map(function(x) { return x.substring(1); }); 134 | 135 | path = new RegExp("^"+path.replace(/\./, '\\.').replace(/\*/g, '(.+)').replace(PATH_PARAMETERS, PATH_PARAMETER_REPLACEMENT)+'$'); 136 | } 137 | 138 | route = makeRoute({ path: path, paramNames: paramNames, apps: apps, originalPath: originalPath }); 139 | 140 | this.emit(exports.bogartEvent.BEFORE_ADD_ROUTE, this, route); 141 | 142 | this.routes[method] = this.routes[method] || []; 143 | this.routes[method].push(route); 144 | 145 | this.emit(exports.bogartEvent.AFTER_ADD_ROUTE, this, route); 146 | 147 | return this; 148 | }; 149 | 150 | Router.prototype.handler = function(verb, path) { 151 | verb = verb.toLowerCase(); 152 | var route; 153 | 154 | if (this.routes[verb]) { 155 | for (var i=0;iWith Partial
-------------------------------------------------------------------------------- /spec/fixtures/index.mustache: -------------------------------------------------------------------------------- 1 |Hello World from Mustache
-------------------------------------------------------------------------------- /spec/fixtures/partial-test.mustache: -------------------------------------------------------------------------------- 1 |Hello World from Mustache
{{>greeting}} -------------------------------------------------------------------------------- /spec/fixtures/test.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nrstott/bogart/a6e3b01b2e6f1247dde697038101fd6fa94e76b0/spec/fixtures/test.jpg -------------------------------------------------------------------------------- /spec/fixtures/text.txt: -------------------------------------------------------------------------------- 1 | Hello World -------------------------------------------------------------------------------- /spec/helpers/JsgiRequestHelper.coffee: -------------------------------------------------------------------------------- 1 | _ = require 'underscore' 2 | 3 | class MockJsgiRequest 4 | this.root = () -> 5 | new RootRequest() 6 | 7 | constructor: (@pathInfo, @method = 'get', @headers = {}) -> 8 | 9 | class RootRequest extends MockJsgiRequest 10 | constructor: (method, headers) -> 11 | super('/', method, headers) 12 | 13 | module.exports = MockJsgiRequest -------------------------------------------------------------------------------- /spec/middleware/facebookSpec.coffee: -------------------------------------------------------------------------------- 1 | facebook = require '../../lib/middleware/facebook' 2 | 3 | describe 'parse facebook profile', -> 4 | rawProfile = null 5 | parsedProfile = null 6 | 7 | shouldMap = (propertyName, rawValue, parsedValue) -> 8 | it "should have correct #{propertyName}", -> 9 | expect(parsedValue()).toBe(rawValue()) 10 | 11 | beforeEach -> 12 | rawProfile = 13 | id: 'abc123', 14 | username: 'myusername', 15 | name: 'myname', 16 | last_name: 'last_name', 17 | first_name: 'first_name', 18 | middle_name: 'middle_name', 19 | gender: 'M', 20 | link: 'http://me.facebook.com', 21 | email: 'hello@test.com' 22 | 23 | parsedProfile = facebook.parseFacebookProfile JSON.stringify(rawProfile) 24 | 25 | shouldMap 'id', (() -> rawProfile.id), (() -> parsedProfile.id) 26 | 27 | shouldMap 'username', (() -> rawProfile.username), (() -> parsedProfile.username) 28 | 29 | shouldMap 'name', (() -> rawProfile.name), (() -> parsedProfile.displayName) 30 | 31 | shouldMap 'last_name', (() -> rawProfile.last_name), (() -> parsedProfile.name.familyName) 32 | 33 | shouldMap 'first_name', (() -> rawProfile.first_name), (() -> parsedProfile.name.givenName) 34 | 35 | shouldMap 'middle_name', (() -> rawProfile.middle_name), (() -> parsedProfile.name.middleName) 36 | 37 | shouldMap 'gender', (() -> rawProfile.gender), (() -> parsedProfile.gender) 38 | 39 | shouldMap 'profileUrl', (() -> rawProfile.link), (() -> parsedProfile.profileUrl) 40 | 41 | shouldMap 'email', (() -> rawProfile.email), (() -> parsedProfile.emails[0]) 42 | 43 | -------------------------------------------------------------------------------- /spec/middleware/session/cookieDataProviderSpec.coffee: -------------------------------------------------------------------------------- 1 | JsgiRequest = require '../../helpers/JsgiRequestHelper' 2 | CookieDataProvider = require '../../../lib/middleware/session/cookieDataProvider' 3 | uuid = require 'node-uuid' 4 | q = require '../../../lib/q' 5 | 6 | describe 'Cookie Data Provider', -> 7 | 8 | describe 'load session', -> 9 | cookieDataProvider = null 10 | sessionId = null 11 | encryptionKey = null 12 | decryptedSessionData = null 13 | session = null 14 | 15 | beforeEach -> 16 | encryptionKey = uuid() 17 | sessionId = 1293 18 | 19 | req = new JsgiRequest('/', 'get', { cookie: 'bogart_session_data={}' }) 20 | 21 | encrypt = jasmine.createSpy 'encrypt' 22 | decrypt = jasmine.createSpy 'decrypt' 23 | 24 | encrypt.andReturn 'bogart_session_data' 25 | 26 | decryptedSessionData = '{}' 27 | decrypt.andReturn decryptedSessionData 28 | 29 | cookieDataProvider = new CookieDataProvider({ 30 | secret: encryptionKey, 31 | encrypt: encrypt, 32 | decrypt: decrypt 33 | }); 34 | 35 | session = cookieDataProvider.loadSession req, sessionId 36 | 37 | it 'should call encrypt', (done) -> 38 | q.when session, (session) -> 39 | expect(cookieDataProvider.encrypt).toHaveBeenCalled() 40 | done() 41 | 42 | it 'should call decrypt', (done) -> 43 | q.when session, (session) -> 44 | expect(cookieDataProvider.decrypt).toHaveBeenCalled() 45 | done() 46 | 47 | it 'should have correct session data', (done) -> 48 | q.when session, (session) -> 49 | expect(session).toEqual JSON.parse(decryptedSessionData) 50 | done() 51 | 52 | describe 'destroy session', -> 53 | res = null 54 | sessionId = null 55 | encrypt = null 56 | 57 | beforeEach -> 58 | sessionId = '--some-session-id--' 59 | 60 | encrypt = jasmine.createSpy 'encrypt' 61 | encrypt.andCallFake (sessionId, secret) -> 62 | sessionId 63 | 64 | cookieDataProvider = new CookieDataProvider 65 | secret: 'VERY_SECRET', 66 | encrypt: encrypt 67 | 68 | req = new JsgiRequest('/', 'get', { cookie: '' }) 69 | req.env = 70 | session: 71 | foo: 'bar' 72 | bar: 'baz' 73 | 74 | res = { headers: {} } 75 | res = cookieDataProvider.destroy(req, res, sessionId) 76 | 77 | it 'should call encrypt', (done) -> 78 | q(res) 79 | .then -> 80 | expect(encrypt).toHaveBeenCalled() 81 | .fail (err) => 82 | @fail err 83 | .fin done 84 | 85 | it 'should have empty session cookie', (done) -> 86 | q(res) 87 | .then (res) -> 88 | cookie = res.headers['Set-Cookie'][0] 89 | parts = cookie.split(';') 90 | val = parts[0].split('=')[1] 91 | expect(val).toEqual(encodeURIComponent(JSON.stringify({}))) 92 | .fail (err) => 93 | @fail err 94 | .fin done 95 | -------------------------------------------------------------------------------- /spec/middlewareSpec.coffee: -------------------------------------------------------------------------------- 1 | bogart = require '../lib/bogart' 2 | q = bogart.q 3 | mockRequest = require './helpers/JsgiRequestHelper' 4 | 5 | describe 'middleware helper', -> 6 | testMiddleware = null 7 | req = null 8 | next = null 9 | handler = null 10 | 11 | beforeEach -> 12 | handler = jasmine.createSpy() 13 | 14 | testMiddleware = bogart.middleware handler 15 | req = mockRequest.root() 16 | next = jasmine.createSpy() 17 | 18 | testMiddleware(next)(req) 19 | 20 | it 'should be a function', -> 21 | expect(typeof testMiddleware).toBe 'function' 22 | 23 | it 'should call handler with correct request', -> 24 | expect(handler).toHaveBeenCalledWith req, jasmine.any(Function) 25 | 26 | it 'should call handler with correct nextApp', -> 27 | expect(handler).toHaveBeenCalledWith jasmine.any(Object), next 28 | 29 | 30 | describe 'parse json', -> 31 | parseJsonMiddleware = null 32 | body = null 33 | jsgiRequest = null 34 | reqParam = null 35 | res = null 36 | 37 | beforeEach -> 38 | forEachDeferred = q.defer() 39 | headers = { 'content-type': 'application/json' } 40 | 41 | body = { 42 | forEach: (callback) -> 43 | callback(JSON.stringify { a: '1' }) 44 | forEachDeferred.promise 45 | } 46 | 47 | request = { headers: headers, body: body } 48 | 49 | parseJsonMiddleware = bogart.middleware.parseJson((req) -> 50 | reqParam = req 51 | ) 52 | 53 | res = parseJsonMiddleware(request) 54 | 55 | process.nextTick(() -> 56 | forEachDeferred.resolve() 57 | ) 58 | 59 | it 'should have passed request to nextApp', (done) -> 60 | q.when(res, () -> 61 | expect(reqParam).toBeDefined() 62 | done() 63 | , (err) => 64 | this.fail err 65 | done() 66 | ) 67 | 68 | it 'should have correct body', (done) -> 69 | q.when(res, () -> 70 | expect(reqParam.body.a).toBe '1' 71 | done() 72 | , (err) => 73 | this.fail err 74 | done() 75 | ) 76 | 77 | describe 'test parse form', -> 78 | forEachDeferred = null 79 | parseFormMiddleware = null 80 | echoApp = null 81 | res = null 82 | reqParamInNextApp = null 83 | 84 | beforeEach -> 85 | echoApp = () -> 86 | (req) -> 87 | reqParamInNextApp = req 88 | { body: [], headers: {}, status: 200 } 89 | 90 | forEachDeferred = q.defer() 91 | 92 | parseFormMiddleware = bogart.middleware.parseForm echoApp() 93 | 94 | jsgiRequest = { 95 | headers: { 'content-type': 'application/x-www-form-urlencoded' }, 96 | body: { 97 | forEach: (callback) -> 98 | callback('a=1') 99 | } 100 | } 101 | 102 | res = parseFormMiddleware jsgiRequest 103 | 104 | process.nextTick(() -> 105 | forEachDeferred.resolve() 106 | ) 107 | 108 | it 'should pass correct req to nextApp', (done) -> 109 | q.when(res, () -> 110 | expect(reqParamInNextApp.body.a).toBe '1' 111 | done() 112 | , (err) => 113 | this.fail(err) 114 | done() 115 | ) 116 | 117 | describe 'method override', -> 118 | methodOverrideMiddleware = null 119 | jsgiRequest = null 120 | res = null 121 | 122 | beforeEach -> 123 | methodOverrideMiddleware = bogart.middleware.methodOverride((req) -> 124 | {} 125 | ) 126 | 127 | headers = { 'content-type': 'text/html' } 128 | jsgiRequest = { method: 'post', env: {}, body: { _method: 'put' }, headers: headers } 129 | 130 | res = methodOverrideMiddleware jsgiRequest 131 | 132 | it 'should change request method to `PUT`', (done) -> 133 | q.when(res, () -> 134 | expect(jsgiRequest.method).toBe 'PUT' 135 | done() 136 | , (err) => 137 | this.fail(err) 138 | done() 139 | ) 140 | 141 | describe 'gzip', -> 142 | jsgiRequest = null 143 | res = null 144 | 145 | beforeEach -> 146 | headers = { 'content-type': 'text/html', 'accept-encoding': 'gzip' } 147 | jsgiRequest = { method: 'post', env: {}, headers: headers, body: [] } 148 | 149 | gzipMiddleware = bogart.middleware.gzip (req) -> 150 | bogart.html 'Hello World' 151 | 152 | res = gzipMiddleware jsgiRequest 153 | 154 | it 'should have response body', (done) -> 155 | q.when(res, (res) -> 156 | expect(typeof res.body).toBe 'object' 157 | done() 158 | , (err) => 159 | this.fail(err) 160 | done() 161 | ) 162 | 163 | it 'should have correct content-type', (done) -> 164 | q.when(res, (res) -> 165 | expect(res.headers['content-type']).toBe 'text/html' 166 | done() 167 | , (err) => 168 | this.fail(err); 169 | done(); 170 | ) 171 | 172 | it 'should have correct status', (done) -> 173 | q.when(res, (res) -> 174 | expect(res.status).toBe 200 175 | done() 176 | , (err) => 177 | this.fail(err) 178 | done() 179 | ) 180 | 181 | describe 'error middleware given exception', -> 182 | res = null 183 | errorMessage = '__Intentional Error Test__' 184 | 185 | beforeEach -> 186 | errorMiddleware = bogart.middleware.error { logError: false }, (req) -> 187 | throw new Error(errorMessage) 188 | 189 | res = errorMiddleware { method: 'get', env: {}, headers: {}, body: [] } 190 | 191 | it 'should have correct status', (done) -> 192 | q.when res, (res) -> 193 | expect(res.status).toBe 500 194 | done() 195 | 196 | it 'should have correct content-type', (done) -> 197 | q.when res, (res) -> 198 | expect(res.headers['content-type']).toBe 'text/html' 199 | done() 200 | 201 | it 'should contain error message', (done) -> 202 | q.when res, (res) -> 203 | expect(res.body.join('')).toContain(errorMessage) 204 | done() 205 | 206 | describe 'error middleware rejected promise given string', -> 207 | rejectionMessage = '__INTENTIONAL REJECTION__' 208 | res = null 209 | 210 | beforeEach -> 211 | errorMiddleware = bogart.middleware.error { logError: false }, (req) -> 212 | q.reject rejectionMessage 213 | 214 | res = errorMiddleware { body: [], headers: {}, env: {} } 215 | 216 | it 'should have correct status', (done) -> 217 | q.when res, (res) -> 218 | expect(res.status).toBe 500 219 | done() 220 | 221 | it 'should have correct content-type', (done) -> 222 | q.when res, (res) -> 223 | expect(res.headers['content-type']).toBe 'text/html' 224 | done() 225 | 226 | it 'should contain rejection message', (done) -> 227 | q.when res, (res) -> 228 | expect(res.body.join '').toContain rejectionMessage 229 | done() 230 | 231 | describe 'error middleware rejected promise given Error', -> 232 | errorMessage = '__INTENTIONAL ERROR__' 233 | rejectionError = new Error errorMessage 234 | res = null 235 | 236 | beforeEach -> 237 | errorMiddleware = bogart.middleware.error { logError: false }, (req) -> 238 | q.reject rejectionError 239 | 240 | res = errorMiddleware { body: [], headers: {}, env: {} } 241 | 242 | it 'should have correct status', (done) -> 243 | q.when res, (res) -> 244 | expect(res.status).toBe 500 245 | done() 246 | 247 | it 'should have correct content-type', (done) -> 248 | q.when res, (res) -> 249 | expect(res.headers['content-type']).toBe 'text/html' 250 | done() 251 | 252 | it 'should contain error message', (done) -> 253 | q.when res, (res) -> 254 | expect(res.body.join '').toContain errorMessage 255 | done() 256 | 257 | describe 'flash middleware', -> 258 | res = null 259 | foo = null 260 | jsgiRequest = null 261 | flashMiddleware = null 262 | 263 | beforeEach -> 264 | flashMiddleware = bogart.middleware.flash {}, (req) -> 265 | req.flash 'foo', 'bar' 266 | 267 | foo = req.flash 'foo' 268 | 269 | { status: 200, body: [], headers: { 'content-type': 'text/html' } } 270 | 271 | jsgiRequest = { headers: { 'content-type': 'text/plain' }, body: [] } 272 | 273 | res = flashMiddleware(jsgiRequest).then (res) -> 274 | cookieStr = res.headers['Set-Cookie'].join('').replace(/;$/, ''); 275 | jsgiRequest.headers.cookie = cookieStr 276 | res 277 | 278 | describe 'first request', -> 279 | 280 | it 'should have `foo` value of undefined', (done) -> 281 | q.when res, (res) -> 282 | expect(foo).toEqual undefined 283 | done() 284 | 285 | describe 'second request', -> 286 | 287 | beforeEach -> 288 | res = q.when res, () -> 289 | flashMiddleware jsgiRequest 290 | 291 | it 'should have correct `foo` value', (done) -> 292 | q.when res, (res) -> 293 | expect(foo).toEqual 'bar' 294 | done() 295 | 296 | describe 'parted', -> 297 | partedMiddleware = null 298 | res = null 299 | 300 | beforeEach -> 301 | partedMiddleware = bogart.middleware.parted (req) -> 302 | req 303 | 304 | describe 'json', -> 305 | 306 | beforeEach -> 307 | res = partedMiddleware { 308 | headers: { 'content-type': 'application/json' }, 309 | body: [ '{ "hello": "world" }' ], 310 | env: {}, 311 | method: 'POST' 312 | } 313 | 314 | it 'should have correct body', (done) -> 315 | q.when res, (req) -> 316 | expect(req.body.hello).toBe 'world' 317 | done() 318 | 319 | describe 'form url-encoded', -> 320 | 321 | beforeEach -> 322 | body = { 323 | forEach: (callback) -> 324 | callback('hello=world') 325 | } 326 | 327 | res = partedMiddleware { 328 | method: 'POST', 329 | env: {}, 330 | headers: { 'content-type': 'application/x-www-form-urlencoded' }, 331 | body: body 332 | } 333 | 334 | it 'should have correct body', (done) -> 335 | q.when res, (res) -> 336 | expect(res.body.hello).toBe 'world' 337 | done() 338 | 339 | describe 'multipart form-encoded', -> 340 | 341 | beforeEach -> 342 | res = partedMiddleware multipartRequest(100, 'chrome') 343 | 344 | it 'should have content', (done) -> 345 | q.when res, (res) -> 346 | expect(res.body.content).not.toBe undefined 347 | done() 348 | 349 | describe 'session', -> 350 | sessionApp = null 351 | firstRequest = true 352 | res = null 353 | values = [] 354 | 355 | beforeEach -> 356 | sessionApp = bogart.middleware.session { secret: 'my-super-secret' }, (req) -> 357 | req.session('foo', 'bar') if firstRequest 358 | firstRequest = false 359 | 360 | values.push req.session('foo') 361 | 362 | return { 363 | status: 200, 364 | body: [] 365 | } 366 | 367 | headers = { 'content-type': 'text/plain' } 368 | jsgiRequest = { headers: headers, body: [] } 369 | 370 | res = q.when sessionApp(jsgiRequest), (res) -> 371 | cookieStr = res.headers['Set-Cookie'].join('').replace(/;$/, ''); 372 | 373 | jsgiRequest.headers.cookie = cookieStr 374 | 375 | q.when sessionApp(jsgiRequest) 376 | 377 | it 'should have correct value for first request', (done) -> 378 | q.when res, (res) -> 379 | expect(values[0]).toBe 'bar' 380 | done() 381 | , (err) => 382 | this.fail err 383 | 384 | it 'should have correct value for second request', (done) -> 385 | q.when res, (res) -> 386 | expect(values[1]).toBe 'bar' 387 | done() 388 | , (err) => 389 | this.fail err 390 | 391 | describe 'validate response middleware', -> 392 | validateResApp = null 393 | 394 | describe 'null response', -> 395 | 396 | beforeEach -> 397 | validateResApp = bogart.middleware.validateResponse (req) -> 398 | null 399 | 400 | it 'should have correct error', (done) -> 401 | validateResApp().fail (err) -> 402 | expect(err).toBe 'Response must be an object.' 403 | done() 404 | , (err) => 405 | this.fail error 406 | done() 407 | 408 | describe 'response without a body', -> 409 | 410 | beforeEach -> 411 | validateResApp = bogart.middleware.validateResponse (req) -> 412 | { status: 200, headers: {} } 413 | 414 | it 'should have correct error', (done) -> 415 | validateResApp().fail (err) -> 416 | expect(err).toBe 'Response must have a body property.' 417 | done() 418 | 419 | describe 'response that has a body that is not a forEachable', -> 420 | 421 | beforeEach -> 422 | validateResApp = bogart.middleware.validateResponse (req) -> 423 | { status: 200, body: {}, headers: {} } 424 | 425 | it 'should have correct error', (done) -> 426 | validateResApp().fail (err) -> 427 | expect(err).toBe 'Response body must have a forEach method.' 428 | done() 429 | 430 | describe 'given response with body that has a forEach property that is not a function', -> 431 | 432 | beforeEach -> 433 | validateResApp = bogart.middleware.validateResponse (req) -> 434 | { status: 200, body: { forEach: {} }, headers: {} } 435 | 436 | it 'should have correct error', (done) -> 437 | validateResApp().fail (err) -> 438 | expect(err).toBe 'Response body has a forEach method but the forEach method is not a function.' 439 | done() 440 | 441 | describe 'given a response without status', -> 442 | 443 | beforeEach -> 444 | validateResApp = bogart.middleware.validateResponse (req) -> 445 | { body: [], headers: {} } 446 | 447 | it 'should have correct error', (done) -> 448 | validateResApp().fail (err) -> 449 | expect(err).toBe 'Response must have a status property.' 450 | done() 451 | 452 | describe 'given a response with a non-number status', -> 453 | 454 | beforeEach -> 455 | validateResApp = bogart.middleware.validateResponse (req) -> 456 | { body: [], headers: {}, status: '200' } 457 | 458 | it 'should have correct error', (done) -> 459 | validateResApp().fail (err) -> 460 | expect(err).toBe 'Response has a status property but the status property must be a number.' 461 | done() 462 | 463 | describe 'string return adapter', -> 464 | str = null 465 | res = null 466 | 467 | beforeEach -> 468 | str = 'This is a message' 469 | req = mockRequest.root() 470 | 471 | stringReturnAdapterApp = bogart.middleware.stringReturnAdapter -> 472 | str 473 | 474 | res = stringReturnAdapterApp req 475 | 476 | it 'should have correct body', (done) -> 477 | q.when res, (res) -> 478 | expect(res.body).toEqual([ str ]) 479 | done() 480 | 481 | describe 'batteries', -> 482 | 483 | describe 'given directory configuration', -> 484 | 485 | beforeEach -> 486 | spyOn bogart.middleware, 'directory' 487 | bogart.middleware.batteries({ directory: 'public', secret: 'my-super-secret' })((req) -> {}) 488 | 489 | it 'should pass correct configuration to directory middleware', -> 490 | expect(bogart.middleware.directory).toHaveBeenCalledWith 'public', jasmine.any(Function) 491 | 492 | describe 'given empty configuration', -> 493 | 494 | beforeEach -> 495 | spyOn bogart.middleware, 'directory' 496 | bogart.middleware.batteries({})((req) -> {}) 497 | 498 | it 'should pass default configuration for `directory`', -> 499 | expect(bogart.middleware.directory).toHaveBeenCalledWith 'public', jasmine.any(Function) 500 | 501 | ### 502 | Create a mock request 503 | Modified from the mock request method in Parted in compliance with the license. 504 | ### 505 | multipartRequest = (size, file) -> 506 | fs = require 'fs' 507 | path = require 'path' 508 | 509 | file = path.join __dirname, 'fixtures', file+'.part' 510 | 511 | stream = fs.createReadStream file, { 512 | bufferSize: size 513 | } 514 | 515 | boundary = fs 516 | .readFileSync(file) 517 | .toString('utf8') 518 | .match(/--[^\r\n]+/)[0] 519 | .slice(2) 520 | 521 | res = 522 | headers: { 'content-type': 'multipart/form-data; boundary="' + boundary + '"' } 523 | method: 'POST' 524 | env: {} 525 | pipe: (dest) -> 526 | stream.pipe dest 527 | emit: (ev, err) -> 528 | this.errback && this.errback(err) if ev == 'error' 529 | this 530 | on: (ev, func) -> 531 | this.errback = func if ev == 'error' 532 | this 533 | destroy: () -> 534 | stream.destroy() 535 | this 536 | body: 537 | forEach: (fn) -> 538 | deferred = q.defer() 539 | 540 | stream.on 'data', (data) -> 541 | fn data 542 | 543 | stream.on 'end', -> 544 | deferred.resolve() 545 | 546 | deferred.promise 547 | -------------------------------------------------------------------------------- /spec/requestSpec.coffee: -------------------------------------------------------------------------------- 1 | request = require '../lib/request' 2 | 3 | describe 'construction request given empty object parameter', -> 4 | req = null 5 | keys = null 6 | 7 | beforeEach -> 8 | req = request({}) 9 | keys = Object.keys req 10 | 11 | it 'should have `params`', -> 12 | expect(keys).toContain 'params' 13 | 14 | it 'should have `search`', -> 15 | expect(keys).toContain 'search' 16 | 17 | it 'should have `isXMLHttpRequest`', -> 18 | expect(keys).toContain 'isXMLHttpRequest' 19 | 20 | describe 'query string parameters', -> 21 | jsgiRequest = null 22 | req = null 23 | 24 | beforeEach -> 25 | jsgiRequest = { queryString: 'a=1&b=abc' } 26 | 27 | req = request jsgiRequest 28 | 29 | it 'should have correct `queryString`', -> 30 | expect(req.queryString).toBe jsgiRequest.queryString 31 | 32 | it 'should have correct `search`', -> 33 | expect(req.search).toEqual { a: '1', b: 'abc' } 34 | 35 | describe 'route parameters', -> 36 | req = null 37 | 38 | beforeEach -> 39 | req = request {} 40 | 41 | req.routeParams.name = 'Bob' 42 | 43 | it 'should have correct name parameter', -> 44 | expect(req.params.name).toBe 'Bob' 45 | 46 | it 'should have correct name search parameter', -> 47 | expect(req.search.name).not.toBe 'Bob' 48 | 49 | 50 | describe 'XHR request', -> 51 | req = null 52 | 53 | beforeEach -> 54 | req = request { headers: { 'x-requested-with': '' } } 55 | 56 | it 'should have correct `isXMLHttpRequest`', -> 57 | expect(req.isXMLHttpRequest).toBe true 58 | 59 | describe 'non-XHR request', -> 60 | req = null 61 | 62 | beforeEach -> 63 | req = request { headers: {} } 64 | 65 | it 'should have correct `isXMLHttpRequest`', -> 66 | expect(req.isXMLHttpRequest).toBe false 67 | -------------------------------------------------------------------------------- /spec/responseBuilderSpec.coffee: -------------------------------------------------------------------------------- 1 | bogart = require '../lib/bogart' 2 | q = bogart.q 3 | fs = require 'fs' 4 | path = require 'path' 5 | 6 | describe 'resolving ResponseBuilder', -> 7 | responseBuilder = null 8 | resolveVal = { 'hello': 'world' } 9 | 10 | beforeEach -> 11 | responseBuilder = new bogart.ResponseBuilder() 12 | 13 | setTimeout -> 14 | responseBuilder.resolve resolveVal 15 | 16 | it 'should resolve', (done) -> 17 | q.when responseBuilder, (res) -> 18 | expect(res).toBe resolveVal 19 | done() 20 | 21 | describe 'rejecting ResponseBuilder', -> 22 | responseBuilder = null 23 | rejectVal = null 24 | 25 | beforeEach -> 26 | rejectVal = new Error('something bad happened') 27 | 28 | responseBuilder = new bogart.ResponseBuilder() 29 | 30 | setTimeout -> 31 | responseBuilder.reject(rejectVal) 32 | 33 | it 'should reject', (done) -> 34 | q.when(responseBuilder).fail (err) -> 35 | expect(err).toBe rejectVal 36 | done() 37 | 38 | describe 'sending a string', -> 39 | responseBuilder = null 40 | msg = 'Hello World' 41 | 42 | beforeEach -> 43 | responseBuilder = bogart.ResponseBuilder() 44 | 45 | responseBuilder.send msg 46 | 47 | responseBuilder.end() 48 | 49 | it 'should have correct body', (done) -> 50 | q.when responseBuilder, (res) -> 51 | written = '' 52 | 53 | q.when res.body.forEach((data) -> 54 | written += data 55 | ), -> 56 | expect(written).toBe msg 57 | done() 58 | 59 | describe 'sending a buffer', -> 60 | responseBuilder = null 61 | msg = null 62 | buffer = null 63 | 64 | beforeEach -> 65 | msg = 'Hello World' 66 | buffer = new Buffer msg.length 67 | buffer.write msg 68 | 69 | responseBuilder = new bogart.ResponseBuilder() 70 | responseBuilder.send buffer 71 | responseBuilder.end() 72 | 73 | it 'should have correct body', (done) -> 74 | q.when responseBuilder, (res) -> 75 | written = '' 76 | 77 | forEachFinished = res.body.forEach (data) -> 78 | written += data 79 | 80 | q.when forEachFinished, -> 81 | expect(written).toBe msg 82 | done() 83 | 84 | describe 'sending binary', -> 85 | responseBuilder = null 86 | filePath = path.join __dirname, 'fixtures', 'test.jpg' 87 | stat = fs.statSync filePath 88 | fileContent = null 89 | 90 | beforeEach -> 91 | responseBuilder = new bogart.ResponseBuilder() 92 | 93 | fs.readFile filePath, 'binary', (err, content) => 94 | this.fail err if err 95 | 96 | fileContent = content 97 | responseBuilder.send content 98 | responseBuilder.end() 99 | 100 | it 'should have correct body', (done) -> 101 | q.when responseBuilder, (res) -> 102 | written = new Buffer stat.size 103 | 104 | forEachFinished = res.body.forEach (data) -> 105 | written.write data, 'binary' 106 | 107 | q.when forEachFinished, -> 108 | expect(written.toString 'binary').toBe fileContent 109 | done() 110 | 111 | -------------------------------------------------------------------------------- /spec/responseHelperSpec.coffee: -------------------------------------------------------------------------------- 1 | bogart = require '../lib/bogart' 2 | q = bogart.q 3 | path = require 'path' 4 | fs = require 'fs' 5 | 6 | describe 'json', -> 7 | it 'should have default status of 200', -> 8 | expect(bogart.json({}).status).toBe 200 9 | 10 | it 'given status should override status', -> 11 | expect(bogart.json({}, { status: 403 }).status).toBe 403 12 | 13 | describe 'given object', -> 14 | res = null 15 | obj = null 16 | etag = "298fjsdkf" 17 | 18 | beforeEach -> 19 | obj = { hello: 'world' } 20 | opts = { headers: {ETag:etag} } 21 | 22 | res = bogart.json obj, opts 23 | 24 | it 'should have correct body', -> 25 | expect(res.body.join()).toBe JSON.stringify(obj) 26 | 27 | it 'should add any additional headers', -> 28 | expect(res.headers["ETag"]).toBe etag 29 | 30 | 31 | describe 'cors', -> 32 | it 'should have default status of 200', -> 33 | expect(bogart.cors({}).status).toBe 200 34 | 35 | it 'given status should override status', -> 36 | expect(bogart.cors({}, { status: 403 }).status).toBe 403 37 | 38 | describe 'given object', -> 39 | res = null 40 | body = null 41 | 42 | beforeEach -> 43 | body = { hello: 'world' } 44 | 45 | res = bogart.cors body 46 | 47 | it 'should have correct body', -> 48 | expect(res.body.join()).toBe JSON.stringify(body) 49 | it 'should have correct headers', -> 50 | expect(res.headers['Access-Control-Allow-Origin']).toBe '*' 51 | expect(res.headers['Access-Control-Allow-Methods']).toBe 'GET,PUT,POST,DELETE' 52 | expect(res.headers['Access-Control-Allow-Headers']).toBe 'x-requested-with,*' 53 | it 'given headers should override the default headers', -> 54 | headers = {'Access-Control-Allow-Origin': 'http://whiteboard-it.com', 'Content-Type': 'text/plain'} 55 | expect(bogart.cors({a:'b'},{headers: headers}).headers['Access-Control-Allow-Origin']).toBe 'http://whiteboard-it.com' 56 | expect(bogart.cors({a:'b'},{headers: headers}).headers['Content-Type']).toBe 'text/plain' 57 | 58 | describe 'error', -> 59 | it 'should have default status of 500', -> 60 | expect(bogart.error().status).toBe 500 61 | 62 | it 'should override status', -> 63 | expect(bogart.error('', { status: 403 }).status).toBe 403 64 | 65 | 66 | describe 'html', -> 67 | it 'should have default status of 200', -> 68 | expect(bogart.html('hello').status).toBe 200 69 | 70 | it 'should override status', -> 71 | expect(bogart.html('hello', { status: 404 }).status).toBe 404 72 | 73 | describe 'given html string', -> 74 | res = null 75 | str = null 76 | 77 | beforeEach -> 78 | str = 'Hello
' 79 | res = bogart.html str 80 | 81 | it 'should have correct content-type', -> 82 | expect(res.headers['content-type']).toBe 'text/html' 83 | 84 | it 'should have correct content-length', -> 85 | expect(res.headers['content-length']).toBe Buffer.byteLength(str, 'utf-8') 86 | 87 | it 'should have correct body', -> 88 | expect(res.body.join()).toBe str 89 | 90 | 91 | describe 'pipe', -> 92 | res = null 93 | 94 | beforeEach -> 95 | readStream = fs.createReadStream path.join(__dirname, 'fixtures', 'text.txt') 96 | res = bogart.pipe readStream 97 | 98 | it 'should have correct body', (done) -> 99 | q.when(res, (res) -> 100 | written = '' 101 | 102 | forEachFinished = res.body.forEach (data) -> 103 | written += data 104 | 105 | q.when forEachFinished, -> 106 | expect(written).toBe 'Hello World' 107 | done() 108 | ).fail (err) => 109 | this.fail err 110 | done() 111 | 112 | describe 'pipe given forEachable', -> 113 | forEachable = null 114 | deferred = null 115 | msg = null 116 | res = null 117 | 118 | beforeEach -> 119 | msg = 'Hello World' 120 | 121 | deferred = q.defer() 122 | 123 | forEachable = { 124 | forEach: (callback) -> 125 | callback msg 126 | deferred.promise 127 | } 128 | 129 | setTimeout -> 130 | deferred.resolve() 131 | 132 | res = bogart.pipe forEachable 133 | 134 | it 'should have correct body', (done) -> 135 | q.when(res, (res) -> 136 | written = '' 137 | 138 | forEachFinished = res.body.forEach (data) -> 139 | written += data 140 | 141 | q.when forEachFinished, -> 142 | expect(written).toBe msg 143 | done() 144 | 145 | ).fail (err) => 146 | this.fail err 147 | done() 148 | 149 | describe 'redirect given options', -> 150 | res = null 151 | opts = null 152 | 153 | beforeEach -> 154 | opts = { hello: 'world' } 155 | res = bogart.redirect '/', opts 156 | 157 | it 'should have correctly merged `hello` value', -> 158 | expect(res.hello).toBe opts.hello 159 | 160 | describe 'redirect given headers', -> 161 | res = null 162 | headers = null 163 | 164 | beforeEach -> 165 | headers = { hello: 'world' } 166 | 167 | res = bogart.redirect '/', { headers: headers } 168 | 169 | it 'should have correct location header', -> 170 | expect(res.headers.location).toBe '/' 171 | 172 | it 'should have correct `hello` header', -> 173 | expect(res.headers.hello).toBe headers.hello 174 | 175 | -------------------------------------------------------------------------------- /spec/routerSpec.coffee: -------------------------------------------------------------------------------- 1 | bogart = require '../lib/bogart' 2 | MockRequest = require './helpers/JsgiRequestHelper' 3 | Router = (require '../lib/router').Router 4 | q = require 'q' 5 | 6 | describe 'matches parameter', -> 7 | req = null 8 | router = null 9 | res = null 10 | name = null 11 | 12 | beforeEach -> 13 | req = MockRequest.root() 14 | 15 | router = bogart.router() 16 | 17 | router.get '/hello/:name', (req) -> 18 | name = req.params.name 19 | bogart.html 'hello' 20 | 21 | req.pathInfo = '/hello/nathan' 22 | 23 | res = router() req 24 | 25 | it 'should have correct status', (done) -> 26 | q.when res, (res) -> 27 | expect(res.status).toBe 200 28 | done() 29 | 30 | it 'should have correct name', (done) -> 31 | q.when res, (res) -> 32 | expect(name).toBe 'nathan' 33 | done() 34 | 35 | describe 'order of routes matching should be in order defined', -> 36 | router = null 37 | res = null 38 | firstCalled = false 39 | secondCalled = false 40 | 41 | beforeEach -> 42 | router = bogart.router() 43 | 44 | router.get '/hello/:name', (req) -> 45 | firstCalled = true 46 | bogart.html 'hello' 47 | 48 | router.get '/hello/:name/:something', (req) -> 49 | secondCalled = true 50 | bogart.html 'hello' 51 | 52 | res = router() new MockRequest('/hello/nathan') 53 | 54 | it 'should have called first route', (done) -> 55 | q.when res, (res) -> 56 | expect(firstCalled).toBe true 57 | done() 58 | 59 | it 'should not have called second route', (done) -> 60 | q.when res, -> 61 | expect(secondCalled).toBe false 62 | done() 63 | 64 | describe 'should call notFoundApp', -> 65 | notFoundApp = null 66 | router = null 67 | res = null 68 | called = false 69 | notFoundRes = null 70 | 71 | beforeEach -> 72 | notFoundRes = { status: 404, body: [ '' ], headers: {} } 73 | 74 | notFoundApp = (req) -> 75 | called = true 76 | notFoundRes 77 | 78 | router = bogart.router() 79 | 80 | res = router(notFoundApp) MockRequest.root() 81 | 82 | it 'should have correct response', (done) -> 83 | q.when res, (res) -> 84 | expect(res).toBe notFoundRes 85 | done() 86 | 87 | it 'should have called the not found app', (done) -> 88 | q.when res, (res) -> 89 | expect(called).toBe true 90 | done() 91 | 92 | 93 | describe 'default notFoundApp behavior of returning 404', -> 94 | res = null 95 | 96 | beforeEach -> 97 | router = bogart.router() 98 | 99 | res = router() MockRequest.root() 100 | 101 | it 'should have status of 404', (done) -> 102 | q.when res, (res) -> 103 | expect(res.status).toBe 404 104 | done() 105 | 106 | describe 'router.notFound', -> 107 | notFoundHandler = null 108 | req = null 109 | res = null 110 | 111 | beforeEach -> 112 | notFoundHandler = jasmine.createSpy 'not found handler' 113 | 114 | router = bogart.router() 115 | router.notFound(notFoundHandler) 116 | 117 | req = MockRequest.root() 118 | res = router() req 119 | 120 | it 'should have called handler specified by notFound', -> 121 | q.when res, -> 122 | expect(notFoundHandler).toHaveBeenCalled() 123 | 124 | describe 'partially matched route', -> 125 | res = null 126 | 127 | beforeEach -> 128 | router = bogart.router() 129 | 130 | router.get '/partial-match', (req) -> 131 | { status: 200, body: [ 'hello' ], headers: {} } 132 | 133 | res = router() new MockRequest('/partial-match/path') 134 | 135 | it 'should have status of 404', (done) -> 136 | q.when res, (res) -> 137 | expect(res.status).toBe 404 138 | done() 139 | 140 | describe 'partially matched route with parameter', -> 141 | res = null 142 | 143 | beforeEach -> 144 | router = bogart.router() 145 | router.get '/:foo', (req) -> 146 | return { status: 200, body: [ 'hello' ], headers: {} } 147 | 148 | res = router() new MockRequest('/hello/world') 149 | 150 | it 'should have status of 404', (done) -> 151 | q.when res, (res) -> 152 | expect(res.status).toBe 404 153 | done() 154 | 155 | describe 'route with querystring', -> 156 | res = null 157 | 158 | beforeEach -> 159 | router = bogart.router() 160 | 161 | router.get '/home', (req) -> 162 | { status: 200, body: [ 'home' ], headers: {} } 163 | 164 | req = new MockRequest('/home') 165 | req.queryString = 'hello=world' 166 | 167 | res = router() req 168 | 169 | it 'should have correct status', (done) -> 170 | q.when res, (res) -> 171 | expect(res.status).toBe 200 172 | done() 173 | 174 | describe 'regex route', -> 175 | res = null 176 | splat = null 177 | routeRes = null 178 | 179 | beforeEach -> 180 | router = bogart.router() 181 | 182 | routeRes = bogart.html 'hello' 183 | 184 | router.get /\/hello\/(.*)\/(.*)/, (req) -> 185 | splat = req.params.splat 186 | routeRes 187 | 188 | res = router() new MockRequest('/hello/cruel/world') 189 | 190 | it 'should have correct splat', (done) -> 191 | q.when res, (res) -> 192 | expect(splat).toEqual [ 'cruel', 'world' ] 193 | done() 194 | 195 | it 'should have correct response', (done) -> 196 | q.when res, (res) -> 197 | expect(res).toBe routeRes 198 | done() 199 | 200 | describe 'request path with encoded slashes', -> 201 | res = null 202 | routeRes = null 203 | 204 | beforeEach -> 205 | routeRes = bogart.html 'hello' 206 | 207 | router = bogart.router() 208 | 209 | router.get '/:foo', (req) -> 210 | routeRes 211 | 212 | res = router() new MockRequest('/foo%2fbar') 213 | 214 | it 'should have correct response', (done) -> 215 | q.when res, (res) -> 216 | expect(res).toBe routeRes 217 | done() 218 | 219 | describe 'request with a dot (".") as part of the named parameter', -> 220 | res = null 221 | params = null 222 | routeRes = null 223 | res = null 224 | 225 | beforeEach -> 226 | routeRes = bogart.html 'hello' 227 | 228 | router = bogart.router() 229 | router.get '/:foo/:bar', (req) -> 230 | params = req.params 231 | routeRes 232 | 233 | res = router() new MockRequest('/user@example.com/name') 234 | 235 | 236 | it 'should have correct :foo param', (done) -> 237 | q.when res, -> 238 | expect(params.foo).toBe 'user@example.com' 239 | done() 240 | 241 | it 'should have correct :bar param', (done) -> 242 | q.when res, -> 243 | expect(params.bar).toBe 'name' 244 | done() 245 | 246 | it 'should have correct response', (done) -> 247 | q.when res, (res) -> 248 | expect(res).toBe routeRes 249 | done() 250 | 251 | describe 'matches empty `pathInfo` to "/" if no route is defined for ""', -> 252 | res = null 253 | routeRes = null 254 | 255 | beforeEach -> 256 | routeRes = bogart.text 'success' 257 | 258 | router = bogart.router() 259 | router.get '/', -> 260 | routeRes 261 | 262 | res = router() new MockRequest('') 263 | 264 | it 'should have correct response', (done) -> 265 | q.when res, (res) -> 266 | expect(res).toBe routeRes 267 | done() 268 | 269 | describe 'matches empty `pathInfo` to "" if a route is defined for ""', -> 270 | res = null 271 | rightRouteRes = null 272 | wrongRouteRes = null 273 | 274 | beforeEach -> 275 | rightRouteRes = bogart.text 'right' 276 | wrongRouteRes = bogart.text 'wrong' 277 | 278 | router = bogart.router() 279 | 280 | router.get '', (req) -> 281 | rightRouteRes 282 | 283 | router.get '/', (req) -> 284 | wrongRouteRes 285 | 286 | res = router() new MockRequest('') 287 | 288 | it 'should have correct response', (done) -> 289 | q.when res, (res) -> 290 | expect(res).toBe rightRouteRes 291 | done() 292 | 293 | describe 'paths that include spaces', -> 294 | res = null 295 | routeRes = null 296 | 297 | beforeEach -> 298 | routeRes = bogart.text 'spaces are cool' 299 | router = bogart.router() 300 | 301 | router.get '/path with spaces', (req) -> 302 | routeRes 303 | 304 | res = router() new MockRequest('/path%20with%20spaces') 305 | 306 | it 'should have correct response', (done) -> 307 | q.when res, (res) -> 308 | expect(res).toBe routeRes 309 | done() 310 | 311 | describe 'literal (".") in path', -> 312 | res = null 313 | routeRes = null 314 | 315 | beforeEach -> 316 | routeRes = bogart.text 'hello' 317 | 318 | router = bogart.router() 319 | 320 | router.get '/foo.bar', -> 321 | routeRes 322 | 323 | res = router() new MockRequest('/foo.bar') 324 | 325 | it 'should have correct response', (done) -> 326 | q.when res, (res) -> 327 | expect(res).toBe routeRes 328 | done() 329 | 330 | describe '("-") in path', -> 331 | res = null 332 | routeRes = null 333 | 334 | beforeEach -> 335 | routeRes = bogart.text 'hello' 336 | 337 | router = bogart.router() 338 | 339 | router.get '/foo/:bar/dash-url', -> 340 | routeRes 341 | 342 | res = router() new MockRequest('/foo/baz/dash-url') 343 | 344 | it 'should have correct response', (done) -> 345 | q.when res, (res) -> 346 | expect(res).toBe routeRes 347 | done() 348 | 349 | describe 'path with splat ("*")', -> 350 | routeRes = null 351 | res = null 352 | params = null 353 | 354 | beforeEach -> 355 | routeRes = bogart.text 'splat' 356 | 357 | router = bogart.router() 358 | 359 | router.get '/foo/*', (req) -> 360 | params = req.params 361 | routeRes 362 | 363 | res = router() new MockRequest('/foo/hello/there') 364 | 365 | it 'should have correct splat', (done) -> 366 | q.when res, (res) -> 367 | expect(params.splat[0]).toBe 'hello/there' 368 | done() 369 | 370 | it 'should have correct response', (done) -> 371 | q.when res, (res) -> 372 | expect(res).toBe routeRes 373 | done() 374 | 375 | describe 'path with multiple splat parameters', -> 376 | routeRes = null 377 | res = null 378 | params = null 379 | 380 | beforeEach -> 381 | routeRes = bogart.text 'splat' 382 | 383 | router = bogart.router() 384 | 385 | router.get '/download/*/*', (req) -> 386 | params = req.params 387 | routeRes 388 | 389 | res = router() new MockRequest('/download/images/ninja-cat.jpg') 390 | 391 | it 'should have correct splat', (done) -> 392 | q.when res, (res) -> 393 | expect(params.splat).toEqual [ 'images', 'ninja-cat.jpg' ] 394 | done() 395 | 396 | it 'should have correct response', (done) -> 397 | q.when res, (res) -> 398 | expect(res).toBe routeRes 399 | done() 400 | 401 | describe 'mixing splat and named parameters', -> 402 | routeRes = null 403 | res = null 404 | params = null 405 | 406 | beforeEach -> 407 | routeRes = bogart.text 'mix' 408 | 409 | router = bogart.router() 410 | 411 | router.get '/:foo/*', (req) -> 412 | params = req.params 413 | routeRes 414 | 415 | res = router() new MockRequest('/foo/bar/baz') 416 | 417 | it 'should have correct response', (done) -> 418 | q.when res, (res) -> 419 | expect(res).toBe routeRes 420 | done() 421 | 422 | it 'should have correct named parameter', (done) -> 423 | q.when res, (res) -> 424 | expect(params.foo).toBe 'foo' 425 | done() 426 | 427 | it 'should have correct splat parameter', (done) -> 428 | q.when res, (res) -> 429 | expect(params.splat).toEqual [ 'bar/baz' ] 430 | done() 431 | 432 | describe 'chaining route handlers', -> 433 | routeRes = null 434 | res = null 435 | hello = null 436 | 437 | beforeEach -> 438 | routeRes = bogart.text 'hello' 439 | 440 | router = bogart.router() 441 | 442 | firstHandler = (req, next) -> 443 | req.hello = 'world' 444 | next req 445 | 446 | secondHandler = (req) -> 447 | hello = req.hello 448 | routeRes 449 | 450 | router.get '/', firstHandler, secondHandler 451 | 452 | res = router() MockRequest.root() 453 | 454 | it 'should have correct response', (done) -> 455 | q.when res, (res) -> 456 | expect(res).toBe routeRes 457 | done() 458 | 459 | it 'should have correct value set by first handler', (done) -> 460 | q.when res, -> 461 | expect(hello).toBe 'world' 462 | done() 463 | 464 | -------------------------------------------------------------------------------- /spec/streamSpec.coffee: -------------------------------------------------------------------------------- 1 | bogart = require '../lib/bogart' 2 | q = bogart.q 3 | fs = require 'fs' 4 | Readable = require('stream').Readable 5 | ForEachStream = require '../lib/forEachStream' 6 | zlib = require 'zlib' 7 | 8 | describe 'ForEachStream pipe to file stream', -> 9 | stat = null 10 | 11 | beforeEach -> 12 | stat = q.defer() 13 | 14 | source = [ 'Hello', 'World' ] 15 | stream = new ForEachStream source 16 | fileName = 'hello-world.txt' 17 | writeStream = fs.createWriteStream fileName 18 | 19 | stream.pipe writeStream 20 | 21 | stream.on 'end', -> 22 | stat.resolve(fs.statSync fileName) 23 | 24 | it 'should have created file', (done) -> 25 | q.when stat.promise, (stat) -> 26 | expect(stat.isFile()).toBe true 27 | done() 28 | 29 | describe 'ForEachStream pipe to deflate stream', -> 30 | stat = null 31 | bufferInflated = null 32 | 33 | beforeEach -> 34 | statDeferred = q.defer() 35 | bufferInflatedDeferred = q.defer() 36 | 37 | stat = statDeferred.promise 38 | bufferInflated = bufferInflatedDeferred.promise 39 | 40 | source = [ 'Hello', ' ', 'World' ] 41 | srcStream = new ForEachStream source 42 | stream = zlib.createDeflateRaw() 43 | fileName = 'hello-world.dat' 44 | 45 | srcStream.pipe(stream).pipe(fs.createWriteStream(fileName)) 46 | 47 | stream.on 'end', -> 48 | statDeferred.resolve fs.statSync(fileName) 49 | 50 | process.nextTick -> 51 | readStream = fs.createReadStream fileName 52 | inflateStream = zlib.createInflateRaw() 53 | buffer = new Buffer 0 54 | 55 | readStream.pipe inflateStream 56 | 57 | inflateStream.on 'data', (data) -> 58 | oldBuffer = buffer 59 | 60 | buffer = new Buffer(oldBuffer.length + data.length) 61 | oldBuffer.copy(buffer, 0, 0) 62 | data.copy(buffer, oldBuffer.length, 0) 63 | 64 | inflateStream.on 'error', (err) => 65 | this.fail err 66 | 67 | inflateStream.on 'end', -> 68 | bufferInflatedDeferred.resolve buffer.toString('utf-8') 69 | 70 | it 'should have correct inflated buffer', (done) -> 71 | q.when bufferInflated, (str) -> 72 | expect(str).toBe 'Hello World' 73 | done() 74 | 75 | it 'should have created file', (done) -> 76 | q.when stat, (stat) -> 77 | expect(stat.isFile()).toBe true 78 | done() 79 | 80 | describe 'pump ForEachStream to file stream', -> 81 | ended = null 82 | fileName = null 83 | 84 | beforeEach -> 85 | seed = [ 'Hello', ' ', 'World' ].map (x) -> 86 | new Buffer x 87 | 88 | fileName = 'forEachableToFileStream.txt' 89 | 90 | src = new ForEachStream seed 91 | 92 | dest = fs.createWriteStream fileName 93 | 94 | ended = bogart.pump src, dest 95 | 96 | it 'should create file', (done) -> 97 | q.when ended, -> 98 | expect(fs.statSync(fileName).isFile()).toBe true 99 | done() 100 | 101 | it 'should have correct file content', (done) -> 102 | q.when ended, -> 103 | expect(fs.readFileSync(fileName, 'utf-8')).toBe 'Hello World' 104 | done() 105 | -------------------------------------------------------------------------------- /spec/utilSpec.coffee: -------------------------------------------------------------------------------- 1 | bogart = require '../lib/bogart' 2 | path = require 'path' 3 | q = bogart.q 4 | security = require '../lib/security' 5 | 6 | describe 'security', -> 7 | dec = null 8 | plain = null 9 | 10 | beforeEach -> 11 | plain = "this is a very long string of text with random characters {}[[]\!@#$%^&*()_+!@#$%^&*()_+%3D%44%5Z,this is a very long string of text with random characters {}[[]\!@#$%^&*()_+!@#$%^&*()_+%3D%44%5Z,this is a very long string of text with random characters {}[[]\!@#$%^&*()_+!@#$%^&*()_+%3D%44%5Z,this is a very long string of text with random characters {}[[]\!@#$%^&*()_+!@#$%^&*()_+%3D%44%5Z"; 12 | 13 | describe 'default key', -> 14 | beforeEach -> 15 | enc = security.encrypt plain 16 | dec = security.decrypt enc 17 | 18 | afterEach -> 19 | dec = null 20 | 21 | it 'should have decrypted original message', -> 22 | expect(dec).toBe plain 23 | 24 | describe 'provided key', -> 25 | beforeEach -> 26 | key = "THIS is a Secret -- key == C!@#$%^&*())_%3D%2F" 27 | 28 | enc = security.encrypt plain, key 29 | dec = security.decrypt enc, key 30 | 31 | afterEach -> 32 | dec = null 33 | 34 | it 'should have decrypted original message', -> 35 | expect(dec).toBe plain 36 | 37 | describe 'uuid key', -> 38 | beforeEach -> 39 | key = "0ce05d12-1a33-11e1-a436-0019e34411d1" 40 | 41 | enc = security.encrypt plain, key 42 | dec = security.decrypt enc, key 43 | 44 | afterEach -> 45 | dec = null 46 | 47 | it 'should have decrypted original message', -> 48 | expect(dec).toBe plain 49 | 50 | describe 'promisify', -> 51 | 52 | describe 'given success', -> 53 | expectedVal = 1 54 | res = null 55 | 56 | beforeEach -> 57 | asyncFn = (cb) -> 58 | process.nextTick -> 59 | cb null, expectedVal 60 | 61 | res = bogart.promisify(asyncFn)() 62 | 63 | it 'should have corrected resolution', (done) -> 64 | q.when res, (res) -> 65 | expect(res).toBe expectedVal 66 | done() 67 | 68 | describe 'given rejection', -> 69 | res = null 70 | expectedRejection = new Error('bad stuff happened') 71 | 72 | beforeEach -> 73 | asyncFn = (cb) -> 74 | process.nextTick -> 75 | cb expectedRejection 76 | 77 | res = bogart.promisify(asyncFn)() 78 | 79 | it 'should have correct rejection', (done) -> 80 | q.when(res).fail (err) -> 81 | expect(err).toBe expectedRejection 82 | done() 83 | 84 | 85 | -------------------------------------------------------------------------------- /spec/viewSpec.coffee: -------------------------------------------------------------------------------- 1 | bogart = require '../lib/bogart' 2 | view = require '../lib/view' 3 | jsgi = require 'jsgi' 4 | q = bogart.q 5 | path = require 'path' 6 | fixturesPath = path.join __dirname, 'fixtures' 7 | 8 | describe 'render mustache', -> 9 | res = null 10 | 11 | beforeEach -> 12 | viewEngine = bogart.viewEngine 'mustache', fixturesPath 13 | 14 | res = viewEngine.render 'index.mustache', { layout: false } 15 | 16 | it 'should have correct html', (done) -> 17 | q.when res, (res) -> 18 | expect(res).toBe 'Hello World from Mustache
' 19 | done() 20 | 21 | describe 'render mustache with partials', -> 22 | res = null 23 | 24 | beforeEach -> 25 | viewEngine = bogart.viewEngine 'mustache', fixturesPath 26 | 27 | res = viewEngine.render 'partial-test.mustache', { 28 | layout: false, 29 | locals: { greeting: {} }, 30 | partials: { greeting: 'greeting.mustache' } 31 | } 32 | 33 | it 'should have correct html', (done) -> 34 | q.when res, (res) -> 35 | expect(res).toBe 'Hello World from Mustache
With Partial
' 36 | done() 37 | 38 | describe 'given headers to merge', -> 39 | res = null 40 | opts = null 41 | 42 | beforeEach -> 43 | viewEngine = bogart.viewEngine 'mustache', fixturesPath 44 | 45 | opts = { 46 | layout: false, 47 | headers: { abc: 123 } 48 | } 49 | 50 | res = viewEngine.respond 'index.mustache', opts 51 | 52 | it 'should have correct content-type', (done) -> 53 | q.when res, (res) -> 54 | expect(res.headers['content-type']).toBe 'text/html' 55 | done() 56 | 57 | it 'should have correct merged value', (done) -> 58 | q.when res, (res) -> 59 | expect(res.headers.abc).toBe opts.headers.abc 60 | done() 61 | --------------------------------------------------------------------------------