mainstreet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8bd7d3041d913f03949353a816c98876686219a
+  data.tar.gz: 482de1d807c5500f1df314de5bef2ac073a97057
+SHA512:
+  metadata.gz: b883a7d67ba49e589243728e6b310cc52541377deafa5a62c2caeba3889a1ed76ae8c1c1efa37d043a47f874401109ff39151ce03971b78fabc30f5e3ece351d
+  data.tar.gz: f5071479677b0dc600347bba39a19b3c1eab1fb9505e84b5064728ae7ca541571263982665da290f008d679aac6cd1bdff7812499f3d61c602e3e83fa70b7413

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andrew Kane
+
+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,86 @@
+# MainStreet
+
+A standard US address model for Rails
+
+You get:
+
+- geocoding
+- standardization
+- verification
+
+## How It Works
+
+[todo]
+
+### Verification
+
+MainStreet performs ZIP code verification by default.
+
+```ruby
+address = Address.new(street: "400 bryant st", zip_code: "94108")
+address.valid?
+# false
+address.errors.full_messages
+# ["Did you mean 94107?"]
+```
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'mainstreet'
+```
+
+To create a new address model, run:
+
+```sh
+rails g mainstreet:address
+```
+
+This creates an `Address` model with:
+
+- street
+- street2
+- city
+- state
+- zip_code
+- latitude
+- longitude
+- verification_info
+- original_attributes
+
+To add to an existing model:
+
+1. Use `alias_attribute` to map existing field names
+2. Add new fields like `verification_info` and `original_attributes`
+3. Add `acts_as_address` to your model
+
+## Address Verification
+
+MainStreet does ZIP code verification by default.
+
+For complete address verification, sign up for a [SmartyStreets](https://smartystreets.com/features) account. The free plan supports 250 lookups per month.
+
+Set:
+
+```ruby
+ENV["SMARTY_STREETS_AUTH_ID"] = "auth-id"
+ENV["SMARTY_STREETS_AUTH_TOKEN"] = "auth-token"
+```
+
+To test it, run:
+
+```ruby
+address = Address.new(street: "122 Mast Rd", zip_code: "03861")
+address.valid? # should get false
+```
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/mainstreet/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/mainstreet/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: :test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/lib/generators/mainstreet/address_generator.rb

@@ -0,0 +1,10 @@
+require "rails/generators"
+
+module Mainstreet
+  class AddressGenerator < Rails::Generators::Base
+    def boom
+      invoke "model", ["Address", "street:string", "street2:string", "city:string", "state:string", "zip_code:string", "latitude:decimal{15.10}", "longitude:decimal{15.10}", "verification_info:text", "original_attributes:text"], options
+      insert_into_file "app/models/address.rb", "  acts_as_address\n", after: "ActiveRecord::Base\n"
+    end
+  end
+end

data/lib/mainstreet/version.rb

@@ -0,0 +1,3 @@
+module Mainstreet
+  VERSION = "0.0.1"
+end

data/lib/mainstreet.rb

@@ -0,0 +1,85 @@
+require "mainstreet/version"
+require "geocoder"
+
+module Mainstreet
+  class << self
+    attr_writer :lookup
+
+    def lookup
+      @lookup ||= begin
+        if ENV["SMARTY_STREETS_AUTH_ID"] && ENV["SMARTY_STREETS_AUTH_TOKEN"]
+          Geocoder.config[:smarty_streets] ||= {api_key: [ENV["SMARTY_STREETS_AUTH_ID"], ENV["SMARTY_STREETS_AUTH_TOKEN"]]}
+        end
+        Geocoder.config[:smarty_streets] ? :smarty_streets : nil
+      end
+    end
+  end
+
+  module Model
+    def acts_as_address(_options = {})
+      class_eval do
+        serialize :original_attributes
+        serialize :verification_info
+
+        validate :verify_address, if: -> { address_fields_changed? }
+        before_save :standardize_address, if: -> { address_fields_changed? }
+
+        def verify_address
+          @verification_result = Geocoder.search("#{street} #{street2} #{city}, #{state} #{zip_code}", lookup: Mainstreet.lookup).first
+          if @verification_result
+            if @verification_result.respond_to?(:analysis)
+              case @verification_result.analysis["dpv_match_code"]
+              when "N"
+                errors.add(:base, "Address could not be confirmed")
+              when "S"
+                errors.add(:base, "Apartment or suite could not be confirmed")
+              when "D"
+                errors.add(:base, "Apartment or suite is missing")
+              end
+            end
+
+            correct_zip_code = @verification_result.postal_code
+            if zip_code != correct_zip_code
+              errors.add(:base, "Did you mean #{correct_zip_code}?")
+            end
+          else
+            errors.add(:base, "Address could not be confirmed")
+          end
+          errors.full_messages
+        end
+
+        def standardize_address
+          result = @verification_result
+          if result
+            info = result.data
+            self.original_attributes = attributes.slice(*address_fields)
+            self.verification_info = result.data.to_hash
+            self.street =
+              if result.respond_to?(:delivery_line_1)
+                result.delivery_line_1
+              else
+                result.formatted_address.split(",").first
+              end
+            self.street2 = nil
+            self.city = result.city
+            self.state = result.state_code
+            self.zip_code = result.postal_code
+            self.latitude = result.latitude
+            self.longitude = result.longitude
+          end
+          true
+        end
+
+        def address_fields_changed?
+          address_fields.any? { |f| send("#{f}_changed?") }
+        end
+
+        def address_fields
+          attributes.keys & %w(street street2 city state zip_code)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:extend, Mainstreet::Model) if defined?(ActiveRecord)

data/mainstreet.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mainstreet/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mainstreet"
+  spec.version       = Mainstreet::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+
+  spec.summary       = "A standard US address model for Rails"
+  spec.description   = "A standard US address model for Rails"
+  spec.homepage      = "https://github.com/ankane/mainstreet"
+  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.add_dependency "geocoder"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "smartystreets"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: mainstreet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: geocoder
+  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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: minitest
+  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: activerecord
+  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: sqlite3
+  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: smartystreets
+  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: 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'
+description: A standard US address model for Rails
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/mainstreet/address_generator.rb
+- lib/mainstreet.rb
+- lib/mainstreet/version.rb
+- mainstreet.gemspec
+homepage: https://github.com/ankane/mainstreet
+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.5
+signing_key: 
+specification_version: 4
+summary: A standard US address model for Rails
+test_files: []
+has_rdoc: