node-votifier

Emulates a Bukkit Votifier server in Node.js

We at CubixCraft don't like Java that much. It kinda sucks a speed. So we always try to replace it with Node.js, whenever it's possible. So is this case. Using node-votifier reduces load on your precious Bukkit and transfers it to your wonderful Node.js app. Plus it's super easy to add vote listeners. No lame .class files anymore!

Requirements

Node.js
OpenSSL (apt-cache search libssl | grep SSL, pre-installed on Ubuntu servers)
RSA public and private key

I recommend using an Ubuntu server. However it should work on Windows / OS X / whatsoever, if your computer supports the requirements listed above.

The RSA keys aren't automatically generated by node-votifier. But it's easy to create them yourself:

openssl genrsa -out private.pem 2048 generates a 2048 bit private key and stores it as private.pem
openssl rsa -in private.pem -pubout > public.pem extracts the public key and stores it as public.pem

Use the public key for all the server lists. Keep the private key private. Otherwise anybody is able to cheat on your vote system.

Installation

npm install votifier

You could also clone this repository. If you wanna do this, you know how.

How to use

Assuming your private.pem is in the same directory as your app, a working Votifier would look like this. An extended example with error handling can be found in the examples directory.

var Votifier = require("node-votifier");
var votifier = new Votifier(__dirname + "/private.pem");

votifier.on("vote", function(user, server, ip, date) {
  console.log(user + " voted.")
});

Complete API

require("node-votifier") returns a Votifier Class.
new Votifier(pathToPrivateKey, port, debug) return a Votifier instance. Constructor requires the absolute path to the private key file. The port is optional and defaults to 8192. Votifier inherits of EventEmitter.
- vote event. This event passes a vote object with the following fields: user (username of the voter), service (name of the server list), ip (IP of the voter) and ts (date and time of the vote as a Date) to its listeners. It is fired, when Votifier receives a vote.
- error event. This event passes error (Error with some infomation), to its listeners. This event is fired when something went wrong.

Contributing

Yes! Please! Fork and pull request! If you experience any issues you don't know how to fix or have any feature requests you're welcome to create an issue.

License

(The MIT License)

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.