geo-ip-json 0.0.1

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@geo-ip-json --create

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+group :development do
+  gem 'minitest'
+  gem 'rack-test'
+  gem 'guard'
+  gem 'guard-minitest'
+end
+
+gem 'geoip'

data/Gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ffi (1.0.11)
+    geoip (1.1.2)
+    guard (1.0.3)
+      ffi (>= 0.5.0)
+      thor (>= 0.14.6)
+    guard-minitest (0.5.0)
+      guard (>= 0.4)
+    minitest (3.0.0)
+    rack (1.4.1)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    thor (0.15.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  geoip
+  guard
+  guard-minitest
+  minitest
+  rack-test

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib\/(.*)\/(.*).rb|)      { |m| "spec/#{m[2]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/README.md

@@ -0,0 +1,41 @@
+# GeoIPJSON - GeoIP information as JSON via a rack app
+
+A very simple rack app to provide Geo-location Information as JSON.
+
+By default it returns the country code of the current client.
+
+Alternatively, an `?ip=1.2.3.4` parameter can be supplied.
+
+We are using this as a datasource for an AJAX call.
+
+## Install
+
+### Rails
+
+In `Gemfile`
+
+    gem 'geo-ip-json'
+
+In `routes.rb`
+
+    <AppName>::Application.routes.draw do
+      match "/geoip.json", :to => GeoIPJson::App.new
+    end
+
+Download the GeoIP database file from MaxMind (http://www.maxmind.com/)
+
+* http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz
+
+Put it in the root of your Rails app (configurable location is coming)
+
+## Testing
+
+Run `rake test` to run the tests. A `Guardfile` is present to use with `Guard`.
+
+## Thanks!
+
+Steve England for the idea
+* https://github.com/stengland
+
+Ruby GeoIP library which does most of the work!
+* http://geoip.rubyforge.org/

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'spec/**/*_spec.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/geo_ip_json.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "geo_ip_json/version"
+
+Gem::Specification.new do |s|
+  s.name        = "geo-ip-json"
+  s.version     = GeoIPJson::VERSION
+  s.authors     = ["Jordan Elver"]
+  s.email       = ["jordan.elver@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Geo IP information via JSON rack app}
+  s.description = %q{Geo IP information via JSON rack app}
+
+  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"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "geoip"
+end

data/lib/geo-ip-json.rb

@@ -0,0 +1 @@
+require_relative 'geo_ip_json/app'

data/lib/geo_ip_json/app.rb

@@ -0,0 +1,42 @@
+require 'json'
+require 'geoip'
+
+module GeoIPJson
+  class App
+    attr_writer :geo_ip
+
+    def call(env)
+      request = Rack::Request.new(env)
+
+      geo_data = lookup(ip_or_hostname(request))
+      country = geo_data.fetch(:country_code2, '').downcase.gsub(/--/, '')
+
+      json = {
+        country: country
+      }.to_json
+
+      [200, {'Content-Type' => 'application/json'}, [json]]
+    end
+
+    def geo_ip
+      @geo_ip ||= GeoIP.new('GeoIP.dat')
+    end
+
+    private
+
+    def ip_or_hostname(request)
+      if request.params['ip'].nil?
+        ip = request.ip
+      else
+        ip = request.params['ip']
+      end
+    end
+
+    def lookup(ip_or_hostname)
+      geo_ip.country(ip_or_hostname).to_hash
+    rescue SocketError
+      {}
+    end
+  end
+end
+

data/lib/geo_ip_json/version.rb

@@ -0,0 +1,3 @@
+module GeoIPJson
+  VERSION = "0.0.1"
+end

data/spec/app_spec.rb

@@ -0,0 +1,73 @@
+require 'rubygems'
+gem 'minitest'
+
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'rack/test'
+require_relative '../lib/geo-ip-json'
+
+include Rack::Test::Methods
+
+def app
+  Rack::Lint.new(@app)
+end
+
+# Setup our rack app as we would with a config.ru file
+def mock_app(options = {})
+
+  # Create a mock to pass to the app
+  mock = MiniTest::Mock.new
+  mock.expect(:country, { country_code2: options[:country] }, options[:ip])
+
+  builder = Rack::Builder.new do
+    map '/geoip.json' do
+      app = GeoIPJson::App.new
+      app.geo_ip = mock
+      run app
+    end
+  end
+
+  @app = builder.to_app
+end
+
+describe "GeoIP" do
+
+  describe "valid IP address" do
+
+    it "must return the country code" do
+      mock_app(:country => 'us', :ip => ['1.2.3.4'])
+
+      get '/geoip.json?ip=1.2.3.4'
+
+      assert_equal 200, last_response.status
+
+      json = JSON.parse(last_response.body)
+      json['country'].must_equal 'us'
+    end
+
+    it "must use the request IP if the ip parameter is missing" do
+      mock_app(:country => 'gb', :ip => ['4.5.6.7'])
+
+      get '/geoip.json', nil, { 'REMOTE_ADDR' => '4.5.6.7' }
+
+      assert_equal 200, last_response.status
+
+      json = JSON.parse(last_response.body)
+      json['country'].must_equal 'gb'
+    end
+  end
+
+  describe "invalid IP address" do
+
+    it "must return return an empty string if the ip is bogus" do
+      mock_app(:country => '', :ip => ['not-an-ip-address'])
+
+      get '/geoip.json?ip=not-an-ip-address'
+
+      assert_equal 200, last_response.status
+
+      json = JSON.parse(last_response.body)
+      json['country'].must_equal ''
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: geo-ip-json
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jordan Elver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: geoip
+  requirement: &2157237940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157237940
+description: Geo IP information via JSON rack app
+email:
+- jordan.elver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- geo_ip_json.gemspec
+- lib/geo-ip-json.rb
+- lib/geo_ip_json/app.rb
+- lib/geo_ip_json/version.rb
+- spec/app_spec.rb
+homepage: ''
+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.8.10
+signing_key: 
+specification_version: 3
+summary: Geo IP information via JSON rack app
+test_files:
+- spec/app_spec.rb
+has_rdoc: