Module: Geokit::Geocoders

Defined in:

lib/geokit/geocoders.rb,
lib/geokit/geocoders/geocoder.rb,
lib/geokit/geocoders/ca_geocoder.rb,
lib/geokit/geocoders/ip_geocoder.rb,
lib/geokit/geocoders/us_geocoder.rb,
lib/geokit/geocoders/geocode_error.rb,
lib/geokit/geocoders/multi_geocoder.rb,
lib/geokit/geocoders/yahoo_geocoder.rb,
lib/geokit/geocoders/google_geocoder.rb,
lib/geokit/geocoders/geonames_geocoder.rb,
lib/geokit/geocoders/geo_plugin_geocoder.rb,
lib/geokit/geocoders/google_premier_geocoder.rb

Overview

Contains a range of geocoders:

### “regular” address geocoders

• Yahoo Geocoder - requires an API key.

• Geocoder.us - may require authentication if performing more than the free request limit.

• Geocoder.ca - for Canada; may require authentication as well.

• Geonames - a free geocoder

### address geocoders that also provide reverse geocoding

• Google Geocoder - requires an API key.

### IP address geocoders

• IP Geocoder - geocodes an IP address using hostip.info’s web service.

• Geoplugin.net – another IP address geocoder

### The Multigeocoder

• Multi Geocoder - provides failover for the physical location geocoders.

Some of these geocoders require configuration. You don’t have to provide it here. See the README.

Defined Under Namespace

Classes: CaGeocoder, GeoPluginGeocoder, GeocodeError, Geocoder, GeonamesGeocoder, GoogleGeocoder, GooglePremierGeocoder, IpGeocoder, MultiGeocoder, UsGeocoder, YahooGeocoder

Constant Summary

@@proxy_addr =

nil

@@proxy_port =

nil

@@proxy_user =

nil

@@proxy_pass =

nil

@@request_timeout =

nil

@@yahoo =

'REPLACE_WITH_YOUR_YAHOO_KEY'

@@google =

'REPLACE_WITH_YOUR_GOOGLE_KEY'

@@google_client =

'REPLACE_WITH_YOUR_GOOGLE_CLIENT'

@@google_channel =

'REPLACE_WITH_YOUR_GOOGLE_CHANNEL'

@@geocoder_us =

false

@@geocoder_ca =

false

@@geonames =

false

@@provider_order =

[:google,:us]

@@ip_provider_order =

[:geo_plugin,:ip]

@@logger =

Logger.new(STDOUT)

@@domain =

nil

Class Method Summary

• .__define_accessors ⇒ Object

Class Method Details

.__define_accessors ⇒ Object

# File 'lib/geokit/geocoders.rb', line 40

def self.__define_accessors
  class_variables.each do |v|
    sym = v.to_s.delete("@").to_sym
    unless self.respond_to? sym
      module_eval <<-EOS, __FILE__, __LINE__
        def self.#{sym}
          value = if defined?(#{sym.to_s.upcase})
            #{sym.to_s.upcase}
          else
            @@#{sym}
          end
          if value.is_a?(Hash)
            value = (self.domain.nil? ? nil : value[self.domain]) || value.values.first
          end
          value
        end

        def self.#{sym}=(obj)
          @@#{sym} = obj
        end
      EOS
    end
  end
end