hapi-relations

A plugin for hapi using the relations ACL.

Dependencies

relations

See relations for supported clients and ACL structure.

Usage

Pass in your relations schema and choosen client as options.

var Hapi = require('hapi');
var redis = require('redis');
var fs = require('fs');
 
var client = redis.createClient(6379, 'localhost');
var server = new Hapi.Server();
 
var schema = JSON.parse(
    fs.readFileSync('schema.json', 'utf8')
);
 
server.register([
  {
    register: require('hapi-relations'),
    options: {
        schema: schema,
        client: redis,
        clientType: 'redis'
    }
  }
], function (err) {
    console.log(err);
});

Or optionally pass the client in as a server plugin

server.register([
  {
    register: require('hapi-relations'),
    options: {
        schema: schema,
        client: 'hapi-redis',
        clientType: 'redis',
        pluginClient: true
    }
  }
], function (err) {
    console.log(err);
});

And access realtions from the plugins

server.plugins.relations.coins('Can TEST GET from EXAMPLE);

Configuration

The schema expects a loaded schema file, which will be added to relations. A context defines an application in which the user's privileges will be evaulated. For instance, if the context is inventory, then the roles and actions listed within the context correspond to a user's ability to use or add to inventory.

The context consists of roles, and which actions they are allowed to perform. Please see the test/permission.json for an example.

Contributing

Please follow the MRN Javascript Style Guide (forked from AirBnB). Use grunt lint to check yo-self