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/v1/base.rb,
lib/addressfinder/version.rb,
lib/addressfinder/address_info.rb,
lib/addressfinder/verification.rb,
lib/addressfinder/configuration.rb,
lib/addressfinder/location_info.rb,
lib/addressfinder/address_search.rb,
lib/addressfinder/location_search.rb,
lib/addressfinder/v2/au/verification.rb,
lib/addressfinder/address_autocomplete.rb,
lib/addressfinder/v1/email/verification.rb,
lib/addressfinder/v1/phone/verification.rb

Defined Under Namespace

Modules: V1, V2 Classes: AddressAutocomplete, AddressInfo, AddressSearch, Bulk, Configuration, HTTP, LocationInfo, LocationSearch, NotFoundError, RequestRejectedError, Util, Verification

Constant Summary collapse

VERSION = 
'1.10.1'

Class Method Summary collapse

Class Method Details

.address_autocomplete(args = {}) ⇒ Object 



58
59
60
 
# File 'lib/addressfinder.rb', line 58

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

.address_info(args = {}) ⇒ Object 



62
63
64
 
# File 'lib/addressfinder.rb', line 62

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

.address_search(args = {}) ⇒ Object 



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

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

.bulk(&block) ⇒ Object 



74
75
76
 
# File 'lib/addressfinder.rb', line 74

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

.cleanse(args = {}) ⇒ Object

We are keeping this method for backward compatibility



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

def cleanse(args={}) # We are keeping this method for backward compatibility
  AddressFinder::Verification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
end

.configuration ⇒ Object 



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

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

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

Yields:



20
21
22
23
24
25
26
27
28
 
# File 'lib/addressfinder.rb', line 20

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

.email_verification(args = {}) ⇒ Object 



66
67
68
 
# File 'lib/addressfinder.rb', line 66

def email_verification(args={})
  AddressFinder::V1::Email::Verification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
end

.location_info(args = {}) ⇒ Object 



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

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

.location_search(args = {}) ⇒ Object 



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

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

.phone_verification(args = {}) ⇒ Object 



70
71
72
 
# File 'lib/addressfinder.rb', line 70

def phone_verification(args={})
  AddressFinder::V1::Phone::Verification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
end

.verification(args = {}) ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/addressfinder.rb', line 38

def verification(args={})
  if (args[:country] || configuration.default_country) == 'au' && configuration.verification_version&.downcase == "v2"
    AddressFinder::V2::Au::Verification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
  else
    AddressFinder::Verification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
  end
end