addressfinder 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d2d3c4923e027e17a94375f9ace07771fc20644
-  data.tar.gz: e17d6c8121c855971b817eaf1807805eeaa708b4
+  metadata.gz: 3e898a98cb65edda0b68b91cf7dd80f5b1678618
+  data.tar.gz: ae753e8e1f56f6aee705b7ee8f7fcb58d6063056
 SHA512:
-  metadata.gz: 58ea4d86be9dc5cab93385a9482247a88d934c0582f9b246f47abef938d97fe2de6bed37c14e110604d448dcf5edf405e0afdbcab66be338fef16d2da3005a3e
-  data.tar.gz: 3568aa198161346b55abe3e941e7ddf027134dcf54ec46e2bd6f46be4d1358ce356eb29e83a70e77776c9f6ef165ec5c973f6f40b5a37ea947940de4c16e9bb4
+  metadata.gz: 6bfb48dfc96843b4000dd91bd9df7e78d443fb271c753457b296bb8d1ddabe3944b4f27bad1b3ef8949a8058073a468189ae8d11116df5fda45b4dbcabb42f7f
+  data.tar.gz: 24efefe0cfc07c40148605f527d57591b7beff0122448e7e7e16fde443dd9f289d449e05e609b0d7301781adee93e3def00a5c939ff20dcde7a2b880325a926b

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# AddressFinder 1.4.0 (October 19, 2015) #
+
+* Add support for Address Search API
+* Add support for Address Info API
+
 # AddressFinder 1.3.0 (October 16, 2015) #
 
 * Add optional domain parameter to configuration and API calls

data/README.md

@@ -89,7 +89,7 @@ end
 
 See documentation on the available parameters and expected response here:
 
-https://addressfinder.nz/docs/address_info_api/
+https://addressfinder.nz/docs/location_info_api/
 
 Usage example:
 
@@ -107,6 +107,50 @@ rescue AddressFinder::RequestRejectedError => e
 end
 ```
 
+### Address Search
+
+See documentation on the available parameters and expected response here:
+
+https://addressfinder.nz/docs/address_api/
+
+Usage example:
+
+```ruby
+begin
+  results = AddressFinder.address_search(q: '186 Willis Street')
+  if results.any?
+    $standout.puts "Success: #{results}"
+  else
+    $standout.puts "Sorry, there were no address matches"
+  end
+rescue AddressFinder::RequestRejectedError => e
+  response = JSON.parse(e.body)
+  $standout.puts response['message']
+end
+```
+
+### Address Info
+
+See documentation on the available parameters and expected response here:
+
+https://addressfinder.nz/docs/address_info_api/
+
+Usage example:
+
+```ruby
+begin
+  result = AddressFinder.address_info(pxid: '1-.B.3l')
+  if result
+    $standout.puts "Success: #{result.a}"
+  else
+    $standout.puts "Sorry, can't find that address"
+  end
+rescue AddressFinder::RequestRejectedError => e
+  response = JSON.parse(e.body)
+  $standout.puts response['message']
+end
+```
+
 ### Bulk Operations
 
 If you have a series of calls you need to make to AddressFinder, you can use the

data/lib/addressfinder.rb

@@ -5,6 +5,8 @@ require 'addressfinder/configuration'
 require 'addressfinder/cleanse'
 require 'addressfinder/location_info'
 require 'addressfinder/location_search'
+require 'addressfinder/address_info'
+require 'addressfinder/address_search'
 require 'addressfinder/bulk'
 require 'addressfinder/errors'
 
@@ -36,6 +38,14 @@ module AddressFinder
       AddressFinder::LocationInfo.new(params: args, http: configure_http).perform.result
     end
 
+    def address_search(args={})
+      AddressFinder::AddressSearch.new(params: args, http: configure_http).perform.results
+    end
+
+    def address_info(args={})
+      AddressFinder::AddressInfo.new(params: args, http: configure_http).perform.result
+    end
+
     def bulk(&block)
       # TODO include parameter http: configure_http
       AddressFinder::Bulk.new(&block).perform

data/lib/addressfinder/address_info.rb

@@ -0,0 +1,71 @@
+require 'ostruct'
+
+module AddressFinder
+  class AddressInfo
+
+    attr_reader :result
+
+    def initialize(params:, http:)
+      @http = http
+      @country = params.delete(:country) || config.default_country
+
+      @params = params
+      @params['key'] = config.api_key
+      @params['secret'] = config.api_secret
+    end
+
+    def perform
+      build_request
+      execute_request
+      build_result
+
+      self
+    end
+
+    private
+
+    attr_reader :request_uri, :params, :country, :http
+    attr_accessor :response_body, :response_status
+    attr_writer :result
+
+    def build_request
+      @request_uri = "/api/#{country}/address/info.json?#{encoded_params}"
+    end
+
+    def encoded_params
+      query = params.map{|k,v| "#{k}=#{v}"}.join('&')
+      URI::encode(query)
+    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.result = Result.new(response_hash)
+      when '404'
+        raise AddressFinder::NotFoundError.new(@response_status, @response_body, @pxid)
+      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/address_search.rb

@@ -0,0 +1,71 @@
+require 'ostruct'
+
+module AddressFinder
+  class AddressSearch
+
+    attr_reader :results
+
+    def initialize(params:, http:)
+      @http = http
+      @country = params.delete(:country) || config.default_country
+
+      @params = params
+      @params['key'] = config.api_key
+      @params['secret'] = config.api_secret
+    end
+
+    def perform
+      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 build_request
+      @request_uri = "/api/#{country}/address.json?#{encoded_params}"
+    end
+
+    def encoded_params
+      query = params.map{|k,v| "#{k}=#{v}"}.join('&')
+      URI::encode(query)
+    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/cleanse.rb

@@ -60,8 +60,11 @@ module AddressFinder
     end
 
     def encoded_params
-      query = params.map{|k,v| "#{k}=#{v}"}.join('&')
-      URI::encode(query)
+      query_params = params.map do |k,v|
+        "#{k}=#{ERB::Util.url_encode(v)}"
+      end
+
+      query_params.join('&')
     end
 
     def response_hash

data/lib/addressfinder/version.rb

@@ -1,3 +1,3 @@
 module AddressFinder
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

data/spec/lib/addressfinder/address_info_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+RSpec.describe AddressFinder::AddressInfo 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::AddressInfo.new(params: args, http: http) }
+    let(:http){ AddressFinder.send(:configure_http) }
+
+    subject(:request_uri){ locator.send(:build_request) }
+
+    context 'with a simple PXID' do
+      let(:args){ {pxid: '123'} }
+
+      it { expect(request_uri).to eq('/api/au/address/info.json?pxid=123&key=XXX&secret=YYY') }
+    end
+
+    context 'with a country override' do
+      let(:args){ {pxid: '123'} }
+
+      it { expect(request_uri).to eq('/api/au/address/info.json?pxid=123&key=XXX&secret=YYY') }
+    end
+  end
+
+  describe '#build_result' do
+    let(:locator){ AddressFinder::AddressInfo.new(params: {q: 'ignored'}, http: nil) }
+
+    before do
+      locator.send('response_body=', body)
+      locator.send('response_status=', status)
+    end
+
+    subject(:result){ locator.send(:build_result) }
+
+    context 'with a successful result' do
+      let(:body){ '{"pxid":"2-.9.2U.F.F.2I","number":"184","container_only":"false","x":"174.314855382547","y":"-35.6946659390092","postcode":"0112","a":"184 William Jones Drive, Otangarei, Whangarei 0112","postal":"184 William Jones Drive, Otangarei, Whangarei 0112","mailtown":"Whangarei","post_suburb":"Otangarei","ta":"Whangarei District","sufi":932755,"street_type":"drive","city":"Whangarei","suburb":"Otangarei","region":"Northland Region","street":"William Jones Drive","postal_line_1":"184 William Jones Drive","postal_line_2":"Otangarei","postal_line_3":"Whangarei 0112","meshblock":"93700","dpid":"681856"}' }
+      let(:status){ '200' }
+
+      it { expect(result.class).to eq(AddressFinder::AddressInfo::Result) }
+      it { expect(result.a).to eq("184 William Jones Drive, Otangarei, Whangarei 0112") }
+      it { expect(result.pxid).to eq("2-.9.2U.F.F.2I") }
+    end
+  end
+end

data/spec/lib/addressfinder/address_search_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+RSpec.describe AddressFinder::AddressSearch 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(:locator){ AddressFinder::AddressSearch.new(params: args, http: http) }
+    let(:http){ AddressFinder.send(:configure_http) }
+
+    subject(:request_uri){ locator.send(:build_request) }
+
+    context 'with minimal arguments' do
+      let(:args){ {q: '186 willis'} }
+
+      it { expect(request_uri).to eq('/api/nz/address.json?q=186%20willis&key=XXX&secret=YYY') }
+    end
+
+    context 'with more arguments' do
+      let(:args){ {q: '186 willis st', delivered: 1, max: 10} }
+
+      it { expect(request_uri).to eq('/api/nz/address.json?q=186%20willis%20st&delivered=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.json?q=186%20willis%20st&key=XXX&secret=YYY') }
+    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/cleanse_spec.rb

@@ -79,4 +79,32 @@ RSpec.describe AddressFinder::Cleanse do
       it { expect(result).to eq(nil) }
     end
   end
+
+  describe '#encoded_params' do
+    subject(:encoded_params){ AddressFinder::Cleanse.new(q: q, http: nil).send(:encoded_params) }
+
+    context 'with a question mark value' do
+      let(:q){ '?' }
+
+      it { expect(encoded_params).to eq('q=%3F&format=json&key=XXX&secret=YYY') }
+    end
+
+    context 'with a normal address value' do
+      let(:q){ '12 high' }
+
+      it { expect(encoded_params).to eq('q=12%20high&format=json&key=XXX&secret=YYY') }
+    end
+
+    context 'with a blank value' do
+      let(:q){ '' }
+
+      it { expect(encoded_params).to eq('q=&format=json&key=XXX&secret=YYY') }
+    end
+
+    context 'with a nil value' do
+      let(:q){ nil }
+
+      it { expect(encoded_params).to eq('q=&format=json&key=XXX&secret=YYY') }
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: addressfinder
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Nigel Ramsay
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-15 00:00:00.000000000 Z
+date: 2015-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -101,6 +101,8 @@ files:
 - Rakefile
 - addressfinder.gemspec
 - lib/addressfinder.rb
+- lib/addressfinder/address_info.rb
+- lib/addressfinder/address_search.rb
 - lib/addressfinder/bulk.rb
 - lib/addressfinder/cleanse.rb
 - lib/addressfinder/configuration.rb
@@ -108,6 +110,8 @@ files:
 - lib/addressfinder/location_info.rb
 - lib/addressfinder/location_search.rb
 - lib/addressfinder/version.rb
+- spec/lib/addressfinder/address_info_spec.rb
+- spec/lib/addressfinder/address_search_spec.rb
 - spec/lib/addressfinder/cleanse_spec.rb
 - spec/lib/addressfinder/location_info_spec.rb
 - spec/lib/addressfinder/location_search_spec.rb
@@ -132,11 +136,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Provides easy access to AddressFinder APIs
 test_files:
+- spec/lib/addressfinder/address_info_spec.rb
+- spec/lib/addressfinder/address_search_spec.rb
 - spec/lib/addressfinder/cleanse_spec.rb
 - spec/lib/addressfinder/location_info_spec.rb
 - spec/lib/addressfinder/location_search_spec.rb