Module: AddressFinder

Defined in:
lib/addressfinder.rb,
lib/addressfinder/bulk.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

Defined Under Namespace

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

Constant Summary collapse

VERSION = 
'1.4.0'

Class Method Summary collapse

Class Method Details

.address_info(args = {}) ⇒ Object 



45
46
47
 
# File 'lib/addressfinder.rb', line 45

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

.address_search(args = {}) ⇒ Object 



41
42
43
 
# File 'lib/addressfinder.rb', line 41

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

.bulk(&block) ⇒ Object 



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

def bulk(&block)
  # TODO include parameter http: configure_http
  AddressFinder::Bulk.new(&block).perform
end

.cleanse(args = {}) ⇒ Object 



29
30
31
 
# File 'lib/addressfinder.rb', line 29

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

.configuration ⇒ Object 



25
26
27
 
# File 'lib/addressfinder.rb', line 25

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

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

Yields:



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

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 



37
38
39
 
# File 'lib/addressfinder.rb', line 37

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

.location_search(args = {}) ⇒ Object 



33
34
35
 
# File 'lib/addressfinder.rb', line 33

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