effective_resources 2.10.1 → 2.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69383be96bec20188162a0c42162ce4727bf0f14ce74fa36556b09930bc2307a
-  data.tar.gz: 7d4ae8dc17da1c34834af13b9d864502de5b580eaa88e3e9da5258f7afc2efb7
+  metadata.gz: 70b3835f1e45128ade83d38d69adbcd8096fd5aecce4882028d0512dab970dae
+  data.tar.gz: 7c38e5cb62a55b4fa4924970aad1b0f45cf06b0dccedb41770f8df394e98a9c0
 SHA512:
-  metadata.gz: ecb3f7fb7caff620a403c577fc9d1196061e7da0ea2e1d137b6b4889e02097b46cc4a3cc8b7497cfc9fcb1641d9111170daed413a9f4743ee6005e0ba0ed4b0e
-  data.tar.gz: 6cc85b52a0ee048f15ee61e9b370cc3cad27910529bbf4d83c8260d67bcdaf7ce464d5841fcfa45c1adb6a2fd518c4348f4e46aba5831740fb4f9d4972e44194
+  metadata.gz: 50be7d9a989a25f8aa6777e85603c18b8ccc3be72e78aa35e4aa83814ca0fa74371de434c1138dc9a2331b57d79c1e032dbf987628c2b3b800b8b3819b26eb3d
+  data.tar.gz: 46e3229e7ecc0a7e989ac022afed029183b96e9a225f7a3d93edc3d9ff0a14a37682bf4d1685e1c3ebf3f8c8a5760e0cd09eafc7346eb940bf13d5aecd1752ad

data/README.md

@@ -392,6 +392,43 @@ def to_select2
 end
 ```
 
+## Authentication
+Effective Resources is designed to work with Devise. It also adds support for an `alternate email`
+for authentication. You just need to add an `alternate_email` column to your `User` model table.
+
+After that column is added, any user would be able to log in with either their `email` or their
+`alternate_email`.
+
+You can also create another mailer for `devise` in order to send password reset emails to the both
+the primary `email` and also the `alternate_email`, like this:
+
+```ruby
+class DeviseMailer < Devise::Mailer
+  # Overriding Devise's #headers_for to support alternate_email when present
+  def headers_for(action, opts)
+    headers = super(action, opts)
+
+    if [:reset_password_instructions].include?(action)
+      headers.merge!(
+        to: [resource.email, resource.try(:alternate_email)].compact.uniq
+      )
+    end
+
+    headers
+  end
+end
+```
+
+and set this new mailer to be used by `devise` in `config/initializers/devise.rb`:
+
+```ruby
+Devise.setup do |config|
+  # ...
+  config.mailer = 'DeviseMailer'
+  # ...
+end
+```
+
 ## Testing
 
 Run tests by:

data/app/models/concerns/effective_devise_user.rb

@@ -46,7 +46,7 @@ module EffectiveDeviseUser
     end
 
     # Devise invitable ignores model validations, so we manually check for duplicate email addresses.
-    before_save(if: -> { new_record? && invitation_sent_at.present? }) do
+    before_save(if: -> { new_record? && try(:invitation_sent_at).present? }) do
       if email.blank?
         self.errors.add(:email, "can't be blank")
         raise("email can't be blank")
@@ -62,6 +62,28 @@ module EffectiveDeviseUser
     before_save(if: -> { persisted? && encrypted_password_changed? }) do
       assign_attributes(provider: nil, access_token: nil, refresh_token: nil, token_expires_at: nil)
     end
+
+    # Uniqueness validation of emails and alternate emails across all users
+    validate(if: -> { respond_to?(:alternate_email) }) do
+      records = self.class.where.not(id: self.id) # exclude self
+      email_duplicates = records.where("lower(email) = :email OR lower(alternate_email) = :email", email: email.to_s.strip.downcase)
+      alternate_email_duplicates = records.where("lower(email) = :alternate_email OR lower(alternate_email) = :alternate_email", alternate_email: alternate_email.to_s.strip.downcase)
+
+      # Check if a uniqueness validation was already performed before triggering the exists query
+      if !self.errors.added?(:email, 'has already been taken') && email_duplicates.exists?
+        self.errors.add(:email, 'has already been taken')
+      end
+
+      # Check if the alternate email is set before triggering the exists query
+      if try(:alternate_email).present? && alternate_email_duplicates.exists?
+        self.errors.add(:alternate_email, 'has already been taken')
+      end
+    end
+
+    with_options(if: -> { respond_to?(:alternate_email) }) do
+      validates :alternate_email, email: true, allow_blank: true
+    end
+
   end
 
   module ClassMethods
@@ -162,10 +184,48 @@ module EffectiveDeviseUser
       recoverable
     end
 
+    # https://github.com/heartcombo/devise/blob/f6e73e5b5c8f519f4be29ac9069c6ed8a2343ce4/lib/devise/models/authenticatable.rb#L276
+    def find_first_by_auth_conditions(tainted_conditions, opts = {})
+      conditions = devise_parameter_filter.filter(tainted_conditions).merge(opts)
+
+      user = to_adapter.find_first(conditions)
+      return user if user.present? && user.persisted?
+
+      to_adapter.find_first(alternate_email: conditions[:email]) if has_alternate_email?
+    end
+
+    # https://github.com/heartcombo/devise/blob/f6e73e5b5c8f519f4be29ac9069c6ed8a2343ce4/lib/devise/models/database_authenticatable.rb#L216
+    def find_for_database_authentication(warden_conditions)
+      conditions = warden_conditions.dup.presence || {}
+      primary_or_alternate_email = conditions[:email]
+      conditions.delete(:email)
+
+      raise "Expected an email #{has_alternate_email? ? 'or alternate email' : ''} but got [#{primary_or_alternate_email}] instead" if primary_or_alternate_email.blank?
+
+      query = if has_alternate_email?
+                "lower(email) = :value OR lower(alternate_email) = :value"
+              else
+                "lower(email) = :value"
+              end
+
+      all
+        .where(conditions)
+        .where(query, value: primary_or_alternate_email.strip.downcase)
+        .first
+    end
+
+    def has_alternate_email?
+      'alternate_email'.in? column_names
+    end
+
   end
 
   # EffectiveDeviseUser Instance Methods
 
+  def alternate_email=(value)
+    super(value.to_s.strip.downcase.presence)
+  end
+
   def reinvite!
     invite!
   end

data/lib/effective_resources/version.rb

@@ -1,3 +1,3 @@
 module EffectiveResources
-  VERSION = '2.10.1'.freeze
+  VERSION = '2.11.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 2.10.1
+  version: 2.11.1
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-13 00:00:00.000000000 Z
+date: 2023-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails