@amedia/gaia-client/gaia-mock/README.md

# Gaia Mock Server

A [node.js][nodejs] mock server for the [Gaia][gaia] REST service. 

This mockserver can act as a simple replacement for the [Gaia][gaia] REST
service in tests and as a standalone server. This mock server serve static
files stored in the projects `data` directory.



## Run as a standalone server

Check out this repo, in the repo run the following:

```bash
$ npm install
$ npm start
```

The mock server will then be running on: http://localhost:9050/.



## Use as a library

This mock server can be included in your own code and started by your own code.
You can then controll and listen on what this application does within your own
program.


### Installation

```bash
$ npm install gaia-mock
```

### Constructor

This constructs a new mock server:

```js
var server = new GaiaMockServer();
```


### Events

The server emit the following events:

 * `listen` - When the server is up running and listening for upcomming requests.
   The first parameter to the `callback` is the port number its listening on.
 * `close` - When the server has closed down.
 * `request` - When the server receives a request. The first parameter to the 
   `callback` is the URL which was requested.


### API

The server has the following methods:


#### .listen(port)

Starts the server. `port` is the port number the server should listen on. If no
value is given for `port` the server will attach itself to a available port.


#### .close()

Closes down the server.


### Example

```js
var MockServer = require('gaia-mock');

var gaia = new MockServer();

gaia.on('listen', function (port) {
    console.log('server is running on port: ' + port);
});

gaia.on('close', function (port) {
    console.log('server stopped');
});

gaia.on('request', function (url) {
    console.log('server got a request on: ' + url);
});

gaia.listen(8080);

// gaia.close();
```



[nodejs]: http://http://nodejs.org/ "node.js"
[gaia]: https://github.com/amedia/gaia "Gaia"