@k03mad/ip2geo 1.0.0 → 2.0.0

package/README.md

@@ -24,7 +24,7 @@ const {
 } = await ip2geo('1.1.1.1', {
     // defaults
     cacheDir: 'geoip',
-    cacheFileName: 'ip.log',
+    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',
 ];
 
 /**
@@ -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.0.0",
   "description": "GeoIP library",
   "maintainers": [
     "Kirill Molchanov <k03.mad@gmail.com"

package/tests/opts-assigned-subfolder.js

@@ -7,7 +7,7 @@ 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_NAME = 'ips.log';
     const CACHE_FILE_SEPARATOR = ';;';
     const CACHE_FILE_NEWLINE = '\n';
 
@@ -20,8 +20,11 @@ describe('opts-assigned', () => {
         emoji: '🇨🇭',
         country: 'Switzerland',
         countryA2: 'CH',
+        region: 'Zurich',
         city: 'Zürich',
+        org: 'Quad9',
         isp: 'Quad9',
+        ispDomain: 'quad9.net',
     };
 
     removeCacheFolder(CACHE_FILE_DIR);

package/tests/opts-assigned.js

@@ -20,8 +20,11 @@ describe('opts-assigned', () => {
         emoji: '🇺🇸',
         country: 'United States',
         countryA2: 'US',
+        region: 'California',
         city: 'Mountain View',
+        org: 'Google LLC',
         isp: 'Google LLC',
+        ispDomain: 'google.com',
     };
 
     removeCacheFolder(CACHE_FILE_DIR);

package/tests/opts-default.js

@@ -7,7 +7,7 @@ import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
 
 describe('opts-default', () => {
     const CACHE_FILE_DIR = 'geoip';
-    const CACHE_FILE_NAME = 'ip.log';
+    const CACHE_FILE_NAME = 'ips.log';
     const CACHE_FILE_SEPARATOR = ';;';
     const CACHE_FILE_NEWLINE = '\n';
 
@@ -20,8 +20,11 @@ describe('opts-default', () => {
         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 = [
@@ -29,8 +32,11 @@ describe('opts-default', () => {
         'emoji',
         'country',
         'countryA2',
+        'region',
         'city',
+        'org',
         'isp',
+        'ispDomain',
     ];
 
     removeCacheFolder(CACHE_FILE_DIR);
@@ -63,5 +69,9 @@ describe('opts-default', () => {
                 assert.ok(data[key]);
             });
         });
+
+        it('should not have extra keys in request response', () => {
+            assert.deepEqual(Object.keys(data), outputKeys);
+        });
     });
 });