addressfinder 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a4f13013752f2897a65b1ae37cdf75432e48d65
-  data.tar.gz: 736cb348b5e219a390025fa85054cc639a4f97cc
+  metadata.gz: dd55287eea55045c57b60b4a33a650c25aba42b0
+  data.tar.gz: 88d85b667c45378a01c370d9b7453845ee1e403b
 SHA512:
-  metadata.gz: f913ac44544240ce9270c202a5916e26d323669f41c494438560316f548657f39c2ee78591ea55a4c3e87eb3be8ca96e4f9ff8995826f094a8782d874818404b
-  data.tar.gz: cf7ce295d772e3902e79f023bb4ecfac1f61129b23f1c714d79e31294760e50a16d6f467a64781d04339d85cbb1acc0e365b839712b67ef24871049dc4a0de99
+  metadata.gz: 05ae9738123018521f49e009ffc0485574a246e2879459b9736170ece70b1923dd50aae07303c28a2e853dc54e7757be42df54a4690acf24dd79338f79fc97ac
+  data.tar.gz: c591f3700cbc86b90cf447a16d79b49e1487a8e1db7b43e45f4b1dc314fb66271b1e8e086edab3118fc2b364f2b474bbed623c80a0dab636d0cb32bf15d8985a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# AddressFinder 1.2.0 (October 1, 2015) #
+
+* Add support for Location Search API
+* Add support for Location Info API
+
 # AddressFinder 1.1.2 (September 23, 2015) #
 
 * Minor bugfixes

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -62,6 +62,50 @@ else
 end
 ```
 
+### Location Search
+
+See documentation on the available parameters and expected response here:
+
+https://addressfinder.nz/docs/location_api/
+
+Usage example:
+
+```ruby
+begin
+  results = AddressFinder.location_search(q: 'Queen Street')
+  if results.any?
+    $standout.puts "Success: #{results}"
+  else
+    $standout.puts "Sorry, there were no location matches"
+  end
+rescue AddressFinder::RequestRejectedError => e
+  response = JSON.parse(e.body)
+  $standout.puts response['message']
+end
+```
+
+### Location Info
+
+See documentation on the available parameters and expected response here:
+
+https://addressfinder.nz/docs/address_info_api/
+
+Usage example:
+
+```ruby
+begin
+  result = AddressFinder.location_info(pxid: '1-.B.3l')
+  if result
+    $standout.puts "Success: #{result.a}"
+  else
+    $standout.puts "Sorry, can't find that location"
+  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/addressfinder.gemspec

@@ -19,8 +19,9 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '~> 2.1'
   gem.add_runtime_dependency 'multi_json', '~> 1.0'
 
-  gem.add_development_dependency 'rspec', '>= 3.3.0'
-  gem.add_development_dependency 'bundler'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'rspec', '~> 3.3'
+  gem.add_development_dependency 'guard-rspec', '~> 4.5'
+  gem.add_development_dependency 'bundler', '~> 0'
+  gem.add_development_dependency 'rake', '~> 0'
+  gem.add_development_dependency 'webmock', '~> 0'
 end

data/lib/addressfinder.rb

@@ -3,6 +3,8 @@ require 'multi_json'
 require 'addressfinder/version'
 require 'addressfinder/configuration'
 require 'addressfinder/cleanse'
+require 'addressfinder/location_info'
+require 'addressfinder/location_search'
 require 'addressfinder/bulk'
 require 'addressfinder/errors'
 
@@ -26,6 +28,14 @@ module AddressFinder
       AddressFinder::Cleanse.new(args.merge(http: configure_http)).perform.result
     end
 
+    def location_search(args={})
+      AddressFinder::LocationSearch.new(params: args, http: configure_http).perform.results
+    end
+
+    def location_info(args={})
+      AddressFinder::LocationInfo.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/errors.rb

@@ -10,4 +10,17 @@ module AddressFinder
       super("Request rejected with status code: #{status}\n#{body}")
     end
   end
+
+  class NotFoundError < StandardError
+
+    attr_reader :status, :body, :pxid
+
+    def initialize(status, body, pxid)
+      @status = status
+      @body = body
+      @pxid = pxid
+
+      super("The address or location you have requested could not be found.\n#{body}")
+    end
+  end
 end

data/lib/addressfinder/location_info.rb

@@ -0,0 +1,71 @@
+require 'ostruct'
+
+module AddressFinder
+  class LocationInfo
+
+    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}/location/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/location_search.rb

@@ -0,0 +1,71 @@
+require 'ostruct'
+
+module AddressFinder
+  class LocationSearch
+
+    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}/location.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/version.rb

@@ -1,3 +1,3 @@
 module AddressFinder
-  VERSION = '1.1.2'
+  VERSION = '1.2.0'
 end

data/spec/lib/addressfinder/location_info_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+RSpec.describe AddressFinder::LocationInfo 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::LocationInfo.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/location/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/location/info.json?pxid=123&key=XXX&secret=YYY') }
+    end
+  end
+
+  describe '#build_result' do
+    let(:locator){ AddressFinder::LocationInfo.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){ '{"a":"Seaview Road, Glenfield, Auckland","city":"Auckland","suburb":"Glenfield","region":"Auckland Region","x":174.713938691835,"y":-36.7894885545157,"pxid":"1-.1.6.j.1F","street":"Seaview Road"}' }
+      let(:status){ '200' }
+
+      it { expect(result.class).to eq(AddressFinder::LocationInfo::Result) }
+      it { expect(result.a).to eq("Seaview Road, Glenfield, Auckland") }
+      it { expect(result.pxid).to eq("1-.1.6.j.1F") }
+    end
+  end
+end

data/spec/lib/addressfinder/location_search_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+RSpec.describe AddressFinder::LocationSearch 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::LocationSearch.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: 'willis'} }
+
+      it { expect(request_uri).to eq('/api/nz/location.json?q=willis&key=XXX&secret=YYY') }
+    end
+
+    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') }
+    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') }
+    end
+  end
+
+  describe '#build_result' do
+    let(:locator){ AddressFinder::LocationSearch.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":"Willowbank","pxid":"1-.B.3l","v":0},{"a":"Willowby","pxid":"1-.3.4O","v":0}],"paid":true}' }
+      let(:status){ '200' }
+
+      it { expect(results.size).to eq(2) }
+      it { expect(results.first.class).to eq(AddressFinder::LocationSearch::Result) }
+      it { expect(results.first.a).to eq("Willowbank") }
+    end
+
+    context 'with no completions' do
+      let(:body){ '{"completions":[],"paid":true}' }
+      let(:status){ '200' }
+
+      it { expect(results).to eq([]) }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: addressfinder
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Nigel Ramsay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-23 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -28,56 +28,70 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby client library for AddressFinder
@@ -91,6 +105,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -100,8 +115,12 @@ files:
 - lib/addressfinder/cleanse.rb
 - lib/addressfinder/configuration.rb
 - lib/addressfinder/errors.rb
+- lib/addressfinder/location_info.rb
+- lib/addressfinder/location_search.rb
 - lib/addressfinder/version.rb
 - spec/lib/addressfinder/cleanse_spec.rb
+- spec/lib/addressfinder/location_info_spec.rb
+- spec/lib/addressfinder/location_search_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/AbleTech/addressfinder-ruby
 licenses:
@@ -123,10 +142,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Provides easy access to AddressFinder APIs
 test_files:
 - spec/lib/addressfinder/cleanse_spec.rb
+- spec/lib/addressfinder/location_info_spec.rb
+- spec/lib/addressfinder/location_search_spec.rb
 - spec/spec_helper.rb