from-the-river-to-the-sea / barry-donations

Evented API wrapper for Barry's Donation Tracker

barry-donations

An evented API wrapper for Barry's Donation Tracker, a service that makes tracking donations easier for Twitch broadcasters.

Installation

npm install barry-donations

Example Usage

var BarryDonations = require('barry-donations');

// New donations will be received via a REST endpoint
// barry-donations takes care of making and listening to the endpoint, but you must supply the hostname
var bd = new BarryDonations({
    username: 'user',
    password: 'pass',
    hostname: 'yourserver.com', // don't add "http://" prefix. https currently unsupported
    port: 1234,                 // optional, will use a random port if not supplied
    reconnect: true             // optional, attempt to automatically reconnect when disconnected. defaults to true.
});

bd.on('connected', function () {
    console.log('connected');
});

bd.on('connectfail', function (e) {
    console.error(e);
});

bd.on('error', function (e) {
    console.error(e);
});

bd.on('disconnected', function (e) {
    console.error(e);
});

bd.on('reconnecting', function (timerDuration) {
    console.log('reconnecting in %d seconds', timerDuration);
});

bd.on('initialized', function (data) {
    console.log("[init]" + data);
});

bd.on('newdonations', function (data) {
    console.log("[newdonations] " + data);
});

Contributing

1. Fork it ( http://github.com/langeh/barry-donations/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

License

barry-donations is provided under the MIT license, which is available to read in the [LICENSE][] file.

Credits

Barry Carlyon, developer of Barry's Donation Tracker

barry-donations's Issues

Cache connections

If two modules both use barry-donations and both attempt to connect to the same account, barry-donations shouldn't create another API session and waste bandwidth. It should instead return the same barry-donations object.