Ruby class to standardize U.S. postal addresses by referencing the U.S. Postal Service's web site
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.rspec
Gemfile
README.rdoc
Rakefile
usps_standardizer.gemspec

README.rdoc

USPS Address Standardizer

Installing

$ require 'usps_standardizer'
$ gem install usps_standardizer

Configuration

Caching

It’s a good idea, when relying on any external service, to cache retrieved data. When implemented correctly it improves your app’s response time and stability. It’s easy to cache usps results with USPSStandardizer, just configure a cache store:

$ USPSStandardizer::Configuration.cache = Redis.new
$ USPSStandardizer::Configuration.cache_prefix = "wyw"

Usage

$ result = USPSStandardizer.lookup_for(:address => '6216 eddington drive', :state => 'oh', :city => 'middletown')

Or you can pass your own Mechanize object to fetch the information

$ require 'usps_standardizer'
$ require 'mechanize'
$ browser = Mechanize.new { |agent| agent.user_agent_alias = 'Mac Safari' }
$ result = USPSStandardizer.lookup_for({:address => '6216 eddington drive', :state => 'oh', :city => 'middletown'}, browser)

License

(The MIT License)

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.