Class: Kaupert::Geocoders::Geocoder

Inherits:
Object
  • Object
show all
Defined in:
lib/kaupert/geocoding.rb

Overview

The Geocoder base class which defines the interface to be used by all other geocoders.

Class Method Summary collapse

Class Method Details

.call_geocoder_service(url) ⇒ Object

Call the geocoder service using the timeout if configured.



144
145
146
147
148
149
 
# File 'lib/kaupert/geocoding.rb', line 144

def self.call_geocoder_service(url)
  Timeout::timeout(Kaupert::Geocoders::request_timeout) { return self.do_get(url) } if Kaupert::Geocoders::request_timeout        
  return self.do_get(url)
rescue TimeoutError
  return nil  
end

.do_reverse_geocode(latlng) ⇒ Object

Not all geocoders can do reverse geocoding. So, unless the subclass explicitly overrides this method, a call to reverse_geocode will return an empty GeoLoc. If you happen to be using MultiGeocoder, this will cause it to failover to the next geocoder, which will hopefully be one which supports reverse geocoding.



154
155
156
 
# File 'lib/kaupert/geocoding.rb', line 154

def self.do_reverse_geocode(latlng)
  return GeoLoc.new
end

.geocode(address, options = {}) ⇒ Object

Main method which calls the do_geocode template method which subclasses are responsible for implementing. Returns a populated GeoLoc or an empty one with a failed success code.



131
132
133
134
 
# File 'lib/kaupert/geocoding.rb', line 131

def self.geocode(address, options = {}) 
  res = do_geocode(address, options)
  return res.nil? ? GeoLoc.new : res
end

.reverse_geocode(latlng) ⇒ Object

Main method which calls the do_reverse_geocode template method which subclasses are responsible for implementing. Returns a populated GeoLoc or an empty one with a failed success code.



138
139
140
141
 
# File 'lib/kaupert/geocoding.rb', line 138

def self.reverse_geocode(latlng)
  res = do_reverse_geocode(latlng)
  return res.success? ? res : GeoLoc.new        
end