ip-monitor - npm Package Compare versions

Comparing version 0.1.2 to 1.0.0

examples/basic.js

 'use strict';
-var ipMon = require('../index');
+const IpMonitor = require('../index');
 
-var watcher = ipMon.createWatcher();
+const ipMonitor = new IpMonitor();
 
-watcher.on('IP:change', function (prevIP, newIP) {
-    console.log('Prev IP: %s, New IP: %s', prevIP, newIP);
+ipMonitor.on('change', (prevIp, newIp) => {
+    console.log(`IP changed from ${prevIp} to ${newIp}`);
 });
 
-/*
-Generic error event
-*/
-watcher.on('error', function (error) {
-    throw error;
-});
 
-/*
-Seperate event for ip error handling.
-It will fire when the connection has been lost, e.g your router is restarting,
-thats why you may want to handle it differently than other errors.
-*/
-watcher.on('IP:error', function (error) {
-    console.log('Cant get external IP: ' + error);
+ipMonitor.on('error', (error) => {
+    console.error(error);
 });
 
-watcher.on('IP:success', function (IP) {
-    console.log('Got IP: %s', IP);
-});
-
-
-watcher.start();
+ipMonitor.start();

examples/customConfig.js

 'use strict';
-var ipMon = require('../index');
+const IpMonitor = require('../index');
 
-var watcher = ipMon.createWatcher({
-    polling: 10000,
-    externalIP: {
+const ipMonitor = new IpMonitor({
+    pollingInterval: 36000,
+    verbose: true,
+    externalIp: {
         timeout: 1000,
         getIP: 'parallel',
         services: ['http://ifconfig.co/x-real-ip', 'http://icanhazip.com/'],
-        replace: true
+        replace: true,
+        verbose: true
     }
 });
 
-watcher.on('IP:change', function (prevIP, newIP) {
-    console.log('Prev IP: %s, New IP: %s', prevIP, newIP);
+ipMonitor.on('change', (prevIp, newIp) => {
+    console.log(`IP changed from ${prevIp} to ${newIp}`);
 });
 
-/*
-Generic error event
-*/
-watcher.on('error', function (error) {
-    throw error;
-});
 
-/*
-Seperate event for ip error handling.
-It will fire when the connection has been lost, e.g your router is restarting,
-thats why you may want to handle it differently than other errors.
-*/
-watcher.on('IP:error', function (error) {
-    console.log('Cant get external IP: ' + error);
+ipMonitor.on('error', (error) => {
+    console.error(error);
 });
 
-watcher.on('IP:success', function (IP) {
-    console.log('Got IP: %s', IP);
-});
-
-
-watcher.start();
+ipMonitor.start();

index.js

 'use strict';
-
-var Watcher = require('./lib/watcher').Watcher;
-var utils = require('./lib/utils');
-var extIP = require('external-ip');
-
-
-module.exports.createWatcher = function (extConfig) {
-    extConfig = extConfig || {};
-    var isValid = utils.validateConfig(extConfig);
-    if(isValid.errors.length) {
-        throw new Error(isValid.errors);
-    }
-
-    var defaultConfig = {
-        polling: 20000,
-        externalIP: {}
-    };
-
-    var config = utils.mergeConfig(extConfig, defaultConfig);
-    var getIP = extIP(config.externalIP);
-
-    return new Watcher(getIP, config);
-};
+module.exports = require('./lib/Watcher');

package.json

 {
   "name": "ip-monitor",
-  "version": "0.1.2",
+  "version": "1.0.0",
   "description": "A node.js library to monitor your external ip",
@@ -28,9 +28,8 @@ "main": "index.js",
   "dependencies": {
-    "external-ip": "^0.2.0",
-    "revalidator": "^0.2.0"
+    "external-ip": "^2.0.3"
   },
   "devDependencies": {
-    "chai": "^1.9.1",
-    "mocha": "^1.21.4"
+    "chai": "^4.1.2",
+    "mocha": "^5.0.4"
   }
 }

README.md

@@ -1,2 +0,5 @@
-#ip-monitor [![Build Status](https://travis-ci.org/J-Chaniotis/ip-monitor.svg)](https://travis-ci.org/J-Chaniotis/ip-monitor) [![Dependency Status](https://david-dm.org/j-Chaniotis/ip-monitor.svg)](https://david-dm.org/j-Chaniotis/ip-monitor)
+# ip-monitor
+[![Build Status](https://travis-ci.org/J-Chaniotis/ip-monitor.svg?branch=master)](https://travis-ci.org/J-Chaniotis/ip-monitor)
+[![dependencies Status](https://david-dm.org/j-Chaniotis/ip-monitor/status.svg)](https://david-dm.org/j-Chaniotis/ip-monitor)
+[![npm version](https://badge.fury.io/js/ip-monitor.svg)](https://badge.fury.io/js/ip-monitor)
 
@@ -8,3 +11,3 @@
 
-using [npm](https://www.npmjs.org/package/ip-monitor): `npm install ip-monitor`
+`npm install ip-monitor`
 
@@ -14,34 +17,16 @@ ## Usage
 ```javascript
-'use strict';
-var ipMon = require('ip-monitor');
+const IpMonitor = require('ip-monitor');
+const ipMonitor = new IpMonitor();
 
-var watcher = ipMon.createWatcher();
-
-watcher.on('IP:change', function (prevIP, newIP) {
-    console.log('Prev IP: %s, New IP: %s', prevIP, newIP);
+ipMonitor.on('change', (prevIp, newIp) => {
+    console.log(`IP changed from ${prevIp} to ${newIp}`);
 });
 
-/*
-Generic error event
-*/
-watcher.on('error', function (error) {
-    throw error;
+ipMonitor.on('error', (error) => {
+    console.error(error);
 });
 
-/*
-Seperate event for ip error handling.
-It will fire when the connection has been lost, e.g your router is restarting,
-thats why you may want to handle it differently than regular errors.
-*/
-watcher.on('IP:error', function (error) {
-    console.log('Cant get external IP: ' + error);
-});
+ipMonitor.start();
 
-watcher.on('IP:success', function (IP) {
-    console.log('Got IP: %s', IP);
-});
 
-
-watcher.start();
-
 ```
@@ -51,30 +36,42 @@
 ```javascript
-var watcher = ipMon.createWatcher({
-    polling: 10000,
-    externalIP: {
+const IpMonitor = require('ip-monitor');
+const ipMonitor = new IpMonitor({
+    pollingInterval: 36000,
+    verbose: true,
+    externalIp: {
         timeout: 1000,
         getIP: 'parallel',
         services: ['http://ifconfig.co/x-real-ip', 'http://icanhazip.com/'],
-        replace: true
+        replace: true,
+        verbose: true
     }
 });
+
+ipMonitor.on('change', (prevIp, newIp) => {
+    console.log(`IP changed from ${prevIp} to ${newIp}`);
+});
+
+ipMonitor.on('error', (error) => {
+    console.error(error);
+});
+
+ipMonitor.start();
 ```
 
-##API
 
-### Configuration
-`ipmon.createWatcher([config])` accepts a configuration object with the following optional properties:
-* <b>`polling: <Integer>`:</b> how often to poll for ip changes, default 20000ms
-* <b>`externalIP: <Object>`:</b> configuration passed directly to [`external-ip`](https://github.com/J-Chaniotis/external-ip/blob/master/README.md)
+## Configuration
+`new IpMonitor([config])` accepts a configuration object with the following optional properties:
+* <b>`pollingInterval: <Integer>`:</b> how often to poll for ip changes, default 1 day
+* <b>`externalIp: <Object>`:</b> configuration passed directly to [`external-ip`](https://github.com/J-Chaniotis/external-ip/blob/master/README.md)
 
-### Methods
+## Methods
 * <b>`.start()`:</b> start watching
 * <b>`.stop()`:</b> stop watching
 * <b>`.poll()`:</b> poll for ip manually
-* <b>`.isWatching()`:</b> check if ip-monitor has started
 
-### Events
-* <b>`IP:success` :</b> fired every time `.poll()` yields an ip
-* <b>`IP:error`:</b> fired when `.poll()` encounters an error, usually if the connection is down
-* <b>`IP:change`:</b> fired when the external ip has changed. it will also fire the first time `.start()` or `.poll()` are invoked.
+## Events
+* <b>`change`:</b> fired when the external ip has changed. it will also fire the first time `.start()` or `.poll()` are invoked.
 * <b>`error`:</b> typical error handling here
+
+## Test
+Change your working directory to the project's root, `npm install` to get the development dependencies and then `npm test`

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Dependency count

1

-50%

Number of low quality alerts

0

-100%

Worsened metrics

Total package byte prevSize

8094

-38.31%

Number of package files

9

-25%

Lines of code

172

-38.79%

Number of lines in readme file

74

-5.13%

Number of medium supply chain risk alerts

2

Infinity%

Dependency changes

• + Added

  commander@5.1.0
  (transitive)

• + Added

  decompress-response@4.2.1
  (transitive)

• + Added

  external-ip@2.3.1
  (transitive)

• + Added

  mimic-response@2.1.0
  (transitive)

• + Added

  once@1.4.0
  (transitive)

• + Added

  simple-concat@1.0.1
  (transitive)

• + Added

  simple-get@3.1.1
  (transitive)

• + Added

  wrappy@1.0.2
  (transitive)

• - Removed

  revalidator@^0.2.0

• - Removed

  asn1@0.2.6
  (transitive)

• - Removed

  assert-plus@1.0.0
  (transitive)

• - Removed

  asynckit@0.4.0
  (transitive)

• - Removed

  aws-sign2@0.7.0
  (transitive)

• - Removed

  aws4@1.13.2
  (transitive)

• - Removed

  bcrypt-pbkdf@1.0.2
  (transitive)

• - Removed

  caseless@0.12.0
  (transitive)

• - Removed

  combined-stream@1.0.8
  (transitive)

• - Removed

  commander@2.20.3
  (transitive)

• - Removed

  core-util-is@1.0.2
  (transitive)

• - Removed

  dashdash@1.14.1
  (transitive)

• - Removed

  delayed-stream@1.0.0
  (transitive)

• - Removed

  ecc-jsbn@0.1.2
  (transitive)

• - Removed

  evented-async-loop@0.1.1
  (transitive)

• - Removed

  extend@3.0.2
  (transitive)

• - Removed

  external-ip@0.2.4
  (transitive)

• - Removed

  extsprintf@1.3.0
  (transitive)

• - Removed

  forever-agent@0.6.1
  (transitive)

• - Removed

  form-data@2.3.3
  (transitive)

• - Removed

  getpass@0.1.7
  (transitive)

• - Removed

  har-schema@2.0.0
  (transitive)

• - Removed

  har-validator@5.1.5
  (transitive)

• - Removed

  http-signature@1.2.0
  (transitive)

• - Removed

  is-typedarray@1.0.0
  (transitive)

• - Removed

  isstream@0.1.2
  (transitive)

• - Removed

  jsbn@0.1.1
  (transitive)

• - Removed

  json-schema@0.4.0
  (transitive)

• - Removed

  json-stringify-safe@5.0.1
  (transitive)

• - Removed

  jsprim@1.4.2
  (transitive)

• - Removed

  mime-db@1.52.0
  (transitive)

• - Removed

  mime-types@2.1.35
  (transitive)

• - Removed

  oauth-sign@0.9.0
  (transitive)

• - Removed

  performance-now@2.1.0
  (transitive)

• - Removed

  psl@1.15.0
  (transitive)

• - Removed

  qs@6.5.3
  (transitive)

• - Removed

  request@2.88.2
  (transitive)

• - Removed

  revalidator@0.2.00.3.1
  (transitive)

• - Removed

  safe-buffer@5.2.1
  (transitive)

• - Removed

  safer-buffer@2.1.2
  (transitive)

• - Removed

  sshpk@1.18.0
  (transitive)

• - Removed

  tough-cookie@2.5.0
  (transitive)

• - Removed

  tunnel-agent@0.6.0
  (transitive)

• - Removed

  tweetnacl@0.14.5
  (transitive)

• - Removed

  uuid@3.4.0
  (transitive)

• - Removed

  verror@1.10.0
  (transitive)

• Updated

  external-ip@^2.0.3