live_address 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWU0YjJlMzlmMjJjZTcyNWZjODlkMDE2NzhkMTA5NWEyMzhkN2Q3NA==
+  data.tar.gz: !binary |-
+    ZDkxYmFhZDkxMzAyMzJlOWY5YTIxODI0MzBiNGZhOTIzZWRhZTYyNw==
+SHA512:
+  metadata.gz: !binary |-
+    MWY2ZjlkM2YyYTVlY2M3YWEyZjFjNWFkZjcyMDRmNWM2OWU5OGNmOGQ0YjRk
+    MDhlYmI5NTE4YjQ5ZDdiMDUyOTNmZWIzYmZjMGY4YTQyYTlhMDRmMzViOTk2
+    ZjQ4NGMyNThlMWRmNTJhOTU5MDYyYmViZWM1NThjOGVjZGZiYWU=
+  data.tar.gz: !binary |-
+    NWNkNTg5MjI0Mzc1ZTg0YmI0NDhkNjgwZjk0OTE1NmU5N2JhMTA5NDQyZjI3
+    MWZjYjA1YjVkMTA0M2Q1MDA2Y2Y3MDU3ZjNhMjA5MzM0ZjVlN2U5YjY3MmJm
+    MDY1NmViMzc1NTg3YTM4OTQ3ZjAxYzY2NWZiOGY0NTJiMTJmNDQ=

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/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 Chris Stringer
+
+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,144 @@
+# LiveAddress
+
+Ruby gem to perform US address validation by way of a Ruby interface to the [SmartyStreets LiveAddress API](http://smartystreets.com/). Gives you a Ruby DSL to interact with the API and first class Ruby objects from the response. If you need to validate addresses, skip the unmaintained scrap yard of USPS related gems out there and use a more modern solution such as this one. SmartyStreets currently provides 250 free lookups per month. Beyond that they have reasonable pricing.
+
+This gem is certainly not the only attempt to wrap this API, although I believe it is the newest one. Check out [smarty_streets](https://github.com/russ/smarty_streets) (a basic wrapper for street address verification) and [smartystreets](https://github.com/centzy/smartystreets) (supports street and ZIP code APIs, batch requests, and all documented fields) which were both around before I created this gem.
+
+Where this gem differs from its predecessors is that it attempts to futureproof changes to what the SmartyStreets LiveAddress API returns by dynamically creating the Ruby response objects. This means that if the SmartyStreets decides to add or remove attributes to/from what their API returns, this gem should still "just work".
+
+## Current Version
+
+0.0.2
+
+## Requirements
+
+This gem was created and tested with Ruby 1.9.3. It may well work with earlier versions of Ruby but I make no guarantees.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'live_address'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install live_address
+
+## Usage
+
+1. First things first. You will need to sign up for an account with Smarty Streets. Once you have signed up and logged in you should be able to generate an API key which will give you the Auth ID and Auth Token that you'll need to start using this gem.
+2. Configure your Rails app to use your credentials with the gem. The suggested approach would be to put this in an initializer. Also be sure to use the raw version of the Auth token and not the encoded one.
+
+```
+LiveAddress.configure do |config|
+  config.auth_id    = "YOUR AUTH ID"
+  config.auth_token = "YOUR AUTH TOKEN"
+end
+```
+
+3. Use the verify method to request address verification of an address that you submit. The list of valid input fields can be seen [here](http://smartystreets.com/kb/liveaddress-api/rest-endpoint). Note that you can limit the number of results using the optional candidates field. The results are returned as an array of formatted address objects, and a lookup with no results simply returns an empty array.
+
+```
+=> address = {
+            :city    => "bend",
+            :state   => "oregon",
+            :zipcode => "97701",
+            :street  => "550 NW Franklin Avenue",
+            :street2 => "Suite 200"
+          }
+
+=> LiveAddress.verify(address)
+
+# [#<LiveAddress::ResponseParser:0x007ffd6c972fe0
+  @analysis=
+   #<Analysis:0x007ffd6c970830
+    @active="Y",
+    @dpv_cmra="N",
+    @dpv_footnotes="AABB",
+    @dpv_match_code="Y",
+    @dpv_vacant="N",
+    @footnotes="N#">,
+  @candidate_index=0,
+  @components=
+   #<Components:0x007ffd6c9728d8
+    @city_name="Bend",
+    @delivery_point="50",
+    @delivery_point_check_digit="0",
+    @plus4_code="2892",
+    @primary_number="550",
+    @secondary_designator="Ste",
+    @secondary_number="200",
+    @state_abbreviation="OR",
+    @street_name="Franklin",
+    @street_predirection="NW",
+    @street_suffix="Ave",
+    @zipcode="97701">,
+  @delivery_line_1="550 NW Franklin Ave Ste 200",
+  @delivery_point_barcode="977012892500",
+  @input_index=0,
+  @last_line="Bend OR 97701-2892",
+  @metadata=
+   #<Metadata:0x007ffd6c971a28
+    @carrier_route="C004",
+    @congressional_district="02",
+    @county_fips="41017",
+    @county_name="Deschutes",
+    @dst=true,
+    @elot_sequence="0241",
+    @elot_sort="A",
+    @latitude=44.05722,
+    @longitude=-121.31347,
+    @precision="Zip9",
+    @rdi="Commercial",
+    @record_type="H",
+    @time_zone="Pacific",
+    @utc_offset=-8.0,
+    @zip_type="Standard">>]
+```
+
+## Specs
+
+Specs are written using mini-test. Run them like this.
+
+```
+rake
+```
+
+## TODO
+
+* Add support for zip code API
+* Add support for POST requests which would in turn allow for multiple addresses in one submission (batch requests)
+
+## Authors
+
+Chris Stringer / [@jcstringer](https://github.com/jcstringer)
+
+## Bugs
+
+File an [issue](https://github.com/jcstringer/live_address/issues)
+
+## 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
+
+If you find bugs, have feature requests or questions, please file an issue.
+
+## License
+
+Copyright (c) 2013 Chris Stringer
+
+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/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/lib/live_address/test_*.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/live_address.rb

@@ -0,0 +1,45 @@
+require 'httparty'
+
+require_relative "./live_address/exceptions"
+require_relative "./live_address/version"
+require_relative "./live_address/configuration"
+require_relative "./live_address/address"
+require_relative "./live_address/url_builder"
+require_relative "./live_address/response_parser"
+
+module LiveAddress
+
+  class << self
+    attr_accessor :configuration
+
+    # Pattern inspired by http://robots.thoughtbot.com/mygem-configure-block/
+    def configure
+      self.configuration = Configuration.new
+      yield(configuration)
+    end
+
+    def auth_id
+      LiveAddress.configuration.auth_id
+    end
+
+    def auth_token
+      LiveAddress.configuration.auth_token
+    end
+
+    def api_endpoint
+      LiveAddress.configuration.api_endpoint
+    end
+
+    def verify(options={})
+      if self.configuration.auth_id.nil? || self.configuration.auth_token.nil?
+        raise LiveAddress::InvalidConfigError
+      end
+      raise LiveAddress::InvalidArgumentError if options.empty?
+      address = Address.new(options)
+      url = UrlBuilder.new(address).url
+      response = HTTParty.get(url)
+      ResponseParser.parse(response)
+    end
+
+  end
+end

data/lib/live_address/address.rb

@@ -0,0 +1,21 @@
+module LiveAddress
+  class Address
+
+    attr_accessor :street, :street2, :secondary, :city, :state, :zipcode, :lastline, :addressee,
+                  :urbanization, :callback, :candidates
+
+    def initialize(options)
+      set_attributes(options)
+    end
+
+    private
+
+    def set_attributes(options)
+      options.each do |key,value|
+        raise LiveAddress::InvalidArgumentError unless respond_to?(key)
+        self.send("#{key}=", value)
+      end
+    end
+
+  end
+end

data/lib/live_address/configuration.rb

@@ -0,0 +1,12 @@
+module LiveAddress
+  class Configuration
+
+    attr_accessor :api_endpoint, :auth_id, :auth_token
+
+    def initialize
+      @api_endpoint = 'https://api.smartystreets.com/street-address'
+    end
+
+  end
+
+end

data/lib/live_address/exceptions.rb

@@ -0,0 +1,10 @@
+module LiveAddress
+
+  class InvalidConfigError < StandardError; end
+  class InvalidArgumentError < StandardError; end
+  class BadInputError < StandardError; end
+  class AuthorizationError < StandardError; end
+  class PaymentRequiredError < StandardError; end
+  class InternalServerError < StandardError; end
+
+end

data/lib/live_address/response_parser.rb

@@ -0,0 +1,54 @@
+require 'json'
+
+module LiveAddress
+
+  class ResponseParser
+
+    def self.parse(response)
+      raise BadInputError        if response.code == 400
+      raise AuthorizationError   if response.code == 401
+      raise PaymentRequiredError if response.code == 402
+      raise InternalServerError  if response.code == 500
+
+      parsed_response = JSON.parse(response.body)
+      parsed_response.map {|r| ResponseParser.new(r) }
+    end
+
+    def initialize(response)
+      set_attrs(response)
+    end
+
+    private
+
+    def set_attrs(hash)
+      # Dynamically create attrs on the object for each hash key
+      # and create subclasses for nested hashes
+      hash.each do |key,value|
+        symbolized_key = key.to_sym
+        define_attr(symbolized_key)
+        if value.is_a?(Hash)
+          populate_subclass(key, value)
+        else
+          self.send("#{symbolized_key}=", value)
+        end
+      end
+    end
+
+    def define_attr(attribute)
+      self.class.send(:attr_accessor, attribute)
+    end
+
+    def populate_subclass(attribute, hash)
+      klass_name = attribute.capitalize
+      if Object.const_defined? klass_name
+        klass = Object.const_get klass_name
+      else
+        klass = Object.const_set klass_name, Class.new(self.class)
+      end
+      klass.send(:define_method, :initialize) { |args| set_attrs(args) }
+      instance_variable_set("@#{attribute}", klass.new(hash))
+    end
+
+  end
+
+end

data/lib/live_address/url_builder.rb

@@ -0,0 +1,37 @@
+require 'uri'
+
+module LiveAddress
+
+  class UrlBuilder
+
+    attr_accessor :instance, :url
+
+    def initialize(instance)
+      @instance = instance
+      @url = build_url
+    end
+
+    private
+
+    def build_url
+      params = {
+        :street => instance.street,
+        :street2 => instance.street2,
+        :secondary => instance.secondary,
+        :city => instance.city,
+        :state => instance.state,
+        :zipcode => instance.zipcode,
+        :lastline => instance.lastline,
+        :addressee => instance.addressee,
+        :urbanization => instance.urbanization,
+        :callback => instance.callback,
+        :candidates => instance.candidates,
+        :"auth-id" => LiveAddress::auth_id,
+        :"auth-token" => LiveAddress::auth_token
+      }
+      "#{LiveAddress::api_endpoint}?#{URI.encode_www_form(params)}"
+    end
+
+  end
+
+end

data/lib/live_address/version.rb

@@ -0,0 +1,3 @@
+module LiveAddress
+  VERSION = "0.0.2"
+end

data/live_address.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'live_address/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "live_address"
+  spec.version       = LiveAddress::VERSION
+  spec.authors       = ["Chris Stringer"]
+  spec.email         = ["chris.stringer@g5searchmarketing.com"]
+  spec.description   = %q{Ruby wrapper for the SmartyStreets LiveAddress API}
+  spec.summary       = %q{Creates requests and parses responses to/from the SmartyStreets LiveAddress API using Ruby.}
+  spec.homepage      = "https://github.com/jcstringer/live_address"
+  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"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "mocha"
+end

data/test/cassettes/address.yml

@@ -0,0 +1,142 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.smartystreets.com/street-address?addressee&auth-id=00b81f59-bf87-42a6-ac65-5ea8556cac81&auth-token=mhv7Wy1BLAptSU4eSucbxZYiz2DtdBioQe%2Bq%2BOaFGViRRxx3OFlR5Cc1wShTaS5Yx3cLFF88MsGfKpc2A099yg==&callback&candidates&city=Bend&lastline&secondary&state=OR&street=550%20NW%20Franklin%20Avenue&street2=Suite%20200&urbanization&zipcode=97701
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - Microsoft-IIS/7.5
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Headers:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Thu, 26 Dec 2013 19:27:46 GMT
+      Content-Length:
+      - '908'
+    body:
+      encoding: US-ASCII
+      string: ! '[{"input_index":0,"candidate_index":0,"delivery_line_1":"550 NW Franklin
+        Ave Ste 200","last_line":"Bend OR 97701-2892","delivery_point_barcode":"977012892500","components":{"primary_number":"550","street_predirection":"NW","street_name":"Franklin","street_suffix":"Ave","secondary_number":"200","secondary_designator":"Ste","city_name":"Bend","state_abbreviation":"OR","zipcode":"97701","plus4_code":"2892","delivery_point":"50","delivery_point_check_digit":"0"},"metadata":{"record_type":"H","zip_type":"Standard","county_fips":"41017","county_name":"Deschutes","carrier_route":"C004","congressional_district":"02","rdi":"Commercial","elot_sequence":"0241","elot_sort":"A","latitude":44.05722,"longitude":-121.31347,"precision":"Zip9","time_zone":"Pacific","utc_offset":-8.0,"dst":true},"analysis":{"dpv_match_code":"Y","dpv_footnotes":"AABB","dpv_cmra":"N","dpv_vacant":"N","active":"Y","footnotes":"N#"}}]'
+    http_version: 
+  recorded_at: Thu, 26 Dec 2013 19:28:01 GMT
+- request:
+    method: get
+    uri: https://api.smartystreets.com/street-address?addressee&auth-id=mhv7Wy1BLAptSU4eSucbxZYiz2DtdBioQe%2Bq%2BOaFGViRRxx3OFlR5Cc1wShTaS5Yx3cLFF88MsGfKpc2A099yg==&auth-token=mhv7Wy1BLAptSU4eSucbxZYiz2DtdBioQe%2Bq%2BOaFGViRRxx3OFlR5Cc1wShTaS5Yx3cLFF88MsGfKpc2A099yg==&callback&candidates&city=Bend&lastline&secondary&state=OR&street=550%20NW%20Franklin%20Avenue&street2=Suite%20200&urbanization&zipcode=97701
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 401
+      message: Not authenticated.
+    headers:
+      Server:
+      - Microsoft-IIS/7.5
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Thu, 26 Dec 2013 20:13:31 GMT
+      Content-Length:
+      - '0'
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Thu, 26 Dec 2013 20:13:52 GMT
+- request:
+    method: get
+    uri: https://api.smartystreets.com/street-address?addressee&auth-id=00b81f59-bf87-42a6-ac65-5ea8556cac81&auth-token=mhv7Wy1BLAptSU4eSucbxZYiz2DtdBioQe%2Bq%2BOaFGViRRxx3OFlR5Cc1wShTaS5Yx3cLFF88MsGfKpc2A099yg==&callback&candidates&city=Bend&lastline&secondary&state=OR&street=550%20NW%20Franklin%20Avenue&street2=Ste%20200&urbanization&zipcode=97701
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - Microsoft-IIS/7.5
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Headers:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Thu, 26 Dec 2013 20:33:52 GMT
+      Content-Length:
+      - '908'
+    body:
+      encoding: US-ASCII
+      string: ! '[{"input_index":0,"candidate_index":0,"delivery_line_1":"550 NW Franklin
+        Ave Ste 200","last_line":"Bend OR 97701-2892","delivery_point_barcode":"977012892500","components":{"primary_number":"550","street_predirection":"NW","street_name":"Franklin","street_suffix":"Ave","secondary_number":"200","secondary_designator":"Ste","city_name":"Bend","state_abbreviation":"OR","zipcode":"97701","plus4_code":"2892","delivery_point":"50","delivery_point_check_digit":"0"},"metadata":{"record_type":"H","zip_type":"Standard","county_fips":"41017","county_name":"Deschutes","carrier_route":"C004","congressional_district":"02","rdi":"Commercial","elot_sequence":"0241","elot_sort":"A","latitude":44.05722,"longitude":-121.31347,"precision":"Zip9","time_zone":"Pacific","utc_offset":-8.0,"dst":true},"analysis":{"dpv_match_code":"Y","dpv_footnotes":"AABB","dpv_cmra":"N","dpv_vacant":"N","active":"Y","footnotes":"N#"}}]'
+    http_version: 
+  recorded_at: Thu, 26 Dec 2013 20:34:22 GMT
+- request:
+    method: get
+    uri: https://api.smartystreets.com/street-address?addressee&auth-id=00b81f59-bf87-42a6-ac65-5ea8556cac81&auth-token=mhv7Wy1BLAptSU4eSucbxZYiz2DtdBioQe%2Bq%2BOaFGViRRxx3OFlR5Cc1wShTaS5Yx3cLFF88MsGfKpc2A099yg==&callback&candidates&city=bend&lastline&secondary&state=oregon&street=550%20NW%20Franklin%20Avenue&street2=Suite%20200&urbanization&zipcode=97701
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - Microsoft-IIS/7.5
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Headers:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Sat, 28 Dec 2013 00:05:45 GMT
+      Content-Length:
+      - '908'
+      Connection:
+      - Keep-alive
+      Keep-Alive:
+      - timeout=15, max=100
+      Via:
+      - 1.1 ID-0002262046133470 uproxy-6
+    body:
+      encoding: US-ASCII
+      string: ! '[{"input_index":0,"candidate_index":0,"delivery_line_1":"550 NW Franklin
+        Ave Ste 200","last_line":"Bend OR 97701-2892","delivery_point_barcode":"977012892500","components":{"primary_number":"550","street_predirection":"NW","street_name":"Franklin","street_suffix":"Ave","secondary_number":"200","secondary_designator":"Ste","city_name":"Bend","state_abbreviation":"OR","zipcode":"97701","plus4_code":"2892","delivery_point":"50","delivery_point_check_digit":"0"},"metadata":{"record_type":"H","zip_type":"Standard","county_fips":"41017","county_name":"Deschutes","carrier_route":"C004","congressional_district":"02","rdi":"Commercial","elot_sequence":"0241","elot_sort":"A","latitude":44.05722,"longitude":-121.31347,"precision":"Zip9","time_zone":"Pacific","utc_offset":-8.0,"dst":true},"analysis":{"dpv_match_code":"Y","dpv_footnotes":"AABB","dpv_cmra":"N","dpv_vacant":"N","active":"Y","footnotes":"N#"}}]'
+    http_version: 
+  recorded_at: Sat, 28 Dec 2013 00:05:46 GMT
+recorded_with: VCR 2.5.0

data/test/cassettes/invalid_address.yml

@@ -0,0 +1,174 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.smartystreets.com/street-address?addressee&auth-id=00b81f59-bf87-42a6-ac65-5ea8556cac81&auth-token=mhv7Wy1BLAptSU4eSucbxZYiz2DtdBioQe%2Bq%2BOaFGViRRxx3OFlR5Cc1wShTaS5Yx3cLFF88MsGfKpc2A099yg==&callback&candidates&city=Bend&lastline&secondary&state=OR&street=1234%20not%20real%20street&street2=Suite%20200&urbanization&zipcode=97701
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - Microsoft-IIS/7.5
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Headers:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Thu, 26 Dec 2013 19:31:59 GMT
+      Content-Length:
+      - '2'
+    body:
+      encoding: US-ASCII
+      string: ! '[]'
+    http_version: 
+  recorded_at: Thu, 26 Dec 2013 19:32:14 GMT
+- request:
+    method: get
+    uri: https://api.smartystreets.com/street-address?addressee&auth-id=mhv7Wy1BLAptSU4eSucbxZYiz2DtdBioQe%2Bq%2BOaFGViRRxx3OFlR5Cc1wShTaS5Yx3cLFF88MsGfKpc2A099yg==&auth-token=mhv7Wy1BLAptSU4eSucbxZYiz2DtdBioQe%2Bq%2BOaFGViRRxx3OFlR5Cc1wShTaS5Yx3cLFF88MsGfKpc2A099yg==&callback&candidates&city=Bend&lastline&secondary&state=OR&street=1234%20not%20real%20street&street2=Suite%20200&urbanization&zipcode=97701
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 401
+      message: Not authenticated.
+    headers:
+      Server:
+      - Microsoft-IIS/7.5
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Thu, 26 Dec 2013 20:13:36 GMT
+      Content-Length:
+      - '0'
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Thu, 26 Dec 2013 20:13:52 GMT
+- request:
+    method: get
+    uri: https://api.smartystreets.com/street-address?addressee&auth-id=00b81f59-bf87-42a6-ac65-5ea8556cac81&auth-token=mhv7Wy1BLAptSU4eSucbxZYiz2DtdBioQe%2Bq%2BOaFGViRRxx3OFlR5Cc1wShTaS5Yx3cLFF88MsGfKpc2A099yg==&callback&candidates&city=Bend&lastline&secondary&state=OR&street=1234%20not%20real%20street&street2=Ste%20200&urbanization&zipcode=97701
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - Microsoft-IIS/7.5
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Headers:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Thu, 26 Dec 2013 20:33:52 GMT
+      Content-Length:
+      - '2'
+    body:
+      encoding: US-ASCII
+      string: ! '[]'
+    http_version: 
+  recorded_at: Thu, 26 Dec 2013 20:34:21 GMT
+- request:
+    method: get
+    uri: https://api.smartystreets.com/street-address?addressee&auth-id=00b81f59-bf87-42a6-ac65-5ea8556cac81&auth-token=mhv7Wy1BLAptSU4eSucbxZYiz2DtdBioQe%2Bq%2BOaFGViRRxx3OFlR5Cc1wShTaS5Yx3cLFF88MsGfKpc2A099yg==&callback&candidates&city=Bend&lastline&secondary&state=OR&street=1234%20not%20real%20street&street2=Suite%20200&urbanization&zipcode=9999999
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - Microsoft-IIS/7.5
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Headers:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Fri, 27 Dec 2013 19:57:54 GMT
+      Content-Length:
+      - '2'
+    body:
+      encoding: US-ASCII
+      string: ! '[]'
+    http_version: 
+  recorded_at: Fri, 27 Dec 2013 19:58:11 GMT
+- request:
+    method: get
+    uri: https://api.smartystreets.com/street-address?addressee&auth-id=00b81f59-bf87-42a6-ac65-5ea8556cac81&auth-token=mhv7Wy1BLAptSU4eSucbxZYiz2DtdBioQe%2Bq%2BOaFGViRRxx3OFlR5Cc1wShTaS5Yx3cLFF88MsGfKpc2A099yg==&callback&candidates&city=bend&lastline&secondary&state=oregon&street=1234%20not%20real%20street&street2=Suite%20200&urbanization&zipcode=9999999
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - Microsoft-IIS/7.5
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Headers:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Sat, 28 Dec 2013 00:05:41 GMT
+      Content-Length:
+      - '2'
+      Connection:
+      - Keep-alive
+      Keep-Alive:
+      - timeout=15, max=100
+      Via:
+      - 1.1 ID-0002262046133470 uproxy-5
+    body:
+      encoding: US-ASCII
+      string: ! '[]'
+    http_version: 
+  recorded_at: Sat, 28 Dec 2013 00:05:46 GMT
+recorded_with: VCR 2.5.0

data/test/lib/live_address/test_live_address.rb

@@ -0,0 +1,139 @@
+require_relative '../../test_helper'
+require "ostruct"
+
+describe LiveAddress do
+
+  subject { LiveAddress }
+
+  before do
+    subject.configure do |config|
+      # These credentials are no longer valid, they were deleted after the VCR cassettes were recorded
+      config.auth_id    = "00b81f59-bf87-42a6-ac65-5ea8556cac81"
+      config.auth_token = "mhv7Wy1BLAptSU4eSucbxZYiz2DtdBioQe+q+OaFGViRRxx3OFlR5Cc1wShTaS5Yx3cLFF88MsGfKpc2A099yg=="
+    end
+  end
+
+  describe "config" do
+
+    it "has an auth id" do
+      subject.must_respond_to(:auth_id)
+    end
+
+    it "has an auth token" do
+      subject.must_respond_to(:auth_token)
+    end
+
+    it "has an api endpoint" do
+      subject.must_respond_to(:api_endpoint)
+    end
+  end
+
+  describe "verify" do
+
+    describe "exceptions" do
+
+      it "auth_id is not present" do
+        subject.configure { |config| config.auth_id = nil }
+        proc {
+          subject.verify(:foo => "bar")
+        }.must_raise(LiveAddress::InvalidConfigError)
+      end
+
+      it "auth_token is not present" do
+        subject.configure { |config| config.auth_token = nil }
+        proc {
+          subject.verify(:foo => "bar")
+        }.must_raise(LiveAddress::InvalidConfigError)
+      end
+
+      it "invalid options are passed" do
+        proc {
+          subject.verify(:foo => "bar")
+        }.must_raise(LiveAddress::InvalidArgumentError)
+      end
+
+      it "no options are passed" do
+        proc {
+          subject.verify
+        }.must_raise(LiveAddress::InvalidArgumentError)
+      end
+
+      describe "response codes" do
+        it "status 400" do
+          HTTParty.stubs(:get).returns(OpenStruct.new(:code => 400))
+          proc {
+            subject.verify(:candidates => 1)
+          }.must_raise(LiveAddress::BadInputError)
+        end
+
+        it "status 401" do
+          HTTParty.stubs(:get).returns(OpenStruct.new(:code => 401))
+          proc {
+            subject.verify(:candidates => 1)
+          }.must_raise(LiveAddress::AuthorizationError)
+        end
+
+        it "status 402" do
+          HTTParty.stubs(:get).returns(OpenStruct.new(:code => 402))
+          proc {
+            subject.verify(:candidates => 1)
+          }.must_raise(LiveAddress::PaymentRequiredError)
+        end
+
+        it "status 500" do
+          HTTParty.stubs(:get).returns(OpenStruct.new(:code => 500))
+          proc {
+            subject.verify(:candidates => 1)
+          }.must_raise(LiveAddress::InternalServerError)
+        end
+      end
+    end
+
+    describe "requests" do
+      let(:options) {
+        {
+          :city    => "bend",
+          :state   => "oregon",
+          :zipcode => "97701",
+          :street  => "550 NW Franklin Avenue",
+          :street2 => "Suite 200"
+        }
+      }
+
+      after do
+        VCR.eject_cassette
+      end
+
+      describe "invalid address" do
+        before do
+          VCR.insert_cassette 'invalid_address', :record => :new_episodes
+        end
+
+        it "returns an empty array when the address has no results" do
+          options.merge!(:street => "1234 not real street", :zipcode => "9999999")
+          subject.verify(options).must_equal []
+        end
+      end
+
+      describe "valid addresss" do
+        let (:results) { subject.verify(options) }
+
+        before do
+          VCR.insert_cassette 'address', :record => :new_episodes
+        end
+
+        it "returns an array of results" do
+          results.must_be_instance_of(Array)
+        end
+
+        it "returns objects with a formatted address" do
+          result = results.first
+          result.delivery_line_1.must_equal("550 NW Franklin Ave Ste 200")
+          result.last_line.must_equal("Bend OR 97701-2892")
+        end
+
+      end
+    end
+  end
+
+end

data/test/lib/live_address/test_version.rb

@@ -0,0 +1,9 @@
+require_relative '../../test_helper'
+
+describe LiveAddress do
+
+  it "must be defined" do
+    LiveAddress::VERSION.wont_be_nil
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require "mocha/setup"
+require 'webmock/minitest'
+require 'vcr'
+require File.expand_path('../../lib/live_address.rb', __FILE__)
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/cassettes'
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: live_address
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Chris Stringer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: Ruby wrapper for the SmartyStreets LiveAddress API
+email:
+- chris.stringer@g5searchmarketing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/live_address.rb
+- lib/live_address/address.rb
+- lib/live_address/configuration.rb
+- lib/live_address/exceptions.rb
+- lib/live_address/response_parser.rb
+- lib/live_address/url_builder.rb
+- lib/live_address/version.rb
+- live_address.gemspec
+- test/cassettes/address.yml
+- test/cassettes/invalid_address.yml
+- test/lib/live_address/test_live_address.rb
+- test/lib/live_address/test_version.rb
+- test/test_helper.rb
+homepage: https://github.com/jcstringer/live_address
+licenses:
+- MIT
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Creates requests and parses responses to/from the SmartyStreets LiveAddress
+  API using Ruby.
+test_files:
+- test/cassettes/address.yml
+- test/cassettes/invalid_address.yml
+- test/lib/live_address/test_live_address.rb
+- test/lib/live_address/test_version.rb
+- test/test_helper.rb