updated README and package.json

fix to readynas.js

Author: greguz

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 .idea
-dump
+dump
+npm-debug.log

README.md

@@ -1,8 +1,14 @@
-# node-raidar: a node.js NetGear RADIar library
+# node-raidar: a node.js NetGear RAIDar library
 
 `node-raidar` is a simple to use NetGear RAIDar implementation for node.js.
 
-# Example
+## Installing
+
+```
+npm install --save raidar
+```
+
+## Get device list
 
 ``` js
 var raidar = require('raidar');
@@ -16,38 +22,51 @@ raidar.request(10000, function(err, devices) {
 });
 ```
 
-# Methods
+## Event definition
+
+``` js
+var raidar = require('raidar');
+
+// set event for particular device
+raidar.on('192.168.1.160', function(device) {
+    console.log('Response from:', device.ip, device.mac, device.hostname);
+});
+
+raidar.request();
+```
+
+## Methods
 
 ``` js
-var raidar = require('raidar')
+var raidar = require('raidar');
 ```
 
-## raidar.open(opt:Object, cb:Function)
+### raidar.open(opt:Object, cb:Function)
+
+Open or reset the UDP socket with given `opt` options and fire `cb` callback when socket is open. All arguments are optional.
 
-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()
+### raidar.close()
 
 Close UDP socket.
 
-## raidar.request(timeout:Number, callback:Function)
+### raidar.request(timeout:Number, callback:Function)
 
 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)
+### raidar.on(event:String, callback:Function)
 
 Set an event callback.
 
-## raidar.once(event:String, callback:Function)
+### raidar.once(event:String, callback:Function)
 
 Set an event callback that execute only one time.
 
@@ -75,18 +94,22 @@ This event fires with `callback(err)` where `err` is an instance of `Error` clas
 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
+## ReadyNAS class
 
-...
+It is the representation of a ReadyNAS device.
 
-## Property
+### device.ip()
 
-...
+Return device IP address.
 
-## Methods
+### device.hostname()
+
+Return Device Hostname.
+
+### device.mac()
 
-...
+Return device MAC address.
 
-# License
+## License
 
 MIT

package.json

@@ -25,6 +25,6 @@
   "keywords": [
     "netgear",
     "raidar",
-    "socket"
+    "readynas"
   ]
 }

readynas.js

@@ -5,19 +5,19 @@
 var ReadyNAS = function(buffer) {
   if (!buffer instanceof Buffer) throw new Error('RAIDar buffer message required!');
 
-  this.buffer   = buffer;
-  this.message  = buffer.toString('utf8');
+  this._buffer    = buffer;
+  this._message   = buffer.toString('utf8');
 
-  this.header   = null;
+  this._header    = null;
 
-  this.mac      = null;
-  this.hostname = null;
-  this.ip       = null;
+  this._mac       = null;
+  this._hostname  = null;
+  this._ip        = null;
 
-  this.info     = {};
-
-  this.init();
+  this._data      = {};
+  this._info      = {};
 
+  this._init();
   return this;
 };
 
@@ -27,52 +27,57 @@ var ReadyNAS = function(buffer) {
 // private
 // #########################################################################
 
-ReadyNAS.prototype.init = function() {
-  this.initHeaderInfo();
-  this.initBodyInfo();
-  this.initFooterInfo();
+ReadyNAS.prototype._init = function() {
+  this._initHeaderData();
+  this._initBodyData();
+  this._initFooterData();
 };
 
-ReadyNAS.prototype.initHeaderInfo = function() {
-  this.header = this.message.substr(0, 28);
+ReadyNAS.prototype._initHeaderData = function() {
+  this._header = this._message.substr(0, 28);
 
   var self      = this
-    , firstLine = this.message.substring(28, this.message.indexOf('\n'))
+    , firstLine = this._message.substring(28, this._message.indexOf('\n'))
     , firstInfo = firstLine.split('\t')
     , otherInfo = firstInfo.slice(3);
 
-  this.mac      = firstInfo[0];
-  this.hostname = firstInfo[1];
-  this.ip       = firstInfo[2];
+  this._mac       = firstInfo[0];
+  this._hostname  = firstInfo[1];
+  this._ip        = firstInfo[2];
 
-  otherInfo.forEach(function(info) {
-    self.parseInfo(info);
+  otherInfo.forEach(function(ini) {
+    var info = self._parseInfo(ini);
+    if (!self._data[info.name]) self._data[info.name] = [];
+    self._data[info.name].push(info);
   });
 };
 
-ReadyNAS.prototype.initBodyInfo = function() {
+ReadyNAS.prototype._initBodyData = function() {
   var self  = this
-    , lines = this.message.split('\n').slice(1);
+    , lines = this._message.split('\n').slice(1);
 
   lines.forEach(function(line) {
     if (line[0] === '\t') return;
-    self.parseInfo(line);
+
+    var info = self._parseInfo(line);
+    if (!self._data[info.name]) self._data[info.name] = [];
+    self._data[info.name].push(info);
   });
 };
 
-ReadyNAS.prototype.initFooterInfo = function() {
-
-  // TODO write footer data initialization
+ReadyNAS.prototype._initFooterData = function() {
+  var lines = this._message.split('\n')
+    , line  = lines[ lines.length - 2 ];
 
+  this._info = this._parseInfo(line.split('\t').join(''));
 };
 
-ReadyNAS.prototype.parseInfo = function(str) {
-  var arr     = str.split('!!')
-    , name    = arr[0]
-    , info    = { _info : arr[1] };
+ReadyNAS.prototype._parseInfo = function(str) {
+  var arr = str.trim().split('!!')
+    , res = { name: arr[0], _status : arr[1] };
 
-  if (!this.info[name]) this.info[name] = [];
-  if (!arr[2]) return this.info[name].push(info);
+  if (!arr[2])
+    return res;
 
   var otherInfo = arr[2].split('::');
 
@@ -82,13 +87,13 @@ ReadyNAS.prototype.parseInfo = function(str) {
       , value = arr[1];
 
     if (value) {
-      info[field] = value;
+      res[field] = value;
     } else {
-      info['_status'] = field;
+      res['_status'] = field;
     }
   });
 
-  return this.info[name].push(info);
+  return res;
 };
 
 
@@ -97,25 +102,16 @@ ReadyNAS.prototype.parseInfo = function(str) {
 // public
 // #########################################################################
 
-ReadyNAS.prototype.disk = function(index) {
-  if (!this.info['disk']) return;
-
-  if (typeof index === 'number')
-    return this.info['disk'][index];
-  else
-    return this.info['disk'];
+ReadyNAS.prototype.ip = function() {
+  return this._ip;
 };
 
-ReadyNAS.prototype.toJSON = function(string) {
-  var res = {
-    message   : this.message,
-    mac       : this.mac,
-    hostname  : this.hostname,
-    ip        : this.ip,
-    info      : this.info
-  };
+ReadyNAS.prototype.hostname = function() {
+  return this._hostname;
+};
 
-  return string === true ? JSON.stringify(res) : res;
+ReadyNAS.prototype.mac = function() {
+  return this._mac;
 };