addressfinder 1.9.1 → 1.10.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +7 -0
- data/README.md +23 -1
- data/addressfinder.gemspec +3 -2
- data/lib/addressfinder/bulk.rb +8 -0
- data/lib/addressfinder/v1/base.rb +71 -0
- data/lib/addressfinder/v1/email/verification.rb +16 -0
- data/lib/addressfinder/v1/phone/verification.rb +16 -0
- data/lib/addressfinder/version.rb +1 -1
- data/lib/addressfinder.rb +10 -0
- metadata +8 -34
- data/.gitignore +0 -11
- data/.travis.yml +0 -6
- data/Dockerfile +0 -28
- data/Gemfile +0 -3
- data/Guardfile +0 -5
- data/Rakefile +0 -7
- data/docker-compose.yml +0 -11
- data/spec/lib/addressfinder/address_autocomplete_spec.rb +0 -95
- data/spec/lib/addressfinder/address_info_spec.rb +0 -62
- data/spec/lib/addressfinder/address_search_spec.rb +0 -76
- data/spec/lib/addressfinder/bulk_spec.rb +0 -115
- data/spec/lib/addressfinder/location_info_spec.rb +0 -79
- data/spec/lib/addressfinder/location_search_spec.rb +0 -93
- data/spec/lib/addressfinder/util_spec.rb +0 -37
- data/spec/lib/addressfinder/v2/au/verification_spec.rb +0 -187
- data/spec/lib/addressfinder/verification_spec.rb +0 -170
- data/spec/lib/addressfinder_spec.rb +0 -74
- data/spec/spec_helper.rb +0 -20
@@ -1,115 +0,0 @@
|
|
1
|
-
require 'spec_helper'
|
2
|
-
|
3
|
-
RSpec.describe AddressFinder::Bulk do
|
4
|
-
before do
|
5
|
-
AddressFinder.configure do |af|
|
6
|
-
af.api_key = 'XXX'
|
7
|
-
af.api_secret = 'YYY'
|
8
|
-
af.default_country = 'nz'
|
9
|
-
af.timeout = 5
|
10
|
-
af.retries = 5
|
11
|
-
end
|
12
|
-
end
|
13
|
-
|
14
|
-
describe '#perform' do
|
15
|
-
let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
|
16
|
-
let(:net_http){ http.send(:net_http) }
|
17
|
-
|
18
|
-
before do
|
19
|
-
WebMock.allow_net_connect!(net_http_connect_on_start: true)
|
20
|
-
allow(http).to receive(:sleep)
|
21
|
-
end
|
22
|
-
|
23
|
-
after do
|
24
|
-
WebMock.disable_net_connect!
|
25
|
-
end
|
26
|
-
|
27
|
-
context "with 3 requests in the provided block" do
|
28
|
-
let(:response){ double(:response, body: %Q({"success": true}), code: "200") }
|
29
|
-
let(:block){
|
30
|
-
Proc.new do |proxy|
|
31
|
-
proxy.verification(q: "1 Willis")
|
32
|
-
proxy.verification(q: "2 Willis")
|
33
|
-
proxy.verification(q: "3 Willis")
|
34
|
-
end
|
35
|
-
}
|
36
|
-
|
37
|
-
it "uses 1 http connection" do
|
38
|
-
expect(net_http).to receive(:do_start).once.and_call_original
|
39
|
-
expect(net_http).to receive(:transport_request).exactly(3).times.and_return(response)
|
40
|
-
expect(net_http).to receive(:do_finish).once.and_call_original
|
41
|
-
AddressFinder::Bulk.new(http: http, verification_version: 'v2', default_country: 'au', &block).perform
|
42
|
-
end
|
43
|
-
|
44
|
-
it "calls the correct class with v2 verification and au default" do
|
45
|
-
allow(net_http).to receive(:do_start).once.and_call_original
|
46
|
-
allow(net_http).to receive(:transport_request).exactly(3).times.and_return(response)
|
47
|
-
allow(net_http).to receive(:do_finish).once.and_call_original
|
48
|
-
expect(AddressFinder::V2::Au::Verification).to receive(:new).exactly(3).times.and_call_original
|
49
|
-
AddressFinder::Bulk.new(http: http, verification_version: 'v2', default_country: 'au', &block).perform
|
50
|
-
end
|
51
|
-
|
52
|
-
it "calls the correct class with v2 verification and nz default" do
|
53
|
-
allow(net_http).to receive(:do_start).once.and_call_original
|
54
|
-
allow(net_http).to receive(:transport_request).exactly(3).times.and_return(response)
|
55
|
-
allow(net_http).to receive(:do_finish).once.and_call_original
|
56
|
-
expect(AddressFinder::Verification).to receive(:new).exactly(3).times.and_call_original
|
57
|
-
AddressFinder::Bulk.new(http: http, verification_version: 'v2', default_country: 'nz', &block).perform
|
58
|
-
end
|
59
|
-
|
60
|
-
it "calls the correct class without a verification version" do
|
61
|
-
allow(net_http).to receive(:do_start).once.and_call_original
|
62
|
-
allow(net_http).to receive(:transport_request).exactly(3).times.and_return(response)
|
63
|
-
allow(net_http).to receive(:do_finish).once.and_call_original
|
64
|
-
expect(AddressFinder::Verification).to receive(:new).exactly(3).times.and_call_original
|
65
|
-
AddressFinder::Bulk.new(http: http, verification_version: nil, default_country: 'au', &block).perform
|
66
|
-
end
|
67
|
-
|
68
|
-
it "re-establishes the http connection and continues where we left off when a Net::OpenTimeout, Net::ReadTimeout or SocketError is raised" do
|
69
|
-
expect(http).to receive(:re_establish_connection).exactly(3).times.and_call_original
|
70
|
-
expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
|
71
|
-
expect(net_http).to receive(:transport_request).once.and_return(response) # 1 Willis (success)
|
72
|
-
expect(net_http).to receive(:transport_request).once.and_raise(Net::OpenTimeout) # 2 Willis (error)
|
73
|
-
expect(net_http).to receive(:transport_request).once.and_raise(Net::ReadTimeout) # Retry 2 Willis (error)
|
74
|
-
expect(net_http).to receive(:transport_request).once.and_raise(SocketError) # Retry 2 Willis (error)
|
75
|
-
expect(net_http).to receive(:transport_request).exactly(2).and_return(response) # Retry 2 Willis (success) & 3 Willis (success)
|
76
|
-
expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
|
77
|
-
AddressFinder::Bulk.new(http: http, verification_version: 'v2', default_country: 'au', &block).perform
|
78
|
-
end
|
79
|
-
end
|
80
|
-
|
81
|
-
context "with the deprecated cleanse method" do
|
82
|
-
let(:response){ double(:response, body: %Q({"success": true}), code: "200") }
|
83
|
-
let(:block){
|
84
|
-
Proc.new do |proxy|
|
85
|
-
proxy.cleanse(q: "1 Willis")
|
86
|
-
end
|
87
|
-
}
|
88
|
-
|
89
|
-
it "has the same behaviour as the verification method" do
|
90
|
-
expect(net_http).to receive(:do_start).once.and_call_original
|
91
|
-
expect(net_http).to receive(:transport_request).once.and_return(response)
|
92
|
-
expect(net_http).to receive(:do_finish).once.and_call_original
|
93
|
-
expect(AddressFinder::Verification).to receive(:new).exactly(1).times.and_call_original
|
94
|
-
AddressFinder::Bulk.new(http: http, verification_version: nil, default_country: 'au', &block).perform
|
95
|
-
end
|
96
|
-
end
|
97
|
-
|
98
|
-
context "with a country override and v2 in the config" do
|
99
|
-
let(:response){ double(:response, body: %Q({"success": true}), code: "200") }
|
100
|
-
let(:block){
|
101
|
-
Proc.new do |proxy|
|
102
|
-
proxy.verification(q: "1 Willis", country: "au")
|
103
|
-
end
|
104
|
-
}
|
105
|
-
|
106
|
-
it "has the same behaviour as the verification method" do
|
107
|
-
expect(net_http).to receive(:do_start).once.and_call_original
|
108
|
-
expect(net_http).to receive(:transport_request).once.and_return(response)
|
109
|
-
expect(net_http).to receive(:do_finish).once.and_call_original
|
110
|
-
expect(AddressFinder::V2::Au::Verification).to receive(:new).exactly(1).times.and_call_original
|
111
|
-
AddressFinder::Bulk.new(http: http, verification_version: "v2", default_country: 'nz', &block).perform
|
112
|
-
end
|
113
|
-
end
|
114
|
-
end
|
115
|
-
end
|
@@ -1,79 +0,0 @@
|
|
1
|
-
require 'spec_helper'
|
2
|
-
|
3
|
-
RSpec.describe AddressFinder::LocationInfo do
|
4
|
-
before do
|
5
|
-
AddressFinder.configure do |af|
|
6
|
-
af.api_key = 'XXX'
|
7
|
-
af.api_secret = 'YYY'
|
8
|
-
af.default_country = 'au'
|
9
|
-
end
|
10
|
-
end
|
11
|
-
|
12
|
-
describe '#build_request' do
|
13
|
-
let(:locator){ AddressFinder::LocationInfo.new(params: args, http: http) }
|
14
|
-
let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
|
15
|
-
|
16
|
-
subject(:request_uri){ locator.send(:build_request) }
|
17
|
-
|
18
|
-
context 'with a simple PXID' do
|
19
|
-
let(:args){ {pxid: '123'} }
|
20
|
-
|
21
|
-
it { expect(request_uri).to eq('/api/au/location/info.json?pxid=123&key=XXX&secret=YYY') }
|
22
|
-
end
|
23
|
-
|
24
|
-
context 'with a country override' do
|
25
|
-
let(:args){ {pxid: '123', country: 'nz'} }
|
26
|
-
|
27
|
-
it { expect(request_uri).to eq('/api/nz/location/info.json?pxid=123&key=XXX&secret=YYY') }
|
28
|
-
end
|
29
|
-
|
30
|
-
context 'with a key override' do
|
31
|
-
let(:args){ {pxid: '123', key: 'AAA'} }
|
32
|
-
|
33
|
-
it { expect(request_uri).to eq('/api/au/location/info.json?pxid=123&key=AAA&secret=YYY') }
|
34
|
-
end
|
35
|
-
|
36
|
-
context 'with a secret override' do
|
37
|
-
let(:args){ {pxid: '123', secret: 'BBB'} }
|
38
|
-
|
39
|
-
it { expect(request_uri).to eq('/api/au/location/info.json?pxid=123&secret=BBB&key=XXX') }
|
40
|
-
end
|
41
|
-
|
42
|
-
context 'with a domain given' do
|
43
|
-
let(:args){ {pxid: '123', domain: 'testdomain.com'} }
|
44
|
-
|
45
|
-
it { expect(request_uri).to eq('/api/au/location/info.json?pxid=123&domain=testdomain.com&key=XXX&secret=YYY') }
|
46
|
-
|
47
|
-
context 'given in the AF configuration' do
|
48
|
-
|
49
|
-
let(:args){ {pxid: '123'} }
|
50
|
-
|
51
|
-
it 'should use the config domain if set' do
|
52
|
-
AddressFinder.configuration.domain = 'anotherdomain.com'
|
53
|
-
expect(request_uri).to eq('/api/au/location/info.json?pxid=123&domain=anotherdomain.com&key=XXX&secret=YYY')
|
54
|
-
AddressFinder.configuration.domain = nil # set back to nil after
|
55
|
-
end
|
56
|
-
end
|
57
|
-
end
|
58
|
-
end
|
59
|
-
|
60
|
-
describe '#build_result' do
|
61
|
-
let(:locator){ AddressFinder::LocationInfo.new(params: {q: 'ignored'}, http: nil) }
|
62
|
-
|
63
|
-
before do
|
64
|
-
locator.send('response_body=', body)
|
65
|
-
locator.send('response_status=', status)
|
66
|
-
end
|
67
|
-
|
68
|
-
subject(:result){ locator.send(:build_result) }
|
69
|
-
|
70
|
-
context 'with a successful result' do
|
71
|
-
let(:body){ '{"a":"Seaview Road, Glenfield, Auckland","city":"Auckland","suburb":"Glenfield","region":"Auckland Region","x":174.713938691835,"y":-36.7894885545157,"pxid":"1-.1.6.j.1F","street":"Seaview Road"}' }
|
72
|
-
let(:status){ '200' }
|
73
|
-
|
74
|
-
it { expect(result.class).to eq(AddressFinder::LocationInfo::Result) }
|
75
|
-
it { expect(result.a).to eq("Seaview Road, Glenfield, Auckland") }
|
76
|
-
it { expect(result.pxid).to eq("1-.1.6.j.1F") }
|
77
|
-
end
|
78
|
-
end
|
79
|
-
end
|
@@ -1,93 +0,0 @@
|
|
1
|
-
require 'spec_helper'
|
2
|
-
|
3
|
-
RSpec.describe AddressFinder::LocationSearch do
|
4
|
-
before do
|
5
|
-
AddressFinder.configure do |af|
|
6
|
-
af.api_key = 'XXX'
|
7
|
-
af.api_secret = 'YYY'
|
8
|
-
af.default_country = 'nz'
|
9
|
-
end
|
10
|
-
end
|
11
|
-
|
12
|
-
describe '#build_request' do
|
13
|
-
let(:locator){ AddressFinder::LocationSearch.new(params: args, http: http) }
|
14
|
-
let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
|
15
|
-
|
16
|
-
subject(:request_uri){ locator.send(:build_request) }
|
17
|
-
|
18
|
-
context 'with minimal arguments' do
|
19
|
-
let(:args){ {q: 'willis'} }
|
20
|
-
|
21
|
-
it { expect(request_uri).to eq('/api/nz/location.json?q=willis&key=XXX&secret=YYY') }
|
22
|
-
end
|
23
|
-
|
24
|
-
context 'with more arguments' do
|
25
|
-
let(:args){ {q: 'willis st', street: 1, max: 10} }
|
26
|
-
|
27
|
-
it { expect(request_uri).to eq('/api/nz/location.json?q=willis+st&street=1&max=10&key=XXX&secret=YYY') }
|
28
|
-
end
|
29
|
-
|
30
|
-
context 'with a country override' do
|
31
|
-
let(:args){ {q: 'willis st', country: 'au'} }
|
32
|
-
|
33
|
-
it { expect(request_uri).to eq('/api/au/location.json?q=willis+st&key=XXX&secret=YYY') }
|
34
|
-
end
|
35
|
-
|
36
|
-
context 'with a key override' do
|
37
|
-
let(:args){ {q: 'willis st', key: 'AAA'} }
|
38
|
-
|
39
|
-
it { expect(request_uri).to eq('/api/nz/location.json?q=willis+st&key=AAA&secret=YYY') }
|
40
|
-
end
|
41
|
-
|
42
|
-
context 'with a secret override' do
|
43
|
-
let(:args){ {q: 'willis st', secret: 'BBB'} }
|
44
|
-
|
45
|
-
it { expect(request_uri).to eq('/api/nz/location.json?q=willis+st&secret=BBB&key=XXX') }
|
46
|
-
end
|
47
|
-
|
48
|
-
context 'with a domain given' do
|
49
|
-
let(:args){ {q: '123', domain: 'testdomain.com'} }
|
50
|
-
|
51
|
-
it { expect(request_uri).to eq('/api/nz/location.json?q=123&domain=testdomain.com&key=XXX&secret=YYY') }
|
52
|
-
|
53
|
-
context 'given in the AF configuration' do
|
54
|
-
|
55
|
-
let(:args){ {q: '123'} }
|
56
|
-
|
57
|
-
it 'should use the config domain if set' do
|
58
|
-
AddressFinder.configuration.domain = 'anotherdomain.com'
|
59
|
-
expect(request_uri).to eq('/api/nz/location.json?q=123&domain=anotherdomain.com&key=XXX&secret=YYY')
|
60
|
-
AddressFinder.configuration.domain = nil # set back to nil after
|
61
|
-
end
|
62
|
-
end
|
63
|
-
end
|
64
|
-
end
|
65
|
-
|
66
|
-
describe '#build_result' do
|
67
|
-
let(:locator){ AddressFinder::LocationSearch.new(params: {q: 'ignored'}, http: nil) }
|
68
|
-
|
69
|
-
before do
|
70
|
-
locator.send('response_body=', body)
|
71
|
-
locator.send('response_status=', status)
|
72
|
-
locator.send(:build_result)
|
73
|
-
end
|
74
|
-
|
75
|
-
subject(:results){ locator.results }
|
76
|
-
|
77
|
-
context 'with completions' do
|
78
|
-
let(:body){ '{"completions":[{"a":"Willowbank","pxid":"1-.B.3l","v":0},{"a":"Willowby","pxid":"1-.3.4O","v":0}],"paid":true}' }
|
79
|
-
let(:status){ '200' }
|
80
|
-
|
81
|
-
it { expect(results.size).to eq(2) }
|
82
|
-
it { expect(results.first.class).to eq(AddressFinder::LocationSearch::Result) }
|
83
|
-
it { expect(results.first.a).to eq("Willowbank") }
|
84
|
-
end
|
85
|
-
|
86
|
-
context 'with no completions' do
|
87
|
-
let(:body){ '{"completions":[],"paid":true}' }
|
88
|
-
let(:status){ '200' }
|
89
|
-
|
90
|
-
it { expect(results).to eq([]) }
|
91
|
-
end
|
92
|
-
end
|
93
|
-
end
|
@@ -1,37 +0,0 @@
|
|
1
|
-
require 'addressfinder/util'
|
2
|
-
|
3
|
-
RSpec.describe AddressFinder::Util do
|
4
|
-
describe '.encode_and_join_params' do
|
5
|
-
subject { AddressFinder::Util.encode_and_join_params(params) }
|
6
|
-
|
7
|
-
context 'with a question mark value' do
|
8
|
-
let(:params){ {q:'?',format:'json',key:'XXX',secret:'YYY'} }
|
9
|
-
|
10
|
-
it { is_expected.to eq('q=%3F&format=json&key=XXX&secret=YYY') }
|
11
|
-
end
|
12
|
-
|
13
|
-
context 'with an ampersand value' do
|
14
|
-
let(:params){ {q:'&',format:'json',key:'XXX',secret:'YYY'} }
|
15
|
-
|
16
|
-
it { is_expected.to eq('q=%26&format=json&key=XXX&secret=YYY') }
|
17
|
-
end
|
18
|
-
|
19
|
-
context 'with a normal address value' do
|
20
|
-
let(:params){ {q:'12 high',format:'json',key:'XXX',secret:'YYY'} }
|
21
|
-
|
22
|
-
it { is_expected.to eq('q=12+high&format=json&key=XXX&secret=YYY') }
|
23
|
-
end
|
24
|
-
|
25
|
-
context 'with a blank value' do
|
26
|
-
let(:params){ {q:'',format:'json',key:'XXX',secret:'YYY'} }
|
27
|
-
|
28
|
-
it { is_expected.to eq('q=&format=json&key=XXX&secret=YYY') }
|
29
|
-
end
|
30
|
-
|
31
|
-
context 'with a nil value' do
|
32
|
-
let(:params){ {q:nil,format:'json',key:'XXX',secret:'YYY'} }
|
33
|
-
|
34
|
-
it { is_expected.to eq('q=&format=json&key=XXX&secret=YYY') }
|
35
|
-
end
|
36
|
-
end
|
37
|
-
end
|
@@ -1,187 +0,0 @@
|
|
1
|
-
require 'spec_helper'
|
2
|
-
|
3
|
-
RSpec.describe AddressFinder::V2::Au::Verification do
|
4
|
-
before do
|
5
|
-
AddressFinder.configure do |af|
|
6
|
-
af.api_key = 'XXX'
|
7
|
-
af.api_secret = 'YYY'
|
8
|
-
af.timeout = 5
|
9
|
-
af.retries = 3
|
10
|
-
end
|
11
|
-
end
|
12
|
-
|
13
|
-
let(:verification_module){ AddressFinder::V2::Au::Verification.new(**args) }
|
14
|
-
let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
|
15
|
-
let(:net_http){ http.send(:net_http) }
|
16
|
-
|
17
|
-
describe '#execute_request' do
|
18
|
-
let(:args){ {q: "186 Willis Street", http: http} }
|
19
|
-
|
20
|
-
before do
|
21
|
-
WebMock.allow_net_connect!(net_http_connect_on_start: true)
|
22
|
-
allow(http).to receive(:sleep)
|
23
|
-
allow(verification_module).to receive(:request_uri).and_return("/test/path")
|
24
|
-
expect(http).to_not receive(:re_establish_connection)
|
25
|
-
end
|
26
|
-
|
27
|
-
after do
|
28
|
-
WebMock.disable_net_connect!
|
29
|
-
end
|
30
|
-
|
31
|
-
subject(:execute_request){ verification_module.send(:execute_request) }
|
32
|
-
|
33
|
-
it "retries an errored request another time before succeeding" do
|
34
|
-
expect(net_http).to receive(:do_start).twice.and_call_original
|
35
|
-
expect(net_http).to receive(:transport_request).once.and_raise(Net::OpenTimeout)
|
36
|
-
expect(net_http).to receive(:transport_request).once.and_return(double(:response, body: "OK", code: "200"))
|
37
|
-
expect(net_http).to receive(:do_finish).twice.and_call_original
|
38
|
-
execute_request
|
39
|
-
end
|
40
|
-
|
41
|
-
it "re-raises a Net::OpenTimeout error after 3 retries" do
|
42
|
-
expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
|
43
|
-
expect(net_http).to receive(:transport_request).exactly(4).times.and_raise(Net::OpenTimeout)
|
44
|
-
expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
|
45
|
-
expect{execute_request}.to raise_error(Net::OpenTimeout)
|
46
|
-
end
|
47
|
-
|
48
|
-
it "re-raises a Net::ReadTimeout error after 3 retries" do
|
49
|
-
expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
|
50
|
-
expect(net_http).to receive(:transport_request).exactly(4).times.and_raise(Net::ReadTimeout)
|
51
|
-
expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
|
52
|
-
expect{execute_request}.to raise_error(Net::ReadTimeout)
|
53
|
-
end
|
54
|
-
|
55
|
-
it "re-raises a SocketError error after 3 retries" do
|
56
|
-
expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
|
57
|
-
expect(net_http).to receive(:transport_request).exactly(4).times.and_raise(SocketError)
|
58
|
-
expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
|
59
|
-
expect{execute_request}.to raise_error(SocketError)
|
60
|
-
end
|
61
|
-
end
|
62
|
-
|
63
|
-
describe '#build_request' do
|
64
|
-
subject(:request_uri){ verification_module.send(:build_request) }
|
65
|
-
|
66
|
-
context 'with minimal arguments' do
|
67
|
-
let(:args){ {q: '186 willis st', http: http} }
|
68
|
-
|
69
|
-
it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&key=XXX&secret=YYY&format=json') }
|
70
|
-
end
|
71
|
-
|
72
|
-
context 'with more arguments' do
|
73
|
-
let(:args){ {q: '186 willis st', census: '2011', http: http} }
|
74
|
-
|
75
|
-
it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&census=2011&key=XXX&secret=YYY&format=json') }
|
76
|
-
end
|
77
|
-
|
78
|
-
context 'with a state codes as an array' do
|
79
|
-
let(:args){ {q: '186 willis st', state_codes: ['ACT','NSW'], http: http} }
|
80
|
-
|
81
|
-
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') }
|
82
|
-
end
|
83
|
-
|
84
|
-
context 'with a reserved character in the query' do
|
85
|
-
let(:args){ {q: '186=willis st', state_codes: ['ACT','NSW'], http: http} }
|
86
|
-
|
87
|
-
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') }
|
88
|
-
end
|
89
|
-
|
90
|
-
context 'with a state codes as a string' do
|
91
|
-
let(:args){ {q: '186 willis st', state_codes: 'ACT,NSW', http: http} }
|
92
|
-
|
93
|
-
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') }
|
94
|
-
end
|
95
|
-
|
96
|
-
context 'with a key override' do
|
97
|
-
let(:args){ {q: '186 willis st', key: 'AAA', http: http} }
|
98
|
-
|
99
|
-
it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&key=AAA&secret=YYY&format=json') }
|
100
|
-
end
|
101
|
-
|
102
|
-
context 'with a secret override' do
|
103
|
-
let(:args){ {q: '186 willis st', secret: 'BBB', http: http} }
|
104
|
-
|
105
|
-
it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&key=XXX&secret=BBB&format=json') }
|
106
|
-
end
|
107
|
-
|
108
|
-
context 'with a domain given' do
|
109
|
-
let(:args){ {q: '123', domain: 'testdomain.com', http: http} }
|
110
|
-
|
111
|
-
it { expect(request_uri).to eq('/api/au/address/v2/verification?q=123&domain=testdomain.com&key=XXX&secret=YYY&format=json') }
|
112
|
-
|
113
|
-
context 'given in the AF configuration' do
|
114
|
-
|
115
|
-
let(:args){ {q: '123', http: http} }
|
116
|
-
|
117
|
-
it 'should use the config domain if set' do
|
118
|
-
AddressFinder.configuration.domain = 'anotherdomain.com'
|
119
|
-
# expect(request_uri).to eq('/api/au/address/v2/verification?q=123&domain=anotherdomain.com&key=XXX&secret=YYY&format=json')
|
120
|
-
AddressFinder.configuration.domain = nil # set back to nil after
|
121
|
-
end
|
122
|
-
end
|
123
|
-
end
|
124
|
-
|
125
|
-
context 'with a post_box exclusion' do
|
126
|
-
let(:args){ {q: '186 willis st', post_box: '0', http: http} }
|
127
|
-
|
128
|
-
it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&post_box=0&key=XXX&secret=YYY&format=json') }
|
129
|
-
end
|
130
|
-
|
131
|
-
context 'with a gnaf request' do
|
132
|
-
let(:args){ {q: '186 willis st', gnaf: '1', http: http} }
|
133
|
-
|
134
|
-
it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&key=XXX&secret=YYY&gnaf=1&format=json') }
|
135
|
-
end
|
136
|
-
|
137
|
-
context 'with a paf request' do
|
138
|
-
let(:args){ {q: '186 willis st', paf: '1', http: http} }
|
139
|
-
|
140
|
-
it { expect(request_uri).to eq('/api/au/address/v2/verification?q=186+willis+st&key=XXX&secret=YYY&paf=1&format=json') }
|
141
|
-
end
|
142
|
-
|
143
|
-
context 'with a all args included request' do
|
144
|
-
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} }
|
145
|
-
|
146
|
-
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') }
|
147
|
-
end
|
148
|
-
end
|
149
|
-
|
150
|
-
describe '#build_result' do
|
151
|
-
let(:args){ {q: 'ignored', http: nil} }
|
152
|
-
|
153
|
-
before do
|
154
|
-
verification_module.send('response_body=', body)
|
155
|
-
verification_module.send('response_status=', status)
|
156
|
-
end
|
157
|
-
|
158
|
-
subject(:result){ verification_module.send(:build_result) }
|
159
|
-
|
160
|
-
context 'with a successful nz result' do
|
161
|
-
let(:body){ '{"matched": true, "postal_address": "Texas"}' }
|
162
|
-
let(:status){ '200' }
|
163
|
-
|
164
|
-
it { expect(result.class).to eq(AddressFinder::V2::Au::Verification::Result) }
|
165
|
-
|
166
|
-
it { expect(result.matched).to eq(true) }
|
167
|
-
|
168
|
-
it { expect(result.postal_address).to eq("Texas") }
|
169
|
-
end
|
170
|
-
|
171
|
-
context 'with a successful au result' do
|
172
|
-
let(:body){ %Q({"matched": true, "success": true, "address": {"full_address": "Texas"}}) }
|
173
|
-
let(:status){ '200' }
|
174
|
-
|
175
|
-
it { expect(result.class).to eq(AddressFinder::V2::Au::Verification::Result) }
|
176
|
-
|
177
|
-
it { expect(result.full_address).to eq("Texas") }
|
178
|
-
end
|
179
|
-
|
180
|
-
context 'with an unfound result' do
|
181
|
-
let(:body){ '{"matched": false}' }
|
182
|
-
let(:status){ '200' }
|
183
|
-
|
184
|
-
it { expect(result).to eq(nil) }
|
185
|
-
end
|
186
|
-
end
|
187
|
-
end
|
@@ -1,170 +0,0 @@
|
|
1
|
-
require 'spec_helper'
|
2
|
-
|
3
|
-
RSpec.describe AddressFinder::Verification do
|
4
|
-
before do
|
5
|
-
AddressFinder.configure do |af|
|
6
|
-
af.api_key = 'XXX'
|
7
|
-
af.api_secret = 'YYY'
|
8
|
-
af.default_country = 'nz'
|
9
|
-
af.timeout = 5
|
10
|
-
af.retries = 3
|
11
|
-
end
|
12
|
-
end
|
13
|
-
|
14
|
-
let(:verification_module){ AddressFinder::Verification.new(**args) }
|
15
|
-
let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
|
16
|
-
let(:net_http){ http.send(:net_http) }
|
17
|
-
|
18
|
-
describe '#execute_request' do
|
19
|
-
let(:args){ {q: "186 Willis Street", http: http} }
|
20
|
-
|
21
|
-
before do
|
22
|
-
WebMock.allow_net_connect!(net_http_connect_on_start: true)
|
23
|
-
allow(http).to receive(:sleep)
|
24
|
-
allow(verification_module).to receive(:request_uri).and_return("/test/path")
|
25
|
-
expect(http).to_not receive(:re_establish_connection)
|
26
|
-
end
|
27
|
-
|
28
|
-
after do
|
29
|
-
WebMock.disable_net_connect!
|
30
|
-
end
|
31
|
-
|
32
|
-
subject(:execute_request){ verification_module.send(:execute_request) }
|
33
|
-
|
34
|
-
it "retries an errored request another time before succeeding" do
|
35
|
-
expect(net_http).to receive(:do_start).twice.and_call_original
|
36
|
-
expect(net_http).to receive(:transport_request).once.and_raise(Net::OpenTimeout)
|
37
|
-
expect(net_http).to receive(:transport_request).once.and_return(double(:response, body: "OK", code: "200"))
|
38
|
-
expect(net_http).to receive(:do_finish).twice.and_call_original
|
39
|
-
execute_request
|
40
|
-
end
|
41
|
-
|
42
|
-
it "re-raises a Net::OpenTimeout error after 3 retries" do
|
43
|
-
expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
|
44
|
-
expect(net_http).to receive(:transport_request).exactly(4).times.and_raise(Net::OpenTimeout)
|
45
|
-
expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
|
46
|
-
expect{execute_request}.to raise_error(Net::OpenTimeout)
|
47
|
-
end
|
48
|
-
|
49
|
-
it "re-raises a Net::ReadTimeout error after 3 retries" do
|
50
|
-
expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
|
51
|
-
expect(net_http).to receive(:transport_request).exactly(4).times.and_raise(Net::ReadTimeout)
|
52
|
-
expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
|
53
|
-
expect{execute_request}.to raise_error(Net::ReadTimeout)
|
54
|
-
end
|
55
|
-
|
56
|
-
it "re-raises a SocketError error after 3 retries" do
|
57
|
-
expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
|
58
|
-
expect(net_http).to receive(:transport_request).exactly(4).times.and_raise(SocketError)
|
59
|
-
expect(net_http).to receive(:do_finish).exactly(4).times.and_call_original
|
60
|
-
expect{execute_request}.to raise_error(SocketError)
|
61
|
-
end
|
62
|
-
end
|
63
|
-
|
64
|
-
describe '#build_request' do
|
65
|
-
subject(:request_uri){ verification_module.send(:build_request) }
|
66
|
-
|
67
|
-
context 'with minimal arguments' do
|
68
|
-
let(:args){ {q: '186 willis st', http: http} }
|
69
|
-
|
70
|
-
it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&key=XXX&secret=YYY&format=json') }
|
71
|
-
end
|
72
|
-
|
73
|
-
context 'with more arguments' do
|
74
|
-
let(:args){ {q: '186 willis st', delivered: true, region_code: 'A', census: '2013', http: http} }
|
75
|
-
|
76
|
-
it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&census=2013&key=XXX&secret=YYY&delivered=true®ion_code=A&format=json') }
|
77
|
-
end
|
78
|
-
|
79
|
-
context 'with a country override' do
|
80
|
-
let(:args){ {q: '186 willis st', country: 'au', http: http} }
|
81
|
-
|
82
|
-
it { expect(request_uri).to eq('/api/au/address/verification?q=186+willis+st&key=XXX&secret=YYY&format=json') }
|
83
|
-
end
|
84
|
-
|
85
|
-
context 'with a state codes as an array' do
|
86
|
-
let(:args){ {q: '186 willis st', country: 'au', state_codes: ['ACT','NSW'], http: http} }
|
87
|
-
|
88
|
-
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') }
|
89
|
-
end
|
90
|
-
|
91
|
-
context 'with a reserved character in the query' do
|
92
|
-
let(:args){ {q: '186=willis st', country: 'au', state_codes: ['ACT','NSW'], http: http} }
|
93
|
-
|
94
|
-
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') }
|
95
|
-
end
|
96
|
-
|
97
|
-
context 'with a state codes as a string' do
|
98
|
-
let(:args){ {q: '186 willis st', country: 'au', state_codes: 'ACT,NSW', http: http} }
|
99
|
-
|
100
|
-
it { expect(request_uri).to eq('/api/au/address/verification?q=186+willis+st&key=XXX&secret=YYY&state_codes=ACT%2CNSW&format=json') }
|
101
|
-
end
|
102
|
-
|
103
|
-
context 'with a key override' do
|
104
|
-
let(:args){ {q: '186 willis st', key: 'AAA', http: http} }
|
105
|
-
|
106
|
-
it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&key=AAA&secret=YYY&format=json') }
|
107
|
-
end
|
108
|
-
|
109
|
-
context 'with a secret override' do
|
110
|
-
let(:args){ {q: '186 willis st', secret: 'BBB', http: http} }
|
111
|
-
|
112
|
-
it { expect(request_uri).to eq('/api/nz/address/verification?q=186+willis+st&key=XXX&secret=BBB&format=json') }
|
113
|
-
end
|
114
|
-
|
115
|
-
context 'with a domain given' do
|
116
|
-
let(:args){ {q: '123', domain: 'testdomain.com', http: http} }
|
117
|
-
|
118
|
-
it { expect(request_uri).to eq('/api/nz/address/verification?q=123&domain=testdomain.com&key=XXX&secret=YYY&format=json') }
|
119
|
-
|
120
|
-
context 'given in the AF configuration' do
|
121
|
-
|
122
|
-
let(:args){ {q: '123', http: http} }
|
123
|
-
|
124
|
-
it 'should use the config domain if set' do
|
125
|
-
AddressFinder.configuration.domain = 'anotherdomain.com'
|
126
|
-
expect(request_uri).to eq('/api/nz/address/verification?q=123&domain=anotherdomain.com&key=XXX&secret=YYY&format=json')
|
127
|
-
AddressFinder.configuration.domain = nil # set back to nil after
|
128
|
-
end
|
129
|
-
end
|
130
|
-
end
|
131
|
-
end
|
132
|
-
|
133
|
-
describe '#build_result' do
|
134
|
-
let(:args){ {q: 'ignored', http: nil} }
|
135
|
-
|
136
|
-
before do
|
137
|
-
verification_module.send('response_body=', body)
|
138
|
-
verification_module.send('response_status=', status)
|
139
|
-
end
|
140
|
-
|
141
|
-
subject(:result){ verification_module.send(:build_result) }
|
142
|
-
|
143
|
-
context 'with a successful nz result' do
|
144
|
-
let(:body){ '{"matched": true, "postal_address": "Texas"}' }
|
145
|
-
let(:status){ '200' }
|
146
|
-
|
147
|
-
it { expect(result.class).to eq(AddressFinder::Verification::Result) }
|
148
|
-
|
149
|
-
it { expect(result.matched).to eq(true) }
|
150
|
-
|
151
|
-
it { expect(result.postal_address).to eq("Texas") }
|
152
|
-
end
|
153
|
-
|
154
|
-
context 'with a successful au result' do
|
155
|
-
let(:body){ %Q({"matched": true, "success": true, "address": {"full_address": "Texas"}}) }
|
156
|
-
let(:status){ '200' }
|
157
|
-
|
158
|
-
it { expect(result.class).to eq(AddressFinder::Verification::Result) }
|
159
|
-
|
160
|
-
it { expect(result.full_address).to eq("Texas") }
|
161
|
-
end
|
162
|
-
|
163
|
-
context 'with an unfound result' do
|
164
|
-
let(:body){ '{"matched": false}' }
|
165
|
-
let(:status){ '200' }
|
166
|
-
|
167
|
-
it { expect(result).to eq(nil) }
|
168
|
-
end
|
169
|
-
end
|
170
|
-
end
|