addressfinder 1.5.2 → 1.7.1

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,24 +1,19 @@
 module AddressFinder
   class Bulk
-    def initialize(&block)
+    def initialize(http:, &block)
       @block = block
+      @http_config = http
     end
 
     def perform
-      Net::HTTP.start(config.hostname, config.port, use_ssl: true,
-                                                    open_timeout: config.timeout,
-                                                    read_timeout: config.timeout) do |http|
+      http_config.start do |http|
         block.call ClientProxy.new(http: http)
       end
     end
 
     private
 
-    attr_reader :block
-
-    def config
-      @_config ||= AddressFinder.configuration
-    end
+    attr_reader :block, :http_config
 
     class ClientProxy
       def initialize(http:)
@@ -26,7 +21,11 @@ module AddressFinder
       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={})
+        AddressFinder::Verification.new(args.merge(http: http)).perform.result
       end
 
       private

data/lib/addressfinder/configuration.rb

@@ -11,11 +11,15 @@ module AddressFinder
     attr_accessor :timeout
     attr_accessor :default_country
     attr_accessor :domain
+    attr_accessor :retries
+    attr_accessor :retry_delay
 
     def initialize
       self.hostname = 'api.addressfinder.io'
       self.port = 443
       self.timeout = 10
+      self.retries = 12
+      self.retry_delay = 5
       self.default_country = 'nz'
     end
   end

data/lib/addressfinder/http.rb

@@ -0,0 +1,55 @@
+require 'net/http'
+
+module AddressFinder
+  class HTTP
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+      @connection_is_bad = false
+    end
+
+    def start(&block)
+      net_http.start do
+        block.call(self)
+      end
+    end
+
+    def request(args)
+      retries = 0
+      begin
+        re_establish_connection if @connection_is_bad
+        net_http.request(args)
+      rescue Net::ReadTimeout, Net::OpenTimeout, SocketError => error
+        if retries < config.retries
+          retries += 1
+          sleep(config.retry_delay)
+          @connection_is_bad = true if net_http.started?
+          retry
+        else
+          raise error
+        end
+      end
+    end
+
+    private
+
+    def re_establish_connection
+      @connection_is_bad = false
+      net_http.finish
+      net_http.start
+    end
+
+    def net_http
+      @net_http ||= begin
+        http = Net::HTTP.new(config.hostname, config.port, config.proxy_host,
+                             config.proxy_port, config.proxy_user,
+                             config.proxy_password)
+        http.open_timeout = config.timeout
+        http.read_timeout = config.timeout
+        http.use_ssl = true
+        http
+      end
+    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/{cleanse.rb → verification.rb}

@@ -1,17 +1,20 @@
 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, domain: nil, key: nil, secret: nil, http:)
+    def initialize(q:, country: nil, delivered: nil, post_box: nil, paf: nil, rural: nil, region_code: nil, state_codes: nil, census: nil, domain: nil, key: nil, secret: nil, http:)
       @params = {}
       @params['q'] = q
       @params['delivered'] = delivered if delivered
       @params['post_box'] = post_box if post_box
+      @params['paf'] = paf if paf
       @params['rural'] = rural if rural
       @params['region_code'] = region_code if region_code
+      @params['state_codes'] = state_codes if state_codes
+      @params['census'] = census if census
       @params['domain'] = domain || config.domain if (domain || config.domain)
       @params['format'] = 'json'
       @params['key'] = key || config.api_key
@@ -35,7 +38,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.5.2'
+  VERSION = '1.7.1'
 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/address_info_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe AddressFinder::AddressInfo do
 
   describe '#build_request' do
     let(:locator){ AddressFinder::AddressInfo.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/address_search_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe AddressFinder::AddressSearch do
 
   describe '#build_request' do
     let(:locator){ AddressFinder::AddressSearch.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/bulk_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+RSpec.describe AddressFinder::Bulk 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 '#perform' do
+    let(:http){ AddressFinder::HTTP.new(AddressFinder.configuration) }
+    let(:net_http){ http.send(:net_http) }
+
+    before do
+      WebMock.allow_net_connect!(net_http_connect_on_start: true)
+      allow(http).to receive(:sleep)
+    end
+
+    after do
+      WebMock.disable_net_connect!
+    end
+
+    context "with 3 requests in the provided block" do
+      let(:response){ double(:response, body: %Q({"success": true}), code: "200") }
+      let(:block){
+        Proc.new do |proxy|
+          proxy.verification(q: "1 Willis")
+          proxy.verification(q: "2 Willis")
+          proxy.verification(q: "3 Willis")
+        end
+      }
+
+      it "uses 1 http connection" 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
+      end
+
+      it "re-establishes the http connection and continues where we left off when a Net::OpenTimeout, Net::ReadTimeout or SocketError is raised" do
+        expect(http).to receive(:re_establish_connection).exactly(3).times.and_call_original
+        expect(net_http).to receive(:do_start).exactly(4).times.and_call_original
+        expect(net_http).to receive(:transport_request).once.and_return(response) # 1 Willis (success)
+        expect(net_http).to receive(:transport_request).once.and_raise(Net::OpenTimeout) # 2 Willis (error)
+        expect(net_http).to receive(:transport_request).once.and_raise(Net::ReadTimeout) # Retry 2 Willis (error)
+        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
+      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, &block).perform
+      end
+    end
+  end
+end

data/spec/lib/addressfinder/location_info_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe AddressFinder::LocationInfo do
 
   describe '#build_request' do
     let(:locator){ AddressFinder::LocationInfo.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) }