removed socket.js lib

rewrote module with node events emitter
refactor dumper.js
refactor test.js
update README.md

Author: greguz

README.md

@@ -1,32 +1,90 @@
-# node-raidar
+# node-raidar: a node.js NetGear RADIar library
 
+`node-raidar` is a simple to use NetGear RAIDar implementation for node.js.
 
+# Example
 
-Define error callback:
+``` js
+var raidar = require('raidar');
 
-```
-raidar.on('error', function(err) {
-  console.log('ERROR', err);
+// send request, wait 10000 ms, and return founded devices
+raidar.request(10000, function(err, devices) {
+    if (err)
+        console.log('ERROR', err);
+    else
+        console.log('Founded devices: ' + devices.length);
 });
 ```
 
+# Methods
 
+``` js
+var raidar = require('raidar')
+```
 
-Define device info callback:
+## raidar.open(opt:Object, cb:Function)
 
-```
-raidar.on('device', function(device) {
-    console.log(device.ip, device.hostname, device.mac,  device.info.disk[0].status);
-});
-```
+Open new UDP socket with given `opt` options and fire `cb` callback when socket is open.
+All arguments are optional.
+Default options:
+- `socketType` : socket type to use ('udp4' or 'udp6'), default `udp4`
+- `portToListen` : port to listen, default `57877`
+- `targetHost` : target host to send "request info" packet, default `255.255.255.255`
+- `targetPort` : target port to send "request info" packet, default `22081`
 
+## raidar.close()
 
+Close UDP socket.
 
-To request information from ReadyNAS devices:
+## raidar.request(timeout:Number, callback:Function)
 
-```
-raidar.sendMagic();
-```
+Send "request info" broadcast packet.
+If at least `callback` function is passed, it will execute after `timeout` ms, default 5000 ms.
+The event fires with `callback(err, devices)`.
+`err` is set in case of errors and `devices` is an array of all devices found.
+
+## raidar.on(event:String, callback:Function)
+
+Set an event callback.
+
+## raidar.once(event:String, callback:Function)
+
+Set an event callback that execute only one time.
+
+## Events
+
+List of possible events.
+
+### raidar.on('device', callback:Function)
+
+Generic ReadyNAS device response.
+This event fires with `callback(device)` where `device` is an instance of `ReadyNAS` class.
+
+### raidar.on(id:String, callback:Function)
+
+Specific device response callback where `id` is IP or Hostname or MAC address.
+This event fires with `callback(device)` where `device` is an instance of `ReadyNAS` class.
+
+### raidar.on('error', callback:Function)
+
+Generic Error.
+This event fires with `callback(err)` where `err` is an instance of `Error` class.
+
+### raidar.on('fail', callback:Function)
+
+Fail to parse response data.
+This event fires with `callback(msg, err)` where `msg` is the response buffer and `err` is an instance of `Error` class.
+
+# ReadyNAS class
+
+...
+
+## Property
+
+...
+
+## Methods
 
+...
 
-License: MIT
+# License: MIT

dumper.js

@@ -1,14 +1,14 @@
-var socket  = require('./libs/socket')
+var raidar  = require('./index')
   , path    = require('path')
   , fs      = require('fs');
 
 var folder = path.join(process.argv[2] || __dirname, 'dump');
 
-socket.on('error', function(err) {
+raidar.on('error', function(err) {
   console.log('ERROR', err);
 });
 
-socket.on('message', function(msg) {
+raidar.on('message', function(msg) {
   var id    = new Date().getTime()
     , file  = path.join(folder, id + '.readynas');
 
@@ -23,10 +23,10 @@ socket.on('message', function(msg) {
 console.log('Creating folder ' + folder + '...');
 
 fs.mkdir(folder, function(err) {
-  if (err)
-    console.log('ERROR', err);
-  else
-    socket.sendMagic();
+  if (!err) return raidar.request();
+
+  console.log('ERROR', err);
+  process.exit();
 });
 
 setTimeout(function() {

index.js

@@ -2,74 +2,149 @@
 // dependencies
 // #########################################################################
 
-var socket    = require('./libs/socket')
-  , ReadyNAS  = require('./libs/readynas')
-  , _         = require('lodash');
+var dgram         = require('dgram')
+  , EventEmitter  = require('events').EventEmitter
+  , _             = require('lodash')
+  , ReadyNAS      = require('./readynas');
 
 
 
 // #########################################################################
 // module vars
 // #########################################################################
 
-var _events = {};
+var _defaultOptions = {
+  socketType    : 'udp4',
+  portToListen  : 57877,
+  targetHost    : '255.255.255.255',
+  targetPort    : 22081,
+  magicPacket   : new Buffer('0000073e0000000100000000f8d496c3ffffffff0000001c00000000', 'hex')
+};
+
+var _socket   = null
+  , _options  = null
+  , _events   = new EventEmitter();
 
 
 
 // #########################################################################
 // utility functions
 // #########################################################################
 
-var notifyEvent = function() {
-  var args      = _.values(arguments)
-    , event     = args.shift()
-    , callback  = _events[event];
+var firstValueByType = function(obj, type) {
+  for (var i in obj) {
+    if (typeof obj[i] === type)
+      return obj[i];
+  }
+};
+
+var firstNumber = function(obj) {
+  return firstValueByType(obj, 'number');
+};
 
-  if (typeof callback !== 'function') return;
+var firstFunction = function(obj) {
+  return firstValueByType(obj, 'function');
+};
 
-  callback.apply(this, args);
+var firstObject = function(obj) {
+  return firstValueByType(obj, 'object');
 };
 
 
 
 // #########################################################################
-// socket settings
+// socket functions
 // #########################################################################
 
-socket.on('error', function(err) {
-  notifyEvent('error', err);
-});
 
-socket.on('message', function(msg) {
+var socketError = function(err) {
+  _events.emit('error', err);
+};
+
+var socketMessage = function(msg) {
+  _events.emit('message', msg);
+
   try {
     var device = new ReadyNAS(msg);
-
-    notifyEvent('device', device);
-    notifyEvent(device.ip, device);
-    notifyEvent(device.hostname, device);
-    notifyEvent(device.mac, device);
+    [ 'device', device.ip, device.hostname, device.mac ].forEach(function(e) {
+      _events.emit(e, device);
+    });
   } catch(e) {
-    notifyEvent('error', e);
+    _events.emit('fail', msg, e);
   }
-});
+};
+
+var openNewSocket = function() {
+  var options   = firstObject(arguments)
+    , callback  = firstFunction(arguments);
+
+  _options = _.extend(_.clone(_defaultOptions), options);
+
+  _socket = dgram.createSocket(_options.socketType);
+
+  _socket.on('error', socketError);
+  _socket.on('message', socketMessage);
 
-socket.open();
+  _socket.bind(_options.portToListen, function() {
+    _socket.setBroadcast(true);
+    if (callback) callback();
+  });
+};
+
+var closeSocket = function() {
+  if (_socket) _socket.close();
+  _socket = null;
+};
+
+var sendMagic = function() {
+  var callback = firstFunction(arguments);
+
+  var send = function() {
+    _socket.send(_options.magicPacket, 0, _options.magicPacket.length, _options.targetPort, _options.targetHost, function(err) {
+      if (callback) callback(err);
+    });
+  };
+
+  if (!_socket) openNewSocket(send); else send();
+};
 
 
 
 // #########################################################################
-// functions
+// exports
 // #########################################################################
 
-module.exports.options = function(options) {
-  socket.close();
-  socket.open(options);
+module.exports.on = function(event, callback) {
+  return _events.on(event, callback.bind(_events));
 };
 
-module.exports.sendMagic = function(options, callback) {
-  socket.sendMagic();
+module.exports.once = function(event, callback) {
+  return _events.once(event, callback.bind(_events));
 };
 
-module.exports.on = function(event, callback) {
-  _events[event] = callback;
+module.exports.open = openNewSocket;
+
+module.exports.close = closeSocket;
+
+module.exports.request = function() {
+  var timeout   = firstNumber(arguments)
+    , callback  = firstFunction(arguments)
+    , founded   = [];
+
+  if (!callback) return sendMagic();
+
+  var cbDevice = function(device) {
+    founded.push(device);
+  };
+
+  sendMagic(function(err) {
+    if (err) return callback(err);
+
+    _events.on('device', cbDevice);
+
+    setTimeout(function() {
+      _events.removeListener('device', cbDevice);
+      callback(null, founded);
+    }, timeout || 5000);
+  });
 };