addressfinder 1.5.2 → 1.7.1

data/spec/lib/addressfinder/location_search_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe AddressFinder::LocationSearch do
 
   describe '#build_request' do
     let(:locator){ AddressFinder::LocationSearch.new(params: args, http: http) }
-    let(:http){ AddressFinder.send(:configure_http) }
+    let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
 
     subject(:request_uri){ locator.send(:build_request) }
 

data/spec/lib/addressfinder/verification_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper'
+
+RSpec.describe AddressFinder::Verification do
+  before do
+    AddressFinder.configure do |af|
+      af.api_key = 'XXX'
+      af.api_secret = 'YYY'
+      af.default_country = 'nz'
+      af.timeout = 5
+      af.retries = 3
+    end
+  end
+
+  let(:verification_module){ AddressFinder::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/nz/address/verification?q=186+willis+st&format=json&key=XXX&secret=YYY') }
+    end
+
+    context 'with more arguments' do
+      let(:args){ {q: '186 willis st', delivered: true, region_code: 'A', paf: '1', census: '2013', http: http} }
+
+      it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&delivered=true&paf=1&region_code=A&census=2013&format=json&key=XXX&secret=YYY') }
+    end
+
+    context 'with a country override' do
+      let(:args){ {q: '186 willis st', country: 'au', http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/verification?q=186+willis+st&format=json&key=XXX&secret=YYY') }
+    end
+
+    context 'with a state codes as an array' do
+      let(:args){ {q: '186 willis st', country: 'au', state_codes: ['ACT','NSW'], http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/verification?q=186+willis+st&state_codes[]=ACT&state_codes[]=NSW&format=json&key=XXX&secret=YYY') }
+    end
+
+    context 'with a reserved character in the query' do
+      let(:args){ {q: '186=willis st', country: 'au', state_codes: ['ACT','NSW'], http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/verification?q=186%3Dwillis+st&state_codes[]=ACT&state_codes[]=NSW&format=json&key=XXX&secret=YYY') }
+    end
+
+    context 'with a state codes as a string' do
+      let(:args){ {q: '186 willis st', country: 'au', state_codes: 'ACT,NSW', http: http} }
+
+      it { expect(request_uri).to eq('/api/au/address/verification?q=186+willis+st&state_codes=ACT%2CNSW&format=json&key=XXX&secret=YYY') }
+    end
+
+    context 'with a key override' do
+      let(:args){ {q: '186 willis st', key: 'AAA', http: http} }
+
+      it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&format=json&key=AAA&secret=YYY') }
+    end
+
+    context 'with a secret override' do
+      let(:args){ {q: '186 willis st', secret: 'BBB', http: http} }
+
+      it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&format=json&key=XXX&secret=BBB') }
+    end
+
+    context 'with a domain given' do
+      let(:args){ {q: '123', domain: 'testdomain.com', http: http} }
+
+      it { expect(request_uri).to eq('/api/nz/address/verification?q=123&domain=testdomain.com&format=json&key=XXX&secret=YYY') }
+
+      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/nz/address/verification?q=123&domain=anotherdomain.com&format=json&key=XXX&secret=YYY')
+          AddressFinder.configuration.domain = nil # set back to nil after
+        end
+      end
+    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::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::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

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: addressfinder
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.7.1
 platform: ruby
 authors:
 - Nigel Ramsay
 - Naiki Pohe
 - Sean Arnold
 - Alexandre Barret
+- Cassandre Guinut
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-21 00:00:00.000000000 Z
+date: 2021-07-02 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
@@ -83,12 +84,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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: []
@@ -96,31 +112,37 @@ 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/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/cleanse_spec.rb
+- spec/lib/addressfinder/bulk_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/verification_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/AbleTech/addressfinder-ruby
+homepage: https://github.com/AddressFinder/addressfinder-ruby
 licenses:
 - MIT
 metadata: {}
@@ -139,16 +161,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.7
+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/cleanse_spec.rb
+- spec/lib/addressfinder/bulk_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/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.
-

data/spec/lib/addressfinder/cleanse_spec.rb

@@ -1,103 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe AddressFinder::Cleanse do
-  before do
-    AddressFinder.configure do |af|
-      af.api_key = 'XXX'
-      af.api_secret = 'YYY'
-      af.default_country = 'nz'
-    end
-  end
-
-  describe '#build_request' do
-    let(:cleanser){ AddressFinder::Cleanse.new(args) }
-    let(:http){ AddressFinder.send(:configure_http) }
-
-    subject(:request_uri){ cleanser.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') }
-    end
-
-    context 'with more arguments' do
-      let(:args){ {q: '186 willis st', delivered: true, region_code: 'A', http: http} }
-
-      it { expect(request_uri).to eq('/api/nz/address/cleanse?q=186+willis+st&delivered=true&region_code=A&format=json&key=XXX&secret=YYY') }
-    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') }
-    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') }
-    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') }
-    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') }
-
-      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/nz/address/cleanse?q=123&domain=anotherdomain.com&format=json&key=XXX&secret=YYY')
-          AddressFinder.configuration.domain = nil # set back to nil after
-        end
-      end
-    end
-  end
-
-  describe '#build_result' do
-    let(:cleanser){ AddressFinder::Cleanse.new(q: 'ignored', http: nil) }
-
-    before do
-      cleanser.send('response_body=', body)
-      cleanser.send('response_status=', status)
-    end
-
-    subject(:result){ cleanser.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.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::Cleanse::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