Module: Geocoder
- Extended by:
- Geocoder
- Included in:
- Geocoder
- Defined in:
- lib/geocoder.rb,
lib/geocoder/cli.rb,
lib/geocoder/sql.rb,
lib/geocoder/cache.rb,
lib/geocoder/query.rb,
lib/geocoder/lookup.rb,
lib/geocoder/railtie.rb,
lib/geocoder/request.rb,
lib/geocoder/version.rb,
lib/geocoder/exceptions.rb,
lib/geocoder/models/base.rb,
lib/geocoder/stores/base.rb,
lib/geocoder/calculations.rb,
lib/geocoder/lookups/base.rb,
lib/geocoder/lookups/test.rb,
lib/geocoder/results/base.rb,
lib/geocoder/results/test.rb,
lib/geocoder/configuration.rb,
lib/geocoder/models/mongoid.rb,
lib/geocoder/models/mongo_base.rb,
lib/geocoder/configuration_hash.rb,
lib/geocoder/models/mongo_mapper.rb,
lib/geocoder/models/active_record.rb,
lib/generators/geocoder/config/config_generator.rb
Defined Under Namespace
Modules: Calculations, Lookup, Model, Request, Result, Sql, Store Classes: Cache, Cli, ConfigGenerator, Configuration, ConfigurationError, ConfigurationHash, Error, InvalidApiKey, InvalidRequest, OverQueryLimitError, Query, Railtie, RequestDenied
Constant Summary collapse
- VERSION =
"1.1.9"
Class Method Summary collapse
-
.config ⇒ Object
Read-only access to the singleton’s config data.
-
.config_for_lookup(lookup_name) ⇒ Object
Read-only access to lookup-specific config data.
-
.configure(options = nil, &block) ⇒ Object
Configuration options should be set by passing a hash:.
Instance Method Summary collapse
-
#address(query, options = {}) ⇒ Object
Look up the address of the given coordinates ([lat,lon]) or IP address (string).
-
#cache ⇒ Object
The working Cache object, or
nil
if none configured. -
#coordinates(address, options = {}) ⇒ Object
Look up the coordinates of the given street or IP address.
-
#search(query, options = {}) ⇒ Object
Search for information about an address or a set of coordinates.
Class Method Details
.config ⇒ Object
Read-only access to the singleton’s config data.
31 32 33 |
# File 'lib/geocoder/configuration.rb', line 31 def self.config Configuration.instance.data end |
.config_for_lookup(lookup_name) ⇒ Object
Read-only access to lookup-specific config data.
38 39 40 41 42 43 44 45 |
# File 'lib/geocoder/configuration.rb', line 38 def self.config_for_lookup(lookup_name) data = config.clone data.reject!{ |key,value| !Configuration::OPTIONS.include?(key) } if config.has_key?(lookup_name) data.merge!(config[lookup_name]) end data end |
.configure(options = nil, &block) ⇒ Object
Configuration options should be set by passing a hash:
Geocoder.configure(
:timeout => 5,
:lookup => :yandex,
:api_key => "2a9fsa983jaslfj982fjasd",
:units => :km
)
16 17 18 19 20 21 22 23 24 25 26 |
# File 'lib/geocoder/configuration.rb', line 16 def self.configure( = nil, &block) if block_given? warn "WARNING: Passing a block to Geocoder.configure is DEPRECATED. Please pass a hash instead (eg: Geocoder.configure(:units => ..., :api_key => ...))." block.call(Configuration.instance) elsif !.nil? Configuration.instance.configure() else warn "WARNING: Use of Geocoder.configure to read or write single config options is DEPRECATED. To write to the config please pass a hash (eg: Geocoder.configure(:units => ...)). To read config options please use the Geocoder.config object (eg: Geocoder.config.units)." Configuration.instance end end |
Instance Method Details
#address(query, options = {}) ⇒ Object
Look up the address of the given coordinates ([lat,lon]) or IP address (string).
36 37 38 39 40 |
# File 'lib/geocoder.rb', line 36 def address(query, = {}) if (results = search(query, )).size > 0 results.first.address end end |
#cache ⇒ Object
The working Cache object, or nil
if none configured.
45 46 47 48 |
# File 'lib/geocoder.rb', line 45 def cache warn "WARNING: Calling Geocoder.cache is DEPRECATED. The #cache method now belongs to the Geocoder::Lookup object." Geocoder::Lookup.get(Geocoder.config.lookup).cache end |
#coordinates(address, options = {}) ⇒ Object
Look up the coordinates of the given street or IP address.
26 27 28 29 30 |
# File 'lib/geocoder.rb', line 26 def coordinates(address, = {}) if (results = search(address, )).size > 0 results.first.coordinates end end |