rack-geoip 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+data

data/COPYING

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Chris Kraybill
+
+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/README

@@ -0,0 +1,78 @@
+= Rack::Geoip
+
+A rack middleware component that handles simple geoip lookups.
+
+== Installation
+
+First you must have a GeoIP database installed. Currently the only backend support is the free one from
+MaxMind (http://www.maxmind.com). So you must first install the C api bindings.
+
+    $ wget http://geolite.maxmind.com/download/geoip/api/c/GeoIP.tar.gz
+    $ tar xzf GeoIP.tar.gz
+    $ cd GeoIP-1.4.6
+    $ ./configure && make && sudo make install
+
+To download the actual GeoLiteCity (free) database you can currently find it here (I like to place it in
+a data sub-directory).
+
+    $ cd data
+    $ wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
+    $ gunzip GeoLiteCity.dat.gz
+
+And finally install the gem
+
+    $ gem install rack-geoip
+    
+== Usage
+
+=== Basic Usage
+
+    require 'rack/geoip'
+    use Rack::Geoip
+    run app
+
+=== Using with Rails
+
+Add this to your config/environment.rb
+
+    config.gem 'rack-geoip'
+
+And then in an initializer block
+
+    config.middleware.use "Rack::Geoip",
+      :db => 'data/GeoLiteCity.dat',
+      :path => '/geoip/info'
+      
+=== Sample output
+
+    $ curl http://localhost:9292/lookup?ip=8.8.8.8
+    
+    { "area_code":650,
+      "city":"Mountain View",
+      "postal_code":"94043",
+      "country_code":"US",
+      "latitude":37.4192008972168,
+      "country_code3":"USA",
+      "longitude":-122.057403564453,
+      "country_name":"United States",
+      "dma_code":807,
+      "region":"CA" }
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Credits
+
+I want to acknowledge the work done by Geoffrey Grosenbach (http://peepcode.com) on the sinatra-geoip gem which was the
+inspiration for this.
+
+== License
+
+Rack::Geoip is Copyright (c) 2010 by Chris Kraybill and is provided under the MIT license. See COPYING for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-geoip"
+    gem.summary = %Q{A rack middleware component that handles simple geoip lookups.}
+    gem.description = %Q{A rack middleware component that handles simple geoip lookups.}
+    gem.email = "ckraybill@gmail.com"
+    gem.homepage = "http://github.com/ckraybill/rack-geoip"
+    gem.authors = ["Chris Kraybill"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "geoip_city"
+    gem.add_dependency "json"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-geoip #{version}"
+  rdoc.rdoc_files.include('README*','COPYING')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('TODO')
+end

data/TODO

@@ -0,0 +1,8 @@
+== Short Term
+
+* Document code better
+ 
+== Version bumps
+
+* Implement a backend interface to allow for different GeoIP backends
+* Country code support

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/examples/basic.ru

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rack'
+require 'rack/geoip'
+
+class BasicRackApp
+  def call(env)
+    [200, {'Content-Type' => 'text/plain'}, 'Your request did not hit the geoip lookup']
+  end
+end
+
+use Rack::Geoip, :path => '/lookup', :db => 'data/GeoLiteCity.dat'
+
+run BasicRackApp.new

data/lib/rack/geoip/lookup.rb

@@ -0,0 +1,32 @@
+require 'geoip_city'
+require 'json'
+
+module Rack::Geoip
+  # Implements Rack's middleware interface and provides the geoip
+  # lookup service
+  class Lookup
+    DEFAULT =  {:path => '/geoip/lookup', :db => 'GeoLiteCity.dat'}
+
+    def initialize(app, options={})
+      @app, @options = app, DEFAULT.merge(options)
+      @db = GeoIPCity::Database.new(@options[:db])
+    end
+    
+    def call(env)
+      dup._call(env)
+    end
+    
+    def _call(env)
+      if env['PATH_INFO'] == @options[:path]
+        request = Rack::Request.new(env)
+        if request.params['ip'] && result=@db.look_up(request.params['ip'])
+          [200, {'Content-Type' => 'application/json'}, result.to_json]
+        else
+          [404, {'Content-Type' => 'text/plain'}, "Example usage: #{env['rack.url_scheme']}://#{env['HTTP_HOST']}#{env['PATH_INFO']}?ip=8.8.8.8"]
+        end
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/rack/geoip.rb

@@ -0,0 +1,37 @@
+require 'rack'
+
+module Rack  #:nodoc:
+  # = Rack Middleware for GEOIP Lookups
+  # 
+  # Rack::Geoip is intended to be a rack interface into a GeoIP database
+  # provided by MaxMind (http://www.maxmind.com). See the README for
+  # installation
+  # 
+  # == Usage
+  # 
+  # === Basic Usage
+  # 
+  #     require 'rack/geoip'
+  #     use Rack::Geoip
+  #     run app
+  # 
+  # === Using with Rails
+  # 
+  # Add this to your config/environment.rb
+  # 
+  #     config.gem 'rack-geoip'
+  # 
+  # And then in an initializer block
+  # 
+  #     config.middleware.use "Rack::Geoip",
+  #       :db => 'data/GeoLiteCity.dat',
+  #       :path => '/geoip/info'
+  #
+  module Geoip
+    autoload :Lookup, 'rack/geoip/lookup'
+  
+    def self.new(backend, options = {})
+      Lookup.new(backend,options)
+    end
+  end
+end

data/lib/rack-geoip.rb

@@ -0,0 +1 @@
+require 'rack/geoip'

data/rack-geoip.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-geoip}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Kraybill"]
+  s.date = %q{2010-08-25}
+  s.description = %q{A rack middleware component that handles simple geoip lookups.}
+  s.email = %q{ckraybill@gmail.com}
+  s.extra_rdoc_files = [
+    "README",
+     "TODO"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "COPYING",
+     "README",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "examples/basic.ru",
+     "lib/rack-geoip.rb",
+     "lib/rack/geoip.rb",
+     "lib/rack/geoip/lookup.rb",
+     "rack-geoip.gemspec",
+     "spec/rack-geoip_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ckraybill/rack-geoip}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A rack middleware component that handles simple geoip lookups.}
+  s.test_files = [
+    "spec/rack-geoip_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<geoip_city>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<geoip_city>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<geoip_city>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end
+

data/spec/rack-geoip_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "RackGeoip" do
+  def app
+    app = Rack::Builder.new {
+      use Rack::Geoip, :path => '/geocode/lookup', :db => File.dirname(__FILE__)+'/../data/GeoLiteCity.dat'
+      run BasicRackApp.new
+    }
+  end
+
+  # This makes sure the middleware doesn't get in the way of normal requests
+  it "says hello" do
+    get '/'
+    last_response.should be_ok
+    last_response.body.should == 'Hello World'
+  end
+  
+  # This makes sure that the middleware will return a 404 with some suggested usage
+  # when the request is malformed
+  it 'should return 404 when a geocode lookup request has malformed parameters' do
+    get '/geocode/lookup'
+    last_response.status.should == 404
+    last_response.body.should == 'Example usage: http:///geocode/lookup?ip=8.8.8.8'
+  end
+  
+  # This makes sure that the response is JSON parse-able
+  it 'should return some json when a geocode lookup works' do
+    get '/geocode/lookup?ip=8.8.8.8'
+    last_response.should be_ok
+    json = JSON.parse(last_response.body)
+    json.class.should == Hash
+  end
+  
+  # This tests the actual geocode lookup
+  it 'should return the city Mountain View when the provided IP lookup is for a googleplex' do
+    get '/geocode/lookup?ip=8.8.8.8'
+    json = JSON.parse(last_response.body)
+    json['city'].should == 'Mountain View'
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'json'
+require 'rack-geoip'
+require 'spec'
+require 'spec/autorun'
+require 'rack/test'
+
+Spec::Runner.configure do |config|
+  config.include Rack::Test::Methods
+end
+
+class BasicRackApp
+  def call(env)
+    [200, {'Content-Type' => 'text/plain'}, 'Hello World']
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: rack-geoip
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Chris Kraybill
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: geoip_city
+  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: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: A rack middleware component that handles simple geoip lookups.
+email: ckraybill@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- TODO
+files: 
+- .document
+- .gitignore
+- COPYING
+- README
+- Rakefile
+- TODO
+- VERSION
+- examples/basic.ru
+- lib/rack-geoip.rb
+- lib/rack/geoip.rb
+- lib/rack/geoip/lookup.rb
+- rack-geoip.gemspec
+- spec/rack-geoip_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ckraybill/rack-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: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A rack middleware component that handles simple geoip lookups.
+test_files: 
+- spec/rack-geoip_spec.rb
+- spec/spec_helper.rb