rack-geoipcity 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.rvmrc
+*.tmproj

data/README

@@ -0,0 +1,47 @@
+Rack::GeoIPCity uses the geoip gem and the GeoIP database to lookup the geographical info of a request by its IP address
+The database can be downloaded from:
+
+(Lite version) http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz, instructions are here http://www.maxmind.com/app/geolitecity.
+
+http://www.maxmind.com/app/city for full version.
+
+*NOTE!* If you're using the country database you'll get a different struct returned, so use the GeoIPCountry gem, rack-geoipcountry. I'd make this middleware do both but:
+
+a) It would be slower 
+b) there's already a country gem and 
+c) you can do the branching yourself if you really want, but why would you?
+
+Usage:
+======
+
+use Rack::GeoIPCity, :db => "path/to/GeoIP.dat"
+
+By default all requests are looked up and the X\_GEOIP\_* headers are added to the request
+The headers can then be read in the application
+The country name is added to the request header as X\_GEOIP\_COUNTRY, eg:
+X\_GEOIP\_COUNTRY: United Kingdom
+
+The full set of GEOIP request headers is below:
+X\_GEOIP\_COUNTRY\_CODE - The ISO3166-1 two-character country code, if not found set to --
+X\_GEOIP\_COUNTRY\_CODE3 - The ISO3166-2 three-character country code, if not found set to --
+X\_GEOIP\_COUNTRY - The ISO3166 English-language name of the country, if not found set to an empty string
+X\_GEOIP\_CONTINENT if not found set to an empty string
+X\_GEOIP\_REGION\_NAME if not found set to an empty string
+X\_GEOIP\_CITY\_NAME if not found set to an empty string
+X\_GEOIP\_POSTAL\_CODE if not found set to an empty string
+X\_GEOIP\_LATITUDE if not found won't be returned as I can't think of another good return value to signify "not found"
+X\_GEOIP\_LONGITUDE if not found won't be returned as I can't think of another good return value to signify "not found"
+'X\_GEOIP\_DMA\_CODE' The metropolitan code (this is for the USA, see http://code.google.com/apis/adwords/docs/appendix/metrocodes.html if you're interested), default 0 for not found.
+X\_GEOIP\_AREA\_CODE if not found set to an empty string
+X\_GEOIP\_TIMEZONE if not found set to an empty string
+X\_GEOIP\_CONTINENT - The two-character continent code, if not found set to an empty string
+
+
+You can use the included Mapping class to trigger lookup only for certain requests by specifying matching path prefix in options, eg:
+use Rack::GeoIPCity::Mapping, :prefix => '/video\_tracking'
+The above will lookup IP addresses only for requests matching /video\_tracking etc.
+
+MIT License - 
+Originally by Karol Hosiawa ( http://twitter.com/hosiawak )
+Converted to a gem by Thomas Maurer
+This one by Iain Barnett

data/lib/rack/geoipcity/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module GeoIPCity
+    VERSION = "0.0.1"
+  end
+end

data/lib/rack/geoipcity.rb

@@ -0,0 +1,69 @@
+require 'geoip'
+
+module Rack
+  
+  # See the README for more docs
+  class GeoIPCity
+    def initialize(app, options = {})
+      options[:db] ||= 'GeoIP.dat'
+      @db = GeoIP.new(options[:db])
+      @app = app
+    end
+    
+    DEFAULTS = {
+      'X_GEOIP_COUNTRY_CODE' => 0,
+      'X_GEOIP_COUNTRY_CODE3' => 0,
+      'X_GEOIP_COUNTRY' => '',
+      'X_GEOIP_CONTINENT' => '',
+      'X_GEOIP_REGION_NAME' => '',
+      'X_GEOIP_CITY_NAME' => '',
+      'X_GEOIP_POSTAL_CODE' => '' ,
+      'X_GEOIP_LATITUDE' => nil,
+      'X_GEOIP_LONGITUDE' => nil,
+      'X_GEOIP_DMA_CODE' => 0,
+      'X_GEOIP_AREA_CODE' => 0,
+      'X_GEOIP_TIMEZONE' => '',
+    }
+
+    def call(env)
+      res = @db.city(env['REMOTE_ADDR'])
+      
+      unless res.nil? # won't bork on local or bad ip's
+        hash = {}
+        hash['X_GEOIP_COUNTRY_CODE'] = res.country_code2 unless res.country_code2.nil?
+        hash['X_GEOIP_COUNTRY_CODE3'] = res.country_code3 unless res.country_code3.nil?
+        hash['X_GEOIP_COUNTRY'] = res.country_name unless res.country_name.nil?
+        hash['X_GEOIP_CONTINENT'] = res.continent_code unless res.continent_code.nil?
+        hash['X_GEOIP_REGION_NAME'] = res.region_name unless res.region_name.nil?
+        hash['X_GEOIP_CITY_NAME'] = res.city_name unless res.city_name.nil?
+        hash['X_GEOIP_POSTAL_CODE'] = res.postal_code unless res.postal_code.nil?
+        hash['X_GEOIP_LATITUDE'] = res.latitude 
+        hash['X_GEOIP_LONGITUDE'] = res.longitude
+        hash['X_GEOIP_DMA_CODE'] = res.dma_code unless res.dma_code.nil?
+        hash['X_GEOIP_AREA_CODE'] = res.area_code unless res.area_code.nil?
+        hash['X_GEOIP_TIMEZONE'] = res.timezone unless res.timezone.nil?
+        
+        hash.delete_if{|k,v| v.nil? } # remove latitude and longitude and any other stragglers
+        env.merge!( DEFAULTS.merge hash )
+      end 
+      
+      @app.call(env)
+    end
+
+    class Mapping
+      def initialize(app, options = {})
+        @app, @prefix = app, /^#{options.delete(:prefix)}/
+        @geoip = GeoIPCity.new(app, options)
+      end
+
+      def call(env)
+        if env['PATH_INFO'] =~ @prefix
+          @geoip.call(env)
+        else
+          @app.call(env)
+        end
+      end
+    end
+    
+  end
+end

data/rack-geoipcity.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/geoipcity/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-geoipcity"
+  s.version     = Rack::GeoIPCity::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Karol Hosiawa", "Thomas Maurer", "Iain Barnett"]
+  s.email       = ["iainspeed@gmail.com"]
+  s.homepage    = "https://github.com/yb66/Rack-GeoIPCity"
+  s.summary     = %q{Rack middleware for Geo IP city lookup}
+  s.description = %q{Rack::GeoIPCity uses the geoip gem and the GeoIP database to lookup the city of a request by its IP address}
+  s.license     = 'MIT'
+
+  s.add_dependency 'geoip'
+
+  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

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: rack-geoipcity
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Karol Hosiawa
+- Thomas Maurer
+- Iain Barnett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: geoip
+  requirement: &2152901760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152901760
+description: Rack::GeoIPCity uses the geoip gem and the GeoIP database to lookup the
+  city of a request by its IP address
+email:
+- iainspeed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README
+- lib/rack/geoipcity.rb
+- lib/rack/geoipcity/version.rb
+- rack-geoipcity.gemspec
+homepage: https://github.com/yb66/Rack-GeoIPCity
+licenses:
+- MIT
+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.8.5
+signing_key: 
+specification_version: 3
+summary: Rack middleware for Geo IP city lookup
+test_files: []