cainus / percolator

Percolator is a framework for quickly and easily building quality HTTP APIs in Node.js

Percolator is a new kind of web application framework (for node.js) for fun and fast development of quality APIs.

It's great for:

• quality, public-facing APIs
• single page apps
• mobile apps

Its goal is to help make RESTful APIs in JSON that aren't painful to write and aren't painful to use.

See percolatorjs.com for more details.

percolator's Issues

e-tag support

add a server response timeout

that way, the request's method and url can be logged with the timeout info before the server dies

add docs for app config

put body on 'this' instead of 'req'

there's no 204 No Body short-cut on $.status

xml, form and multipart body parsers

Examples.html web page error

The example code on the web site has the wrong number of args in the update function of the CRUDCollection. http://percolatorjs.com/examples.html

update : function($, obj, cb)

should be:

update : function($, id, obj, cb)

docs for options.parseBody

make it easy to see defined routes somehow (show as a tree diagram like npm's dependencies?)

http://jrgraphix.net/r/Unicode/2500-257F

when content-type header is unsupported, should return 415 "Unsupported Media Type"

add _id to param variable names

uri.pathJoin() should rip off host

add docs for reaper

resorcery mongo resource!

make all links absolute

route-by-route middleware addition?

could just leave it up to routes to call individually and explicitly. does it need method-by-method granularity? or can it be on the entire resource?

is there a better way to handle cross-cutting aspects?

pull `fetched` off req, and add it to instance

implement Percolator.close()

test https

add `authenticate(req, res){}` to resource and `authenticated` to instance

there's no easy way to redirect

options won't work without a content-type and body

when Content-Type is JSON, but body isn't, should 400 w a "JSON parse error" message

would be useful to have a way to hook into all responses and do something (augment / log)

fix repr() to already have req, res

PUT should 415 when missing content-type (instead of crashing server)

fix uri api docs to have better usage examples

have a non-strict mode for routing that can just use regexes, doesn't care about hierarchy.

Update handler and promise, seems to be broken?

I implemented an update method, it has a kind-of-promise type implementation..

The update fails when the CRUDCollection method tries to run $.onJson in the generic update handler.

When my function returns a simple data structure immediately from within my update implementation directly, it works ok.

I'll post my code with a link soon if that would be useful.

on(response) events, on(request) events, some way to measure time diff

$.uri.pathEnd() throws up when the path ends in /

params with numerical indices?

rename: routeDirectory -> loadResources

docco docs?

http://jashkenas.github.com/docco/

add docs for fetch

add docs for collections

self links + querystring = fugliness

make links() return form with 'href' in it

reaper can't tell that "application/json; charset=UTF-8" is json

create links shouldn't have querystring

etags support

add etags support. (to simple resources and CRUDCollection)

If an etag($) function is defined...

• GETs return the etag($) return value in the ETag header as a quoted string.
• If the client sends an If-Match header that matches it, then PUTs and DELETEs should be allowed to succeed, otherwise a 412 response (Precondition Failed) should be sent.
• If the client sends an If-None-Match header that matches it, then GETs should return a 304 (Not Modified) response.

If fetch($) is defined for a resource, the etag($) function should be executed AFTER fetch($) so that $.fetched is available to the etag($) function.

get test coverage working

http://tjholowaychuk.com/post/18175682663/mocha-test-coverage

add docs for status

check out PUT scenario. fix if necessary.

$.uri.get() could use a better name. in case people think it's an http client.

406 unacceptable errors should return a list of acceptable types

add docs for dynamic routes, variables, fetch()

remove express dependency

add docs for testing

make it easy to generate the context object for tests