ip2location_ruby 8.4.0 → 8.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6b5f833dfd8e52321b11114f24103b44ff2cc9279360a71a0948ecb6742d2d1
-  data.tar.gz: 9f2b62167a00f19ac4f342d222291c108a3204b4c99324e9c21770339a73444d
+  metadata.gz: 3b96ea3f6c523f75a72a00b44179ed6cfa7101bcd9adacc1edfb58b74df8885e
+  data.tar.gz: c3e223b2caf2b0b8e72d80586229db8addb576a8286878f3cda360194f411562
 SHA512:
-  metadata.gz: 59be638fbbba78173c4fc3ba9bc708d4a43b21024cf5e675135533bbc10093c6a6707a15e108646e0d546b130e59a63e355c9d2c2ace995b0bd59c51484c454d
-  data.tar.gz: 283ac65d80c92f7bd054eb82399217901b08da84b965fa6764002baa5773073f130689b0646217b98ff62ebacf672e6990787a5d287075750eb05b9518f3892f
+  metadata.gz: 8f587dfa25da7d4437c4dfb6089e5806461acc6917b4201922ac4dcf492e8d78507e003a4229afd324aee99d92851711fb1ed3f6071aa30934df7fa5dd164621
+  data.tar.gz: 8b8522bee147a05b3c799deaf8fbc4eacf26bf8109a4ad00e7fde806bd3462bc3909917075041a61352bfabbe922e0eee77742dfbb0793e230c998fdf58b4505

data/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

data/VERSION

@@ -1 +1 @@
-8.4.0
+8.6.0

data/example.rb

@@ -29,7 +29,6 @@ puts record['elevation']
 puts 'Usage Type: ' + record['usagetype']
 puts 'Address Type: ' + record['addresstype']
 puts 'Category: ' + record['category']
-
 i2l.close()
 
 # Web Service
@@ -52,3 +51,11 @@ puts iptool.ipv6_to_cidr('2002:0000:0000:1234:abcd:ffff:c0a8:0000', '2002:0000:0
 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')

data/ip2location_ruby.gemspec

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

data/lib/ip2location_ruby.rb

@@ -3,6 +3,7 @@ require 'bindata'
 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 @@ 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.4.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.'
@@ -88,7 +89,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 +108,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 +618,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 +636,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
 
@@ -676,17 +677,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
@@ -962,4 +965,127 @@ class Ip2locationIpTools
       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

data/rb/data/IP2LOCATION-COUNTRY-INFORMATION-BASIC.CSV

@@ -0,0 +1,250 @@
+"country_code","capital","total_area"
+"AD","Andorra la Vella","468"
+"AE","Abu Dhabi","83600"
+"AF","Kabul","652230"
+"AG","Saint John's","442"
+"AI","The Valley","91"
+"AL","Tirana","28748"
+"AM","Yerevan","29743"
+"AO","Luanda","1246700"
+"AQ","-","14000000"
+"AR","Buenos Aires","2780400"
+"AS","Pago Pago","199"
+"AT","Vienna","83871"
+"AU","Canberra","7741220"
+"AW","Oranjestad","180"
+"AX","Mariehamn","1552"
+"AZ","Baku","86600"
+"BA","Sarajevo","51197"
+"BB","Bridgetown","430"
+"BD","Dhaka","143998"
+"BE","Brussels","30528"
+"BF","Ouagadougou","274200"
+"BG","Sofia","110879"
+"BH","Manama","760"
+"BI","Bujumbura","27830"
+"BJ","Porto-Novo","112622"
+"BL","Gustavia","21"
+"BM","Hamilton","54"
+"BN","Bandar Seri Begawan","5765"
+"BO","Sucre","1098581"
+"BQ","Kralendijk","328"
+"BR","Brasilia","8514877"
+"BS","Nassau","13880"
+"BT","Thimphu","38394"
+"BV","-","49"
+"BW","Gaborone","581730"
+"BY","Minsk","207600"
+"BZ","Belmopan","22966"
+"CA","Ottawa","9984670"
+"CC","West Island","14"
+"CD","Kinshasa","2344858"
+"CF","Bangui","622984"
+"CG","Brazzaville","342000"
+"CH","Bern","41277"
+"CI","Yamoussoukro","322463"
+"CK","Avarua","236"
+"CL","Santiago","756102"
+"CM","Yaounde","475440"
+"CN","Beijing","9596961"
+"CO","Bogota","1138910"
+"CR","San Jose","51100"
+"CU","Havana","110860"
+"CV","Praia","4033"
+"CW","Willemstad","444"
+"CX","Flying Fish Cove","135"
+"CY","Nicosia","9251"
+"CZ","Prague","78867"
+"DE","Berlin","357022"
+"DJ","Djibouti","23200"
+"DK","Copenhagen","43094"
+"DM","Roseau","751"
+"DO","Santo Domingo","48670"
+"DZ","Algiers","2381741"
+"EC","Quito","283561"
+"EE","Tallinn","45228"
+"EG","Cairo","1001450"
+"EH","Laayoune / El Aaiun","266000"
+"ER","Asmara","117600"
+"ES","Madrid","505370"
+"ET","Addis Ababa","1104300"
+"FI","Helsinki","338145"
+"FJ","Suva","18274"
+"FK","Stanley","12173"
+"FM","Palikir","702"
+"FO","Torshavn","1393"
+"FR","Paris","643801"
+"GA","Libreville","267667"
+"GB","London","243610"
+"GD","Saint George's","344"
+"GE","Tbilisi","69700"
+"GF","Cayenne","86504"
+"GG","Saint Peter Port","78"
+"GH","Accra","238533"
+"GI","Gibraltar","6"
+"GL","Nuuk","2166086"
+"GM","Banjul","11295"
+"GN","Conakry","245857"
+"GP","Basse-terre","1630"
+"GQ","Malabo","28051"
+"GR","Athens","131957"
+"GS","Grytviken","3903"
+"GT","Guatemala City","108889"
+"GU","Hagatna","544"
+"GW","Bissau","36125"
+"GY","Georgetown","214969"
+"HK","-","1104"
+"HM","-","412"
+"HN","Tegucigalpa","112090"
+"HR","Zagreb","56594"
+"HT","Port-au-prince","27750"
+"HU","Budapest","93028"
+"ID","Jakarta","1904569"
+"IE","Dublin","70273"
+"IL","Jerusalem","20770"
+"IM","Douglas","572"
+"IN","New Delhi","3287263"
+"IO","Diego Garcia","54400"
+"IQ","Baghdad","438317"
+"IR","Tehran","1648195"
+"IS","Reykjavik","103000"
+"IT","Roma","301340"
+"JE","Saint Helier","116"
+"JM","Kingston","10991"
+"JO","Amman","89342"
+"JP","Tokyo","377915"
+"KE","Nairobi","580367"
+"KG","Bishkek","199951"
+"KH","Phnom Penh","181035"
+"KI","Tarawa","811"
+"KM","Moroni","2235"
+"KN","Basseterre","261"
+"KP","Pyongyang","120538"
+"KR","Seoul","99720"
+"KW","Kuwait","17818"
+"KY","George Town","264"
+"KZ","Astana","2724900"
+"LA","Vientiane","236800"
+"LB","Beirut","10400"
+"LC","Castries","616"
+"LI","Vaduz","160"
+"LK","Sri Jayewardenepura Kotte","65610"
+"LR","Monrovia","111369"
+"LS","Maseru","30355"
+"LT","Vilnius","65300"
+"LU","Luxembourg","2586"
+"LV","Riga","64589"
+"LY","Tripoli","1759540"
+"MA","Rabat","446550"
+"MC","Monaco","2"
+"MD","Chisinau","33851"
+"ME","Podgorica","13812"
+"MF","Marigot","54"
+"MG","Antananarivo","587041"
+"MH","Majuro","181"
+"MK","Skopje","25713"
+"ML","Bamako","1240192"
+"MM","Pyinmana","676578"
+"MN","Ulaanbaatar","1564116"
+"MO","-","31.3"
+"MP","Saipan","464"
+"MQ","Fort-de-france","1128"
+"MR","Nouakchott","1030700"
+"MS","Plymouth","102"
+"MT","Valletta","316"
+"MU","Port Louis","2040"
+"MV","Male","298"
+"MW","Lilongwe","118484"
+"MX","Mexico City","1964375"
+"MY","Kuala Lumpur","329847"
+"MZ","Maputo","799380"
+"NA","Windhoek","824292"
+"NC","Noumea","18575"
+"NE","Niamey","1186408"
+"NF","Kingston","36"
+"NG","Abuja","923768"
+"NI","Managua","130370"
+"NL","Amsterdam","41543"
+"NO","Oslo","323802"
+"NP","Kathmandu","147181"
+"NR","Yaren","21"
+"NU","Alofi","260"
+"NZ","Wellington","267710"
+"OM","Muscat","309500"
+"PA","Panama","75420"
+"PE","Lima","1285216"
+"PF","Papeete","4167"
+"PG","Port Moresby","462840"
+"PH","Manila","300000"
+"PK","Islamabad","796095"
+"PL","Warsaw","312685"
+"PM","Saint-pierre","242"
+"PN","Adamstown","47"
+"PR","San Juan","13790"
+"PS","-","5860"
+"PT","Lisbon","92090"
+"PW","Melekeok - Palau State Capital","459"
+"PY","Asuncion","406752"
+"QA","Doha","11586"
+"RE","Saint-denis","2512"
+"RO","Bucharest","238391"
+"RS","Belgrade","77474"
+"RU","Moscow","17098242"
+"RW","Kigali","26338"
+"SA","Riyadh","2149690"
+"SB","Honiara","28896"
+"SC","Victoria","455"
+"SD","Khartoum","1861484"
+"SE","Stockholm","450295"
+"SG","Singapore","697"
+"SH","Jamestown","122"
+"SI","Ljubljana","20273"
+"SJ","Longyearbyen","62045"
+"SK","Bratislava","49035"
+"SL","Freetown","71740"
+"SM","San Marino","61"
+"SN","Dakar","196722"
+"SO","Mogadishu","637657"
+"SR","Paramaribo","163820"
+"SS","Juba","644329"
+"ST","Sao Tome","964"
+"SV","San Salvador","21041"
+"SX","Philipsburg","34"
+"SY","Damascus","185180"
+"SZ","Mbabane","17364"
+"TC","Cockburn Town","948"
+"TD","N'djamena","1284000"
+"TF","Port-aux-francais","439781"
+"TG","Lome","56785"
+"TH","Bangkok","513120"
+"TJ","Dushanbe","143100"
+"TK","-","12"
+"TL","Dili","14874"
+"TM","Ashgabat","488100"
+"TN","Tunis","163610"
+"TO","Nuku'alofa","747"
+"TR","Ankara","783562"
+"TT","Port of Spain","5128"
+"TV","Funafuti","26"
+"TW","Taipei","35980"
+"TZ","Dodoma","947300"
+"UA","Kiev","603550"
+"UG","Kampala","241038"
+"UM","-","34.2"
+"US","Washington, D.C.","9826675"
+"UY","Montevideo","176215"
+"UZ","Tashkent","447400"
+"VA","Vatican City","0.44"
+"VC","Kingstown","389"
+"VE","Caracas","912050"
+"VG","Road Town","151"
+"VI","Charlotte Amalie","1910"
+"VN","Ha Noi","331210"
+"VU","Port-vila","12189"
+"WF","Mata'utu","142"
+"WS","Apia","2831"
+"YE","Sanaa","527968"
+"YT","Mamoudzou","374"
+"ZA","Cape Town","1219090"
+"ZM","Lusaka","752618"
+"ZW","Harare","390757"