Module: AddressFinder

Defined in:
lib/addressfinder.rb,
lib/addressfinder/bulk.rb,
lib/addressfinder/http.rb,
lib/addressfinder/util.rb,
lib/addressfinder/errors.rb,
lib/addressfinder/cleanse.rb,
lib/addressfinder/version.rb,
lib/addressfinder/address_info.rb,
lib/addressfinder/configuration.rb,
lib/addressfinder/location_info.rb,
lib/addressfinder/address_search.rb,
lib/addressfinder/location_search.rb,
lib/addressfinder/address_autocomplete.rb

Defined Under Namespace

Classes: AddressAutocomplete, AddressInfo, AddressSearch, Bulk, Cleanse, Configuration, HTTP, LocationInfo, LocationSearch, NotFoundError, RequestRejectedError, Util

Constant Summary collapse

VERSION = 
'1.7.0'

Class Method Summary collapse

Class Method Details

.address_autocomplete(args = {}) ⇒ Object 



47
48
49
 
# File 'lib/addressfinder.rb', line 47

def address_autocomplete(args={})
  AddressFinder::AddressAutocomplete.new(params: args, http: AddressFinder::HTTP.new(configuration)).perform.results
end

.address_info(args = {}) ⇒ Object 



51
52
53
 
# File 'lib/addressfinder.rb', line 51

def address_info(args={})
  AddressFinder::AddressInfo.new(params: args, http: AddressFinder::HTTP.new(configuration)).perform.result
end

.address_search(args = {}) ⇒ Object 



43
44
45
 
# File 'lib/addressfinder.rb', line 43

def address_search(args={})
  AddressFinder::AddressSearch.new(params: args, http: AddressFinder::HTTP.new(configuration)).perform.results
end

.bulk(&block) ⇒ Object 



55
56
57
 
# File 'lib/addressfinder.rb', line 55

def bulk(&block)
  AddressFinder::Bulk.new(http: AddressFinder::HTTP.new(configuration), &block).perform
end

.cleanse(args = {}) ⇒ Object 



31
32
33
 
# File 'lib/addressfinder.rb', line 31

def cleanse(args={})
  AddressFinder::Cleanse.new(args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
end

.configuration ⇒ Object 



27
28
29
 
# File 'lib/addressfinder.rb', line 27

def configuration
  @configuration ||= AddressFinder::Configuration.new
end

.configure(config_hash = nil) {|configuration| ... } ⇒ Object

Yields:



17
18
19
20
21
22
23
24
25
 
# File 'lib/addressfinder.rb', line 17

def configure(config_hash=nil)
  if config_hash
    config_hash.each do |k,v|
      configuration.send("#{k}=", v) rescue nil if configuration.respond_to?("#{k}=")
    end
  end

  yield(configuration) if block_given?
end

.location_info(args = {}) ⇒ Object 



39
40
41
 
# File 'lib/addressfinder.rb', line 39

def location_info(args={})
  AddressFinder::LocationInfo.new(params: args, http: AddressFinder::HTTP.new(configuration)).perform.result
end

.location_search(args = {}) ⇒ Object 



35
36
37
 
# File 'lib/addressfinder.rb', line 35

def location_search(args={})
  AddressFinder::LocationSearch.new(params: args, http: AddressFinder::HTTP.new(configuration)).perform.results
end