smarty_streets 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smarty_streets.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Russ Smith
+
+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.

data/README.md

@@ -0,0 +1,46 @@
+# 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
+
+```ruby
+SmartyStreets.configure do |c|
+  c.auth_id = 'MY-AUTH-ID'
+  c.auth_token = 'MY-AUTH-TOKEN'
+  c.number_of_candidates = 5
+end
+
+locations = SmartyStreets.standardize do |location|
+  location.street = '1 infinite loop'
+  location.city = 'cupertino'
+  location.state = 'california'
+  location.zip_code = '95014'
+end
+
+# #<SmartyStreets::Location:0x007fb4bbb507d0 @street="1 Infinite Loop", @city="Cupertino", @state="CA", @zip_code="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"}, @meta_data={"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

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rspec/core/rake_task'
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:normal) do |t|
+    t.pattern ='spec/**/*_spec.rb'
+    t.rcov = false
+  end
+end
+
+desc 'RSpec tests'
+task spec: 'spec:normal'
+
+task default: 'spec'

data/lib/smarty_streets.rb

@@ -0,0 +1,32 @@
+require 'cgi'
+require 'json'
+require 'httparty'
+require 'smarty_streets/version'
+require 'smarty_streets/configuration'
+require 'smarty_streets/location'
+require 'smarty_streets/request'
+
+module SmartyStreets
+  class << self
+    attr_accessor :configuration
+
+    # Call this method to set your configuration.
+    #
+    #   SmartyStreets.configure do |config|
+    #     config.auth_id = 'AUTHID'
+    #     config.auth_token = 'AUTHTOKEN'
+    #     config.number_of_candidates = 1
+    #   end
+    def configure
+      self.configuration = Configuration.new
+      yield(configuration)
+    end
+
+    # Request standardization for an address
+    def standardize
+      location = Location.new
+      yield(location)
+      Request.new(location).standardize!
+    end
+  end
+end

data/lib/smarty_streets/configuration.rb

@@ -0,0 +1,27 @@
+module SmartyStreets
+  class Configuration
+    # API url for SmartyStreets
+    attr_accessor :api_url
+
+    # AUTH ID from SmartyStreets
+    attr_accessor :auth_id
+
+    # AUTH TOKEN from SmartyStreets
+    attr_accessor :auth_token
+
+    # Number of candidates to provide when making a request.
+    attr_accessor :number_of_candidates
+
+    def initialize
+      @api_url = 'api.smartystreets.com'
+      @number_of_candidates = 1
+    end
+
+    # Returns a hash of all configurable options
+    def to_hash
+      OPTIONS.inject({}) do |hash, option|
+        hash.merge(option.to_sym => send(option))
+      end
+    end
+  end
+end

data/lib/smarty_streets/location.rb

@@ -0,0 +1,8 @@
+module SmartyStreets
+  class Location
+    attr_accessor :street, :street2, :secondary
+    attr_accessor :city, :state, :zip_code
+    attr_accessor :last_line, :addressee, :urbanization
+    attr_accessor :delivery_point_barcode, :components, :meta_data
+  end
+end

data/lib/smarty_streets/request.rb

@@ -0,0 +1,70 @@
+module SmartyStreets
+  class Request
+    class InvalidCredentials < Exception; end
+    class MalformedData < Exception; end
+    class PaymentRequired < Exception; end
+    class NoValidCandidates < Exception; end
+    class RemoteServerError < Exception; end
+
+    attr_accessor :location
+
+    def initialize(location)
+      @location = location
+    end
+
+    def standardize!
+      url = build_request_url(@location)
+      handle_response(send_request(url))
+    end
+
+    private
+
+    def handle_response(response)
+      raise InvalidCredentials if response.code == 401
+      raise MalformedData if response.code == 400
+      raise PaymentRequired if response.code == 402
+      raise RemoteServerError if response.code == 500
+      raise NoValidCandidates if response.body.nil?
+
+      JSON.parse(response.body).collect do |l|
+        location = Location.new
+        location.street = l['delivery_line_1']
+        location.city = l['components']['city_name']
+        location.state = l['components']['state_abbreviation']
+        location.zip_code = l['components']['zipcode'] + '-' + l['components']['plus4_code']
+        location.delivery_point_barcode = l['delivery_point_barcode']
+        location.components = l['components']
+        location.meta_data = l['metadata']
+        location
+      end
+    end
+
+    def send_request(url)
+      HTTParty.get(url)
+    end
+
+    def build_request_url(location)
+      parameters = {
+        street: location.street,
+        street2: location.street2,
+        secondary: location.secondary,
+        city: location.city,
+        state: location.state,
+        zip_code: location.zip_code,
+        last_line: location.last_line,
+        addressee: location.addressee,
+        urbanization: location.urbanization,
+        candidates: SmartyStreets.configuration.number_of_candidates,
+        auth_id: SmartyStreets.configuration.auth_id,
+        auth_token: SmartyStreets.configuration.auth_token
+      }
+
+      parameter_string = parameters.collect { |k,v|
+        "#{k.to_s.gsub('_', '-')}=#{CGI.escape(v.to_s)}"
+      }.join('&')
+
+      'http://' + SmartyStreets.configuration.api_url +
+      '/street-address/?' + parameter_string
+    end
+  end
+end

data/lib/smarty_streets/version.rb

@@ -0,0 +1,3 @@
+module SmartyStreets
+  VERSION = '0.0.1'
+end

data/smarty_streets.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smarty_streets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smarty_streets"
+  spec.version       = SmartyStreets::VERSION
+  spec.authors       = ["Russ Smith"]
+  spec.email         = ["russ@bashme.org"]
+  spec.description   = 'A ruby gem to integrate with http://www.smartystreets.com'
+  spec.summary       = 'A ruby gem to integrate with http://www.smartystreets.com'
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.11"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe SmartyStreets::Configuration do
+  before do
+    SmartyStreets.configure do |c|
+      c.api_url = 'apiurl'
+      c.auth_id = 'MYAUTHID'
+      c.auth_token = 'MYAUTHTOKEN'
+      c.number_of_candidates = 1
+    end
+  end
+
+  it 'sets the api_url' do
+    expect(SmartyStreets.configuration.api_url).to eq 'apiurl'
+  end
+
+  it 'sets the auth_id' do
+    expect(SmartyStreets.configuration.auth_id).to eq 'MYAUTHID'
+  end
+
+  it 'sets the auth_token' do
+    expect(SmartyStreets.configuration.auth_token).to eq 'MYAUTHTOKEN'
+  end
+
+  it 'sets the number_of_candidates' do
+    expect(SmartyStreets.configuration.number_of_candidates).to eq 1
+  end
+end

data/spec/smarty_streets_spec.rb

@@ -0,0 +1,171 @@
+require 'spec_helper'
+
+describe SmartyStreets do
+  before do
+  end
+
+  context SmartyStreets::Request do
+    context 'unauthorized request' do
+      let(:unauthorized_request) do
+        double(:response, code: 401)
+      end
+
+      before do
+        SmartyStreets.configure do |c|
+          c.auth_id = 'ERROR'
+          c.auth_token = 'ERROR'
+        end
+        HTTParty.stub(:get).and_return(unauthorized_request)
+      end
+
+      specify 'raises an InvalidCredentials error' do
+        expect {
+          locations = SmartyStreets.standardize do |location|
+            location.street = '1 infinite loop'
+            location.city = 'cupertino'
+            location.state = 'california'
+            location.zip_code = '95014'
+          end
+        }.to raise_error SmartyStreets::Request::InvalidCredentials
+      end
+    end
+
+    context 'malformed data' do
+      let(:malformed_data_request) do
+        double(:response, code: 400)
+      end
+
+      before do
+        SmartyStreets.configure do |c|
+          c.auth_id = 'ERROR'
+          c.auth_token = 'ERROR'
+        end
+        HTTParty.stub(:get).and_return(malformed_data_request)
+      end
+
+      specify 'raises an InvalidCredentials error' do
+        expect {
+          locations = SmartyStreets.standardize do |location|
+            location.street = '1 infinite loop'
+            location.city = 'cupertino'
+            location.state = 'california'
+            location.zip_code = '95014'
+          end
+        }.to raise_error SmartyStreets::Request::MalformedData
+      end
+    end
+
+    context 'payment required' do
+      let(:payment_required_request) do
+        double(:response, code: 402)
+      end
+
+      before do
+        SmartyStreets.configure do |c|
+          c.auth_id = 'ERROR'
+          c.auth_token = 'ERROR'
+        end
+        HTTParty.stub(:get).and_return(payment_required_request)
+      end
+
+      specify 'raises an InvalidCredentials error' do
+        expect {
+          locations = SmartyStreets.standardize do |location|
+            location.street = '1 infinite loop'
+            location.city = 'cupertino'
+            location.state = 'california'
+            location.zip_code = '95014'
+          end
+        }.to raise_error SmartyStreets::Request::PaymentRequired
+      end
+    end
+
+    context 'remote server error' do
+      let(:remote_server_error_request) do
+        double(:response, code: 500)
+      end
+
+      before do
+        SmartyStreets.configure do |c|
+          c.auth_id = 'ERROR'
+          c.auth_token = 'ERROR'
+        end
+        HTTParty.stub(:get).and_return(remote_server_error_request)
+      end
+
+      specify 'raises an InvalidCredentials error' do
+        expect {
+          locations = SmartyStreets.standardize do |location|
+            location.street = '1 infinite loop'
+            location.city = 'cupertino'
+            location.state = 'california'
+            location.zip_code = '95014'
+          end
+        }.to raise_error SmartyStreets::Request::RemoteServerError
+      end
+    end
+
+    context 'successful request' do
+      let(:successful_response) do
+        double(:response, code: 200, body: successful_response_data)
+      end
+
+      before do
+        SmartyStreets.configure do |c|
+          c.auth_id = 'MYAUTHID'
+          c.auth_token = 'MYAUTHTOKEN'
+          c.number_of_candidates = 5
+        end
+        HTTParty.stub(:get).and_return(successful_response)
+      end
+
+      specify 'makes a request for a standardized address' do
+        locations = SmartyStreets.standardize do |location|
+          location.street = '1 infinite loop'
+          location.city = 'cupertino'
+          location.state = 'calforna'
+          location.zip_code = '95014'
+        end
+
+        expect(locations.first.street).to eq '1 Infinite Loop'
+        expect(locations.first.city).to eq 'Cupertino'
+        expect(locations.first.state).to eq 'CA'
+        expect(locations.first.zip_code).to eq '95014-2083'
+      end
+    end
+
+    context 'address with no candidates' do
+      let(:unsuccessful_response) do
+        double(:response, code: 200, body: unsuccessful_response_data)
+      end
+
+      before do
+        SmartyStreets.configure do |c|
+          c.auth_id = 'MYAUTHID'
+          c.auth_token = 'MYAUTHTOKEN'
+          c.number_of_candidates = 5
+        end
+        HTTParty.stub(:get).and_return(unsuccessful_response)
+      end
+
+      specify 'makes a request for a standardized address' do
+        expect {
+          locations = SmartyStreets.standardize do |location|
+            location.street = '1234 Unicorn Lane'
+            location.city = 'earth'
+            location.state = 'galaxy'
+            location.zip_code = '1234923'
+          end
+        }.to raise_error SmartyStreets::Request::NoValidCandidates
+      end
+    end
+  end
+
+  def successful_response_data
+    '[{"input_index":0,"candidate_index":0,"delivery_line_1":"1 Infinite Loop","last_line":"Cupertino CA 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"},"analysis":{"dpv_match_code":"Y","dpv_footnotes":"AABB","dpv_cmra":"N","dpv_vacant":"N","active":"Y"}},{"input_index":0,"candidate_index":1,"addressee":"Apple Computer","delivery_line_1":"1 Infinite Loop","last_line":"Cupertino CA 95014-2084","delivery_point_barcode":"950142084016","components":{"primary_number":"1","street_name":"Infinite","street_suffix":"Loop","city_name":"Cupertino","state_abbreviation":"CA","zipcode":"95014","plus4_code":"2084","delivery_point":"01","delivery_point_check_digit":"6"},"metadata":{"record_type":"F","county_fips":"06085","county_name":"Santa Clara","carrier_route":"C067","congressional_district":"18","rdi":"Commercial","elot_sequence":"0032","elot_sort":"A","latitude":37.33118,"longitude":-122.03062,"precision":"Zip9"},"analysis":{"dpv_match_code":"Y","dpv_footnotes":"AABB","dpv_cmra":"N","dpv_vacant":"N","active":"Y"}}]'
+  end
+
+  def unsuccessful_response_data
+    nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'smarty_streets'
+require 'rspec'
+
+RSpec.configure do |c|
+  c.mock_with(:rspec)
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: smarty_streets
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Russ Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby gem to integrate with http://www.smartystreets.com
+email:
+- russ@bashme.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smarty_streets.rb
+- lib/smarty_streets/configuration.rb
+- lib/smarty_streets/location.rb
+- lib/smarty_streets/request.rb
+- lib/smarty_streets/version.rb
+- smarty_streets.gemspec
+- spec/configuration_spec.rb
+- spec/smarty_streets_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A ruby gem to integrate with http://www.smartystreets.com
+test_files:
+- spec/configuration_spec.rb
+- spec/smarty_streets_spec.rb
+- spec/spec_helper.rb