class GeoIp

Constants

CITY_API
COUNTRY_API
SERVICE_URL

Public Class Methods

api_key() click to toggle source

# File lib/geo_ip.rb, line 20
def api_key
  @@api_key
end

api_key=(api_key) click to toggle source

# File lib/geo_ip.rb, line 24
def api_key=(api_key)
  @@api_key = api_key
end

fallback_timeout() click to toggle source

# File lib/geo_ip.rb, line 36
def fallback_timeout
  @@fallback_timeout
end

fallback_timeout=(fallback_timeout) click to toggle source

# File lib/geo_ip.rb, line 40
def fallback_timeout=(fallback_timeout)
  @@fallback_timeout = fallback_timeout
end

geolocation(ip, options = {}) click to toggle source

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})

# File lib/geo_ip.rb, line 67
def geolocation(ip, options = {})
  location = nil
  Timeout.timeout(fallback_timeout) do
    parsed_response = JSON.parse Net::HTTP.get(URI(lookup_url(ip, options)))
    location = convert_keys(parsed_response, options)
  end

  location
end

lookup_url(ip, options = {}) click to toggle source

# File lib/geo_ip.rb, line 51
def lookup_url(ip, options = {})
  set_defaults_if_necessary options
  fail ApiKeyError.new('API key must be set first: GeoIp.api_key = \'YOURKEY\'') if api_key.nil?
  fail InvalidIpError.new(ip) unless ip.to_s =~ Resolv::IPv4::Regex || ip.to_s =~ Resolv::IPv6::Regex

  "#{SERVICE_URL}#{options[:precision] == :city || options[:timezone] ? CITY_API : COUNTRY_API}?key=#{api_key}&ip=#{ip}&format=json&timezone=#{options[:timezone]}"
end

set_defaults_if_necessary(options) click to toggle source

# File lib/geo_ip.rb, line 44
def set_defaults_if_necessary(options)
  options[:precision] ||= :city
  options[:timezone] ||= false
  fail InvalidPrecisionError unless [:country, :city].include?(options[:precision])
  fail InvalidTimezoneError unless [true, false].include?(options[:timezone])
end

timeout() click to toggle source

# File lib/geo_ip.rb, line 28
def timeout
  @@timeout
end

timeout=(timeout) click to toggle source

# File lib/geo_ip.rb, line 32
def timeout=(timeout)
  @@timeout = timeout
end

Private Class Methods

convert_keys(hash, options) click to toggle source

# File lib/geo_ip.rb, line 79
def convert_keys(hash, options)
  set_defaults_if_necessary options
  location = {}
  location[:ip]             = hash['ipAddress']
  location[:status_code]    = hash['statusCode']
  location[:status_message] = hash['statusMessage']
  location[:country_code]   = hash['countryCode']
  location[:country_name]   = hash['countryName']
  if options[:precision] == :city
    location[:region_name]  = hash['regionName']
    location[:city]         = hash['cityName']
    location[:zip_code]     = hash['zipCode']
    location[:latitude]     = hash['latitude']
    location[:longitude]    = hash['longitude']
    location[:timezone]     = hash['timeZone'] if options[:timezone]
  end
  location
end