et/README.md

effortlessness, et al.

et
==

effortlessness, serverside <i>et al.</i>


    $ npm install et
    



Usage
-----

This example uses [jugglingdb](https://github.com/1602/jugglingdb) as a `resource` to provide schema based database access

### thing.coffee

```coffee

module.exports = 

    config: (opts) -> 

        #
        # config() is called when the server starts up
        # to allow for things like schema definitions
        # 

        opts.resource.database1.define 'things'

            id: Number
            name: String
            location: String

    get: (req, res) ->

        #
        # The presence of a get() method here causes the 
        # automatic creation of the rest endpoint '/things/:id' 
        #

        Thing = req.et.resource.database1.models.thing

        Thing.find req.params.id, (arg1, data, arg3) -> 

            #
            # apologies, have not looked into what args1&3 are...
            #

            res.send data

    #
    # although called a model, this is more precisely a combination
    # of model and controller
    # 
    #   ie. a "controdel"
    # 



```


### server.coffee

```coffee

et      = require('et')
Schema  = require('jugglingdb').Schema

server  = et.al

    port: 3001

    resource:

        #
        # resources become available in the models
        # (see above)
        #

        database1: new Schema 'postgres'

            host: 'db.domain.com',
            database: 'dbname',
            username: 'dbuser',
            password: 'passrod'

    models:

        #
        # link 'thing.coffee' as a 'model'
        #

        things: require './thing'

    static:

        scripts:

            #
            # key (above) must match last path element (below)
            #

            path: __dirname + '/nested/path/to/scripts'



```


### result

```coffee

$ coffee server
...
$ curl http://localhost:3001/things/1

{
    "id": 1
    "name": "Venus of Hohle Fels"
    "location": "Schelklingen, Germany"
}

```

Develop
-------

### 2013-02-?? (0.0.5)

* TODO Added post() to enable http POST endpoints
* TODO Configurables for redis session store (eg. redis:hostname:port:password)


Changelog
---------

### 2013-02-01 (0.0.4)

* Added middleware config `opts.before` and `opts.use` callbacks
* Added use of env vars APP_NAME, APP_VERSION, APP_PORT, APP_LOGLEVEL (if present)
* Added use of restify app name and version
* Added overideable request logger, first into the connect stack
* Added configurable [bunyan](https://github.com/trentm/node-bunyan) logger 
* Added auto serve static assets from `opts.static.key.path (if present)

### 2013-01-04 (0.0.3)

* Added auto spawn a restify server if no `opts.app` provided
* `et.al( opts )` returns the running server
* Switched specs to mocha

### 2012-12-12 (0.0.2)

* Added call to model.config (if present), to configure resources at startup
* Added opts.resource available at startup and on req._et.resource
* Added basic local auth using [passport](http://passportjs.org/) 
* Added basic redis session using [connect.session](http://www.senchalabs.org/connect/session.html) (very defaulty! See TODO in src/session)
* Added et.al() all encompasser

### 2012-12-09 (0.0.1)

* Added support for http GET to et
* Transparently plugin to [express'](https://github.com/visionmedia/express) routing