addressfinder 1.7.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2191b3d7090b6eb2c2001f080427cc917c5af00262520c907b401a2a3d7c82e
-  data.tar.gz: bd35444c4cb2a31a47130ded4dae80596718a4d6998006ffc34b92512cf729dd
+  metadata.gz: bac347ed1fa4ee45f7ff1bdc3f5fdc5bee74206fa73b1fe4d33be727f21c1b41
+  data.tar.gz: 44e72444624d652a166089b6c630fb739d47f77155dfaed2e8a27b88afa7bf59
 SHA512:
-  metadata.gz: '08384b27d66dd5397f8e07dc550b86ea0befa4eaae6f8f294dcb8f01e4372739bebfe0484a6874fd0f3f05b6f19ed21108e7923fd8416379532d5b799bb5c60f'
-  data.tar.gz: aadab0cc138ef723af46bd2e6baf1ac6571f51ecaba2dcfa2aedd34ff44b3a5c44b78f39ca5c2828edea29ae3329f1e22ec8ddfdc787482c24142202ece4b749
+  metadata.gz: 180b47e4aa74a5b09c312cc6be655bca62f9f4293f68b7c2505370dbdf2f14c2a48bf71d6523fbe1cf991bcf078745f62ba9d9f9b4e7cebdabd9b38900e111ee
+  data.tar.gz: 7396a52596c09359dbd3cb2facaafe6d4af4b4887be6d0c12b9de8770441ca45055bace9b4665af649793c0f482f39125b59df0e377f75c61e6380578ab258e1

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# AddressFinder 1.9.0 (July 2022) #
+
+* Add support for Ruby 3.x
+* Update gem dependencies
+
+# AddressFinder 1.8.1 (October 2021) #
+
+* Prevent NZ bulk and verification calls from using V2 module
+
+# AddressFinder 1.8.0 (October 2021) #
+
+* Create a V2 Module for verification (Australia)
+* Remove PAF support from V1 verification API (Australia)
+* Include API version number in configuration
+
 # AddressFinder 1.7.1 (June 2, 2021) #
 
 * Add support for PAF verification

data/Dockerfile

@@ -1,5 +1,5 @@
-# Use the barebones version of Ruby 2.6.1
-FROM ruby:2.6
+# Use the barebones version of Ruby 2.7.x
+FROM ruby:2.7
 
 # Install dependencies:
 # - build-essential: To ensure certain gems can be compiled

data/README.md

@@ -31,6 +31,7 @@ AddressFinder.configure do |af|
 
   # Optional
   af.default_country = 'nz' # default: nz
+  af.verification_version = 'v2' # default: v1
   af.timeout = 10 # default: 10 seconds
   af.retries = 12 # default: 12
   af.retry_delay = 5 # default: 5 seconds

data/addressfinder.gemspec

@@ -2,25 +2,25 @@
 require File.expand_path('../lib/addressfinder/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.name          = "addressfinder"
+  gem.name          = 'addressfinder'
   gem.version       = AddressFinder::VERSION
   gem.licenses      = ['MIT']
-  gem.authors       = ["Nigel Ramsay", "Naiki Pohe", "Sean Arnold", "Alexandre Barret", "Cassandre Guinut"]
-  gem.email         = ["nigel.ramsay@addressfinder.nz", "naiki.pohe@abletech.co.nz", "seanarnie@gmail.com", "alex@abletech.nz", "cassandre.guinut@addressfinder.nz"]
-  gem.description   = %q{Ruby client library for AddressFinder}
-  gem.summary       = %q{Provides easy access to AddressFinder APIs}
-  gem.homepage      = "https://github.com/AddressFinder/addressfinder-ruby"
+  gem.authors       = ['Nigel Ramsay', 'Naiki Pohe', 'Sean Arnold', 'Alexandre Barret', 'Cassandre Guinut']
+  gem.email         = ['nigel.ramsay@addressfinder.nz', 'naiki.pohe@abletech.co.nz', 'seanarnie@gmail.com', 'alex@abletech.nz', 'cassandre.guinut@addressfinder.nz']
+  gem.description   = 'Ruby client library for AddressFinder'
+  gem.summary       = 'Provides easy access to AddressFinder APIs'
+  gem.homepage      = 'https://github.com/AddressFinder/addressfinder-ruby'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
-  gem.required_ruby_version = '~> 2.1'
-  gem.add_dependency 'multi_json', '~> 1.11'
-  gem.add_development_dependency 'rspec', '~> 3.3'
-  gem.add_development_dependency 'guard-rspec', '~> 4.6'
+  gem.required_ruby_version = '>= 2.1'
+  gem.add_dependency 'multi_json', '~> 1.15'
+  gem.add_development_dependency 'guard-rspec', '~> 4.7'
+  gem.add_development_dependency 'listen', '~> 3.7'
   gem.add_development_dependency 'rake', '~> 13.0'
+  gem.add_development_dependency 'rspec', '~> 3.11'
   gem.add_development_dependency 'webmock', '~> 1.21'
-  gem.add_development_dependency 'listen', '~> 3.2'
 end

data/lib/addressfinder/bulk.rb

@@ -1,36 +1,44 @@
 module AddressFinder
   class Bulk
-    def initialize(http:, &block)
+    def initialize(http:, verification_version:, default_country:, &block)
       @block = block
+      @verification_version = verification_version
+      @default_country = default_country
       @http_config = http
     end
 
     def perform
       http_config.start do |http|
-        block.call ClientProxy.new(http: http)
+        block.call ClientProxy.new(http: http, verification_version: verification_version, default_country: default_country)
       end
     end
 
     private
 
-    attr_reader :block, :http_config
+    attr_reader :block, :verification_version, :default_country, :http_config
 
     class ClientProxy
-      def initialize(http:)
+      def initialize(http:, verification_version:, default_country:)
+        @verification_version = verification_version
+        @default_country = default_country
         @http = http
       end
 
       def cleanse(args={})
-        AddressFinder::Verification.new(args.merge(http: http)).perform.result
+        AddressFinder::Verification.new(**args.merge(http: http)).perform.result
       end
 
       def verification(args={})
-        AddressFinder::Verification.new(args.merge(http: http)).perform.result
+        if verification_version&.downcase == "v2" && (args[:country] || default_country) == 'au'
+          AddressFinder::V2::Au::Verification.new(**args.merge(http: http)).perform.result
+        else
+          AddressFinder::Verification.new(**args.merge(http: http)).perform.result
+        end
       end
 
       private
 
-      attr_reader :http
+      attr_reader :http, :verification_version, :default_country
     end
   end
 end

data/lib/addressfinder/configuration.rb

@@ -2,6 +2,7 @@ module AddressFinder
   class Configuration
     attr_accessor :api_key
     attr_accessor :api_secret
+    attr_accessor :verification_version
     attr_accessor :hostname
     attr_accessor :port
     attr_accessor :proxy_host
@@ -21,6 +22,7 @@ module AddressFinder
       self.retries = 12
       self.retry_delay = 5
       self.default_country = 'nz'
+      self.verification_version = 'v1'
     end
   end
 end

data/lib/addressfinder/v2/au/verification.rb

@@ -0,0 +1,96 @@
+require 'ostruct'
+
+module AddressFinder
+  module V2
+    module Au
+      class Verification
+
+        attr_reader :result
+
+        # V2 AU expected attributes:
+        # params[:q] --> the address query,
+        # params[:post_box] --> nil or '0'
+        # params[:census] --> '2011' or '2016' or nil,
+        # params[:domain] --> used for reporting does not affect query results
+        # params[:key] --> unique AddressFinder public key
+        # params[:secret] --> unique AddressFinder secret key
+        # params[:paf] --> nil or '1',
+        # params[:gnaf] --> nil or '1',
+        # params[:gps] --> nil or '1',
+        # params[:extended] --> nil or '1',
+        # params[:state_codes] --> string or array of strings: i.e.,['ACT', 'NSW'],
+        def initialize(q:, post_box: nil, census: nil, domain: nil, key: nil, secret: nil, paf: nil, gnaf: nil, gps: nil, state_codes: nil, extended: nil, http:, country: nil)
+          @params = {}
+          @params['q'] = q
+          @params['post_box'] = post_box if post_box
+          @params['census'] = census if census
+          @params['domain'] = domain || config.domain if (domain || config.domain)
+          @params['key'] = key || config.api_key
+          @params['secret'] = secret || config.api_secret
+          @params['paf'] = paf if paf
+          @params['gnaf'] = gnaf if gnaf
+          @params['gps'] = gps if gps
+          @params['extended'] = extended if extended
+          @params['state_codes'] = state_codes if state_codes
+
+          @params['format'] = 'json'
+          @http = http
+        end
+
+        def perform
+          build_request
+          execute_request
+          build_result
+
+          self
+        end
+
+        private
+
+        attr_reader :request_uri, :params, :http
+        attr_accessor :response_body, :response_status
+        attr_writer :result
+
+        def build_request
+          @request_uri = "/api/au/address/v2/verification?#{encoded_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
+          if response_status != '200'
+            raise AddressFinder::RequestRejectedError.new(@response_status, @response_body)
+          end
+
+          if response_hash['matched']
+            self.result = Result.new(response_hash['address'] || response_hash)
+          else
+            self.result = nil
+          end
+        end
+
+        def encoded_params
+          Util.encode_and_join_params(params)
+        end
+
+        def response_hash
+          @_response_hash ||= MultiJson.load(response_body)
+        end
+
+        def config
+          @_config ||= AddressFinder.configuration
+        end
+
+        class Result < OpenStruct
+        end
+      end
+    end
+end
+end

data/lib/addressfinder/verification.rb

@@ -5,21 +5,40 @@ module AddressFinder
 
     attr_reader :result
 
-    def initialize(q:, country: nil, delivered: nil, post_box: nil, paf: nil, rural: nil, region_code: nil, state_codes: nil, census: nil, domain: nil, key: nil, secret: nil, http:)
+    # AU V1 expected attributes:
+    # params[:state_codes] --> string or array of strings: i.e.,['ACT', 'NSW'],
+    # params[:census] --> '2011' or '2016' or nil,
+
+    # NZ expected attributes:
+    # params[:delivered] --> '0', '1', or nil,
+    # params[:post_box] --> '0', '1', or nil,
+    # params[:rural] --> '0', '1', or nil,
+    # params[:region_code] --> string, see options on addressfinder.nz or nil,
+    # params[:census] --> '2013', '2018' or nil
+
+    # Combined attributes
+    # params[:q] --> the address query,
+    # params[:domain] --> used for reporting does not affect query results
+    # params[:key] --> unique AddressFinder public key
+    # params[:secret] --> unique AddressFinder secret key
+    def initialize(q:, post_box: nil, census: nil, domain: nil, key: nil, secret: nil, state_codes: nil, delivered: nil, rural: nil, region_code: nil, country: nil, http:)
       @params = {}
+      # Common to AU and NZ
       @params['q'] = q
-      @params['delivered'] = delivered if delivered
       @params['post_box'] = post_box if post_box
-      @params['paf'] = paf if paf
-      @params['rural'] = rural if rural
-      @params['region_code'] = region_code if region_code
-      @params['state_codes'] = state_codes if state_codes
       @params['census'] = census if census
       @params['domain'] = domain || config.domain if (domain || config.domain)
-      @params['format'] = 'json'
       @params['key'] = key || config.api_key
       @params['secret'] = secret || config.api_secret
+      # AU params
+      @params['state_codes'] = state_codes if state_codes
+      # NZ params
+      @params['delivered'] = delivered if delivered
+      @params['rural'] = rural if rural
+      @params['region_code'] = region_code if region_code
       @country = country || config.default_country
+
+      @params['format'] = 'json'
       @http = http
     end
 

data/lib/addressfinder/version.rb

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

data/lib/addressfinder.rb

@@ -2,6 +2,7 @@ require 'multi_json'
 require 'addressfinder/version'
 require 'addressfinder/configuration'
 require 'addressfinder/verification'
+require 'addressfinder/v2/au/verification'
 require 'addressfinder/location_info'
 require 'addressfinder/location_search'
 require 'addressfinder/address_info'
@@ -33,7 +34,11 @@ module AddressFinder
     end
 
     def verification(args={})
-      AddressFinder::Verification.new(args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
+      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
 
     def location_search(args={})
@@ -57,7 +62,7 @@ module AddressFinder
     end
 
     def bulk(&block)
-      AddressFinder::Bulk.new(http: AddressFinder::HTTP.new(configuration), &block).perform
+      AddressFinder::Bulk.new(http: AddressFinder::HTTP.new(configuration), verification_version: configuration.verification_version, default_country: configuration.default_country, &block).perform
     end
   end
 end

data/spec/lib/addressfinder/bulk_spec.rb

@@ -38,7 +38,31 @@ RSpec.describe AddressFinder::Bulk 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, &block).perform
+        AddressFinder::Bulk.new(http: http, verification_version: 'v2', default_country: 'au', &block).perform
+      end
+
+      it "calls the correct class with v2 verification and au 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::V2::Au::Verification).to receive(:new).exactly(3).times.and_call_original
+        AddressFinder::Bulk.new(http: http, verification_version: 'v2', default_country: 'au', &block).perform
+      end
+
+      it "calls the correct class with v2 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::Verification).to receive(:new).exactly(3).times.and_call_original
+        AddressFinder::Bulk.new(http: http, verification_version: 'v2', default_country: 'nz', &block).perform
+      end
+
+      it "calls the correct class without a verification version" 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::Verification).to receive(:new).exactly(3).times.and_call_original
+        AddressFinder::Bulk.new(http: http, verification_version: nil, default_country: 'au', &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
@@ -50,7 +74,7 @@ RSpec.describe AddressFinder::Bulk do
         expect(net_http).to receive(:transport_request).once.and_raise(SocketError) # Retry 2 Willis (error)
         expect(net_http).to receive(:transport_request).exactly(2).and_return(response) # Retry 2 Willis (success) & 3 Willis (success)
         expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
-        AddressFinder::Bulk.new(http: http, &block).perform
+        AddressFinder::Bulk.new(http: http, verification_version: 'v2', default_country: 'au', &block).perform
       end
     end
 
@@ -66,7 +90,25 @@ RSpec.describe AddressFinder::Bulk do
         expect(net_http).to receive(:do_start).once.and_call_original
         expect(net_http).to receive(:transport_request).once.and_return(response)
         expect(net_http).to receive(:do_finish).once.and_call_original
-        AddressFinder::Bulk.new(http: http, &block).perform
+        expect(AddressFinder::Verification).to receive(:new).exactly(1).times.and_call_original
+        AddressFinder::Bulk.new(http: http, verification_version: nil, default_country: 'au', &block).perform
+      end
+    end
+
+    context "with a country override and v2 in the config" do
+      let(:response){ double(:response, body: %Q({"success": true}), code: "200") }
+      let(:block){
+        Proc.new do |proxy|
+          proxy.verification(q: "1 Willis", country: "au")
+        end
+      }
+
+      it "has the same behaviour as the verification method" do
+        expect(net_http).to receive(:do_start).once.and_call_original
+        expect(net_http).to receive(:transport_request).once.and_return(response)
+        expect(net_http).to receive(:do_finish).once.and_call_original
+        expect(AddressFinder::V2::Au::Verification).to receive(:new).exactly(1).times.and_call_original
+        AddressFinder::Bulk.new(http: http, verification_version: "v2", default_country: 'nz', &block).perform
       end
     end
   end

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

@@ -0,0 +1,187 @@
+require 'spec_helper'
+
+RSpec.describe AddressFinder::V2::Au::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::V2::Au::Verification.new(**args) }
+  let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
+  let(:net_http){ http.send(:net_http) }
+
+  describe '#execute_request' do
+    let(:args){ {q: "186 Willis Street", 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 minimal arguments' do
+      let(:args){ {q: '186 willis st', http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&key=XXX&secret=YYY&format=json') }
+    end
+
+    context 'with more arguments' do
+      let(:args){ {q: '186 willis st', census: '2011', http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&census=2011&key=XXX&secret=YYY&format=json') }
+    end
+
+    context 'with a state codes as an array' do
+      let(:args){ {q: '186 willis st', state_codes: ['ACT','NSW'], http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&key=XXX&secret=YYY&state_codes[]=ACT&state_codes[]=NSW&format=json') }
+    end
+
+    context 'with a reserved character in the query' do
+      let(:args){ {q: '186=willis st', state_codes: ['ACT','NSW'], http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186%3Dwillis+st&key=XXX&secret=YYY&state_codes[]=ACT&state_codes[]=NSW&format=json') }
+    end
+
+    context 'with a state codes as a string' do
+      let(:args){ {q: '186 willis st', state_codes: 'ACT,NSW', http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&key=XXX&secret=YYY&state_codes=ACT%2CNSW&format=json') }
+    end
+
+    context 'with a key override' do
+      let(:args){ {q: '186 willis st', key: 'AAA', http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&key=AAA&secret=YYY&format=json') }
+    end
+
+    context 'with a secret override' do
+      let(:args){ {q: '186 willis st', secret: 'BBB', http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&key=XXX&secret=BBB&format=json') }
+    end
+
+    context 'with a domain given' do
+      let(:args){ {q: '123', domain: 'testdomain.com', http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/v2/verification?q=123&domain=testdomain.com&key=XXX&secret=YYY&format=json') }
+
+      context 'given in the AF configuration' do
+
+        let(:args){ {q: '123', http: http} }
+
+        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')
+          AddressFinder.configuration.domain = nil # set back to nil after
+        end
+      end
+    end
+
+    context 'with a post_box exclusion' do
+      let(:args){ {q: '186 willis st', post_box: '0', http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&post_box=0&key=XXX&secret=YYY&format=json') }
+    end
+
+    context 'with a gnaf request' do
+      let(:args){ {q: '186 willis st', gnaf: '1', http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&key=XXX&secret=YYY&gnaf=1&format=json') }
+    end
+
+    context 'with a paf request' do
+      let(:args){ {q: '186 willis st', paf: '1', http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&key=XXX&secret=YYY&paf=1&format=json') }
+    end
+
+    context 'with a all args included request' do
+      let(:args){ {q: '186 willis st', paf: '1', gnaf:'1', post_box:'0', state_codes:'ACT', census: '2016', domain: 'mysite.com', gps: '1', extended: '1', http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&post_box=0&census=2016&domain=mysite.com&key=XXX&secret=YYY&paf=1&gnaf=1&gps=1&extended=1&state_codes=ACT&format=json') }
+    end
+  end
+
+  describe '#build_result' do
+    let(:args){ {q: '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 nz result' do
+      let(:body){ '{"matched": true, "postal_address": "Texas"}' }
+      let(:status){ '200' }
+
+      it { expect(result.class).to eq(AddressFinder::V2::Au::Verification::Result) }
+
+      it { expect(result.matched).to eq(true) }
+
+      it { expect(result.postal_address).to eq("Texas") }
+    end
+
+    context 'with a successful au result' do
+      let(:body){ %Q({"matched": true, "success": true, "address": {"full_address": "Texas"}}) }
+      let(:status){ '200' }
+
+      it { expect(result.class).to eq(AddressFinder::V2::Au::Verification::Result) }
+
+      it { expect(result.full_address).to eq("Texas") }
+    end
+
+    context 'with an unfound result' do
+      let(:body){ '{"matched": false}' }
+      let(:status){ '200' }
+
+      it { expect(result).to eq(nil) }
+    end
+  end
+end

data/spec/lib/addressfinder/verification_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe AddressFinder::Verification do
     end
   end
 
-  let(:verification_module){ AddressFinder::Verification.new(args) }
+  let(:verification_module){ AddressFinder::Verification.new(**args) }
   let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
   let(:net_http){ http.send(:net_http) }
 
@@ -67,55 +67,55 @@ RSpec.describe AddressFinder::Verification do
     context 'with minimal arguments' do
       let(:args){ {q: '186 willis st', http: http} }
 
-      it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&format=json&key=XXX&secret=YYY') }
+      it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&key=XXX&secret=YYY&format=json') }
     end
 
     context 'with more arguments' do
-      let(:args){ {q: '186 willis st', delivered: true, region_code: 'A', paf: '1', census: '2013', http: http} }
+      let(:args){ {q: '186 willis st', delivered: true, region_code: 'A', census: '2013', http: http} }
 
-      it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&delivered=true&paf=1&region_code=A&census=2013&format=json&key=XXX&secret=YYY') }
+      it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&census=2013&key=XXX&secret=YYY&delivered=true&region_code=A&format=json') }
     end
 
     context 'with a country override' do
       let(:args){ {q: '186 willis st', country: 'au', http: http} }
 
-      it { expect(request_uri).to eq('/api/au/address/verification?q=186+willis+st&format=json&key=XXX&secret=YYY') }
+      it { expect(request_uri).to eq('/api/au/address/verification?q=186+willis+st&key=XXX&secret=YYY&format=json') }
     end
 
     context 'with a state codes as an array' do
       let(:args){ {q: '186 willis st', country: 'au', state_codes: ['ACT','NSW'], http: http} }
 
-      it { expect(request_uri).to eq('/api/au/address/verification?q=186+willis+st&state_codes[]=ACT&state_codes[]=NSW&format=json&key=XXX&secret=YYY') }
+      it { expect(request_uri).to eq('/api/au/address/verification?q=186+willis+st&key=XXX&secret=YYY&state_codes[]=ACT&state_codes[]=NSW&format=json') }
     end
 
     context 'with a reserved character in the query' do
       let(:args){ {q: '186=willis st', country: 'au', state_codes: ['ACT','NSW'], http: http} }
 
-      it { expect(request_uri).to eq('/api/au/address/verification?q=186%3Dwillis+st&state_codes[]=ACT&state_codes[]=NSW&format=json&key=XXX&secret=YYY') }
+      it { expect(request_uri).to eq('/api/au/address/verification?q=186%3Dwillis+st&key=XXX&secret=YYY&state_codes[]=ACT&state_codes[]=NSW&format=json') }
     end
 
     context 'with a state codes as a string' do
       let(:args){ {q: '186 willis st', country: 'au', state_codes: 'ACT,NSW', http: http} }
 
-      it { expect(request_uri).to eq('/api/au/address/verification?q=186+willis+st&state_codes=ACT%2CNSW&format=json&key=XXX&secret=YYY') }
+      it { expect(request_uri).to eq('/api/au/address/verification?q=186+willis+st&key=XXX&secret=YYY&state_codes=ACT%2CNSW&format=json') }
     end
 
     context 'with a key override' do
       let(:args){ {q: '186 willis st', key: 'AAA', http: http} }
 
-      it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&format=json&key=AAA&secret=YYY') }
+      it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&key=AAA&secret=YYY&format=json') }
     end
 
     context 'with a secret override' do
       let(:args){ {q: '186 willis st', secret: 'BBB', http: http} }
 
-      it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&format=json&key=XXX&secret=BBB') }
+      it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&key=XXX&secret=BBB&format=json') }
     end
 
     context 'with a domain given' do
       let(:args){ {q: '123', domain: 'testdomain.com', http: http} }
 
-      it { expect(request_uri).to eq('/api/nz/address/verification?q=123&domain=testdomain.com&format=json&key=XXX&secret=YYY') }
+      it { expect(request_uri).to eq('/api/nz/address/verification?q=123&domain=testdomain.com&key=XXX&secret=YYY&format=json') }
 
       context 'given in the AF configuration' do
 
@@ -123,7 +123,7 @@ RSpec.describe AddressFinder::Verification do
 
         it 'should use the config domain if set' do
           AddressFinder.configuration.domain = 'anotherdomain.com'
-          expect(request_uri).to eq('/api/nz/address/verification?q=123&domain=anotherdomain.com&format=json&key=XXX&secret=YYY')
+          expect(request_uri).to eq('/api/nz/address/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

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'fileutils'
+
+RSpec.describe AddressFinder do
+  before do
+    AddressFinder.configure do |af|
+      af.api_key = 'XXX'
+      af.api_secret = 'YYY'
+      af.default_country = 'nz'
+      af.timeout = 5
+      af.retries = 5
+    end
+  end
+
+  describe '#verification with verification_version configured to "v2"' do
+    before do
+      AddressFinder.configuration.verification_version = "v2"
+    end
+
+    after do
+      AddressFinder.configuration.verification_version = nil # set back to nil after
+    end
+
+    subject(:verification){ AddressFinder.verification(args) }
+
+    context "with country set to nz" do
+      let(:args){ {country: "nz", q: "12 high street sydney"} }
+      it "calls the old class" do
+        expect(AddressFinder::Verification).to receive_message_chain(:new, :perform, :result)
+        subject
+      end
+    end
+
+    context "with country set to au" do
+      let(:args){ {country: "au", q: "12 high street sydney"} }
+      it "calls the v2::Au class" do
+        expect(AddressFinder::V2::Au::Verification).to receive_message_chain(:new, :perform, :result)
+        subject
+      end
+    end
+  end
+
+  describe '#verification with verification_version not configured' do
+    subject(:verification){ AddressFinder.verification(args) }
+
+    context "with country set to nz" do
+      let(:args){ {country: "nz", q: "12 high street sydney"} }
+
+      it "calls the old class" do
+        expect(AddressFinder::Verification).to receive_message_chain(:new, :perform, :result)
+        subject
+      end
+    end
+
+    context "with country set to au" do
+      let(:args){ {country: "au", q: "12 high street sydney"} }
+
+      it "calls the old class" do
+        expect(AddressFinder::Verification).to receive_message_chain(:new, :perform, :result)
+        subject
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -12,6 +12,9 @@ require 'addressfinder'
 
 RSpec.configure do |config|
   config.mock_with :rspec
+
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
 end
 
 WebMock.disable_net_connect!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: addressfinder
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Nigel Ramsay
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-02 00:00:00.000000000 Z
+date: 2022-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -20,42 +20,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -71,33 +71,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
-  name: listen
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '1.21'
 description: Ruby client library for AddressFinder
 email:
 - nigel.ramsay@addressfinder.nz
@@ -131,6 +131,7 @@ files:
 - lib/addressfinder/location_info.rb
 - lib/addressfinder/location_search.rb
 - lib/addressfinder/util.rb
+- lib/addressfinder/v2/au/verification.rb
 - lib/addressfinder/verification.rb
 - lib/addressfinder/version.rb
 - spec/lib/addressfinder/address_autocomplete_spec.rb
@@ -140,7 +141,9 @@ files:
 - spec/lib/addressfinder/location_info_spec.rb
 - spec/lib/addressfinder/location_search_spec.rb
 - spec/lib/addressfinder/util_spec.rb
+- spec/lib/addressfinder/v2/au/verification_spec.rb
 - spec/lib/addressfinder/verification_spec.rb
+- spec/lib/addressfinder_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/AddressFinder/addressfinder-ruby
 licenses:
@@ -152,7 +155,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -161,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Provides easy access to AddressFinder APIs
@@ -173,5 +176,7 @@ 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/v2/au/verification_spec.rb
 - spec/lib/addressfinder/verification_spec.rb
+- spec/lib/addressfinder_spec.rb
 - spec/spec_helper.rb