addressfinder 1.6.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 867dfc938d96ea86964d5855d4ad5427407b7685
-  data.tar.gz: 7cae59337cb6014fecc96334a350e6315c2ab8cb
+SHA256:
+  metadata.gz: 472a6d05ac8dfbfd58b7a6b3203848d3f133c0dad187a096e70820e89b1915b0
+  data.tar.gz: 710a21c33cd0d14533a1292e3a847be537fa1a906df75d91d5ca6337d9df6e38
 SHA512:
-  metadata.gz: e0db8ca4d697a30774da34e3058ef5a4c3f24e0c82d5f8e393ff86fa87a70ff95d1849c2f28d0248b20230d694f2d32a95d0265c1fa9493f651d8996cea39402
-  data.tar.gz: 15d086c393bdd02f3adc9adee36d562e8f7e8e380f95c888c87c77f934a4ea8ef6dc4a84d4d9310576007a57c2fc88e07e9fec19a2cbc6791fec3168f9ea7ef1
+  metadata.gz: 47797fa15c8aba466c4bda510479dac8e82b2c64120f2c1b549710e22199e01087028b97b2b640f90538f28931b1a0490ed48a18d1d1faeede9f73a7c153f4bd
+  data.tar.gz: 0c252011d9a9df47448c2e3a4e3e7115665361ec31dd0b394d899b8b7052542f00976ca8aa117ac7a0f59a9e9044b0beccb95a4da2d24b0717dff0b2b036ecfb

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.2
-  - 2.2.3
+  - 2.2.7
   - 2.3.1
   - 2.4.1
+  - 2.6.3

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# AddressFinder 1.8.0 (October 2021) #
+
+* Create a V2 API 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
+* Rename cleanse to verification
+
+# AddressFinder 1.7.0 (May 4, 2020) #
+
+* Add support for Address Autocomplete API (Australia only)
+
+# AddressFinder 1.6.2 (September 23, 2019) #
+
+* Add support for an optional state_codes parameter in the Cleanse class
+
 # AddressFinder 1.6.1 (January 14, 2019) #
 
 * Add support for an optional census parameter in the Cleanse class

data/Dockerfile

@@ -0,0 +1,28 @@
+# Use the barebones version of Ruby 2.6.1
+FROM ruby:2.6
+
+# Install dependencies:
+# - build-essential: To ensure certain gems can be compiled
+# - nodejs: Compile assets
+# - bundler: ensure most recent version is installed
+RUN apt-get update && apt-get install -qq -y build-essential --fix-missing --no-install-recommends
+RUN gem install bundler
+
+# Set an environment variable to store where the app is installed to inside
+# of the Docker image.
+ENV LANG C.UTF-8
+ENV BUNDLE_PATH /bundle
+ENV INSTALL_PATH /addressfinder-ruby
+RUN mkdir -p $INSTALL_PATH
+
+# Create address verification directories
+RUN mkdir -p $INSTALL_PATH/verification/originals
+RUN mkdir -p $INSTALL_PATH/verification/verified
+
+# This sets the context of where commands will be ran in and is documented
+# on Docker's website extensively.
+WORKDIR $INSTALL_PATH
+
+ADD . $INSTALL_PATH
+
+RUN bundle install

data/Guardfile

@@ -1,4 +1,4 @@
-guard :rspec, cmd: 'rspec' do
+guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/LICENSE.md

@@ -0,0 +1,15 @@
+Copyright (c) 2015-present AddressFinder
+
+The intellectual property rights in this plugin are owned by AddressFinder Limited of Wellington New Zealand (referred to below as “we”, “us” or “our”) or its third party licensors.  The plugin may be accessed and used by AddressFinder customers only, subject to the following terms. If you are not, or are no longer, an AddressFinder customer you are not permitted to access or use the plugin in any way.
+
+If you are an AddressFinder customer (referred to below as “you” or “your”), the following terms apply in relation to your access and use of the plugin (and your access or use of the plugin confirms your acceptance of the following terms). If you do not accept the following terms you are not permitted to access or use the plugin in any way.
+* In these terms, “Terms and Conditions” means the applicable Terms and Conditions that you entered into, being either https://addressfinder.nz/legal/terms/ or https://addressfinder.com.au/legal/terms/, and “Services” and “Subscription Term” have the meaning given in the Terms and Conditions.
+* All rights, title and interest (including, without limitation, all intellectual property rights) in and to the plugin are owned by us or our third party licensors. Provided that you comply with these terms, and the Terms and Conditions, we grant you the right during your Subscription Term to: (a) access and use the plugin solely in connection with the Services and then only in combination with websites that you own or control; and (b) view the source code and configurations of the plugin solely for the purpose of evaluating the plugin in relation to its use in connection with the Services, and for no other purpose. This right is non-exclusive, non-transferable and may be revoked by us at any time. You are not granted any other rights or licences in relation to the plugin.
+* You must never copy, modify, publish, merge, distribute, resell, lease, transfer or sub-license, or create derivative works from, all or any part of the plugin. You must never access or use the plugin for any purpose related to building a product or service which competes with the Services or the plugin or has similar features or functionality. You must comply with all instructions or restrictions that we provide to you in relation to the plugin (including, without limitation, that we may post on this page from time to time).
+* The plugin is provided to you on an "as is" and "as available" basis and your use of it is at your sole risk. To the maximum extent permitted by law, we do not represent or warrant that the plugin will be secure, reliable, uninterrupted, always available, free of errors, omissions, inaccuracies, viruses or other destructive code, or that it will be fit for your purposes or for use in any specific technical environment or that any problems can or will be corrected. To the maximum extent permitted by law, we give no warranties in relation to the plugin. To avoid doubt, to the maximum extent permitted by law, we disclaim and exclude all implied representations, warranties and conditions (including any warranties of fitness for purpose, merchantability, title and non-infringement). Certain legislation may imply warranties or conditions, impose obligations or give statutory guarantees (together, Statutory Provisions) which cannot be excluded, restricted or modified except to a limited extent. These terms must be read subject to applicable Statutory Provisions. If the Statutory Provisions apply, notwithstanding any other provision of these terms, to the extent to which we are entitled to do so, we limit our liability in respect of any claim to: (a) in the case of goods, at our option: the replacement of the goods or the supply of equivalent goods; the repair of the goods; the payment of the cost of replacing the goods or acquiring equivalent goods; or the payment of having the goods repaired; and (b) in the case of services, at our option: the supply of the services again; or the payment of the cost of having the services supplied again. If you entered into our New Zealand Terms and Conditions, you represent to us that you are acquiring the right to use the plugin for the purposes of a business and so you agree that the provisions of the Consumer Guarantees Act 1993 do not apply to the plugin.
+* To the maximum extent permitted by law, we and Our Related Parties will not be liable to you or any third party for any loss or damage to data, breach of security, loss of profit, revenue, opportunity or saving, or any incidental, indirect, special or consequential loss or damage. To the maximum extent permitted by law, the total aggregate liability of us and Our Related Parties (together) to you under or in connection with these terms or its subject matter is limited to NZ$10. These limitations and exclusions of liability apply however liability arises, whether in contract, in tort (including negligence), for breach of statutory duty or otherwise.  You fully indemnify us from and against any claim, proceeding, damage, loss, liability, cost or expense (including legal costs on a solicitor and own client basis) arising from or connected to your use of plugin or breach of these terms. In these terms “Our Related Parties” means AddressFinder Pty Limited, ACN 606 672 333, any related company of us or AddressFinder Pty Limited (where “related company” has the meaning given in section 2(3) of the Companies Act 1993, and includes any company or similar entity which would be a related company within that definition if incorporated as a company in New Zealand) and our suppliers, contractors, directors, employees and agents.
+* We may change these terms at any time by emailing you, by updating the Terms and Conditions and/or by displaying or referring to the replacement terms on this page.  Your continued use of the plugin after you receive notice of any such changes will amount to your acceptance of those changes. If you don’t accept those changes you must immediately stop using the plugin.
+* Any waiver of any part of these terms must be in writing and signed by one of our authorised representatives. Any delay or failure by us to exercise any right does not prevent us from exercising that right, or any other right, on that or any other occasion.
+* Any unlawful or unenforceable provision of these terms will be deemed to be amended to the minimum extent necessary to ensure that it is not unlawful or unenforceable and, as far as is possible, to ensure that it is consistent with the intent and effect of the provision.  The remaining provisions will be enforceable as if such unlawful or unenforceable provision had not been included in these terms.  If the provision is unable to be amended without materially altering the intent and effect of the provision, it will be severed, and the remaining provisions will be enforceable.
+* The terms are governed by the laws of New Zealand and you and we submit to the non-exclusive jurisdiction of the New Zealand courts.
+

data/README.md

@@ -1,7 +1,7 @@
 # AddressFinder Ruby Gem
 
 [![Gem Version](https://badge.fury.io/rb/addressfinder.svg)](http://badge.fury.io/rb/addressfinder)
-[![Build  Status](https://travis-ci.org/AbleTech/addressfinder-ruby.svg)](https://travis-ci.org/AbleTech/addressfinder-ruby)
+[![Build  Status](https://travis-ci.com/github/AddressFinder/addressfinder-ruby.svg)](https://travis-ci.com/github/AddressFinder/addressfinder-ruby)
 
 A client library for accessing the [AddressFinder](https://addressfinder.nz/?utm_source=github&utm_medium=readme&utm_campaign=addressfinder_rubygem&utm_term=AddressFinder) APIs.
 
@@ -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
@@ -56,7 +57,7 @@ For available parameters and example responses, see the API documentation pages
 #### Address Verification
 
 ```ruby
-result = AddressFinder.cleanse(q: '186 Willis St, Wellington', country: 'nz')
+result = AddressFinder.verification(q: '186 Willis St, Wellington', country: 'nz')
 
 if result
   $stdout.puts "Success: #{result.postal}"
@@ -65,7 +66,14 @@ else
 end
 ```
 
-#### Address Autocomplete
+**Note:** The deprecated method `cleanse` is still available now but will be dropped in the future.
+
+#### Address Search
+
+The Address Search API supports the following address sets:
+
+* New Zealand addresses
+* Australian addresses from the GNAF dataset only
 
 ```ruby
 begin
@@ -81,6 +89,26 @@ rescue AddressFinder::RequestRejectedError => e
 end
 ```
 
+#### Address Autocomplete
+
+The Address Autocomplete API supports the following address sets:
+
+* Australian addresses from the GNAF and PAF datasets only
+
+```ruby
+begin
+  results = AddressFinder.address_autocomplete(q: '275 high st, bel', au_paf: '1')
+  if results.any?
+    $stdout.puts "Success: #{results}"
+  else
+    $stdout.puts "Sorry, there were no address matches"
+  end
+rescue AddressFinder::RequestRejectedError => e
+  response = JSON.parse(e.body)
+  $stdout.puts response['message']
+end
+```
+
 #### Address Metadata
 
 ```ruby
@@ -136,12 +164,12 @@ 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 (`#cleanse`).
+**Note:** The bulk method is currently only available for Address Verification (`#verification`).
 
 ```ruby
 AddressFinder.bulk do |af|
   CSV.foreach('auckland_addresses.csv') do |row|
-    result = af.cleanse(q: row[0], region_code: '1')
+    result = af.verification(q: row[0], region_code: '1')
 
     if result
       $stdout.puts "Success: #{result.postal}"
@@ -171,3 +199,12 @@ rescue AddressFinder::RequestRejectedError => e
 end
 ```
 
+### Testing
+
+You can run all the specs with the following command:
+
+`docker-compose up`
+
+You can `guard` for repeating test runs (while editing new code):
+
+`docker-compose run ruby bundle exec guard`

data/addressfinder.gemspec

@@ -5,11 +5,11 @@ Gem::Specification.new do |gem|
   gem.name          = "addressfinder"
   gem.version       = AddressFinder::VERSION
   gem.licenses      = ['MIT']
-  gem.authors       = ["Nigel Ramsay", "Naiki Pohe", "Sean Arnold", "Alexandre Barret"]
-  gem.email         = ["nigel.ramsay@abletech.co.nz", "naiki.pohe@abletech.co.nz", "seanarnie@gmail.com", "alex@abletech.nz"]
+  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/AbleTech/addressfinder-ruby"
+  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) }
@@ -20,7 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'multi_json', '~> 1.11'
   gem.add_development_dependency 'rspec', '~> 3.3'
   gem.add_development_dependency 'guard-rspec', '~> 4.6'
-  gem.add_development_dependency 'rake', '~> 10.4'
+  gem.add_development_dependency 'rake', '~> 13.0'
   gem.add_development_dependency 'webmock', '~> 1.21'
-  gem.add_development_dependency 'listen', '~> 3.0.0'
+  gem.add_development_dependency 'listen', '~> 3.2'
 end

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3'
+services:
+  ruby:
+    build: .
+    volumes:
+      - .:/addressfinder-ruby
+      - bundle-cache:/bundle
+    command: bundle exec rspec
+
+volumes:
+  bundle-cache: {}

data/lib/addressfinder/address_autocomplete.rb

@@ -0,0 +1,77 @@
+require 'ostruct'
+
+module AddressFinder
+  class AddressAutocomplete
+
+    attr_reader :results
+
+    def initialize(params:, http:)
+      @http = http
+      @country = params.delete(:country) || 'au'
+
+      @params = params
+      @params[:key] ||= config.api_key
+      @params[:secret] ||= config.api_secret
+    end
+
+    def perform
+      validate_params
+      build_request
+      execute_request
+      build_result
+
+      self
+    end
+
+    private
+
+    attr_reader :request_uri, :params, :country, :http
+    attr_accessor :response_body, :response_status
+    attr_writer :results
+
+    def validate_params
+      if country != 'au'
+        raise AddressFinder::RequestRejectedError.new("400", "#address_autocomplete only available for Australian addresses")
+      end
+    end
+
+    def build_request
+      @request_uri = "/api/au/address/autocomplete.json?#{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.results = response_hash['completions'].map do |result_hash|
+          Result.new(result_hash)
+        end
+      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

data/lib/addressfinder/bulk.rb

@@ -1,32 +1,42 @@
 module AddressFinder
   class Bulk
-    def initialize(http:, &block)
+    def initialize(http:, verification_version:, &block)
       @block = block
+      @verification_version = verification_version
       @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)
       end
     end
 
     private
 
-    attr_reader :block, :http_config
+    attr_reader :block, :verification_version, :http_config
 
     class ClientProxy
-      def initialize(http:)
+      def initialize(http:, verification_version:)
+        @verification_version = verification_version
         @http = http
       end
 
       def cleanse(args={})
-        AddressFinder::Cleanse.new(args.merge(http: http)).perform.result
+        AddressFinder::Verification.new(args.merge(http: http)).perform.result
+      end
+
+      def verification(args={})
+      if verification_version&.downcase == "v2"
+          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
     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/util.rb

@@ -6,7 +6,14 @@ module AddressFinder
     end
 
     def self.encode_and_join_params(params)
-      params.map{ |k,v| "#{k}=#{encode(v)}" }.join('&')
+      # URI.encode_www_form(params)
+      params.map do |k,v|
+        if v.is_a? Array
+          v.collect {|e| "#{k}[]=#{encode(e)}" }
+        else
+          "#{k}=#{encode(v)}"
+        end
+      end.join('&')
     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, :country, :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/{cleanse.rb → verification.rb}

@@ -1,23 +1,44 @@
 require 'ostruct'
 
 module AddressFinder
-  class Cleanse
+  class Verification
 
     attr_reader :result
 
-    def initialize(q:, country: nil, delivered: nil, post_box: nil, rural: nil, region_code: 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['rural'] = rural if rural
-      @params['region_code'] = region_code if region_code
       @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
 
@@ -36,7 +57,7 @@ module AddressFinder
     attr_writer :result
 
     def build_request
-      @request_uri = "/api/#{country}/address/cleanse?#{encoded_params}"
+      @request_uri = "/api/#{country}/address/verification?#{encoded_params}"
     end
 
     def execute_request

data/lib/addressfinder/version.rb

@@ -1,3 +1,3 @@
 module AddressFinder
-  VERSION = '1.6.1'
+  VERSION = '1.8.0'
 end

data/lib/addressfinder.rb

@@ -1,11 +1,13 @@
 require 'multi_json'
 require 'addressfinder/version'
 require 'addressfinder/configuration'
-require 'addressfinder/cleanse'
+require 'addressfinder/verification'
+require 'addressfinder/v2/au/verification'
 require 'addressfinder/location_info'
 require 'addressfinder/location_search'
 require 'addressfinder/address_info'
 require 'addressfinder/address_search'
+require 'addressfinder/address_autocomplete'
 require 'addressfinder/bulk'
 require 'addressfinder/errors'
 require 'addressfinder/util'
@@ -27,8 +29,16 @@ module AddressFinder
       @configuration ||= AddressFinder::Configuration.new
     end
 
-    def cleanse(args={})
-      AddressFinder::Cleanse.new(args.merge(http: AddressFinder::HTTP.new(configuration))).perform.result
+    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={})
+      if 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={})
@@ -43,12 +53,16 @@ module AddressFinder
       AddressFinder::AddressSearch.new(params: args, http: AddressFinder::HTTP.new(configuration)).perform.results
     end
 
+    def address_autocomplete(args={})
+      AddressFinder::AddressAutocomplete.new(params: args, http: AddressFinder::HTTP.new(configuration)).perform.results
+    end
+
     def address_info(args={})
       AddressFinder::AddressInfo.new(params: args, http: AddressFinder::HTTP.new(configuration)).perform.result
     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, &block).perform
     end
   end
 end

data/spec/lib/addressfinder/address_autocomplete_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+RSpec.describe AddressFinder::AddressAutocomplete do
+  before do
+    AddressFinder.configure do |af|
+      af.api_key = 'XXX'
+      af.api_secret = 'YYY'
+      af.default_country = 'au'
+    end
+  end
+
+  describe '#build_request' do
+    let(:locator){ AddressFinder::AddressAutocomplete.new(params: args, http: http) }
+    let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
+
+    subject(:request_uri){ locator.send(:build_request) }
+
+    context 'with minimal arguments' do
+      let(:args){ {q: '186 willis'} }
+
+      it { expect(request_uri).to eq('/api/au/address/autocomplete.json?q=186+willis&key=XXX&secret=YYY') }
+    end
+
+    context 'with more arguments' do
+      let(:args){ {q: '186 willis st', au_paf: 1, max: 10} }
+
+      it { expect(request_uri).to eq('/api/au/address/autocomplete.json?q=186+willis+st&au_paf=1&max=10&key=XXX&secret=YYY') }
+    end
+
+    context 'with a country override' do
+      let(:args){ {q: '186 willis st', country: 'au'} }
+
+      it { expect(request_uri).to eq('/api/au/address/autocomplete.json?q=186+willis+st&key=XXX&secret=YYY') }
+    end
+
+    context 'with a key override' do
+      let(:args){ {q: '186 willis st', key: 'AAA'} }
+
+      it { expect(request_uri).to eq('/api/au/address/autocomplete.json?q=186+willis+st&key=AAA&secret=YYY') }
+    end
+
+    context 'with a secret override' do
+      let(:args){ {q: '186 willis st', secret: 'BBB'} }
+
+      it { expect(request_uri).to eq('/api/au/address/autocomplete.json?q=186+willis+st&secret=BBB&key=XXX') }
+    end
+  end
+
+  describe '#validate_params' do
+    let(:locator){ AddressFinder::AddressAutocomplete.new(params: args, http: http) }
+    let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
+
+    subject(:validate_params){ locator.send(:validate_params) }
+
+    context 'with wrong country' do
+      let(:args){ {q: '186 willis st', country: 'nz'} }
+
+      it { expect{validate_params}.to raise_error(AddressFinder::RequestRejectedError) }
+    end
+
+    context 'with correct country' do
+      let(:args){ {q: '186 willis st', country: 'au'} }
+
+      it { expect{validate_params}.not_to raise_error }
+    end
+  end
+
+  describe '#build_result' do
+    let(:locator){ AddressFinder::AddressSearch.new(params: {q: 'ignored'}, http: nil) }
+
+    before do
+      locator.send('response_body=', body)
+      locator.send('response_status=', status)
+      locator.send(:build_result)
+    end
+
+    subject(:results){ locator.results }
+
+    context 'with completions' do
+      let(:body){ '{"completions":[{"a":"184 William Jones Drive, Otangarei, Whangarei 0112","pxid":"2-.9.2U.F.F.2I","v":1},{"a":"184 Williams Street, Kaiapoi 7630","pxid":"2-.3.1q.2.4G.4c","v":0},{"a":"184 Willis Street, Te Aro, Wellington 6011","pxid":"2-.F.1W.p.1D.1W","v":0}],"paid":true}' }
+      let(:status){ '200' }
+
+      it { expect(results.size).to eq(3) }
+      it { expect(results.first.class).to eq(AddressFinder::AddressSearch::Result) }
+      it { expect(results.first.a).to eq("184 William Jones Drive, Otangarei, Whangarei 0112") }
+    end
+
+    context 'with no completions' do
+      let(:body){ '{"completions":[],"paid":true}' }
+      let(:status){ '200' }
+
+      it { expect(results).to eq([]) }
+    end
+  end
+end

data/spec/lib/addressfinder/bulk_spec.rb

@@ -28,9 +28,9 @@ RSpec.describe AddressFinder::Bulk do
       let(:response){ double(:response, body: %Q({"success": true}), code: "200") }
       let(:block){
         Proc.new do |proxy|
-          proxy.cleanse(q: "1 Willis")
-          proxy.cleanse(q: "2 Willis")
-          proxy.cleanse(q: "3 Willis")
+          proxy.verification(q: "1 Willis")
+          proxy.verification(q: "2 Willis")
+          proxy.verification(q: "3 Willis")
         end
       }
 
@@ -38,7 +38,7 @@ 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', &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,8 +50,24 @@ 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', &block).perform
+      end
+    end
+
+    context "with the deprecated cleanse method" do
+      let(:response){ double(:response, body: %Q({"success": true}), code: "200") }
+      let(:block){
+        Proc.new do |proxy|
+          proxy.cleanse(q: "1 Willis")
+        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
+        AddressFinder::Bulk.new(http: http, verification_version: 'v2', &block).perform
       end
     end
   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/{cleanse_spec.rb → verification_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe AddressFinder::Cleanse do
+RSpec.describe AddressFinder::Verification do
   before do
     AddressFinder.configure do |af|
       af.api_key = 'XXX'
@@ -11,7 +11,7 @@ RSpec.describe AddressFinder::Cleanse do
     end
   end
 
-  let(:cleanser){ AddressFinder::Cleanse.new(args) }
+  let(:verification_module){ AddressFinder::Verification.new(args) }
   let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
   let(:net_http){ http.send(:net_http) }
 
@@ -21,7 +21,7 @@ RSpec.describe AddressFinder::Cleanse do
     before do
       WebMock.allow_net_connect!(net_http_connect_on_start: true)
       allow(http).to receive(:sleep)
-      allow(cleanser).to receive(:request_uri).and_return("/test/path")
+      allow(verification_module).to receive(:request_uri).and_return("/test/path")
       expect(http).to_not receive(:re_establish_connection)
     end
 
@@ -29,7 +29,7 @@ RSpec.describe AddressFinder::Cleanse do
       WebMock.disable_net_connect!
     end
 
-    subject(:execute_request){ cleanser.send(:execute_request) }
+    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
@@ -62,42 +62,60 @@ RSpec.describe AddressFinder::Cleanse do
   end
 
   describe '#build_request' do
-    subject(:request_uri){ cleanser.send(:build_request) }
+    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/nz/address/cleanse?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', census: '2013', http: http} }
 
-      it { expect(request_uri).to eq('/api/nz/address/cleanse?q=186+willis+st&delivered=true&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/cleanse?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&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&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&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/cleanse?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/cleanse?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/cleanse?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
 
@@ -105,7 +123,7 @@ RSpec.describe AddressFinder::Cleanse do
 
         it 'should use the config domain if set' do
           AddressFinder.configuration.domain = 'anotherdomain.com'
-          expect(request_uri).to eq('/api/nz/address/cleanse?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
@@ -116,17 +134,17 @@ RSpec.describe AddressFinder::Cleanse do
     let(:args){ {q: 'ignored', http: nil} }
 
     before do
-      cleanser.send('response_body=', body)
-      cleanser.send('response_status=', status)
+      verification_module.send('response_body=', body)
+      verification_module.send('response_status=', status)
     end
 
-    subject(:result){ cleanser.send(:build_result) }
+    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::Cleanse::Result) }
+      it { expect(result.class).to eq(AddressFinder::Verification::Result) }
 
       it { expect(result.matched).to eq(true) }
 
@@ -137,7 +155,7 @@ RSpec.describe AddressFinder::Cleanse do
       let(:body){ %Q({"matched": true, "success": true, "address": {"full_address": "Texas"}}) }
       let(:status){ '200' }
 
-      it { expect(result.class).to eq(AddressFinder::Cleanse::Result) }
+      it { expect(result.class).to eq(AddressFinder::Verification::Result) }
 
       it { expect(result.full_address).to eq("Texas") }
     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,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: addressfinder
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Nigel Ramsay
 - Naiki Pohe
 - Sean Arnold
 - Alexandre Barret
+- Cassandre Guinut
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-14 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -61,14 +62,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -89,20 +90,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.2'
 description: Ruby client library for AddressFinder
 email:
-- nigel.ramsay@abletech.co.nz
+- nigel.ramsay@addressfinder.nz
 - naiki.pohe@abletech.co.nz
 - seanarnie@gmail.com
 - alex@abletech.nz
+- cassandre.guinut@addressfinder.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -110,33 +112,39 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - Guardfile
-- LICENSE
+- LICENSE.md
 - README.md
 - Rakefile
 - addressfinder.gemspec
+- docker-compose.yml
 - lib/addressfinder.rb
+- lib/addressfinder/address_autocomplete.rb
 - lib/addressfinder/address_info.rb
 - lib/addressfinder/address_search.rb
 - lib/addressfinder/bulk.rb
-- lib/addressfinder/cleanse.rb
 - lib/addressfinder/configuration.rb
 - lib/addressfinder/errors.rb
 - lib/addressfinder/http.rb
 - 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
 - spec/lib/addressfinder/address_info_spec.rb
 - spec/lib/addressfinder/address_search_spec.rb
 - spec/lib/addressfinder/bulk_spec.rb
-- spec/lib/addressfinder/cleanse_spec.rb
 - 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/spec_helper.rb
-homepage: https://github.com/AbleTech/addressfinder-ruby
+homepage: https://github.com/AddressFinder/addressfinder-ruby
 licenses:
 - MIT
 metadata: {}
@@ -155,17 +163,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Provides easy access to AddressFinder APIs
 test_files:
+- spec/lib/addressfinder/address_autocomplete_spec.rb
 - spec/lib/addressfinder/address_info_spec.rb
 - spec/lib/addressfinder/address_search_spec.rb
 - spec/lib/addressfinder/bulk_spec.rb
-- spec/lib/addressfinder/cleanse_spec.rb
 - 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/spec_helper.rb

data/LICENSE

@@ -1,22 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Abletech
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-