addressfinder 1.11.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46f5a02e06b4bdc77c39d7b925ac71f901572519461ce39f9d60a89ce7e1643c
-  data.tar.gz: 72415086c4e0e7b200f12727616b68a9604b559318759e98d3b431f71ca5407a
+  metadata.gz: 8e9d77bd22770090ef74d02d1b2135dd3504130442b4a5dfd0de17b90661c468
+  data.tar.gz: 91f162b6b301ff9f86c3253f8a37c89c5d5f9f8781dd8e674f49a8f6624cd2ff
 SHA512:
-  metadata.gz: 6936156c02c1ed2996aabd83da48d5ac3952fb4ad65c06a4403be957139f9b2dc87146cc9e685b2669c91bba4f96f7dd7b0a7611d481a3628455602d7c1b97ce
-  data.tar.gz: 46540a8561ef184f0a8b092123166a078ccde5875b30f8688df7f5c98f2c45c5c72bbbf43a59913d59bcf1c946b6d66bc5bcdb141ae941825d7068290a847d35
+  metadata.gz: 076b5eb2c9d1200713f7952a631b70852071db5e31321c89c31264b134fd2e4ebb8e40f5820fa97fb9a4c3b43fa0c71b714c656018458a6aa02d5e0d92c20ae6
+  data.tar.gz: 651f98846af6d9d31ab6cb135775f6e0cae3855e8d6031aeef342e1a4d7983bd3389432123bd4b7b01b207029632e325fbb73c703e15ba27da2a471e5099a40d

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# Addressfinder 1.13.0 (September 2024) #
+
+* Add client agent versioning
+
+# Addressfinder 1.12.0 (May 2024) #
+
+* Add a batch capability with concurrency for Address Verification
+* Include a demo that shows address verification of a CSV file
+
 # Addressfinder 1.11.0 (May 2024) #
 
 * Add a batch capability with concurrency for Email Verification

data/README.md

@@ -54,21 +54,75 @@ end
 For available parameters and example responses, see the API documentation pages for [New Zealand](https://addressfinder.nz/docs?utm_source=github&utm_medium=readme&utm_campaign=addressfinder_rubygem&utm_term=New%20Zealand) or [Australia](https://addressfinder.com.au/docs?utm_source=github&utm_medium=readme&utm_campaign=addressfinder_rubygem&utm_term=Australia).
 
 
-#### Address Verification
+### Address Verification
+
+#### New Zealand addresses
+
+To verify a single New Zealand address, use the following method:
+
+```ruby
+result = AddressFinder.address_verification(q: "186 Willis St, Wellington", country: "nz")
+
+if result
+  $stdout.puts "Success: '#{result.a}'"
+else
+  $stdout.puts "Sorry, can't find that address"
+end
+```
+
+You can also verify a batch of New Zealand addresses using the following method. 
+We suggest that you send up to 100 addresses in each batch. 
+
+```ruby
+addresses = ["186 Willis St, Wellington", "1 Ghuznee St, Te Aro, Wellington 6011", "bad address"]
+
+results = AddressFinder.address_verification_nz_batch(addresses: addresses, concurrency: 10)
+
+results.each_with_index do |result, index|
+  if result
+    $stdout.puts "Success: matched '#{addresses[index]}' with '#{result.a}'"
+  else
+    $stdout.puts "Sorry, can't find address: '#{addresses[index]}'"
+  end
+end
+```
+
+There is a demo of processing a CSV file of sample New Zealand address in the [/demo/batch](/demo/verification/) folder. 
+
+#### Australian addresses
+
+To verify a single Australian address, use the following method:
 
 ```ruby
-result = AddressFinder.verification(q: '186 Willis St, Wellington', country: 'nz')
+result = AddressFinder.address_verification(q: '10/274 Harbour Drive, Coffs Harbour NSW 2450', gnaf: "1", country: 'au')
 
 if result
-  $stdout.puts "Success: #{result.postal}"
+  $stdout.puts "Success: #{result.full_address}"
 else
   $stdout.puts "Sorry, can't find that address"
 end
 ```
 
-**Note:** The deprecated method `cleanse` is still available now but will be dropped in the future.
+You can also verify a batch of Australian addresses using the following method:
+We suggest that you send up to 100 addresses in each batch. 
+
+```ruby
+addresses = ["10/274 Harbour Drive, Coffs Harbour NSW 2450", "49 CORNISH ST, COBAR NSW 2835", "bad address"]
+
+results = AddressFinder.address_verification_au_batch(addresses: addresses, gnaf: "1", concurrency: 10)
+
+results.each_with_index do |result, index|
+  if result
+    $stdout.puts "Success: matched '#{addresses[index]}' with '#{result.a}'"
+  else
+    $stdout.puts "Sorry, can't find address: '#{addresses[index]}'"
+  end
+end
+```
+
+There is a demo of processing a CSV file of sample Australian address in the [/demo/batch](/demo/verification/) folder. 
 
-#### Address Search
+### Address Search
 
 The Address Search API supports the following address sets:
 
@@ -89,7 +143,7 @@ rescue AddressFinder::RequestRejectedError => e
 end
 ```
 
-#### Address Autocomplete
+### Address Autocomplete
 
 The Address Autocomplete API supports the following address sets:
 
@@ -109,7 +163,7 @@ rescue AddressFinder::RequestRejectedError => e
 end
 ```
 
-#### Address Metadata
+### Address Metadata
 
 ```ruby
 begin
@@ -125,7 +179,7 @@ rescue AddressFinder::RequestRejectedError => e
 end
 ```
 
-#### Location Autocomplete
+### Location Autocomplete
 
 ```ruby
 begin
@@ -141,7 +195,7 @@ rescue AddressFinder::RequestRejectedError => e
 end
 ```
 
-#### Location Metadata
+### Location Metadata
 
 ```ruby
 begin
@@ -157,7 +211,7 @@ rescue AddressFinder::RequestRejectedError => e
 end
 ```
 
-#### Email Verification
+### Email Verification
 
 This example shows how to request verification of a single email address. 
 
@@ -191,7 +245,7 @@ end
 The emails will be verified concurrently, and returned in the same order in 
 which they were provided.
 
-#### Phone Verification
+### Phone Verification
 
 ```ruby
 begin
@@ -205,29 +259,7 @@ end
 
 ## Advanced Usage
 
-#### Bulk Operations
-
-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, Email Verification and Phone Verification (`#verification`, `#email_verification`, `#phone_verifiction`).
-
-```ruby
-AddressFinder.bulk do |af|
-  CSV.foreach('auckland_addresses.csv') do |row|
-    result = af.verification(q: row[0], region_code: '1')
-
-    if result
-      $stdout.puts "Success: #{result.postal}"
-    else
-      $stdout.puts "Sorry, can't find that address"
-    end
-  end
-end
-```
-
-
-#### Key and Secret override
+### Key and Secret override
 
 What if you want to use another account for a specific query? You can override the `api_key` and `api_secret`.
 
@@ -245,7 +277,7 @@ rescue AddressFinder::RequestRejectedError => e
 end
 ```
 
-### Testing
+## Testing
 
 You can run all the specs with the following command:
 

data/demo/verification/README.md

@@ -0,0 +1,68 @@
+# Address Verification demo using the batch functions
+
+In this folder there are two Ruby scripts that demonstrate how to use the 
+address verification functions for New Zealand and Australia. These functions
+seek to process a CSV file of sample addresses, and generate a CSV stream on
+standard output. 
+
+## Usage instructions
+
+``` 
+bundle exec ruby process_nz_address_csv.rb <input-file.csv>
+```
+
+or 
+
+``` 
+bundle exec ruby process_au_address_csv.rb <input-file.csv>
+```
+
+We have provided two sample CSV files for demonstration purposes. The files contain a
+selection of various addresses for each country.  
+
+You will also need to set the following environment variables:
+
+- `AF_KEY` - your API key for accessing the Addressfinder API
+- `AF_SECRET` - the API secret corresponding to your API key
+
+You can obtain an API key by registering for a free trial account at https://addressfinder.com/
+
+## Example execution
+
+Processing a CSV file of New Zealand address records:
+
+```
+> export AF_KEY=XXXXXXXXXXXXXXX
+> export AF_SECRET=YYYYYYYYYYYYYYY
+> bundle exec ruby process_nz_address_csv.rb sample_addresses_nz.csv
+address_id,address_query,address_query_length,full_address,address_id
+1,133 wilton road wilton wellington,33,"133 Wilton Road, Wilton, Wellington 6012",2-.F.1W.v.Torm
+2,1 ghuznee st te aro wellington 6011,35,"1 Ghuznee Street, Te Aro, Wellington 6011",2-2eNwG1oBJExni2nUFJm1cW
+3,40 severne st springlands blemnheim,35,"40 Severne Street, Yelverton, Blenheim 7201",2-.7.7.E.4$2
+4,hahaha,6,"",""
+5,"14 Espin Crescent, Karori, Wellington 6012",42,"14 Espin Crescent, Karori, Wellington 6012",2-.F.1W.J.tx4
+6,"Level 7, 45 Johnston Street, Wellington Central, Wellington 6011",64,"Level 7, 45 Johnston Street, Wellington Central, Wellington 6011",3-.2u
+# ...
+```
+
+Processing a CSV file of Australian address records:
+
+```
+> bundle exec ruby process_au_address_csv.rb sample_addresses_au.csv
+address_id,address_query,address_query_length,full_address,address_id
+1,"10/274 harbour drive, coffs harbour NSW 2450",44,"Unit 10, 274 Harbour Drive, COFFS HARBOUR NSW 2450",670cd8c3-b883-ee24-2874-74440e515b80
+2,"9/274 harbour drive, coffs harbour NSW 2450",43,"Unit 9, 274 Harbour Drive, COFFS HARBOUR NSW 2450",42ae5625-d679-266b-5d66-5ece6bbfb179
+3,"8/274 harbour drive, coffs harbour NSW 2450",43,"Unit 8, 274 Harbour Drive, COFFS HARBOUR NSW 2450",447a0952-c354-80de-712f-e3458f71bf1a
+4,hahaha,6,"",""
+5,"Unit 56, Level C, 12 Limburg Way, GREENWAY ACT 2900",51,"Unit 56, Level C, 12 Limburg Way, GREENWAY ACT 2900",275aa5ff-401e-3cd8-9de9-e9c36eb262cb
+# ...
+```
+
+## Code example
+
+Take close look at the function `process_csv` which manages the reading of the CSV file and the creation of
+each block. In the example, fairly small block sizes are used, but you will likely want to use a larger size
+of around 100 records. 
+
+The `process_block` function is responsible for making the API call and processing the response. The response
+is used to compose each CSV line, which is written to `$stdout`.

data/lib/addressfinder/address_autocomplete.rb

@@ -44,9 +44,7 @@ module AddressFinder
     end
 
     def execute_request
-      request = Net::HTTP::Get.new(request_uri)
-
-      response = http.request(request)
+      response = http.request(request_uri)
 
       self.response_body = response.body
       self.response_status = response.code

data/lib/addressfinder/address_info.rb

@@ -37,9 +37,7 @@ module AddressFinder
     end
 
     def execute_request
-      request = Net::HTTP::Get.new(request_uri)
-
-      response = http.request(request)
+      response = http.request(request_uri)
 
       self.response_body = response.body
       self.response_status = response.code

data/lib/addressfinder/address_search.rb

@@ -37,9 +37,7 @@ module AddressFinder
     end
 
     def execute_request
-      request = Net::HTTP::Get.new(request_uri)
-
-      response = http.request(request)
+      response = http.request(request_uri)
 
       self.response_body = response.body
       self.response_status = response.code

data/lib/addressfinder/configuration.rb

@@ -14,6 +14,7 @@ module AddressFinder
     attr_accessor :domain
     attr_accessor :retries
     attr_accessor :retry_delay
+    attr_accessor :ca
 
     def initialize
       self.hostname = 'api.addressfinder.io'
@@ -23,6 +24,7 @@ module AddressFinder
       self.retry_delay = 5
       self.default_country = 'nz'
       self.verification_version = 'v1'
+      self.ca = "Ruby/#{AddressFinder::VERSION}"
     end
   end
 end

data/lib/addressfinder/http.rb

@@ -15,11 +15,15 @@ module AddressFinder
       end
     end
 
-    def request(args)
+    def request(request_uri)
       retries = 0
       begin
         re_establish_connection if @connection_is_bad
-        net_http.request(args)
+
+        uri = build_uri(request_uri)
+        request = Net::HTTP::Get.new(uri)
+
+        net_http.request(request)
       rescue Net::ReadTimeout, Net::OpenTimeout, SocketError => error
         if retries < config.retries
           retries += 1
@@ -40,6 +44,19 @@ module AddressFinder
       net_http.start
     end
 
+    def build_uri(request_uri)
+      uri = URI(request_uri)
+      encoded_ca = URI.encode_www_form_component(config.ca)
+
+      if uri.query
+        uri.query += "&ca=#{encoded_ca}"
+      else
+        uri.query = "ca=#{encoded_ca}"
+      end
+
+      uri.to_s
+    end
+
     def net_http
       @net_http ||= begin
         http = Net::HTTP.new(config.hostname, config.port, config.proxy_host,

data/lib/addressfinder/location_info.rb

@@ -38,9 +38,7 @@ module AddressFinder
     end
 
     def execute_request
-      request = Net::HTTP::Get.new(request_uri)
-
-      response = http.request(request)
+      response = http.request(request_uri)
 
       self.response_body = response.body
       self.response_status = response.code

data/lib/addressfinder/location_search.rb

@@ -38,9 +38,7 @@ module AddressFinder
     end
 
     def execute_request
-      request = Net::HTTP::Get.new(request_uri)
-
-      response = http.request(request)
+      response = http.request(request_uri)
 
       self.response_body = response.body
       self.response_status = response.code

data/lib/addressfinder/v1/base.rb

@@ -20,12 +20,12 @@ module AddressFinder
         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
@@ -33,20 +33,18 @@ module AddressFinder
       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)
-  
+        response = http.request(request_uri)
+
         self.response_body = response.body
         self.response_status = response.code
       end
-  
+
       def build_result
         case response_status
         when '200'
@@ -55,15 +53,15 @@ module AddressFinder
           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

data/lib/addressfinder/v1/nz/batch_verification.rb

@@ -0,0 +1,70 @@
+module AddressFinder
+  module V1
+    module Nz
+      class BatchVerification
+        attr_reader :addresses, :results
+
+        # Verifies an array of addresses using concurrency to reduce the execution time.
+        #
+        # The results of the verification are stored in the `results` attribute, in the same order
+        # in which they were supplied.
+        #
+        # @param [Array<String>] addresses array of address query strings
+        # @param [AddressFinder::HTTP] http HTTP connection helper
+        # @param [Integer] concurrency How many threads to use for verification
+        # @param [Hash] args Any additional arguments that will be passed onto the Address Verification API
+        def initialize(addresses:, http: nil, concurrency: 2, **args)
+          @addresses = addresses
+          @concurrency = concurrency
+          @http = http
+          @args = args
+        end
+
+        def perform
+          confirm_concurrency_level
+          verify_each_address_concurrently
+
+          self
+        end
+
+        private
+
+        attr_reader :args, :concurrency, :http
+
+        MAX_CONCURRENCY_LEVEL = 5
+
+        def confirm_concurrency_level
+          return unless @concurrency > MAX_CONCURRENCY_LEVEL
+
+          warn "WARNING: Concurrency level of #{@concurrency} is higher than the maximum of #{MAX_CONCURRENCY_LEVEL}. Using #{MAX_CONCURRENCY_LEVEL}."
+          @concurrency = MAX_CONCURRENCY_LEVEL
+        end
+
+        def verify_each_address_concurrently
+          @results = Concurrent::Array.new(addresses.length)
+
+          pool = Concurrent::FixedThreadPool.new(concurrency)
+
+          addresses.each_with_index do |address, index_of_address|
+            # Start a new thread for each task
+            pool.post do
+              verify_address(address, index_of_address)
+            end
+          end
+
+          ## Shutdown the pool and wait for all tasks to complete
+          pool.shutdown
+          pool.wait_for_termination
+        end
+
+        # Verifies a single address, and writes the result into @results
+        def verify_address(address, index_of_address)
+          @results[index_of_address] =
+            AddressFinder::Verification.new(q: address, http: http.clone, **args).perform.result
+        rescue AddressFinder::RequestRejectedError => e
+          @results[index_of_address] = OpenStruct.new(success: false, body: e.body, status: e.status)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module AddressFinder
+  module V2
+    module Au
+      class BatchVerification
+        attr_reader :addresses, :results
+
+        # Verifies an array of addresses using concurrency to reduce the execution time.
+        #
+        # The results of the verification are stored in the `results` attribute, in the same order
+        # in which they were supplied.
+        #
+        # @param [Array<String>] addresses array of address query strings
+        # @param [AddressFinder::HTTP] http HTTP connection helper
+        # @param [Integer] concurrency How many threads to use for verification
+        # @param [Hash] args Any additional arguments that will be passed onto the Address Verification API
+        def initialize(addresses:, http: nil, concurrency: 2, **args)
+          @addresses = addresses
+          @concurrency = concurrency
+          @http = http
+          @args = args
+        end
+
+        def perform
+          confirm_concurrency_level
+          verify_each_address_concurrently
+
+          self
+        end
+
+        private
+
+        attr_reader :args, :concurrency, :http
+
+        MAX_CONCURRENCY_LEVEL = 5
+
+        def confirm_concurrency_level
+          return unless @concurrency > MAX_CONCURRENCY_LEVEL
+
+          warn "WARNING: Concurrency level of #{@concurrency} is higher than the maximum of #{MAX_CONCURRENCY_LEVEL}. Using #{MAX_CONCURRENCY_LEVEL}."
+          @concurrency = MAX_CONCURRENCY_LEVEL
+        end
+
+        def verify_each_address_concurrently
+          @results = Concurrent::Array.new(addresses.length)
+
+          pool = Concurrent::FixedThreadPool.new(concurrency)
+
+          addresses.each_with_index do |address, index_of_address|
+            # Start a new thread for each task
+            pool.post do
+              verify_address(address, index_of_address)
+            end
+          end
+
+          ## Shutdown the pool and wait for all tasks to complete
+          pool.shutdown
+          pool.wait_for_termination
+        end
+
+        # Verifies a single address, and writes the result into @results
+        def verify_address(address, index_of_address)
+          @results[index_of_address] =
+            AddressFinder::V2::Au::Verification.new(q: address, http: http.clone, **args).perform.result
+        rescue AddressFinder::RequestRejectedError => e
+          @results[index_of_address] = OpenStruct.new(success: false, body: e.body, status: e.status)
+        end
+      end
+    end
+  end
+end

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

@@ -1,10 +1,9 @@
-require 'ostruct'
+require "ostruct"
 
 module AddressFinder
   module V2
     module Au
       class Verification
-
         attr_reader :result
 
         # V2 AU expected attributes:
@@ -19,21 +18,22 @@ module AddressFinder
         # 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)
+        def initialize(q:, http:, post_box: nil, census: nil, domain: nil, key: nil, secret: nil, paf: nil, gnaf: nil,
+          gps: nil, state_codes: nil, extended: nil, 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'
+          @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
 
@@ -56,23 +56,17 @@ module AddressFinder
         end
 
         def execute_request
-          request = Net::HTTP::Get.new(request_uri)
-
-          response = http.request(request)
+          response = http.request(request_uri)
 
           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
+          raise AddressFinder::RequestRejectedError.new(@response_status, @response_body) if response_status != "200"
 
-          if response_hash['matched']
-            self.result = Result.new(response_hash['address'] || response_hash)
-          else
-            self.result = nil
+          self.result = if response_hash["matched"]
+            Result.new(response_hash["address"] || response_hash)
           end
         end
 
@@ -92,5 +86,5 @@ module AddressFinder
         end
       end
     end
-end
+  end
 end

data/lib/addressfinder/verification.rb

@@ -1,8 +1,7 @@
-require 'ostruct'
+require "ostruct"
 
 module AddressFinder
   class Verification
-
     attr_reader :result
 
     # AU V1 expected attributes:
@@ -21,24 +20,25 @@ module AddressFinder
     # 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:)
+    def initialize(q:, http:, post_box: nil, census: nil, domain: nil, key: nil, secret: nil, state_codes: nil,
+      delivered: nil, rural: nil, region_code: nil, country: nil)
       @params = {}
       # Common to AU and NZ
-      @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["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
       # AU params
-      @params['state_codes'] = state_codes if state_codes
+      @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
+      @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'
+      @params["format"] = "json"
       @http = http
     end
 
@@ -61,23 +61,17 @@ module AddressFinder
     end
 
     def execute_request
-      request = Net::HTTP::Get.new(request_uri)
-
-      response = http.request(request)
+      response = http.request(request_uri)
 
       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
+      raise AddressFinder::RequestRejectedError.new(@response_status, @response_body) if response_status != "200"
 
-      if response_hash['matched']
-        self.result = Result.new(response_hash['address'] || response_hash)
-      else
-        self.result = nil
+      self.result = if response_hash["matched"]
+        Result.new(response_hash["address"] || response_hash)
       end
     end
 

data/lib/addressfinder/version.rb

@@ -1,3 +1,3 @@
 module AddressFinder
-  VERSION = "1.11.0"
+  VERSION = "1.13.0"
 end

data/lib/addressfinder.rb

@@ -4,7 +4,9 @@ require "concurrent/array"
 require "addressfinder/version"
 require "addressfinder/configuration"
 require "addressfinder/verification"
+require "addressfinder/v1/nz/batch_verification"
 require "addressfinder/v2/au/verification"
+require "addressfinder/v2/au/batch_verification"
 require "addressfinder/location_info"
 require "addressfinder/location_search"
 require "addressfinder/address_info"
@@ -22,12 +24,12 @@ module AddressFinder
   class << self
     def configure(config_hash = nil)
       config_hash&.each do |k, v|
-        if configuration.respond_to?(:"#{k}=")
-          begin
-            configuration.send(:"#{k}=", v)
-          rescue
-            nil
-          end
+        next unless configuration.respond_to?(:"#{k}=")
+
+        begin
+          configuration.send(:"#{k}=", v)
+        rescue
+          nil
         end
       end
 
@@ -38,11 +40,7 @@ module AddressFinder
       @configuration ||= AddressFinder::Configuration.new
     end
 
-    def cleanse(args = {}) # We are keeping this method for backward compatibility
-      AddressFinder::Verification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
-    end
-
-    def verification(args = {})
+    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
@@ -50,6 +48,22 @@ module AddressFinder
       end
     end
 
+    def verification(args = {}) # We are keeping this method for backward compatibility
+      address_verification(args)
+    end
+
+    def cleanse(args = {}) # We are keeping this method for backward compatibility
+      address_verification(args)
+    end
+
+    def address_verification_nz_batch(args = {})
+      AddressFinder::V1::Nz::BatchVerification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.results
+    end
+
+    def address_verification_au_batch(args = {})
+      AddressFinder::V2::Au::BatchVerification.new(**args.merge(http: AddressFinder::HTTP.new(configuration))).perform.results
+    end
+
     def location_search(args = {})
       AddressFinder::LocationSearch.new(params: args, http: AddressFinder::HTTP.new(configuration)).perform.results
     end
@@ -83,7 +97,9 @@ module AddressFinder
     end
 
     def bulk(&block)
-      AddressFinder::Bulk.new(http: AddressFinder::HTTP.new(configuration), verification_version: configuration.verification_version, default_country: configuration.default_country, &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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: addressfinder
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Nigel Ramsay
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-05 00:00:00.000000000 Z
+date: 2024-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -155,6 +155,7 @@ files:
 - LICENSE.md
 - README.md
 - addressfinder.gemspec
+- demo/verification/README.md
 - lib/addressfinder.rb
 - lib/addressfinder/address_autocomplete.rb
 - lib/addressfinder/address_info.rb
@@ -169,7 +170,9 @@ files:
 - lib/addressfinder/v1/base.rb
 - lib/addressfinder/v1/email/batch_verification.rb
 - lib/addressfinder/v1/email/verification.rb
+- lib/addressfinder/v1/nz/batch_verification.rb
 - lib/addressfinder/v1/phone/verification.rb
+- lib/addressfinder/v2/au/batch_verification.rb
 - lib/addressfinder/v2/au/verification.rb
 - lib/addressfinder/verification.rb
 - lib/addressfinder/version.rb
@@ -192,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: Provides easy access to Addressfinder APIs