add getIP()

Author: fengmk2

README.md

@@ -52,6 +52,13 @@ utils.datestruct(); // { YYYYMMDD: 20130416, H: 8 }
 
 // Safe encodeURIComponent and decodeURIComponent
 utils.decodeURIComponent(utils.encodeURIComponent('你好, nodejs')).should.equal('你好, nodejs');
+
+// get first ip
+utils.getIP(); // "10.7.68.72"
+utils.getIPv4(); // "10.7.68.72"
+utils.getIP('ppp'); // "10.2.0.231"
+
+utils.getIPv6(); // "fe80::cabc:c8ff:feef:f996"
 ```
 
 ## benchmark

lib/utility.js

@@ -10,6 +10,7 @@
  * Module dependencies.
  */
 
+var os = require('os');
 var crypto = require('crypto');
 
 /**
@@ -255,3 +256,40 @@ exports.datestruct = function (now) {
     H: now.getHours() 
   };
 };
+
+function _getIP(family, interfaceName) {
+  var interfaces = os.networkInterfaces();
+  interfaceName = interfaceName || 'en';
+  for (var i = 0; i < 8; i++) {
+    var items = interfaces[interfaceName + i];
+    var found = false;
+    if (items && items.length > 0) {
+      for (var j = 0; j < items.length; j++) {
+        var item = items[j];
+        if (item.family === family && !item.internal) {
+          return item.address;
+        }
+      }
+    }
+  }
+}
+
+/**
+ * Get current machine IPv4
+ *
+ * @param {String} [interfaceName] interface name, default is 'en'
+ * @return {String} IP address
+ */
+exports.getIP = exports.getIPv4 = function (interfaceName) {
+  return _getIP('IPv4', interfaceName);
+};
+
+/**
+ * Get current machine IPv6
+ *
+ * @param {String} [interfaceName] interface name, default is 'en'
+ * @return {String} IP address
+ */
+exports.getIPv6 = function (interfaceName) {
+  return _getIP('IPv6', interfaceName);
+};

package.json

@@ -13,6 +13,7 @@
   },
   "devDependencies": {
     "should": "*",
+    "mm": "*",
     "moment": "*",
     "blanket": "*",
     "travis-cov": "*",

test/utility.test.js

@@ -10,7 +10,9 @@
  * Module dependencies.
  */
 
+var os = require('os');
 var utils = require('../');
+var mm = require('mm');
 var should = require('should');
 var moment = require('moment');
 
@@ -170,4 +172,36 @@ Encode string s using a URL-safe alphabet, which substitutes - instead of + and
       }
     });
   });
+
+  describe('getIP(), getIPv6(), getIPv4()', function () {
+    it('should return ip version 4 address', function () {
+      var address = utils.getIP();
+      address.should.equal(utils.getIPv4());
+      address.should.match(/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/);
+    });
+
+    it('should return ip version 6 address', function () {
+      mm(os, 'networkInterfaces', function () {
+        return { lo0: 
+         [ { address: '::1', family: 'IPv6', internal: true },
+           { address: 'fe80::1', family: 'IPv6', internal: true },
+           { address: '127.0.0.1', family: 'IPv4', internal: true } ],
+        en0: 
+         [ { address: 'fe81::cabc:c8ff:feef:f996', family: 'IPv6',
+             internal: true },
+           { address: '10.0.1.123', family: 'IPv4', internal: false } ],
+        en7: 
+         [ { address: 'fe80::cabc:c8ff:feef:f996', family: 'IPv6',
+             internal: false },
+           { address: '10.0.1.123', family: 'IPv4', internal: false } ],
+        vmnet1: [ { address: '10.99.99.254', family: 'IPv4', internal: false } ],
+        vmnet8: [ { address: '10.88.88.1', family: 'IPv4', internal: false } ],
+        ppp0: [ { address: '10.2.0.231', family: 'IPv4', internal: false } ] 
+        };
+      });
+      var address = utils.getIPv6();
+      should.exists(address);
+      address.should.equal('fe80::cabc:c8ff:feef:f996');
+    });
+  });
 });