rack-geoipcity 0.0.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20d4c9f7f5da4c49e72e3109eb566a57fa37f53c
+  data.tar.gz: 9090d1130020227c502a0b9b7fb2abd6fadee717
+SHA512:
+  metadata.gz: 1fba05767d17158dc0f3a2f8d662f6f813737397b08d315f3e55558a726389f51aa35a81152e41f36cf266cff76811fa24be03442d8b53ca0d813ad54bb51b95
+  data.tar.gz: a4697c3cfa17d1a78ab7bbfbd776ff051c9e5092e21ccc9aff7775ec1f5f3d6d591669f7073a711712321690f24bb0740c6c74428c2899d0b23d56d9fb1cbed0

data/.gitignore

@@ -1,3 +1,51 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+.bundle
+db/*.sqlite3*
+log/*.log
+*.log
+/tmp/
+doc/
+docs/
+.yardoc/
+*.swp
+*~
+.project
 .DS_Store
+.rvm
+.DS_Store
+*.log
+*.swp
+*.db
+*.old
+photos/
+attachments/
+.sass-cache/
+run/
+spec/fixtures/images/
+spec/html/
 .rvmrc
-*.tmproj
+.bundle
+db/*.sqlite3*
+log/*.log
+*.log
+/tmp/
+doc/
+*.swp
+*~
+.project
+.rspec
+vendor/ruby/
+vendor.noindex
+bin/
+db/backups/
+*.rdb
+config/redis.conf
+Gemfile.lock
+*.gem
+examples/assets/GeoLiteCity.dat
+spec/support/assets/GeoLiteCity.dat
+coverage/

data/CHANGES.md

@@ -0,0 +1,11 @@
+# CH CH CH CHANGES! #
+
+## v1.0.0 ##
+
+* Updated RSpec and specs ever so slightly because of it.
+* Updated for semver, it's been same API for aaaages.
+* Little bit of love for the formatting.
+
+## v0.0.1 ##
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,16 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "haml"
+  gem "simplecov"
+  gem "yard"
+  gem "rake"
+  gem "redcarpet"
+  gem "rspec"
+  gem "rspec-its"
+  gem "rack-test"
+  gem "rack-fake_ip", :git => "git://github.com/yb66/rack-fake_ip.git", :branch => "master"
+end

data/README.md

@@ -0,0 +1,56 @@
+## Rack GeoIPCity ##
+
+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.
+
+## Running the specs and examples ##
+
+You'll need a copy of the database, so download it and place it in:
+
+* examples/assets for the examples
+* spec/support/assets for the specs
+
+## License ##
+
+MIT License -   
+Originally by Karol Hosiawa ( http://twitter.com/hosiawak )  
+Converted to a gem by Thomas Maurer  
+This one by Iain Barnett  

data/Rakefile

@@ -0,0 +1,6 @@
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', 'app/*.rb', 'models/*.rb', 'spec/**/*.rb']
+  t.options = ['-odocs/'] # optional
+end

data/examples/config.ru

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+
+require 'rubygems'
+require 'bundler'
+Bundler.require
+
+
+require 'rack/geoipcity'
+require 'haml'
+
+root = File.expand_path File.dirname(__FILE__)
+
+# everything was moved into a separate module/file to make it easier to set up tests
+
+class FakeIps
+  def ip
+    @ips.sample
+  end
+  
+  def initialize
+    @ips = ["87.237.57.28","89.145.84.82","119.63.193.39","122.152.129.9","193.26.222.136","202.165.96.142","209.198.242.61","212.209.54.40","216.239.41.97"]
+  end
+end
+
+use Rack::GeoIPCity, :db => File.join(root, "assets/GeoLiteCity.dat"), :ips => FakeIps.new#, :path => %r{^/geo}#, :prefix => "/ge"
+
+
+layout = ->(){ 
+  File.read File.join(root, "views/layout.haml" )
+}
+
+app = lambda do |env|
+  request = Rack::Request.new(env)
+  stuff_here = env.select{|x| x =~ /^GEOIP/ }.inspect
+  output = Haml::Engine.new(layout.call).render( Object.new,
+    :stuff_here =>  stuff_here
+  )
+  Rack::Response.new( output ).finish
+end
+
+run app

data/examples/views/layout.haml

@@ -0,0 +1,15 @@
+- stuff_here ||= "Nothing doing"
+!!!
+%head
+  %title
+    Rack GeoIPCity Example
+%body
+  %h1
+    Rack GeoIPCity Example
+  
+  %p= Time.now
+    
+  %h2
+    Geo Info
+  %p  
+    = stuff_here

data/lib/rack/geoipcity.rb

@@ -2,68 +2,51 @@ require 'geoip'
 
 module Rack
   
-  # See the README for more docs
+  # See the README for more docs.
+  # @example
+  #   use Rack::GeoIPCity, :db => "/PATH/TO/GeoLiteCity.dat")
   class GeoIPCity
+
+    # Setting the db. Let the app do this, hands away!
+    # @param [GeoIP] :db
+    def self.db=( db )
+      @db = db
+    end
+
+
+    # Use this from another app, say a Sinatra or Rack app, when you want to use the GeoIP database for something other than the referrer's IP.
+    # @return [GeoIP]
+    def self.db
+      @db
+    end
+
+    # @param [Hash] options
+    # @option options [String] :db Path to the GeoIP database
+    # @option options [#ip] :ips ('Rack::Request.new(env)') An object that responds to `ip` and gives an IP address. You'll probably want to use this when you're developing/testing locally and want to pass in fake addresses to get the GeoIP to fire something other than blanks.
+    # @option options [Regexp] :path
+    # @option options [String] :prefix
     def initialize(app, options = {})
       options[:db] ||= 'GeoIP.dat'
-      @db = GeoIP.new(options[:db])
-      @app = app
+      @ips           = options[:ips]
+      @path          = ->(env){ env['PATH_INFO'].start_with? options[:prefix] } unless options[:prefix].nil?
+      @path          = ->(env){ env['PATH_INFO'] =~ options[:path] } unless options[:path].nil?
+      @path         ||= ->(_){ true }
+      self.class.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 
-      
+      if @path.call(env)
+        ips = @ips || Rack::Request.new(env)
+        res = self.class.db.city ips.ip
+        unless res.nil? # won't bork on local or bad ip's
+          h = Hash[ [:country_code2, :country_code3, :country_name, :continent_code, :region_name, :city_name, :postal_code, :latitude, :longitude, :dma_code, :area_code, :timezone, :ip,].map{|x| [ "GEOIP_#{x.upcase}", res.__send__(x) ] } ].delete_if{|k,v| v.nil? }
+          
+          env.merge! h
+        end 
+      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
+  end # GeoIPCity
+end # Rack

data/lib/rack/geoipcity/version.rb

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

data/rack-geoipcity.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
   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 'rack'
   s.add_dependency 'geoip'
 
   s.files         = `git ls-files`.split("\n")

data/spec/geoipcity_spec.rb

@@ -0,0 +1,41 @@
+
+require 'spec_helper'
+
+
+describe "A normal route" do
+  # set a known static ip to help with testing
+  # i.e. Wikipedia
+  include_context "All routes", :ip => "208.80.152.201"
+  before do
+    get "/"
+  end
+  it_should_behave_like "Any route"
+  subject { Marshal.load last_response.body }
+  it { should respond_to :keys }
+  its(:keys) { should include "country_code2", "country_code3", "country_name", "continent_code", "region_name", "city_name", "postal_code", "latitude", "longitude", "timezone", "ip" }
+  its(:values) { should include "US", "USA", "United States", "NA", "CA", "San Francisco", "94105", 37.789800000000014, -122.3942, 807, 415, "America/Los_Angeles", "208.80.152.201" }
+end
+
+describe "Using the database from inside another app." do
+  include_context "All routes"
+  subject { Rack::GeoIPCity.db }
+  it { should_not be_nil }
+  it { should respond_to :city }
+
+  context "Given an IP" do
+    subject { Rack::GeoIPCity.db.city "208.80.152.201" }
+    it { should respond_to :members }
+    its(:members) { should include :country_code2, :country_code3, :country_name, :continent_code, :region_name, :city_name, :postal_code, :latitude, :longitude, :timezone, :ip }
+    its(:values) { should include "US", "USA", "United States", "NA", "CA", "San Francisco", "94105", 37.789800000000014, -122.3942, 807, 415, "America/Los_Angeles", "208.80.152.201" }
+  end
+
+  context "Called from inside a route" do
+    before do
+      get "/ip/208.80.152.201"
+    end
+    subject { Marshal.load last_response.body }
+    it { should respond_to :keys }
+    its(:keys) { should include :country_code2, :country_code3, :country_name, :continent_code, :region_name, :city_name, :postal_code, :latitude, :longitude, :timezone, :ip }
+    its(:values) { should include "US", "USA", "United States", "NA", "CA", "San Francisco", "94105", 37.789800000000014, -122.3942, 807, 415, "America/Los_Angeles", "208.80.152.201" }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+
+require 'rspec'
+require 'rspec/its'
+Spec_dir = File.expand_path( File.dirname __FILE__ )
+
+unless Kernel.respond_to?(:require_relative)
+  module Kernel
+    def require_relative(path)
+      require File.join(File.dirname(caller[0]), path.to_str)
+    end
+  end
+end
+
+# code coverage
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/bin/"
+  add_filter "/vendor/"
+  add_filter "/vendor.noindex/"
+end
+
+require "rack/test"
+ENV['RACK_ENV'] ||= 'test'
+ENV["EXPECT_WITH"] ||= "racktest"
+
+
+require "logger"
+logger = Logger.new STDOUT
+logger.level = Logger::DEBUG
+logger.datetime_format = '%a %d-%m-%Y %H%M '
+LOgger = logger
+
+
+
+Dir[ File.join( Spec_dir, "/support/**/*.rb")].each do |f| 
+  logger.info "requiring #{f}"
+  require f
+end
+
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true  
+end
+

data/spec/support/shared/app.rb

@@ -0,0 +1,58 @@
+require 'rack/fake_ip'
+require_relative "../../../lib/rack/geoipcity.rb"
+
+
+module App
+
+  def self.app( options={} )
+    Rack::Builder.app do
+      ip_opts = {}
+      ip_opts.merge!( {ip: options[:ip] } ) if options[:ip]
+      use Rack::FakeIP, ip_opts
+      use Rack::GeoIPCity, :db => File.expand_path( File.join(File.dirname(__FILE__), "../assets/GeoLiteCity.dat"))
+
+      geo_info = ->(env) {
+        h = {}
+        env.select{|x| x =~ /^GEOIP/ }.each {|k,v|
+          h[k.split("GEOIP_").last.downcase] = v
+        }
+        h
+      }
+
+      routes = lambda { |e|
+        request = Rack::Request.new(e)
+        response = if request.path == "/"
+          Rack::Response.new(
+            [Marshal.dump(geo_info.(e))],
+            200,
+            {"Content-Type" => "text/html"}
+          ).finish
+        elsif request.path.start_with? "/ip/"
+          ip_in_route = request.path.split("/ip/").last
+          ip = Rack::GeoIPCity.db.city ip_in_route
+          Rack::Response.new(
+            [Marshal.dump(Hash[ip.each_pair.to_a])],
+            200,
+            {"Content-Type" => "text/html"}
+          ).finish
+        end
+        response
+      }
+      run routes
+    end
+  end    
+end
+
+
+shared_context "All routes" do |options={}|
+  include Rack::Test::Methods
+  warn "options = #{options.inspect}"
+  let(:app){ App.app( options ) }
+end
+
+shared_examples_for "Any route" do
+  subject {
+    last_response
+  }
+  it { should be_ok }
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-geoipcity
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Karol Hosiawa
@@ -11,19 +10,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-24 00:00:00.000000000Z
+date: 2016-04-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: geoip
-  requirement: &2152901760 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152901760
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rack::GeoIPCity uses the geoip gem and the GeoIP database to lookup the
   city of a request by its IP address
 email:
@@ -33,33 +49,43 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- README
+- CHANGES.md
+- Gemfile
+- README.md
+- Rakefile
+- examples/config.ru
+- examples/views/layout.haml
 - lib/rack/geoipcity.rb
 - lib/rack/geoipcity/version.rb
 - rack-geoipcity.gemspec
+- spec/geoipcity_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared/app.rb
 homepage: https://github.com/yb66/Rack-GeoIPCity
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rack middleware for Geo IP city lookup
-test_files: []
+test_files:
+- spec/geoipcity_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared/app.rb

data/README

@@ -1,47 +0,0 @@
-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