addressfinder 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66c372b498b7ea4985e39e71a716d420c1c513b6
-  data.tar.gz: 3fc1051f78850bba86129bcb27dd559af33fc0f3
+  metadata.gz: 75748dbec5997618df1a9aef78d9bfabced2f496
+  data.tar.gz: 77750d90c4738a6fcfd099837d76cae0dd9ff825
 SHA512:
-  metadata.gz: 68dfa823334e903b4e3d13b78ab3b09e42295524b4fe9ada388691fe2fd5c323eb765036220bf179c8378167fd406531a419d29b89917f20714679d262c8667d
-  data.tar.gz: 1afe7e53b11b4962fc65e6f63c28e0ded310e6f72507b0e91ec52afee9397bcdfeeb4ff0b4bdb183640d035b2efc55798b3e810541f1437e1d7d9f9c45bbe855
+  metadata.gz: cfcd83c4a5a3fcde6b12a71587a8f60b5a2044f1fffc4eba479baa14ab51300d1537ee80a376076e896a3d05f297f1171a1d5bbd64e624fe1ef798524eb98440
+  data.tar.gz: 67b503303c3c5360112b77e256187492c952bf4da48ae9881943aaed606d24fa916e55d7f43d7e44ba65e26eacc0f8b0f0e87f332b8ef6682e4a8d45d30c56a6

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.2.3

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# AddressFinder 1.1.1 (September 14, 2015) #
+
+* Minor bugfixes
+
+# AddressFinder 1.1.0 (September 11, 2015) #
+
+* Support for bulk operations
+
 # AddressFinder 1.0.0 (September 10, 2015) #
 
 * Support for address cleansing API

data/README.md

@@ -1,5 +1,8 @@
 # AddressFinder Ruby Gem
 
+[![Gem Version](https://badge.fury.io/rb/addressfinder.svg)](http://badge.fury.io/rb/addressfinder)
+[![Build  Status](https://travis-ci.org/AbleTech/addressfinder-ruby.svg)](https://travis-ci.org/AbleTech/addressfinder-ruby)
+
 A client library for accessing the AddressFinder APIs.
 
 ## Installation
@@ -23,19 +26,23 @@ Or install it yourself as:
 You should call the configure block on startup of your app. In a Ruby on Rails application this
 is normally performed in an initializer file. For example `./config/initializers/addressfinder.rb`
 
-    AddressFinder.configure do |af|
-      # Mandatory configuration
-      af.api_key = 'XXXXXXXXXX'
-      af.api_secret = 'YYYYYYYYYY'
-      af.default_country = 'nz'
-
-      # Optional configuration
-      af.timeout = 10 # seconds
-      af.proxy_host = 'corp.proxy.com'
-      af.proxy_port = 8080
-      af.proxy_user = 'username'
-      af.proxy_password = 'password'
-    end
+```ruby
+AddressFinder.configure do |af|
+  # Mandatory configuration
+  af.api_key = 'XXXXXXXXXX'
+  af.api_secret = 'YYYYYYYYYY'
+  af.default_country = 'nz'
+
+  # Optional configuration
+  af.timeout = 10 # seconds
+  af.proxy_host = 'corp.proxy.com'
+  af.proxy_port = 8080
+  af.proxy_user = 'username'
+  af.proxy_password = 'password'
+end
+```
+
+You can obtain your API key and secret from the AddressFinder Portal.
 
 ### Address Cleansing
 
@@ -45,10 +52,33 @@ https://addressfinder.nz/docs/address_cleanse_api/
 
 Usage example:
 
-    result = AddressFinder.cleanse(q: '186 Willis St, Wellington')
+```ruby
+result = AddressFinder.cleanse(q: '186 Willis St, Wellington')
+
+if result
+  $stdout.puts "Success: #{result.postal}"
+else
+  $stdout.puts "Sorry, can't find that address"
+end
+```
+
+### Bulk Operations
+
+If you have a series of calls you need to make to AddressFinder, you can use the
+bulk method which re-uses the HTTP connection.
+
+Usage example:
+
+```ruby
+AddressFinder.bulk do |af|
+  CSV.foreach('auckland_addresses.csv') do |row|
+    result = af.cleanse(q: row[0], region_code: '1')
 
     if result
-      $stdout.puts "Found: #{result.postal}"
+      $stdout.puts "Success: #{result.postal}"
     else
       $stdout.puts "Sorry, can't find that address"
     end
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/addressfinder.gemspec

@@ -14,4 +14,12 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(spec|features)/})
   gem.require_paths = ["lib"]
+
+  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'
 end

data/lib/addressfinder.rb

@@ -1,6 +1,9 @@
+require 'net/http'
+require 'multi_json'
 require 'addressfinder/version'
 require 'addressfinder/configuration'
 require 'addressfinder/cleanse'
+require 'addressfinder/bulk'
 require 'addressfinder/errors'
 
 module AddressFinder
@@ -19,8 +22,26 @@ module AddressFinder
       @configuration ||= AddressFinder::Configuration.new
     end
 
-    def cleanse(*args)
-      AddressFinder::Cleanse.new(*args).perform
+    def cleanse(args={})
+      AddressFinder::Cleanse.new(args.merge(http: configure_http)).perform.result
+    end
+
+    def bulk(&block)
+      # TODO include parameter http: configure_http
+      AddressFinder::Bulk.new(&block).perform
+    end
+
+    private
+
+    def configure_http
+      http = Net::HTTP.new(configuration.hostname, configuration.port,
+                           configuration.proxy_host, configuration.proxy_port,
+                           configuration.proxy_user, configuration.proxy_password)
+      http.open_timeout = configuration.timeout
+      http.read_timeout = configuration.timeout
+      http.use_ssl = true
+
+      http
     end
   end
 end

data/lib/addressfinder/bulk.rb

@@ -0,0 +1,37 @@
+module AddressFinder
+  class Bulk
+    def initialize(&block)
+      @block = block
+    end
+
+    def perform
+      Net::HTTP.start(config.hostname, config.port, use_ssl: true,
+                                                    open_timeout: config.timeout,
+                                                    read_timeout: config.timeout) do |http|
+        block.call ClientProxy.new(http: http)
+      end
+    end
+
+    private
+
+    attr_reader :block
+
+    def config
+      @_config ||= AddressFinder.configuration
+    end
+
+    class ClientProxy
+      def initialize(http:)
+        @http = http
+      end
+
+      def cleanse(args={})
+        AddressFinder::Cleanse.new(args.merge(http: http)).perform
+      end
+
+      private
+
+      attr_reader :http
+    end
+  end
+end

data/lib/addressfinder/cleanse.rb

@@ -1,6 +1,11 @@
+require 'ostruct'
+
 module AddressFinder
   class Cleanse
-    def initialize(q:, country: nil, delivered: nil, post_box: nil, rural: nil, region_code: nil)
+
+    attr_reader :result
+
+    def initialize(q:, country: nil, delivered: nil, post_box: nil, rural: nil, region_code: nil, http:)
       @params = {}
       @params['q'] = q
       @params['delivered'] = delivered if delivered
@@ -11,35 +16,34 @@ module AddressFinder
       @params['key'] = config.api_key
       @params['secret'] = config.api_secret
       @country = country || config.default_country
+      @http = http
     end
 
     def perform
       build_request
       execute_request
       build_result
+
+      self
     end
 
     private
 
-    attr_reader :full_url, :params, :response_body, :response_status, :result, :country
+    attr_reader :request_uri, :params, :result, :country, :http
+    attr_accessor :response_body, :response_status
+    attr_writer :result
 
     def build_request
-      @full_url = "https://#{config.hostname}:#{config.port}/api/#{country}/address/cleanse?#{encoded_params}"
+      @request_uri = "/api/#{country}/address/cleanse?#{encoded_params}"
     end
 
     def execute_request
-      uri = URI.parse(full_url)
-      http = Net::HTTP.new(uri.host, uri.port, config.proxy_host, config.proxy_port, config.proxy_user, config.proxy_password)
-      http.open_timeout = config.timeout
-      http.read_timeout = config.timeout
-      http.use_ssl = (uri.scheme == "https")
-
-      request = Net::HTTP::Get.new(uri.request_uri)
+      request = Net::HTTP::Get.new(request_uri)
 
       response = http.request(request)
 
-      @response_body = response.body
-      @response_status = response.code
+      self.response_body = response.body
+      self.response_status = response.code
     end
 
     def build_result
@@ -48,10 +52,10 @@ module AddressFinder
       end
 
       if response_hash['matched']
-        return Result.new(response_hash)
+        self.result = Result.new(response_hash)
+      else
+        self.result = nil
       end
-
-      nil
     end
 
     def encoded_params
@@ -60,7 +64,7 @@ module AddressFinder
     end
 
     def response_hash
-      @_response_hash ||= JSON.parse(response_body)
+      @_response_hash ||= MultiJson.load(response_body)
     end
 
     def config

data/lib/addressfinder/configuration.rb

@@ -15,6 +15,7 @@ module AddressFinder
       self.hostname = 'api.addressfinder.io'
       self.port = 443
       self.timeout = 10
+      self.default_country = 'nz'
     end
   end
 end

data/lib/addressfinder/version.rb

@@ -1,3 +1,3 @@
 module AddressFinder
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/spec/lib/addressfinder/cleanse_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+RSpec.describe AddressFinder::Cleanse 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(:cleanser){ AddressFinder::Cleanse.new(args) }
+    let(:http){ AddressFinder.send(:configure_http) }
+
+    subject(:request_uri){ cleanser.send(:build_request) }
+
+    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') }
+    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') }
+    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') }
+    end
+  end
+
+  describe '#build_result' do
+    let(:cleanser){ AddressFinder::Cleanse.new(q: 'ignored', http: nil) }
+
+    before do
+      cleanser.send('response_body=', body)
+      cleanser.send('response_status=', status)
+    end
+
+    subject(:result){ cleanser.send(:build_result) }
+
+    context 'with a successful result' do
+      let(:body){ '{"matched": true, "postal_address": "Texas"}' }
+      let(:status){ '200' }
+
+      it { expect(result.class).to eq(AddressFinder::Cleanse::Result) }
+
+      it { expect(result.matched).to eq(true) }
+
+      it { expect(result.postal_address).to eq("Texas") }
+    end
+
+    context 'with an unfound result' do
+      let(:body){ '{"matched": false}' }
+      let(:status){ '200' }
+
+      it { expect(result).to eq(nil) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rubygems'
+require 'bundler'
+require 'webmock/rspec'
+require 'addressfinder'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+
+WebMock.disable_net_connect!

metadata

@@ -1,15 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: addressfinder
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Nigel Ramsay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-11 00:00:00.000000000 Z
-dependencies: []
+date: 2015-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !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
 email:
 - nigel@abletech.nz
@@ -18,16 +88,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - addressfinder.gemspec
 - lib/addressfinder.rb
+- lib/addressfinder/bulk.rb
 - lib/addressfinder/cleanse.rb
 - lib/addressfinder/configuration.rb
 - lib/addressfinder/errors.rb
 - lib/addressfinder/version.rb
+- spec/lib/addressfinder/cleanse_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/AbleTech/addressfinder-ruby
 licenses: []
 metadata: {}
@@ -37,9 +112,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -47,8 +122,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Provides easy access to AddressFinder APIs
-test_files: []
+test_files:
+- spec/lib/addressfinder/cleanse_spec.rb
+- spec/spec_helper.rb