ip2proxy_ruby 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e85aa655931de9dec06fe78849d14e570b6410859cf0db44d14eaec4788b65ab
-  data.tar.gz: b11479694f3df231134bb86bcfbbb858d758b80bb73f59be2a5c45309372fbf9
+  metadata.gz: 30a6be5f8b9be3046d9450d970a996f61f07d49c35dc8ad44036f534457e8cb1
+  data.tar.gz: 7b2babc2892f5f6c29d5038ab86d23da675e7cd0acadac7bf035e2ab2f2fff39
 SHA512:
-  metadata.gz: 8a54a2ecc9cc1476f4695c3fac314f6df50c174b170e5b3a4a7c9a417cf46a5b1d8372378612eb40c1cd5b140baa22dd82f69fb71989d82a1c40421f9db35007
-  data.tar.gz: fd0d1ef56dcd0c47d8180047f89ebb301195e1a9cdc09f1908661dc4a383c056363b3e50c19e81f9fe36b2f78c66d648efbf0fe63445dadae088535d83b90f39
+  metadata.gz: 0304a809be3a8fc3e87265b2c93811a91aa6595d1ce535132db963d114a6ec4b9e2102dc2418f99d3812ada25cc18fff631065387e9b1aff3dad777ac1c598c8
+  data.tar.gz: 6faecc7b8ca06d0b0221fa926d587d45bd9e447f881f1b0e7a84e3873adb6a7af831ba9d37fe5105f6f7e46e82113e89f968735c30d401a67dafa6fcc4c85889

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2021 IP2Location ( support@ip2location.com )
+Copyright (c) 2022 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,27 +2,24 @@
 [![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 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
-
-* Free IP2Proxy BIN Data: https://lite.ip2location.com
-* Commercial IP2Proxy BIN Data: https://www.ip2location.com/proxy-database
-
+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 or web service.
 
 For more details, please visit:
 [https://www.ip2location.com/ip2proxy/developers/ruby](https://www.ip2location.com/ip2proxy/developers/ruby)
 
-## Methods
+# Usage
+You can check the **example.rb** file to learn more about usage.
+
+## BIN Database
+An outdated BIN database was provided in the library for your testing. You are recommended to visit the [links](#dependencies) to download the latest BIN database and save it in the ```rb``` folder.
 
-Below are the methods supported in this module.
+Below is the description of the functions available in the **BIN Database** lookup.
 
 |Method Name|Description|
 |---|---|
 |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 PX11 respectively).|
+|get_package_version|Get the package version (1 to 11 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>|
@@ -41,55 +38,14 @@ Below are the methods supported in this module.
 |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-PROVIDER.BIN")
-
-# get versioning information
-print 'Module Version: ' + i2p.get_module_version + "\n"
-print 'Package Version: ' + i2p.get_package_version + "\n"
-print 'Database Version: ' + i2p.get_database_version + "\n"
-
-# individual proxy data check
-print 'Is Proxy: ' + i2p.is_proxy('1.2.3.4').to_s + "\n"
-print 'Proxy Type: ' + i2p.get_proxytype('1.2.3.4') + "\n"
-print 'Country Code: ' + i2p.get_country_short('1.2.3.4') + "\n"
-print 'Country Name: ' + i2p.get_country_long('1.2.3.4') + "\n"
-print 'Region Name: ' + i2p.get_region('1.2.3.4') + "\n"
-print 'City Name: ' + i2p.get_city('1.2.3.4') + "\n"
-print 'ISP: ' + i2p.get_isp('1.2.3.4') + "\n"
-print 'Domain: ' + i2p.get_domain('1.2.3.4') + "\n"
-print 'Usage Type: ' + i2p.get_usagetype('1.2.3.4') + "\n"
-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')
-print 'is Proxy: ' + record['is_proxy'].to_s + "\n"
-print 'Proxy Type: ' + record['proxy_type'] + "\n"
-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 'ISP: ' + record['isp'] + "\n"
-print 'Domain: ' + record['domain'] + "\n"
-print 'Usage Type: ' + record['usagetype'] + "\n"
-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()
-```
+## Web Service
+Below is the description of the functions available in the **Web Service** lookup.
+
+| Function Name | Description |
+|---|---|
+| Constructor | Expect 3 input parameters:<ol><li>IP2Proxy API Key.</li><li>Package (PX1 - PX11)</li></li><li>Use HTTPS or HTTP</li></ol> |
+| lookup | Return the proxy information in array.<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> |
+| get_credit | Return remaining credit of the web service account. |
 
 ### Proxy Type
 
@@ -128,7 +84,15 @@ i2p.close()
 |SCANNER|Security Scanner or Attack|
 |BOTNET|Spyware or Malware|
 
-## Support
+# Dependencies
+
+This library requires IP2Proxy BIN data file to function. You may download the BIN data file at
+* IP2Proxy LITE BIN Data (Free): https://lite.ip2location.com
+* IP2Proxy Commercial BIN Data (Comprehensive): https://www.ip2location.com/proxy-database
+
+You can also sign up for [IP2Proxy Web Service](https://www.ip2location.com/web-service/ip2proxy) to lookup by IP2Proxy API.
+
+# Support
 
 Email: support@ip2location.com  
 URL: [https://www.ip2location.com](https://www.ip2location.com)

data/example.rb

@@ -42,4 +42,11 @@ print 'Threat: ' + record['threat'] + "\n"
 print 'Provider: ' + record['provider'] + "\n"
 
 # close IP2Proxy BIN database
-i2p.close()
+i2p.close()
+
+# Web Service
+ws = Ip2proxyWebService.new('demo', 'PX11', true)
+record = ws.lookup('1.2.3.4')
+print record
+print "\n"
+print ws.get_credit()

data/ip2proxy_ruby.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = "ip2proxy_ruby"
-  s.version       = "3.1.0"
+  s.version       = "3.3.0"
   s.authors       = ["ip2location"]
   s.email         = ["support@ip2location.com"]
 
@@ -51,18 +51,18 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<bindata>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<rdoc>, [">= 6.3.1"])
       s.add_development_dependency(%q<bundler>, [">= 1.2.0"])
     else
       s.add_dependency(%q<bindata>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<rdoc>, [">= 6.3.1"])
       s.add_dependency(%q<bundler>, [">= 1.2.0"])
     end
   else
     s.add_dependency(%q<bindata>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<rdoc>, [">= 6.3.1"])
     s.add_dependency(%q<bundler>, [">= 1.2.0"])
   end
 end

data/lib/ip2proxy_ruby.rb

@@ -1,5 +1,7 @@
 require 'bindata'
 require 'ipaddr'
+require 'net/http'
+require 'json'
 require_relative 'ip2proxy_ruby/ip2proxy_config'
 require_relative 'ip2proxy_ruby/i2p_database_config'
 require_relative 'ip2proxy_ruby/i2p_string_data'
@@ -9,7 +11,7 @@ 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, :last_err_msg
 
-  VERSION = '3.1.0'
+  VERSION = '3.3.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.'
@@ -24,7 +26,7 @@ class Ip2proxy
         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 +'.')
+        abort('Ip2proxy.new.open() error in opening ' + url + '. No such file in the /your_ip2proxy_ruby_library_path/rb/ folder.')
     else
     end
     i2p = Ip2proxyConfig.read(file)
@@ -99,8 +101,7 @@ class Ip2proxy
                 ipnum = realipno - 1
             end
         end
-        low = read32(indexpos)
-        high = read32(indexpos + 4)
+        low, high = read32x2(indexpos)
         return self.record = bsearch(low, high, ipnum, self.base_addr, col_length)
     else
         return self.record = bsearch(0, self.count, ipnum, self.base_addr, col_length)
@@ -417,11 +418,12 @@ class Ip2proxy
   end
 
   def get_from_to(mid, base_addr, col_length)
-    from_base = ( base_addr + mid * (col_length + (v4 ? 0 : 12)))
+    from_base = (base_addr + mid * (col_length + (v4 ? 0 : 12)))
+    data_length = col_length + (v4 ? 4 : (12 + 16))
     file.seek(from_base)
-    ip_from = v4 ? file.read(4).unpack('V').first : readipv6(file)
-    file.seek(from_base + col_length + (v4 ? 0 : 12))
-    ip_to = v4 ? file.read(4).unpack('V').first : readipv6(file)
+    data_read = file.read(data_length)
+    ip_from = v4 ? data_read[0..3].unpack('V').first : readipv6(data_read[0..15].unpack('V*'))
+    ip_to = v4 ? data_read[(data_length - 4)..(data_length - 1)].unpack('V').first : readipv6(data_read[(data_length - 16)..(data_length - 1)].unpack('V*'))
     [ip_from, ip_to]
   end
 
@@ -457,16 +459,69 @@ class Ip2proxy
     [ipv, ipnum]
   end
 
-  def read32(indexp)
+  def read32x2(indexp)
     file.seek(indexp - 1)
-    return file.read(4).unpack('V').first
+    data_read = file.read(8)
+    data1 = data_read[0..3].unpack('V').first
+    data2 = data_read[4..7].unpack('V').first
+    return [data1, data2]
   end
 
-  def readipv6(filer)
-    parts = filer.read(16).unpack('V*')
+  def readipv6(parts)
     return parts[0] + parts[1] * 4294967296 + parts[2] * 4294967296**2 + parts[3] * 4294967296**3
   end
 
-  private :get_record, :bsearch, :get_from_to, :read32, :readipv6
+  private :get_record, :bsearch, :get_from_to, :read32x2, :readipv6
 
+end
+
+class Ip2proxyWebService
+  attr_accessor :ws_api_key, :ws_package, :ws_use_ssl
+
+  def initialize(api_key, package, use_ssl)
+    if !api_key.match(/^[0-9A-Z]{10}$/) && api_key != 'demo'
+      raise Exception.new "Please provide a valid IP2Proxy web service API key."
+    end
+    if !package.match(/^PX[0-9]+$/)
+      package = 'PX1'
+    end
+    if use_ssl == ''
+      use_ssl = true
+    end
+    self.ws_api_key = api_key
+    self.ws_package = package
+    self.ws_use_ssl = use_ssl
+  end
+
+  def lookup(ip)
+    if self.ws_use_ssl
+      response =  Net::HTTP.get(URI("https://api.ip2proxy.com/?key=" + self.ws_api_key + "&ip=" + ip + "&package=" + self.ws_package + "&format=json"))
+    else
+      response =  Net::HTTP.get(URI("http://api.ip2proxy.com/?key=" + self.ws_api_key + "&ip=" + ip + "&package=" + self.ws_package + "&format=json"))
+    end
+    parsed_response = JSON.parse(response)
+    if parsed_response.nil?
+      return false
+    end
+    if parsed_response["response"] != "OK"
+      raise Exception.new "Error: " + parsed_response["response"]
+    end
+    return parsed_response
+  end
+
+  def get_credit()
+    if self.ws_use_ssl
+      response =  Net::HTTP.get(URI("https://api.ip2proxy.com/?key=" + self.ws_api_key + "&check=true"))
+    else
+      response =  Net::HTTP.get(URI("http://api.ip2proxy.com/?key=" + self.ws_api_key + "&check=true"))
+    end
+    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

data/spec/ip2proxy_ruby_database_spec.rb

@@ -106,7 +106,7 @@ describe "Ip2proxy" do
   it "work correctly with get_module_version" do
     i2p = Ip2proxy.new.open(File.dirname(__FILE__) + "/assets/PX11.SAMPLE.BIN")
     record = i2p.get_module_version()
-    expect(record).to eq '3.1.0'
+    expect(record).to eq '3.3.0'
   end
 
   it "work correctly with get_package_version" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ip2proxy_ruby
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.0
 platform: ruby
 authors:
 - ip2location
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2022-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -42,16 +42,16 @@ dependencies:
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 6.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 6.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -104,7 +104,7 @@ metadata:
   bug_tracker_uri: https://github.com/ip2location/ip2proxy-ruby/issues
   homepage_uri: https://www.ip2location.com
   source_code_uri: https://github.com/ip2location/ip2proxy-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,9 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: IP2Proxy Ruby library
 test_files: []