Added provider field and exception handling for incorrect BIN database.

Author: ip2location

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2019 IP2Location ( [email protected] )
+Copyright (c) 2021 IP2Location ( [email protected] )
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -3,7 +3,7 @@
 
 # IP2Proxy Ruby Library
 
-This module allows user to reverse search of IP address to detect VPN servers, open proxies, web proxies, Tor exit nodes, search engine robots, data center ranges and residential proxies using IP2Proxy BIN database. Other information available includes proxy type, country, state, city,  ISP, domain name, usage type, AS number, AS name, threats and last seen date.
+This module allows user to reverse search of IP address to detect VPN servers, open proxies, web proxies, Tor exit nodes, search engine robots, data center ranges and residential proxies using IP2Proxy BIN database. Other information available includes proxy type, country, state, city,  ISP, domain name, usage type, AS number, AS name, threats, last seen date and provider names.
 
 It lookup the proxy IP address from **IP2Proxy BIN Data** file. This data file can be downloaded at
 
@@ -22,12 +22,12 @@ Below are the methods supported in this module.
 |---|---|
 |open|Open the IP2Proxy BIN data with **File I/O** mode for lookup.|
 |close|Close and clean up the file pointer.|
-|get_package_version|Get the package version (1 to 10 for PX1 to PX10 respectively).|
+|get_package_version|Get the package version (1 to 10 for PX1 to PX11 respectively).|
 |get_module_version|Get the module version.|
 |get_database_version|Get the database version.|
 |is_proxy|Check whether if an IP address was a proxy. Please see [Proxy Type](#proxy-type) for details. Returned value:<ul><li>-1 : errors</li><li>0 : not a proxy</li><li>1 : a proxy</li><li>2 : a data center IP address</li></ul>|
 |get_all|Return the proxy information in array.|
-|get_proxytype|Return the proxy type. Please visit <a href="https://www.ip2location.com/database/px10-ip-proxytype-country-region-city-isp-domain-usagetype-asn-lastseen-threat-residential" target="_blank">IP2Location</a> for the list of proxy types supported|
+|get_proxytype|Return the proxy type. Please visit <a href="https://www.ip2location.com/database/px11-ip-proxytype-country-region-city-isp-domain-usagetype-asn-lastseen-threat-residential-provider" target="_blank">IP2Location</a> for the list of proxy types supported|
 |get_country_short|Return the ISO3166-1 country code (2-digits) of the proxy.|
 |get_country_long|Return the ISO3166-1 country name of the proxy.|
 |get_region|Return the ISO3166-2 region name of the proxy. Please visit <a href="https://www.ip2location.com/free/iso3166-2" target="_blank">ISO3166-2 Subdivision Code</a> for the information of ISO3166-2 supported|
@@ -39,14 +39,15 @@ Below are the methods supported in this module.
 |get_as|Return the autonomous system (AS) name of proxy's IP address or domain name.|
 |get_last_seen|Return the last seen days ago value of proxy's IP address or domain name.|
 |get_threat|Return the threat types reported to proxy's IP address or domain name. Please see [Threat Type](#threat-type) for details.|
+|get_provider|Returns the VPN service provider name if available.|
 
 ## Usage
 
 ```
 require 'ip2proxy_ruby'
 
 # open IP2Proxy BIN database for proxy lookup
-i2p = Ip2proxy.new.open("./data/IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL.BIN")
+i2p = Ip2proxy.new.open("./data/IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL-PROVIDER.BIN")
 
 # get versioning information
 print 'Module Version: ' + i2p.get_module_version + "\n"
@@ -67,6 +68,7 @@ print 'ASN: ' + i2p.get_asn('1.2.3.4') + "\n"
 print 'AS: ' + i2p.get_as('1.2.3.4') + "\n"
 print 'Last Seen: ' + i2p.get_last_seen('1.2.3.4') + "\n"
 print 'Threat: ' + i2p.get_threat('1.2.3.4') + "\n"
+print 'Provider: ' + i2p.get_provider('1.2.3.4') + "\n"
 
 # single function to get all proxy data returned in array
 record = i2p.get_all('1.2.3.4')
@@ -83,6 +85,7 @@ print 'ASN: ' + record['asn'] + "\n"
 print 'AS: ' + record['as'] + "\n"
 print 'Last Seen: ' + record['last_seen'] + "\n"
 print 'Threat: ' + record['threat'] + "\n"
+print 'Provider: ' + record['provider'] + "\n"
 
 # close IP2Proxy BIN database
 i2p.close()

example.rb

@@ -1,7 +1,7 @@
 require 'ip2proxy_ruby'
 
 # open IP2Proxy BIN database for proxy lookup
-i2p = Ip2proxy.new.open("./data/IP2PROXY-LITE-PX1.BIN")
+i2p = Ip2proxy.new.open("./data/PX11.SAMPLE.BIN")
 
 # get versioning information
 print 'Module Version: ' + i2p.get_module_version + "\n"
@@ -22,6 +22,7 @@
 print 'AS: ' + i2p.get_as('1.2.3.4') + "\n"
 print 'Last Seen: ' + i2p.get_last_seen('1.2.3.4') + "\n"
 print 'Threat: ' + i2p.get_threat('1.2.3.4') + "\n"
+print 'Provider: ' + i2p.get_provider('1.2.3.4') + "\n"
 
 # single function to get all proxy data returned in array
 record = i2p.get_all('1.2.3.4')
@@ -38,6 +39,7 @@
 print 'AS: ' + record['as'] + "\n"
 print 'Last Seen: ' + record['last_seen'] + "\n"
 print 'Threat: ' + record['threat'] + "\n"
+print 'Provider: ' + record['provider'] + "\n"
 
 # close IP2Proxy BIN database
 i2p.close()

ip2proxy_ruby.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name          = "ip2proxy_ruby"
-  s.version       = "3.0.1"
+  s.version       = "3.1.0"
   s.authors       = ["ip2location"]
   s.email         = ["[email protected]"]
 
   s.summary       = "IP2Proxy Ruby library"
-  s.description   = "The official IP2Proxy Ruby library to detect VPN servers, open proxies, web proxies, Tor exit nodes, search engine robots, data center ranges and residential proxies using IP2Proxy BIN database. Other information available includes proxy type, country, state, city, ISP, domain name, usage type, AS number, AS name, threats and last seen date."
+  s.description   = "The official IP2Proxy Ruby library to detect VPN servers, open proxies, web proxies, Tor exit nodes, search engine robots, data center ranges and residential proxies using IP2Proxy BIN database. Other information available includes proxy type, country, state, city, ISP, domain name, usage type, AS number, AS name, threats, last seen date and provider names."
   s.homepage      = "https://github.com/ip2location/ip2proxy-ruby"
   s.licenses      = ["MIT"]
   s.require_paths = ["lib"]
@@ -31,10 +31,10 @@ Gem::Specification.new do |s|
     "lib/ip2proxy_ruby/i2p_string_data.rb",
     "lib/ip2proxy_ruby/ip2proxy_config.rb",
     "lib/ip2proxy_ruby/ip2proxy_record.rb",
-    "spec/assets/PX10.SAMPLE.BIN",
+    "spec/assets/PX11.SAMPLE.BIN",
     "spec/ip2proxy_ruby_database_spec.rb",
     "spec/spec_helper.rb",
-    "rb/data/PX10.SAMPLE.BIN"
+    "rb/data/PX11.SAMPLE.BIN"
   ]
 
   if s.respond_to?(:metadata=)

lib/ip2proxy_ruby.rb

@@ -7,15 +7,36 @@
 require_relative 'ip2proxy_ruby/ip2proxy_record'
 
 class Ip2proxy
-  attr_accessor :record_class4, :record_class6, :v4, :file, :db_index, :count, :base_addr, :ipno, :record, :database, :columns, :ip_version, :ipv4databasecount, :ipv4databaseaddr, :ipv4indexbaseaddr, :ipv6databasecount, :ipv6databaseaddr, :ipv6indexbaseaddr, :databaseyear, :databasemonth, :databaseday 
+  attr_accessor :record_class4, :record_class6, :v4, :file, :db_index, :count, :base_addr, :ipno, :record, :database, :columns, :ip_version, :ipv4databasecount, :ipv4databaseaddr, :ipv4indexbaseaddr, :ipv6databasecount, :ipv6databaseaddr, :ipv6indexbaseaddr, :databaseyear, :databasemonth, :databaseday, :last_err_msg
 
-  VERSION = '3.0.1'
+  VERSION = '3.1.0'
   FIELD_NOT_SUPPORTED = 'NOT SUPPORTED'
   INVALID_IP_ADDRESS = 'INVALID IP ADDRESS'
+  INVALID_BIN_DATABASE = 'Incorrect IP2Proxy BIN file format. Please make sure that you are using the latest IP2Proxy BIN file.'
 
   def open(url)
-    self.file = File.open(File.expand_path url, 'rb')
+    if url == ''
+        self.last_err_msg = 'Ip2proxy.new.open() requires a database path name.'
+        abort('Ip2proxy.new.open() requires a database path name.')
+    end
+
+    begin
+        self.file = File.open(File.expand_path url, 'rb')
+    rescue
+        self.last_err_msg = 'Ip2proxy.new.open() error in opening ' + url +'.'
+        abort('Ip2proxy.new.open() error in opening ' + url +'.')
+    else
+    end
     i2p = Ip2proxyConfig.read(file)
+    if i2p.productcode == 2
+    else
+        if i2p.databaseyear <= 20 && i2p.productcode == 0
+        else
+            self.file.close
+            self.last_err_msg = INVALID_BIN_DATABASE
+            abort(INVALID_BIN_DATABASE)
+        end
+    end
     self.db_index = i2p.databasetype
     self.columns = i2p.databasecolumn + 0
     self.databaseyear = 2000 + i2p.databaseyear
@@ -37,6 +58,10 @@ def close()
     self.file.close
   end
 
+  def get_last_error_message()
+    return self.last_err_msg
+  end
+
   def get_module_version()
     return VERSION
   end
@@ -281,6 +306,21 @@ def is_proxy(ip)
     return isproxy
   end
 
+  def get_provider(ip)
+    valid = !(IPAddr.new(ip) rescue nil).nil?
+    if valid
+        rec = get_record(ip)
+        if !(rec.nil?)
+            provider = (defined?(rec.provider) && rec.provider != '') ? rec.provider : FIELD_NOT_SUPPORTED
+        else
+            provider = INVALID_IP_ADDRESS
+        end
+    else
+        provider = INVALID_IP_ADDRESS
+    end
+    return provider
+  end
+
   def get_all(ip)
     valid = !(IPAddr.new(ip) rescue nil).nil?
     if valid
@@ -298,6 +338,7 @@ def get_all(ip)
             as = (defined?(rec.as) && rec.as != '') ? rec.as : FIELD_NOT_SUPPORTED
             last_seen = (defined?(rec.lastseen) && rec.lastseen != '') ? rec.lastseen : FIELD_NOT_SUPPORTED
             threat = (defined?(rec.threat) && rec.threat != '') ? rec.threat : FIELD_NOT_SUPPORTED
+            provider = (defined?(rec.provider) && rec.provider != '') ? rec.provider : FIELD_NOT_SUPPORTED
             if self.db_index == 1
                 isproxy = (rec.country_short == '-') ? 0 : 1
             else
@@ -316,6 +357,7 @@ def get_all(ip)
             as = INVALID_IP_ADDRESS
             last_seen = INVALID_IP_ADDRESS
             threat = INVALID_IP_ADDRESS
+            provider = INVALID_IP_ADDRESS
             isproxy = -1
         end
     else
@@ -331,6 +373,7 @@ def get_all(ip)
         as = INVALID_IP_ADDRESS
         last_seen = INVALID_IP_ADDRESS
         threat = INVALID_IP_ADDRESS
+        provider = INVALID_IP_ADDRESS
         isproxy = -1
     end
     results = {}
@@ -347,6 +390,7 @@ def get_all(ip)
     results['as'] = as
     results['last_seen'] = last_seen
     results['threat'] = threat
+    results['provider'] = provider
     return results
   end
 

lib/ip2proxy_ruby/i2p_database_config.rb

@@ -1,16 +1,17 @@
 class I2pDbConfig 
   COLUMNS = { 
-     :COUNTRY                  => [0, 2, 3, 3, 3, 3, 3, 3, 3, 3, 3],
-     :REGION                   => [0, 0, 0, 4, 4, 4, 4, 4, 4, 4, 4],
-     :CITY                     => [0, 0, 0, 5, 5, 5, 5, 5, 5, 5, 5],
-     :ISP                      => [0, 0, 0, 0, 6, 6, 6, 6, 6, 6, 6],
-     :PROXYTYPE                => [0, 0, 2, 2, 2, 2, 2, 2, 2, 2, 2],
-     :DOMAIN                   => [0, 0, 0, 0, 0, 7, 7, 7, 7, 7, 7],
-     :USAGETYPE                => [0, 0, 0, 0, 0, 0, 8, 8, 8, 8, 8],
-     :ASN                      => [0, 0, 0, 0, 0, 0, 0, 9, 9, 9, 9],
-     :AS                       => [0, 0, 0, 0, 0, 0, 0, 10, 10, 10, 10],
-     :LASTSEEN                 => [0, 0, 0, 0, 0, 0, 0, 0, 11, 11, 11],
-     :THREAT                   => [0, 0, 0, 0, 0, 0, 0, 0, 0, 12, 12]
+     :COUNTRY                  => [0, 2, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3],
+     :REGION                   => [0, 0, 0, 4, 4, 4, 4, 4, 4, 4, 4, 4],
+     :CITY                     => [0, 0, 0, 5, 5, 5, 5, 5, 5, 5, 5, 5],
+     :ISP                      => [0, 0, 0, 0, 6, 6, 6, 6, 6, 6, 6, 6],
+     :PROXYTYPE                => [0, 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2],
+     :DOMAIN                   => [0, 0, 0, 0, 0, 7, 7, 7, 7, 7, 7, 7],
+     :USAGETYPE                => [0, 0, 0, 0, 0, 0, 8, 8, 8, 8, 8, 8],
+     :ASN                      => [0, 0, 0, 0, 0, 0, 0, 9, 9, 9, 9, 9],
+     :AS                       => [0, 0, 0, 0, 0, 0, 0, 10, 10, 10, 10, 10],
+     :LASTSEEN                 => [0, 0, 0, 0, 0, 0, 0, 0, 11, 11, 11, 11],
+     :THREAT                   => [0, 0, 0, 0, 0, 0, 0, 0, 0, 12, 12, 12],
+     :PROVIDER                 => [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 13]
    }
 
  def self.setup_database(db_index)

lib/ip2proxy_ruby/ip2proxy_config.rb

@@ -1,17 +1,20 @@
 class Ip2proxyConfig < BinData::Record
   endian :little
-	uint8 :databasetype
-	uint8 :databasecolumn
-	uint8 :databaseyear
-	uint8 :databasemonth
-	uint8 :databaseday
-	# uint32 :databasecount
-	# uint32 :databaseaddr
-	# uint32 :ipversion
+  uint8 :databasetype
+  uint8 :databasecolumn
+  uint8 :databaseyear
+  uint8 :databasemonth
+  uint8 :databaseday
+  # uint32 :databasecount
+  # uint32 :databaseaddr
+  # uint32 :ipversion
   uint32 :ipv4databasecount
   uint32 :ipv4databaseaddr
   uint32 :ipv6databasecount
   uint32 :ipv6databaseaddr
   uint32 :ipv4indexbaseaddr
   uint32 :ipv6indexbaseaddr
+  uint8 :productcode
+  uint8 :licensecode
+  uint32 :databasesize
 end