Added support for fraud score

Author: ip2location

LICENSE.txt

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

docs/source/code.md

@@ -1,15 +1,14 @@
 # IP2Proxy Ruby API
 
 ## Database Class
-```{py:function} open(database_file_path, file_mode)
+```{py:function} open(database_file_path)
 Load the IP2Proxy BIN database.
 
 :param str database_file_path: (Required) The file path links to IP2Location BIN databases.
-:param str file_mode: (Optional) Caching mode (one of FILE_IO, MEMORY_CACHE, or SHARED_MEMORY).
 ```
 
 ```{py:function} get_package_version()
-Return the database's type, 1 to 10 respectively for PX1 to PX11. Please visit https://www.ip2location.com/databases/ip2proxy for details.
+Return the database's type, 1 to 12 respectively for PX1 to PX12. Please visit https://www.ip2location.com/databases/ip2proxy for details.
 
 :return: Returns the package version.
 :rtype: string
@@ -40,17 +39,18 @@ Retrieve geolocation information for an IP address.
 
 | Field Name       | Description                                                  |
 | ---------------- | ------------------------------------------------------------ |
-| countryCode    |     Two-character country code based on ISO 3166. |
-| countryName    |     Country name based on ISO 3166. |
-| regionName     |     Region or state name. |
-| cityName       |     City name. |
-| isp            |     Internet Service Provider or company\'s name. |
-| domain         |     Internet domain name associated with IP address range. |
-| usageType      |     Usage type classification of ISP or company. |
-| asn            |     Autonomous system number (ASN). |
-| as             |     Autonomous system (AS) name. |
-| lastSeen       |     Proxy last seen in days. |
-| threat         |     Security threat reported. |
-| proxyType      |     Type of proxy. |
-| provider       |     Name of VPN provider if available. |
+| country_short    |     Two-character country code based on ISO 3166. |
+| country_long     |     Country name based on ISO 3166. |
+| region           |     Region or state name. |
+| city             |     City name. |
+| isp              |     Internet Service Provider or company\'s name. |
+| domain           |     Internet domain name associated with IP address range. |
+| usagetype        |     Usage type classification of ISP or company. |
+| asn              |     Autonomous system number (ASN). |
+| as               |     Autonomous system (AS) name. |
+| last_seen        |     Proxy last seen in days. |
+| threat           |     Security threat reported. |
+| is_proxy         |     Type of proxy. |
+| provider         |     Name of VPN provider if available. |
+| fraud_score      |     Potential risk score (0 - 99) associated with IP address. |
 ```

docs/source/index.md

@@ -2,7 +2,7 @@
 [![Total Downloads](https://img.shields.io/gem/dt/ip2proxy_ruby.svg)](https://rubygems.org/gems/ip2proxy_ruby)
 
 # 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, residential proxies, consumer privacy networks, and enterprise private networks 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 or web service.
+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, residential proxies, consumer privacy networks, and enterprise private networks 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, provider names and potential risk score associated with IP address. It lookup the proxy IP address from **IP2Proxy BIN Data** file or web service.
 
 For more details, please visit:
 [https://www.ip2location.com/ip2proxy/developers/ruby](https://www.ip2location.com/ip2proxy/developers/ruby)

docs/source/quickstart.md

@@ -30,7 +30,7 @@ You can query the geolocation information from the IP2Proxy BIN database as belo
 require 'ip2proxy_ruby'
 
 # open IP2Proxy BIN database for proxy lookup
-i2p = Ip2proxy.new.open("./data/PX11.SAMPLE.BIN")
+i2p = Ip2proxy.new.open("./data/PX12.SAMPLE.BIN")
 
 # get versioning information
 print 'Module Version: ' + i2p.get_module_version + "\n"
@@ -52,6 +52,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"
+print 'Fraud Score: ' + i2p.get_fraud_score('1.2.3.4') + "\n"
 
 # single function to get all proxy data returned in array
 record = i2p.get_all('1.2.3.4')
@@ -69,6 +70,7 @@ print 'AS: ' + record['as'] + "\n"
 print 'Last Seen: ' + record['last_seen'] + "\n"
 print 'Threat: ' + record['threat'] + "\n"
 print 'Provider: ' + record['provider'] + "\n"
+print 'Fraud Score: ' + record['fraud_score'] + "\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/PX11.SAMPLE.BIN")
+i2p = Ip2proxy.new.open("./data/PX12.SAMPLE.BIN")
 
 # get versioning information
 print 'Module Version: ' + i2p.get_module_version + "\n"
@@ -23,6 +23,7 @@
 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"
+print 'Fraud Score: ' + i2p.get_fraud_score('1.2.3.4') + "\n"
 
 # single function to get all proxy data returned in array
 record = i2p.get_all('1.2.3.4')
@@ -40,6 +41,7 @@
 print 'Last Seen: ' + record['last_seen'] + "\n"
 print 'Threat: ' + record['threat'] + "\n"
 print 'Provider: ' + record['provider'] + "\n"
+print 'Fraud Score: ' + record['fraud_score'] + "\n"
 
 # close IP2Proxy BIN database
 i2p.close()

ip2proxy_ruby.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = "ip2proxy_ruby"
-  s.version       = "3.3.1"
+  s.version       = "3.4.0"
   s.authors       = ["ip2location"]
   s.email         = ["[email protected]"]
 
@@ -31,15 +31,16 @@ 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/PX11.SAMPLE.BIN",
+    "spec/assets/PX12.SAMPLE.BIN",
     "spec/ip2proxy_ruby_database_spec.rb",
     "spec/spec_helper.rb",
-    "rb/data/PX11.SAMPLE.BIN"
+    "rb/data/PX12.SAMPLE.BIN"
   ]
 
   if s.respond_to?(:metadata=)
     s.metadata = {
       "bug_tracker_uri" => "https://github.com/ip2location/ip2proxy-ruby/issues",
+      "documentation_uri" => "https://www.rubydoc.info/gems/ip2proxy_ruby",
       "homepage_uri" => "https://www.ip2location.com",
       "source_code_uri" => "https://github.com/ip2location/ip2proxy-ruby",
     }

lib/ip2proxy_ruby.rb

@@ -11,7 +11,7 @@
 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, :last_err_msg
 
-  VERSION = '3.3.1'
+  VERSION = '3.4.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.'
@@ -322,6 +322,21 @@ def get_provider(ip)
     return provider
   end
 
+  def get_fraud_score(ip)
+    valid = !(IPAddr.new(ip) rescue nil).nil?
+    if valid
+        rec = get_record(ip)
+        if !(rec.nil?)
+            fraud_score = (defined?(rec.fraud_score) && rec.fraud_score != '') ? rec.fraud_score : FIELD_NOT_SUPPORTED
+        else
+            fraud_score = INVALID_IP_ADDRESS
+        end
+    else
+        fraud_score = INVALID_IP_ADDRESS
+    end
+    return fraud_score
+  end
+
   def get_all(ip)
     valid = !(IPAddr.new(ip) rescue nil).nil?
     if valid
@@ -340,6 +355,7 @@ def get_all(ip)
             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
+            fraud_score = (defined?(rec.fraud_score) && rec.fraud_score != '') ? rec.fraud_score : FIELD_NOT_SUPPORTED
             if self.db_index == 1
                 isproxy = (rec.country_short == '-') ? 0 : 1
             else
@@ -359,6 +375,7 @@ def get_all(ip)
             last_seen = INVALID_IP_ADDRESS
             threat = INVALID_IP_ADDRESS
             provider = INVALID_IP_ADDRESS
+            fraud_score = INVALID_IP_ADDRESS
             isproxy = -1
         end
     else
@@ -375,6 +392,7 @@ def get_all(ip)
         last_seen = INVALID_IP_ADDRESS
         threat = INVALID_IP_ADDRESS
         provider = INVALID_IP_ADDRESS
+        fraud_score = INVALID_IP_ADDRESS
         isproxy = -1
     end
     results = {}
@@ -392,6 +410,7 @@ def get_all(ip)
     results['last_seen'] = last_seen
     results['threat'] = threat
     results['provider'] = provider
+    results['fraud_score'] = fraud_score
     return results
   end
 

lib/ip2proxy_ruby/i2p_database_config.rb

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