Smarty Ruby SDK

If you want to access our APIs (other than the Download API) from a Ruby application, the Smarty Ruby SDK can make it a lot easier. Our Ruby SDK includes ready-made data structures and takes care of all the gritty, low-level HTTP intricacies for you.

Contents

1. Requirements
2. How to get it
   1. RubyGems
   2. Download the source code
3. How to use it
   1. Demo
   2. Examples
4. API reference material

Requirements

1. Have a Ruby project that is written for Ruby 2.0 or higher.
2. Realize that you need an address verification component.
3. Wisely conclude that you don't want to build your own address verification component.
4. Realize that Smarty has already created an address verification component.
5. Congratulations! You are now ready to use the Smarty Ruby SDK.

How to get it

RubyGems

The easiest way to get your giddy hands on this goodness is by using RubyGems.

Be sure RubyGems is installed, then just pop open your terminal and run

$ gem install smartystreets_ruby_sdk

Alternately, you can add this line to your application's Gemfile:

gem 'smartystreets_ruby_sdk'

Then execute:

$ bundle

Download the source code

You can find source code of the Smarty Ruby SDK repository on Github which contains many sample code snippets.

Use the source, Luke!

How to use it

Demo

Examples

Here are a few examples showing how to use the Ruby SDK:

• Verifying US street addresses
• Verifying international street addresses
• Finding US ZIP Codes
• Extracting US street addresses from arbitrary text
• Completing US street addresses given an prefix