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/email/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.11.0"

Class Method Summary collapse

Class Method Details

.address_autocomplete(args = {}) ⇒ Object 



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

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

.address_info(args = {}) ⇒ Object 



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

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

.address_search(args = {}) ⇒ Object 



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

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

.bulk(&block) ⇒ Object 



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

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



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

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 



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

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

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

Yields:



23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/addressfinder.rb', line 23

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

  yield(configuration) if block_given?
end

.email_verification(args = {}) ⇒ Object 



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

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

.email_verification_batch(args = {}) ⇒ Object 



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

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

.location_info(args = {}) ⇒ Object 



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

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

.location_search(args = {}) ⇒ Object 



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

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

.phone_verification(args = {}) ⇒ Object 



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

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

.verification(args = {}) ⇒ Object 



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

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