Added Country and Region class

Added Country class to query country information and Region class to lookup for ISO 3166-2 subdivision code form country code and region name.

Author: ip2location

README.md

@@ -83,6 +83,22 @@ Below is the description of the functions available in the **IpTools** class.
 | compress_ipv6 | Compress a IPv6 to shorten the length. |
 | expand_ipv6 | Expand a shorten IPv6 to full length. |
 
+## Country
+Below is the description of the functions available in the **Country** class.
+
+| Function Name | Description |
+|---|---|
+| Constructor | Expect a IP2Location Country Information CSV file. This database is free for download at https://www.ip2location.com/free/country-information |
+| get_country_info | Provide a ISO 3166 country code to get the country information in array. Will return a full list of countries information if country code not provided. Below is the information returned: <ul><li>country_code</li><li>country_alpha3_code</li><li>country_numeric_code</li><li>capital</li><li>country_demonym</li><li>total_area</li><li>population</li><li>idd_code</li><li>currency_code</li><li>currency_name</li><li>currency_symbol</li><li>lang_code</li><li>lang_name</li><li>cctld</li></ul> |
+
+## Region
+Below is the description of the functions available in the **Region** class.
+
+| Function Name | Description |
+|---|---|
+| Constructor | Expect a IP2Location ISO 3166-2 Subdivision Code CSV file. This database is free for download at https://www.ip2location.com/free/iso3166-2 |
+| get_region_code | Provide a ISO 3166 country code and the region name to get ISO 3166-2 subdivision code for the region. |
+
 # 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.5.0
+8.6.0

example.rb

@@ -29,7 +29,6 @@
 puts 'Usage Type: ' + record['usagetype']
 puts 'Address Type: ' + record['addresstype']
 puts 'Category: ' + record['category']
-
 i2l.close()
 
 # Web Service
@@ -52,3 +51,11 @@
 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')
+
+# Country Class
+country = Ip2locationCountry.new('./data/IP2LOCATION-COUNTRY-INFORMATION-BASIC.CSV')
+puts country.get_country_info('US')
+
+# Region Class
+region = Ip2locationRegion.new('./data/IP2LOCATION-ISO3166-2.CSV')
+puts region.get_region_code('US', 'California')

ip2location_ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "ip2location_ruby"
-  s.version = "8.5.0"
+  s.version = "8.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
@@ -30,11 +30,15 @@ Gem::Specification.new do |s|
     "lib/ip2location_ruby/ip2location_config.rb",
     "lib/ip2location_ruby/ip2location_record.rb",
     "spec/assets/IP2LOCATION-LITE-DB1.IPV6.BIN",
+    "spec/ip2location_ruby_country_spec.rb",
     "spec/ip2location_ruby_database_spec.rb",
     "spec/ip2location_ruby_iptools_spec.rb",
+    "spec/ip2location_ruby_region_spec.rb",
     "spec/ip2location_ruby_webservice_spec.rb",
     "spec/spec_helper.rb",
-    "rb/data/IP2LOCATION-LITE-DB1.IPV6.BIN"
+    "rb/data/IP2LOCATION-LITE-DB1.IPV6.BIN",
+    "rb/data/IP2LOCATION-COUNTRY-INFORMATION-BASIC.CSV",
+    "rb/data/IP2LOCATION-ISO3166-2.CSV"
   ]
   s.homepage = "https://github.com/ip2location/ip2location-ruby"
   s.licenses = ["MIT"]

lib/ip2location_ruby.rb

@@ -3,6 +3,7 @@
 require 'ipaddr'
 require 'net/http'
 require 'json'
+require 'csv'
 require 'ip2location_ruby/ip2location_config'
 require 'ip2location_ruby/database_config'
 require 'ip2location_ruby/i2l_float_data'
@@ -13,7 +14,7 @@
 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.5.0'
+  VERSION = '8.6.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.'
@@ -964,4 +965,127 @@ def expand_ipv6(ip)
       return
     end
   end
+end
+
+class Ip2locationCountry
+  attr_accessor :fields, :records
+
+  def initialize(csv)
+    if csv == ''
+      abort('The CSV file "' + csv + '" is not found.')
+    end
+
+    begin
+      csvfile = File.open(File.expand_path csv, 'rb')
+    rescue
+      abort('Error in opening ' + csv + '. No such CSV file in the /your_ip2location_ruby_library_path/rb/ folder.')
+    else
+    end
+
+    begin
+      CSV.parse(csvfile)
+    rescue
+      abort('Unable to read "' + csv + '".')
+    else
+      line = 1
+      self.records = Hash.new
+      CSV.foreach((csvfile)) do |data|
+        if line == 1
+          if data[0] != 'country_code'
+            abort('Invalid country information CSV file.')
+          end
+          self.fields = data
+        else
+          self.records[data[0]] = data
+        end
+        line = line + 1
+      end
+    end
+  end
+
+  def get_country_info(country_code = nil)
+    if self.records.empty?
+      abort('No record available.')
+    end
+
+    if country_code
+      if (self.records[country_code]).nil?
+        return []
+      end
+      results = Hash.new
+      for i in 0..(self.fields.length()-1)
+        results[self.fields[i]] = self.records[country_code][i]
+      end
+      return results
+    end
+
+    results = []
+    self.records.each do |key, value|
+      data = Hash.new
+      for i in 0..(self.fields.length()-1)
+        data[self.fields[i]] = self.records[key][i]
+      end
+      results = results.append(data)
+    end
+    return results
+  end
+end
+
+class Ip2locationRegion
+  attr_accessor :records
+
+  def initialize(csv)
+    if csv == ''
+      abort('The CSV file "' + csv + '" is not found.')
+    end
+
+    begin
+      csvfile = File.open(File.expand_path csv, 'rb')
+    rescue
+      abort('Error in opening ' + csv + '. No such CSV file in the /your_ip2location_ruby_library_path/rb/ folder.')
+    else
+    end
+
+    begin
+      CSV.parse(csvfile)
+    rescue
+      abort('Unable to read "' + csv + '".')
+    else
+      line = 1
+      self.records = Hash.new
+      CSV.foreach((csvfile)) do |data|
+        if line == 1
+          if data[1] != 'subdivision_name'
+            abort('Invalid region information CSV file.')
+          end
+        else
+          temp_data = Hash.new
+          temp_data['code'] = data[2]
+          temp_data['name'] = data[1]
+          if self.records[data[0]]
+            self.records[data[0]].push temp_data
+          else
+            self.records[data[0]] = [temp_data]
+          end
+        end
+        line = line + 1
+      end
+    end
+  end
+
+  def get_region_code(country_code, region_name)
+    if self.records.empty?
+      abort('No record available.')
+    end
+
+    if (self.records[country_code]).nil?
+      return
+    end
+
+    for i in 0..(self.records[country_code].length()-1)
+      if region_name.upcase == self.records[country_code][i]["name"].upcase
+        return self.records[country_code][i]["code"]
+      end
+    end
+  end
 end