1.0.9

sefinek · Dec 7, 2024 · 4e44230 · 4e44230
1 parent f4daddf
commit 4e44230
Show file tree

Hide file tree

Showing 14 changed files with 101 additions and 38 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1 @@
-.idea
 node_modules
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/discord.xml b/.idea/discord.xml
diff --git a/.idea/geoip2-api.iml b/.idea/geoip2-api.iml
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/.idea/jsLibraryMappings.xml b/.idea/jsLibraryMappings.xml
diff --git a/.idea/jsLinters/eslint.xml b/.idea/jsLinters/eslint.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/README.md b/README.md
@@ -11,13 +11,10 @@
 
 
 ## 📝 Information
-This documentation provides information about the lightweight Node.js module designed for sending requests to a geolocation data API.
-This module enables you to retrieve location information for a specified IP address and takes full advantage of native modules.
-The [official API](https://api.sefinek.net) is thoroughly optimized ⚡ and secure 🔐.
-
-> We use the [MaxMind database](https://www.maxmind.com) in the [geoip-lite2](https://github.com/sefinek/geoip-lite2) module for [our API](https://api.sefinek.net/docs/v2).
-> Due to certain limitations, the database is not updated daily (and never will be) by the module's developer. Updates are issued periodically.
+This documentation covers a lightweight Node.js module designed for interacting with a geolocation data API.
+The module enables efficient retrieval of location details for specific IP addresses, utilizing native modules for optimal performance.
 
+> We utilize the [MaxMind database](https://www.maxmind.com) via the [geoip-lite2](https://github.com/sefinek/geoip-lite2) module for [our API](https://api.sefinek.net/docs/v2).
 
 ## 💻 Locally
 There is an alternative to this module that allows for local geolocation retrieval based on a specific IP address.
@@ -83,6 +80,4 @@ If you like this module, please **star** ⭐ the repository.
 ## 🔑 MIT License
 This GeoIP API client script is provided under the MIT License. See the [LICENSE](LICENSE) file for more details.
 
-Copyright 2023-2024 © by [Sefinek](https://sefinek.net). All Rights Reserved.
-
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsefinek%2Fgeoip2-api.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsefinek%2Fgeoip2-api?ref=badge_large)
+Copyright 2023-2024 © by [Sefinek](https://sefinek.net). All Rights Reserved.
diff --git a/index.js b/index.js
@@ -12,31 +12,38 @@ const headers = {
 
 const timeout = 25000;
 
-const makeRequest = ip => new Promise((resolve, reject) => {
-	if (!ip) return reject(new Error('IP address is required.'));
-
-	const req = https.get(`https://api.sefinek.net/api/v2/geoip/${ip}`, { headers, timeout }, res => {
-		const { statusCode } = res;
-		if (statusCode !== 200 && statusCode !== 400) {
-			return reject(new Error(`HTTP Status Code: ${statusCode}`));
-		}
-
-		let data = '';
-		res.on('data', chunk => data += chunk);
-		res.on('end', () => {
-			try {
-				resolve(JSON.parse(data));
-			} catch (err) {
-				reject(err);
+const get = async ip => {
+	if (!ip || typeof ip !== 'string') throw new Error('A valid IP address is required.');
+
+	return new Promise((resolve, reject) => {
+		const req = https.get(`https://api.sefinek.net/api/v2/geoip/${ip}`, { headers, timeout }, res => {
+			const { statusCode } = res;
+			if (statusCode !== 200 && statusCode !== 400) {
+				req.destroy();
+				return reject(new Error(`HTTP Status Code: ${statusCode}`));
 			}
+
+			let data = '';
+			res.on('data', chunk => data += chunk);
+			res.on('end', () => {
+				try {
+					resolve(JSON.parse(data));
+				} catch (err) {
+					reject(err);
+				}
+			});
 		});
-	});
 
-	req.on('error', reject);
-	req.on('timeout', () => {
-		req.destroy();
-		reject(new Error(`Request timed out after ${timeout} ms.`));
+		req.on('error', err => {
+			req.destroy();
+			reject(err);
+		});
+
+		req.on('timeout', () => {
+			req.destroy();
+			reject(new Error(`Request timed out after ${timeout} ms.`));
+		});
 	});
-});
+};
 
-module.exports = { get: makeRequest, version };
+module.exports = { get, version };
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "geoip2-api",
-  "version": "1.0.8",
-  "description": "This module enables you to retrieve the customer's geolocation using their IP address, utilizing data obtained from an official and high-speed API.",
+  "version": "1.0.9",
+  "description": "This module allows obtaining the client's geolocation using their IP address, leveraging data retrieved from a fast API.",
   "keywords": [
     "geo api",
     "geo ip",

diff --git a/test/index.test.js b/test/index.test.js
@@ -88,4 +88,4 @@ describe('GeoIP Wrapper Module', () => {
 			expect(result.message).toBe('HTTP Status Code: 400');
 		}
 	});
-});
+});
-Original file line number
+Diff line change
@@ Expand Up / @@ -88,4 +88,4 @@ describe('GeoIP Wrapper Module', () => { @@
     			expect(result.message).toBe('HTTP Status Code: 400');
     		}
     	});
-    });
+    });