RubyGems - geoip_server - Versions diffs - 1.0.0 - Mend

geoip_server 1.0.0

Files changed (8) hide show

data/.gems ADDED

	@@ -0,0 +1,2 @@
1	+ sinatra
2	+ geoip

data/README.markdown ADDED

@@ -0,0 +1,31 @@
+# GeoIP Server
+This simple Rack server is useful as a self-hosted service for making lookups to the GeoIP database from MaxMind.com
+## Instant installation and deploy
+* Clone this: `git clone git://github.com/JackDanger/geoip_server.git`
+* Download the free GeoIP data files: `rake geoip:update_city_lite`
+* Commit that data file to your clone: `git add vendor && git commit -m "adding data file"`
+* Signup for an account at Heroku ([better details here](http://github.com/sinatra/heroku-sinatra-app))
+* Create and name a new app where you want to host this
+* push it to Heroku.com: `git push heroku master`
+## HowTo
+Once the server is running you can make a GET request to the server and receive lookup results in JSON format.
+    ip = request.remote_ip
+    require 'open-uri'
+    data = JSON.decode(open("http://my-geoip-service-app.heroku.com/#{ip}").read)
+    render :text => "You're in: #{data[:city]}"
+Or, straight from a terminal:
+    curl -X POST http://my-geoip-service-app.heroku.com/207.97.227.239
+Patches welcome, forks celebrated.
+Copyright (c) 2010 [Jack Danger Canty](http://jåck.com). Released under the MIT License.

data/Rakefile ADDED

@@ -0,0 +1,46 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "geoip_server"
+    gem.summary = %Q{Query the MaxMind GeoIP data records via a web service}
+    gem.description = %Q{Query the MaxMind GeoIP data records via a web service}
+    gem.email = "gitcommit@6brand.com"
+    gem.homepage = "http://github.com/JackDanger/geoip_server"
+    gem.authors = ["Jack Danger Canty"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    # 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
+task :default => :test
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << '.'
+  test.pattern = 'test.rb'
+  test.verbose = true
+end
+namespace :geoip do
+  desc "Update GeoIP City data file"
+  task :update_city_lite => :vendor do
+    %x{wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz && gzip -d GeoLiteCity.dat.gz && mv GeoLiteCity.dat ./vendor}
+  end
+  desc "Update GeoIP Country data file"
+  task :update_country_lite => :vendor do
+    %x{wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz && gzip -d GeoIP.dat.gz && mv GeoIP.dat ./vendor}
+  end
+  task :vendor do
+    %x{mkdir -p vendor}
+  end
+end

data/VERSION ADDED

	@@ -0,0 +1 @@
1	+ 1.0.0

data/config.ru ADDED

@@ -0,0 +1,6 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'lib/geoip_server'))
+## There is no need to set directories here anymore;
+## Just run the application
+run Sinatra::Application

data/lib/geoip_server.rb ADDED

@@ -0,0 +1,73 @@
+## Resources
+gem 'sinatra', :version => '1.0'
+require 'sinatra'
+require 'geoip'
+require 'json'
+data_file = File.expand_path(File.join(File.dirname(__FILE__), '..', 'vendor', 'GeoLiteCity.dat'))
+## Application
+get '/' do
+  %Q{
+    <html><title>Detect a computer's location by IP address</title>
+    <body style='line-height: 1.8em; font-family: Archer, Museo, Helvetica, Georgia; font-size 25px; text-align: center; padding-top: 20%;'>
+      Lookup a location by IP address. Example:
+      <pre style='font-family: Iconsolata, monospace;background-color:#EEE'>curl http://#{request.host}/207.97.227.239</pre>
+      <br />
+      <form action=/ method=GET onsubmit='if(\"\"==this.ip.value)return false;else{this.action=\"/\"+this.ip.value}'>
+        <input type=text name='ip' value='#{request.env['HTTP_X_REAL_IP']}' />
+        <input type=submit value='Lookup!' />
+      </form>
+      <div>None of this would be possible without <a href='http://www.maxmind.com/app/geolitecity'>MaxMind</a></div>
+    </body></html>
+}
+end
+get '/:ip' do
+  pass unless params[:ip] =~ /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/
+  data = GeoIP.new(data_file).city(params[:ip])
+  content_type 'application/json'
+  headers['Cache-Control'] = "public; max-age=#{365*24*60*60}"
+  return "{}" unless data
+  encode(data).to_json
+end
+def encode data
+  {
+    # * The host or IP address string as requested
+    :ip => data.shift,
+    # * The IP address string after looking up the host
+    :ip_lookup => data.shift,
+    # * The GeoIP country-ID as an integer
+    # :country_id => data.shift,
+    # * The ISO3166-1 two-character country code
+    :country_code => data.shift,
+    # * The ISO3166-2 three-character country code
+    :country_code_long => data.shift,
+    # * The ISO3166 English-language name of the country
+    :country => data.shift,
+    # * The two-character continent code
+    :continent => data.shift,
+    # * The region name
+    :region => data.shift,
+    # * The city name
+    :city => data.shift,
+    # * The postal code
+    :postal_code => data.shift,
+    # * The latitude
+    :lat => data.shift,
+    # * The longitude
+    :lng => data.shift,
+    # * The USA dma_code and area_code, if available (REV1 City database)
+    :dma_code => data.shift,
+    :area_code => data.shift,
+    # Timezone, if available
+    :timezone => data.shift
+  }
+end

data/test.rb ADDED

@@ -0,0 +1,73 @@
+ENV['RACK_ENV'] = 'test'
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'rack/test'
+require File.expand_path(File.join(File.dirname(__FILE__), 'lib/geoip_server'))
+class GeoipServerTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+  def app
+    Sinatra::Application
+  end
+  context "on GET to /" do
+    setup {
+      get '/'
+    }
+    should "return ok" do
+      assert last_response.ok?
+    end
+    should "have some kind of welcome" do
+      assert last_response.body =~ /curl/
+    end
+  end
+  context "on GET to /:ip" do
+    setup {
+      get '/67.161.92.71'
+    }
+    should "return ok" do
+      assert last_response.ok?
+    end
+    should "return json content-type" do
+      assert_equal 'application/json', last_response.headers['Content-Type']
+    end
+  end
+  context "converting array" do
+    setup {
+      array = [
+        "67.161.92.71",
+        "67.161.92.71",
+        "US",
+        "USA",
+        "United States",
+        "NA",
+        "WA",
+        "Seattle",
+        "98117",
+        47.6847,
+        -122.3848,
+        819,
+        206,
+        "America/Los_Angeles"
+      ]
+      @hash = encode(array)
+    }
+    should "find city" do
+      assert_equal 'Seattle', @hash[:city]
+    end
+    should "find country" do
+      assert_equal 'United States', @hash[:country]
+    end
+    should "find lat" do
+      assert_equal 47.6847, @hash[:lat]
+    end
+    should "find lng" do
+      assert_equal -122.3848, @hash[:lng]
+    end
+  end
+end

metadata ADDED

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: geoip_server
+version: !ruby/object:Gem::Version
+  hash: 23
+  prerelease: false
+  segments:
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors:
+- Jack Danger Canty
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-11-27 00:00:00 -08:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Query the MaxMind GeoIP data records via a web service
+email: gitcommit@6brand.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.markdown
+files:
+- .gems
+- README.markdown
+- Rakefile
+- VERSION
+- config.ru
+- lib/geoip_server.rb
+- test.rb
+has_rdoc: true
+homepage: http://github.com/JackDanger/geoip_server
+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: Query the MaxMind GeoIP data records via a web service
+test_files: []