Class: Geokit::GeoLoc
Overview
This class encapsulates the result of a geocoding call. It’s primary purpose is to homogenize the results of multiple geocoding providers. It also provides some additional functionality, such as the “full address” method for geocoders that do not provide a full address in their results (for example, Yahoo), and the “is_us” method.
Some geocoders can return multple results. Geoloc can capture multiple results through its “all” method.
For the geocoder setting the results, it would look something like this:
geo=GeoLoc.new(first_result)
geo.all.push(second_result)
geo.all.push(third_result)
Then, for the user of the result:
puts geo.full_address # just like usual
puts geo.all.size => 3 # there's three results total
puts geo.all.first # all is just an array or additional geolocs,
so do what you want with it
Constant Summary
Constants included from Mappable
Mappable::EARTH_RADIUS_IN_KMS, Mappable::EARTH_RADIUS_IN_MILES, Mappable::EARTH_RADIUS_IN_NMS, Mappable::KMS_PER_LATITUDE_DEGREE, Mappable::KMS_PER_MILE, Mappable::LATITUDE_DEGREES, Mappable::MILES_PER_LATITUDE_DEGREE, Mappable::NMS_PER_LATITUDE_DEGREE, Mappable::NMS_PER_MILE, Mappable::PI_DIV_RAD
Instance Attribute Summary collapse
-
#accuracy ⇒ Object
accuracy is set for Yahoo and Google geocoders, it is a numeric value of the precision.
-
#all ⇒ Object
Location attributes.
-
#city ⇒ Object
Location attributes.
-
#country_code ⇒ Object
Location attributes.
-
#full_address ⇒ Object
full_address is provided by google but not by yahoo.
-
#precision ⇒ Object
Attributes set upon return from geocoding.
-
#provider ⇒ Object
Attributes set upon return from geocoding.
-
#state ⇒ Object
Location attributes.
-
#street_address ⇒ Object
Location attributes.
-
#street_name ⇒ Object
readonly
Returns the street name portion of the street address.
-
#street_number ⇒ Object
readonly
Extracts the street number from the street address if the street address has a value.
-
#success ⇒ Object
Attributes set upon return from geocoding.
-
#zip ⇒ Object
Location attributes.
Attributes inherited from LatLng
Instance Method Summary collapse
-
#hash ⇒ Object
(also: #to_hash)
gives you all the important fields as key-value pairs.
-
#initialize(h = {}) ⇒ GeoLoc
constructor
Constructor expects a hash of symbols to correspond with attributes.
-
#is_us? ⇒ Boolean
Returns true if geocoded to the United States.
- #success? ⇒ Boolean
-
#to_geocodeable_s ⇒ Object
Returns a comma-delimited string consisting of the street address, city, state, zip, and country code.
-
#to_s ⇒ Object
Returns a string representation of the instance.
- #to_yaml_properties ⇒ Object
Methods inherited from LatLng
#==, #eql?, #ll, normalize, #to_a
Methods included from Mappable
#distance_to, #endpoint, #heading_from, #heading_to, included, #midpoint_to, #to_lat_lng
Constructor Details
#initialize(h = {}) ⇒ GeoLoc
Constructor expects a hash of symbols to correspond with attributes.
333 334 335 336 337 338 339 340 341 342 343 344 345 |
# File 'lib/geokit/mappable.rb', line 333 def initialize(h={}) @all = [self] @street_address=h[:street_address] @city=h[:city] @state=h[:state] @zip=h[:zip] @country_code=h[:country_code] @success=false @precision='unknown' @full_address=nil super(h[:lat],h[:lng]) end |
Instance Attribute Details
#accuracy ⇒ Object
accuracy is set for Yahoo and Google geocoders, it is a numeric value of the precision. see code.google.com/apis/maps/documentation/geocoding/#GeocodingAccuracy
330 331 332 |
# File 'lib/geokit/mappable.rb', line 330 def accuracy @accuracy end |
#all ⇒ Object
Location attributes. Full address is a concatenation of all values. For example: 100 Spear St, San Francisco, CA, 94101, US
321 322 323 |
# File 'lib/geokit/mappable.rb', line 321 def all @all end |
#city ⇒ Object
Location attributes. Full address is a concatenation of all values. For example: 100 Spear St, San Francisco, CA, 94101, US
321 322 323 |
# File 'lib/geokit/mappable.rb', line 321 def city @city end |
#country_code ⇒ Object
Location attributes. Full address is a concatenation of all values. For example: 100 Spear St, San Francisco, CA, 94101, US
321 322 323 |
# File 'lib/geokit/mappable.rb', line 321 def country_code @country_code end |
#full_address ⇒ Object
full_address is provided by google but not by yahoo. It is intended that the google geocoding method will provide the full address, whereas for yahoo it will be derived from the parts of the address we do have.
321 322 323 |
# File 'lib/geokit/mappable.rb', line 321 def full_address @full_address end |
#precision ⇒ Object
Attributes set upon return from geocoding. Success will be true for successful geocode lookups. The provider will be set to the name of the providing geocoder. Finally, precision is an indicator of the accuracy of the geocoding.
325 326 327 |
# File 'lib/geokit/mappable.rb', line 325 def precision @precision end |
#provider ⇒ Object
Attributes set upon return from geocoding. Success will be true for successful geocode lookups. The provider will be set to the name of the providing geocoder. Finally, precision is an indicator of the accuracy of the geocoding.
325 326 327 |
# File 'lib/geokit/mappable.rb', line 325 def provider @provider end |
#state ⇒ Object
Location attributes. Full address is a concatenation of all values. For example: 100 Spear St, San Francisco, CA, 94101, US
321 322 323 |
# File 'lib/geokit/mappable.rb', line 321 def state @state end |
#street_address ⇒ Object
Location attributes. Full address is a concatenation of all values. For example: 100 Spear St, San Francisco, CA, 94101, US
321 322 323 |
# File 'lib/geokit/mappable.rb', line 321 def street_address @street_address end |
#street_name ⇒ Object (readonly)
Returns the street name portion of the street address.
327 328 329 |
# File 'lib/geokit/mappable.rb', line 327 def street_name @street_name end |
#street_number ⇒ Object (readonly)
Extracts the street number from the street address if the street address has a value.
327 328 329 |
# File 'lib/geokit/mappable.rb', line 327 def street_number @street_number end |
#success ⇒ Object
Attributes set upon return from geocoding. Success will be true for successful geocode lookups. The provider will be set to the name of the providing geocoder. Finally, precision is an indicator of the accuracy of the geocoding.
325 326 327 |
# File 'lib/geokit/mappable.rb', line 325 def success @success end |
#zip ⇒ Object
Location attributes. Full address is a concatenation of all values. For example: 100 Spear St, San Francisco, CA, 94101, US
321 322 323 |
# File 'lib/geokit/mappable.rb', line 321 def zip @zip end |
Instance Method Details
#hash ⇒ Object Also known as: to_hash
gives you all the important fields as key-value pairs
375 376 377 378 379 |
# File 'lib/geokit/mappable.rb', line 375 def hash res={} [:success,:lat,:lng,:country_code,:city,:state,:zip,:street_address,:provider,:full_address,:is_us?,:ll,:precision].each { |s| res[s] = self.send(s.to_s) } res end |
#is_us? ⇒ Boolean
Returns true if geocoded to the United States.
348 349 350 |
# File 'lib/geokit/mappable.rb', line 348 def is_us? country_code == 'US' end |
#success? ⇒ Boolean
352 353 354 |
# File 'lib/geokit/mappable.rb', line 352 def success? success == true end |
#to_geocodeable_s ⇒ Object
Returns a comma-delimited string consisting of the street address, city, state, zip, and country code. Only includes those attributes that are non-blank.
394 395 396 397 398 |
# File 'lib/geokit/mappable.rb', line 394 def to_geocodeable_s a=[street_address, city, state, zip, country_code].compact a.delete_if { |e| !e || e == '' } a.join(', ') end |
#to_s ⇒ Object
Returns a string representation of the instance.
405 406 407 |
# File 'lib/geokit/mappable.rb', line 405 def to_s "Provider: #{provider}\n Street: #{street_address}\nCity: #{city}\nState: #{state}\nZip: #{zip}\nLatitude: #{lat}\nLongitude: #{lng}\nCountry: #{country_code}\nSuccess: #{success}" end |
#to_yaml_properties ⇒ Object
400 401 402 |
# File 'lib/geokit/mappable.rb', line 400 def to_yaml_properties (instance_variables - ['@all']).sort end |