address_validator 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5af87fb8d4f36b232617af62df65bfc65e5fd9a
+  data.tar.gz: ac831584b8e803d1c026faf83890e705d3854f74
+SHA512:
+  metadata.gz: 06be75bc5fb2f47af0fdfc772bc44837c0b90c83b10d13e97f12b2b56209dafcf525f790a8900234a11a0f34c68b1b18e0acfa38df4ecadfbfdd45ff70ddc183
+  data.tar.gz: 07787078a406a37018ad7dc6db921daf6b0955d17c1248a1cb5fff7de29c91a004fc8afa89c79a1b940ae461cee4007c5d2a40c46428fa61b4c01a65400cbba6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.3
+before_install:
+  - cp ./spec/config.yml.example ./spec/config.yml
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in address_validator.gemspec
+gemspec
+
+group :test do
+  gem 'rspec', '~> 2.12.0'
+  gem 'webmock', '~> 1.9.0'
+  gem 'vcr', '~> 2.4.0'
+  gem 'mocha', '~> 0.10.5'
+  gem 'faker', '~> 1.1.2'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 robhurring
+
+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,79 @@
+[![Build Status](https://travis-ci.org/robhurring/address-validator.svg)](https://travis-ci.org/robhurring/address-validator)
+
+# AddressValidator
+
+Wrapper around the UPS street level validation API. Nowhere near a complete implementation. This will just give some basic information back, such as address classification (residential/commercial) and if it is valid or not.
+
+This can be modified to include address suggestions pretty easily in the `Validator#build_request` method, but we have no need of this right now.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'address_validator', github: 'robhurring/address-validator'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Configuring the client
+
+```ruby
+AddressValidator.configure do |config|
+  config.key = 'youraccesskeyfromups'
+  config.username = 'username'
+  config.password = 'hunter2'
+end
+```
+
+Basic Example
+
+```ruby
+address = AddressValidator::Address.new(
+  name: 'Yum',
+  street1: '33 St. Marks Place',
+  city: 'New York',
+  state: 'NY',
+  zip: '10003',
+  country: 'US'
+)
+
+validator = AddressValidator::Validator.new
+response = validator.validate(address)
+
+# check if address is valid
+response.valid?
+
+# get the returned address
+new_address = response.address
+
+# check if its a house
+new_address.residential?
+```
+
+You can also pass hashes directly into the validator if you want.
+
+```ruby
+validator = AddressValidator::Validator.new
+response = validator.validate(
+  name: 'Yum',
+  street1: '33 St. Marks Place',
+  city: 'New York',
+  state: 'NY',
+  zip: '10003',
+  country: 'US'
+)
+
+# check if address is valid
+response.valid?
+```
+
+## 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 @@
+require "bundler/gem_tasks"

data/address_validator.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'address_validator/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "address_validator"
+  gem.version       = AddressValidator::VERSION
+  gem.authors       = ["robhurring"]
+  gem.email         = ["robhurring@gmail.com"]
+  gem.description   = %q{UPS address validation gem}
+  gem.summary       = %q{Simple address validator using the UPS address validation API}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'httparty', '>= 0.11.0'
+  gem.add_dependency 'builder', '>= 3.0.4'
+end

data/lib/address_validator.rb

@@ -0,0 +1,18 @@
+require "address_validator/version"
+
+require_relative './address_validator/config'
+require_relative './address_validator/address'
+require_relative './address_validator/response'
+require_relative './address_validator/client'
+require_relative './address_validator/validator'
+
+module AddressValidator
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure(&block)
+    self.config = Config.new
+    yield self.config
+  end
+end

data/lib/address_validator/address.rb

@@ -0,0 +1,79 @@
+require 'builder'
+
+module AddressValidator
+  class Address
+    CLASSIFICATION_UNKNOWN = 0
+    CLASSIFICATION_COMMERCIAL = 1
+    CLASSIFICATION_RESIDENTIAL = 2
+
+    class << self
+      # Public: Build an address from the API's response xml.
+      #
+      # attrs  - Hash of address attributes.
+      #
+      # Returns an address.
+      def from_xml(attrs = {})
+        classification = nil
+
+        if _classification = attrs['AddressClassification']
+          classification = _classification['Code']
+        end
+
+        # AddressLine can come in as a single element, or upto 3 elements according
+        # to the UPS docs, so we force it into an array and split them up
+        address_lines = Array(attrs['AddressLine'])
+
+        new(
+          street1: address_lines[0],
+          street2: address_lines[1],
+          street3: address_lines[2],
+          city: attrs['PoliticalDivision2'],
+          state: attrs['PoliticalDivision1'],
+          zip: attrs['PostcodePrimaryLow'],
+          country: attrs['CountryCode'],
+          classification: classification
+        )
+      end
+    end
+
+    attr_accessor :name, :street1, :street2, :street3, :city, :state, :zip, :country, :classification
+
+    def initialize(name: name(), street1: street1(), street2: street2(), street3: street3(), city: city(), state: state(), zip: zip(), country: country(), classification: classification())
+      @name = name
+      @street1 = street1
+      @street2 = street2
+      @street3 = street3
+      @city = city
+      @state = state
+      @zip = zip
+      @country = country
+      @classification = (classification || CLASSIFICATION_UNKNOWN).to_i
+    end
+
+    def residential?
+      classification == CLASSIFICATION_RESIDENTIAL
+    end
+
+    def commercial?
+      classification == CLASSIFICATION_COMMERCIAL
+    end
+
+    def to_xml(options={})
+
+      xml = Builder::XmlMarkup.new(options)
+
+      xml.AddressKeyFormat do
+        xml.ConsigneeName(self.name)
+        xml.tag! 'AddressLine', self.street1
+        xml.tag! 'AddressLine', self.street2 if self.street2
+        xml.tag! 'AddressLine', self.street3 if self.street3
+        xml.PoliticalDivision2(self.city)
+        xml.PoliticalDivision1(self.state)
+        xml.PostcodePrimaryLow(self.zip)
+        xml.CountryCode(self.country)
+      end
+
+      xml.target!
+    end
+  end
+end

data/lib/address_validator/client.rb

@@ -0,0 +1,45 @@
+require 'httparty'
+require 'builder'
+
+module AddressValidator
+  class Client
+    include HTTParty
+    format :xml
+
+    def initialize
+      @config = AddressValidator.config
+      set_base_uri
+    end
+
+    def access_request
+      xml = Builder::XmlMarkup.new
+
+      xml.instruct!
+      xml.AccessRequest do
+        xml.AccessLicenseNumber(@config.key)
+        xml.UserId(@config.username)
+        xml.Password(@config.password)
+      end
+    end
+
+    def set_base_uri
+      if @config.testing
+        endpoint = 'https://wwwcie.ups.com'
+      else
+        endpoint = 'https://onlinetools.ups.com'
+      end
+
+      self.class.base_uri(endpoint)
+    end
+
+    def post(request)
+      xml = Builder::XmlMarkup.new
+      xml << access_request
+      xml << request
+      body = xml.target!
+
+      api_response = self.class.post('/ups.app/xml/XAV', body: body)
+      Response.new(api_response)
+    end
+  end
+end

data/lib/address_validator/config.rb

@@ -0,0 +1,5 @@
+module AddressValidator
+  class Config
+    attr_accessor :key, :username, :password, :testing
+  end
+end

data/lib/address_validator/response.rb

@@ -0,0 +1,47 @@
+require 'forwardable'
+
+module AddressValidator
+  class Response
+    extend Forwardable
+
+    attr_reader :api_response
+    def_delegators :api_response, :[]
+
+    def initialize(api_response)
+      @api_response = api_response
+    end
+
+    def ok?
+      @api_response.ok?
+    end
+
+    def success?
+      ok? && response['Response']['ResponseStatusCode'] == '1'
+    end
+
+    def response
+      @response ||= self['AddressValidationResponse']
+    end
+
+    def error
+      _error_container = response['Response']['Error']
+      _error_container && _error_container['ErrorDescription']
+    end
+
+    def valid?
+      response.has_key?('ValidAddressIndicator')
+    end
+
+    def ambiguous?
+      response.has_key?('AmbiguousAddressIndicator')
+    end
+
+    def no_canidates?
+      response.has_key?('NoCandidatesIndicator')
+    end
+
+    def address
+      AddressValidator::Address.from_xml(response['AddressKeyFormat'])
+    end
+  end
+end

data/lib/address_validator/validator.rb

@@ -0,0 +1,40 @@
+require 'builder'
+
+module AddressValidator
+  class Validator
+    attr_reader :client
+
+    def initialize
+      @client = Client.new
+    end
+
+    def validate(address)
+      if address.is_a?(::Hash)
+        address = build_address(address)
+      end
+
+      request = build_request(address)
+      @client.post(request)
+    end
+
+    def build_address(attrs)
+      AddressValidator::Address.new(attrs)
+    end
+
+    def build_request(address)
+      xml = Builder::XmlMarkup.new
+
+      xml.instruct!
+      xml.AddressValidationRequest do
+        xml.Request do
+          xml.RequestAction 'XAV' # must be XAV
+          xml.RequestOption '3'   # validation + classification
+        end
+        xml.MaximumListSize('1')
+        xml << address.to_xml
+      end
+
+      xml.target!
+    end
+  end
+end

data/lib/address_validator/version.rb

@@ -0,0 +1,3 @@
+module AddressValidator
+  VERSION = "0.1.1"
+end

data/spec/config.yml.example

@@ -0,0 +1,6 @@
+# copy this file to spec/config.yml and place your username, password, apikey here
+
+access_key: youraccesstoken
+username: user
+password: password
+testing: true

data/spec/data/vcr_cassettes/invalid-address.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://onlinetools.ups.com/ups.app/xml/XAV
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="UTF-8"?><AccessRequest><AccessLicenseNumber>%{AccessLicenseNumber}</AccessLicenseNumber><UserId>%{UserId}</UserId><Password>%{Password}</Password></AccessRequest><?xml
+        version="1.0" encoding="UTF-8"?><AddressValidationRequest><Request><RequestAction>XAV</RequestAction><RequestOption>3</RequestOption></Request><MaximumListSize>1</MaximumListSize><AddressKeyFormat><ConsigneeName>Doctor
+        Daves Backyard Dentistry</ConsigneeName><AddressLine>1 Seseme Street</AddressLine><PoliticalDivision2>New
+        York</PoliticalDivision2><PoliticalDivision1>NY</PoliticalDivision1><PostcodePrimaryLow>10012</PostcodePrimaryLow><CountryCode>US</CountryCode></AddressKeyFormat></AddressValidationRequest>
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 15 Nov 2015 00:36:42 GMT
+      Server:
+      - Apache
+      X-Frame-Options:
+      - SAMEORIGIN
+      Pragma:
+      - no-cache
+      Content-Length:
+      - '365'
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/xml
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0"?><AddressValidationResponse><Response><TransactionReference></TransactionReference><ResponseStatusCode>1</ResponseStatusCode><ResponseStatusDescription>Success</ResponseStatusDescription></Response><NoCandidatesIndicator/><AddressClassification><Code>0</Code><Description>Unknown</Description></AddressClassification></AddressValidationResponse>
+    http_version: 
+  recorded_at: Sun, 15 Nov 2015 00:36:42 GMT
+recorded_with: VCR 2.4.0

data/spec/data/vcr_cassettes/valid-address-hash.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://onlinetools.ups.com/ups.app/xml/XAV
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="UTF-8"?><AccessRequest><AccessLicenseNumber>%{AccessLicenseNumber}</AccessLicenseNumber><UserId>%{UserId}</UserId><Password>%{Password}</Password></AccessRequest><?xml
+        version="1.0" encoding="UTF-8"?><AddressValidationRequest><Request><RequestAction>XAV</RequestAction><RequestOption>3</RequestOption></Request><MaximumListSize>1</MaximumListSize><AddressKeyFormat><ConsigneeName>Yum</ConsigneeName><AddressLine>33
+        St. Marks Place</AddressLine><AddressLine>Suite 3</AddressLine><AddressLine>C/O
+        Some Dude</AddressLine><PoliticalDivision2>New York</PoliticalDivision2><PoliticalDivision1>NY</PoliticalDivision1><PostcodePrimaryLow>10003</PostcodePrimaryLow><CountryCode>US</CountryCode></AddressKeyFormat></AddressValidationRequest>
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 15 Nov 2015 00:36:44 GMT
+      Server:
+      - Apache
+      X-Frame-Options:
+      - SAMEORIGIN
+      Pragma:
+      - no-cache
+      Content-Length:
+      - '829'
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/xml
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0"?><AddressValidationResponse><Response><TransactionReference></TransactionReference><ResponseStatusCode>1</ResponseStatusCode><ResponseStatusDescription>Success</ResponseStatusDescription></Response><ValidAddressIndicator/><AddressClassification><Code>1</Code><Description>Commercial</Description></AddressClassification><AddressKeyFormat><AddressClassification><Code>1</Code><Description>Commercial</Description></AddressClassification><AddressLine>33
+        ST MARKS PL</AddressLine><AddressLine>APT 3</AddressLine><Region>NEW YORK
+        NY 10003-7832</Region><PoliticalDivision2>NEW YORK</PoliticalDivision2><PoliticalDivision1>NY</PoliticalDivision1><PostcodePrimaryLow>10003</PostcodePrimaryLow><PostcodeExtendedLow>7832</PostcodeExtendedLow><CountryCode>US</CountryCode></AddressKeyFormat></AddressValidationResponse>
+    http_version: 
+  recorded_at: Sun, 15 Nov 2015 00:36:43 GMT
+recorded_with: VCR 2.4.0

data/spec/data/vcr_cassettes/valid-address.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://onlinetools.ups.com/ups.app/xml/XAV
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="UTF-8"?><AccessRequest><AccessLicenseNumber>%{AccessLicenseNumber}</AccessLicenseNumber><UserId>%{UserId}</UserId><Password>%{Password}</Password></AccessRequest><?xml
+        version="1.0" encoding="UTF-8"?><AddressValidationRequest><Request><RequestAction>XAV</RequestAction><RequestOption>3</RequestOption></Request><MaximumListSize>1</MaximumListSize><AddressKeyFormat><ConsigneeName>Yum</ConsigneeName><AddressLine>33
+        St. Marks Place</AddressLine><AddressLine>Suite 3</AddressLine><PoliticalDivision2>New
+        York</PoliticalDivision2><PoliticalDivision1>NY</PoliticalDivision1><PostcodePrimaryLow>10003</PostcodePrimaryLow><CountryCode>US</CountryCode></AddressKeyFormat></AddressValidationRequest>
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 15 Nov 2015 00:36:41 GMT
+      Server:
+      - Apache
+      X-Frame-Options:
+      - SAMEORIGIN
+      Pragma:
+      - no-cache
+      Content-Length:
+      - '829'
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/xml
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0"?><AddressValidationResponse><Response><TransactionReference></TransactionReference><ResponseStatusCode>1</ResponseStatusCode><ResponseStatusDescription>Success</ResponseStatusDescription></Response><ValidAddressIndicator/><AddressClassification><Code>1</Code><Description>Commercial</Description></AddressClassification><AddressKeyFormat><AddressClassification><Code>1</Code><Description>Commercial</Description></AddressClassification><AddressLine>33
+        ST MARKS PL</AddressLine><AddressLine>APT 3</AddressLine><Region>NEW YORK
+        NY 10003-7832</Region><PoliticalDivision2>NEW YORK</PoliticalDivision2><PoliticalDivision1>NY</PoliticalDivision1><PostcodePrimaryLow>10003</PostcodePrimaryLow><PostcodeExtendedLow>7832</PostcodeExtendedLow><CountryCode>US</CountryCode></AddressKeyFormat></AddressValidationResponse>
+    http_version: 
+  recorded_at: Sun, 15 Nov 2015 00:36:41 GMT
+recorded_with: VCR 2.4.0

data/spec/lib/address_validator/address_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe AddressValidator::Address do
+  describe 'properties' do
+    subject(:address) do
+      described_class.new(
+        name: 'rob',
+        street1: 'street1',
+        street2: 'street2',
+        street3: 'street3',
+        city: 'city',
+        state: 'state',
+        zip: '90210',
+        country: 'US'
+      )
+    end
+
+    its(:name)    { should eq 'rob' }
+    its(:street1) { should eq 'street1' }
+    its(:street2) { should eq 'street2' }
+    its(:street3) { should eq 'street3' }
+    its(:city)    { should eq 'city' }
+    its(:state)   { should eq 'state' }
+    its(:zip)     { should eq '90210' }
+    its(:country) { should eq 'US' }
+  end
+
+  describe '#to_xml' do
+    let(:address) do
+      described_class.new(
+        name: 'rob',
+        street1: 'street1',
+        street2: 'street2',
+        city: 'city',
+        state: 'state',
+        zip: '90210',
+        country: 'US'
+      )
+    end
+
+    let(:xml){ address.to_xml }
+
+    it 'should have a ConsigneeName' do
+      xml.should =~ /<ConsigneeName>rob<\/ConsigneeName>/
+    end
+
+    it 'should have a AddressLine for street1' do
+      xml.should =~ /<AddressLine>street1<\/AddressLine>/
+    end
+
+    it 'should have a AddressLine for street2' do
+      xml.should =~ /<AddressLine>street2<\/AddressLine>/
+    end
+
+    it 'should not have a AddressLine for street3' do
+      xml.should_not =~ /<AddressLine>street3<\/AddressLine>/
+    end
+
+    it 'should have a PoliticalDivision2' do
+      xml.should =~ /<PoliticalDivision2>city<\/PoliticalDivision2>/
+    end
+
+    it 'should have a PoliticalDivision1' do
+      xml.should =~ /<PoliticalDivision1>state<\/PoliticalDivision1>/
+    end
+
+    it 'should have a PostcodePrimaryLow' do
+      xml.should =~ /<PostcodePrimaryLow>90210<\/PostcodePrimaryLow>/
+    end
+
+    it 'should have a CountryCode' do
+      xml.should =~ /<CountryCode>US<\/CountryCode>/
+    end
+  end
+
+  describe '#from_xml' do
+    context 'when only a single AddressLine comes back' do
+      let!(:xml) do
+        MultiXml.parse %{
+          <AddressKeyFormat>
+            <AddressClassification>
+              <Code>1</Code>
+              <Description>Commercial</Description>
+            </AddressClassification>
+            <AddressLine>648 BROADWAY</AddressLine>
+            <Region>NEW YORK NY 10012-2348</Region>
+            <PoliticalDivision2>NEW YORK</PoliticalDivision2>
+            <PoliticalDivision1>NY</PoliticalDivision1>
+            <PostcodePrimaryLow>10012</PostcodePrimaryLow>
+            <PostcodeExtendedLow>2348</PostcodeExtendedLow>
+            <CountryCode>US</CountryCode>
+          </AddressKeyFormat>
+        }
+      end
+
+      subject(:address){ described_class.from_xml(xml['AddressKeyFormat']) }
+
+      its(:street1){ should eq '648 BROADWAY' }
+      its(:street2){ should be_nil }
+      its(:street3){ should be_nil }
+      its(:classification){ should eq described_class::CLASSIFICATION_COMMERCIAL }
+      its(:city){ should eq 'NEW YORK' }
+      its(:state){ should eq 'NY' }
+      its(:zip){ should eq '10012' }
+      its(:country){ should eq 'US' }
+    end
+
+    context 'when multiple AddressLines comes back' do
+      let!(:xml) do
+        MultiXml.parse %{
+          <AddressKeyFormat>
+            <AddressClassification>
+              <Code>1</Code>
+              <Description>Commercial</Description>
+            </AddressClassification>
+            <AddressLine>648 BROADWAY</AddressLine>
+            <AddressLine>SUITE 1</AddressLine>
+            <AddressLine>C/O SOME GUY</AddressLine>
+            <Region>NEW YORK NY 10012-2348</Region>
+            <PoliticalDivision2>NEW YORK</PoliticalDivision2>
+            <PoliticalDivision1>NY</PoliticalDivision1>
+            <PostcodePrimaryLow>10012</PostcodePrimaryLow>
+            <PostcodeExtendedLow>2348</PostcodeExtendedLow>
+            <CountryCode>US</CountryCode>
+          </AddressKeyFormat>
+        }
+      end
+
+      subject(:address){ described_class.from_xml(xml['AddressKeyFormat']) }
+
+      its(:street1){ should eq '648 BROADWAY' }
+      its(:street2){ should eq 'SUITE 1' }
+      its(:street3){ should eq 'C/O SOME GUY' }
+      its(:classification){ should eq described_class::CLASSIFICATION_COMMERCIAL }
+      its(:city){ should eq 'NEW YORK' }
+      its(:state){ should eq 'NY' }
+      its(:zip){ should eq '10012' }
+      its(:country){ should eq 'US' }
+    end
+
+  end
+end

data/spec/lib/address_validator/validator_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe AddressValidator::Validator do
+  let(:validator){ described_class.new }
+
+  context 'with a valid address', vcr: {cassette_name: 'valid-address'} do
+    let(:address) do
+      AddressValidator::Address.new(
+        name: 'Yum',
+        street1: '33 St. Marks Place',
+        street2: 'Suite 3',
+        city: 'New York',
+        state: 'NY',
+        zip: '10003',
+        country: 'US'
+      )
+     end
+
+    describe '#validate' do
+      let(:response){ validator.validate(address) }
+
+      it 'should be HTTP ok' do
+        response.should be_ok
+      end
+
+      it 'should be a successful request' do
+        response.should be_success
+      end
+
+      it 'should be a valid address' do
+        response.should be_valid
+      end
+
+      it 'should have an address' do
+        response.address.should_not be_nil
+      end
+
+      it 'should have no errors' do
+        response.error.should be_nil
+      end
+    end
+  end
+
+  context 'with an invalid address', vcr: {cassette_name: 'invalid-address'} do
+    let(:address) do
+      AddressValidator::Address.new(
+        name: 'Doctor Daves Backyard Dentistry',
+        street1: '1 Seseme Street',
+        city: 'New York',
+        state: 'NY',
+        zip: '10012',
+        country: 'US'
+      )
+     end
+
+    describe '#validate' do
+      let(:response){ validator.validate(address) }
+
+      it 'should be HTTP ok' do
+        response.should be_ok
+      end
+
+      it 'should be a successful request' do
+        response.should be_success
+      end
+
+      it 'should not be a valid address' do
+        response.should_not be_valid
+      end
+    end
+  end
+
+  context 'when passing in address hashes', vcr: {cassette_name: 'valid-address-hash'} do
+    let(:address_hash) do
+      {
+        name: 'Yum',
+        street1: '33 St. Marks Place',
+        street2: 'Suite 3',
+        street3: 'C/O Some Dude',
+        city: 'New York',
+        state: 'NY',
+        zip: '10003',
+        country: 'US'
+      }
+     end
+
+    describe '#validate' do
+      let(:response){ validator.validate(address_hash) }
+
+      it 'should be HTTP ok' do
+        response.should be_ok
+      end
+
+      it 'should be a successful request' do
+        response.should be_success
+      end
+
+      it 'should be a valid address' do
+        response.should be_valid
+      end
+
+      it 'should have an address' do
+        response.address.should_not be_nil
+      end
+
+      it 'should have no errors' do
+        response.error.should be_nil
+      end
+    end
+  end
+end

data/spec/lib/address_validator_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe AddressValidator do
+  describe '.configure' do
+    it 'should set the key' do
+      described_class.configure do |config|
+        config.key = '90210'
+      end
+
+      described_class.config.key.should eq '90210'
+    end
+
+    it 'should set the username' do
+      described_class.configure do |config|
+        config.username = 'usr'
+      end
+
+      described_class.config.username.should eq 'usr'
+    end
+
+    it 'should set the password' do
+      described_class.configure do |config|
+        config.password = 's3cre7'
+      end
+
+      described_class.config.password.should eq 's3cre7'
+    end
+
+    it 'should set the testing flag' do
+      described_class.configure do |config|
+        config.testing = true
+      end
+
+      described_class.config.testing.should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default, :test)
+require 'faker'
+require 'address_validator'
+
+default_config = AddressValidator::Config.new
+config_file = File.expand_path('../config.yml', __FILE__)
+if File.exists?(config_file)
+  API_CONFIG = YAML.load_file(config_file)
+  default_config.key = API_CONFIG['access_key']
+  default_config.username = API_CONFIG['username']
+  default_config.password = API_CONFIG['password']
+else
+  puts "ERROR!"
+  puts "No config file was found! Copy the config.yml.example file to spec/config.yml and fill out the details."
+  exit 1
+end
+
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each{ |f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = "random"
+  config.mock_with :mocha
+
+  config.before(:each) do
+    # reset any config changes we've made
+    AddressValidator.config = default_config
+  end
+end

data/spec/support/vcr.rb

@@ -0,0 +1,20 @@
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/data/vcr_cassettes'
+  c.hook_into :webmock
+  c.ignore_localhost = true
+  c.configure_rspec_metadata!
+  c.default_cassette_options = {record: :new_episodes}
+  c.filter_sensitive_data('%{AccessLicenseNumber}'){ API_CONFIG['access_key'] }
+  c.filter_sensitive_data('%{UserId}'){ API_CONFIG['username'] }
+  c.filter_sensitive_data('%{Password}'){ API_CONFIG['password'] }
+end
+
+# Re-Record all VCR cassettes
+# Usage: RERECORD=1 rspec
+unless ENV['RERECORD'].to_i.zero?
+  $stderr << "Re-Recording...\n\n"
+
+  VCR.configure do |c|
+    c.default_cassette_options = {record: :all}
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: address_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- robhurring
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+description: UPS address validation gem
+email:
+- robhurring@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- address_validator.gemspec
+- lib/address_validator.rb
+- lib/address_validator/address.rb
+- lib/address_validator/client.rb
+- lib/address_validator/config.rb
+- lib/address_validator/response.rb
+- lib/address_validator/validator.rb
+- lib/address_validator/version.rb
+- spec/config.yml.example
+- spec/data/vcr_cassettes/invalid-address.yml
+- spec/data/vcr_cassettes/valid-address-hash.yml
+- spec/data/vcr_cassettes/valid-address.yml
+- spec/lib/address_validator/address_spec.rb
+- spec/lib/address_validator/validator_spec.rb
+- spec/lib/address_validator_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr.rb
+homepage: ''
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Simple address validator using the UPS address validation API
+test_files:
+- spec/config.yml.example
+- spec/data/vcr_cassettes/invalid-address.yml
+- spec/data/vcr_cassettes/valid-address-hash.yml
+- spec/data/vcr_cassettes/valid-address.yml
+- spec/lib/address_validator/address_spec.rb
+- spec/lib/address_validator/validator_spec.rb
+- spec/lib/address_validator_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr.rb