Created Ip2locationIpTools class

Author: ip2location

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

README.md

@@ -56,7 +56,6 @@ Below is the description of the functions available in the **BIN Database** look
 | get_addresstype | Returns the IP address type (A-Anycast, B-Broadcast, M-Multicast & U-Unicast) 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.
 
@@ -66,6 +65,24 @@ 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

VERSION

@@ -1 +1 @@
-8.3.2
+8.4.0

example.rb

@@ -4,40 +4,51 @@
 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')

ip2location_ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "ip2location_ruby"
-  s.version = "8.3.2"
+  s.version = "8.4.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"