Creek

Notice

This README and all documentation have to be updated. For functional examples, see how tests are done.

A simple web development framework with Sinatra looks and Dart power.

Creek is a web development framework that let's you feel at home while you take advantage of Dart. It does things a little different than most Sinatra-inspired frameworks by using a routing tree (instead of a set of RegExp matchers) and Streams API.

A routing tree is a tree with all the accessible URL paths of a server. This tree allows the framework to be lighting fast while finding the right handler of a HTTP request. Also, it stores some metadata about your routes that might come in handy. For example, when close a route (e.g., "/foo"), you might want to close all it's child routes (e.g., "/foo/bar", "/foo/barz", "/foo/bar/qux") and Creek can do exactly that.

With the use of the Streams API, you get full control of your request flow. You can filter requests by calling Stream.where, redirect requests internally to another consumer with Stream.pipe, modify request in some manner using a StreamTransformer, pause your handler from receiving request through StreamSubscription.pause... If Dart's HttpServer is a Stream, your framework should work accordingly to give as much power as possible.

Usage

Running a Creek server is really straight forward:

Creek creek = new Creek();
creek.bind('127.0.0.1', 7070);

//Or
HttpServer.bind('127.0.0.1', 7071).then((server) => creek.bind(server));

When a Creek is instanciated, it can be used to create all routes right away. A HttpServer is not created though, so you have to tell Creek to bind to an address or a HttpServer. The bind() method returns a Future, which will gives you a HttpServer server when complete.

Routes

Creating routes is easy:

creek
	..get('/', (req, res) => res.send('Hello, Dartisans!'))
	..post('/foo', (req, res) => res.send('It is so easy, it got boring already... or maybe not!'));
	
// Alternatively, you can do this
creek.put('/bar').listen((req) => req.response.send('It is time to go to the bar'));

Streams and StreamSubscriptions

With Streams and StreamSubscriptions, you can add some awesome sauce to your code:

StreamSubscription subscription = creek.get('/filtered').where((req) {
      if (req.params['name'] == 'Creek') {
        return true;
      } else {
      	// Remember to treat rejected requests so they won't stay alive waiting for a response... forever...
        req.response.status = HttpStatus.FORBIDDEN;
        req.response.close();
        return false;
      }
    }).listen((req) => req.response.send('Filtered!'));
    
// When paused, no request will be passed to this subscription.
subscription.pause();

// You can pause and resume subscriptions freely at runtime, without much trouble. This way, you can control your routes
// while your server is stil running. 
creek.get('/resume', (req, res) { subscription.resume(); res.send('subscription resumed!'); });

License

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.