validate-address-smartystreets 1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 69d8d9f663282bc21a0a16b51c33e48a9c9cbff2
4
+ data.tar.gz: 826da51218588fa0d3fe4076e9e03c74f67a8528
5
+ SHA512:
6
+ metadata.gz: 645a26cc0acbe2921d77563d64bbf69549a558ce9ea3921373b2bd4ea2689a1430542b5798ae7de46c49b836288a1541fe0f0dfdb667bd57dc8566784f4eafba
7
+ data.tar.gz: 3b262f7865d459d2afa364dcee07746832a003a077fb4af7cfef1b2336fbc469503df82059ef638bd77db9c4da5c08108134182e7d55ae0a7528b1c0b5d6246b
@@ -0,0 +1,22 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
18
+ *.bundle
19
+ *.so
20
+ *.o
21
+ *.a
22
+ mkmf.log
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in validate-address-smartystreets.gemspec
4
+ gemspec
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2014 Kenneth Ballenegger
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,29 @@
1
+ # Validate::Address::Smartystreets
2
+
3
+ TODO: Write a gem description
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'validate-address-smartystreets'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install validate-address-smartystreets
18
+
19
+ ## Usage
20
+
21
+ TODO: Write usage instructions here
22
+
23
+ ## Contributing
24
+
25
+ 1. Fork it ( https://github.com/[my-github-username]/validate-address-smartystreets/fork )
26
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
27
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
28
+ 4. Push to the branch (`git push origin my-new-feature`)
29
+ 5. Create a new Pull Request
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+
@@ -0,0 +1,118 @@
1
+ require 'validate'
2
+ require 'validate/validations'
3
+ require 'smarty_streets'
4
+
5
+ module Validate
6
+
7
+ class ValidationMethods
8
+
9
+ # Validates an address using the SmartyStreets API.
10
+ #
11
+ # An address can have two representations: as a string, or as a structured
12
+ # object. Structured objects have these keys:
13
+ #
14
+ # street: the street address, one line (e.g. "1 Main St\nSte 200")
15
+ # city: e.g. "San Francisco"
16
+ # state: two-digit code, e.g. "CA"
17
+ # country: two-digit code, e.g. "US"
18
+ # zip: postal code as a String, e.g. "94158"
19
+ #
20
+ # Note: this method will clean the address in-place. Careful with this, it
21
+ # *will* mutate your source data.
22
+ #
23
+ # Failures will have this format:
24
+ #
25
+ # ['was not a recognizable address. suggestions:', [
26
+ # {street: ..., city: ..., state: ..., country: ..., zip: ...}, ...
27
+ # ]]
28
+ #
29
+ fails_because_key do
30
+ f = obj[field].instance_variable_get(:@ValidateAddressFailures)
31
+ next 'could not be validated as an address.' unless f
32
+ obj[field].remove_instance_variable(:@ValidateAddressFailures)
33
+ f
34
+ end
35
+ #
36
+ def validates_and_cleans_address(obj, field, opts, validator)
37
+
38
+ address = obj[field]
39
+
40
+ # validate data types
41
+ unless address.is_a?(Hash) || address.is_a?(String)
42
+ address.instance_variable_set(:@ValidateAddressFailures,
43
+ ['must be either an address string or hash.'])
44
+ return false
45
+ end
46
+
47
+ # only US is valid for now
48
+ if address.is_a?(Hash) && (address[:country] || address['country']) != 'US'
49
+ address.instance_variable_set(:@ValidateAddressFailures,
50
+ ['must be a US address.'])
51
+ return false
52
+ end
53
+
54
+ result, match, suggestions = Address.verify(address)
55
+
56
+ unless result == true
57
+ address.instance_variable_set(:@ValidateAddressFailures, [
58
+ 'was not a deliverable address. suggestions:',
59
+ suggestions
60
+ ])
61
+ return false
62
+ end
63
+
64
+ # modify address in-place
65
+ obj[field] = match
66
+ true
67
+ end
68
+ end
69
+
70
+ module Address
71
+
72
+ # This performs the actual validation.
73
+ #
74
+ # An address is considered valid when SmartyStreets returns:
75
+ # 1. Exactly one match.
76
+ # 2. That match is verified as DPV deliverable.
77
+ #
78
+ # Returns a [valid, match, suggestions] tuple.
79
+ #
80
+ def self.verify(address)
81
+ address = case address
82
+ when Hash then address
83
+ when String
84
+ {street: address}
85
+ end
86
+ matches = SmartyStreets.standardize do |s|
87
+ x = nil
88
+ s.street = x if x = address[:street] || address['street']
89
+ s.city = x if x = address[:city] || address['city']
90
+ s.state = x if x = address[:state] || address['state']
91
+ s.zip_code = x if x = address[:zip] || address['zip']
92
+ end
93
+
94
+ format_suggestion = lambda do |s|
95
+ {
96
+ street: s.street,
97
+ city: s.city,
98
+ state: s.state,
99
+ zip: s.zip_code,
100
+ country: 'US',
101
+ }
102
+ end
103
+
104
+ case matches.count
105
+ when 0
106
+ [false, nil, nil]
107
+ when 1
108
+ unless matches.first.analysis['dpv_match_code'] == 'Y'
109
+ [false, nil, matches.map(&format_suggestion)]
110
+ else
111
+ [true, matches.map(&format_suggestion).first, nil]
112
+ end
113
+ else
114
+ [false, nil, matches.map(&format_suggestion)]
115
+ end
116
+ end
117
+ end
118
+ end
@@ -0,0 +1,7 @@
1
+ module Validate
2
+ module Address
3
+ module SmartyStreets
4
+ VERSION = '1.0'
5
+ end
6
+ end
7
+ end
@@ -0,0 +1,26 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'validate-address-smartystreets/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'validate-address-smartystreets'
8
+ spec.version = Validate::Address::SmartyStreets::VERSION
9
+ spec.authors = ['Kenneth Ballenegger']
10
+ spec.email = ['kenneth@ballenegger.com']
11
+ spec.summary = %q{Verify addresses using SmartyStreets}
12
+ spec.description = %q{Verify addresses using SmartyStreets}
13
+ spec.homepage = 'https://github.com/kballenegger/validate-address-smartystreets'
14
+ spec.license = 'http://license.azuretalon.com'
15
+
16
+ spec.files = `git ls-files -z`.split("\x0")
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ['lib']
20
+
21
+ spec.add_dependency 'smarty_streets'
22
+ spec.add_dependency 'validate'
23
+
24
+ spec.add_development_dependency 'bundler', '~> 1.6'
25
+ spec.add_development_dependency 'rake'
26
+ end
metadata ADDED
@@ -0,0 +1,109 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: validate-address-smartystreets
3
+ version: !ruby/object:Gem::Version
4
+ version: '1.0'
5
+ platform: ruby
6
+ authors:
7
+ - Kenneth Ballenegger
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-08-19 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: smarty_streets
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: validate
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.6'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.6'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description: Verify addresses using SmartyStreets
70
+ email:
71
+ - kenneth@ballenegger.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - Gemfile
78
+ - LICENSE.txt
79
+ - README.md
80
+ - Rakefile
81
+ - lib/validate-address-smartystreets.rb
82
+ - lib/validate-address-smartystreets/version.rb
83
+ - validate-address-smartystreets.gemspec
84
+ homepage: https://github.com/kballenegger/validate-address-smartystreets
85
+ licenses:
86
+ - http://license.azuretalon.com
87
+ metadata: {}
88
+ post_install_message:
89
+ rdoc_options: []
90
+ require_paths:
91
+ - lib
92
+ required_ruby_version: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ required_rubygems_version: !ruby/object:Gem::Requirement
98
+ requirements:
99
+ - - ">="
100
+ - !ruby/object:Gem::Version
101
+ version: '0'
102
+ requirements: []
103
+ rubyforge_project:
104
+ rubygems_version: 2.2.2
105
+ signing_key:
106
+ specification_version: 4
107
+ summary: Verify addresses using SmartyStreets
108
+ test_files: []
109
+ has_rdoc: