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,
lib/addressfinder/v1/nz/batch_verification.rb,
lib/addressfinder/v2/au/batch_verification.rb,
lib/addressfinder/v1/email/batch_verification.rb,
lib/addressfinder/v1/phone/batch_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.16.0"

Class Method Summary collapse

Class Method Details

.address_autocomplete(args = {}) ⇒ Object 



80
81
82
 
# File 'lib/addressfinder.rb', line 80

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

.address_info(args = {}) ⇒ Object 



84
85
86
 
# File 'lib/addressfinder.rb', line 84

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

.address_search(args = {}) ⇒ Object 



76
77
78
 
# File 'lib/addressfinder.rb', line 76

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

.address_verification(args = {}) ⇒ Object 



44
45
46
47
48
49
50
 
# File 'lib/addressfinder.rb', line 44

def address_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

.address_verification_au_batch(args = {}) ⇒ Object 



64
65
66
 
# File 'lib/addressfinder.rb', line 64

def address_verification_au_batch(args = {})
  AddressFinder::V2::Au::BatchVerification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.results
end

.address_verification_nz_batch(args = {}) ⇒ Object 



60
61
62
 
# File 'lib/addressfinder.rb', line 60

def address_verification_nz_batch(args = {})
  AddressFinder::V1::Nz::BatchVerification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.results
end

.bulk(&block) ⇒ Object 



104
105
106
107
108
 
# File 'lib/addressfinder.rb', line 104

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



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

def cleanse(args = {}) # We are keeping this method for backward compatibility
  address_verification(args)
end

.configuration ⇒ Object 



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

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

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

Yields:



26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/addressfinder.rb', line 26

def configure(config_hash = nil)
  config_hash&.each do |k, v|
    next unless configuration.respond_to?(:"#{k}=")

    begin
      configuration.send(:"#{k}=", v)
    rescue
      nil
    end
  end

  yield(configuration) if block_given?
end

.email_verification(args = {}) ⇒ Object 



88
89
90
 
# File 'lib/addressfinder.rb', line 88

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

.email_verification_batch(args = {}) ⇒ Object 



92
93
94
 
# File 'lib/addressfinder.rb', line 92

def email_verification_batch(args = {})
  AddressFinder::V1::Email::BatchVerification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.results
end

.location_info(args = {}) ⇒ Object 



72
73
74
 
# File 'lib/addressfinder.rb', line 72

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

.location_search(args = {}) ⇒ Object 



68
69
70
 
# File 'lib/addressfinder.rb', line 68

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

.phone_verification(args = {}) ⇒ Object 



96
97
98
 
# File 'lib/addressfinder.rb', line 96

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

.phone_verification_batch(args = {}) ⇒ Object 



100
101
102
 
# File 'lib/addressfinder.rb', line 100

def phone_verification_batch(args = {})
  AddressFinder::V1::Phone::BatchVerification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.results
end

.verification(args = {}) ⇒ Object

We are keeping this method for backward compatibility



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

def verification(args = {}) # We are keeping this method for backward compatibility
  address_verification(args)
end