geo_ip 0.2.0 → 0.3.0

data/.gitignore

@@ -19,3 +19,4 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+spec/api.yml

data/CHANGES

@@ -1,8 +1,15 @@
+== 0.3.0
+
+* Added support for API key requirement (Thanks to seanconaty and luigi)
+* Explicit gem dependency for json and removed rubygems requirement (idris) (http://tomayko.com/writings/require-rubygems-antipattern)
+* Removed deprecated GeoIp#remote_geolocation method
+
 == 0.2.0
 
 * Added support for timezone information. Use the optional {:timezone => true|false} option
 * Added support for country lookup. This will result in a faster reply since less queries need
   to be done at ipinfodb's side. Use the optional {:precision => :city|:country} option
+* API change: GeoIp.remote_geolocation(ip) is deprecated in favor of GeoIp.geolocation(ip)
 
 == 0.1.1
 

data/README.rdoc

@@ -2,36 +2,81 @@
 
 Retreive the geolocation of an IP address based on the {ipinfodb.com}[http://ipinfodb.com/] webservice.
 
+As of 8th November 2010, the service is asking that all users {register}[http://ipinfodb.com/register.php] for an API key.
+
 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)
+=== Set API key
+  GeoIp.api_key = "YOUR_API_KEY"
+
+This must be done before making the geolocation call.
+
+=== Retrieve geolocation
+  GeoIp.geolocation(ip_address)
 
 === Example
 
   # 209.85.227.104 = google.be (US)
-  GeoIp.remote_geolocation('209.85.227.104')
+  GeoIp.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"
+  }
+
+=== Country only
+
+There is an option to only retreive the country information and thus excluding the city details. This results in a faster response from the service since less queries need to be done.
+
+  GeoIp.geolocation('209.85.227.104', {:precision => :country})
+
+returns:
+
+  {
+    :status           => "OK",
+    :ip               => "209.85.227.104"
+    :country_code     => "US",
+    :country_name     => "United States"
+  }
+
+=== Timezone information
+
+There is an option now to retrieve optional timezone information too:
+
+  GeoIp.geolocation('209.85.227.104', {:timezone => true})
 
 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",
+    :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_name    =>"America/Los_Angeles",
+    :utc_offset       =>-25200,
+    :dst?             =>true
   }
 
+Obviously it is not possible to have the country precision enabled while retrieving the timezone information.
+
 == Getting it
 
 GeoIp can be installed as a Ruby Gem:
@@ -42,8 +87,24 @@ Alternatively, you can also install it as a Rails plugin:
 
   ./script/plugin install git://github.com/jeroenj/geo_ip.git
 
+== Testing
+
+Set up your API key first for the test suite by creating a spec/api.yml file. Follow the example in spec/api.yml.example. Then run the tests with:
+
+  ruby spec/geo_ip_spec.rb
+
+If you get a LoadError, you should run the tests with:
+
+  ruby -rubygems spec/geo_ip_spec.rb
+
+== Colaborators
+
+* {seanconaty}[https://github.com/seanconaty]
+* {luigi}[https://github.com/luigi]
+* {idris}[https://github.com/idris]
+
 == 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

data/Rakefile

@@ -7,10 +7,11 @@ begin
     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.email = "jacobsjeroen@gmail.com"
     gem.homepage = "http://github.com/jeroenj/geo_ip"
     gem.authors = ["Jeroen Jacobs"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "json", "~> 1.4.6"
+    gem.add_development_dependency "rspec", "~> 1.3.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/geo_ip.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{geo_ip}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeroen Jacobs"]
-  s.date = %q{2010-03-25}
+  s.date = %q{2010-11-16}
   s.description = %q{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.}
-  s.email = %q{jj@redstorm.com}
+  s.email = %q{jacobsjeroen@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
      "geo_ip.gemspec",
      "init.rb",
      "lib/geo_ip.rb",
+     "spec/api.yml.example",
      "spec/geo_ip_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
@@ -34,7 +35,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/jeroenj/geo_ip}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Retreive the geolocation of an IP address based on the ipinfodb.com webservice}
   s.test_files = [
     "spec/geo_ip_spec.rb",
@@ -45,13 +46,16 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, ["~> 1.4.6"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
     else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<json>, ["~> 1.4.6"])
+      s.add_dependency(%q<rspec>, ["~> 1.3.0"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<json>, ["~> 1.4.6"])
+    s.add_dependency(%q<rspec>, ["~> 1.3.0"])
   end
 end
 

data/lib/geo_ip.rb

@@ -1,18 +1,22 @@
-SERVICE_URL = "http://ipinfodb.com/"
+SERVICE_URL = "http://api.ipinfodb.com/v2/"
 CITY_API    = "ip_query.php"
 COUNTRY_API = "ip_query_country.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
-  # <b>DEPRECATED:</b> Please use <tt>geolocation</tt> instead.
-  def self.remote_geolocation(ip, timezone=false)
-    warn "DEPRECATION WARNING: `remote_geolocation` is deprecated and will be removed from 0.3. Use `geolocation` instead."
-    geolocation(ip, {:timezone => timezone})
+
+  @@api_key = nil
+
+  def self.api_key
+    @@api_key
+  end
+
+  def self.api_key=(api_key)
+    @@api_key = api_key
   end
 
   # Retreive the remote location of a given ip address.
@@ -26,10 +30,11 @@ class GeoIp
   def self.geolocation(ip, options={})
     @precision = options[:precision] || :city
     @timezone  = options[:timezone]  || false
+    raise "API key must be set first: GeoIp.api_key = 'YOURKEY'" if self.api_key.nil?
     raise "Invalid IP address" unless ip.to_s =~ IPV4_REGEXP
     raise "Invalid precision"  unless [:country, :city].include?(@precision)
     raise "Invalid timezone"   unless [true, false].include?(@timezone)
-    uri = "#{SERVICE_URL}#{@country ? COUNTRY_API : CITY_API}?ip=#{ip}&output=json&timezone=#{@timezone}"
+    uri = "#{SERVICE_URL}#{@country ? COUNTRY_API : CITY_API}?key=#{self.api_key}&ip=#{ip}&output=json&timezone=#{@timezone}"
     url = URI.parse(uri)
     reply = JSON.parse(Net::HTTP.get(url))
     location = convert_keys reply

data/spec/api.yml.example

@@ -0,0 +1 @@
+key: YOUR_KEY_HERE

data/spec/geo_ip_spec.rb

@@ -4,6 +4,24 @@ IP_PRIVATE = '10.0.0.1'
 IP_LOCAL = '127.0.0.1'
 
 describe "GeoIp" do
+
+  before(:all) do
+    api_config = YAML.load_file(File.dirname(__FILE__) + '/api.yml')
+    GeoIp.api_key = api_config['key']
+  end
+
+  context "api_key" do
+    it "should return the API key when set" do
+      GeoIp.api_key = "my_api_key"
+      GeoIp.api_key.should == "my_api_key"
+    end
+
+    it "should throw an error when API key is not set" do
+      GeoIp.api_key = nil
+      lambda {GeoIp.geolocation(IP_GOOGLE_US)}.should raise_error
+    end
+  end
+
   context "city" do
     it "should return the correct city for a public ip address" do
       geolocation = GeoIp.geolocation(IP_GOOGLE_US)
@@ -65,7 +83,7 @@ describe "GeoIp" do
     it "should return the correct timezone information for a public ip address" do
       geolocation = GeoIp.geolocation(IP_GOOGLE_US, {:timezone => true})
       geolocation[:timezone_name].should == 'America/Los_Angeles'
-      geolocation[:utc_offset].should    == -25200
+      geolocation[:utc_offset].should    == -28800
       geolocation[:dst?].should_not      be_nil # true if dst?, false if not dst?
     end
 
@@ -90,12 +108,4 @@ describe "GeoIp" do
       geolocation[:dst?].should          be_nil
     end
   end
-
-  context "deprecated" do
-    it "should return the correct country for a public ip address" do
-      geolocation = GeoIp.remote_geolocation(IP_GOOGLE_US)
-      geolocation[:country_code].should == 'US'
-      geolocation[:country_name].should == 'United States'
-    end
-  end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: geo_ip
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jeroen Jacobs
@@ -14,25 +15,43 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-25 00:00:00 +01:00
+date: 2010-11-16 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 1
-        - 2
-        - 9
-        version: 1.2.9
-  type: :development
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id002
 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
+email: jacobsjeroen@gmail.com
 executables: []
 
 extensions: []
@@ -51,6 +70,7 @@ files:
 - geo_ip.gemspec
 - init.rb
 - lib/geo_ip.rb
+- spec/api.yml.example
 - spec/geo_ip_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -64,23 +84,27 @@ rdoc_options:
 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.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Retreive the geolocation of an IP address based on the ipinfodb.com webservice