sails-cloudant-orm/README.md

Waterline Sails Adapter for IBM Cloudant Database

![image_squidhome@2x.png](http://i.imgur.com/RIvu9.png)

# Waterline Cloudant Adapter

[Waterline](https://github.com/balderdashy/waterline) adapter for Cloudant.

## Versions

0.0.1 - Initial version of the adapter, its a adaptation from sails-couchdb-orm that is no longer being maintained

## Install

Add this module to your sails.js project:

```bash
$ npm install sails-cloudant-orm --save
```

## Configuration

```javascript
var db = {
    adapter: 'sails-cloudant-orm', // adapter module
    host: 'localhost', // server address
    port: '443', // database port
    username: process.env.DB_USER,	// database user name
    password: process.env.DB_PASSWORD, // database password 
    database: 'mixblog', // the database name
    migrate: 'safe', // 'safe' is safe for production, 'drop' will drop the database every time, 'alter' will add / delete columns
    https: true // if server is http or https
}
```

## Use

### Class methods

Besides the usual Waterline stuff, this adapter also provides the class methods `merge`, `authenticate` and `session`.

#### View

TODO docs

#### Merge

Merge some attributes into one document.

Example:

```javascript
var someAttributes = {
  lastName: 'Simpson',
  favoriteFood: 'beer'
};

var id = 'homer@simpsons.com';

User.merge(id, someAttributes, function(err, homer) {
  // ...
});
```

#### Authenticate

Authenticate against the Cloudant user database (`_users`).

Example:

```javascript
var username = req.param('username');
var password = req.param('password');

Users.authenticate(username, password, function(err, sessionId, username, roles) {
  // ...
});
```


#### Session

Get the Cloudant session object.

Example:

```javascript
var sessionId = req.cookies.sid;
Users.session(sessionId, function(err, session) {
  // ...
});
```

## Sails.js

http://sailsjs.org

## Waterline

[Waterline](https://github.com/balderdashy/waterline) is a brand new kind of storage and retrieval engine.

It provides a uniform API for accessing stuff from different kinds of databases, protocols, and 3rd party APIs. That means you write the same code to get users, whether they live in MySQL, LDAP, MongoDB, or Facebook.


## Credits

The sails-couchdb-orm adapter was published in npm by Daniel Duan - https://www.npmjs.com/~danielduan , many thanks to him
And thanks so much to Pedro Teixeira([@pgte](https://twitter.com/pgte)) for building this adapter (as written in other package readme).

## License

### The MIT License (MIT)

Copyright © 2014 CodeSwarm, Inc. 

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.