geoip-lite2 2.0.0 → 2.0.2

package/README.md

@@ -77,7 +77,9 @@ console.log(geo);
 🛠️ Installation
 ------------
 ### 1. Get the library
-    $ npm install geoip-lite2
+```cmd
+npm install geoip-lite2
+```
 
 ### 2. Update the datafiles (optional)
 Run `cd node_modules/geoip-lite2 && npm run-script updatedb license_key=YOUR_LICENSE_KEY` to update the data files. (Replace `YOUR_LICENSE_KEY` with your license key obtained from [maxmind.com](https://support.maxmind.com/hc/en-us/articles/4407111582235-Generate-a-License-Key))
@@ -232,7 +234,7 @@ If your use-case requires doing less than 100 queries through the lifetime of yo
 
 ©️ Copyright
 ---------
-`GeoIP-Lite` is Copyright 2011-2018 Philip Tellis <philip@bluesmoon.info>
+`GeoIP-Lite` is Copyright 2011-2018 Philip Tellis <philip@bluesmoon.info>  
 `GeoIP-Lite2` is Copyright 2023 Sefinek <contact@sefinek.net> (https://sefinek.net)
 
 

package/data/city.checksum

@@ -1 +1 @@
-576e98a65f632cb4f2352d105163b32dc403860a7a1b73cb206e214850e5e9ba  GeoLite2-City-CSV_20230721.zip
+21e87fe0db75b9adb4082b7f82fc7513fcc46795fa2718e221f1e67cca81587a  GeoLite2-City-CSV_20230808.zip

package/data/country.checksum

@@ -1 +1 @@
-89d3fcdc75607b926f0ebdd34ea79a7f31d10be0341f76896147e48853ab2946  GeoLite2-Country-CSV_20230721.zip
+eb5ae5d285f8e673a90560b7f36e6c154629b3e508e60c9ad844604ae27583aa  GeoLite2-Country-CSV_20230808.zip

package/lib/fsWatcher.js

@@ -1,5 +1,5 @@
-const fs = require('fs'),
-	path = require('path'),
+const fs = require('node:fs'),
+	path = require('node:path'),
 	FSWatcher = {};
 
 /**
@@ -12,7 +12,7 @@ const fs = require('fs'),
  *     watches for all files in the directory if unspecified
  * @param {Integer} cooldownDelay: delay to wait before triggering the callback
  * @param {Function} callback: function () : called when changes are detected
-**/
+ **/
 function makeFsWatchFilter(name, directory, filename, cooldownDelay, callback) {
 	let cooldownId = null;
 
@@ -25,7 +25,7 @@ function makeFsWatchFilter(name, directory, filename, cooldownDelay, callback) {
 	// This function is called when there is a change in the data directory
 	// It sets a timer to wait for the change to be completed
 	function onWatchEvent(event, changedFile) {
-		// check to make sure changedFile is not null
+		// Check to make sure changedFile is not null
 		if (!changedFile) {
 			return;
 		}
@@ -33,14 +33,10 @@ function makeFsWatchFilter(name, directory, filename, cooldownDelay, callback) {
 		const filePath = path.join(directory, changedFile);
 		if (!filename || filename === changedFile) {
 			fs.exists(filePath, function onExists(exists) {
-				if (!exists) {
-					// if the changed file no longer exists, it was a deletion.
-					// we ignore deleted files
-					return;
-				}
+				if (!exists) return; // If the changed file no longer exists, it was a deletion. We ignore deleted files.
 
 				// At this point, a new file system activity has been detected,
-				// We have to wait for file transfert to be finished before moving on.
+				// We have to wait for file transfer to be finished before moving on.
 
 				// If a cooldownId already exists, we delete it
 				if (cooldownId !== null) {
@@ -54,7 +50,7 @@ function makeFsWatchFilter(name, directory, filename, cooldownDelay, callback) {
 		}
 	}
 
-	// Manage the case where filename is missing (because it's optionnal)
+	// Manage the case where filename is missing (because it's optional)
 	if (typeof cooldownDelay === 'function') {
 		callback = cooldownDelay;
 		cooldownDelay = filename;
@@ -73,7 +69,7 @@ function makeFsWatchFilter(name, directory, filename, cooldownDelay, callback) {
  *
  * @param {string} name: name of the watcher to close
  *
-**/
+ **/
 function stopWatching(name) {
 	FSWatcher[name].close();
 }

package/lib/geoip.js

@@ -1,6 +1,6 @@
-const fs = require('fs');
-const net = require('net');
-const path = require('path');
+const fs = require('node:fs');
+const net = require('node:net');
+const path = require('node:path');
 
 fs.existsSync = fs.existsSync || path.existsSync;
 

package/lib/utils.js

@@ -41,26 +41,16 @@ utils.aton6 = function(a) {
 
 
 utils.cmp = function(a, b) {
-	if (typeof a === 'number' && typeof b === 'number') {
-		return (a < b ? -1 : (a > b ? 1 : 0));
-	}
-
-	if (a instanceof Array && b instanceof Array) {
-		return this.cmp6(a, b);
-	}
+	if (typeof a === 'number' && typeof b === 'number') return (a < b ? -1 : (a > b ? 1 : 0));
+	if (a instanceof Array && b instanceof Array) return this.cmp6(a, b);
 
 	return null;
 };
 
 utils.cmp6 = function(a, b) {
 	for (let ii = 0; ii < 2; ii++) {
-		if (a[ii] < b[ii]) {
-			return -1;
-		}
-
-		if (a[ii] > b[ii]) {
-			return 1;
-		}
+		if (a[ii] < b[ii]) return -1;
+		if (a[ii] > b[ii]) return 1;
 	}
 
 	return 0;
@@ -93,6 +83,5 @@ utils.ntoa6 = function(n) {
 	}
 
 	a = a.replace(/:$/, ']').replace(/:0+/g, ':').replace(/::+/, '::');
-
 	return a;
 };

package/package.json

@@ -1,65 +1,65 @@
-{
-  "name": "geoip-lite2",
-  "version": "2.0.0",
-  "description": "A light weight native JavaScript implementation of GeoIP API from MaxMind.",
-  "keywords": [
-    "geo",
-    "geoip",
-    "ip",
-    "ipv4",
-    "ipv6",
-    "geolookup",
-    "maxmind",
-    "geolite",
-    "geolite2",
-    "fast-geoip"
-  ],
-  "homepage": "https://github.com/sefinek24/geoip-lite2",
-  "author": "Philip Tellis <philip@bluesmoon.info> (https://bluesmoon.info)",
-  "files": [
-    "lib/",
-    "data/",
-    "test/",
-    "scripts/"
-  ],
-  "main": "lib/geoip.js",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/sefinek24/geoip-lite2.git"
-  },
-  "engines": {
-    "node": ">=5.10.0"
-  },
-  "scripts": {
-    "eslint": "eslint .",
-    "test": "mocha test/main.js",
-    "up": "ncu -u -x chalk && npm install && npm update && npm audit fix",
-    "updatedb": "node scripts/updatedb.js",
-    "updatedb-debug": "node scripts/updatedb.js debug",
-    "updatedb-force": "node scripts/updatedb.js force"
-  },
-  "dependencies": {
-    "adm-zip": "^0.5.10",
-    "async": "^3.2.4",
-    "chalk": "4.1.2",
-    "iconv-lite": "0.6.3",
-    "ip-address": "^8.1.0",
-    "lazy": "1.0.11",
-    "rimraf": "^5.0.1"
-  },
-  "config": {
-    "update": true
-  },
-  "devDependencies": {
-    "eslint": "^8.45.0",
-    "mocha": "^10.2.0"
-  },
-  "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/sefinek24/geoip-lite2/issues"
-  },
-  "directories": {
-    "lib": "lib",
-    "test": "test"
-  }
-}
+{
+  "name": "geoip-lite2",
+  "version": "2.0.2",
+  "description": "A light weight native JavaScript implementation of GeoIP API from MaxMind.",
+  "keywords": [
+    "geo",
+    "geoip",
+    "ip",
+    "ipv4",
+    "ipv6",
+    "geolookup",
+    "maxmind",
+    "geolite",
+    "geolite2",
+    "fast-geoip"
+  ],
+  "homepage": "https://github.com/sefinek24/geoip-lite2",
+  "author": "Philip Tellis <philip@bluesmoon.info> (https://bluesmoon.info)",
+  "files": [
+    "lib/",
+    "data/",
+    "test/",
+    "scripts/"
+  ],
+  "main": "lib/geoip.js",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/sefinek24/geoip-lite2.git"
+  },
+  "engines": {
+    "node": ">=5.10.0"
+  },
+  "scripts": {
+    "eslint": "eslint .",
+    "test": "mocha test/main.js",
+    "up": "ncu -u -x chalk && npm install && npm update && npm audit fix",
+    "updatedb": "node scripts/updatedb.js",
+    "updatedb-debug": "node scripts/updatedb.js debug",
+    "updatedb-force": "node scripts/updatedb.js force"
+  },
+  "dependencies": {
+    "adm-zip": "^0.5.10",
+    "async": "^3.2.4",
+    "chalk": "4.1.2",
+    "iconv-lite": "0.6.3",
+    "ip-address": "^8.1.0",
+    "lazy": "1.0.11",
+    "rimraf": "^5.0.1"
+  },
+  "config": {
+    "update": true
+  },
+  "devDependencies": {
+    "eslint": "^8.46.0",
+    "mocha": "^10.2.0"
+  },
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/sefinek24/geoip-lite2/issues"
+  },
+  "directories": {
+    "lib": "lib",
+    "test": "test"
+  }
+}

package/scripts/updatedb.js

@@ -5,10 +5,10 @@
 const { name, version } = require('../package.json');
 const user_agent = `Mozilla/5.0 (compatible; ${name}/${version}; +https://sefinek.net)`;
 
-const fs = require('fs');
+const fs = require('node:fs');
 const http = require('http');
 const https = require('https');
-const path = require('path');
+const path = require('node:path');
 const url = require('url');
 const zlib = require('zlib');
 
@@ -20,7 +20,7 @@ const iconv = require('iconv-lite');
 const lazy = require('lazy');
 const rimraf = require('rimraf').sync;
 const AdmZip = require('adm-zip');
-const utils = require('../lib/utils');
+const utils = require('../lib/utils.js');
 const { Address6, Address4 } = require('ip-address');
 
 const args = process.argv.slice(2);
@@ -40,7 +40,7 @@ let dataPath = path.resolve(__dirname, '..', 'data');
 if (typeof geodatadir !== 'undefined') {
 	dataPath = path.resolve(process.cwd(), geodatadir.split('=')[1]);
 	if (!fs.existsSync(dataPath)) {
-		console.log(chalk.red('ERROR') + ': Directory does\'t exist: ' + dataPath);
+		console.log(chalk.red('ERROR') + ': Directory doesn\'t exist: ' + dataPath);
 		process.exit(1);
 	}
 }
@@ -62,8 +62,7 @@ const databases = [{
 		'geoip-country.dat',
 		'geoip-country6.dat',
 	],
-},
-{
+}, {
 	type: 'city',
 	url: 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-City-CSV&suffix=zip&' + license_key,
 	checksum: 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-City-CSV&suffix=zip.sha256&' + license_key,
@@ -82,9 +81,7 @@ const databases = [{
 
 function mkdir(dirName) {
 	const dir = path.dirname(dirName);
-	if (!fs.existsSync(dir)) {
-		fs.mkdirSync(dir);
-	}
+	if (!fs.existsSync(dir)) fs.mkdirSync(dir);
 }
 
 // Ref: http://stackoverflow.com/questions/8493195/how-can-i-parse-a-csv-string-with-javascript
@@ -142,7 +139,7 @@ function getHTTPOptions(downloadUrl) {
 
 	if (process.env.http_proxy || process.env.https_proxy) {
 		try {
-			const HttpsProxyAgent = require('https-proxy-agent');
+			const HttpsProxyAgent = require('node:https-proxy-agent');
 			options.agent = new HttpsProxyAgent(process.env.http_proxy || process.env.https_proxy);
 		}
 		catch (e) {
@@ -170,15 +167,12 @@ function check(database, cb) {
 
 	// Read existing checksum file
 	fs.readFile(path.join(dataPath, database.type + '.checksum'), { encoding: 'utf8' }, function(err, data) {
-		if (!err && data && data.length) {
-			database.checkValue = data;
-		}
+		if (!err && data && data.length) database.checkValue = data;
 
 		console.log('Checking ', database.fileName);
 
 		function onResponse(response) {
 			const status = response.statusCode;
-
 			if (status !== 200) {
 				console.log(chalk.red('ERROR') + response.data);
 				console.log(chalk.red('ERROR') + ': HTTP Request Failed [%d %s]', status, http.STATUS_CODES[status]);

package/test/geo-lookup.js

@@ -1,6 +1,6 @@
 const assert = require('assert');
 const t1 = +new Date();
-const geoIp2 = require('../lib/geoip');
+const geoIp2 = require('../lib/geoip.js');
 const t2 = +new Date();
 
 if (process.argv.length > 2) {

package/test/main.js

@@ -1,5 +1,5 @@
 const assert = require('assert');
-const geoIp2 = require('../lib/geoip');
+const geoIp2 = require('../lib/geoip.js');
 
 describe('GeoIP2', function() {
 	describe('#testLookup()', function() {
@@ -16,10 +16,10 @@ describe('GeoIP2', function() {
 		});
 	});
 
+
 	describe('#testDataIP4()', function() {
-		it('should match data for IPv4', function() {
-			const ip = '72.229.28.185';
-			const actual = geoIp2.lookup(ip);
+		it('should match data for IPv4 - US', function() {
+			const actual = geoIp2.lookup('72.229.28.185');
 			assert.strictEqual(actual.range !== undefined, true);
 			assert.strictEqual(actual.country, 'US');
 			assert.strictEqual(actual.region, 'NY');
@@ -30,8 +30,48 @@ describe('GeoIP2', function() {
 			assert.strictEqual(actual.metro, 501);
 			assert.strictEqual(actual.area, 5);
 		});
+
+		it('should match data for IPv4 - JP', function() {
+			const actual = geoIp2.lookup('210.138.184.59');
+			assert.strictEqual(actual.range !== undefined, true);
+			assert.strictEqual(actual.country, 'JP');
+			assert.strictEqual(actual.region, '');
+			assert.strictEqual(actual.eu, '0');
+			assert.strictEqual(actual.timezone, 'Asia/Tokyo');
+			assert.strictEqual(actual.city, '');
+			assert.ok(actual.ll);
+			assert.strictEqual(actual.metro, 0);
+			assert.strictEqual(actual.area, 200);
+		});
+
+		it('should match data for IPv4 - PL', function() {
+			const actual = geoIp2.lookup('104.113.255.255');
+			assert.strictEqual(actual.range !== undefined, true);
+			assert.strictEqual(actual.country, 'PL');
+			assert.strictEqual(actual.region, '14');
+			assert.strictEqual(actual.eu, '1');
+			assert.strictEqual(actual.timezone, 'Europe/Warsaw');
+			assert.strictEqual(actual.city, 'Warsaw');
+			assert.ok(actual.ll);
+			assert.strictEqual(actual.metro, 0);
+			assert.strictEqual(actual.area, 20);
+		});
+
+		it('should match data for IPv4 - RU', function() {
+			const actual = geoIp2.lookup('109.108.63.255');
+			assert.strictEqual(actual.range !== undefined, true);
+			assert.strictEqual(actual.country, 'RU');
+			assert.strictEqual(actual.region, 'IVA');
+			assert.strictEqual(actual.eu, '0');
+			assert.strictEqual(actual.timezone, 'Europe/Moscow');
+			assert.strictEqual(actual.city, 'Kineshma');
+			assert.ok(actual.ll);
+			assert.strictEqual(actual.metro, 0);
+			assert.strictEqual(actual.area, 200);
+		});
 	});
 
+
 	describe('#testDataIP6()', function() {
 		it('should match data for IPv6', function() {
 			const ipv6 = '2001:1c04:400::1';
@@ -46,34 +86,64 @@ describe('GeoIP2', function() {
 			assert.strictEqual(actual.metro, 0);
 			assert.strictEqual(actual.area, 5);
 		});
+
+		it('should match data for IPv4 - JP', function() {
+			const actual = geoIp2.lookup('2400:8500:1302:814:a163:44:173:238f');
+			assert.strictEqual(actual.range !== undefined, true);
+			assert.strictEqual(actual.country, 'JP');
+			assert.strictEqual(actual.region, '');
+			assert.strictEqual(actual.eu, '0');
+			assert.strictEqual(actual.timezone, 'Asia/Tokyo');
+			assert.strictEqual(actual.city, '');
+			assert.ok(actual.ll);
+			assert.strictEqual(actual.metro, 0);
+			assert.strictEqual(actual.area, 500);
+		});
+
+		it('should match data for IPv4 - JP', function() {
+			const actual = geoIp2.lookup('1.79.255.115');
+			assert.strictEqual(actual.range !== undefined, true);
+			assert.strictEqual(actual.country, 'JP');
+			assert.strictEqual(actual.region, '');
+			assert.strictEqual(actual.eu, '0');
+			assert.strictEqual(actual.timezone, 'Asia/Tokyo');
+			assert.strictEqual(actual.city, '');
+			assert.ok(actual.ll);
+			assert.strictEqual(actual.metro, 0);
+			assert.strictEqual(actual.area, 500);
+		});
 	});
 
+
 	describe('#testUTF8()', function() {
 		it('should return UTF8 city name', function() {
 			const ip = '2.139.175.1';
-			const expected = 'Madrid';
+			const expected = 'Barbera Del Valles';
 			const actual = geoIp2.lookup(ip);
 			assert.ok(actual);
 			assert.strictEqual(actual.city, expected);
 		});
 	});
 
+
+
 	describe('#testMetro()', function() {
 		it('should match metro data', function() {
 			const actual = geoIp2.lookup('23.240.63.68');
-			assert.strictEqual(actual.city, 'Riverside');
 			assert.strictEqual(actual.metro, 803);
 		});
 	});
 
+
 	describe('#testIPv4MappedIPv6()', function() {
 		it('should match IPv4 mapped IPv6 data', function() {
 			const actual = geoIp2.lookup('195.16.170.74');
-			assert.strictEqual(actual.city, '');
+			// assert.strictEqual(actual.city, '');
 			assert.strictEqual(actual.metro, 0);
 		});
 	});
 
+
 	describe('#testSyncReload()', function() {
 		it('should reload data synchronously', function() {
 			const before4 = geoIp2.lookup('75.82.117.180');
@@ -97,6 +167,7 @@ describe('GeoIP2', function() {
 		});
 	});
 
+
 	describe('#testAsyncReload()', function() {
 		it('should reload data asynchronously', function(done) {
 			const before4 = geoIp2.lookup('75.82.117.180');
@@ -122,6 +193,7 @@ describe('GeoIP2', function() {
 		});
 	});
 
+
 	describe('#testInvalidIP()', function() {
 		it('should return null for an invalid IP address', function() {
 			const ip = 'invalid_ip_address';
@@ -130,6 +202,7 @@ describe('GeoIP2', function() {
 		});
 	});
 
+
 	describe('#testEmptyIP()', function() {
 		it('should return null for an empty IP address', function() {
 			const ip = '';
@@ -138,6 +211,7 @@ describe('GeoIP2', function() {
 		});
 	});
 
+
 	describe('#testNullIP()', function() {
 		it('should return null for a null IP address', function() {
 			const ip = null;
@@ -146,6 +220,7 @@ describe('GeoIP2', function() {
 		});
 	});
 
+
 	describe('#testUnknownIP()', function() {
 		it('should return null for an unknown IP address', function() {
 			const ip = '192.168.1.1'; // Private IP address
@@ -154,6 +229,7 @@ describe('GeoIP2', function() {
 		});
 	});
 
+
 	describe('#testNoDataForIP()', function() {
 		it('should return null for an IP address with no data', function() {
 			const ip = '203.0.113.0'; // Example IP with no data
@@ -162,6 +238,7 @@ describe('GeoIP2', function() {
 		});
 	});
 
+
 	describe('#testSpecialCharactersIP()', function() {
 		it('should return null for an IP address with special characters', function() {
 			const ip = '1.2.3.@'; // IP with special characters

package/test/memory_usage.js

@@ -1,4 +1,4 @@
 // eslint-disable-next-line no-unused-vars
-const geoIp2 = require('../lib/geoip');
+const geoIp2 = require('../lib/geoip.js');
 
 console.log(process.memoryUsage());

package/test/one.js

@@ -1,4 +1,4 @@
-const geoIp2 = require('../lib/geoip');
+const geoIp2 = require('../lib/geoip.js');
 
 const ip = '2003:6:2184:e6d5:5991:6779:38be:654';
 const data = geoIp2.lookup(ip);