geo_ip 0.1.1 → 0.2.0

data/CHANGES

@@ -1,7 +1,13 @@
+== 0.2.0
+
+* Added support for timezone information. Use the optional {:timezone => true|false} option
+* Added support for country lookup. This will result in a faster reply since less queries need
+  to be done at ipinfodb's side. Use the optional {:precision => :city|:country} option
+
 == 0.1.1
- 
+
 * Removed time zone information since this has been deprecated with the service
- 
+
 == 0.1.0
- 
+
 * Initial commit

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/geo_ip.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{geo_ip}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeroen Jacobs"]
-  s.date = %q{2010-02-15}
+  s.date = %q{2010-03-25}
   s.description = %q{A call to the ipinfodb.com will be done to retreive the geolocation based on the IP address. No need to include a database file in the application.}
   s.email = %q{jj@redstorm.com}
   s.extra_rdoc_files = [
@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/jeroenj/geo_ip}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Retreive the geolocation of an IP address based on the ipinfodb.com webservice}
   s.test_files = [
     "spec/geo_ip_spec.rb",

data/lib/geo_ip.rb

@@ -1,4 +1,6 @@
-SERVICE_URL = "http://ipinfodb.com/ip_query.php"
+SERVICE_URL = "http://ipinfodb.com/"
+CITY_API    = "ip_query.php"
+COUNTRY_API = "ip_query_country.php"
 IPV4_REGEXP = /\A(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)(?:\.(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)){3}\z/
 
 require 'rubygems'
@@ -7,10 +9,27 @@ require 'uri'
 require 'net/http'
 
 class GeoIp
-  def self.remote_geolocation(ip)
+  # <b>DEPRECATED:</b> Please use <tt>geolocation</tt> instead.
+  def self.remote_geolocation(ip, timezone=false)
+    warn "DEPRECATION WARNING: `remote_geolocation` is deprecated and will be removed from 0.3. Use `geolocation` instead."
+    geolocation(ip, {:timezone => timezone})
+  end
+
+  # Retreive the remote location of a given ip address.
+  #
+  # It takes two optional arguments: precision and timezone
+  # preceision can either be :city (default) or :country
+  # timezone can either be false (default) or true
+  #
+  # Example:
+  # GeoIp.geolocation('209.85.227.104', {:precision => :city, :timezone => true})
+  def self.geolocation(ip, options={})
+    @precision = options[:precision] || :city
+    @timezone  = options[:timezone]  || false
     raise "Invalid IP address" unless ip.to_s =~ IPV4_REGEXP
-    
-    uri = SERVICE_URL + "?ip=#{ip}&output=json&timezone=false"
+    raise "Invalid precision"  unless [:country, :city].include?(@precision)
+    raise "Invalid timezone"   unless [true, false].include?(@timezone)
+    uri = "#{SERVICE_URL}#{@country ? COUNTRY_API : CITY_API}?ip=#{ip}&output=json&timezone=#{@timezone}"
     url = URI.parse(uri)
     reply = JSON.parse(Net::HTTP.get(url))
     location = convert_keys reply
@@ -19,16 +38,23 @@ class GeoIp
   private
   def self.convert_keys(hash)
     location = {}
-    location[:ip]               = hash["Ip"]
-    location[:status]           = hash["Status"]
-    location[:country_code]     = hash["CountryCode"]
-    location[:country_name]     = hash["CountryName"]
-    location[:region_code]      = hash["RegionCode"]
-    location[:region_name]      = hash["RegionName"]
-    location[:city]             = hash["City"]
-    location[:zip_postal_code]  = hash["ZipPostalCode"]
-    location[:latitude]         = hash["Latitude"]
-    location[:longitude]        = hash["Longitude"]
+    location[:ip]                 = hash["Ip"]
+    location[:status]             = hash["Status"]
+    location[:country_code]       = hash["CountryCode"]
+    location[:country_name]       = hash["CountryName"]
+    if @precision == :city
+      location[:region_code]      = hash["RegionCode"]
+      location[:region_name]      = hash["RegionName"]
+      location[:city]             = hash["City"]
+      location[:zip_postal_code]  = hash["ZipPostalCode"]
+      location[:latitude]         = hash["Latitude"]
+      location[:longitude]        = hash["Longitude"]
+      if @timezone
+        location[:timezone_name]  = hash["TimezoneName"]
+        location[:utc_offset]     = hash["Gmtoffset"].to_i
+        location[:dst?]           = hash["Isdst"] ? true : false
+      end
+    end
     location
   end
 end

data/spec/geo_ip_spec.rb

@@ -1,19 +1,101 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+IP_GOOGLE_US = '209.85.227.104'
+IP_PRIVATE = '10.0.0.1'
+IP_LOCAL = '127.0.0.1'
 
 describe "GeoIp" do
-  it "should return the correct country for a public ip address" do
-    # 209.85.227.104 = google.be (US)
-    GeoIp.remote_geolocation('209.85.227.104')[:country_code].should == 'US'
-    GeoIp.remote_geolocation('209.85.227.104')[:country_name].should == 'United States'
+  context "city" do
+    it "should return the correct city for a public ip address" do
+      geolocation = GeoIp.geolocation(IP_GOOGLE_US)
+      geolocation[:country_code].should == 'US'
+      geolocation[:country_name].should == 'United States'
+      geolocation[:city].should         == 'Mountain View'
+    end
+
+    it "should return the correct city for a private ip address" do
+      geolocation = GeoIp.geolocation(IP_PRIVATE)
+      geolocation[:country_code].should == 'RD'
+      geolocation[:country_name].should == 'Reserved'
+      geolocation[:city].should         be_empty
+    end
+
+    it "should return the correct city for localhost ip address" do
+      geolocation = GeoIp.geolocation(IP_LOCAL)
+      geolocation[:country_code].should == 'RD'
+      geolocation[:country_name].should == 'Reserved'
+      geolocation[:city].should         be_empty
+    end
+
+    it "should return the correct city for a public ip address when explicitly requiring it" do
+      geolocation = GeoIp.geolocation(IP_GOOGLE_US, {:precision => :city})
+      geolocation[:country_code].should == 'US'
+      geolocation[:country_name].should == 'United States'
+      geolocation[:city].should         == 'Mountain View'
+    end
   end
 
-  it "should return the correct country for a private ip address" do
-    GeoIp.remote_geolocation('10.0.0.1')[:country_code].should == 'RD'
-    GeoIp.remote_geolocation('10.0.0.1')[:country_name].should == 'Reserved'
+  context "country" do
+    it "should return the correct country for a public ip address" do
+      geolocation = GeoIp.geolocation(IP_GOOGLE_US, {:precision => :country})
+      geolocation[:country_code].should == 'US'
+      geolocation[:country_name].should == 'United States'
+    end
+
+    it "should return the correct country for a private ip address" do
+      geolocation = GeoIp.geolocation(IP_PRIVATE, {:precision => :country})
+      geolocation[:country_code].should == 'RD'
+      geolocation[:country_name].should == 'Reserved'
+    end
+
+    it "should return the correct country for localhost ip address" do
+      geolocation = GeoIp.geolocation(IP_LOCAL, {:precision => :country})
+      geolocation[:country_code].should == 'RD'
+      geolocation[:country_name].should == 'Reserved'
+    end
+
+    it "should not return the city for a public ip address" do
+      geolocation = GeoIp.geolocation(IP_GOOGLE_US, {:precision => :country})
+      geolocation[:country_code].should == 'US'
+      geolocation[:country_name].should == 'United States'
+      geolocation[:city].should         be_nil
+    end
+  end
+
+  context "timezone" do
+    it "should return the correct timezone information for a public ip address" do
+      geolocation = GeoIp.geolocation(IP_GOOGLE_US, {:timezone => true})
+      geolocation[:timezone_name].should == 'America/Los_Angeles'
+      geolocation[:utc_offset].should    == -25200
+      geolocation[:dst?].should_not      be_nil # true if dst?, false if not dst?
+    end
+
+    it "should not return the timezone information when explicitly not requesting it" do
+      geolocation = GeoIp.geolocation(IP_GOOGLE_US, {:timezone => false})
+      geolocation[:timezone_name].should be_nil
+      geolocation[:utc_offset].should    be_nil
+      geolocation[:dst?].should          be_nil
+    end
+
+    it "should not return the timezone information when not requesting it" do
+      geolocation = GeoIp.geolocation(IP_GOOGLE_US)
+      geolocation[:timezone_name].should be_nil
+      geolocation[:utc_offset].should    be_nil
+      geolocation[:dst?].should          be_nil
+    end
+
+    it "should not return the timezone information when country precision is selected" do
+      geolocation = GeoIp.geolocation(IP_GOOGLE_US, {:precision => :country, :timezone => true})
+      geolocation[:timezone_name].should be_nil
+      geolocation[:utc_offset].should    be_nil
+      geolocation[:dst?].should          be_nil
+    end
   end
 
-  it "should return the correct country for localhost ip address" do
-    GeoIp.remote_geolocation('127.0.0.1')[:country_code].should == 'RD'
-    GeoIp.remote_geolocation('127.0.0.1')[:country_name].should == 'Reserved'
+  context "deprecated" do
+    it "should return the correct country for a public ip address" do
+      geolocation = GeoIp.remote_geolocation(IP_GOOGLE_US)
+      geolocation[:country_code].should == 'US'
+      geolocation[:country_name].should == 'United States'
+    end
   end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: geo_ip
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jeroen Jacobs
@@ -9,19 +14,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-15 00:00:00 +01:00
+date: 2010-03-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
         version: 1.2.9
-    version: 
+  type: :development
+  version_requirements: *id001
 description: A call to the ipinfodb.com will be done to retreive the geolocation based on the IP address. No need to include a database file in the application.
 email: jj@redstorm.com
 executables: []
@@ -58,18 +67,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Retreive the geolocation of an IP address based on the ipinfodb.com webservice