addressfinder 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c39a2c437c55eca8db36e66ae69a229a3ca953ea
+  data.tar.gz: 895b3bd4ec4ceeea78a8e974ba84767aff30f76e
+SHA512:
+  metadata.gz: 9b38cef13fc5014066701d73e85a8e0a96853e996ede39ef215dabe4a4a9bad09cf5a58f2e445aaf369cdc86730ab9e34731deb34160650a4dc0f694f03d7d0d
+  data.tar.gz: 95a9e4d8b7cd31628218bc88138f8d30ea2faf7ee997d7de636a2d369efd25e197e6eee46bfa02df5062aafae670adbf16dc18e0c25556c37382aa55037bc68d

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# AddressFinder 1.0.0 (September 10, 2015) #
+
+* Support for address cleansing API

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Abletech
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,54 @@
+# AddressFinder Ruby Gem
+
+A client library for accessing the AddressFinder APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'addressfinder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install addressfinder
+
+## Usage
+
+### Configuration
+
+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
+
+### Address Cleansing
+
+See the documentation on the available parameters and expected response here:
+
+https://addressfinder.nz/docs/address_cleanse_api/
+
+Usage example:
+
+    result = AddressFinder.cleanse(q: '186 Willis St, Wellington')
+
+    if result
+      $stdout.puts "Found: #{result.postal}"
+    else
+      $stdout.puts "Sorry, can't find that address"
+    end

data/addressfinder.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/addressfinder/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "addressfinder"
+  gem.version       = AddressFinder::VERSION
+  gem.authors       = ["Nigel Ramsay"]
+  gem.email         = ["nigel@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"
+
+  gem.files         = `git ls-files`.split($/)
+  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"]
+end

data/lib/addressfinder.rb

@@ -0,0 +1,26 @@
+require 'addressfinder/version'
+require 'addressfinder/configuration'
+require 'addressfinder/cleanse'
+require 'addressfinder/errors'
+
+module AddressFinder
+  class << self
+    def configure(config_hash=nil)
+      if config_hash
+        config_hash.each do |k,v|
+          configuration.send("#{k}=", v) rescue nil if configuration.respond_to?("#{k}=")
+        end
+      end
+
+      yield(configuration) if block_given?
+    end
+
+    def configuration
+      @configuration ||= AddressFinder::Configuration.new
+    end
+
+    def cleanse(*args)
+      AddressFinder::Cleanse.new(*args).perform
+    end
+  end
+end

data/lib/addressfinder/cleanse.rb

@@ -0,0 +1,73 @@
+module AddressFinder
+  class Cleanse
+    def initialize(q:, country: nil, delivered: nil, post_box: nil, rural: nil, region_code: nil)
+      @params = {}
+      @params['q'] = q
+      @params['delivered'] = delivered if delivered
+      @params['post_box'] = post_box if post_box
+      @params['rural'] = rural if rural
+      @params['region_code'] = region_code if region_code
+      @params['format'] = 'json'
+      @params['key'] = config.api_key
+      @params['secret'] = config.api_secret
+      @country = country || config.default_country
+    end
+
+    def perform
+      build_request
+      execute_request
+      build_result
+    end
+
+    private
+
+    attr_reader :full_url, :params, :response_body, :response_status, :result, :country
+
+    def build_request
+      @full_url = "https://#{config.hostname}:#{config.port}/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)
+
+      response = http.request(request)
+
+      @response_body = response.body
+      @response_status = response.code
+    end
+
+    def build_result
+      if response_status != '200'
+        raise AddressFinder::RequestRejectedError.new(@response_status, @response_body)
+      end
+
+      if response_hash['matched']
+        return Result.new(response_hash)
+      end
+
+      nil
+    end
+
+    def encoded_params
+      query = params.map{|k,v| "#{k}=#{v}"}.join('&')
+      URI::encode(query)
+    end
+
+    def response_hash
+      @_response_hash ||= JSON.parse(response_body)
+    end
+
+    def config
+      @_config ||= AddressFinder.configuration
+    end
+
+    class Result < OpenStruct
+    end
+  end
+end

data/lib/addressfinder/configuration.rb

@@ -0,0 +1,20 @@
+module AddressFinder
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :api_secret
+    attr_accessor :hostname
+    attr_accessor :port
+    attr_accessor :proxy_host
+    attr_accessor :proxy_port
+    attr_accessor :proxy_user
+    attr_accessor :proxy_password
+    attr_accessor :timeout
+    attr_accessor :default_country
+
+    def initialize
+      self.hostname = 'api.addressfinder.io'
+      self.port = 443
+      self.timeout = 10
+    end
+  end
+end

data/lib/addressfinder/errors.rb

@@ -0,0 +1,13 @@
+module AddressFinder
+  class RequestRejectedError < StandardError
+
+    attr_reader :status, :body
+
+    def initialize(status, body)
+      @status = status
+      @body = body
+
+      super("Request rejected with status code: #{status}\n#{body}")
+    end
+  end
+end

data/lib/addressfinder/version.rb

@@ -0,0 +1,3 @@
+module AddressFinder
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: addressfinder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nigel Ramsay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-10 00:00:00.000000000 Z
+dependencies: []
+description: Ruby client library for AddressFinder
+email:
+- nigel@abletech.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- addressfinder.gemspec
+- lib/addressfinder.rb
+- lib/addressfinder/cleanse.rb
+- lib/addressfinder/configuration.rb
+- lib/addressfinder/errors.rb
+- lib/addressfinder/version.rb
+homepage: https://github.com/AbleTech/addressfinder-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Provides easy access to AddressFinder APIs
+test_files: []