geo_ip 0.1.0

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeroen Jacobs
+
+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.rdoc

@@ -0,0 +1,57 @@
+= GeoIp
+
+Retreive the geolocation of an IP address based on the {ipinfodb.com}[http://ipinfodb.com/] webservice.
+
+Consider making a donation to {ipinfodb.com}[http://ipinfodb.com/] at {http://ipinfodb.com/donate.php}[http://ipinfodb.com/donate.php]
+
+== Usage
+
+=== Retreive geolocation
+  GeoIp.remote_geolocation(ip_address)
+
+=== Example
+
+  # 209.85.227.104 = google.be (US)
+  GeoIp.remote_geolocation('209.85.227.104')
+
+returns:
+
+  {
+    :status=>"OK",
+    :ip=>"209.85.227.104"
+    :country_code=>"US",
+    :country_name=>"United States",
+    :region_code=>"06",
+    :region_name=>"California",
+    :city=>"Mountain View",
+    :zip_postal_code=>"94043",
+    :latitude=>"37.4192",
+    :longitude=>"-122.057",
+    :timezone=>"-8",
+    :gmt_offset=>"-8",
+    :dst_offset=>"-7",
+  }
+
+== Getting it
+
+GeoIp can be installed as a Ruby Gem:
+
+  gem install geo_ip
+
+Alternatively, you can also install it as a Rails plugin:
+
+  ./script/plugin install git://github.com/jeroenj/geo_ip.git
+
+== 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.
+
+== Copyright
+
+Copyright (c) 2010 Jeroen Jacobs, {redstorm sprl}[http://www.redstorm.be]. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "geo_ip"
+    gem.summary = "Retreive the geolocation of an IP address based on the ipinfodb.com webservice"
+    gem.description = "A call to the ipinfodb.com will be done to retreive the geolocation based on the IP address. No need to include a database file in the application."
+    gem.email = "jj@redstorm.com"
+    gem.homepage = "http://github.com/jeroenj/geo_ip"
+    gem.authors = ["Jeroen Jacobs"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # 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 = "geo_ip #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+require 'geo_ip'

data/lib/geo_ip.rb

@@ -0,0 +1,37 @@
+SERVICE_URL = "http://ipinfodb.com/ip_query.php"
+IPV4_REGEXP = /\A(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)(?:\.(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)){3}\z/
+
+require 'rubygems'
+require 'json'
+require 'uri'
+require 'net/http'
+
+class GeoIp
+  def self.remote_geolocation(ip)
+    raise "Invalid IP address" unless ip.to_s =~ IPV4_REGEXP
+    
+    uri = SERVICE_URL + "?ip=#{ip}&output=json"
+    url = URI.parse(uri)
+    reply = JSON.parse(Net::HTTP.get(url))
+    location = convert_keys reply
+  end
+
+  private
+  def self.convert_keys(hash)
+    location = {}
+    location[:ip]               = hash["Ip"]
+    location[:status]           = hash["Status"]
+    location[:country_code]     = hash["CountryCode"]
+    location[:country_name]     = hash["CountryName"]
+    location[:region_code]      = hash["RegionCode"]
+    location[:region_name]      = hash["RegionName"]
+    location[:city]             = hash["City"]
+    location[:zip_postal_code]  = hash["ZipPostalCode"]
+    location[:latitude]         = hash["Latitude"]
+    location[:longitude]        = hash["Longitude"]
+    location[:timezone]         = hash["Timezone"]
+    location[:gmt_offset]       = hash["Gmtoffset"]
+    location[:dst_offset]       = hash["Dstoffset"]
+    location
+  end
+end

data/spec/geo_ip_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "GeoIp" do
+  it "should return the correct country for a public ip address" do
+    # 209.85.227.104 = google.be (US)
+    GeoIp.remote_geolocation('209.85.227.104')[:country_code].should == 'US'
+    GeoIp.remote_geolocation('209.85.227.104')[:country_name].should == 'United States'
+  end
+
+  it "should return the correct country for a private ip address" do
+    GeoIp.remote_geolocation('10.0.0.1')[:country_code].should == 'RD'
+    GeoIp.remote_geolocation('10.0.0.1')[:country_name].should == 'Reserved'
+  end
+
+  it "should return the correct country for localhost ip address" do
+    GeoIp.remote_geolocation('127.0.0.1')[:country_code].should == 'RD'
+    GeoIp.remote_geolocation('127.0.0.1')[:country_name].should == 'Reserved'
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'geo_ip'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: geo_ip
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeroen Jacobs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-09 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: A call to the ipinfodb.com will be done to retreive the geolocation based on the IP address. No need to include a database file in the application.
+email: jj@redstorm.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/geo_ip.rb
+- spec/geo_ip_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jeroenj/geo_ip
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Retreive the geolocation of an IP address based on the ipinfodb.com webservice
+test_files: 
+- spec/geo_ip_spec.rb
+- spec/spec_helper.rb