address_validate 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 934d4c95f0c0ff0a57eb87e4423c1d704454f4de
+  data.tar.gz: 475de09953d7c2f267aa8a1acc0f695844d3b0ed
+SHA512:
+  metadata.gz: 1b6be3b23a2f87bcd02651216615d33bdc0771bb387b3f93aad72791b207f184240add006883f7286a79d7fc8a6945c5ea6c4cdd6326f1696d1dac60a19d97fd
+  data.tar.gz: 80c7fb6ca1c94dadb4982cd1cf429fc0bbb3752cdf5f0de4c4f87e5f7e422360de19550cbfc606097ed9392ab9ad8712cace61cbf1e08840788387b610dc41ee

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+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 marybethlee11@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 address_validate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 marybethlee
+
+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,85 @@
+# AddressValidate
+
+A ruby gem for integrating with the USPS address validation API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'address_validate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install address_validate
+
+## Configuration
+
+The USPS address validation api requires a valid username. It will need to be set in order for calls to be made:
+
+```ruby
+# config/initializers/address_validate.rb
+AddressValidate.configure do |config|
+  config.environment = :test # or :production
+  config.username    = 'MY_USPS_USERNAME'
+end
+```
+
+## Usage
+
+```ruby
+address_data = { street_address: '34 Berry', zip_5: '11249' }
+
+response = AddressValidate::API.validate_address(address_data)
+
+response.success? # => true
+
+response.data # => { street_address: '34 BERRY ST', city: 'BROOKLYN', state: 'NY', zip_5: '11249' }
+
+response.error # => nil
+
+response.message # => 'Default address: The address you entered was found but more information is needed...'
+```
+
+If you want to override the default fields for address data, you can do that during configuration
+
+```ruby
+# config/initializers/address_validate.rb
+AddressValidate.configure do |config|
+  config.environment      = :test # or :production
+  config.username         = 'MY_USPS_USERNAME'
+  config.street_address   = :address_1
+  config.apartment_number = :address_2
+  config.zip_5            = :postal_code
+end
+```
+
+You can then send your address data with your field names to the API, and will receive matching data back.
+
+```ruby
+address_data = { address_1: '34 Berry', postal_code: '11249' }
+
+response = AddressValidate::API.validate_address(address_data)
+
+response.data # => { address_1: '34 BERRY ST', city: 'BROOKLYN', state: 'NY', postal_code: '11249' }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 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/marybethlee/address_validate.
+
+## 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/address_validate.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'address_validate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "address_validate"
+  spec.version       = AddressValidate::VERSION
+  spec.authors       = ["Mary Lee"]
+  spec.email         = ["marybethlee11@gmail.com"]
+
+  spec.summary       = %q{USPS address validation api integration}
+  spec.description   = %q{AddressValidate is a ruby wrapper for integrating with the USPS address validation api.}
+  spec.homepage      = "https://github.com/marybethlee/address_validate"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency "ox", "~> 2.4.1"
+
+  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 "pry"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "address_validate"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/address_validate.rb

@@ -0,0 +1,23 @@
+require 'address_validate/version'
+require 'address_validate/configuration'
+require 'address_validate/api'
+require 'address_validate/api/request'
+require 'address_validate/api/response'
+require 'address_validate/api/error'
+require 'ox'
+
+module AddressValidate
+  extend Configuration
+
+  def self.address_fields_map
+    {
+      'FirmName' => AddressValidate.firm_name,
+      'Address1' => AddressValidate.apartment_number,
+      'Address2' => AddressValidate.street_address,
+      'City'     => AddressValidate.city,
+      'State'    => AddressValidate.state,
+      'Zip5'     => AddressValidate.zip_5,
+      'Zip4'     => AddressValidate.zip_4
+    }
+  end
+end

data/lib/address_validate/api.rb

@@ -0,0 +1,13 @@
+require 'net/http'
+require 'uri'
+
+module AddressValidate
+  module API
+    def self.validate_address(data)
+      response = Net::HTTP.post_form(URI(AddressValidate.verify_url),
+        { API: 'Verify',
+          XML: Request.build_xml(data) })
+      Response.new(response.body)
+    end
+  end
+end

data/lib/address_validate/api/error.rb

@@ -0,0 +1,23 @@
+module AddressValidate
+  module API
+    class Error
+      attr_reader :error
+
+      def initialize(error)
+        @error = error
+      end
+
+      def message
+        error.Description.text
+      end
+
+      def code
+        error.Number.text
+      end
+
+      def source
+        error.Source.text
+      end
+    end
+  end
+end

data/lib/address_validate/api/request.rb

@@ -0,0 +1,37 @@
+module AddressValidate
+  module API
+    class Request
+      attr_reader :data
+
+      def self.build_xml(data)
+        new(data).build_xml
+      end
+
+      def initialize(data)
+        @data = data
+      end
+
+      def build_xml
+        request_xml = build_node('AddressValidateRequest', nil,
+                        { 'USERID' => AddressValidate.username })
+        request_xml << build_address
+        Ox.dump(request_xml)
+      end
+
+      def build_node(name, text, attrs={})
+        node = Ox::Element.new(name)
+        attrs.each { |key, value| node[key] = value }
+        node << text if text
+        node
+      end
+
+      def build_address
+        address = build_node('Address', nil, { 'ID' => 0 })
+        AddressValidate.address_fields_map.each do |field, name|
+          address << build_node(field, data[name])
+        end
+        address
+      end
+    end
+  end
+end

data/lib/address_validate/api/response.rb

@@ -0,0 +1,50 @@
+module AddressValidate
+  module API
+    class Response
+      attr_reader :response_body
+
+      def initialize(response_body)
+        @response_body = Ox.parse(response_body)
+      end
+
+      def success?
+        errors.nil?
+      end
+
+      def error
+        AddressValidate::API::Error.new(errors) if errors
+      end
+
+      def data
+        @data ||= errors ? {} : parse_data
+      end
+
+      def warning
+        get_field('ReturnText')
+      end
+
+    private
+
+      def errors
+        @errors ||= address_data.locate('Error').first
+      end
+
+      def address_data
+        @address_data ||= response_body.AddressValidateResponse.Address
+      end
+
+      def parse_data
+        {}.tap do |data|
+          AddressValidate.address_fields_map.each do |field, name|
+            data[name] = get_field(field)
+          end
+        end
+      end
+
+      def get_field(field_name)
+        field = address_data.locate(field_name).first
+        field.text if field
+      end
+    end
+  end
+end

data/lib/address_validate/configuration.rb

@@ -0,0 +1,35 @@
+module AddressValidate
+  module Configuration
+    API_URLS = {
+      test: 'http://production.shippingapis.com/ShippingAPITest.dll',
+      production: 'http://production.shippingapis.com/ShippingAPI.dll'
+    }
+
+    attr_accessor :environment, :username, :password,
+      :firm_name, :street_address, :apartment_number,
+      :city, :state, :zip_5, :zip_4
+
+    def configure
+      yield self
+    end
+
+    def self.extended(base)
+      base.set_default_configuration
+    end
+
+    def verify_url
+      API_URLS[environment]
+    end
+
+    def set_default_configuration
+      self.environment      = :production
+      self.firm_name        = :firm_name
+      self.street_address   = :street_address
+      self.apartment_number = :apartment_number
+      self.city             = :city
+      self.state            = :state
+      self.zip_5            = :zip_5
+      self.zip_4            = :zip_4
+    end
+  end
+end

data/lib/address_validate/version.rb

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

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: address_validate
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mary Lee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+- !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: pry
+  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: AddressValidate is a ruby wrapper for integrating with the USPS address
+  validation api.
+email:
+- marybethlee11@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- address_validate.gemspec
+- bin/console
+- bin/setup
+- lib/address_validate.rb
+- lib/address_validate/api.rb
+- lib/address_validate/api/error.rb
+- lib/address_validate/api/request.rb
+- lib/address_validate/api/response.rb
+- lib/address_validate/configuration.rb
+- lib/address_validate/version.rb
+homepage: https://github.com/marybethlee/address_validate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: USPS address validation api integration
+test_files: []