validate-address-smartystreets 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69d8d9f663282bc21a0a16b51c33e48a9c9cbff2
+  data.tar.gz: 826da51218588fa0d3fe4076e9e03c74f67a8528
+SHA512:
+  metadata.gz: 645a26cc0acbe2921d77563d64bbf69549a558ce9ea3921373b2bd4ea2689a1430542b5798ae7de46c49b836288a1541fe0f0dfdb667bd57dc8566784f4eafba
+  data.tar.gz: 3b262f7865d459d2afa364dcee07746832a003a077fb4af7cfef1b2336fbc469503df82059ef638bd77db9c4da5c08108134182e7d55ae0a7528b1c0b5d6246b

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kenneth Ballenegger
+
+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,29 @@
+# Validate::Address::Smartystreets
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'validate-address-smartystreets'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install validate-address-smartystreets
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/validate-address-smartystreets/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/validate-address-smartystreets.rb

@@ -0,0 +1,118 @@
+require 'validate'
+require 'validate/validations'
+require 'smarty_streets'
+
+module Validate
+
+  class ValidationMethods
+
+    # Validates an address using the SmartyStreets API.
+    #
+    # An address can have two representations: as a string, or as a structured
+    # object. Structured objects have these keys:
+    #
+    # street: the street address, one line (e.g. "1 Main St\nSte 200")
+    # city: e.g. "San Francisco"
+    # state: two-digit code, e.g. "CA"
+    # country: two-digit code, e.g. "US"
+    # zip: postal code as a String, e.g. "94158"
+    #
+    # Note: this method will clean the address in-place. Careful with this, it
+    # *will* mutate your source data.
+    #
+    # Failures will have this format:
+    #
+    #   ['was not a recognizable address. suggestions:', [
+    #     {street: ..., city: ..., state: ..., country: ..., zip: ...}, ...
+    #   ]]
+    #
+    fails_because_key do
+      f = obj[field].instance_variable_get(:@ValidateAddressFailures)
+      next 'could not be validated as an address.' unless f
+      obj[field].remove_instance_variable(:@ValidateAddressFailures)
+      f
+    end
+    #
+    def validates_and_cleans_address(obj, field, opts, validator)
+
+      address = obj[field]
+
+      # validate data types
+      unless address.is_a?(Hash) || address.is_a?(String)
+        address.instance_variable_set(:@ValidateAddressFailures,
+                                      ['must be either an address string or hash.'])
+        return false
+      end
+
+      # only US is valid for now
+      if address.is_a?(Hash) && (address[:country] || address['country']) != 'US'
+        address.instance_variable_set(:@ValidateAddressFailures,
+                                      ['must be a US address.'])
+        return false
+      end
+
+      result, match, suggestions = Address.verify(address)
+
+      unless result == true
+        address.instance_variable_set(:@ValidateAddressFailures, [
+          'was not a deliverable address. suggestions:',
+          suggestions
+        ])
+        return false
+      end
+
+      # modify address in-place
+      obj[field] = match
+      true
+    end
+  end
+
+  module Address
+
+    # This performs the actual validation.
+    #
+    # An address is considered valid when SmartyStreets returns:
+    # 1. Exactly one match.
+    # 2. That match is verified as DPV deliverable.
+    #
+    # Returns a [valid, match, suggestions] tuple.
+    #
+    def self.verify(address)
+      address = case address
+                when Hash then address
+                when String
+                  {street: address}
+                end
+      matches = SmartyStreets.standardize do |s|
+        x = nil
+        s.street = x if x = address[:street] || address['street']
+        s.city = x if x = address[:city] || address['city']
+        s.state = x if x = address[:state] || address['state']
+        s.zip_code = x if x = address[:zip] || address['zip']
+      end
+
+      format_suggestion = lambda do |s|
+        {
+          street: s.street,
+          city: s.city,
+          state: s.state,
+          zip: s.zip_code,
+          country: 'US',
+        }
+      end
+
+      case matches.count
+      when 0
+        [false, nil, nil]
+      when 1
+        unless matches.first.analysis['dpv_match_code'] == 'Y'
+          [false, nil, matches.map(&format_suggestion)]
+        else
+          [true, matches.map(&format_suggestion).first, nil]
+        end
+      else
+        [false, nil, matches.map(&format_suggestion)]
+      end
+    end
+  end
+end

data/lib/validate-address-smartystreets/version.rb

@@ -0,0 +1,7 @@
+module Validate
+  module Address
+    module SmartyStreets
+      VERSION = '1.0'
+    end
+  end
+end

data/validate-address-smartystreets.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'validate-address-smartystreets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'validate-address-smartystreets'
+  spec.version       = Validate::Address::SmartyStreets::VERSION
+  spec.authors       = ['Kenneth Ballenegger']
+  spec.email         = ['kenneth@ballenegger.com']
+  spec.summary       = %q{Verify addresses using SmartyStreets}
+  spec.description   = %q{Verify addresses using SmartyStreets}
+  spec.homepage      = 'https://github.com/kballenegger/validate-address-smartystreets'
+  spec.license       = 'http://license.azuretalon.com'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 'smarty_streets'
+  spec.add_dependency 'validate'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: validate-address-smartystreets
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Kenneth Ballenegger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: smarty_streets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: validate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Verify addresses using SmartyStreets
+email:
+- kenneth@ballenegger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/validate-address-smartystreets.rb
+- lib/validate-address-smartystreets/version.rb
+- validate-address-smartystreets.gemspec
+homepage: https://github.com/kballenegger/validate-address-smartystreets
+licenses:
+- http://license.azuretalon.com
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Verify addresses using SmartyStreets
+test_files: []
+has_rdoc: