Hextor

The God of Conflicts has arrived, to resolve yours!

Resolves database conflicts in systems that might have them, like Orchestrate.

Install

To install Hextor, you'll need node.js. Once you have it, run this in terminal:

npm install --save hextor

Usage

var hextor = require('hextor');

var resolver = hextor({
  api_key: 'your_orchestrate_api_key',
  collection: 'your_orchestrate_collection',
  on_conflict: function (conflict, done) {
    resolve(conflict)
    .then(done.bind(null, undefined))
    .fail(done);
  }
});

resolver.on('conflict.success', console.log);

Now whenever the resolver successfully resolves a conflict, it will print a message.

Options

{
  api_key: process.ORCHESTRATE_API_KEY,
  collection: process.ORCHESTRATE_COLLECTION,
  on_conflict: function (conflict, done) {
    // see `default.js` for more info
  }
}

Events

• connect: Emitted when Hextor begins processing conflicts.
• conflict: Emitted when a conflict is detected, resolved, or generates an error.
• conflict.start: Emitted when a conflict is detected.
• conflict.resolved: Emitted when a conflict is resolved.
• conflict.error: Emitted when resolving a conflict experiences an error.
• error: Emitted when Hextor's connection to Orchestrate experiences an error.
• drain: Emitted when there are no more conflicts left to process.

Usage as Daemon

You can also run Hextor as a daemon, so it will continue watching your Orchestrate collection autonomously. To start, just do:

sudo npm install -g hextor
export ORCHESTRATE_API_KEY=...
export ORCHESTRATE_COLLECTION=...
# modify defaults.js with your resolution strategies
hextor
# Now watching [collection] for conflicts...

Usage on Heroku

To deploy Hextor on Heroku, so it will watch your collection while you corner the global market on toe socks, you'll need the heroku toolbelt. Then:

git clone https://github.com/orchestrate-io/hextor.git
cd hextor
heroku create [app-name]
heroku config:set ORCHESTRATE_API_KEY=...
heroku config:set ORCHESTRATE_COLLECTION=...
git push heroku master

Now your app is running on Heroku! Since there are no worker dynos by default, let's start one:

heroku ps:scale worker=1 web=0

Tests

The tests require a valid API key to run. To set it, do this:

export ORCHESTRATE_API_KEY=YOUR_API_KEY

Then, run the tests:

npm test

License

ISC, yo.