========== disover.js

REST microframework with a universal client.

.. image:: https://travis-ci.org/kevinconway/discover.js.png?branch=master :target: https://travis-ci.org/kevinconway/discover.js :alt: Current Build Status

.. note::

This project is in a very early stage. Expect backwards incompatible
changes frequently until it rolls to version 1.0.0.

Example

.. code-block:: javascript

var http = require('http'),
    Service = require('discoverjs').Service
    Handler = require('discoverjs').Handler,
    success = require('discoverjs').success,
    hello,
    world,
    handler;

hello = new Service("hello", "Simple example service.");
world = hello.resource("world", "Reply with Hello World!");
world.collection.get(null, null, function (request) {
    return new success.OK({"Hello": "World!"});
});

handler = new Handler();
handler.add(hello.service);

http.createServer(handler.listener()).listen(8080);

// GET /hello/world => {"Hello": "World!"}

// Also adds the service to a built-in discovery API.
// GET /discovery/service => [{"name": "hello",...}, ...]
// GET /discovery/service/hello =>
//      {"name": "hello": "description": "Simple example service."}
// GET /discovery/resource?service=hello => [{"name": "world", ...}]
// GET /dicovery/resource/world?service=hello =>
//      {"name": "world", "description": "Reply with Hello World!"}

Does it do X?

Probably not. The focus of this framework is on removing features rather than adding them. For example, only JSON input/output is accounted for. Anything else is on you. The way URLs are generated is also highly constrained. Resources within a service must all be at the top level. This means URLs like "/myServce/user/friends/1234" would be invalid.

The constraints this framework places on the API are not without purpose. Specifically, the framework constrains the API in order to support a client which can work with all services built using this framework. Constraining the URL space and limiting the I/O to JSON allows for the functionality of an API to easily be placed into a controlled discovery API.

For more details see the docs directory.

Setup

Node.js

This package is published through NPM under the name discoverjs::

$ npm install discoverjs

Once installed, simply defer = require("discoverjs").

Browser

Only the client code can be used in the browser. Run the grunt workflow to generate the brwoserified code::

<script src="discover.client.min.js"></script>

The package is exposed via the global name "discoverjs".

Tests

Running the npm test command will kick off the default grunt workflow. This will lint using jslint, run the mocha/expect tests, generate a browser module, and test the browser module using PhantomJS.

License

This project is released and distributed under an MIT License.

::

Copyright (C) 2013 Kevin Conway

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.

Contributors

Style Guide

All code must validate against JSlint.

Testing

Mocha plus expect. All tests and functionality must run in Node.js and the browser.

Contributor's Agreement

All contribution to this project are protected by the contributors agreement detailed in the CONTRIBUTING file. All contributors should read the file before contributing, but as a summary::

You give us the rights to distribute your code and we promise to maintain
an open source release of anything you contribute.