authlogic_email_token 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82c6ebcef382eeba4a9db915cc926f4dbf250b6f
+  data.tar.gz: 13fda182503d9ea91e6d9a2971165ca9c2050560
+SHA512:
+  metadata.gz: 8dba7244d2f51afeaa34616aeb2f5df29f921803fc9f48d1e38b3887ef893ef777839452c27750e1cd17ee7528c73f35d346c1fcdb7c6d8af71be03b9d712281
+  data.tar.gz: ada7d45d51568a5893da5966eda865c7d179c86662aa497714d0b5be7a2c79a5bad6f55e4e68b9af122f4b8ec34266d2a6033adc18f96177ead8b5e4ed03fd0e

data/lib/authlogic/acts_as_authentic/email_token.rb

@@ -0,0 +1,115 @@
+# An extension to Authlogic for email confirmation tokens. Email confirmation tokens have
+# a value (+email_token+) and a timestamp (+email_token_updated_at+). Email tokens are
+# never maintained automatically. You must call +reset_email_token+ or
+# +reset_email_token!+ yourself. At a minimum, you should do so:
+#
+# * When you send a confirmation email.
+# * When the user follows the link in a confirmation email.
+# 
+# The internal structure of this module is based on Authlogic's own modules.
+module Authlogic::ActsAsAuthentic::EmailToken
+  def self.included(klass)
+    klass.class_eval do
+      # Every subclass of ActiveRecord::Base will have the class methods defined in the
+      # Config module.
+      extend Config
+      
+      add_acts_as_authentic_module(Methods)
+    end
+  end
+  
+  module Config
+    def email_token_valid_for(value = nil)
+      rw_config(:email_token_valid_for, (!value.nil? && value.to_i) || value, 10.minutes.to_i)
+    end
+    alias_method :email_token_valid_for=, :email_token_valid_for
+    
+    # Configures the name of the account activation boolean column. See
+    # +Authlogic::ActsAsAuthentic::EmailToken::Confirmation#confirm_email+ for more info.
+    def activation_method(value = nil)
+      rw_config(:activation_method, value, :activate)
+    end
+    alias_method :activation_method=, :activation_method
+  end
+  
+  module Methods
+    def self.included(klass)
+      # Do nothing if the email_token column is missing. If the email_token column
+      # is present but not email_token_updated_at, raise.
+      if !klass.column_names.include? 'email_token'
+        return
+      elsif !klass.column_names.include? 'email_token_updated_at'
+        raise(
+          "#{klass.name} has an email_token column but not email_token_updated_at. " +
+          " You must add the latter. (Should be :datetime, null: false.)"
+        )
+      end
+            
+      klass.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+      
+        # If this module is added to an existing app, the email_confirmation column will
+        # initially be blank. To avoid errors upon save, we must phase in the new tokens.
+        # 
+        # Similarly, when new records are created, we must set these values.
+        before_save ->(user) {
+          if user.email_token.blank? or user.email_token_updated_at.blank?
+            user.reset_email_token
+          end
+        }
+      end
+    end
+    
+    module ClassMethods
+      # Use this method to find a record with an email confirmation token. This method
+      # does 2 things for you:
+      #
+      # 1. It ignores blank tokens
+      # 2. It enforces the +email_token_valid_for configuration+ option.
+      #
+      # If you want to use a different timeout value, just pass it as the second
+      # parameter:
+      #
+      #   User.find_using_email_token(token, 1.hour)
+      # 
+      # This method is very similar to, and based heavily off of, Authlogic's
+      # +#find_using_perishable_token+ method.
+      def find_using_email_token(token, age = self.email_token_valid_for)
+        return if token.blank?
+        age = age.to_i
+        
+        # Authlogic builds its SQL by hand, but I prefer Arel. The logic is the same.
+        t = arel_table
+        conditions = t[:email_token].eq(token)
+        if age > 0
+          conditions = conditions.and(
+            t[:email_token_updated_at].gt(age.seconds.ago)
+          )
+        end
+        
+        where(conditions).first
+      end
+      
+      # This method will raise +ActiveRecord::RecordNotFound+ if no record is found.
+      def find_using_email_token!(token, age = self.email_token_valid_for)
+        find_using_email_token(token, age) || raise(ActiveRecord::RecordNotFound)
+      end
+    end
+    
+    module InstanceMethods  
+      # Resets the email token to a random friendly token. Sets email_token_updated_at
+      # to the current time.
+      def reset_email_token
+        self.email_token_updated_at = Time.now
+        self.email_token = Authlogic::Random.friendly_token
+      end
+  
+      # Same as reset_email_token, but then saves the record afterwards.
+      def reset_email_token!
+        reset_email_token
+        save_without_session_maintenance(validate: false)
+      end
+    end
+  end
+end

data/lib/authlogic/acts_as_authentic/email_token/confirmation.rb

@@ -0,0 +1,135 @@
+# This module is an optional part of the authlogic_email_token gem. It provides some
+# standard logic for confirming email addresses.
+# 
+# Include this module in your +User+ model and add a +new_email+ column to the +users+
+# table:
+# 
+#   add_column :users, :new_email, :string, null: true, after: :email
+# 
+# You can then use the +new_email+ attribute in your account settings form like so:
+# 
+#   <%= form_for current_user do |f| %>
+#     <% if f.object.email_change_unconfirmed? %>
+#       <div>
+#         Your email address (<%= f.object.new_email %>) has not been confirmed yet. In the
+#         meantime, emails will continue to be sent to <%= f.object.email %>.
+#       </div>
+#     <% end %>
+#   
+#     <div>
+#       <%= f.label 'Email address:' %>
+#       <%= f.text_field :new_email %>
+#     </div>
+#   <% end %>
+# 
+# 
+
+module Authlogic::ActsAsAuthentic::EmailToken::Confirmation
+  
+  # Call this when you have verified the user's email address. (Typically, as a result of
+  # the user clicking the link in a confirmation email.)
+  # 
+  # Sets +email+ to +new_email+ and +new_email+ to nil, if appropriate. Resets
+  # the +email_token+.
+  # 
+  # You can use this for at least two purposes:
+  # 
+  # * verifying changes of address for existing accounts; and
+  # * verifying new accounts.
+  # 
+  # For the latter purpose, this method looks for a method called +activate+, and if it
+  # exists, calls it. (Or a method of a different name, if you configured
+  # +activation_method+.)
+  def confirm_email
+    send(self.class.activation_method) if respond_to?(self.class.activation_method)
+    if new_email.present?
+      self.email = new_email
+      self.new_email = nil
+    end
+    reset_email_token
+  end
+  
+  def confirm_email!
+    confirm_email
+    save_without_session_maintenance(validate: false)
+  end
+  
+  # Returns true if and only if:
+  # 
+  #   * +email+ changed during the previous save; or
+  #   * +new_email+ changed during the previous save.
+  def email_changed_previously?
+    (previous_changes.has_key?(:email) and previous_changes[:email][1].present?) or
+    (previous_changes.has_key?(:new_email) and previous_changes[:new_email][1].present?)
+  end
+  
+  # Returns true if and only if new_email != email. Should only ever be true when user
+  # changes email address. When user creates new account and activation is pending, this
+  # is not true.
+  def email_change_unconfirmed?
+    read_attribute(:new_email).present? and (read_attribute(:new_email) != email)
+  end
+  
+  # Sends a confirmation message if and only if +#email_changed_previously?+ returns true.
+  # (In other words, if +#email+ or +#new_email+ changed on the last save.)
+  # 
+  # By default, this methods assumes that the following method exists:
+  # 
+  #   UserMailer.email_confirmation(user, controller)
+  # 
+  # If you don't like that, you can override it by providing a block to this method. E.g.:
+  # 
+  #   # This would be in a controller action, so self refers to the controller.
+  #   user.maybe_deliver_email_confirmation!(self) do
+  #     MyOtherMailer.whatever_message(user).deliver
+  #   end
+  # 
+  # Recommended usage looks something like this:
+  #
+  #   class UsersController < ApplicationController
+  #     def create
+  #       @user = User.new user_params
+  #       if @user.save
+  #         @user.maybe_deliver_email_confirmation! self
+  #         redirect_to root_url, notice: 'Confirmation email sent.'
+  #       else
+  #         render action: :new
+  #       end
+  #     end
+  #     
+  #     def update
+  #       if current_user.update_attributes user_params
+  #         if current_user.maybe_deliver_email_confirmation! self
+  #           redirect_to(edit_user_url, notice: 'Confirmation email sent.'
+  #         else
+  #           redirect_to edit_user_url, notice: 'Account settings saved.'
+  #         end
+  #       else
+  #         render action: 'edit'
+  #       end
+  #     end
+  #   end
+  def maybe_deliver_email_confirmation!(controller)
+    if email_changed_previously?
+      reset_email_token!
+      if block_given?
+        yield
+      else
+        UserMailer.email_confirmation(self, controller).deliver
+      end
+      true
+    else
+      false
+    end
+  end
+  
+  # Returns the contents of the +new_email+ column. Or, if that column is blank, returns
+  # the contents of the +email+ column instead. Designed to be called from an account
+  # settings form, e.g.:
+  # 
+  #   <%= f.text_field :new_email %>
+  def new_email
+    e = read_attribute :new_email
+    e.present? ? e : email
+  end
+end

data/lib/authlogic/acts_as_authentic/email_token/railtie.rb

@@ -0,0 +1,9 @@
+module Authlogic::ActsAsAuthentic::EmailToken
+  class Railtie < Rails::Railtie
+    initializer 'authlogic_email_token.configure_rails_initialization' do
+      ::ActiveRecord::Base.class_eval do
+        include Authlogic::ActsAsAuthentic::EmailToken
+      end
+    end
+  end
+end

data/lib/authlogic_email_token.rb

@@ -0,0 +1,3 @@
+require 'authlogic/acts_as_authentic/email_token'
+require 'authlogic/acts_as_authentic/email_token/confirmation'
+require 'authlogic/acts_as_authentic/email_token/railtie' if defined?(Rails)

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: authlogic_email_token
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Jarrett Colby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: authlogic
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Adds email_token and email_token_updated_at columns. Works like Authlogic's
+  perishable_token, but doesn't reset on every request. Designed primarily for verifying
+  users' email addresses.
+email: jarrett@madebyhq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/authlogic/acts_as_authentic/email_token.rb
+- lib/authlogic/acts_as_authentic/email_token/confirmation.rb
+- lib/authlogic/acts_as_authentic/email_token/railtie.rb
+- lib/authlogic_email_token.rb
+homepage: https://github.com/jarrett/authlogic_email_token
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Authlogic extension for email confirmation
+test_files: []