geo_ip_curb 0.3.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 Ryan Conway, Jeroen Jacobs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/geo_ip_curb.rb

@@ -0,0 +1,80 @@
+require 'json'
+require 'curb'
+
+class GeoIpCurb
+  SERVICE_URL     = "http://api.ipinfodb.com/v2"
+  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/
+  TIMEOUT         = 1
+  ERROR_PREFIX    = "GeoIpCurb service error"
+
+  @@api_key = nil
+
+  def self.api_key
+    @@api_key
+  end
+
+  def self.api_key=(api_key)
+    @@api_key = api_key
+  end
+
+  # Retreive the remote location of a given ip address.
+  #
+  # It takes two optional arguments:
+  # * +preceision+: can either be +:city+ (default) or +:country+
+  # * +timezone+: can either be +false+ (default) or +true+
+  #
+  # ==== Example:
+  #   GeoIpCurb.geolocation('209.85.227.104', {:precision => :city, :timezone => true})
+  def self.geolocation(ip, options={})
+    @precision = options[:precision] || :city
+    @timezone  = options[:timezone]  || false
+    @timeout   = options[:timeout]   || TIMEOUT
+    
+    raise "API key must be set first: GeoIpCurb.api_key = 'YOURKEY'" if self.api_key.nil?
+    raise "Invalid IP address" unless ip.to_s =~ IPV4_REGEXP
+    raise "Invalid precision"  unless [:country, :city].include?(@precision)
+    raise "Invalid timezone"   unless [true, false].include?(@timezone)
+   
+    uri = "#{SERVICE_URL}/#{@country ? COUNTRY_API : CITY_API}?key=#{self.api_key}&ip=#{ip}&output=json&timezone=#{@timezone}"
+    
+    convert_keys send_request(uri)
+  end
+
+  private
+  
+  def self.send_request(uri)
+    http = Curl::Easy.new(uri)
+    http.timeout = @timeout
+    http.perform
+    JSON.parse(http.body_str)
+  rescue => e
+    error = {}
+    error[:error_msg] = "#{ERROR_PREFIX}: \"#{e}\"."
+    error
+  end
+  
+  def self.convert_keys(hash)
+    location = {}
+    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[:error]              = hash[:error_msg] if hash[:error_msg]
+    location
+  end
+end

data/spec/api.yml.example

@@ -0,0 +1 @@
+key: YOUR_KEY_HERE

data/spec/geo_ip_spec.rb

@@ -0,0 +1,120 @@
+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
+
+  before :each do
+    api_config = YAML.load_file(File.dirname(__FILE__) + '/api.yml')
+    GeoIp.api_key = api_config['key']
+  end
+
+  context "api_key" do
+    it "should return the API key when set" do
+      GeoIp.api_key = "my_api_key"
+      GeoIp.api_key.should == "my_api_key"
+    end
+
+    it "should throw an error when API key is not set" do
+      GeoIp.api_key = nil
+      lambda {GeoIp.geolocation(IP_GOOGLE_US)}.should raise_error
+    end
+  end
+
+  context "service failure" do
+    it "should return an error hash if the GeoIP service is down" do
+      GeoIp.expects(:send_request).returns({:error_msg => "#{GeoIp::ERROR_PREFIX}: Im on fire!"}).once
+      geolocation = GeoIp.geolocation(IP_GOOGLE_US)
+      geolocation[:error].should =~ Regexp.new("^#{GeoIp::ERROR_PREFIX}")
+      Mocha::Mockery.instance.stubba.unstub_all
+    end
+  end
+
+  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
+ 
+  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    == -28800
+      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
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler.require :development
+
+require 'geo_ip'

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: geo_ip_curb
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 2
+  version: 0.3.2
+platform: ruby
+authors: 
+- Ryan Conway
+- Jeroen Jacobs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: curb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 7
+        - 15
+        version: 0.7.15
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 5
+        version: "2.5"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 0
+        - 9
+        - 12
+        version: 0.9.12
+  type: :development
+  version_requirements: *id004
+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: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- lib/geo_ip_curb.rb
+- spec/api.yml.example
+- spec/geo_ip_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.2
+signing_key: 
+specification_version: 3
+summary: Retreive the geolocation of an IP address based on the ipinfodb.com webservice. It is the same as Jeroen Jacobs' gem, but uses the Curb gem, rather than Net::HTTP in order to avoid issues with DNS resolution ignoring timeout settings.
+test_files: 
+- spec/api.yml.example
+- spec/geo_ip_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb