addressfinder 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 472a6d05ac8dfbfd58b7a6b3203848d3f133c0dad187a096e70820e89b1915b0
-  data.tar.gz: 710a21c33cd0d14533a1292e3a847be537fa1a906df75d91d5ca6337d9df6e38
+  metadata.gz: 939c60d3f251b84c6fc378148d6d8d3480e2dcf2f171c27b7edef470d9b5a5b8
+  data.tar.gz: '07988c8cbbe65632d5551a11d9a02618360589c43ef2b3f3112159141b0a290d'
 SHA512:
-  metadata.gz: 47797fa15c8aba466c4bda510479dac8e82b2c64120f2c1b549710e22199e01087028b97b2b640f90538f28931b1a0490ed48a18d1d1faeede9f73a7c153f4bd
-  data.tar.gz: 0c252011d9a9df47448c2e3a4e3e7115665361ec31dd0b394d899b8b7052542f00976ca8aa117ac7a0f59a9e9044b0beccb95a4da2d24b0717dff0b2b036ecfb
+  metadata.gz: 14d93058d16682693bf237678aed85bb496d71447ff16457c30a32785e2fde1ad263c0063eb3da5a54ce96df3d88733afcef9452eb97e9a0a3483a56cfc86083
+  data.tar.gz: 19825d8fefac06180ee9c8d7a62eb81ec1ee8a06b753272f2dace02620a6e07c231e062d2af4f39285baafae1b00c232fd5c8034332d5f522452dae10e842145

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+# 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 API for verification (Australia)
+* Create a V2 Module for verification (Australia)
 * Remove PAF support from V1 verification API (Australia)
 * Include API version number in configuration
 

data/lib/addressfinder/bulk.rb

@@ -1,24 +1,26 @@
 module AddressFinder
   class Bulk
-    def initialize(http:, verification_version:, &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, verification_version: verification_version)
+        block.call ClientProxy.new(http: http, verification_version: verification_version, default_country: default_country)
       end
     end
 
     private
 
-    attr_reader :block, :verification_version, :http_config
+    attr_reader :block, :verification_version, :default_country, :http_config
 
     class ClientProxy
-      def initialize(http:, verification_version:)
+      def initialize(http:, verification_version:, default_country:)
         @verification_version = verification_version
+        @default_country = default_country
         @http = http
       end
 
@@ -27,7 +29,7 @@ module AddressFinder
       end
 
       def verification(args={})
-      if verification_version&.downcase == "v2"
+        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
@@ -36,7 +38,7 @@ module AddressFinder
 
       private
 
-      attr_reader :http, :verification_version
+      attr_reader :http, :verification_version, :default_country
     end
   end
 end

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

@@ -47,7 +47,7 @@ module AddressFinder
 
         private
 
-        attr_reader :request_uri, :params, :country, :http
+        attr_reader :request_uri, :params, :http
         attr_accessor :response_body, :response_status
         attr_writer :result
 

data/lib/addressfinder/version.rb

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

data/lib/addressfinder.rb

@@ -34,7 +34,7 @@ module AddressFinder
     end
 
     def verification(args={})
-      if configuration.verification_version&.downcase == "v2"
+      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
@@ -62,7 +62,7 @@ module AddressFinder
     end
 
     def bulk(&block)
-      AddressFinder::Bulk.new(http: AddressFinder::HTTP.new(configuration), verification_version: configuration.verification_version, &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, verification_version: 'v2', &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, verification_version: 'v2', &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, verification_version: 'v2', &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_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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: addressfinder
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Nigel Ramsay
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -143,6 +143,7 @@ files:
 - 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:
@@ -177,4 +178,5 @@ test_files:
 - 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