mm_geoip 0.0.4 → 0.1.0

data/bin/mm_geoip

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'mm_geoip'
+
+begin
+  if ip = ARGV[0]
+    MMGeoip.db_path = ARGV[1] if ARGV[1]
+    
+    puts "Using database: #{MMGeoip.db_path}"
+    
+    geoip = MMGeoip.new :ip => ip
+    
+    (MMGeoip::FIELDS + [:region_name]).each do |field|
+      puts "#{field}: #{geoip.send field}"
+    end
+  
+  else
+    puts "You should try passing an IP as argument: mm_geoip 134.34.3.2"
+  end
+rescue MMGeoip::NoDatabaseFile => e
+  puts %Q{
+MMGeoip could't find your geodb database file.
+#{e.class}: #{e.message}
+
+When runing this tool you have three possibilities to define the database location.
+
+* Either you can put one into the gem so mm_geoip finds it automatically:
+  ln -s /your/database.dat `pwd`
+
+* Or you set an environment variable:
+  MMGeoipDatabase=/your/database.dat mm_geoip 134.34.3.2
+
+* Or you pass the location as a second argument:
+  mm_geoip 134.34.3.2 /your/database.dat
+
+Download:
+  curl http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz | gunzip > GeoLiteCity.dat
+                                                                                                            
+}
+
+end

data/lib/mm_geoip/version.rb

@@ -1,3 +1,3 @@
 class MMGeoip
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 end

data/lib/mm_geoip.rb

@@ -4,6 +4,7 @@ $LOAD_PATH << File.dirname(File.expand_path __FILE__)
 
 class MMGeoip; end
 
+require 'mm_geoip/version'
 require 'mm_geoip/region'
 
 class MMGeoip
@@ -13,14 +14,19 @@ class MMGeoip
   attr_reader :lookup
   
   class NoIpGiven < StandardError; end
+  class NoDatabaseFile < StandardError; end
   
   def initialize(env)
-    @env = env # may be a Rack @env or any hash containing initial data
-    @env[:ip] ||= @env["HTTP_X_REAL_IP"] || @env["HTTP_X_FORWARDED_FOR"] || @env["REMOTE_ADDR"]
+    # May be a Rack @env or any hash containing initial data. Or just an IP.
+    @env = env.is_a?(Hash) ? env.dup : {:ip => env}
+    @ip = @env[:ip] || @env["HTTP_X_REAL_IP"] || @env["HTTP_X_FORWARDED_FOR"] || @env["REMOTE_ADDR"]
     
-    raise NoIpGiven.new unless @env[:ip]
-    
-    @geodb = GeoIP.new self.class.db_path
+    raise NoIpGiven.new("No IP in env hash") unless @ip
+    raise NoDatabaseFile.new("No database file: #{self.class.db_path}") unless File.exists? self.class.db_path
+  end
+  
+  def geodb
+    @geodb ||= GeoIP.new self.class.db_path
   end
   
   FIELDS.each do |field|
@@ -56,7 +62,7 @@ class MMGeoip
   def lookup
     return @lookup if @lookup
     
-    looked_up_fields = @geodb.city @env[:ip]
+    looked_up_fields = geodb.city @ip
     
     return @lookup = {} unless looked_up_fields
     
@@ -69,7 +75,7 @@ class MMGeoip
     File.join(File.dirname(File.expand_path(__FILE__)), '../data')
   end
   def self.db_path
-    @db_path || File.join(data_path, 'GeoLiteCity.dat')
+    @db_path || ENV['MMGeoipDatabase'] || File.join(data_path, 'GeoLiteCity.dat')
   end
   def self.db_path=(path)
     @db_path = path

data/lib/{rack_mm_geoip.rb → rack/mm_geoip.rb}

@@ -1,3 +1,5 @@
+require 'mm_geoip.rb'
+
 module Rack
   class MMGeoip
     def initialize(app)
@@ -5,8 +7,8 @@ module Rack
     end
     
     def call(env)
-      env['GEOIP'] = ::MMGeoip.new env
-      @app.call(env)
+      @app.call env.dup.merge('GEOIP' => ::MMGeoip.new(env))
     end
   end
 end
+

data/lib/sinatra/mm_geoip.rb

@@ -0,0 +1,15 @@
+require 'rack/mm_geoip.rb'
+
+module Sinatra
+  module MMGeoip
+    
+    # Just a convinience method to access the mm_geoip proxy
+    # object in Sinatra routes and views.
+    def geoip
+      request.env['GEOIP']
+    end
+    
+  end
+  
+  helpers MMGeoip
+end

data/spec/mm_geoip_region_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), 'spec_helper')
+
+describe MMGeoip::Regions do
+  describe "#parse" do
+    it "works" do
+      MMGeoip::Regions.parse[:CA]['NS'].should == 'Nova Scotia'       # CA,NS,"Nova Scotia"
+      MMGeoip::Regions.parse[:US]['AL'].should == 'Alabama'           # US,AL,"Alabama"
+      MMGeoip::Regions.parse[:DE]['01'].should == 'Baden-Wurttemberg' # DE,02,"Bayern"
+      MMGeoip::Regions.parse[:DE]['02'].should == 'Bayern'            # DE,01,"Baden-Wurttemberg"
+    end
+  end
+  describe "#[]" do
+    it "works" do
+      MMGeoip::Regions[:CA]['NS'].should == 'Nova Scotia'       # CA,NS,"Nova Scotia"
+      MMGeoip::Regions[:US]['AL'].should == 'Alabama'           # US,AL,"Alabama"
+      MMGeoip::Regions[:DE]['01'].should == 'Baden-Wurttemberg' # DE,02,"Bayern"
+      MMGeoip::Regions[:DE]['02'].should == 'Bayern'            # DE,01,"Baden-Wurttemberg"
+    end
+  end
+end

data/spec/mm_geoip_spec.rb

@@ -0,0 +1,105 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), 'spec_helper')
+
+describe MMGeoip do
+  describe "the whole stack" do
+    before(:each) do
+      @env = {:ip => '134.34.3.2'}
+    end
+    it "should be fast" do
+      # Succeeds with a margin of about 10% on my MBP core2duo 2.4GHz.
+      # On slower computers this will fail.
+      Benchmark.measure{
+        1000.times{mm_geoip = MMGeoip.new @env ; mm_geoip.city} # with lookup
+      }.total.should < 0.6
+    end
+    it "be lazy, i.e. 3 times faster without lookup" do
+      with_lookup = Benchmark.measure{
+        1000.times{mm_geoip = MMGeoip.new @env ; mm_geoip.city} # with lookup
+      }.total
+      
+      no_lookup = Benchmark.measure{
+        1000.times{mm_geoip = MMGeoip.new @env} # no lookup
+      }.total
+      
+      (no_lookup*3).should < with_lookup
+    end
+  end
+  
+  describe "#initialize" do
+    it "works with the IP as :ip field" do
+      MMGeoip.new '134.34.3.2'
+    end
+    it "works with just the IP" do
+      MMGeoip.new :ip => '134.34.3.2'
+    end
+    it "works with the IP as 'REMOTE_ADDR' field" do
+      MMGeoip.new 'REMOTE_ADDR' => '134.34.3.2'
+    end
+    it "works with the IP as 'HTTP_X_REAL_IP' field" do
+      MMGeoip.new 'HTTP_X_REAL_IP' => '134.34.3.2'
+    end
+    it "works with the IP as 'HTTP_X_FORWARDED_FOR' field" do
+      MMGeoip.new 'HTTP_X_FORWARDED_FOR' => '134.34.3.2'
+    end
+    it "raises, if not :ip or 'REMOTE_ADDR' is given" do
+      lambda{ MMGeoip.new :whatelse => 'something' }.should raise_error(MMGeoip::NoIpGiven)
+    end
+    it "puts the parameter into the env instance variable" do
+      env = {:ip => '134.34.3.2'}
+      mm_geoip = MMGeoip.new env
+      mm_geoip.instance_variable_get('@env').should == env
+    end
+    it "does not alter the env hash" do
+      env = {'REMOTE_ADDR' => '134.34.3.2'}
+      env_before = env.dup
+      mm_geoip = MMGeoip.new env
+      env.should == env_before
+    end
+  end
+  
+  describe "#geoip" do
+    it "sets up a geoidb object" do
+      mm_geoip = MMGeoip.new(:ip => '134.34.3.2')
+      mm_geoip.geodb.should == mm_geoip.instance_variable_get('@geodb')
+      mm_geoip.geodb.should be_a(GeoIP)
+    end
+  end
+  
+  describe "the getters" do
+    it "works" do
+      mm_geoip = MMGeoip.new :ip => '134.34.3.2'
+      mm_geoip.ip.should == '134.34.3.2'
+      
+      mm_geoip.hostname.should          == '134.34.3.2'
+      mm_geoip.ip.should                == '134.34.3.2'
+      mm_geoip.country_code.should      == 'DE'
+      mm_geoip.country_code3.should     == 'DEU'
+      mm_geoip.country_name.should      == 'Germany'
+      mm_geoip.country_continent.should == 'EU'
+      mm_geoip.region.should            == '01'
+      mm_geoip.city.should              == 'Konstanz'
+      mm_geoip.postal_code.should       == ''
+      mm_geoip.lat.should               == 47.66669999999999
+      mm_geoip.lng.should               == 9.183300000000003
+      mm_geoip.dma_code.should          == nil
+      mm_geoip.area_code.should         == nil
+      mm_geoip.timezone.should          == 'Europe/Berlin'
+      mm_geoip.region_name.should       == 'Baden-Wurttemberg'
+    end
+    it "works with localhost, too" do
+      mm_geoip = MMGeoip.new :ip => '127.0.0.1'
+      mm_geoip.ip.should == '127.0.0.1'
+      
+      mm_geoip.hostname.should be_nil
+      mm_geoip.region_name.should be_nil
+    end
+  end
+  
+  describe "#get_from_env" do
+    it "tries the env fields" do
+      MMGeoip.new(:ip => '134.34.3.2', :hostname => 'hostname').hostname.should == 'hostname'
+      MMGeoip.new(:ip => '134.34.3.2', 'GEOIP_HOSTNAME' => 'geoip hostname').hostname.should == 'geoip hostname'
+      MMGeoip.new(:ip => '134.34.3.2', 'X_GEOIP_HOSTNAME' => 'x geoip hostname').hostname.should == 'x geoip hostname'
+    end
+  end
+end

data/spec/rack/mm_geoip_spec.rb

@@ -0,0 +1,11 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), '../spec_helper')
+
+describe Rack::MMGeoip do
+  describe '#call' do
+    it "adds a MMGeoip object to the env hash" do
+      app = proc{|env| env}
+      rack_geoip = Rack::MMGeoip.new app
+      rack_geoip.call({:ip => '134.34.3.2'})['GEOIP'].should be_a(MMGeoip)
+    end
+  end
+end

data/spec/sinatra/mm_geoip_spec.rb

@@ -0,0 +1,39 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), '../spec_helper')
+
+require 'rack/test'
+
+class SinatraMMGeoipApp < Sinatra::Base
+  use Rack::MMGeoip
+  helpers Sinatra::MMGeoip
+  
+  get '/' do
+    geoip.city
+  end
+  
+end
+
+describe Sinatra::MMGeoip do
+  include Rack::Test::Methods
+  
+  def app
+    SinatraMMGeoipApp
+  end
+  
+  describe "a test app which just puts the city into the body" do
+    describe "with a remote address in the env hash" do
+      it "returns the city as response" do
+        get '/', {}, {'REMOTE_ADDR' => '134.34.3.2'}
+        puts last_response.body
+        last_response.should be_ok
+        last_response.body.should == 'Konstanz'
+      end
+    end
+    describe "without a remote address in the env hash" do
+      it "returns an emty response" do
+        get '/'
+        last_response.should be_ok
+        last_response.body.should == ''
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH << File.join(File.dirname(File.expand_path __FILE__), '../lib')
+
+require 'benchmark'
+
+require 'mm_geoip'
+require 'rack/mm_geoip'
+require 'sinatra/base'
+require 'sinatra/mm_geoip'
+

metadata

@@ -2,7 +2,7 @@
 name: mm_geoip
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - Niko Dittmann
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-06 00:00:00 Z
+date: 2011-06-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: geoip
@@ -23,10 +23,65 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
 description: A proxy object around the geoip gem for lazy lookup. Includes a Rack middleware.
 email: mail+git@niko-dittmann.com
-executables: []
-
+executables: 
+- mm_geoip
 extensions: []
 
 extra_rdoc_files: []
@@ -35,13 +90,19 @@ files:
 - lib/mm_geoip/region.rb
 - lib/mm_geoip/version.rb
 - lib/mm_geoip.rb
-- lib/rack_mm_geoip.rb
+- lib/rack/mm_geoip.rb
+- lib/sinatra/mm_geoip.rb
 - data/fips_and_3166_2.txt
-- data/GeoLiteCity.dat
+- bin/mm_geoip
+- spec/mm_geoip_region_spec.rb
+- spec/mm_geoip_spec.rb
+- spec/rack/mm_geoip_spec.rb
+- spec/sinatra/mm_geoip_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/niko/mm_geoip
 licenses: []
 
-post_install_message: 
+post_install_message: "Try your new mm_geoip installation: type mm_geoip 134.34.3.2 [RETURN] in the command line."
 rdoc_options: []
 
 require_paths: 
@@ -65,5 +126,9 @@ 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: []
-
+test_files: 
+- spec/mm_geoip_region_spec.rb
+- spec/mm_geoip_spec.rb
+- spec/rack/mm_geoip_spec.rb
+- spec/sinatra/mm_geoip_spec.rb
+- spec/spec_helper.rb