bella

Bella

An API Authentication for node.js

Getting Started

Install the module with: npm install bella

var bella = require('bella');
//Express.js
app.configure(function() {
  app.use(bella.init(mongoose, conn));
  app.use(bella.authenticate());
});

Documentation

.init(mongoose, conn)

Parameter: mongoose Type: Object Example: var mongoose = require('mongoose');

Parameter: conn Type: Object Example: var conn = mongoose.connect('mongodb://localhost/testdb');

The 'init' is method responsible for initiating the module and set the Schema and create a model to be used by other methods.

How to use this method

app.configure(function() {
  app.use(bella.init(mongoose, conn));
});

.create(domain, ip, terminal, cb)

Parameter: domain Type: String Example: example.com

Parameter: ip Type: String Example: 127.0.0.1

Parameter: terminal Type: Boolean Example: true

Parameter: cb Type: Function Example: function(err, access_token) {};

The 'create' is method responsible for creating the access_tokens to be used by the authentication system.

INFO: If the terminal option is passed as true then users will only be able to access the API using the access_token.

How to use this method

bella.create('example.com', '127.0.0.1', true, function(err, access_token) {
   console.log('Token: ' + access_token);
});

.remove(access_token, cb)

Parameter: access_token Type: String

Parameter: cb Type: Function Example: function(err, access_token) {};

The 'remove' method is responsible for removing users

How to use this method

bella.remove('YOUR ACCESS TOKEN', function(err, access_token) {
   console.log('Token: ' + access_token + 'Deleted');
 });

.authenticate()

The 'authenticate' method is responsible for authenticating access the API. Only users with Access Token, Domain, IP, Username and Password authenticated can access the API.

How to use this method

app.configure(function() {
   app.use(bella.init(mongoose, conn));
   app.use(bella.authenticate());
});

  //OR

app.get('/users', bella.authenticate(), ctrl);

Contributing

Please submit all issues and pull requests to the chrisenytc/bella repository!

Support

If you have any problem or suggestion please open an issue here.

License

Copyright (c) 2013 Christopher EnyTC

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.