geoip 1.2.0 → 1.3.0

data/geoip.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "geoip"
-  s.version = "1.2.0"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Clifford Heath", "Roland Moriz"]
-  s.date = "2012-10-16"
+  s.date = "2013-08-13"
   s.description = "GeoIP searches a GeoIP database for a given host or IP address, and\nreturns information about the country where the IP address is allocated,\nand the city, ISP and other information, if you have that database version."
   s.email = ["clifford.heath@gmail.com", "rmoriz@gmail.com"]
   s.executables = ["geoip"]
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "data/geoip/country_code3.yml",
     "data/geoip/country_continent.yml",
     "data/geoip/country_name.yml",
+    "data/geoip/region.yml",
     "data/geoip/time_zone.yml",
     "geoip.gemspec",
     "lib/geoip.rb",
@@ -40,7 +41,7 @@ Gem::Specification.new do |s|
     "website/template.rhtml"
   ]
   s.homepage = "http://github.com/cjheath/geoip"
-  s.licenses = ["GPL"]
+  s.licenses = ["LGPL"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.24"
   s.summary = "GeoIP searches a GeoIP database for a given host or IP address, and returns information about the country where the IP address is allocated, and the city, ISP and other information, if you have that database version."

data/lib/geoip.rb

@@ -8,19 +8,18 @@
 # Derived from the C version, Copyright (C) 2003 MaxMind LLC
 #
 # This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public
+# modify it under the terms of the GNU Lesser General Public
 # License as published by the Free Software Foundation; either
 # version 2.1 of the License, or (at your option) any later version.
 #
 # This library is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# General Public License for more details.
+# Lesser General Public License for more details.
 #
-# You should have received a copy of the GNU General Public
+# You should have received a copy of the GNU Lesser General Public
 # License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 # = SYNOPSIS
 #
 #   require 'geoip'
@@ -59,7 +58,7 @@ require 'yaml'
 class GeoIP
 
   # The GeoIP GEM version number
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 
   # The +data/+ directory for geoip
   DATA_DIR = File.expand_path(File.join(File.dirname(__FILE__),'..','data','geoip'))
@@ -79,6 +78,9 @@ class GeoIP
   # ordered by GeoIP ID
   CountryContinent = YAML.load_file(File.join(DATA_DIR,'country_continent.yml'))
 
+  # Load a hash of region names by region code
+  RegionName = YAML.load_file(File.join(DATA_DIR,'region.yml'))
+
   # Hash of the timezone codes mapped to timezone name, per zoneinfo
   TimeZone = YAML.load_file(File.join(DATA_DIR,'time_zone.yml'))
 
@@ -92,6 +94,7 @@ class GeoIP
   GEOIP_PROXY_EDITION = 8
   GEOIP_ASNUM_EDITION = 9
   GEOIP_NETSPEED_EDITION = 10
+  GEOIP_COUNTRY_EDITION_V6 = 12
   GEOIP_CITY_EDITION_REV1_V6 = 30
 
   COUNTRY_BEGIN = 16776960          #:nodoc:
@@ -118,13 +121,27 @@ class GeoIP
 
   end
 
+  class Region < Struct.new(:request, :ip, :country_code2, :country_code3, :country_name, :continent_code,
+                            :region_code, :region_name, :timezone)
+
+    def to_hash
+      Hash[each_pair.to_a]
+    end
+
+  end
+
+  # Warning: for historical reasons the region code is mis-named region_name here
   class City < Struct.new(:request, :ip, :country_code2, :country_code3, :country_name, :continent_code,
-                          :region_name, :city_name, :postal_code, :latitude, :longitude, :dma_code, :area_code, :timezone)
+                          :region_name, :city_name, :postal_code, :latitude, :longitude, :dma_code, :area_code, :timezone, :real_region_name)
 
     def to_hash
       Hash[each_pair.to_a]
     end
 
+    def region_code
+      self.region_name
+    end
+
   end
 
   class ASN < Struct.new(:number, :asn)
@@ -136,6 +153,9 @@ class GeoIP
   # The Edition number that identifies which kind of database you've opened
   attr_reader :database_type
 
+  # An IP that is used instead of local IPs
+  attr_accessor :local_ip_alias
+
   alias databaseType database_type
 
   # Open the GeoIP database and determine the file format version.
@@ -182,17 +202,24 @@ class GeoIP
       return city(hostname)
     end
 
-    if (@database_type != GEOIP_COUNTRY_EDITION &&
-        @database_type != GEOIP_PROXY_EDITION &&
-        @database_type != GEOIP_NETSPEED_EDITION)
-      throw "Invalid GeoIP database type, can't look up Country by IP"
+    if (@database_type == GEOIP_REGION_EDITION_REV0 ||
+        @database_type == GEOIP_REGION_EDITION_REV1)
+      return region(hostname)
     end
 
     ip = lookup_ip(hostname)
-
-    ipnum = iptonum(ip)           # Convert numeric IP address to an integer
-
-    code = (seek_record(ipnum) - COUNTRY_BEGIN)
+    if (@database_type == GEOIP_COUNTRY_EDITION ||
+        @database_type == GEOIP_PROXY_EDITION ||
+        @database_type == GEOIP_NETSPEED_EDITION)
+        # Convert numeric IP address to an integer
+        ipnum = iptonum(ip)
+        code = (seek_record(ipnum) - COUNTRY_BEGIN)
+    elsif @database_type == GEOIP_COUNTRY_EDITION_V6
+      ipaddr = IPAddr.new ip
+      code = (seek_record_v6(ipaddr.to_i) - COUNTRY_BEGIN)
+    else
+      throw "Invalid GeoIP database type, can't look up Country by IP"
+    end
 
     Country.new(
       hostname,                   # Requested hostname
@@ -205,6 +232,42 @@ class GeoIP
     )
   end
 
+  # Search the GeoIP database for the specified host, retuning region info.
+  #
+  # +hostname+ is a String holding the hosts's DNS name or numeric IP
+  # address.
+  #
+  # Returns a Region object with the nine elements:
+  # * The host or IP address string as requested
+  # * The IP address string after looking up the host
+  # * The two-character country code (ISO 3166-1 alpha-2)
+  # * The three-character country code (ISO 3166-2 alpha-3)
+  # * The ISO 3166 English-language name of the country
+  # * The two-character continent code
+  # * The region name (state or territory)
+  # * The timezone name, if known
+  #
+  def region(hostname)
+    if (@database_type == GEOIP_CITY_EDITION_REV0 ||
+        @database_type == GEOIP_CITY_EDITION_REV1 ||
+        @database_type == GEOIP_CITY_EDITION_REV1_V6)
+      return city(hostname)
+    end
+
+    if (@database_type == GEOIP_REGION_EDITION_REV0 ||
+        @database_type == GEOIP_REGION_EDITION_REV1)
+      ip = lookup_ip(hostname)
+      ipnum = iptonum(ip)
+      pos = seek_record(ipnum)
+    else
+      throw "Invalid GeoIP database type, can't look up Region by IP"
+    end
+
+    unless pos == @database_segments[0]
+      read_region(pos, hostname, ip)
+    end
+  end
+
   # Search the GeoIP database for the specified host, returning city info.
   #
   # +hostname+ is a String holding the host's DNS name or numeric IP
@@ -393,11 +456,57 @@ class GeoIP
 
     if (@database_type == GEOIP_COUNTRY_EDITION ||
         @database_type == GEOIP_PROXY_EDITION ||
+        @database_type == GEOIP_COUNTRY_EDITION_V6 ||
         @database_type == GEOIP_NETSPEED_EDITION)
       @database_segments = [COUNTRY_BEGIN]
     end
   end
 
+  def read_region(pos, hostname = '', ip = '') #:nodoc:
+    if (@database_type == GEOIP_REGION_EDITION_REV0)
+      pos -= STATE_BEGIN_REV0
+      if (pos >= 1000)
+        code = 225
+        region_code = ((pos - 1000) / 26 + 65).chr + ((pos - 1000) % 26 + 65).chr
+      else
+        code = pos
+        region_code = ''
+      end
+    elsif (@database_type == GEOIP_REGION_EDITION_REV1)
+      pos -= STATE_BEGIN_REV1
+      if (pos < US_OFFSET)
+        code = 0
+        region_code = ''
+      elsif (pos < CANADA_OFFSET)
+        code = 225
+        region_code = ((pos - US_OFFSET) / 26 + 65).chr + ((pos - US_OFFSET) % 26 + 65).chr
+      elsif (pos < WORLD_OFFSET)
+        code = 38
+        region_code = ((pos - CANADA_OFFSET) / 26 + 65).chr + ((pos - CANADA_OFFSET) % 26 + 65).chr
+      else
+        code = (pos - WORLD_OFFSET) / FIPS_RANGE
+        region_code = ''
+      end
+    end
+
+    Region.new(
+      hostname,
+      ip,
+      CountryCode[code],          # ISO3166-1 alpha-2 code
+      CountryCode3[code],         # ISO3166-2 alpha-3 code
+      CountryName[code],          # Country name, per ISO 3166
+      CountryContinent[code],     # Continent code.
+      region_code,		  # Unfortunately this is called region_name in the City structure
+      lookup_region_name(CountryCode[code], region_code),
+      (TimeZone["#{CountryCode[code]}#{region_code}"] || TimeZone["#{CountryCode[code]}"])
+    )
+  end
+
+  def lookup_region_name(country_iso2, region_code)
+    country_regions = RegionName[country_iso2]
+    country_regions && country_regions[region_code]
+  end
+
   # Search the GeoIP database for the specified host, returning city info.
   #
   # +hostname+ is a String holding the host's DNS name or numeric
@@ -427,9 +536,9 @@ class GeoIP
     @iter_pos += 1 unless @iter_pos.nil?
 
     spl = record.split("\x00", 4)
-    # Get the region:
-    region = spl[0]
-    @iter_pos += (region.size + 1) unless @iter_pos.nil?
+    # Get the region code:
+    region_code = spl[0]
+    @iter_pos += (region_code.size + 1) unless @iter_pos.nil?
 
     # Get the city:
     city = spl[1]
@@ -439,7 +548,7 @@ class GeoIP
 
     # Get the postal code:
     postal_code = spl[2]
-    @iter_pos += (postal_code.size + 1) unless @iter_pos.nil?
+    @iter_pos += (postal_code.size + 1) unless @iter_pos.nil? || postal_code.nil?
 
     record = spl[3]
 
@@ -484,18 +593,23 @@ class GeoIP
       CountryCode3[code],         # ISO3166-2 code
       CountryName[code],          # Country name, per IS03166
       CountryContinent[code],     # Continent code.
-      region,                     # Region name
+      region_code,                # Region code (called region_name, unfortunately)
       city,                       # City name
       postal_code,                # Postal code
       latitude,
       longitude,
       dma_code,
       area_code,
-      (TimeZone["#{CountryCode[code]}#{region}"] || TimeZone["#{CountryCode[code]}"])
+      (TimeZone["#{CountryCode[code]}#{region_code}"] || TimeZone["#{CountryCode[code]}"]),
+      lookup_region_name(CountryCode[code], region_code)  # Real region name
     )
   end
 
   def lookup_ip(ip_or_hostname) # :nodoc:
+    if is_local?(ip_or_hostname) && @local_ip_alias
+      ip_or_hostname = @local_ip_alias
+    end
+
     if !ip_or_hostname.kind_of?(String) or ip_or_hostname =~ /^[0-9.]+$/
       return ip_or_hostname
     end
@@ -506,6 +620,10 @@ class GeoIP
     ip
   end
 
+  def is_local?(ip_or_hostname) #:nodoc:
+    ["127.0.0.1", "localhost", "::1", "0000::1", "0:0:0:0:0:0:0:1"].include? ip_or_hostname
+  end
+
   # Convert numeric IP address to Integer.
   def iptonum(ip) #:nodoc:
     if (ip.kind_of?(String) &&

data/script/txt2html

@@ -2,9 +2,8 @@
 
 require 'rubygems'
 require 'redcloth'
-require 'syntax/convertors/html'
 require 'erb'
-require File.dirname(__FILE__) + '/../lib/geoip.rb'
+require './' + File.dirname(__FILE__) + '/../lib/geoip.rb'
 
 version  = GeoIP::VERSION
 download = 'http://rubyforge.org/projects/geoip'
@@ -15,9 +14,9 @@ class Fixnum
     return 'th' if (10..19).include?(self % 100)
     # others
     case self % 10
-    when 1: return 'st'
-    when 2: return 'nd'
-    when 3: return 'rd'
+    when 1; return 'st'
+    when 2; return 'nd'
+    when 3; return 'rd'
     else    return 'th'
     end
   end

data/website/index.txt

@@ -65,15 +65,15 @@ This version Copyright (C) 2005 Clifford Heath
 Derived from the C version, Copyright (C) 2003 MaxMind LLC
 
 This library is free software; you can redistribute it and/or
-modify it under the terms of the GNU General Public
+modify it under the terms of the GNU Lesser General Public
 License as published by the Free Software Foundation; either
 version 2.1 of the License, or (at your option) any later version.
 
 This library is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-General Public License for more details.
+Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public
+You should have received a copy of the GNU Lesser General Public
 License along with this library; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geoip
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-16 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies: []
 description: ! 'GeoIP searches a GeoIP database for a given host or IP address, and
 
@@ -35,6 +35,7 @@ files:
 - data/geoip/country_code3.yml
 - data/geoip/country_continent.yml
 - data/geoip/country_name.yml
+- data/geoip/region.yml
 - data/geoip/time_zone.yml
 - geoip.gemspec
 - lib/geoip.rb
@@ -49,7 +50,7 @@ files:
 - website/template.rhtml
 homepage: http://github.com/cjheath/geoip
 licenses:
-- GPL
+- LGPL
 post_install_message: 
 rdoc_options: []
 require_paths: