README.md

agile-enforcer

Agile Enforcer API

Install via npm

npm install --save agile-enforcer

Use

To start agile-enforcer as an HTTP server:

const fs = require('fs');
const _ = require('lodash');
const { createHttpServer } = require('./dist');

const swaggerDefinition = fs.readFileSync('./example.swagger.yml');
const config = {
  "origin": "agile-core",
  "methodMap": {
    "deviceStatus": "/device/{deviceId}/status"
  }
}

createHttpServer(swaggerDefinition, config)
.then((app) => {
  app.listen(8008);
  console.log('Listening on port 8008');
})
.catch((err) => {
  console.error('error', err);
  process.exit(1);
});

Example HTTP Request:

GET http://localhost:8008/agile-ui/device/1/status

Headers:

{
  "x-agile-api-method": "deviceStatus", // mapped to /device/{deviceId}/status through config object
  "Authorization": "Bearer 12345" // token to be used for the PDP evaluation call
}

Origin: agile-core -- mapped to agile-core through config object

Target: agile-ui -- first segment of the incoming http request path

EntityId: 1 -- mapped with swagger api definition params

Method: read -- http request method GET

Action: action.status -- mapped with swagger api definition property "operationId"

To use agile-enforcer as a node module:

const { Enforcer } = require(’agile-enforcer’);

const origin = 'agile-ui'
const target = 'devices'
const method = 'read'
const action = 'typeof'

Enforcer.authorize(origin, target, method, action)
.then((response) => {
  console.log('response', response);
})
.catch((err) => {
  console.error('error', err);
});

Check the DOCS for further reading: Documentation