ip2location_ruby 8.3.1 → 8.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88ca0a0eeda11477542ff26e73d650ee4710fe53cefacfae2becdab77a60b296
-  data.tar.gz: b53da2a74fb4cbe4580d0745cee0b9be50b21dc45d63b7baf4fd2d94090380a6
+  metadata.gz: f7f7cc867aa07b3595ae89b5f5fa55fab2b210236b106fa8ad10ccb5b9dd15b1
+  data.tar.gz: 36b720b84b89cfaad323c1d695e1b5408eca69476197cdb7911cdb614856c5e9
 SHA512:
-  metadata.gz: f20f7d2bb1fd83dacaacc4f78e9f2641a67be6a833be040c9ceaf289471d58658df35f01623bb8429bfaf9830df36e10517a693ab564c4542911c510f5b90292
-  data.tar.gz: b8f9340cd456e71a2e7920290f04aeea7d1d88692d53dee247f537f31b7ab25e5ccf83870667b5df626080c65a60c872ede67c606aab11dcdeef1d2cc7c5c4dd
+  metadata.gz: 7a84781d5ab63cee79729be08a0ebdc1f3866630b8f00e4aea983e654c2cf55fd66370d8006666c76880621231fd91d9ddf3f19c2efdd0d7b7fde9428f630935
+  data.tar.gz: d6e40740c7fa84c5410239e93f54502e197a19dcc8c00b8a1d30bec76660a35bb9dfe78bced75ae7b4b3c15e29ad9f7e339a1b817e4b28cc4aff99caaf58f624

data/Gemfile.lock

@@ -4,7 +4,7 @@ GEM
     bindata (2.4.10)
     diff-lcs (1.1.3)
     json (>= 2.3.0)
-    rdoc (3.12.2)
+    rdoc (>= 6.3.1)
       json (~> 1.4)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
@@ -21,5 +21,5 @@ PLATFORMS
 DEPENDENCIES
   bindata
   bundler (>= 1.2.0)
-  rdoc (~> 3.12)
+  rdoc (>= 6.3.1)
   rspec (~> 2.8.0)

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

@@ -9,10 +9,19 @@ Supported IPv4 and IPv6 address.
 For more details, please visit:
 [https://www.ip2location.com/developers/ruby](https://www.ip2location.com/developers/ruby)
 
+# INSTALLATION
+Install this package using the command as below:
+
+```
+gem install ip2location_ruby
+```
+
 # 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 is the description of the functions available in the **BIN Database** lookup.
 
 | Function Name | Description |
@@ -45,8 +54,7 @@ Below is the description of the functions available in the **BIN Database** look
 | get_elevation | Return average height of city above sea level in meters (m). |
 | get_usagetype | Return the ISP's usage type of IP address. |
 | get_addresstype | Returns the IP address type (A-Anycast, B-Broadcast, M-Multicast & U-Unicast) of IP address or domain name. |
-| category | Returns the IAB content taxonomy category of IP address or domain name. |
-
+| get_category | Returns the IAB content taxonomy category of IP address or domain name. |
 
 ## Web Service
 Below is the description of the functions available in the **Web Service** lookup.
@@ -57,13 +65,29 @@ Below is the description of the functions available in the **Web Service** looku
 | 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>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> |
 | get_credit | Return remaining credit of the web service account. |
 
+## IpTools
+Below is the description of the functions available in the **IpTools** class.
+
+| Function Name | Description |
+|---|---|
+| is_ipv4 | Return either true or false. Verify if a string is a valid IPv4 address. |
+| is_ipv6 | Return either true or false. Verify if a string is a valid IPv6 address. |
+| ipv4_to_decimal | Translate IPv4 address from dotted-decimal address to decimal format. Return null on error. |
+| decimal_to_ipv4 | Translate IPv4 address from decimal number to dotted-decimal address. Return null on error. |
+| ipv6_to_decimal | Translate IPv6 address from hexadecimal address to decimal format. Return null on error. |
+| decimal_to_ipv6 | Translate IPv6 address from decimal number into hexadecimal address. Return null on error. |
+| ipv4_to_cidr | Convert IPv4 range into a list of IPv4 CIDR notation. |
+| cidr_to_ipv4 | Convert IPv4 CIDR notation into a list of IPv4 addresses. |
+| ipv6_to_cidr | Convert IPv6 range into a list of IPv6 CIDR notation. |
+| cidr_to_ipv6 | Convert IPv6 CIDR notation into a list of IPv6 addresses. |
+| compress_ipv6 | Compress a IPv6 to shorten the length. |
+| expand_ipv6 | Expand a shorten IPv6 to full length. |
+
 # 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
 
-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

data/VERSION

@@ -1 +1 @@
-8.3.1
+8.5.0

data/example.rb

@@ -4,40 +4,51 @@ require 'ip2location_ruby'
 i2l = Ip2location.new.open("./data/IP2LOCATION-LITE-DB1.IPV6.BIN")
 record = i2l.get_all('8.8.8.8')
 
-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"
-print 'Address Type: ' + record['addresstype'] + "\n"
-print 'Category: ' + record['category'] + "\n"
+puts 'Country Code: ' + record['country_short']
+puts 'Country Name: ' + record['country_long']
+puts 'Region Name: ' + record['region']
+puts 'City Name: ' + record['city']
+puts 'Latitude: '
+puts record['latitude']
+puts 'Longitude: '
+puts record['longitude']
+puts 'ISP: ' + record['isp']
+puts 'Domain: ' + record['domain']
+puts 'Net Speed: ' + record['netspeed']
+puts 'Area Code: ' + record['areacode']
+puts 'IDD Code: ' + record['iddcode']
+puts 'Time Zone: ' + record['timezone']
+puts 'ZIP Code: ' + record['zipcode']
+puts 'Weather Station Code: ' + record['weatherstationname']
+puts 'Weather Station Name: ' + record['weatherstationcode']
+puts 'MCC: ' + record['mcc']
+puts 'MNC: ' + record['mnc']
+puts 'Mobile Name: ' + record['mobilebrand']
+puts 'Elevation: '
+puts record['elevation']
+puts 'Usage Type: ' + record['usagetype']
+puts 'Address Type: ' + record['addresstype']
+puts 'Category: ' + record['category']
 
 i2l.close()
 
 # Web Service
 ws = Ip2locationWebService.new('demo', 'WS25', true)
 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()
+puts record
+puts ws.get_credit()
+
+# IP Tools
+iptool = Ip2locationIpTools.new()
+puts iptool.is_ipv4('8.8.8.8')
+puts iptool.is_ipv6('2001:4860:4860::8888')
+puts iptool.ipv4_to_decimal('8.8.8.8')
+puts iptool.decimal_to_ipv4(134744072)
+puts iptool.ipv6_to_decimal('2001:4860:4860::8888')
+puts iptool.decimal_to_ipv6(42541956123769884636017138956568135816)
+puts iptool.ipv4_to_cidr('8.0.0.0', '8.255.255.255')
+puts iptool.cidr_to_ipv4('8.0.0.0/8')
+puts iptool.ipv6_to_cidr('2002:0000:0000:1234:abcd:ffff:c0a8:0000', '2002:0000:0000:1234:ffff:ffff:ffff:ffff')
+puts iptool.cidr_to_ipv6('2002::1234:abcd:ffff:c0a8:101/64')
+puts iptool.compress_ipv6('2002:0000:0000:1234:ffff:ffff:ffff:ffff')
+puts iptool.expand_ipv6('2002::1234:ffff:ffff:ffff:ffff')

data/ip2location_ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "ip2location_ruby"
-  s.version = "8.3.1"
+  s.version = "8.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
     "lib/ip2location_ruby/ip2location_record.rb",
     "spec/assets/IP2LOCATION-LITE-DB1.IPV6.BIN",
     "spec/ip2location_ruby_database_spec.rb",
+    "spec/ip2location_ruby_iptools_spec.rb",
     "spec/ip2location_ruby_webservice_spec.rb",
     "spec/spec_helper.rb",
     "rb/data/IP2LOCATION-LITE-DB1.IPV6.BIN"
@@ -54,18 +55,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/ip2location_ruby.rb

@@ -13,7 +13,7 @@ require 'ip2location_ruby/ip2location_record'
 class Ip2location
   attr_accessor :record_class4, :record_class6, :v4, :file, :db_index, :count, :base_addr, :ipno, :count, :record, :database, :columns, :ip_version, :ipv4databasecount, :ipv4databaseaddr, :ipv4indexbaseaddr, :ipv6databasecount, :ipv6databaseaddr, :ipv6indexbaseaddr, :databaseyear, :databasemonth, :databaseday, :last_err_msg
 
-  VERSION = '8.3.1'
+  VERSION = '8.5.0'
   FIELD_NOT_SUPPORTED = 'NOT SUPPORTED'
   INVALID_IP_ADDRESS = 'INVALID IP ADDRESS'
   INVALID_BIN_DATABASE = 'Incorrect IP2Location BIN file format. Please make sure that you are using the latest IP2Location BIN file.'
@@ -29,7 +29,7 @@ class Ip2location
         self.file = File.open(File.expand_path url, 'rb')
     rescue
         self.last_err_msg = 'Ip2location.new.open() error in opening ' + url +'.'
-        abort('Ip2location.new.open() error in opening ' + url +'.')
+        abort('Ip2location.new.open() error in opening ' + url + '. No such file in the /your_ip2location_ruby_library_path/rb/ folder.')
     else
     end
     i2l = Ip2locationConfig.read(file)
@@ -88,7 +88,7 @@ class Ip2location
     if ip_version == 6 && self.ipv6databasecount == 0
         return IPV6_ADDRESS_IN_IPV4_BIN
     end
-    col_length = columns * 4
+    col_length = self.columns * 4
     if ipv4indexbaseaddr > 0 || ipv6indexbaseaddr > 0
         indexpos = 0
         case ip_version
@@ -107,8 +107,7 @@ class Ip2location
                 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)
@@ -618,7 +617,7 @@ class Ip2location
         mid = (low + high) >> 1
         ip_from, ip_to = get_from_to(mid, base_addr, col_length)
         if ipnum >= ip_from && ipnum < ip_to
-            from_base = ( base_addr + mid * (col_length + (self.v4 ? 0 : 12)))
+            from_base = (base_addr + mid * (col_length + (self.v4 ? 0 : 12)))
             file.seek(from_base)
             if v4
                 return self.record_class4.read(file)
@@ -636,11 +635,12 @@ class Ip2location
   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
 
@@ -651,7 +651,7 @@ class Ip2location
     else
         ipv = 6
         ipnum = ip.to_i + 0
-        #reformat ipv4 address in ipv6 
+        #reformat ipv4 address in ipv6
         if ipnum >= 281470681743360 && ipnum <= 281474976710655
             ipv = 4
             ipnum = ipnum - 281470681743360
@@ -676,17 +676,19 @@ class Ip2location
     [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 Ip2locationWebService
@@ -717,7 +719,7 @@ class Ip2locationWebService
     if parsed_response.nil?
       return false
     end
-    if !parsed_response["response"].nil?
+    if parsed_response["country_code"].nil?
       raise Exception.new "Error: " + parsed_response["response"]
     end
     return parsed_response
@@ -738,4 +740,228 @@ class Ip2locationWebService
     end
     return parsed_response["response"]
   end
+end
+
+class Ip2locationIpTools
+  def is_ipv4(ip)
+    if !(IPAddr.new(ip) rescue nil).nil?
+      if IPAddr.new(ip).ipv4?
+        return true
+      else
+        return false
+      end
+    else
+      return false
+    end
+  end
+
+  def is_ipv6(ip)
+    if !(IPAddr.new(ip) rescue nil).nil?
+      if IPAddr.new(ip).ipv6?
+        return true
+      else
+        return false
+      end
+    else
+      return false
+    end
+  end
+
+  def ipv4_to_decimal(ip)
+    if !(IPAddr.new(ip) rescue nil).nil?
+      ip = IPAddr.new(ip)
+      if ip.ipv4?
+        return ip.to_i
+      else
+        return
+      end
+    else
+      return
+    end
+  end
+
+  def decimal_to_ipv4(number)
+    if number.is_a? Numeric
+      return IPAddr.new(number, Socket::AF_INET).to_s
+    else
+      return
+    end
+  end
+
+  def ipv6_to_decimal(ip)
+    if !(IPAddr.new(ip) rescue nil).nil?
+      ip = IPAddr.new(ip)
+      if ip.ipv6?
+        return ip.to_i
+      else
+        return
+      end
+    else
+      return
+    end
+  end
+
+  def decimal_to_ipv6(number)
+    if number.is_a? Numeric
+      return IPAddr.new(number, Socket::AF_INET6).to_s
+    else
+      return
+    end
+  end
+
+  def ipv4_to_cidr(ipfrom, ipto)
+    if (!(IPAddr.new(ipfrom) rescue nil).nil?) and (!(IPAddr.new(ipto) rescue nil).nil?)
+      ipfrom = IPAddr.new(ipfrom)
+      ipto = IPAddr.new(ipto)
+      if ipfrom.ipv4? and ipto.ipv4?
+        ipfrom = ipfrom.to_i
+        ipto = ipto.to_i
+        result = []
+        while ipto >= ipfrom do
+          maxSize = 32
+          while maxSize > 0 do
+            mask = (2**32 - 2**(32-(maxSize - 1)))
+            maskBase = ipfrom & mask
+            if maskBase != ipfrom
+              break
+            end
+              maxSize-=1
+          end
+          x = Math.log(ipto - ipfrom + 1)/Math.log(2)
+          maxDiff = (32 - x.floor).floor
+
+          if maxSize < maxDiff
+            maxSize = maxDiff
+          end
+
+          ip = IPAddr.new(ipfrom, Socket::AF_INET).to_s
+          cidr = [ip, maxSize].join('/')
+          result.push cidr
+          ipfrom += 2**(32-maxSize)
+        end
+        return result
+      else
+        return
+      end
+    else
+      return
+    end
+  end
+
+  def cidr_to_ipv4(cidr)
+    if cidr.include? "/"
+      cidr = IPAddr.new(cidr)
+      arr_tmp = cidr.to_range.to_s.split('..')
+      ip_arr = {}
+      ip_arr['ip_start'] = arr_tmp[0]
+      ip_arr['ip_end'] = arr_tmp[1]
+      return ip_arr
+    else
+      return
+    end
+  end
+
+  def ipv6_to_cidr(ipfrom_ori, ipto)
+    if (!(IPAddr.new(ipfrom_ori) rescue nil).nil?) and (!(IPAddr.new(ipto) rescue nil).nil?)
+      ipfrom = IPAddr.new(ipfrom_ori)
+      ipto = IPAddr.new(ipto)
+      if ipfrom.ipv6? and ipto.ipv6?
+        ipfrom = '00' + ipfrom.to_i.to_s(2)
+        ipto = '00' + ipto.to_i.to_s(2)
+        result = []
+        if ipfrom == ipto
+          cidr = ipfrom_ori + '/128'
+          result.push cidr
+          return result
+        end
+        if ipfrom > ipto
+          ipfrom, ipto = ipto, ipfrom
+        end
+        networks = {}
+        network_size = 0
+        while ipto > ipfrom do
+          if ipfrom[-1, 1] == '1'
+            networks[ipfrom[network_size, (128 - network_size)] + ('0' * network_size)] = 128 - network_size
+            n = ipfrom.rindex('0')
+            ipfrom = ((n == 0) ? '' : ipfrom[0, n]) + '1' + ('0' * (128 - n - 1))
+          end
+
+          if ipto[-1, 1] == '0'
+            networks[ipto[network_size, (128 - network_size)] + ('0' * network_size)] = 128 - network_size
+            n = ipto.rindex('1')
+            ipto = ((n == 0) ? '' : ipto[0, n]) + '0' + ('1' * (128 - n - 1))
+          end
+
+          if ipfrom > ipto
+            next
+          end
+
+          shift = 128 - [ipfrom.rindex('0'), ipto.rindex('1')].max
+          ipfrom = ('0' * shift) + ipfrom[0, (128 - shift)]
+          ipto = ('0' * shift) + ipto[0, (128 - shift)]
+          network_size = network_size + shift
+
+          if ipfrom == ipto
+            networks[ipfrom[network_size, (128 - network_size)] + ('0' * network_size)] = 128 - network_size
+            next
+          end
+        end
+
+        networks.each do |ip, netmask|
+          result.push IPAddr.new(ip.to_i(2), Socket::AF_INET6).to_s + '/' + netmask.to_s
+        end
+        return result
+      else
+        return
+      end
+    else
+      return
+    end
+  end
+
+  def cidr_to_ipv6(cidr)
+    if cidr.include? "/"
+      ip_start = IPAddr.new(cidr.to_s.split('/').first).to_i.to_s(16).scan(/.{4}/)
+      ip_start = ip_start[0] + ':' + ip_start[1] + ':' + ip_start[2] + ':' + ip_start[3] + ':' + ip_start[4] + ':' + ip_start[5] + ':' + ip_start[6] + ':' + ip_start[7]
+
+      cidr_new = IPAddr.new(cidr)
+      arr_tmp = cidr_new.to_range.to_s.split('..')
+      ip_end = IPAddr.new(arr_tmp[1]).to_i.to_s(16).scan(/.{4}/)
+      ip_end = ip_end[0] + ':' + ip_end[1] + ':' + ip_end[2] + ':' + ip_end[3] + ':' + ip_end[4] + ':' + ip_end[5] + ':' + ip_end[6] + ':' + ip_end[7]
+
+      ip_arr = {}
+      ip_arr['ip_start'] = ip_start
+      ip_arr['ip_end'] = ip_end
+      return ip_arr
+    else
+      return
+    end
+  end
+
+  def compress_ipv6(ip)
+    if !(IPAddr.new(ip) rescue nil).nil?
+      ip = IPAddr.new(ip)
+      if ip.ipv6?
+        return ip
+      else
+        return
+      end
+    else
+      return
+    end
+  end
+
+  def expand_ipv6(ip)
+    if !(IPAddr.new(ip) rescue nil).nil?
+      ip = IPAddr.new(ip)
+      if ip.ipv6?
+        res = ip.to_i.to_s(16).scan(/.{4}/)
+        return res[0] + ':' + res[1] + ':' + res[2] + ':' + res[3] + ':' + res[4] + ':' + res[5] + ':' + res[6] + ':' + res[7]
+      else
+        return
+      end
+    else
+      return
+    end
+  end
 end

data/spec/ip2location_ruby_iptools_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Ip2location" do
+  it "work correctly with iptools is_ipv4" do
+    iptool = Ip2locationIpTools.new()
+    record = iptool.is_ipv4('8.8.8.8')
+    expect(record).to eq true
+  end
+
+  it "work correctly with iptools invalid is_ipv4" do
+    iptool = Ip2locationIpTools.new()
+    record = iptool.is_ipv4('8.8.8.555')
+    expect(record).to eq false
+  end
+
+  it "work correctly with iptools is_ipv6" do
+    iptool = Ip2locationIpTools.new()
+    record = iptool.is_ipv6('2001:4860:4860::8888')
+    expect(record).to eq true
+  end
+
+  it "work correctly with iptools invalid is_ipv6" do
+    iptool = Ip2locationIpTools.new()
+    record = iptool.is_ipv6('2001:4860:4860::ZZZZ')
+    expect(record).to eq false
+  end
+
+  it "work correctly with iptools ipv4_to_decimal" do
+    iptool = Ip2locationIpTools.new()
+    record = iptool.ipv4_to_decimal('8.8.8.8')
+    expect(record).to eq 134744072
+  end
+
+  it "work correctly with iptools decimal_to_ipv4" do
+    iptool = Ip2locationIpTools.new()
+    record = iptool.decimal_to_ipv4(134744072)
+    expect(record).to eq '8.8.8.8'
+  end
+
+  it "work correctly with iptools ipv6_to_decimal" do
+    iptool = Ip2locationIpTools.new()
+    record = iptool.ipv6_to_decimal('2001:4860:4860::8888')
+    expect(record).to eq 42541956123769884636017138956568135816
+  end
+
+  it "work correctly with iptools decimal_to_ipv6" do
+    iptool = Ip2locationIpTools.new()
+    record = iptool.decimal_to_ipv6(42541956123769884636017138956568135816)
+    expect(record).to eq '2001:4860:4860::8888'
+  end
+
+  it "work correctly with iptools ipv4_to_cidr" do
+    iptool = Ip2locationIpTools.new()
+    record = iptool.ipv4_to_cidr('8.0.0.0', '8.255.255.255')
+    expect(record).to eq ['8.0.0.0/8']
+  end
+
+  it "work correctly with iptools cidr_to_ipv4" do
+    iptool = Ip2locationIpTools.new()
+    record = iptool.cidr_to_ipv4('8.0.0.0/8')
+    expect(record).to include(
+  "ip_start"=>"8.0.0.0",
+  "ip_end"=>"8.255.255.255"
+)
+  end
+
+  it "work correctly with iptools ipv6_to_cidr" do
+    iptool = Ip2locationIpTools.new()
+    record = iptool.ipv6_to_cidr('2002:0000:0000:1234:abcd:ffff:c0a8:0000', '2002:0000:0000:1234:ffff:ffff:ffff:ffff')
+    expect(record).to eq ['2002::1234:abcd:ffff:c0a8:0/109','2002::1234:abcd:ffff:c0b0:0/108','2002::1234:abcd:ffff:c0c0:0/106','2002::1234:abcd:ffff:c100:0/104','2002::1234:abcd:ffff:c200:0/103','2002::1234:abcd:ffff:c400:0/102','2002::1234:abcd:ffff:c800:0/101','2002::1234:abcd:ffff:d000:0/100','2002::1234:abcd:ffff:e000:0/99','2002:0:0:1234:abce::/79','2002:0:0:1234:abd0::/76','2002:0:0:1234:abe0::/75','2002:0:0:1234:ac00::/70','2002:0:0:1234:b000::/68','2002:0:0:1234:c000::/66']
+  end
+
+  it "work correctly with iptools cidr_to_ipv6" do
+    iptool = Ip2locationIpTools.new()
+    record = iptool.cidr_to_ipv6('2002::1234:abcd:ffff:c0a8:101/64')
+    expect(record).to include(
+  "ip_start"=>"2002:0000:0000:1234:abcd:ffff:c0a8:0101",
+  "ip_end"=>"2002:0000:0000:1234:ffff:ffff:ffff:ffff"
+)
+  end
+
+  it "work correctly with iptools compress_ipv6" do
+    iptool = Ip2locationIpTools.new()
+    record = iptool.compress_ipv6('2002:0000:0000:1234:ffff:ffff:ffff:ffff')
+    expect(record).to eq '2002::1234:ffff:ffff:ffff:ffff'
+  end
+
+  it "work correctly with iptools expand_ipv6" do
+    iptool = Ip2locationIpTools.new()
+    record = iptool.expand_ipv6('2002::1234:ffff:ffff:ffff:ffff')
+    expect(record).to eq '2002:0000:0000:1234:ffff:ffff:ffff:ffff'
+  end
+
+end

data/spec/ip2location_ruby_webservice_spec.rb

@@ -10,6 +10,6 @@ describe "Ip2location" do
   it "work correctly with web service get_credit" do
     ws = Ip2locationWebService.new('demo', 'WS25', true)
     record = ws.get_credit()
-    expect(record).to_not eq 0
+    expect(record).to eq 0
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ip2location_ruby
 version: !ruby/object:Gem::Version
-  version: 8.3.1
+  version: 8.5.0
 platform: ruby
 authors:
 - ip2location
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-14 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
@@ -97,6 +97,7 @@ files:
 - rb/data/IP2LOCATION-LITE-DB1.IPV6.BIN
 - spec/assets/IP2LOCATION-LITE-DB1.IPV6.BIN
 - spec/ip2location_ruby_database_spec.rb
+- spec/ip2location_ruby_iptools_spec.rb
 - spec/ip2location_ruby_webservice_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ip2location/ip2location-ruby
@@ -107,7 +108,7 @@ metadata:
   documentation_uri: https://www.rubydoc.info/gems/ip2location_ruby
   homepage_uri: https://www.ip2location.com
   source_code_uri: https://github.com/ip2location/ip2location-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,9 +123,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: the ip2location ruby library
 test_files: []