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

Author: ip2location

README.md

@@ -20,6 +20,9 @@ The database will be updated on a monthly basis for greater accuracy.
 The complete database is available at https://www.ip2location.com under Premium subscription package.
 The free LITE database is available at https://lite.ip2location.com.
 
+As an alternative, this module can also call the IP2Location 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/ip2location
 
 ## Installation
 
@@ -31,6 +34,7 @@ npm install ip2location-nodejs
 
 ```
 
+## QUERY USING THE BIN FILE
 
 ## Dependencies
 
@@ -53,50 +57,97 @@ Below are the methods supported in this module.
 
 |Method Name|Description|
 |---|---|
-|IP2Location_init|Opens the IP2Location BIN data for lookup.|
-|IP2Location_get_all|Returns the geolocation information in an object.|
-|IP2Location_get_country_short|Returns the country code.|
-|IP2Location_get_country_long|Returns the country name.|
-|IP2Location_get_region|Returns the region name.|
-|IP2Location_get_city|Returns the city name.|
-|IP2Location_get_isp|Returns the ISP name.|
-|IP2Location_get_latitude|Returns the latitude.|
-|IP2Location_get_longitude|Returns the longitude.|
-|IP2Location_get_domain|Returns the domain name.|
-|IP2Location_get_zipcode|Returns the ZIP code.|
-|IP2Location_get_timezone|Returns the time zone.|
-|IP2Location_get_netspeed|Returns the net speed.|
-|IP2Location_get_iddcode|Returns the IDD code.|
-|IP2Location_get_areacode|Returns the area code.|
-|IP2Location_get_weatherstationcode|Returns the weather station code.|
-|IP2Location_get_weatherstationname|Returns the weather station name.|
-|IP2Location_get_mcc|Returns the mobile country code.|
-|IP2Location_get_mnc|Returns the mobile network code.|
-|IP2Location_get_mobilebrand|Returns the mobile brand.|
-|IP2Location_get_elevation|Returns the elevation in meters.|
-|IP2Location_get_usagetype|Returns the usage type.|
-|IP2Location_get_addresstype|Returns the address type.|
-|IP2Location_get_category|Returns the IAB category.|
-|IP2Location_close|Closes BIN file and resets metadata.|
+|open|Opens the IP2Location BIN data for lookup.|
+|getAll|Returns the geolocation information in an object.|
+|getCountryShort|Returns the country code.|
+|getCountryLong|Returns the country name.|
+|getRegion|Returns the region name.|
+|getCity|Returns the city name.|
+|getISP|Returns the ISP name.|
+|getLatitude|Returns the latitude.|
+|getLongitude|Returns the longitude.|
+|getDomain|Returns the domain name.|
+|getZIPCode|Returns the ZIP code.|
+|getTimeZone|Returns the time zone.|
+|getNetSpeed|Returns the net speed.|
+|getIDDCode|Returns the IDD code.|
+|getAreaCode|Returns the area code.|
+|getWeatherStationCode|Returns the weather station code.|
+|getWeatherStationName|Returns the weather station name.|
+|getMCC|Returns the mobile country code.|
+|getMNC|Returns the mobile network code.|
+|getMobileBrand|Returns the mobile brand.|
+|getElevation|Returns the elevation in meters.|
+|getUsageType|Returns the usage type.|
+|getAddressType|Returns the address type.|
+|getCategory|Returns the IAB category.|
+|close|Closes BIN file and resets metadata.|
 
 
 ## Usage
 
 ```javascript
 
-var ip2loc = require("ip2location-nodejs");
+const {IP2Location} = require("ip2location-nodejs");
+
+let ip2location = new IP2Location();
 
-ip2loc.IP2Location_init("./DB25.BIN");
+ip2location.open("./DB25.BIN");
 
 testip = ['8.8.8.8', '2404:6800:4001:c01::67'];
 
 for (var x = 0; x < testip.length; x++) {
-	result = ip2loc.IP2Location_get_all(testip[x]);
+	result = ip2location.getAll(testip[x]);
 	for (var key in result) {
 		console.log(key + ": " + result[key]);
 	}
 	console.log("--------------------------------------------------------------");
 }
 
-ip2loc.IP2Location_close();
+ip2location.close();
+
 ```
+
+## QUERY USING THE IP2PROXY PROXY DETECTION WEB SERVICE
+
+## Methods
+Below are the methods supported in this module.
+
+|Method Name|Description|
+|---|---|
+|open| 3 input parameters:<ol><li>IP2Location API Key.</li><li>Package (WS1 - WS25)</li></li><li>Use HTTPS or HTTP</li></ol> |
+|lookup|Query IP address. This method returns an object containing the geolocation info. <ul><li>country_code</li><li>country_name</li><li>region_name</li><li>city_name</li><li>latitude</li><li>longitude</li><li>zip_code</li><li>time_zone</li><li>isp</li><li>domain</li><li>net_speed</li><li>idd_code</li><li>area_code</li><li>weather_station_code</li><li>weather_station_name</li><li>mcc</li><li>mnc</li><li>mobile_brand</li><li>elevation</li><li>usage_type</li><li>address_type</li><li>category</li><li>continent<ul><li>name</li><li>code</li><li>hemisphere</li><li>translations</li></ul></li><li>country<ul><li>name</li><li>alpha3_code</li><li>numeric_code</li><li>demonym</li><li>flag</li><li>capital</li><li>total_area</li><li>population</li><li>currency<ul><li>code</li><li>name</li><li>symbol</li></ul></li><li>language<ul><li>code</li><li>name</li></ul></li><li>idd_code</li><li>tld</li><li>translations</li></ul></li><li>region<ul><li>name</li><li>code</li><li>translations</li></ul></li><li>city<ul><li>name</li><li>translations</li></ul></li><li>geotargeting<ul><li>metro</li></ul></li><li>country_groupings</li><li>time_zone_info<ul><li>olson</li><li>current_time</li><li>gmt_offset</li><li>is_dst</li><li>sunrise</li><li>sunset</li></ul></li><ul>|
+|getCredit()|This method returns the web service credit balance in an object.|
+
+## Usage
+
+```javascript
+
+const {IP2LocationWebService} = require("ip2location-nodejs");
+
+let ws = new IP2LocationWebService();
+
+let ip = "8.8.8.8";
+let apiKey = "YOUR_API_KEY";
+let apiPackage = "WS25";
+let useSSL = true;
+
+// addon and lang to get more data and translation (leave both blank if you don't need them)
+let addon = "continent,country,region,city,geotargeting,country_groupings,time_zone_info";
+let lang = "fr";
+
+ws.open(apiKey, apiPackage, useSSL);
+
+ws.lookup(ip, addon, lang, (err, data) => {
+	if (!err) {
+		console.log(data);
+		
+		ws.getCredit((err, data) => {
+			if (!err) {
+				console.log(data);
+			}
+		});
+	}
+});
+
+```

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ip2location-nodejs",
-	"version": "8.5.0",
+	"version": "9.0.0",
 	"description": "IP2Location geolocation component",
 	"keywords": [
 		"ip2location",
@@ -25,5 +25,8 @@
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/ip2location/ip2location-nodejs.git"
+	},
+	"devDependencies": {
+		"prettier": "2.4.0"
 	}
 }