@k03mad/ip2geo 2.1.0 → 2.3.0

package/README.md

@@ -4,6 +4,28 @@
 — Runtime cache \
 — Filesystem infinity cache
 
+## Global
+
+```bash
+npm i @k03mad/ip2geo -g
+
+ip2geo 1.1.1.1
+# {
+#   ip: '1.1.1.1',
+#   emoji: '🇺🇸',
+#   country: 'United States',
+#   countryA2: 'US',
+#   region: 'District of Columbia',
+#   city: 'Washington',
+#   org: 'APNIC and Cloudflare DNS Resolver project',
+#   isp: 'Cloudflare, Inc.',
+#   ispDomain: 'cloudflare.com'
+# }
+
+ip2geo 1.1.1.1 --json
+# {"ip":"1.1.1.1","emoji":"🇺🇸","country":"United States","countryA2":"US","region":"District of Columbia","city":"Washington","org":"APNIC and Cloudflare DNS Resolver project","isp":"Cloudflare, Inc.","ispDomain":"cloudflare.com"}
+```
+
 ## API
 
 ```bash
@@ -14,14 +36,7 @@ echo .geoip >> .gitignore
 ```js
 import {ip2geo} from '@k03mad/ip2geo';
 
-const {
-    ip,
-    emoji,
-    country,
-    countryA2,
-    city,
-    isp,
-} = await ip2geo('1.1.1.1', {
+const info = await ip2geo('1.1.1.1', {
     // defaults
     cacheDir: '.geoip',
     cacheFileName: 'ips.log',
@@ -29,10 +44,15 @@ const {
     cacheFileNewline: '\n',
 });
 
-// ip: "1.1.1.1"
-// emoji: "🇺🇸"
-// country: "United States"
-// countryA2: "US"
-// city: "Washington"
-// isp: "Cloudflare, Inc."
+// info {
+//   ip: '1.1.1.1',
+//   emoji: '🇺🇸',
+//   country: 'United States',
+//   countryA2: 'US',
+//   region: 'District of Columbia',
+//   city: 'Washington',
+//   org: 'APNIC and Cloudflare DNS Resolver project',
+//   isp: 'Cloudflare, Inc.',
+//   ispDomain: 'cloudflare.com'
+// }
 ```

package/app/cli.js

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+
+import os from 'node:os';
+import path from 'node:path';
+
+import {codeText, errorText, nameText} from './helpers/colors.js';
+import {log, throwError} from './helpers/logging.js';
+
+import {ip2geo} from './index.js';
+
+const jsonParam = '--json';
+
+let args = process.argv.slice(2);
+
+if (args.length === 0) {
+    const prefix = codeText('$');
+    const name = nameText('ip2geo');
+
+    throwError([
+        errorText('IP(s) should be passed as args'),
+        '',
+        `${prefix} ${name} 1.1.1.1`,
+        `${prefix} ${name} 1.1.1.1 8.8.8.8`,
+    ]);
+}
+
+let json;
+
+if (args.includes(jsonParam)) {
+    json = true;
+    args = args.filter(elem => elem !== jsonParam);
+}
+
+await Promise.all(args.map(async arg => {
+    const output = await ip2geo(arg, {
+        cacheDir: path.join(os.tmpdir(), '.ip2geo'),
+    });
+
+    if (json) {
+        return log(JSON.stringify(output));
+    }
+
+    log(output);
+}));

package/app/helpers/array.js

@@ -0,0 +1,5 @@
+/**
+ * @param {any|any[]} elem
+ * @returns {any[]}
+ */
+export const convertToArray = elem => Array.isArray(elem) ? elem : [elem];

package/app/helpers/colors.js

@@ -0,0 +1,6 @@
+import chalk from 'chalk';
+
+export const errorText = chalk.red.bold.bgGray;
+export const codeText = chalk.gray;
+export const numText = chalk.blue;
+export const nameText = chalk.magenta;

package/app/helpers/logging.js

@@ -0,0 +1,26 @@
+/* eslint-disable no-console */
+
+import {convertToArray} from './array.js';
+
+/**
+ * @param {any|any[]} msg
+ * @returns {void}
+ */
+export const log = msg => convertToArray(msg)
+    .forEach(elem => console.log(elem));
+
+/**
+ * @param {any|any[]} msg
+ * @returns {void}
+ */
+export const logError = msg => convertToArray(msg)
+    .forEach(elem => console.error(elem));
+
+/**
+ * @param {any|any[]} msg
+ * @returns {void}
+ */
+export const throwError = msg => {
+    logError(msg);
+    process.exit(1);
+};

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@k03mad/ip2geo",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "GeoIP library",
   "maintainers": [
     "Kirill Molchanov <k03.mad@gmail.com"
   ],
+  "bin": {
+    "ip2geo": "app/cli.js"
+  },
   "main": "app/index.js",
   "repository": {
     "type": "git",
@@ -17,17 +20,19 @@
   },
   "dependencies": {
     "@k03mad/request": "5.4.1",
+    "chalk": "5.3.0",
     "debug": "4.3.4"
   },
   "devDependencies": {
     "@k03mad/eslint-config": "19.2.0",
     "eslint": "8.56.0",
-    "husky": "8.0.3"
+    "husky": "8.0.3",
+    "mocha": "10.2.0"
   },
   "scripts": {
     "lint": "npm run lint:eslint",
     "lint:eslint": "eslint ./ --cache",
-    "test": "node --test tests/*",
+    "test": "mocha tests",
     "clean": "npm run clean:modules && npm run clean:eslint:cache",
     "clean:modules": "rm -rf ./node_modules || true",
     "clean:eslint:cache": "rm -rf .eslintcache || true",

package/tests/helpers/path.js

@@ -5,3 +5,9 @@ import path from 'node:path';
  * @returns {string}
  */
 export const getCurrentFilename = file => path.basename(file, '.js');
+
+/**
+ * @param {string} file
+ * @returns {string}
+ */
+export const getTestFolder = file => path.join('.geoipCustom', file);

package/tests/opts-assigned-ipv6.js

@@ -0,0 +1,51 @@
+import assert from 'node:assert/strict';
+
+import {describe, it} from 'mocha';
+
+import {ip2geo} from '../app/index.js';
+
+import {getCurrentFilename, getTestFolder} from './helpers/path.js';
+import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
+
+const testName = getCurrentFilename(import.meta.url);
+
+describe(testName, () => {
+    const CACHE_FILE_DIR = getTestFolder(testName);
+    const CACHE_FILE_NAME = 'ips.log';
+    const CACHE_FILE_SEPARATOR = ';;';
+    const CACHE_FILE_NEWLINE = '\n';
+
+    const REQUEST_IP = '2a00:dd80:40:100::';
+
+    const cacheFile = `${REQUEST_IP.split(/\.|:/)[0]}_${CACHE_FILE_NAME}`;
+
+    const response = {
+        ip: REQUEST_IP,
+        emoji: '🇳🇱',
+        country: 'Netherlands',
+        countryA2: 'NL',
+        region: 'North Holland',
+        city: 'Amsterdam',
+        org: '',
+        isp: 'NetActuate Inc',
+        ispDomain: '',
+    };
+
+    it('should remove fs cache dir if exist', () => removeCacheFolder(CACHE_FILE_DIR));
+
+    it(`should return correct response for IP: "${REQUEST_IP}"`, async () => {
+        const data = await ip2geo(REQUEST_IP, {
+            cacheDir: CACHE_FILE_DIR,
+        });
+
+        assert.deepEqual(data, response);
+    });
+
+    it('should have cache file', () => checkCacheFile(
+        CACHE_FILE_DIR,
+        cacheFile,
+        CACHE_FILE_SEPARATOR,
+        CACHE_FILE_NEWLINE,
+        response,
+    ));
+});

package/tests/opts-assigned-subfolder.js

@@ -0,0 +1,58 @@
+import assert from 'node:assert/strict';
+import path from 'node:path';
+
+import {describe, it} from 'mocha';
+
+import {ip2geo} from '../app/index.js';
+
+import {getCurrentFilename, getTestFolder} from './helpers/path.js';
+import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
+
+const testName = getCurrentFilename(import.meta.url);
+const SUBFOLDERS = 5;
+
+describe(testName, () => {
+    const CACHE_FILE_DIR = getTestFolder(
+        path.join(
+            ...Array.from({length: SUBFOLDERS}, () => testName),
+        ),
+    );
+
+    const CACHE_FILE_NAME = 'ips.log';
+    const CACHE_FILE_SEPARATOR = ';;';
+    const CACHE_FILE_NEWLINE = '\n';
+
+    const REQUEST_IP = '9.9.9.9';
+
+    const cacheFile = `${REQUEST_IP.split(/\.|:/)[0]}_${CACHE_FILE_NAME}`;
+
+    const response = {
+        ip: REQUEST_IP,
+        emoji: '🇨🇭',
+        country: 'Switzerland',
+        countryA2: 'CH',
+        region: 'Zurich',
+        city: 'Zürich',
+        org: 'Quad9',
+        isp: 'Quad9',
+        ispDomain: 'quad9.net',
+    };
+
+    it('should remove fs cache dir if exist', () => removeCacheFolder(CACHE_FILE_DIR));
+
+    it(`should return correct response for IP: "${REQUEST_IP}"`, async () => {
+        const data = await ip2geo(REQUEST_IP, {
+            cacheDir: CACHE_FILE_DIR,
+        });
+
+        assert.deepEqual(data, response);
+    });
+
+    it('should have cache file', () => checkCacheFile(
+        CACHE_FILE_DIR,
+        cacheFile,
+        CACHE_FILE_SEPARATOR,
+        CACHE_FILE_NEWLINE,
+        response,
+    ));
+});

package/tests/opts-assigned.js

@@ -0,0 +1,54 @@
+import assert from 'node:assert/strict';
+
+import {describe, it} from 'mocha';
+
+import {ip2geo} from '../app/index.js';
+
+import {getCurrentFilename, getTestFolder} from './helpers/path.js';
+import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
+
+const testName = getCurrentFilename(import.meta.url);
+
+describe(testName, () => {
+    const CACHE_FILE_DIR = getTestFolder(testName);
+    const CACHE_FILE_NAME = 'ips.md';
+    const CACHE_FILE_SEPARATOR = '-_-';
+    const CACHE_FILE_NEWLINE = '%%%';
+
+    const REQUEST_IP = '8.8.8.8';
+
+    const cacheFile = `${REQUEST_IP.split(/\.|:/)[0]}_${CACHE_FILE_NAME}`;
+
+    const response = {
+        ip: REQUEST_IP,
+        emoji: '🇺🇸',
+        country: 'United States',
+        countryA2: 'US',
+        region: 'California',
+        city: 'Mountain View',
+        org: 'Google LLC',
+        isp: 'Google LLC',
+        ispDomain: 'google.com',
+    };
+
+    it('should remove fs cache dir if exist', () => removeCacheFolder(CACHE_FILE_DIR));
+
+    it(`should return correct response for IP: "${REQUEST_IP}"`, async () => {
+        const data = await ip2geo(REQUEST_IP, {
+            cacheDir: CACHE_FILE_DIR,
+            cacheFileName: CACHE_FILE_NAME,
+            cacheFileSeparator: CACHE_FILE_SEPARATOR,
+            cacheFileNewline: CACHE_FILE_NEWLINE,
+        });
+
+        assert.deepEqual(data, response);
+    });
+
+    it('should have cache file', () => checkCacheFile(
+        CACHE_FILE_DIR,
+        cacheFile,
+        CACHE_FILE_SEPARATOR,
+        CACHE_FILE_NEWLINE,
+        response,
+    ));
+});

package/tests/opts-default.js

@@ -0,0 +1,78 @@
+import assert from 'node:assert/strict';
+
+import {describe, it} from 'mocha';
+
+import {ip2geo} from '../app/index.js';
+
+import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
+
+describe('opts-default', () => {
+    const CACHE_FILE_DIR = '.geoip';
+    const CACHE_FILE_NAME = 'ips.log';
+    const CACHE_FILE_SEPARATOR = ';;';
+    const CACHE_FILE_NEWLINE = '\n';
+
+    const REQUEST_IP = '1.1.1.1';
+
+    const cacheFile = `${REQUEST_IP.split(/\.|:/)[0]}_${CACHE_FILE_NAME}`;
+
+    const response = {
+        ip: REQUEST_IP,
+        emoji: '🇺🇸',
+        country: 'United States',
+        countryA2: 'US',
+        region: 'District of Columbia',
+        city: 'Washington',
+        org: 'APNIC and Cloudflare DNS Resolver project',
+        isp: 'Cloudflare, Inc.',
+        ispDomain: 'cloudflare.com',
+    };
+
+    const outputKeys = [
+        'ip',
+        'emoji',
+        'country',
+        'countryA2',
+        'region',
+        'city',
+        'org',
+        'isp',
+        'ispDomain',
+    ];
+
+    removeCacheFolder(CACHE_FILE_DIR);
+
+    describe('with ip arg', () => {
+        it(`should return correct response for IP: "${REQUEST_IP}"`, async () => {
+            const data = await ip2geo(REQUEST_IP);
+
+            assert.deepEqual(data, response);
+        });
+
+        it('should have cache file', () => checkCacheFile(
+            CACHE_FILE_DIR,
+            cacheFile,
+            CACHE_FILE_SEPARATOR,
+            CACHE_FILE_NEWLINE,
+            response,
+        ));
+    });
+
+    describe('without ip arg', () => {
+        let data;
+
+        it('should request geoip without ip arg', async () => {
+            data = await ip2geo();
+        });
+
+        outputKeys.forEach(key => {
+            it(`should have "${key}" in request response`, () => {
+                assert.ok(data[key]);
+            });
+        });
+
+        it('should not have extra keys in request response', () => {
+            assert.deepEqual(Object.keys(data), outputKeys);
+        });
+    });
+});

package/tests/shared/fs.js

@@ -1,21 +1,18 @@
 import assert from 'node:assert/strict';
 import fs from 'node:fs/promises';
 import path from 'node:path';
-import {it} from 'node:test';
 
 /**
  * @param {string} cacheDir
  */
-export const removeCacheFolder = cacheDir => {
-    it('should remove fs cache dir if exist', async () => {
-        try {
-            await fs.rm(cacheDir, {recursive: true, force: true});
-        } catch (err) {
-            if (err.code !== 'ENOENT') {
-                throw err;
-            }
+export const removeCacheFolder = async cacheDir => {
+    try {
+        await fs.rm(cacheDir, {recursive: true, force: true});
+    } catch (err) {
+        if (err.code !== 'ENOENT') {
+            throw err;
         }
-    });
+    }
 };
 
 /**
@@ -25,10 +22,8 @@ export const removeCacheFolder = cacheDir => {
  * @param {string} cacheFileNewline
  * @param {object} response
  */
-export const checkCacheFile = (cacheDir, cacheFileName, cacheFileSeparator, cacheFileNewline, response) => {
-    it('should have cache file', async () => {
-        const data = await fs.readFile(path.join(cacheDir, cacheFileName), {encoding: 'utf8'});
+export const checkCacheFile = async (cacheDir, cacheFileName, cacheFileSeparator, cacheFileNewline, response) => {
+    const data = await fs.readFile(path.join(cacheDir, cacheFileName), {encoding: 'utf8'});
 
-        assert.equal(data, Object.values(response).join(cacheFileSeparator) + cacheFileNewline);
-    });
+    assert.equal(data, Object.values(response).join(cacheFileSeparator) + cacheFileNewline);
 };