mainstreet 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc0cc69ef3e5d2a656626dc6dca4fc1c2742c302f643f819b84469ee3d3fb5f6
-  data.tar.gz: 8c7b9672fa0129541e76b0013ef3c0b3500d1797ffd1363f8739bfd274deec61
+  metadata.gz: d74ee9bd034da5023b1d16a19814f8e921ac542f2cff1b209e2fbdc662d2a1d7
+  data.tar.gz: 679a9cdfe1d892456372e9e422e0db93fa679fe7298c7a052a1e944a298792c3
 SHA512:
-  metadata.gz: 97261f746dd103d661b8d08d12c3cf9c903aa8e4ddf2b5ce6697e5ecd990ffe77d4557f828ee08ae56499c14b77bdea01cf5a489aa69abd9b1da3dc09debcd7d
-  data.tar.gz: 739008f795c5107cd1a8f41ebebba23a01d992534974294018bdec643f252316246d6f785693b3d31e94733f28a911437f7f55e980c62e3c0c213baf5560db4c
+  metadata.gz: d70178c18422b36a12febca14d16a1907052bd30923f64625491607c03fb82822de72c980d3e032ccfa3336eae0487f3526e2f0c071f86b073e7ecf2da92fb71
+  data.tar.gz: 25ba36dd066fc89578ddee0df29d29e70da4884f8eca1657acecec7608a418a40bb9ab34aa6538b2005d1848d7227ed8484994d70dfcc0c502dc3fbdfa66dee1

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.1
+
+- Added support for i18n
+- Added support for more validation options like `if` and `on`
+- Specified minimum Geocoder version
+
 ## 0.2.0
 
 - Added `AddressVerifier`

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2018 Andrew Kane
+Copyright (c) 2015-2019 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

data/README.md

@@ -4,6 +4,8 @@ Address verification for Ruby and Rails
 
 :earth_americas: Supports international addresses
 
+[![Build Status](https://travis-ci.org/ankane/mainstreet.svg?branch=master)](https://travis-ci.org/ankane/mainstreet)
+
 ## Installation
 
 Add this line to your application’s Gemfile:
@@ -60,7 +62,15 @@ class User < ApplicationRecord
 end
 ```
 
-For performance, the address is only verified if at least one of the fields changes. The order should be the same as if you were to write the address out.
+The order should be the same as if you were to write the address out.
+
+For performance, the address is only verified if at least one of the fields changes. Set your own condition with:
+
+```ruby
+class User < ApplicationRecord
+  validates_address if: -> { something_changed? }, ...
+end
+```
 
 Geocode the address with:
 
@@ -96,17 +106,11 @@ MainStreet::AddressVerifier.new(address, country: "France")
 
 Here’s the list of [supported countries](https://smartystreets.com/docs/cloud/international-street-api#countries). You can pass the name, ISO-3, ISO-2, or ISO-N code (like `France`, `FRA`, `FR`, or `250`).
 
-**Note:** You’ll also need to use a fork of Geocoder until [this PR](https://github.com/alexreisner/geocoder/pull/1367) is merged.
-
-```ruby
-gem 'geocoder', github: 'ankane/geocoder', branch: 'smarty_streets_international'
-```
-
 For Active Record, use:
 
 ```ruby
 class User < ApplicationRecord
-  validates_address country: "France"
+  validates_address country: "France", ...
 end
 ```
 
@@ -114,17 +118,31 @@ Or use a proc to make it dynamic
 
 ```ruby
 class User < ApplicationRecord
-  validates_address country: -> { country }
+  validates_address country: -> { country }, ...
 end
 ```
 
-## Data Privacy
+## Internationalization (i18n)
+
+You can customize error messages with the [i18n](https://github.com/ruby-i18n/i18n) gem. In Rails, add to the appropriate `config/locales` file:
+
+```yml
+en:
+  mainstreet:
+    errors:
+      messages:
+        unconfirmed: Address can't be confirmed
+        apt_unconfirmed: Apartment or suite can't be confirmed
+        apt_missing: Apartment or suite is missing
+```
+
+## Data Protection
 
-We recommend encrypting the street information for user addresses. Check out [this article](https://ankane.org/sensitive-data-rails) for more details.
+We recommend encrypting street information and postal code (at the very least) for user addresses. [Lockbox](https://github.com/ankane/lockbox) is great for this. Check out [this article](https://ankane.org/sensitive-data-rails) for more details.
 
 ```ruby
 class User < ApplicationRecord
-  attr_encrypted :street, key: ...
+  encrypts :street, :postal_code
 end
 ```
 

data/lib/mainstreet/address_verifier.rb

@@ -1,8 +1,9 @@
 module MainStreet
   class AddressVerifier
-    def initialize(address, country: nil)
+    def initialize(address, country: nil, locale: nil)
       @address = address
       @country = country
+      @locale = locale
     end
 
     def success?
@@ -11,7 +12,7 @@ module MainStreet
 
     def failure_message
       if !result
-        "Address can't be confirmed"
+        message :unconfirmed, "Address can't be confirmed"
       elsif result.respond_to?(:analysis)
         analysis = result.analysis
 
@@ -20,7 +21,7 @@ module MainStreet
           when "Verified"
             nil # success!!
           when "Ambiguous", "Partial", "None"
-            "Address can't be confirmed"
+            message :unconfirmed, "Address can't be confirmed"
           else
             raise "Unknown verification_status"
           end
@@ -29,11 +30,11 @@ module MainStreet
           when "Y"
             nil # success!!
           when "N"
-            "Address can't be confirmed"
+            message :unconfirmed, "Address can't be confirmed"
           when "S"
-            "Apartment or suite can't be confirmed"
+            message :apt_unconfirmed, "Apartment or suite can't be confirmed"
           when "D"
-            "Apartment or suite is missing"
+            message :apt_missing, "Apartment or suite is missing"
           else
             raise "Unknown dpv_match_code"
           end
@@ -66,5 +67,13 @@ module MainStreet
     def lookup
       ENV["SMARTY_STREETS_AUTH_ID"] ? :smarty_streets : nil
     end
+
+    def message(key, default)
+      if defined?(I18n)
+        I18n.t(key, scope: [:mainstreet, :errors, :messages], locale: @locale, default: default)
+      else
+        default
+      end
+    end
   end
 end

data/lib/mainstreet/model.rb

@@ -1,12 +1,13 @@
 module MainStreet
   module Model
-    def validates_address(fields:, geocode: false, country: nil)
+    def validates_address(fields:, geocode: false, country: nil, **options)
       fields = Array(fields.map(&:to_s))
       geocode_options = {latitude: :latitude, longitude: :longitude}
       geocode_options = geocode_options.merge(geocode) if geocode.is_a?(Hash)
+      options[:if] ||= -> { fields.any? { |f| changes.key?(f.to_s) } } unless options[:unless]
 
       class_eval do
-        validate :verify_address, if: -> { fields.any? { |f| changes.key?(f.to_s) } }
+        validate :verify_address, **options
 
         define_method :verify_address do
           address = fields.map { |v| send(v).presence }.compact.join(", ")

data/lib/mainstreet/version.rb

@@ -1,3 +1,3 @@
 module MainStreet
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mainstreet
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-01 00:00:00.000000000 Z
+date: 2019-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: geocoder
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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
@@ -154,8 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Address verification for Ruby and Rails