addressfinder 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00f132e87a8994d62729692417afd3f3ab3139a8
-  data.tar.gz: 7b0e282348a00cf69f1d86f67b4f2b375c316163
+  metadata.gz: 05ba956f56eb4abdf67174b1c8dc8fa60e429855
+  data.tar.gz: 473d3c098ab85f3255409d42fc114dbbddd278bf
 SHA512:
-  metadata.gz: 29d29e3a4d9ce40a8dff5bd41638cd0d1afa07c02e6918eba0c2695f7cee6505ae6b781a28fbfb95254e6151aeb90c19cd84d5bd197b7519ae8f0652c184edb3
-  data.tar.gz: 99c4f04547759bea41ffe1db021d83709ca372881651e1d7484978ffd936d8f4caf123d866308d981d1622cc63b1e321d227a0da4b1ddc19edc16d1715a71da9
+  metadata.gz: 9056caa0b3632c4069dc0f78fea84c876fa3fda0438af6cd771bee2a09aab93087e912decf5eabf923b442994360ec09c063f62d014ea86dd959be1dbf031082
+  data.tar.gz: 0d20f2503daaeed9e724231973414731e65bfa4aa468f37ad7dadd059b226832bdf0f1ac3eadd49fbc395dc746cf5887e092e98691e9aa09ff4473764c1cba24

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# AddressFinder 1.5.2 (December 21, 2015) #
+
+* Update for the nested response format used in Address Cleanse Australia
+* Add an encoding helper which uses CGI::escape
+
 # AddressFinder 1.5.1 (November 25, 2015) #
 
 * Update the ClientProxy #cleanse method to return result instead of an AddressFinder::Cleanse instance

data/README.md

@@ -50,11 +50,12 @@ You can obtain your API key and secret from the AddressFinder Portal.
 See the documentation on the available parameters and expected response here:
 
 https://addressfinder.nz/docs/address_cleanse_api/
+https://addressfinder.com.au/docs/address_cleanse_api/
 
 Usage example:
 
 ```ruby
-result = AddressFinder.cleanse(q: '186 Willis St, Wellington')
+result = AddressFinder.cleanse(q: '186 Willis St, Wellington', country: 'nz')
 
 if result
   $stdout.puts "Success: #{result.postal}"

data/lib/addressfinder.rb

@@ -9,6 +9,7 @@ require 'addressfinder/address_info'
 require 'addressfinder/address_search'
 require 'addressfinder/bulk'
 require 'addressfinder/errors'
+require 'addressfinder/util'
 
 module AddressFinder
   class << self

data/lib/addressfinder/address_info.rb

@@ -33,8 +33,7 @@ module AddressFinder
     end
 
     def encoded_params
-      query = params.map{|k,v| "#{k}=#{v}"}.join('&')
-      URI::encode(query)
+      Util.encode_and_join_params(params)
     end
 
     def execute_request

data/lib/addressfinder/address_search.rb

@@ -33,8 +33,7 @@ module AddressFinder
     end
 
     def encoded_params
-      query = params.map{|k,v| "#{k}=#{v}"}.join('&')
-      URI::encode(query)
+      Util.encode_and_join_params(params)
     end
 
     def execute_request

data/lib/addressfinder/cleanse.rb

@@ -53,18 +53,14 @@ module AddressFinder
       end
 
       if response_hash['matched']
-        self.result = Result.new(response_hash)
+        self.result = Result.new(response_hash['address'] || response_hash)
       else
         self.result = nil
       end
     end
 
     def encoded_params
-      query_params = params.map do |k,v|
-        "#{k}=#{ERB::Util.url_encode(v)}"
-      end
-
-      query_params.join('&')
+      Util.encode_and_join_params(params)
     end
 
     def response_hash

data/lib/addressfinder/location_info.rb

@@ -34,8 +34,7 @@ module AddressFinder
     end
 
     def encoded_params
-      query = params.map{|k,v| "#{k}=#{v}"}.join('&')
-      URI::encode(query)
+      Util.encode_and_join_params(params)
     end
 
     def execute_request

data/lib/addressfinder/location_search.rb

@@ -34,8 +34,7 @@ module AddressFinder
     end
 
     def encoded_params
-      query = params.map{|k,v| "#{k}=#{v}"}.join('&')
-      URI::encode(query)
+      Util.encode_and_join_params(params)
     end
 
     def execute_request

data/lib/addressfinder/util.rb

@@ -0,0 +1,12 @@
+module AddressFinder
+  class Util
+
+    def self.encode(v)
+      CGI::escape(v.to_s)
+    end
+
+    def self.encode_and_join_params(params)
+      params.map{ |k,v| "#{k}=#{encode(v)}" }.join('&')
+    end
+  end
+end

data/lib/addressfinder/version.rb

@@ -1,3 +1,3 @@
 module AddressFinder
-  VERSION = '1.5.1'
+  VERSION = '1.5.2'
 end

data/spec/lib/addressfinder/address_search_spec.rb

@@ -18,31 +18,31 @@ RSpec.describe AddressFinder::AddressSearch do
     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') }
+      it { expect(request_uri).to eq('/api/nz/address.json?q=186+willis&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') }
+      it { expect(request_uri).to eq('/api/nz/address.json?q=186+willis+st&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') }
+      it { expect(request_uri).to eq('/api/au/address.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/nz/address.json?q=186%20willis%20st&key=AAA&secret=YYY') }
+      it { expect(request_uri).to eq('/api/nz/address.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/nz/address.json?q=186%20willis%20st&secret=BBB&key=XXX') }
+      it { expect(request_uri).to eq('/api/nz/address.json?q=186+willis+st&secret=BBB&key=XXX') }
     end
   end
 

data/spec/lib/addressfinder/cleanse_spec.rb

@@ -18,31 +18,31 @@ RSpec.describe AddressFinder::Cleanse do
     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%20willis%20st&format=json&key=XXX&secret=YYY') }
+      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%20willis%20st&delivered=true&region_code=A&format=json&key=XXX&secret=YYY') }
+      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%20willis%20st&format=json&key=XXX&secret=YYY') }
+      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%20willis%20st&format=json&key=AAA&secret=YYY') }
+      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%20willis%20st&format=json&key=XXX&secret=BBB') }
+      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
@@ -73,7 +73,7 @@ RSpec.describe AddressFinder::Cleanse do
 
     subject(:result){ cleanser.send(:build_result) }
 
-    context 'with a successful result' do
+    context 'with a successful nz result' do
       let(:body){ '{"matched": true, "postal_address": "Texas"}' }
       let(:status){ '200' }
 
@@ -84,39 +84,20 @@ RSpec.describe AddressFinder::Cleanse do
       it { expect(result.postal_address).to eq("Texas") }
     end
 
-    context 'with an unfound result' do
-      let(:body){ '{"matched": false}' }
+    context 'with a successful au result' do
+      let(:body){ %Q({"matched": true, "success": true, "address": {"full_address": "Texas"}}) }
       let(:status){ '200' }
 
-      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(result.class).to eq(AddressFinder::Cleanse::Result) }
 
-      it { expect(encoded_params).to eq('q=&format=json&key=XXX&secret=YYY') }
+      it { expect(result.full_address).to eq("Texas") }
     end
 
-    context 'with a nil value' do
-      let(:q){ nil }
+    context 'with an unfound result' do
+      let(:body){ '{"matched": false}' }
+      let(:status){ '200' }
 
-      it { expect(encoded_params).to eq('q=&format=json&key=XXX&secret=YYY') }
+      it { expect(result).to eq(nil) }
     end
   end
 end

data/spec/lib/addressfinder/location_search_spec.rb

@@ -24,25 +24,25 @@ RSpec.describe AddressFinder::LocationSearch do
     context 'with more arguments' do
       let(:args){ {q: 'willis st', street: 1, max: 10} }
 
-      it { expect(request_uri).to eq('/api/nz/location.json?q=willis%20st&street=1&max=10&key=XXX&secret=YYY') }
+      it { expect(request_uri).to eq('/api/nz/location.json?q=willis+st&street=1&max=10&key=XXX&secret=YYY') }
     end
 
     context 'with a country override' do
       let(:args){ {q: 'willis st', country: 'au'} }
 
-      it { expect(request_uri).to eq('/api/au/location.json?q=willis%20st&key=XXX&secret=YYY') }
+      it { expect(request_uri).to eq('/api/au/location.json?q=willis+st&key=XXX&secret=YYY') }
     end
 
     context 'with a key override' do
       let(:args){ {q: 'willis st', key: 'AAA'} }
 
-      it { expect(request_uri).to eq('/api/nz/location.json?q=willis%20st&key=AAA&secret=YYY') }
+      it { expect(request_uri).to eq('/api/nz/location.json?q=willis+st&key=AAA&secret=YYY') }
     end
 
     context 'with a secret override' do
       let(:args){ {q: 'willis st', secret: 'BBB'} }
 
-      it { expect(request_uri).to eq('/api/nz/location.json?q=willis%20st&secret=BBB&key=XXX') }
+      it { expect(request_uri).to eq('/api/nz/location.json?q=willis+st&secret=BBB&key=XXX') }
     end
 
     context 'with a domain given' do

data/spec/lib/addressfinder/util_spec.rb

@@ -0,0 +1,37 @@
+require 'addressfinder/util'
+
+RSpec.describe AddressFinder::Util do
+  describe '.encode_and_join_params' do
+    subject { AddressFinder::Util.encode_and_join_params(params) }
+
+    context 'with a question mark value' do
+      let(:params){ {q:'?',format:'json',key:'XXX',secret:'YYY'} }
+
+      it { is_expected.to eq('q=%3F&format=json&key=XXX&secret=YYY') }
+    end
+
+    context 'with an ampersand value' do
+      let(:params){ {q:'&',format:'json',key:'XXX',secret:'YYY'} }
+
+      it { is_expected.to eq('q=%26&format=json&key=XXX&secret=YYY') }
+    end
+
+    context 'with a normal address value' do
+      let(:params){ {q:'12 high',format:'json',key:'XXX',secret:'YYY'} }
+
+      it { is_expected.to eq('q=12+high&format=json&key=XXX&secret=YYY') }
+    end
+
+    context 'with a blank value' do
+      let(:params){ {q:'',format:'json',key:'XXX',secret:'YYY'} }
+
+      it { is_expected.to eq('q=&format=json&key=XXX&secret=YYY') }
+    end
+
+    context 'with a nil value' do
+      let(:params){ {q:nil,format:'json',key:'XXX',secret:'YYY'} }
+
+      it { is_expected.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.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Nigel Ramsay
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2015-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -111,12 +111,14 @@ files:
 - lib/addressfinder/errors.rb
 - lib/addressfinder/location_info.rb
 - lib/addressfinder/location_search.rb
+- lib/addressfinder/util.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
+- spec/lib/addressfinder/util_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/AbleTech/addressfinder-ruby
 licenses:
@@ -148,4 +150,5 @@ test_files:
 - spec/lib/addressfinder/cleanse_spec.rb
 - spec/lib/addressfinder/location_info_spec.rb
 - spec/lib/addressfinder/location_search_spec.rb
+- spec/lib/addressfinder/util_spec.rb
 - spec/spec_helper.rb