addressfinder 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de05727d08ca624896115f6fe76ae68bb3dd36ed99195468153cf982c9af07a0
-  data.tar.gz: 30ba24d9f052a8884ec5772b8d0d492f1334636674ae29e265ddd3fb105d51dd
+  metadata.gz: b611487efde8627017242a6a2c631fb4c617b9c4721ed803f75c85ee466c86e3
+  data.tar.gz: 4d3f919d8b9e2217b4911f8b7da663c7793b8f09bd61377474760b69f3818907
 SHA512:
-  metadata.gz: 160bee2722353ec131681b401a1ddb92748cb606b4e0bf5d1572a924becf1475a61431ef8382f39df9e361a4133d300714ec029033a631285f62f646c3428e17
-  data.tar.gz: e1d026848279132f2cd4b2e1ba35061adee84fcac56e89b54fc336b7caff2386e4123a9f5686ea0792dc371fd6a2ba6fa35195d8dfd28a858de43e376cc423f5
+  metadata.gz: 7241c2ec121dcd4b3381968bf53394ec8911b0dfe6b1a03436055c739ad50c12180371ebd3ec48209fa82d63d0a0d8fcffeda44389054a132f84bff3edd60153
+  data.tar.gz: d1e00512432a0c15f8f19fc4b5a629408d2eab5ee216e9d76176e2574e4071080c1c181d250343da997d58ff6d799d5dd74bb87849fc88296d9e92b422a13326

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 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

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 cleansing directories
+RUN mkdir -p $INSTALL_PATH/cleansing/originals
+RUN mkdir -p $INSTALL_PATH/cleansing/cleansed
+
+# 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/README.md

@@ -65,7 +65,12 @@ else
 end
 ```
 
-#### Address Autocomplete
+#### 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 +86,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
@@ -171,3 +196,13 @@ 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

@@ -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.rb

@@ -6,6 +6,7 @@ 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'
@@ -43,6 +44,10 @@ 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

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/version.rb

@@ -1,3 +1,3 @@
 module AddressFinder
-  VERSION = '1.6.2'
+  VERSION = '1.7.0'
 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: addressfinder
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Nigel Ramsay
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-23 00:00:00.000000000 Z
+date: 2020-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -61,14 +61,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,14 +89,14 @@ 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
@@ -110,13 +110,16 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - Guardfile
 - LICENSE
 - 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
@@ -128,6 +131,7 @@ files:
 - lib/addressfinder/location_search.rb
 - lib/addressfinder/util.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
@@ -160,6 +164,7 @@ 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