spas

Version:

spas is a pragmatic tool for bundling multiple API requests into a single request/response for the end user. spas throttles, caches, parses, filters, concatenates and minifies API responses. It serves them all up in one tidy little package resulting in fe

dtex.github.io/spas/

dtex/spas

89 lines (77 loc) • 22 kB

HTML

View Raw

<!DOCTYPE html> <html> <head> <title>little-spas.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> little-spas.js </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> </td> <td class="code"> <div class="highlight"><pre>/* The MIT License (MIT) Copyright (c) 2012 Donovan Buck Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <h2>Module dependencies.</h2> </td> <td class="code"> <div class="highlight"><pre>var </pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> Built in modules </td> <td class="code"> <div class="highlight"><pre> http = require('http') , url = require('url') , querystring = require('querystring') , fs = require('fs') , spawn = require('child_process').spawn </pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> My modules </td> <td class="code"> <div class="highlight"><pre> , bundles = require('./bundles') , engine = require('./lib/engine') , oauth2 = require('./lib/oauth2') </pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> Other Dependencies </td> <td class="code"> <div class="highlight"><pre> , nconf = require('nconf') , director = require('director') , _ = require('underscore')._ , cronJob = require("cron").CronJob ;</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> Use nconf to grab commandline params and read config.json </td> <td class="code"> <div class="highlight"><pre>nconf.argv().file({ file: 'config.json' });</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> If --dev is passed use the development config section </td> <td class="code"> <div class="highlight"><pre>var config = nconf.get('dev') ? nconf.get('development') : nconf.get('live');</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> <h2>Run little-spas as a service</h2> </td> <td class="code"> <div class="highlight"><pre>if (nconf.get('service')) {</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> Specify output and error log files </td> <td class="code"> <div class="highlight"><pre> var out = fs.openSync('./logs/spasout.log', 'a'), err = fs.openSync('./logs/spaserr.log', 'a'); </pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> Spawn the process </td> <td class="code"> <div class="highlight"><pre> var spasService = spawn('node', ['little-spas', nconf.get('dev') ? '--dev' : ''], { detached: true, stdio: [ 'ignore', out, err ] }); spasService.unref(); console.log("little-spas is listening on port " + config.port); process.exit(); } else {</pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> <h2>Our Routes</h2> </td> <td class="code"> <div class="highlight"><pre> var router = new director.http.Router({ </pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> This is the return route for authentication services </td> <td class="code"> <div class="highlight"><pre> '/auth': { get: function() { if (_.has(querystring.parse((url.parse(this.req.url).query)), 'code')) { oauth2.saveCode ( this.res, querystring.parse((url.parse(this.req.url).query)).state.split(','), querystring.parse((url.parse(this.req.url).query)).code); } } }, </pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> This route needs to be removed and changed to a command line call. Anybody could revoke creds right now </td> <td class="code"> <div class="highlight"><pre> '/revoke/:cred': { get: function(cred) { oauth2.revoke ( this.res, cred ); } }, </pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">¶</a> </div> A bundle is being requested </td> <td class="code"> <div class="highlight"><pre> '/bundle/:bid': { get: function(bid) { engine.fulfill ( this.res, bid, bundles[bid], querystring.parse((url.parse(this.req.url).query)).callback ); } } }); </pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">¶</a> </div> <h3>Schedule jobs defined in bundles</h3> </td> <td class="code"> <div class="highlight"><pre> _.each(bundles, function (bundle, bid) { _.each(bundle, function (api, key) { if (api.schedule) { new cronJob(api.schedule, function(){ engine.refresh(api, key, bid, bundle); }, null, true); } }); }); </pre></div> </td> </tr> <tr id="section-16"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-16">¶</a> </div> <h3>Create our server</h3> </td> <td class="code"> <div class="highlight"><pre> var server = http.createServer(function (req, res) { router.dispatch(req, res, function (err) { if (err) { res.writeHead(404); res.end(); } }); }); server.listen(config.port); } </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>