geokit-geoip 0.1.0

data/README.md

@@ -0,0 +1,4 @@
+geokit-geoip
+============
+
+GeoKit module for using Maxmind GeoIP City database

data/Rakefile

@@ -0,0 +1,11 @@
+require "rubygems"
+require "bundler/setup"
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/geokit-geoip.rb

@@ -0,0 +1,41 @@
+# Normally we would want this in lib/ext, but it needs to be loaded before the initializers.
+
+require 'geokit'
+require 'geoip'
+
+module Geokit
+  module Geocoders
+
+    @@geoip_data_path = File.expand_path(File.join(File.dirname(__FILE__),'..','data','GeoLiteCity.dat')) 
+    __define_accessors
+
+    # Provide geocoding based upon an IP address.  The underlying web service is maxmind.com.
+    # MaxMind City is a paid-for service, provides country, region, and city. Updated every month.
+    class GeoIpCityGeocoder < Geocoder
+      # Given an IP address, returns a GeoLoc instance which contains latitude,
+      # longitude, city, and country code. Sets the success attribute to false if the ip
+      # parameter does not match an ip address.
+      def self.do_geocode(ip, options = {})
+        return GeoLoc.new unless /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})?$/.match(ip)
+        if (res = ::GeoIP.new(Geocoders::geoip_data_path).city(ip))
+          loc = GeoLoc.new({
+            :provider => 'maxmind_city',
+            :lat => res.latitude,
+            :lng => res.longitude,
+            :city => res.city_name,
+            :state => res.region_name,
+            :zip => res.postal_code,
+            :country_code => res.country_code2
+          })
+          # Work around Geokit's jankiness
+          loc.success = res.city_name && res.city_name != ''
+          loc
+        else
+          GeoLoc.new
+        end
+      end
+
+    end
+  end
+end
+

data/test/test_geokit_geoip.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestGeokitGeoip < Test::Unit::TestCase
+
+  context "GeoIpCityGeocoder" do
+    setup do
+      @geocoder = Geokit::Geocoders::GeoIpCityGeocoder
+    end
+
+    should "have a default geoip_data_path" do
+      path = File.expand_path(File.join(File.dirname(__FILE__), "..", "data", "GeoLiteCity.dat"))
+      assert_equal path, Geokit::Geocoders.geoip_data_path
+    end
+
+    should "be able to set geoip_data_path" do
+      orig_path = Geokit::Geocoders.geoip_data_path
+      Geokit::Geocoders.geoip_data_path = "foo"
+      assert_equal "foo", Geokit::Geocoders.geoip_data_path
+      # Reset
+      Geokit::Geocoders.geoip_data_path = orig_path
+    end
+
+
+    bad_ips = ["nonesuch", "0.0.0.0", "127.0.0.1"]
+    bad_ips.each do |bad_ip|
+      should "return a blank GeoLoc for #{bad_ip}" do
+        assert_equal Geokit::GeoLoc.new, @geocoder.geocode(bad_ip)
+      end
+    end
+
+    context "with a good ip" do
+      setup { @ip = '67.244.97.190' }
+      should "be successful" do
+        result = @geocoder.geocode(@ip)
+        assert result.success?, result.city
+      end
+      should "set the right attributes" do
+        loc = @geocoder.geocode(@ip)
+        assert_equal "New York", loc.city
+        assert_equal "NY", loc.state
+        assert_equal "US", loc.country_code
+        assert (40..41).include?(loc.lat)
+        assert (-74..073).include?(loc.lng)
+        assert 5, loc.zip.size
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/geokit-geoip'
+require 'shoulda'
+require 'ruby-debug'

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: geokit-geoip
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aaron Suggs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-01 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: geoip
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: geokit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: GeoKit module for using Maxmind GeoIP City database
+email: aaron@ktheory.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- data/GeoLiteCity.dat
+- lib/geokit-geoip.rb
+- README.md
+- Rakefile
+- test/test_geokit_geoip.rb
+- test/test_helper.rb
+homepage: http://github.com/kickstarter/geokit-geoip
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+      - 1
+      - 5
+      - 0
+      version: 1.5.0
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.22
+signing_key: 
+specification_version: 3
+summary: GeoKit module for GeoIP
+test_files: 
+- test/test_geokit_geoip.rb
+- test/test_helper.rb