photon

My generic middlewares for connect.js

npm install photon
32 downloads in the last week
66 downloads in the last month

photon.js

Photon is just Connect, extended by method app.extend. And also a number of extensions and middlewares for it.

All Photon in this 7 lines:

function photon() {
    var c = connect.apply(null, arguments);

    c.extend = function(extension) {
        return extension.call(this), this;
    };

    return c;
}

Extensions

photon.routing()

Provides possibility to route requests by method, request url match, or by RegExp.

Warning: here is two types of routes. Static (with pattern as string) and dynamic (with pattern as RegExp). And static routes have highter priority.

Requires

  • photon.path

Adds

  • app.get, app.post
  • app.routeStatic

At current time I'm don't need more, than get/post handlers. If you need, ask me for it, thanks.

app.VERB(pattern, handler)

Arguments

  • pattern: String | RegExp
  • handler(req, res, [group1, [group2, ...]]) - will be called, if pattern is matching. Also, if RegExp pattern has groups, they will be passed as arguments. Beware, they are strings.

app.routeStatic(routes)

Example

app.routeStatic({
  '/get/by/default': handlerA,
  '/but/other/methods/too': {
    'GET': handlerA,
    'POST': handlerB,
    'HEAD': handlerC
  }
})

Middlewares

photon.common(options)

Adds

  • res.status(statusCode) - chainable version of res.statusCode = statusCode
  • res.location(url) - shortcut for res.setHeader('Location', url)
  • res.redirect([statusCode,] url) - shortcut for res.status(statusCode).location(url). Default statusCode is 303.
  • res.onEnd(callback) - adds callback to stack, and when res.end called — calls every callback from stack. Callback must call this.apply(this, arguments) to continue.

Options

  • status, location, redirect, onEnd: Boolean - enable/disable features. Default true for all.

photon.decodeURI()

Calls decodeURIComponent to req.url for replacing '%D1%8D%D1%82%D0%BE' to unicode.


photon.mime([type, charset])

Default type — text/html, charset — utf-8.

Requires

  • photon.common({onEnd: true})

Adds

  • res.mime(type, charset) - sets mime type and charset. If type or charset === null, takes value from passed options to photon.mime.

Requires

  • photon.common({onEnd: true});

Adds

  • res.cookie(name, value, options) - sets cookie. Supported options is: maxAge (in seconds), expires (Date), path, httpOnly (Boolean). Expires has highter priority, than maxAge.

photon.session(options)

Provides generic session mechanism.

Requires

  • photon.cookieParser
  • photon.cookie

Options

  • sessionApi.read(sessionId, [key], callback(error, data))
  • sessionApi.update(sessionId, [key], data, callback(error, sessionId))
  • sessionApi.remove(sessionId, [key], callback(error))

Adds

  • req.session.read([key], callback(error, data))
  • res.session.set([key], data, callback(error))
  • res.session.remove([key], callback(error))

photon.auth(options)

Provides auth mechanism based on session. Will rewritten to generic version soon.

Requires

  • photon.session

Options

  • cookie - cookie name, used for store session id. Defaults to 'session_id'

Adds

  • req.session:user — creates user field in session
  • req.user.get(callback(error, user))
  • res.user.set(user, callback(error))
  • res.user.unset(callback)

Extras

  • photon.auth.required(fn(req, res, user), otherwise(req, res, error)) - if Boolean(user) !== false, calls fn and passes user as third argument (if this is dynamic route, groups will follow), otherwise calls otherwise. If here backend error, calls otherwise too.
  • photon.auth.fail(otherwise) - returns photon.auth.required equivalent with otherwise as default otherwise.
  • photon.auth.provide(fn(req, res, user), error(req, res, error)) - if no error, provides user (null, if not set).
  • photon.auth.provideFail(error(req, res, error)) - returns photon.auth.provide equivalent with error as default error callback.

photon.path()

Adds

  • req.path - req.url sliced to first '?' char

photon.hostRedirect(host, [protocol])

If req.headers.host !== host, redirects with 302 to protocol://host.


photon.cache()

Adds

  • req.cached({etag: 'string', lastModified: Date}) — one of etag or lastModified options must be defined. Checks for If-Modified-Since and If-None-Match headers. If If-Modified-Since >= lastModified, or If-None-Match === etag, returns true, else false. Warning: here is 1s error possible.
  • res.cache({mode: 'public', maxAge: int, etag: 'string', lastModified: Date}) — sets Cache-Control: mode[, max-age=maxAge], ETag: etag, Last-Modified: lastModified. Also sets Date: new Date().toUTCString().
  • res.notModified() — chainable res.statusCode = 304.
  • res.endIfCached(options) — options same as in req.cached. Shortcut for return req.cached(options) ? res.notModified().end(), true : false.

If you know English and can fix my errors, please, write me to rulix.exec@gmail.com. Thanks.

npm loves you