addressfinder 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e898a98cb65edda0b68b91cf7dd80f5b1678618
-  data.tar.gz: ae753e8e1f56f6aee705b7ee8f7fcb58d6063056
+  metadata.gz: cd5b1ce66a9ed764e1e42cb407b2ca8887f17769
+  data.tar.gz: d611d57cdf18997cd16118428304d7601caecd75
 SHA512:
-  metadata.gz: 6bfb48dfc96843b4000dd91bd9df7e78d443fb271c753457b296bb8d1ddabe3944b4f27bad1b3ef8949a8058073a468189ae8d11116df5fda45b4dbcabb42f7f
-  data.tar.gz: 24efefe0cfc07c40148605f527d57591b7beff0122448e7e7e16fde443dd9f289d449e05e609b0d7301781adee93e3def00a5c939ff20dcde7a2b880325a926b
+  metadata.gz: 7fb527e911f117fae0d47756baf63613c602085014bf9cb2576b6d0d1fd28798ebd45bda55e446c0b7f52126cc006d745d3a8958651cec51640de0de99d727e3
+  data.tar.gz: 0dceb57bfa8962fc79ef50405342735814a57e5f39be9d010bec8999e467f05a184f50d77f44a0a93447e3f97988de2b49f54ca54b434a98da0f7c06d4d60374

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# AddressFinder 1.5.0 (October 19, 2015) #
+
+* Add support for supplying `key` and `secret` override values in each API call
+
 # AddressFinder 1.4.0 (October 19, 2015) #
 
 * Add support for Address Search API

data/README.md

@@ -171,3 +171,35 @@ AddressFinder.bulk do |af|
   end
 end
 ```
+
+## Advanced Usage
+
+### Key and Secret Override
+
+What if you want to use another acccount for a specific query using the AddressFinder gem in your ruby app?
+
+You can override the `api_key` and `api_secret` set in the AddressFinder.configure block in `./config/initializers/addressfinder.rb` when using the AddressFinder gem.
+
+Those AddressFinder methods accept `:key` and `:secret` arguments:
+- `#cleanse`,
+- `#location_search`,
+- `#location_info`,
+- `#address_search`
+- `#address_info`
+
+Usage example:
+
+```ruby
+begin
+  result = AddressFinder.address_info(pxid: '1-.B.3l', key: 'AAAAAAAAAAAAA', secret: 'BBBBBBBBBBBBB')
+  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
+```
+

data/addressfinder.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |gem|
   gem.name          = "addressfinder"
   gem.version       = AddressFinder::VERSION
   gem.licenses      = ['MIT']
-  gem.authors       = ["Nigel Ramsay", "Naiki Pohe", "Sean Arnold"]
-  gem.email         = ["nigel.ramsay@abletech.co.nz", "naiki.pohe@abletech.co.nz", "seanarnie@gmail.com"]
+  gem.authors       = ["Nigel Ramsay", "Naiki Pohe", "Sean Arnold", "Alexandre Barret"]
+  gem.email         = ["nigel.ramsay@abletech.co.nz", "naiki.pohe@abletech.co.nz", "seanarnie@gmail.com", "alex@abletech.nz"]
   gem.description   = %q{Ruby client library for AddressFinder}
   gem.summary       = %q{Provides easy access to AddressFinder APIs}
   gem.homepage      = "https://github.com/AbleTech/addressfinder-ruby"

data/lib/addressfinder/address_info.rb

@@ -10,8 +10,8 @@ module AddressFinder
       @country = params.delete(:country) || config.default_country
 
       @params = params
-      @params['key'] = config.api_key
-      @params['secret'] = config.api_secret
+      @params[:key] ||= config.api_key
+      @params[:secret] ||= config.api_secret
     end
 
     def perform

data/lib/addressfinder/address_search.rb

@@ -10,8 +10,8 @@ module AddressFinder
       @country = params.delete(:country) || config.default_country
 
       @params = params
-      @params['key'] = config.api_key
-      @params['secret'] = config.api_secret
+      @params[:key] ||= config.api_key
+      @params[:secret] ||= config.api_secret
     end
 
     def perform

data/lib/addressfinder/cleanse.rb

@@ -5,7 +5,7 @@ module AddressFinder
 
     attr_reader :result
 
-    def initialize(q:, country: nil, delivered: nil, post_box: nil, rural: nil, region_code: nil, domain: nil, http:)
+    def initialize(q:, country: nil, delivered: nil, post_box: nil, rural: nil, region_code: nil, domain: nil, key: nil, secret: nil, http:)
       @params = {}
       @params['q'] = q
       @params['delivered'] = delivered if delivered
@@ -14,8 +14,8 @@ module AddressFinder
       @params['region_code'] = region_code if region_code
       @params['domain'] = domain || config.domain if (domain || config.domain)
       @params['format'] = 'json'
-      @params['key'] = config.api_key
-      @params['secret'] = config.api_secret
+      @params['key'] = key || config.api_key
+      @params['secret'] = secret || config.api_secret
       @country = country || config.default_country
       @http = http
     end

data/lib/addressfinder/location_info.rb

@@ -11,8 +11,8 @@ module AddressFinder
 
       @params = params
       @params['domain'] = params['domain'] || config.domain if (params['domain'] || config.domain)
-      @params['key'] = config.api_key
-      @params['secret'] = config.api_secret
+      @params[:key] ||= config.api_key
+      @params[:secret] ||= config.api_secret
     end
 
     def perform

data/lib/addressfinder/location_search.rb

@@ -11,8 +11,8 @@ module AddressFinder
 
       @params = params
       @params['domain'] = params['domain'] || config.domain if (params['domain'] || config.domain)
-      @params['key'] = config.api_key
-      @params['secret'] = config.api_secret
+      @params[:key] ||= config.api_key
+      @params[:secret] ||= config.api_secret
     end
 
     def perform

data/lib/addressfinder/version.rb

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

data/spec/lib/addressfinder/address_info_spec.rb

@@ -22,9 +22,21 @@ RSpec.describe AddressFinder::AddressInfo do
     end
 
     context 'with a country override' do
-      let(:args){ {pxid: '123'} }
+      let(:args){ {pxid: '123', country: 'nz'} }
 
-      it { expect(request_uri).to eq('/api/au/address/info.json?pxid=123&key=XXX&secret=YYY') }
+      it { expect(request_uri).to eq('/api/nz/address/info.json?pxid=123&key=XXX&secret=YYY') }
+    end
+
+    context 'with a key override' do
+      let(:args){ {pxid: '123', key:'AAA'} }
+
+      it { expect(request_uri).to eq('/api/au/address/info.json?pxid=123&key=AAA&secret=YYY') }
+    end
+
+    context 'with a secret override' do
+      let(:args){ {pxid: '123', secret: 'BBB'} }
+
+      it { expect(request_uri).to eq('/api/au/address/info.json?pxid=123&secret=BBB&key=XXX') }
     end
   end
 

data/spec/lib/addressfinder/address_search_spec.rb

@@ -32,6 +32,18 @@ RSpec.describe AddressFinder::AddressSearch do
 
       it { expect(request_uri).to eq('/api/au/address.json?q=186%20willis%20st&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') }
+    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') }
+    end
   end
 
   describe '#build_result' do

data/spec/lib/addressfinder/cleanse_spec.rb

@@ -33,6 +33,18 @@ RSpec.describe AddressFinder::Cleanse do
       it { expect(request_uri).to eq('/api/au/address/cleanse?q=186%20willis%20st&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') }
+    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') }
+    end
+
     context 'with a domain given' do
       let(:args){ {q: '123', domain: 'testdomain.com', http: http} }
 

data/spec/lib/addressfinder/location_info_spec.rb

@@ -22,9 +22,21 @@ RSpec.describe AddressFinder::LocationInfo do
     end
 
     context 'with a country override' do
-      let(:args){ {pxid: '123'} }
+      let(:args){ {pxid: '123', country: 'nz'} }
 
-      it { expect(request_uri).to eq('/api/au/location/info.json?pxid=123&key=XXX&secret=YYY') }
+      it { expect(request_uri).to eq('/api/nz/location/info.json?pxid=123&key=XXX&secret=YYY') }
+    end
+
+    context 'with a key override' do
+      let(:args){ {pxid: '123', key: 'AAA'} }
+
+      it { expect(request_uri).to eq('/api/au/location/info.json?pxid=123&key=AAA&secret=YYY') }
+    end
+
+    context 'with a secret override' do
+      let(:args){ {pxid: '123', secret: 'BBB'} }
+
+      it { expect(request_uri).to eq('/api/au/location/info.json?pxid=123&secret=BBB&key=XXX') }
     end
 
     context 'with a domain given' do

data/spec/lib/addressfinder/location_search_spec.rb

@@ -33,6 +33,18 @@ RSpec.describe AddressFinder::LocationSearch do
       it { expect(request_uri).to eq('/api/au/location.json?q=willis%20st&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') }
+    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') }
+    end
+
     context 'with a domain given' do
       let(:args){ {q: '123', domain: 'testdomain.com'} }
 

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: addressfinder
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Nigel Ramsay
 - Naiki Pohe
 - Sean Arnold
+- Alexandre Barret
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2015-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -87,6 +88,7 @@ email:
 - nigel.ramsay@abletech.co.nz
 - naiki.pohe@abletech.co.nz
 - seanarnie@gmail.com
+- alex@abletech.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -136,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Provides easy access to AddressFinder APIs