socketer

Socket.io utility for testing socket.io/node applications.

Installation

npm install socketer

Usage

This lib provides two methods:

1. anonSocket
2. authSocket

anonSocket

anonSocket takes your express app as an argument and a callback that returns an anonymous socket that you can use to poll your server as an anonymous user.

var socketer = request('socketer');

socketer.anonSocket(app, function(socket) {
  socket.on('connect', function() {
    console.log('I am connected!');
  });
  socket.on('my-event', function() {
    console.log('My event is happening');
  });
};

authSocket

authSocket takes your express app as an argument, login credentials in the form of a dict, login url, and a callback that returns an anonymous socket that you can use to poll your server as an anonymous user.

var socketer = request('socketer');

socketer.authSocket(app, {'username': 'Ramsey', 'password': 'Ramseypass'}, '/login', function(socket) {
  socket.on('connect', function() {
    console.log('I am connected as Ramsey!');
  });
});

Requirements

This library simulates the a client socket using socket.io-client package. Different versions of this package might differ in its implementation. During the time time of writing this lib, the versions I was using was:

1. express: ~3.5.1
2. socket.io: ~0.9.16
3. socket.io-client: ^0.9.16

Issues

If you notice any issues with the lib, or any compatibilty issues with the versions you are using, let us know. If you want to extend this library with more helper functions also do let us know here: https://github.com/ramseydsilva/socketer/issues

Credits

This library was inspired by the following gist: https://gist.github.com/jfromaniello/4087861