geo_ip 0.3.1 → 0.3.2

data/lib/geo_ip.rb

@@ -4,62 +4,70 @@ 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 'json'
-require 'uri'
-require 'net/http'
+require 'rest-client'
 
 class GeoIp
-
   @@api_key = nil
+  @@timeout = 1
 
-  def self.api_key
-    @@api_key
-  end
+  class << self
+    def api_key
+      @@api_key
+    end
 
-  def self.api_key=(api_key)
-    @@api_key = api_key
-  end
+    def api_key= api_key
+      @@api_key = api_key
+    end
 
-  # Retreive the remote location of a given ip address.
-  #
-  # It takes two optional arguments:
-  # * +preceision+: can either be +:city+ (default) or +:country+
-  # * +timezone+: can either be +false+ (default) or +true+
-  #
-  # ==== Example:
-  #   GeoIp.geolocation('209.85.227.104', {:precision => :city, :timezone => true})
-  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}?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
-  end
+    def timeout
+      @@timeout
+    end
+
+    def timeout= timeout
+      @@timeout = timeout
+    end
+
+    # Retreive the remote location of a given ip address.
+    #
+    # It takes two optional arguments:
+    # * +preceision+: can either be +:city+ (default) or +:country+
+    # * +timezone+: can either be +false+ (default) or +true+
+    #
+    # ==== Example:
+    #   GeoIp.geolocation('209.85.227.104', {:precision => :city, :timezone => true})
+    def 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)
+      url = "#{SERVICE_URL}#{@country ? COUNTRY_API : CITY_API}?key=#{self.api_key}&ip=#{ip}&output=json&timezone=#{@timezone}"
+      reply = JSON.parse RestClient::Request.execute(:method => :get, :url => url, :timeout => self.timeout)
+      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"]
-    if @precision == :city
-      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"]
-      if @timezone
-        location[:timezone_name]  = hash["TimezoneName"]
-        location[:utc_offset]     = hash["Gmtoffset"].to_i
-        location[:dst?]           = hash["Isdst"] ? true : false
+    private
+    def convert_keys hash
+      location = {}
+      location[:ip]                 = hash["Ip"]
+      location[:status]             = hash["Status"]
+      location[:country_code]       = hash["CountryCode"]
+      location[:country_name]       = hash["CountryName"]
+      if @precision == :city
+        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"]
+        if @timezone
+          location[:timezone_name]  = hash["TimezoneName"]
+          location[:utc_offset]     = hash["Gmtoffset"].to_i
+          location[:dst?]           = hash["Isdst"] ? true : false
+        end
       end
+      location
     end
-    location
   end
 end

data/spec/geo_ip_spec.rb

@@ -83,8 +83,8 @@ 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    == -28800
       geolocation[:dst?].should_not      be_nil # true if dst?, false if not dst?
+      geolocation[:utc_offset].should    == (geolocation[:dst?] ? -25200 : -28800)
     end
 
     it "should not return the timezone information when explicitly not requesting it" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: geo_ip
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Jeroen Jacobs
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-26 00:00:00 +01:00
+date: 2011-05-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,18 +26,33 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 7
         segments: 
         - 1
         - 4
-        - 6
-        version: 1.4.6
+        version: "1.4"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: rest-client
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -48,7 +63,7 @@ dependencies:
         - 5
         version: "2.5"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 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: gems@jeroenj.be
 executables: []
@@ -95,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Retreive the geolocation of an IP address based on the ipinfodb.com webservice