ip2location_ruby 8.1.1 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d160588d5a49065122250d6dee7accdbe55df7cf59fd6553280021d70f7de57
-  data.tar.gz: 2d3f13b07b33befcbf33f9219d746bd6e3a5b7f3e7e698f73a1c40b3403351d3
+  metadata.gz: d40ddb96c3b68fc1ff4d851a0389f715e09c41c3b185d8936558686fa39ce2a4
+  data.tar.gz: 1b0d493cddb9e69b692be6f3a84b4e178d1ad16a1c63641732638b6134cf51e1
 SHA512:
-  metadata.gz: 6f4038abb8b7d375e5fa7bcc755caf185618b2b7c14bd905349ab07df4626e0ad13e503ef28bd3f149c8a6ecf03b597ea549d497f8c161dca05bff6a72bdbc3f
-  data.tar.gz: 313f941c440627468594b39364793c1ef919fe6d3bdf0842338510983b88186d3e21feb6c37a03e6eb18ae4e6c074b25685cc066ff46605773f0ebcc183195d9
+  metadata.gz: c21ffd658ec663cc61c726a77a907e56bb69114ac1a016ccea7568ccf0b6faa180a4efade585009dbed2c526880fddef1dce724f1e724f0592ec1b52174ae287
+  data.tar.gz: 6337c61e5594a6e48bc2b2541afe9d0f944eeeabd6200091ac6f3b0459d60e31f216ac4ca5aaa51e5bc3c890eb17b1fd28fbdadce4d7b46c6308faa117a621de

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2019 IP2Location ( support@ip2location.com )
+Copyright (c) 2020 IP2Location ( support@ip2location.com )
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,8 +2,7 @@
 [![Total Downloads](https://img.shields.io/gem/dt/ip2location_ruby.svg)](https://rubygems.org/gems/ip2location_ruby)
 
 # IP2Location Ruby Library
-This is IP2Location Ruby library that enables the user to find the country, region or state, city, latitude and longitude, US ZIP code, time zone, Internet Service Provider (ISP) or company name, domain name, net speed, area code, weather station code, weather station name, mobile country code (MCC), mobile network code (MNC) and carrier brand, elevation, and usage type by IP address or hostname originates from.  The library reads the geo location information
-from **IP2Location BIN data** file.
+This is IP2Location Ruby library that enables the user to find the country, region or state, city, latitude and longitude, US ZIP code, time zone, Internet Service Provider (ISP) or company name, domain name, net speed, area code, weather station code, weather station name, mobile country code (MCC), mobile network code (MNC) and carrier brand, elevation, and usage type by IP address or hostname originates from.  The library reads the geo location information from **IP2Location BIN data** file or web service.
 
 Supported IPv4 and IPv6 address.
 
@@ -11,50 +10,58 @@ For more details, please visit:
 [https://www.ip2location.com/developers/ruby](https://www.ip2location.com/developers/ruby)
 
 # Usage
+You can check the **example.rb** file to learn more about usage.
 
-```
-require 'ip2location_ruby'
+## BIN Database
+Below is the description of the functions available in the **BIN Database** lookup.
 
-i2l = Ip2location.new.open("./data/IPV6-COUNTRY-REGION-CITY-LATITUDE-LONGITUDE-ZIPCODE-TIMEZONE-ISP-DOMAIN-NETSPEED-AREACODE-WEATHER-MOBILE-ELEVATION-USAGETYPE.BIN")
-record = i2l.get_all('8.8.8.8')
+| Function Name | Description |
+|---|---|
+| open | Open the IP2Location BIN data for lookup. |
+| close | Close and clean up the file pointer. |
+| close | Close and clean up the file pointer. |
+| get_all | Return the geolocation information in array. |
+| get_country_short | Return the ISO3166-1 country code (2-digits) of the IP address. |
+| get_country_long  | Return the ISO3166-1 country name of the IP address. |
+| get_region | Return the ISO3166-2 region name of the IP address. Please visit [ISO3166-2 Subdivision Code](https://www.ip2location.com/free/iso3166-2) for the information of ISO3166-2 supported |
+| get_city | Return the city name of the IP address. |
+| get_latitude | Return the city latitude of the IP address. |
+| get_longitude | Return the city longtitude of the IP address. |
+| get_isp | Return the ISP name of the IP address. |
+| get_domain | Return the domain name of IP address. |
+| get_zipcode | Return the zipcode of the city. |
+| get_timezone | Return the UTC time zone (with DST supported). |
+| get_netspeed | Return the Internet connection type. |
+| get_iddcode | Return the IDD prefix to call the city from another country. |
+| get_areacode | Return the area code of the city. |
+| get_weathercode | Return the nearest weather observation station code. |
+| get_weathername | Return the nearest weather observation station name. |
+| get_mcc | Return the Mobile Country Codes (MCC). |
+| get_mnc | Return the Mobile Network Code (MNC). |
+| get_mobilebrand | Commercial brand associated with the mobile carrier. |
+| get_elevation | Return average height of city above sea level in meters (m). |
+| get_usagetype | Return the ISP's usage type of IP address. |
 
-print 'Country Code: ' + record['country_short'] + "\n"
-print 'Country Name: ' + record['country_long'] + "\n"
-print 'Region Name: ' + record['region'] + "\n"
-print 'City Name: ' + record['city'] + "\n"
-print 'Latitude: '
-print record['latitude']
-print "\n"
-print 'Longitude: '
-print record['longitude']
-print "\n"
-print 'ISP: ' + record['isp'] + "\n"
-print 'Domain: ' + record['domain'] + "\n"
-print 'Net Speed: ' + record['netspeed'] + "\n"
-print 'Area Code: ' + record['areacode'] + "\n"
-print 'IDD Code: ' + record['iddcode'] + "\n"
-print 'Time Zone: ' + record['timezone'] + "\n"
-print 'ZIP Code: ' + record['zipcode'] + "\n"
-print 'Weather Station Code: ' + record['weatherstationname'] + "\n"
-print 'Weather Station Name: ' + record['weatherstationcode'] + "\n"
-print 'MCC: ' + record['mcc'] + "\n"
-print 'MNC: ' + record['mnc'] + "\n"
-print 'Mobile Name: ' + record['mobilebrand'] + "\n"
-print 'Elevation: '
-print record['elevation']
-print "\n"
-print 'Usage Type: ' + record['usagetype'] + "\n"
 
-i2l.close()
-```
+## Web Service
+Below is the description of the functions available in the **Web Service** lookup.
 
-# Sample BIN Databases
+| Function Name | Description |
+|---|---|
+| Constructor | Expect 2 input parameters:<ol><li>IP2Location API Key.</li><li>Package (WS1 - WS24)</li></ol> |
+| lookup | Return the IP information in array.<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>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> |
+| get_credit | Return remaining credit of the web service account. |
 
-* Download free IP2Location LITE databases at [https://lite.ip2location.com](https://lite.ip2location.com)  
-* Download IP2Location sample databases at [https://www.ip2location.com/developers](https://www.ip2location.com/developers)
+# Dependencies
+This library requires IP2Location BIN data file to function. You may download the BIN data file at
+* IP2Location LITE BIN Data (Free): https://lite.ip2location.com
+* IP2Location Commercial BIN Data (Comprehensive): https://www.ip2location.com
 
-# IPv4 BIN vs IPv6 BIN
+An outdated BIN database was provided in the library for your testing. You are recommended to visit the above links to download the latest BIN database.
+
+You can also sign up for [IP2Location Web Service](https://www.ip2location.com/web-service/ip2location) to lookup by IP2Location API.
 
+# IPv4 BIN vs IPv6 BIN
 * Use the IPv4 BIN file if you just need to query IPv4 addresses.
 * Use the IPv6 BIN file if you need to query BOTH IPv4 and IPv6 addresses.
 

data/VERSION

@@ -1 +1 @@
-8.1.1
+8.2.0

data/example.rb

@@ -1,5 +1,6 @@
 require 'ip2location_ruby'
 
+# BIN Database
 i2l = Ip2location.new.open("./data/IP2LOCATION-LITE-DB1.IPV6.BIN")
 record = i2l.get_all('8.8.8.8')
 
@@ -30,4 +31,11 @@ print record['elevation']
 print "\n"
 print 'Usage Type: ' + record['usagetype'] + "\n"
 
-i2l.close()
+i2l.close()
+
+# Web Service
+ws = Ip2locationWebService.new('demo', 'WS24')
+record = ws.lookup('8.8.8.8', 'continent,country,region,city,geotargeting,country_groupings,time_zone_info', 'en')
+print record
+print "\n"
+print ws.get_credit()

data/ip2location_ruby.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "ip2location_ruby"
-  s.version = "8.1.1"
+  s.version = "8.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]

data/lib/ip2location_ruby.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
 require 'bindata'
 require 'ipaddr'
+require 'net/http'
+require 'json'
 require 'ip2location_ruby/ip2location_config'
 require 'ip2location_ruby/database_config'
 require 'ip2location_ruby/i2l_float_data'
@@ -535,5 +537,43 @@ class Ip2location
   end
 
   private :get_record, :bsearch, :get_from_to, :read32, :readipv6
+end
 
+class Ip2locationWebService
+  attr_accessor :ws_api_key, :ws_package
+
+  def initialize(api_key, package)
+    if !api_key.match(/^[0-9A-Z]{10}$/) && api_key != 'demo'
+      raise Exception.new "Please provide a valid IP2Location web service API key."
+    end
+    if !package.match(/^WS[0-9]+$/)
+      package = 'WS1'
+    end
+    self.ws_api_key = api_key
+    self.ws_package = package
+  end
+
+  def lookup(ip, add_ons, language)
+    response =  Net::HTTP.get(URI("https://api.ip2location.com/v2/?key=" + self.ws_api_key + "&ip=" + ip + "&package=" + self.ws_package + "&format=json&addon=" + add_ons + "&lang=" + language))
+    parsed_response = JSON.parse(response)
+    if parsed_response.nil?
+      return false
+    end
+    if !parsed_response["response"].nil?
+      raise Exception.new "Error: " + parsed_response["response"]
+    end
+    return parsed_response
+  end
+
+  def get_credit()
+    response =  Net::HTTP.get(URI("https://api.ip2location.com/v2/?key=" + self.ws_api_key + "&check=true"))
+    parsed_response = JSON.parse(response)
+    if parsed_response.nil?
+      return 0
+    end
+    if parsed_response["response"].nil?
+      return 0
+    end
+    return parsed_response["response"]
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ip2location_ruby
 version: !ruby/object:Gem::Version
-  version: 8.1.1
+  version: 8.2.0
 platform: ruby
 authors:
 - ip2location
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-24 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata