devise-multi_email 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d9dc3a93e09984b89cf88cb94b4bb158ca942dd
-  data.tar.gz: d298b22cd393f35811e02dcc011ec90874ed8e8e
+  metadata.gz: a2b9c44fd5e0d7e67068e283c110c3d5bcf2578d
+  data.tar.gz: 6c6101cc82b5f18131fb3a44383953424ad4c433
 SHA512:
-  metadata.gz: 5a052c760a050ab2cf8a10102a7d9817f098e5c212d9279fa0c7163497919b220e8d8b89d10da402e8ddbc83afb9e2a8efe99af57c20c7391f23c39c91383a4e
-  data.tar.gz: b8a2b9620fb3d23d38c0985f57f965abce55146522a0bd2d7198e250f3896b9abf89bfec6548661aaea139bddc96fef9ab247bf0348a2f59944ba8ec4ec6f3ac
+  metadata.gz: 77aae6065dcb2ce816df78945ea39addbb4c3550f80252ad5048ea81fbd38f7360ec92678574a554a54591c4c1fac9eee23433935145a1fe2ee2e4e37d563e08
+  data.tar.gz: ef10791a3e1818069f8138373eb11fb277e63f4fbdaa5c40ed451f9c9bf1a6ea4b756762a94024499aa6389f742fa54ba23084cb31256421819a4f80b463bf0d

data/.simplecov

@@ -0,0 +1,6 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.start do
+   add_filter 'spec/'
+end

data/Gemfile

@@ -9,4 +9,6 @@ group :development, :test do
   gem 'rspec', '~> 3'
   gem 'sqlite3'
   gem 'capybara'
+  gem 'coveralls', require: false
 end
+

data/README.md

@@ -1,28 +1,106 @@
-# Devise::MultiEmail [![Build Status](https://travis-ci.org/allenwq/devise-multi_email.svg?branch=master)](https://travis-ci.org/allenwq/devise-multi_email)
+# Devise::MultiEmail [![Build Status](https://travis-ci.org/allenwq/devise-multi_email.svg?branch=master)](https://travis-ci.org/allenwq/devise-multi_email) [![Coverage Status](https://coveralls.io/repos/allenwq/devise-multi_email/badge.svg?branch=master&service=github)](https://coveralls.io/github/allenwq/devise-multi_email?branch=master)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/devise/multi_email`. To experiment with that code, run `bin/console` for an interactive prompt.
+Let [devise](https://github.com/plataformatec/devise) support multilpe emails, it allows you to:
+- Login with multiple emails
+- Send confirmations to multiple emails
+- Recover the password with any of the emails
+- Validations for multiple emails 
 
-TODO: Delete this and the text above, and describe your gem
+`:multi_email_authenticatable`, `:multi_email_confirmable` and `:multi_email_validatable` are provided by devise-multi_email.
 
-## Installation
+## Getting Started
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile, devise-multi_email has been tested with devise 4.0 and rails 4.2:
 
 ```ruby
 gem 'devise-multi_email'
 ```
 
-And then execute:
+Suppose you have already setup devise, your `User` model might look like this:
 
-    $ bundle
+```ruby
+class User < ActiveRecord::Base
+  devise :database_authenticatable, :registerable
+end
+```
+
+In order to let your `User` support multiple emails, with `devise-multi_email` what you need to do is just:
+
+```ruby
+class User < ActiveRecord::Base
+  has_many :emails
+
+  # Replace :database_authenticatable, with :multi_email_authenticatable
+  devise :multi_email_authenticatable, :registerable
+end
+
+class Email < ActiveRecord::Base
+  belongs_to :user
+end
+```
+
+Note that `:email` column should be moved from users table to the emails table, and a new `primary` boolean column should be added to the emails table (so that all the emails will be sent to the primary email, and `user.email` will give you the primary email address). Your emails table's migration should look like:
+```ruby
+create_table :emails do |t|
+  t.integer :user_id
+  t.string :email
+  t.boolean :primary
+ end
+```
 
-Or install it yourself as:
+## Confirmable with multiple emails
+Sending different confirmaitons to different emails is supported. What you need to do is:
 
-    $ gem install devise-multi_email
+Declare `devise :multi_email_confirmable` in your `User` model:
+```ruby
+class User < ActiveRecord::Base
+  has_many :emails
+
+  # You should not declare :confiramble and :multi_email_confirmable at the same time.
+  devise :multi_email_authenticatable, :registerable, :multi_email_confirmable
+end
+```
+
+Add `:confirmation_token`, `:confirmed_at` and `:confirmation_sent_at` to your emails table:
+```ruby
+create_table :emails do |t|
+  t.integer :user_id
+  t.string :email
+  t.boolean :primary, default: false
+
+  ## Confirmable
+  t.string   :confirmation_token
+  t.datetime :confirmed_at
+  t.datetime :confirmation_sent_at
+end
+```
+
+Then all the methods in devise confirmable are avalible in your `Email` model. You can do `Email#send_confirmation_instructions` for each of your email. And `User#send_confirmation_instructions` will be delegated to the primary email.
+
+## Validatable with multiple emails
+Declare `devise :multi_email_validatable` in the user model, then all the user emails will be validated:
+
+```ruby
+class User < ActiveRecord::Base
+  has_many :emails
+
+  # You should not declare :validatable and :multi_email_validatable at the same time.
+  devise :multi_email_authenticatable, :registerable, :multi_email_validatable
+end
+```
+
+## What's more
+
+The gem works with all other devise modules just as normal, you don't need to add the `multi_email` prefix.
+```ruby
+  devise :multi_email_authenticatable, :multi_email_confirmable, :multi_email_validatable, :lockable, 
+         :recoverable, :registerable, :rememberable, :timeoutable, :trackable
+```
 
-## Usage
+## Issues
+You need to implement add/delete emails for a user as well as set/unset primary email.
 
-TODO: Write usage instructions here
+You can do `email.send_confirmation_instructions` for every email, but you also need to handle this logic in some place(excpet for the primary email). e.g. After a new email was added by a user, you might want to provide some buttons to allow user to resend confirmation instrucitons for that email.
 
 ## Development
 

data/lib/devise/multi_email/models/confirmable.rb

@@ -33,17 +33,8 @@ module Devise
 
       module InstanceReplacementMethods
         delegate :skip_confirmation!, :skip_confirmation_notification!, :skip_reconfirmation!, :confirmation_required?,
-                 :confirmation_token, :confirmed_at, :confirmation_sent_at, :confirm, :confirmed?,
-                 :reconfirmation_required?, to: :primary_email_record
-
-        def unconfirmed_email
-          primary_email_record.try(:unconfirmed_email)
-        end
-
-        def pending_reconfirmation?
-          primary_email = primary_email_record
-          primary_email && primary_email.pending_reconfirmation?
-        end
+                 :confirmation_token, :confirmed_at, :confirmation_sent_at, :confirm, :confirmed?, :unconfirmed_email,
+                 :reconfirmation_required?, :pending_reconfirmation?, to: :primary_email_record, allow_nil: true
 
         # This need to be forwarded to the email that the user logged in with
         def active_for_authentication?

data/lib/devise/multi_email/models/validatable.rb

@@ -25,6 +25,7 @@ module Devise
 
       included do
         devise :validatable
+        validates Devise::Models::MultiEmailAuthenticatable::EMAILS_ASSOCIATION, presence: true
 
         after_validation :propagate_email_errors
         email_class.send :include, EmailValidatable
@@ -41,7 +42,12 @@ module Devise
       end
 
       def propagate_email_errors
-        return if (email_errors = errors.delete(self.class::EMAILS_ASSOCIATION)).nil?
+        email_error_key = self.class::EMAILS_ASSOCIATION
+        if respond_to?("#{self.class::EMAILS_ASSOCIATION}_attributes=")
+          email_error_key = "#{email_error_key}.email".to_sym
+        end
+
+        return if (email_errors = errors.delete(email_error_key)).nil?
 
         email_errors.each do |error|
           errors.add(:email, error)

data/lib/devise/multi_email/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module MultiEmail
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise-multi_email
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - ALLEN WANG QIANG
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".simplecov"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile