addressfinder 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bac347ed1fa4ee45f7ff1bdc3f5fdc5bee74206fa73b1fe4d33be727f21c1b41
-  data.tar.gz: 44e72444624d652a166089b6c630fb739d47f77155dfaed2e8a27b88afa7bf59
+  metadata.gz: 8d84bdab006a12ff6f18d90d33986cf03172e1d8fedc52ffca604795631b8420
+  data.tar.gz: 933d6673ee1271440c17801ac410047a44761d6e1539de3f7c211cec9ee16bd7
 SHA512:
-  metadata.gz: 180b47e4aa74a5b09c312cc6be655bca62f9f4293f68b7c2505370dbdf2f14c2a48bf71d6523fbe1cf991bcf078745f62ba9d9f9b4e7cebdabd9b38900e111ee
-  data.tar.gz: 7396a52596c09359dbd3cb2facaafe6d4af4b4887be6d0c12b9de8770441ca45055bace9b4665af649793c0f482f39125b59df0e377f75c61e6380578ab258e1
+  metadata.gz: 27b217ad366baf5b6e46d02ab14410a30133d7adfefb06292a92daedc271266ed7139d83be5d14cdee4a3e1128ee18d6604049cd41405f243496bfc24dc13cf6
+  data.tar.gz: 26861692d4d8936ae1f5a581390afb2d04cc1f9a870b43488e6f0e76d4bb33caacdbe92e28ee13e8b92960d1dc5bb410d0a01ffdba6fe83c4917214afbbbdf57

data/.github/workflows/ruby.yml

@@ -0,0 +1,31 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@0a29871fe2b0200a17a4497bae54fe5df0d973aa # v1.115.3
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# AddressFinder 1.10.0 (August 2023) #
+
+* Add support for Email Verification
+* Add support for Phone Verification
+* Add support for Bulk Email Verification
+* Add support for Bulk Phone Verification
+
+# AddressFinder 1.9.1 (October 2022) #
+
+* Add missing kwarg `**` for ruby 3
+
 # AddressFinder 1.9.0 (July 2022) #
 
 * Add support for Ruby 3.x

data/README.md

@@ -157,6 +157,28 @@ rescue AddressFinder::RequestRejectedError => e
 end
 ```
 
+#### Email Verification
+```ruby
+begin
+  result = AddressFinder.email_verification(email: 'john.doe')
+  $stdout.puts "This email address is verified: #{result.is_verified}"
+rescue AddressFinder::RequestRejectedError => e
+  response = JSON.parse(e.body)
+  $stdout.puts response['message']
+end
+```
+
+#### Phone Verification
+```ruby
+begin
+  result = AddressFinder.phone_verification(phone_number: '1800 152 363', default_country_code: 'AU')
+  $stdout.puts "This phone number is verified: #{result.is_verified}"
+rescue AddressFinder::RequestRejectedError => e
+  response = JSON.parse(e.body)
+  $stdout.puts response['message']
+end
+```
+
 ## Advanced Usage
 
 #### Bulk Operations
@@ -164,7 +186,7 @@ end
 If you have a series of API requests, you can use the
 bulk method to re-use the HTTP connection.
 
-**Note:** The bulk method is currently only available for Address Verification (`#verification`).
+**Note:** The bulk method is currently only available for Address Verification, Email Verification and Phone Verification (`#verification`, `#email_verification`, `#phone_verifiction`).
 
 ```ruby
 AddressFinder.bulk do |af|

data/lib/addressfinder/bulk.rb

@@ -36,6 +36,14 @@ module AddressFinder
         end
       end
 
+      def email_verification(args={})
+        AddressFinder::V1::Email::Verification.new(**args.merge(http: http)).perform.result
+      end
+
+      def phone_verification(args={})
+        AddressFinder::V1::Phone::Verification.new(**args.merge(http: http)).perform.result
+      end
+
       private
 
       attr_reader :http, :verification_version, :default_country

data/lib/addressfinder/v1/base.rb

@@ -0,0 +1,71 @@
+require 'ostruct'
+
+module AddressFinder
+  module V1
+    class Base
+      attr_reader :result
+
+      def initialize(params:, path:, http:)
+        @params = params
+        @params[:domain] ||= config.domain if config.domain
+        @params[:key] ||= config.api_key
+        @params[:secret] ||= config.api_secret
+        @params[:format] ||= 'json'
+
+        @path = path
+        @http = http
+      end
+
+      def perform
+        build_request
+        execute_request
+        build_result
+  
+        self
+      end
+
+      private
+  
+      attr_reader :request_uri, :params, :http, :path
+      attr_accessor :response_body, :response_status
+      attr_writer :result
+
+      def build_request
+        @request_uri = "#{path}?#{encoded_params}"
+      end
+  
+      def encoded_params
+        Util.encode_and_join_params(params)
+      end
+  
+      def execute_request
+        request = Net::HTTP::Get.new(request_uri)
+  
+        response = http.request(request)
+  
+        self.response_body = response.body
+        self.response_status = response.code
+      end
+  
+      def build_result
+        case response_status
+        when '200'
+          self.result = Result.new(response_hash)
+        else
+          raise AddressFinder::RequestRejectedError.new(response_status, response_body)
+        end
+      end
+  
+      def response_hash
+        @_response_hash ||= MultiJson.load(response_body)
+      end
+  
+      def config
+        @_config ||= AddressFinder.configuration
+      end
+  
+      class Result < OpenStruct
+      end
+    end
+  end
+end

data/lib/addressfinder/v1/email/verification.rb

@@ -0,0 +1,16 @@
+require 'addressfinder/v1/base'
+
+module AddressFinder
+  module V1
+    module Email
+      class Verification < AddressFinder::V1::Base
+        attr_reader :result
+    
+        def initialize(email:, http:, **args)
+          params = {email: email}.merge(args)
+          super(params: params, path: "/api/email/v1/verification", http: http)
+        end
+      end
+    end
+  end
+end

data/lib/addressfinder/v1/phone/verification.rb

@@ -0,0 +1,16 @@
+require 'addressfinder/v1/base'
+
+module AddressFinder
+  module V1
+    module Phone
+      class Verification < AddressFinder::V1::Base
+        attr_reader :result
+    
+        def initialize(phone_number:, default_country_code:, http:, **args)
+          params = {phone_number: phone_number, default_country_code: default_country_code}.merge(args)
+          super(params: params, path: "/api/phone/v1/verification", http: http)
+        end
+      end
+    end
+  end
+end

data/lib/addressfinder/version.rb

@@ -1,3 +1,3 @@
 module AddressFinder
-  VERSION = '1.9.0'
+  VERSION = '1.10.0'
 end

data/lib/addressfinder.rb

@@ -9,6 +9,8 @@ require 'addressfinder/address_info'
 require 'addressfinder/address_search'
 require 'addressfinder/address_autocomplete'
 require 'addressfinder/bulk'
+require 'addressfinder/v1/email/verification'
+require 'addressfinder/v1/phone/verification'
 require 'addressfinder/errors'
 require 'addressfinder/util'
 require 'addressfinder/http'
@@ -30,14 +32,14 @@ module AddressFinder
     end
 
     def cleanse(args={}) # We are keeping this method for backward compatibility
-      AddressFinder::Verification.new(args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
+      AddressFinder::Verification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
     end
 
     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
+        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
+        AddressFinder::Verification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
       end
     end
 
@@ -61,6 +63,14 @@ module AddressFinder
       AddressFinder::AddressInfo.new(params: args, http: AddressFinder::HTTP.new(configuration)).perform.result
     end
 
+    def email_verification(args={})
+      AddressFinder::V1::Email::Verification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
+    end
+
+    def phone_verification(args={})
+      AddressFinder::V1::Phone::Verification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
+    end
+
     def bulk(&block)
       AddressFinder::Bulk.new(http: AddressFinder::HTTP.new(configuration), verification_version: configuration.verification_version, default_country: configuration.default_country, &block).perform
     end

data/spec/lib/addressfinder/bulk_spec.rb

@@ -111,5 +111,97 @@ RSpec.describe AddressFinder::Bulk do
         AddressFinder::Bulk.new(http: http, verification_version: "v2", default_country: 'nz', &block).perform
       end
     end
+
+    context "email verification with 3 requests in the provided block" do
+      let(:response){ double(:response, body: %Q({"success": true}), code: "200") }
+      let(:block){
+        Proc.new do |proxy|
+          proxy.email_verification(email: "john.doe@addressfinder.com")
+          proxy.email_verification(email: "jane.doe@addressfinder.com")
+          proxy.email_verification(email: "tom.doe@addressfinder.com")
+        end
+      }
+
+      it "uses 1 http connection" do
+        expect(net_http).to receive(:do_start).once.and_call_original
+        expect(net_http).to receive(:transport_request).exactly(3).times.and_return(response)
+        expect(net_http).to receive(:do_finish).once.and_call_original
+        AddressFinder::Bulk.new(http: http, verification_version: 'v1', default_country: 'nz', &block).perform
+      end
+
+      it "calls the correct class with v1 verification and nz default" do
+        allow(net_http).to receive(:do_start).once.and_call_original
+        allow(net_http).to receive(:transport_request).exactly(3).times.and_return(response)
+        allow(net_http).to receive(:do_finish).once.and_call_original
+        expect(AddressFinder::V1::Email::Verification).to receive(:new).exactly(3).times.and_call_original
+        AddressFinder::Bulk.new(http: http, verification_version: 'v1', default_country: 'nz', &block).perform
+      end
+
+      it "calls the correct class without a verification version or default country" do
+        allow(net_http).to receive(:do_start).once.and_call_original
+        allow(net_http).to receive(:transport_request).exactly(3).times.and_return(response)
+        allow(net_http).to receive(:do_finish).once.and_call_original
+        expect(AddressFinder::V1::Email::Verification).to receive(:new).exactly(3).times.and_call_original
+        AddressFinder::Bulk.new(http: http, verification_version: nil, default_country: nil, &block).perform
+      end
+
+      it "re-establishes the http connection and continues where we left off when a Net::OpenTimeout, Net::ReadTimeout or SocketError is raised" do
+        expect(http).to receive(:re_establish_connection).exactly(3).times.and_call_original
+        expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
+        expect(net_http).to receive(:transport_request).once.and_return(response) # john.doe@addressfinder.com (success)
+        expect(net_http).to receive(:transport_request).once.and_raise(Net::OpenTimeout) # jane.doe@addressfinder.com (error)
+        expect(net_http).to receive(:transport_request).once.and_raise(Net::ReadTimeout) # Retry jane.doe@addressfinder.com (error)
+        expect(net_http).to receive(:transport_request).once.and_raise(SocketError) # Retry jane.doe@addressfinder.com (error)
+        expect(net_http).to receive(:transport_request).exactly(2).and_return(response) # Retry jane.doe@addressfinder.com (success) & tom.doe@addressfinder.com (success)
+        expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
+        AddressFinder::Bulk.new(http: http, verification_version: 'v1', default_country: 'nz', &block).perform
+      end
+    end
+
+    context "phone verification with 3 requests in the provided block" do
+      let(:response){ double(:response, body: %Q({"success": true}), code: "200") }
+      let(:block){
+        Proc.new do |proxy|
+          proxy.phone_verification(phone_number: "+64274673830", default_country_code: "AU")
+          proxy.phone_verification(phone_number: "1800 152 363", default_country_code: "AU")
+          proxy.phone_verification(phone_number: "0274673830", default_country_code: "NZ")
+        end
+      }
+
+      it "uses 1 http connection" do
+        expect(net_http).to receive(:do_start).once.and_call_original
+        expect(net_http).to receive(:transport_request).exactly(3).times.and_return(response)
+        expect(net_http).to receive(:do_finish).once.and_call_original
+        AddressFinder::Bulk.new(http: http, verification_version: 'v1', default_country: 'nz', &block).perform
+      end
+
+      it "calls the correct class with v1 verification and nz default" do
+        allow(net_http).to receive(:do_start).once.and_call_original
+        allow(net_http).to receive(:transport_request).exactly(3).times.and_return(response)
+        allow(net_http).to receive(:do_finish).once.and_call_original
+        expect(AddressFinder::V1::Phone::Verification).to receive(:new).exactly(3).times.and_call_original
+        AddressFinder::Bulk.new(http: http, verification_version: 'v1', default_country: 'nz', &block).perform
+      end
+
+      it "calls the correct class without a verification version or default country" do
+        allow(net_http).to receive(:do_start).once.and_call_original
+        allow(net_http).to receive(:transport_request).exactly(3).times.and_return(response)
+        allow(net_http).to receive(:do_finish).once.and_call_original
+        expect(AddressFinder::V1::Phone::Verification).to receive(:new).exactly(3).times.and_call_original
+        AddressFinder::Bulk.new(http: http, verification_version: nil, default_country: nil, &block).perform
+      end
+
+      it "re-establishes the http connection and continues where we left off when a Net::OpenTimeout, Net::ReadTimeout or SocketError is raised" do
+        expect(http).to receive(:re_establish_connection).exactly(3).times.and_call_original
+        expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
+        expect(net_http).to receive(:transport_request).once.and_return(response) # +64274673830 (success)
+        expect(net_http).to receive(:transport_request).once.and_raise(Net::OpenTimeout) # 1800 152 363 (error)
+        expect(net_http).to receive(:transport_request).once.and_raise(Net::ReadTimeout) # Retry 1800 152 363 (error)
+        expect(net_http).to receive(:transport_request).once.and_raise(SocketError) # Retry 1800 152 363 (error)
+        expect(net_http).to receive(:transport_request).exactly(2).and_return(response) # Retry 1800 152 363 (success) & 0274673830 (success)
+        expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
+        AddressFinder::Bulk.new(http: http, verification_version: 'v1', default_country: 'nz', &block).perform
+      end
+    end
   end
 end

data/spec/lib/addressfinder/v1/email/verification_spec.rb

@@ -0,0 +1,148 @@
+require "spec_helper"
+
+RSpec.describe AddressFinder::V1::Email::Verification do
+  before do
+    AddressFinder.configure do |af|
+      af.api_key = "XXX"
+      af.api_secret = "YYY"
+      af.timeout = 5
+      af.retries = 3
+    end
+  end
+
+  let(:verification_module){ AddressFinder::V1::Email::Verification.new(**args) }
+  let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
+  let(:net_http){ http.send(:net_http) }
+
+  describe "#execute_request" do
+    let(:args){ {email: "john.doe@addressfinder.com", http: http} }
+
+    before do
+      WebMock.allow_net_connect!(net_http_connect_on_start: true)
+      allow(http).to receive(:sleep)
+      allow(verification_module).to receive(:request_uri).and_return("/test/path")
+      expect(http).to_not receive(:re_establish_connection)
+    end
+
+    after do
+      WebMock.disable_net_connect!
+    end
+
+    subject(:execute_request){ verification_module.send(:execute_request) }
+
+    it "retries an errored request another time before succeeding" do
+      expect(net_http).to receive(:do_start).twice.and_call_original
+      expect(net_http).to receive(:transport_request).once.and_raise(Net::OpenTimeout)
+      expect(net_http).to receive(:transport_request).once.and_return(double(:response, body: "OK", code: "200"))
+      expect(net_http).to receive(:do_finish).twice.and_call_original
+      execute_request
+    end
+
+    it "re-raises a Net::OpenTimeout error after 3 retries" do
+      expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
+      expect(net_http).to receive(:transport_request).exactly(4).times.and_raise(Net::OpenTimeout)
+      expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
+      expect{execute_request}.to raise_error(Net::OpenTimeout)
+    end
+
+    it "re-raises a Net::ReadTimeout error after 3 retries" do
+      expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
+      expect(net_http).to receive(:transport_request).exactly(4).times.and_raise(Net::ReadTimeout)
+      expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
+      expect{execute_request}.to raise_error(Net::ReadTimeout)
+    end
+
+    it "re-raises a SocketError error after 3 retries" do
+      expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
+      expect(net_http).to receive(:transport_request).exactly(4).times.and_raise(SocketError)
+      expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
+      expect{execute_request}.to raise_error(SocketError)
+    end
+  end
+
+  describe "#build_request" do
+    subject(:request_uri){ verification_module.send(:build_request) }
+
+    context "with email argument" do
+      let(:args){ {email: "john.doe@addressfinder.com", http: http} }
+
+      it { expect(request_uri).to eq("/api/email/v1/verification?email=john.doe%40addressfinder.com&key=XXX&secret=YYY&format=json") }
+    end
+
+    context "with email and format arguments" do
+      let(:args){ {email: "john.doe@addressfinder.com", format: "xml", http: http} }
+
+      it { expect(request_uri).to eq("/api/email/v1/verification?email=john.doe%40addressfinder.com&format=xml&key=XXX&secret=YYY") }
+    end
+
+    context "with a reserved character in the email" do
+      let(:args){ {email: "john=doe@addressfinder.com", http: http} }
+
+      it { expect(request_uri).to eq("/api/email/v1/verification?email=john%3Ddoe%40addressfinder.com&key=XXX&secret=YYY&format=json") }
+    end
+
+    context "with a key override" do
+      let(:args){ {email: "john.doe@addressfinder.com", key: "AAA", http: http} }
+
+      it { expect(request_uri).to eq("/api/email/v1/verification?email=john.doe%40addressfinder.com&key=AAA&secret=YYY&format=json") }
+    end
+
+    context "with a secret override" do
+      let(:args){ {email: "john.doe@addressfinder.com", secret: "BBB", http: http} }
+
+      it { expect(request_uri).to eq("/api/email/v1/verification?email=john.doe%40addressfinder.com&secret=BBB&key=XXX&format=json") }
+    end
+
+    context "with a domain given" do
+      let(:args){ {email: "john.doe@addressfinder.com", domain: "testdomain.com", http: http} }
+
+      it { expect(request_uri).to eq("/api/email/v1/verification?email=john.doe%40addressfinder.com&domain=testdomain.com&key=XXX&secret=YYY&format=json") }
+
+      context "given in the AF configuration" do
+        let(:args){ {email: "john.doe@addressfinder.com", http: http} }
+
+        it "should use the config domain if set" do
+          AddressFinder.configuration.domain = "anotherdomain.com"
+          expect(request_uri).to eq("/api/email/v1/verification?email=john.doe%40addressfinder.com&domain=anotherdomain.com&key=XXX&secret=YYY&format=json")
+          AddressFinder.configuration.domain = nil # set back to nil after
+        end
+      end
+    end
+
+    context "with a all arguments included in request" do
+      let(:args){ {email: "john.doe@addressfinder.com", domain: "mysite.com", key: "AAA", secret: "BBB", format: "json", http: http} }
+
+      it { expect(request_uri).to eq("/api/email/v1/verification?email=john.doe%40addressfinder.com&domain=mysite.com&key=AAA&secret=BBB&format=json") }
+    end
+  end
+
+  describe "#build_result" do
+    let(:args){ {email: "ignored", http: nil} }
+
+    before do
+      verification_module.send("response_body=", body)
+      verification_module.send("response_status=", status)
+    end
+
+    subject(:result){ verification_module.send(:build_result) }
+
+    context "with a successful verification" do
+      let(:body){ '{"email_account": "john.doe", "email_domain": "addressfinder.com", "is_verified": true, "success": true}' }
+      let(:status){ "200" }
+
+      it { expect(result.class).to eq(AddressFinder::V1::Email::Verification::Result) }
+      it { expect(result.is_verified).to eq(true) }
+      it { expect(result.email_account).to eq("john.doe") }
+    end
+
+    context "with an unsuccessful verification" do
+      let(:body){ '{"email_account": "jane.doe", "email_domain": "addressfinder.com", "is_verified": false, "not_verified_reason": "The email account does not exist", "success": true}' }
+      let(:status){ "200" }
+
+      it { expect(result.class).to eq(AddressFinder::V1::Email::Verification::Result) }
+      it { expect(result.is_verified).to eq(false) }
+      it { expect(result.email_account).to eq("jane.doe") }
+      it { expect(result.not_verified_reason).to eq("The email account does not exist") }
+    end
+  end
+end

data/spec/lib/addressfinder/v1/phone/verification_spec.rb

@@ -0,0 +1,144 @@
+require "spec_helper"
+
+RSpec.describe AddressFinder::V1::Phone::Verification do
+  before do
+    AddressFinder.configure do |af|
+      af.api_key = "XXX"
+      af.api_secret = "YYY"
+      af.timeout = 5
+      af.retries = 3
+    end
+  end
+
+  let(:verification_module){ AddressFinder::V1::Phone::Verification.new(**args) }
+  let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
+  let(:net_http){ http.send(:net_http) }
+
+  describe "#execute_request" do
+    let(:args){ {phone_number: "1800 152 363", default_country_code: "AU", http: http} }
+
+    before do
+      WebMock.allow_net_connect!(net_http_connect_on_start: true)
+      allow(http).to receive(:sleep)
+      allow(verification_module).to receive(:request_uri).and_return("/test/path")
+      expect(http).to_not receive(:re_establish_connection)
+    end
+
+    after do
+      WebMock.disable_net_connect!
+    end
+
+    subject(:execute_request){ verification_module.send(:execute_request) }
+
+    it "retries an errored request another time before succeeding" do
+      expect(net_http).to receive(:do_start).twice.and_call_original
+      expect(net_http).to receive(:transport_request).once.and_raise(Net::OpenTimeout)
+      expect(net_http).to receive(:transport_request).once.and_return(double(:response, body: "OK", code: "200"))
+      expect(net_http).to receive(:do_finish).twice.and_call_original
+      execute_request
+    end
+
+    it "re-raises a Net::OpenTimeout error after 3 retries" do
+      expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
+      expect(net_http).to receive(:transport_request).exactly(4).times.and_raise(Net::OpenTimeout)
+      expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
+      expect{execute_request}.to raise_error(Net::OpenTimeout)
+    end
+
+    it "re-raises a Net::ReadTimeout error after 3 retries" do
+      expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
+      expect(net_http).to receive(:transport_request).exactly(4).times.and_raise(Net::ReadTimeout)
+      expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
+      expect{execute_request}.to raise_error(Net::ReadTimeout)
+    end
+
+    it "re-raises a SocketError error after 3 retries" do
+      expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
+      expect(net_http).to receive(:transport_request).exactly(4).times.and_raise(SocketError)
+      expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
+      expect{execute_request}.to raise_error(SocketError)
+    end
+  end
+
+  describe "#build_request" do
+    subject(:request_uri){ verification_module.send(:build_request) }
+
+    context "with phone number and default country code arguments" do
+      let(:args){ {phone_number: "1800 152 363", default_country_code: "AU", http: http} }
+
+      it { expect(request_uri).to eq("/api/phone/v1/verification?phone_number=1800+152+363&default_country_code=AU&key=XXX&secret=YYY&format=json") }
+    end
+
+    context "with a reserved character in the phone number" do
+      let(:args){ {phone_number: "1800= 152 363", default_country_code: "AU", http: http} }
+
+      it { expect(request_uri).to eq("/api/phone/v1/verification?phone_number=1800%3D+152+363&default_country_code=AU&key=XXX&secret=YYY&format=json") }
+    end
+
+    context "with a key override" do
+      let(:args){ {phone_number: "1800 152 363", default_country_code: "AU", key: "AAA", http: http} }
+
+      it { expect(request_uri).to eq("/api/phone/v1/verification?phone_number=1800+152+363&default_country_code=AU&key=AAA&secret=YYY&format=json") }
+    end
+
+    context "with a secret override" do
+      let(:args){ {phone_number: "1800 152 363", default_country_code: "AU", secret: "BBB", http: http} }
+
+      it { expect(request_uri).to eq("/api/phone/v1/verification?phone_number=1800+152+363&default_country_code=AU&secret=BBB&key=XXX&format=json") }
+    end
+
+    context "with a domain given" do
+      let(:args){ {phone_number: "1800 152 363", default_country_code: "AU", domain: "testdomain.com", http: http} }
+
+      it { expect(request_uri).to eq("/api/phone/v1/verification?phone_number=1800+152+363&default_country_code=AU&domain=testdomain.com&key=XXX&secret=YYY&format=json") }
+
+      context "given in the AF configuration" do
+        let(:args){ {phone_number: "1800 152 363", default_country_code: "AU", http: http} }
+
+        it "should use the config domain if set" do
+          AddressFinder.configuration.domain = "anotherdomain.com"
+          expect(request_uri).to eq("/api/phone/v1/verification?phone_number=1800+152+363&default_country_code=AU&domain=anotherdomain.com&key=XXX&secret=YYY&format=json")
+          AddressFinder.configuration.domain = nil # set back to nil after
+        end
+      end
+    end
+
+    context "with a all arguments included in request" do
+      let(:args){ {phone_number: "1800 152 363", default_country_code: "NZ", allowed_country_codes: "AU,NZ", mobile_only: true, timeout: "10", domain: "mysite.com", key: "AAA", secret: "BBB", format: "xml", http: http} }
+
+      it { expect(request_uri).to eq("/api/phone/v1/verification?phone_number=1800+152+363&default_country_code=NZ&allowed_country_codes=AU%2CNZ&mobile_only=true&timeout=10&domain=mysite.com&key=AAA&secret=BBB&format=xml") }
+    end
+  end
+
+  describe "#build_result" do
+    let(:args){ {phone_number: "ignored", default_country_code: "ignored", http: nil} }
+
+    before do
+      verification_module.send("response_body=", body)
+      verification_module.send("response_status=", status)
+    end
+
+    subject(:result){ verification_module.send(:build_result) }
+
+    context "with a successful verification" do
+      let(:body){ '{"raw_international": "+611800152353", "line_type": "toll_free", "line_status": "disconnected", "is_verified": true, "success": true}' }
+      let(:status){ "200" }
+
+      it { expect(result.class).to eq(AddressFinder::V1::Phone::Verification::Result) }
+      it { expect(result.is_verified).to eq(true) }
+      it { expect(result.raw_international).to eq("+611800152353") }
+      it { expect(result.line_type).to eq("toll_free") }
+      it { expect(result.line_status).to eq("disconnected") }
+    end
+
+    context "with an unsuccessful verification" do
+      let(:body){ '{"is_verified": false, "not_verified_reason": "Phone number format is incorrect", "not_verified_code": "INVALID_FORMAT", "success": true}' }
+      let(:status){ "200" }
+
+      it { expect(result.class).to eq(AddressFinder::V1::Phone::Verification::Result) }
+      it { expect(result.is_verified).to eq(false) }
+      it { expect(result.not_verified_code).to eq("INVALID_FORMAT") }
+      it { expect(result.not_verified_reason).to eq("Phone number format is incorrect") }
+    end
+  end
+end

data/spec/lib/addressfinder/v2/au/verification_spec.rb

@@ -116,7 +116,7 @@ RSpec.describe AddressFinder::V2::Au::Verification do
 
         it 'should use the config domain if set' do
           AddressFinder.configuration.domain = 'anotherdomain.com'
-          # expect(request_uri).to eq('/api/au/address/v2/verification?q=123&domain=anotherdomain.com&key=XXX&secret=YYY&format=json')
+          expect(request_uri).to eq('/api/au/address/v2/verification?q=123&domain=anotherdomain.com&key=XXX&secret=YYY&format=json')
           AddressFinder.configuration.domain = nil # set back to nil after
         end
       end

data/spec/lib/addressfinder_spec.rb

@@ -29,6 +29,11 @@ RSpec.describe AddressFinder do
         expect(AddressFinder::Verification).to receive_message_chain(:new, :perform, :result)
         subject
       end
+
+      it "safely passes arguments through" do
+        stub_request(:get, Addressable::Template.new("https://api.addressfinder.io/api/nz/address/verification{?args*}")).to_return(:status => 200, :body => "{}", :headers => {})
+        subject
+      end
     end
 
     context "with country set to au" do
@@ -37,6 +42,11 @@ RSpec.describe AddressFinder do
         expect(AddressFinder::V2::Au::Verification).to receive_message_chain(:new, :perform, :result)
         subject
       end
+
+      it "safely passes arguments through" do
+        stub_request(:get, Addressable::Template.new("https://api.addressfinder.io/api/au/address/v2/verification{?args*}")).to_return(:status => 200, :body => "{}", :headers => {})
+        subject
+      end
     end
   end
 
@@ -61,4 +71,24 @@ RSpec.describe AddressFinder do
       end
     end
   end
+
+  context "#email_verification" do
+    subject(:verification) { AddressFinder.email_verification(args) }
+    let(:args){ {email: "john.doe@addressfinder.com"} }
+
+    it "calls the email verification class" do
+      expect(AddressFinder::V1::Email::Verification).to receive_message_chain(:new, :perform, :result)
+      subject
+    end
+  end
+
+  context "#phone_verification" do
+    subject(:verification) { AddressFinder.phone_verification(args) }
+    let(:args){ {phone_number: "1800 152 363", default_country_code: "AU"} }
+
+    it "calls the phone verification class" do
+      expect(AddressFinder::V1::Phone::Verification).to receive_message_chain(:new, :perform, :result)
+      subject
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: addressfinder
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Nigel Ramsay
@@ -9,10 +9,10 @@ authors:
 - Sean Arnold
 - Alexandre Barret
 - Cassandre Guinut
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-21 00:00:00.000000000 Z
+date: 2023-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -109,6 +109,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -131,6 +132,9 @@ files:
 - lib/addressfinder/location_info.rb
 - lib/addressfinder/location_search.rb
 - lib/addressfinder/util.rb
+- lib/addressfinder/v1/base.rb
+- lib/addressfinder/v1/email/verification.rb
+- lib/addressfinder/v1/phone/verification.rb
 - lib/addressfinder/v2/au/verification.rb
 - lib/addressfinder/verification.rb
 - lib/addressfinder/version.rb
@@ -141,6 +145,8 @@ files:
 - spec/lib/addressfinder/location_info_spec.rb
 - spec/lib/addressfinder/location_search_spec.rb
 - spec/lib/addressfinder/util_spec.rb
+- spec/lib/addressfinder/v1/email/verification_spec.rb
+- spec/lib/addressfinder/v1/phone/verification_spec.rb
 - spec/lib/addressfinder/v2/au/verification_spec.rb
 - spec/lib/addressfinder/verification_spec.rb
 - spec/lib/addressfinder_spec.rb
@@ -149,7 +155,7 @@ homepage: https://github.com/AddressFinder/addressfinder-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Provides easy access to AddressFinder APIs
 test_files:
@@ -176,6 +182,8 @@ test_files:
 - spec/lib/addressfinder/location_info_spec.rb
 - spec/lib/addressfinder/location_search_spec.rb
 - spec/lib/addressfinder/util_spec.rb
+- spec/lib/addressfinder/v1/email/verification_spec.rb
+- spec/lib/addressfinder/v1/phone/verification_spec.rb
 - spec/lib/addressfinder/v2/au/verification_spec.rb
 - spec/lib/addressfinder/verification_spec.rb
 - spec/lib/addressfinder_spec.rb