geoip-rails 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in geoip-rails.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,122 @@
+Implements efficient MaxMind GeoIP database queries in Rails. Read more about the techinque at [this fantastic article](http://jcole.us/blog/archives/2007/11/24/on-efficiently-geo-referencing-ips-with-maxmind-geoip-and-mysql-gis).
+
+## Install
+
+Add gem dependency to your Gemfile:
+
+    gem 'geoip-rails'
+
+## Usage
+
+In your Rails app, `Geoip::Location` model is available. To get the location information for the user IP-address, call find_by_ip on it:
+
+    Geoip::Location.find_by_ip('123.123.123.123')
+    # => #<Geoip::Location id: 33447, country: "EE", region: "18", city: "Tartu", postal_code: 0, latitude: 58.3661, longitude: 26.7361, metro_code: 0, area_code: 0>
+    
+
+## TODO
+
+See [GitHub issues list](https://github.com/priithaamer/geoip-rails/issues).
+
+## Database schema
+
+    CREATE DATABASE geoip;
+
+    CREATE TABLE blocks (
+      ip_poly      POLYGON       NOT NULL,
+      ip_from      INT UNSIGNED  NOT NULL,
+      ip_to        INT UNSIGNED  NOT NULL,
+      location_id  INT(11)       NOT NULL,
+      SPATIAL INDEX (ip_poly)
+    ) ENGINE = MyISAM DEFAULT CHARSET = utf8;
+
+    CREATE TABLE locations (
+      id            INT(10)       UNSIGNED NOT NULL,
+      country       CHAR(2)       NOT NULL,
+      region        CHAR(2)       NOT NULL,
+      city          VARCHAR(50)   NOT NULL,
+      postal_code   INT(10)       UNSIGNED DEFAULT NULL,
+      latitude      FLOAT         DEFAULT NULL,
+      longitude     FLOAT         DEFAULT NULL,
+      metro_code    INT(10)       UNSIGNED DEFAULT NULL,
+      area_code     INT(10)       UNSIGNED DEFAULT NULL,
+      PRIMARY KEY (id)
+    ) ENGINE = MyISAM DEFAULT CHARSET = utf8;
+    
+## Import database from CSV files
+
+    USE geoip;
+
+    CREATE TABLE blocks_new (
+      ip_poly      POLYGON       NOT NULL,
+      ip_from      INT UNSIGNED  NOT NULL,
+      ip_to        INT UNSIGNED  NOT NULL,
+      location_id  INT(11)       NOT NULL,
+      SPATIAL INDEX (ip_poly)
+    ) ENGINE = MyISAM DEFAULT CHARSET = utf8;
+
+    CREATE TABLE locations_new (
+      id INT(10)    UNSIGNED    NOT NULL,
+      country       CHAR(2)     NOT NULL,
+      region        CHAR(2)     NOT NULL,
+      city          VARCHAR(50) NOT NULL,
+      postal_code   INT(10)     UNSIGNED DEFAULT NULL,
+      latitude      FLOAT       DEFAULT NULL,
+      longitude     FLOAT       DEFAULT NULL,
+      metro_code    INT(10)     UNSIGNED DEFAULT NULL,
+      area_code     INT(10)     UNSIGNED DEFAULT NULL,
+      PRIMARY KEY (id)
+    ) ENGINE = MyISAM DEFAULT CHARSET = utf8;
+
+    LOAD DATA LOCAL INFILE "/tmp/GeoLiteCity-Blocks.csv"
+    INTO TABLE blocks_new
+    FIELDS
+      TERMINATED BY ","
+      ENCLOSED BY '\"'
+    IGNORE 2 LINES
+    (
+      @start, @end, @location_id
+    )
+    SET
+      ip_from       := @start,
+      ip_to         := @end,
+      ip_poly       := GEOMFROMWKB(POLYGON(LINESTRING(
+          POINT(@start, -1),
+          POINT(@end,   -1),
+          POINT(@end,    1),
+          POINT(@start,  1),
+          POINT(@start, -1)
+        ))),
+      location_id := @location_id
+    ;
+
+    LOAD DATA LOCAL INFILE "/tmp/GeoLiteCity-Location.csv"
+    INTO TABLE locations_new
+    FIELDS
+      TERMINATED BY ","
+      ENCLOSED BY '\"'
+    IGNORE 2 LINES
+    (
+      @id, @country, @region, @city, @postal_code, @latitude, @longitude, @metro_code, @area_code
+    )
+    SET
+      id          := @id,
+      country     := @country,
+      region      := @region,
+      city        := @city,
+      postal_code := @postal_code,
+      latitude    := @latitude,
+      longitude   := @longitude,
+      metro_code  := @metro_code,
+      area_code   := @area_code
+    ;
+
+    RENAME TABLE blocks TO blocks_old;
+    RENAME TABLE locations TO locations_old;
+    RENAME TABLE blocks_new TO blocks;
+    RENAME TABLE locations_new TO locations;
+
+    DROP TABLE blocks_old;
+    DROP TABLE locations_old;
+    
+    

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app/models/geoip/base.rb

@@ -0,0 +1,9 @@
+module Geoip
+  class Base < ActiveRecord::Base
+    
+    self.abstract_class = true
+    
+    establish_connection(ActiveRecord::Base.configurations["geoip_#{::Rails.env}"])
+    
+  end
+end

data/app/models/geoip/block.rb

@@ -0,0 +1,7 @@
+module Geoip
+  class Block < Geoip::Base
+    
+    belongs_to :location
+    
+  end
+end

data/app/models/geoip/location.rb

@@ -0,0 +1,10 @@
+module Geoip
+  class Location < Geoip::Base
+    
+    has_many :blocks
+    
+    def self.find_by_ip(ip)
+      self.joins(:blocks).where('MBRCONTAINS(ip_poly, POINTFROMWKB(POINT(INET_ATON(?), 0)))', ip).first
+    end
+  end
+end

data/geoip-rails.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'geoip-rails/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'geoip-rails'
+  s.version     = Geoip::Rails::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Priit Haamer']
+  s.email       = ['priit@fraktal.ee']
+  s.homepage    = 'https://github.com/priithaamer/geoip-rails'
+  s.summary     = %q{MySQL database backed interface to MaxMind's GeoLite City GeoIP information}
+  s.description = %q{Provides ultra-fast access to GeoIP database through Rails models}
+
+  s.rubyforge_project = 'geoip-rails'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/lib/geoip-rails.rb

@@ -0,0 +1 @@
+require 'geoip-rails/engine' if defined?(::Rails) && ::Rails::VERSION::MAJOR >= 3

data/lib/geoip-rails/engine.rb

@@ -0,0 +1,6 @@
+module Geoip
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/geoip-rails/version.rb

@@ -0,0 +1,5 @@
+module Geoip
+  module Rails
+    VERSION = '0.0.1'
+  end
+end

data/lib/tasks/geoip-rails.rake

@@ -0,0 +1,14 @@
+namespace :geoip do
+
+  desc 'Download GeoLiteCity database from MaxMind'
+  task :download do
+    # wget -O /tmp/GeoLiteCity.zip http://geolite.maxmind.com/download/geoip/database/GeoLiteCity_CSV/GeoLiteCity_20110301.zip
+    # unzip /tmp/GeoLiteCity.zip
+    # mv /tmp/GeoLiteCity_20110301/*.* /tmp
+  end
+  
+  desc 'Update database'
+  task :updatedb do
+    puts 'Update database stub'
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: geoip-rails
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Priit Haamer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-20 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: Provides ultra-fast access to GeoIP database through Rails models
+email: 
+- priit@fraktal.ee
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- app/models/geoip/base.rb
+- app/models/geoip/block.rb
+- app/models/geoip/location.rb
+- geoip-rails.gemspec
+- lib/geoip-rails.rb
+- lib/geoip-rails/engine.rb
+- lib/geoip-rails/version.rb
+- lib/tasks/geoip-rails.rake
+has_rdoc: true
+homepage: https://github.com/priithaamer/geoip-rails
+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: geoip-rails
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: MySQL database backed interface to MaxMind's GeoLite City GeoIP information
+test_files: []
+