Class: MaxMind::GeoIP2::Record::Location

Inherits:
Abstract
  • Object
show all
Defined in:
lib/maxmind/geoip2/record/location.rb

Overview

Contains data for the location record associated with an IP address.

This record is returned by all location services and databases besides Country.

Instance Method Summary collapse

Instance Method Details

#accuracy_radius ⇒ Integer?

The approximate accuracy radius in kilometers around the latitude and longitude for the IP address. This is the radius where we have a 67% confidence that the device using the IP address resides within the circle centered at the latitude and longitude with the provided radius.

Returns:

  • (Integer, nil) 


19
20
21
 
# File 'lib/maxmind/geoip2/record/location.rb', line 19

def accuracy_radius
  get('accuracy_radius')
end

#average_income ⇒ Integer?

The average income in US dollars associated with the requested IP address. This attribute is only available from the Insights service.

Returns:

  • (Integer, nil) 


27
28
29
 
# File 'lib/maxmind/geoip2/record/location.rb', line 27

def average_income
  get('average_income')
end

#latitude ⇒ Float?

The approximate latitude of the location associated with the IP address. This value is not precise and should not be used to identify a particular address or household.

Returns:

  • (Float, nil) 


36
37
38
 
# File 'lib/maxmind/geoip2/record/location.rb', line 36

def latitude
  get('latitude')
end

#longitude ⇒ Float?

The approximate longitude of the location associated with the IP address. This value is not precise and should not be used to identify a particular address or household.

Returns:

  • (Float, nil) 


45
46
47
 
# File 'lib/maxmind/geoip2/record/location.rb', line 45

def longitude
  get('longitude')
end

#metro_code ⇒ Integer?

The metro code of the location if the location is in the US. MaxMind returns the same metro codes as the Google AdWords API. See developers.google.com/adwords/api/docs/appendix/cities-DMAregions.

Returns:

  • (Integer, nil) 


54
55
56
 
# File 'lib/maxmind/geoip2/record/location.rb', line 54

def metro_code
  get('metro_code')
end

#population_density ⇒ Integer?

The estimated population per square kilometer associated with the IP address. This attribute is only available from the Insights service.

Returns:

  • (Integer, nil) 


62
63
64
 
# File 'lib/maxmind/geoip2/record/location.rb', line 62

def population_density
  get('population_density')
end

#time_zone ⇒ String?

The time zone associated with location, as specified by the IANA Time Zone Database, e.g., “America/New_York”. See www.iana.org/time-zones.

Returns:

  • (String, nil) 


71
72
73
 
# File 'lib/maxmind/geoip2/record/location.rb', line 71

def time_zone
  get('time_zone')
end