smartystreets_api 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTk5YTNiMGExYzA2NDNkYjU0MzlmMjJjNjdhZmE2YzYyYWM3MDQ1Yg==
+  data.tar.gz: !binary |-
+    NmQ4N2EwN2Y2OWRkMmFmZjA1NjYxYmZlYWI0NmEzNDJjMDMxNGMzOA==
+SHA512:
+  metadata.gz: !binary |-
+    OThkOTNiZGI5OTRmNWM5MGNjOGVjNTE3YzNlZDJkNmFkNzE3NjQzZGZkYTcz
+    YzE1YzI5OTJjNzNkYzEwNjE5NWUyNTllODZmZDE1YTM2OTMxYWI1ZWZhY2Y4
+    YjM3NDhjZTIzMGVhMmViOTllZjAyM2IyY2QyYmY2MDk5NzNjN2Q=
+  data.tar.gz: !binary |-
+    ZTBiMGE1ODAxZWVkYjI0ZGYwN2ZhYzJhYTFkMjkwYTljZDI4YWIxMWZkMmYy
+    NGNlMjI2OWVmMDFjZmM3NTJhZGE1Y2IxOTRiNDgyMzE5OTExZGZkN2I5NDAz
+    ZjRmZDg1YmZiNWIxMTAyOWUxOTY2ZDgwMGNhMzkwYWUyZWUyNmM=

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/credentials.yml

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at lorrain.florian@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 florrain
+
+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,128 @@
+# SmartyStreetsApi [![Build Status](https://travis-ci.org/florrain/smartystreets_api.svg?branch=master)](https://travis-ci.org/florrain/smartystreets_api)
+
+Ruby client for smartystreets.com APIs. So far only the single US street address API has been implemented.
+
+PRs are welcome!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smartystreets_api'
+```
+
+Or install it yourself as:
+
+    $ gem install smartystreets_api
+
+## Usage
+Configure the GEM first:
+```ruby
+# config/initializers/smartystreets_api.rb
+SmartyStreetsApi.configure do |config|
+	config.auth_id = "AUTH-ID"
+	config.auth_token = "AUTH-TOKEN"
+end
+```
+
+Then try to validate an address:
+```ruby
+address_args = {
+  street: "114 Sansome Street",
+  secondary: "Floor 5",
+  city: "San Francisco",
+  state: "CA",
+  zipcode: "94104"
+}
+
+response = SmartyStreetsApi::UsStreetAddress.get_single(address_args)
+
+#response
+[
+  {
+    lines: {
+      delivery_line_1: "114 Sansome St Fl 5",
+      last_line: "San Francisco CA 94104-3812"
+    },
+    indexes: {
+      input_index: 0,
+      candidate_index: 0,
+      delivery_point_barcode: "941043812053"
+    },
+    components: {
+      primary_number: "114",
+      street_name: "Sansome",
+      street_suffix: "St",
+      secondary_number: "5",
+      secondary_designator: "Fl",
+      city_name: "San Francisco",
+      state_abbreviation: "CA",
+      zipcode: "94104",
+      plus4_code: "3812",
+      delivery_point: "05",
+      delivery_point_check_digit: "3"
+    },
+    metadata: {
+      record_type: "H",
+      zip_type: "Standard",
+      county_fips: "06075",
+      county_name: "San Francisco",
+      carrier_route: "C015",
+      congressional_district: "12",
+      rdi: "Commercial",
+      elot_sequence: "0163",
+      elot_sort: "A",
+      latitude: 37.79133,
+      longitude: -122.40068,
+      precision: "Zip9",
+      time_zone: "Pacific",
+      utc_offset: -8,
+      dst: true
+    },
+    analysis: {
+      dpv_match_code: "Y",
+      dpv_footnotes: "AABB",
+      dpv_cmra: "N",
+      dpv_vacant: "N",
+      active: "N",
+      footnotes: "N#"
+    }
+}]
+```
+
+A decorator can reformat the address based on the components. Please make sure the format fits your need!!
+
+```ruby
+response = SmartyStreetsApi::UsStreetAddress.get_single(office)
+
+decorated_address = SmartyStreetsApi::Decorators::UsFormat.new.call(response.first)
+
+# decorated_address
+{
+  street: "114 Sansome St",
+  secondary: "Fl 5",
+  city: "San Francisco",
+  state: "CA",
+  zipcode: "94104",
+  plus4_code: "3812"
+}
+```
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then copy/paste `spec/credentials.sample.yml` to `spec/credentials.yml` and set your own credentials.
+VCR is intended to hide them so no worries, as long as you don't commit hard-coded credentials in the code they won't be pushed in cassettes + you won't have to pay for the already passed tests.
+
+Run `rake spec` to run the tests.
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/florrain/smartystreets_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/smartystreets_api/decorators/us_format.rb

@@ -0,0 +1,58 @@
+class SmartyStreetsApi::Decorators::UsFormat
+  def call(address_object)
+    return if !address_object || !address_object[:components]
+
+    self.class.private_instance_methods(false).inject({}) do |decorated_address, attribute|
+      components = self.send(attribute.to_sym)
+
+      array_values = components.map do |component_name|
+        if address_object[:components] && address_object[:components][component_name]
+          address_object[:components][component_name]
+        else
+          nil
+        end
+      end.compact
+
+      decorated_address[attribute] = array_values.empty? ? nil : array_values.join(" ")
+
+      decorated_address
+    end
+  end
+
+  private
+
+  def street
+    [
+      :primary_number,
+      :street_predirection,
+      :street_name,
+      :street_postdirection,
+      :street_suffix
+    ]
+  end
+
+  def secondary
+    [
+      :secondary_designator,
+      :secondary_number,
+      :extra_secondary_designator,
+      :extra_secondary_number
+    ]
+  end
+
+  def city
+    [:city_name]
+  end
+
+  def state
+    [:state_abbreviation]
+  end
+
+  def zipcode
+    [:zipcode]
+  end
+
+  def plus4_code
+    [:plus4_code]
+  end
+end

data/lib/smartystreets_api/monkey_patches.rb

@@ -0,0 +1,16 @@
+module SmartyStreetsApi
+  module MonkeyPatches
+    module Hash
+
+      def symbolize_keys!
+        keys.each do |key|
+          self[key.to_sym] = delete(key)
+        end
+        self
+      end unless method_defined?(:symbolize_keys!)
+
+    end
+  end
+end
+
+Hash.send(:include, SmartyStreetsApi::MonkeyPatches::Hash)

data/lib/smartystreets_api/us_street_address.rb

@@ -0,0 +1,77 @@
+class SmartyStreetsApi::UsStreetAddress
+  AUTH_ARGS = %w(auth-id auth-token)
+  INPUTS = %w(street street2 secondary city state zipcode lastline addressee urbanization candidates)
+  OUTPUT_ADDRESS_LINES = %w(addressee delivery_line_1 delivery_line_2 last_line)
+  OUTPUT_ADDRESS_INDEXES = %w(input_id input_index candidate_index delivery_point_barcode)
+
+  def self.get_single(options)
+    uri = URI("#{host}/street-address")
+
+    args = options.select { |name, value| INPUTS.include?(name.to_s) && (value && !value.empty?) }.merge!(auth_args)
+
+    uri.query = URI.encode_www_form(args)
+
+    response = Net::HTTP.get_response(uri)
+
+    parse(response)
+  end
+
+  private
+
+  def self.parse(response)
+    parsed_response = JSON.parse(response.body)
+
+    raise_error!(parsed_response) if severe_error?(response.code)
+
+    parse_response(parsed_response)
+  end
+
+  def self.parse_response(response)
+    response.map do |address|
+      {
+        lines: address_lines(address).symbolize_keys!,
+        indexes: address_indexes(address).symbolize_keys!,
+        components: address["components"].symbolize_keys!,
+        metadata: address["metadata"].symbolize_keys!,
+        analysis: address["analysis"].symbolize_keys!
+      }
+    end
+  end
+
+  def self.address_lines(address)
+    address.select { |field| OUTPUT_ADDRESS_LINES.include?(field) }.symbolize_keys!
+  end
+
+  def self.address_indexes(address)
+    address.select { |field| OUTPUT_ADDRESS_INDEXES.include?(field) }.symbolize_keys!
+  end
+
+  def self.severe_error?(response_status_code)
+    response_status_code.to_i != 200
+  end
+
+  def self.raise_error!(response_status_code)
+    case response_status_code
+    when 401
+      raise "SmartyStreets - Unauthorized"
+    when 402
+      raise "SmartyStreets - Payment Required"
+    when 413
+      raise "SmartyStreets - Request Entity Too Large"
+    when 400
+      raise "SmartyStreets - Bad Request (Malformed Payload)"
+    when 429
+      raise "SmartyStreets - Too Many Requests"
+    else
+      raise "SmartyStreets - Unknown error"
+    end
+  end
+
+  def self.host
+    SmartyStreetsApi.configuration.base_url
+  end
+
+  def self.auth_args
+    SmartyStreetsApi.configuration.auth_args
+  end
+end

data/lib/smartystreets_api/version.rb

@@ -0,0 +1,3 @@
+module SmartyStreetsApi
+  VERSION = "0.1.0"
+end

data/lib/smartystreets_api.rb

@@ -0,0 +1,41 @@
+require "smartystreets_api/version"
+
+module SmartyStreetsApi
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configuration
+    unless @config
+      configure
+    end
+
+    @config
+  end
+
+  def self.configure
+    self.config ||= Configuration.new
+    yield(config)
+  end
+
+  class Configuration
+    attr_accessor :auth_id, :auth_token, :base_url
+
+    def initialize
+      @auth_id = "AUTH-ID"
+      @auth_token = "AUTH-TOKEN"
+      @base_url = "https://api.smartystreets.com"
+    end
+
+    def auth_args
+      { "auth-id" => @auth_id, "auth-token" => @auth_token }
+    end
+  end
+
+  module Decorators
+  end
+end
+
+require "smartystreets_api/monkey_patches"
+require "smartystreets_api/decorators/us_format"
+require "smartystreets_api/us_street_address"

data/smartystreets_api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smartystreets_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smartystreets_api"
+  spec.version       = SmartyStreetsApi::VERSION
+  spec.authors       = ["florrain"]
+  spec.email         = ["lorrain.florian@gmail.com"]
+
+  spec.summary       = "Ruby API client for SmartyStreets"
+  spec.description   = "A simple and dependency free API GEM for https://smartystreets.com/, the address verification API."
+  spec.homepage      = "https://github.com/florrain/smartystreets_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 3.0.3"
+  spec.add_development_dependency "webmock", "~> 1.21.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: smartystreets_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- florrain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+description: A simple and dependency free API GEM for https://smartystreets.com/,
+  the address verification API.
+email:
+- lorrain.florian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smartystreets_api.rb
+- lib/smartystreets_api/decorators/us_format.rb
+- lib/smartystreets_api/monkey_patches.rb
+- lib/smartystreets_api/us_street_address.rb
+- lib/smartystreets_api/version.rb
+- smartystreets_api.gemspec
+homepage: https://github.com/florrain/smartystreets_api
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby API client for SmartyStreets
+test_files: []