smartystreets.com ruby gem
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.rspec
Gemfile
LICENSE.txt
README.md
Rakefile
smarty_streets.gemspec

README.md

** USE https://github.com/smartystreets/smartystreets-ruby-sdk INSTEAD **

Circle CI Coverage Status

SmartyStreets

A ruby library to integrate with the SmartyStreets API.

Installation

Add this line to your application's Gemfile:

gem 'smarty_streets'

And then execute:

$ bundle

Or install it yourself as:

$ gem install smarty_streets

Usage

You must have valid tokens from http://www.smartystreets.com

SmartyStreets.configure do |c|
  c.auth_id = 'MY-AUTH-ID'
  c.auth_token = 'MY-AUTH-TOKEN'
  c.candidates = 5
end

locations = SmartyStreets.standardize do |location|
  location.street = '1 infinite loop'
  location.city = 'cupertino'
  location.state = 'california'
  location.zipcode = '95014'
end

# #<SmartyStreets::Location:0x007fb4bbb507d0 @street="1 Infinite Loop", @city="Cupertino", @state="CA", @zipcode="95014-2083", @delivery_point_barcode="950142083017", @components={"primary_number"=>"1", "street_name"=>"Infinite", "street_suffix"=>"Loop", "city_name"=>"Cupertino", "state_abbreviation"=>"CA", "zipcode"=>"95014", "plus4_code"=>"2083", "delivery_point"=>"01", "delivery_point_check_digit"=>"7"}, @metadata={"record_type"=>"S", "county_fips"=>"06085", "county_name"=>"Santa Clara", "carrier_route"=>"C067", "congressional_district"=>"18", "rdi"=>"Commercial", "elot_sequence"=>"0031", "elot_sort"=>"A", "latitude"=>37.33118, "longitude"=>-122.03062, "precision"=>"Zip9"}>

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request