@k03mad/ip2geo 1.0.0 → 2.1.0

package/README.md

@@ -8,7 +8,7 @@
 
 ```bash
 npm i @k03mad/ip2geo --save-exact
-echo "/geoip" >> .gitignore
+echo .geoip >> .gitignore
 ```
 
 ```js
@@ -23,8 +23,8 @@ const {
     isp,
 } = await ip2geo('1.1.1.1', {
     // defaults
-    cacheDir: 'geoip',
-    cacheFileName: 'ip.log',
+    cacheDir: '.geoip',
+    cacheFileName: 'ips.log',
     cacheFileSeparator: ';;',
     cacheFileNewline: '\n',
 });

package/app/lib/ip2geo.js

@@ -13,15 +13,18 @@ const debug = _debug('mad:geoip');
  * @property {string} [country]
  * @property {string} [countryA2]
  * @property {string} [city]
+ * @property {string} [region]
+ * @property {string} [org]
  * @property {string} [isp]
+ * @property {string} [ispDomain]
  */
 
 const API = 'https://ipwho.is/';
 
-const CACHE_FILE_DIR = 'geoip';
-const CACHE_FILE_NAME = 'ip.log';
-const CACHE_FILE_SEPARATOR = ';;';
-const CACHE_FILE_NEWLINE = '\n';
+const DEFAULT_CACHE_FILE_DIR = '.geoip';
+const DEFAULT_CACHE_FILE_NAME = 'ips.log';
+const DEFAULT_CACHE_FILE_SEPARATOR = ';;';
+const DEFAULT_CACHE_FILE_NEWLINE = '\n';
 
 const cacheMap = new Map();
 
@@ -30,8 +33,11 @@ const outputKeys = [
     'emoji',
     'country',
     'countryA2',
+    'region',
     'city',
+    'org',
     'isp',
+    'ispDomain',
 ];
 
 /**
@@ -55,7 +61,7 @@ const collectOutputData = dataArr => {
  * @returns {string}
  */
 const getCacheFileFullPath = (ip, cacheDir, cacheFileName) => {
-    const [firstOctet] = ip.split('.');
+    const [firstOctet] = ip.split(/\.|:/);
     return path.join(cacheDir, `${firstOctet}_${cacheFileName}`);
 };
 
@@ -106,10 +112,10 @@ const writeToFsCache = async (ip, data, cacheDir, cacheFileName, cacheFileSepara
  * @returns {Promise<GeoIpOutput>}
  */
 export default async (ip = '', {
-    cacheDir = CACHE_FILE_DIR,
-    cacheFileName = CACHE_FILE_NAME,
-    cacheFileSeparator = CACHE_FILE_SEPARATOR,
-    cacheFileNewline = CACHE_FILE_NEWLINE,
+    cacheDir = DEFAULT_CACHE_FILE_DIR,
+    cacheFileName = DEFAULT_CACHE_FILE_NAME,
+    cacheFileSeparator = DEFAULT_CACHE_FILE_SEPARATOR,
+    cacheFileNewline = DEFAULT_CACHE_FILE_NEWLINE,
 } = {}) => {
     if (ip) {
         const ipData = cacheMap.get(ip);
@@ -145,8 +151,11 @@ export default async (ip = '', {
         body?.flag?.emoji,
         body?.country,
         body?.country_code,
+        body?.region,
         body?.city,
+        body?.connection?.org,
         body?.connection?.isp,
+        body?.connection?.domain,
     ];
 
     const outputData = collectOutputData(usedData);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k03mad/ip2geo",
-  "version": "1.0.0",
+  "version": "2.1.0",
   "description": "GeoIP library",
   "maintainers": [
     "Kirill Molchanov <k03.mad@gmail.com"

package/tests/helpers/path.js

@@ -0,0 +1,7 @@
+import path from 'node:path';
+
+/**
+ * @param {string} file import.meta.url
+ * @returns {string}
+ */
+export const getCurrentFilename = file => path.basename(file, '.js');

package/tests/opts-assigned-subfolder.js

@@ -1,44 +0,0 @@
-import assert from 'node:assert/strict';
-import {describe, it} from 'node:test';
-
-import {ip2geo} from '../app/index.js';
-
-import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
-
-describe('opts-assigned', () => {
-    const CACHE_FILE_DIR = 'geoip-subfolder/hello_there';
-    const CACHE_FILE_NAME = 'ip.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',
-        city: 'Zürich',
-        isp: 'Quad9',
-    };
-
-    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);
-    });
-
-    checkCacheFile(
-        CACHE_FILE_DIR,
-        cacheFile,
-        CACHE_FILE_SEPARATOR,
-        CACHE_FILE_NEWLINE,
-        response,
-    );
-});

package/tests/opts-assigned.js

@@ -1,47 +0,0 @@
-import assert from 'node:assert/strict';
-import {describe, it} from 'node:test';
-
-import {ip2geo} from '../app/index.js';
-
-import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
-
-describe('opts-assigned', () => {
-    const CACHE_FILE_DIR = 'geoip-cache-opts';
-    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',
-        city: 'Mountain View',
-        isp: 'Google LLC',
-    };
-
-    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);
-    });
-
-    checkCacheFile(
-        CACHE_FILE_DIR,
-        cacheFile,
-        CACHE_FILE_SEPARATOR,
-        CACHE_FILE_NEWLINE,
-        response,
-    );
-});

package/tests/opts-default.js

@@ -1,67 +0,0 @@
-import assert from 'node:assert/strict';
-import {describe, it} from 'node:test';
-
-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 = 'ip.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',
-        city: 'Washington',
-        isp: 'Cloudflare, Inc.',
-    };
-
-    const outputKeys = [
-        'ip',
-        'emoji',
-        'country',
-        'countryA2',
-        'city',
-        'isp',
-    ];
-
-    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);
-        });
-
-        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]);
-            });
-        });
-    });
-});