mm_geoip 0.0.2

data/lib/mm_geoip/region.rb

@@ -0,0 +1,29 @@
+class MMGeoip::Regions
+  class << self
+    
+    # Memoization and convinience for #parse.
+    def [](country_key)
+      @regions_hash ||= parse
+      @regions_hash[country_key.to_sym]
+    end
+    
+    # Parse the included regions file.
+    # It contains both, the ISO 3166-2 Subcountry codes for Canada and the US
+    # and the FIPS 10-4 Subcountry codes for the rest of the world.
+    # http://www.maxmind.com/app/iso3166_2
+    # http://www.maxmind.com/app/fips10_4)
+    # 
+    def parse
+      regions_hash = {}
+      File.open(File.join(MMGeoip::data_path, 'fips_and_3166_2.txt')).each_line do |line|
+        line_parts = line.split(',')
+        country, area, area_name = line_parts[0].to_sym, line_parts[1], line_parts[2].gsub('"','').strip
+        
+        regions_hash[country] ||= {}
+        regions_hash[country][area] = area_name
+      end
+      regions_hash
+    end
+    
+  end
+end

data/lib/mm_geoip/version.rb

@@ -0,0 +1,3 @@
+class MMGeoip
+  VERSION = '0.0.2'
+end

data/lib/mm_geoip.rb

@@ -0,0 +1,74 @@
+require 'geoip'
+
+$LOAD_PATH << File.dirname(File.expand_path __FILE__)
+
+class MMGeoip; end
+
+require 'mm_geoip/region'
+
+class MMGeoip
+  FIELDS = [:hostname, :ip, :country_code, :country_code3, :country_name,
+    :country_continent, :region, :city, :postal_code, :lat, :lng, :dma_code,
+    :area_code, :timezone]
+  attr_reader :lookup
+  
+  class NoIpGiven < StandardError; end
+  
+  def initialize(env)
+    @env = env # may be a Rack @env or any hash containing initial data
+    @env[:ip] ||= @env["REMOTE_ADDR"] # :ip or "REMOTE_ADDR" should be present
+    
+    raise NoIpGiven.new unless @env[:ip]
+    
+    @geodb = GeoIP.new self.class.db_path
+  end
+  
+  FIELDS.each do |field|
+    define_method field do
+      # if already looked up, get field from lookup or environment (lookup has priority)
+      # else                  get field from environment or lookup (environment has priority; perhaps we don't have to lookup)
+      # looked_up? ? fields[field] || get_from_env(field) : get_from_env(field) || fields[field]
+      looked_up? ? lookup[field]  || get_from_env(field)  : get_from_env(field) || lookup[field]
+    end
+  end
+  
+  def get_from_env(field)
+    # APACHE:GEOIP with Geolite City give us:
+    # GEOIP_REGION, GEOIP_CITY, GEOIP_DMA_CODE, GEOIP_AREA_CODE, GEOIP_LAT, GEOIP_LNG
+    # 
+    # Nginx with HttpGeoIPModule and Geolite City makes these variables available in nginx.conf:
+    # $geoip_country_code, ..., you'll have to set the env variables by yourself.
+    # I'd recommend using the X_GEOIP_... form.
+    # 
+    # Here, we look for both forms and the plain version.
+    # 
+    @env[field] || @env["GEOIP_#{field.upcase}"] || @env["X_GEOIP_#{field.upcase}"]
+  end
+  
+  def region_name
+    MMGeoip::Regions[country_code.to_sym] && MMGeoip::Regions[country_code.to_sym][region]
+  end
+  
+  def looked_up?
+    !!@lookup
+  end
+  
+  def lookup                                                                                                                     
+    return @lookup if @lookup                                                                                                    
+    
+    @lookup = Hash[FIELDS.zip @geodb.city(@env[:ip])]                                                                            
+    @lookup[:region_name] = region_name                                                                                          
+    @lookup                                                                                                                      
+  end
+  
+  def self.data_path
+    File.join(File.dirname(File.expand_path(__FILE__)), '../data')
+  end
+  def self.db_path
+    @db_path || File.join(data_path, 'GeoLiteCity.dat')
+  end
+  def self.db_path=(path)
+    @db_path = path
+  end
+  
+end

data/lib/rack_mm_geoip.rb

@@ -0,0 +1,12 @@
+module Rack
+  class MMGeoip
+    def initialize(app)
+      @app = app
+    end
+    
+    def call(env)
+      env['GEOIP'] = ::MMGeoip.new env
+      @app.call(env)
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: mm_geoip
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Niko Dittmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-04 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 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: A proxy object around the geoip gem for lazy lookup. Includes a Rack middleware.
+email: mail+git@niko-dittmann.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mm_geoip/region.rb
+- lib/mm_geoip/version.rb
+- lib/mm_geoip.rb
+- lib/rack_mm_geoip.rb
+- data/fips_and_3166_2.txt
+- data/GeoLiteCity.dat
+homepage: http://github.com/niko/mm_geoip
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: A proxy object around the geoip gem for lazy lookup. Includes a Rack middleware.
+test_files: []
+