51stats REST API

This is a wrapper for some statistics of a bunch of people made with some APIs.

Getting started

Start the app

Navigate to the directory and type node index into your command line. In development mode it's nice to use a node module like nodemon.

Arguments

• no-socket: launches the app without socket.io in case if you don't want to have streams listening in the background.

How do I include an API?

Add a file into the api directory. The name of your file will be the URL, without the .js extension.

For example: a simple file named file.js is accessible under [http://localhost:8080]/file and can look like this:

module.exports = function(req, res, next) {
	res.send('Hello World!');
	return next();
};

Structure configs

You can put a few configurations of your API module into the config directory. Would be great if the name of the file is somehow related to the module.

Securing your API keys

Open accessible API keys are meh. Put them into a configuration file, censor them (maybe with xxxx), add the file to the .gitignore, push the whole thing and then insert them again. No one will see them (unless you want to update your config-file).

If git is still tracking the file, you can "untrack" (assume unchanged) it with: git update-index --assume-unchanged path/to/file.js

To revert this, type the following command: git update-index --no-assume-unchanged path/to/file.js

Stream APIs

Listen to streams by adding a file into the api/stream directory. There's a socket.io server listening, so you can emit news easily.

A simple file can look like this:

module.exports = function(io) {
	[some stream event listener], function() {
		io.emit('news', { hello: 'world' });
	});
};

In a Browser you can connect to the websocket like this:

<script src="https://cdn.socket.io/socket.io-1.0.6.js"></script>
<script>
var socket = io('http://localhost:8080'); // or wherever the server is located
socket.on('news', function (data) {
	console.log(data);
});
</script>

Troubleshooting

The provided example with the Twitter API won't work!!1

The API Keys for Twitter are censored. For testing register your own twitter app.

I get an error when launching the app

1. Try npm install
2. Restify runs on port 8080, maybe some other process is running on that port?
3. You've edited something and made a mistake

TODO

• restify Caching
• private POST/PUT methods
• ...