geo_ip_curb 0.4.0 → 0.4.1

data/lib/geo_ip_curb.rb

@@ -7,7 +7,7 @@ class GeoIpCurb
   COUNTRY_API     = "ip-country"
   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/
   TIMEOUT         = 10
-  ERROR_PREFIX    = "api.ipinfodb.com service error"
+  ERROR_PREFIX    = "API service error"
 
   @@api_key = nil
 
@@ -22,25 +22,34 @@ class GeoIpCurb
   # 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+
+  # * +precision+: can either be +:city+ (default) or +:country+
+  # * +timeout+: number of seconds to wait before timing out
+  # * +service_url+: set the service URL, in case it changes, or you want to proxy it for additional caching, etc. Add 'APIKEYPLACEHOLDER' and 'IPPLACEHOLDER' in the right places and they will be replaced accordingly.
   #
   # ==== Example:
-  #   GeoIpCurb.geolocation('209.85.227.104', {:precision => :city, :timezone => true})
+  #   GeoIpCurb.geolocation('209.85.227.104', {:precision => :city, :timeout => 5})
   def self.geolocation(ip, options={})
-    @precision = options[:precision] || :country
-    @timeout   = options[:timeout]   || TIMEOUT
-    
+    @precision   = options[:precision]   || :country
+    @timeout     = options[:timeout]     || TIMEOUT
+    @service_url = options[:service_url] || nil
+
     raise "API key must be set first: GeoIpCurb.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)
-   
-    uri = "#{SERVICE_URL}/#{@precision==:country ? COUNTRY_API : CITY_API}/?key=#{self.api_key}&ip=#{ip}&format=json"
+
+    if @service_url then
+      @service_url = @service_url.sub("APIKEYPLACEHOLDER", self.api_key)
+      @service_url = @service_url.sub("IPPLACEHOLDER", ip)
+      uri = @service_url
+    else
+      uri = "#{SERVICE_URL}/#{@precision==:country ? COUNTRY_API : CITY_API}/?key=#{self.api_key}&ip=#{ip}&format=json"
+    end
+
     convert_keys send_request(uri)
   end
 
   private
-  
+
   def self.send_request(uri)
     http = Curl::Easy.new(uri)
     http.timeout = @timeout
@@ -48,10 +57,10 @@ class GeoIpCurb
     JSON.parse(http.body_str)
   rescue => e
     error = {}
-    error[:error_msg] = "#{ERROR_PREFIX}: \"#{e}\"."
+    error[:error_msg] = "#{ERROR_PREFIX}: #{e}."
     error
   end
-  
+
   def self.convert_keys(hash)
     location = {}
     location[:ip]                 = hash["ipAddress"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: geo_ip_curb
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Ryan Conway
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-25 00:00:00 +01:00
+date: 2011-06-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Retrieve the geolocation of an IP address using the the ipinfodb.com v3 API service using Curb.