Modified to be classes. Added support for IP2Proxy Web Service.

Author: ip2location

README.md

@@ -8,6 +8,9 @@ This module allows user to query an IP address if it was being used as VPN anony
 * Free IP2Proxy BIN Data: https://lite.ip2location.com
 * Commercial IP2Proxy BIN Data: https://www.ip2location.com/database/ip2proxy
 
+As an alternative, this module can also call the IP2Proxy Web Service. This requires an API key. If you don't have an existing API key, you can subscribe for one at the below:
+
+https://www.ip2location.com/web-service/ip2proxy
 
 ## Installation
 
@@ -19,13 +22,15 @@ npm install ip2proxy-nodejs
 
 ```
 
+## QUERY USING THE BIN FILE
+
 ## Methods
 Below are the methods supported in this class.
 
 |Method Name|Description|
 |---|---|
-|Open|Open the IP2Proxy BIN data for lookup.|
-|Close|Close and clean up the file pointer.|
+|open|Open the IP2Proxy BIN data for lookup.|
+|close|Close and clean up the file pointer.|
 |getPackageVersion|Get the package version (1 to 11 for PX1 to PX11 respectively).|
 |getModuleVersion|Get the module version.|
 |getDatabaseVersion|Get the database version.|
@@ -48,10 +53,11 @@ Below are the methods supported in this class.
 ## Usage
 
 ```javascript
+const {IP2Proxy} = require("ip2proxy-nodejs");
 
-var ip2proxy = require("ip2proxy-nodejs");
+let ip2proxy = new IP2Proxy();
 
-if (ip2proxy.Open("./IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL-PROVIDER.BIN") == 0) {
+if (ip2proxy.open("./IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL-PROVIDER.BIN") == 0) {
 	ip = '199.83.103.79';
 
 	console.log("GetModuleVersion: " + ip2proxy.getModuleVersion());
@@ -75,25 +81,101 @@ if (ip2proxy.Open("./IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGET
 	console.log("Provider: " + ip2proxy.getProvider(ip));
 
 	// function for all fields
-	var all = ip2proxy.getAll(ip);
-	console.log("isProxy: " + all.Is_Proxy);
-	console.log("ProxyType: " + all.Proxy_Type);
-	console.log("CountryShort: " + all.Country_Short);
-	console.log("CountryLong: " + all.Country_Long);
-	console.log("Region: " + all.Region);
-	console.log("City: " + all.City);
-	console.log("ISP: " + all.ISP);
-	console.log("Domain: " + all.Domain);
-	console.log("UsageType: " + all.Usage_Type);
-	console.log("ASN: " + all.ASN);
-	console.log("AS: " + all.AS);
-	console.log("LastSeen: " + all.Last_Seen);
-	console.log("Threat: " + all.Threat);
-	console.log("Provider: " + all.Provider);
+	let all = ip2proxy.getAll(ip);
+	console.log("isProxy: " + all.isProxy);
+	console.log("proxyType: " + all.proxyType);
+	console.log("countryShort: " + all.countryShort);
+	console.log("countryLong: " + all.countryLong);
+	console.log("region: " + all.region);
+	console.log("city: " + all.city);
+	console.log("isp: " + all.isp);
+	console.log("domain: " + all.domain);
+	console.log("usagetype: " + all.usageType);
+	console.log("asn: " + all.asn);
+	console.log("as: " + all.as);
+	console.log("lastSeen: " + all.lastSeen);
+	console.log("threat: " + all.threat);
+	console.log("provider: " + all.provider);
 }
 else {
 	console.log("Error reading BIN file.");
 }
-ip2proxy.Close();
+ip2proxy.close();
+
+```
+
+## QUERY USING THE IP2PROXY PROXY DETECTION WEB SERVICE
+
+## Methods
+Below are the methods supported in this class.
+
+|Method Name|Description|
+|---|---|
+|open(apiKey, apiPackage, useSSL = true)| Expects 2 or 3 input parameters:<ol><li>IP2Proxy API Key.</li><li>Package (PX1 - PX11)</li></li><li>Use HTTPS or HTTP</li></ol> |
+|lookup(myIP, callback)|Query IP address. This method returns an object containing the proxy info. <ul><li>countryCode</li><li>countryName</li><li>regionName</li><li>cityName</li><li>isp</li><li>domain</li><li>usageType</li><li>asn</li><li>as</li><li>lastSeen</li><li>threat</li><li>proxyType</li><li>isProxy</li><li>provider</li><ul>|
+|getCredit()|This method returns the web service credit balance in an object.|
+
+## Usage
+
+```javascript
+const {IP2ProxyWebService} = require("ip2proxy-nodejs");
+
+let ws = new IP2ProxyWebService();
+
+let ip = "8.8.8.8";
+let apiKey = "YOUR_API_KEY";
+let apiPackage = "PX11";
+let useSSL = true;
+
+ws.open(apiKey, apiPackage, useSSL);
+
+ws.lookup(ip, (err, data) => {
+	if (!err) {
+		console.log(data);
+		
+		ws.getCredit((err, data) => {
+			if (!err) {
+				console.log(data);
+			}
+		});
+	}
+});
 
 ```
+
+### Proxy Type
+
+|Proxy Type|Description|
+|---|---|
+|VPN|Anonymizing VPN services|
+|TOR|Tor Exit Nodes|
+|PUB|Public Proxies|
+|WEB|Web Proxies|
+|DCH|Hosting Providers/Data Center|
+|SES|Search Engine Robots|
+|RES|Residential Proxies [PX10+]|
+
+### Usage Type
+
+|Usage Type|Description|
+|---|---|
+|COM|Commercial|
+|ORG|Organization|
+|GOV|Government|
+|MIL|Military|
+|EDU|University/College/School|
+|LIB|Library|
+|CDN|Content Delivery Network|
+|ISP|Fixed Line ISP|
+|MOB|Mobile ISP|
+|DCH|Data Center/Web Hosting/Transit|
+|SES|Search Engine Spider|
+|RSV|Reserved|
+
+### Threat Type
+
+|Threat Type|Description|
+|---|---|
+|SPAM|Spammer|
+|SCANNER|Security Scanner or Attack|
+|BOTNET|Spyware or Malware|

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ip2proxy-nodejs",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "description": "IP2Proxy proxy detection component",
   "keywords": [
     "vpn-detection",
@@ -31,5 +31,8 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/ip2location/ip2proxy-nodejs"
+  },
+  "devDependencies": {
+    "prettier": "2.4.0"
   }
 }