josevalim-auth_helpers 0.1.2 → 0.2.0

data/lib/auth_helpers/model/updatable.rb

@@ -0,0 +1,39 @@
+module AuthHelpers
+  module Model
+
+    # Hacks into update attributes to dael with email, email confirmation,
+    # password and password confirmation. If the e-mail changes, it resends
+    # the confirmation instructions if the confirmable module is also included.
+    #
+    module Updatable
+      def self.included(base)
+        base.send :attr_accessor, :email_confirmation, :password_confirmation
+        base.send :attr_accessible, :email, :email_confirmation, :password, :password_confirmation
+        base.send :validates_confirmation_of, :email, :password
+      end
+
+      def update_attributes(options)
+        options.delete(:email)              if options[:email] == self.email
+        options.delete(:email_confirmation) if options[:email_confirmation].blank?
+
+        options.delete(:password)              if options[:password].blank? || self.valid_password?(options[:password])
+        options.delete(:password_confirmation) if options[:password_confirmation].blank?
+
+        # Force confirmations (if confirmation is nil, it won't validate, it has to be at least blank)
+        options[:email_confirmation]    ||= '' if options[:email]
+        options[:password_confirmation] ||= '' if options[:password]
+
+        if super(options)
+          if options[:email] && self.respond_to?(:send_confirmation_instructions)
+            self.send_confirmation_instructions(:update)
+          end
+
+          return true
+        end
+
+        return false
+      end
+    end
+
+  end
+end

data/lib/auth_helpers/notifier.rb

@@ -16,39 +16,40 @@ module AuthHelpers
   class Notifier < ActionMailer::Base
     class << self; attr_accessor :sender, :content_type end
 
-    def new_account(record)
-      @subject = I18n.t 'actionmailer.auth_helpers.new_account', :default => 'New account'
-      set_ivars!(:confirmable, record)
+    def create_confirmation(record)
+      @subject = I18n.t 'actionmailer.auth_helpers.create_confirmation', :default => 'Create confirmation'
+      set_ivars!(record)
     end
 
-    def email_changed(record)
-      @subject = I18n.t 'actionmailer.auth_helpers.email_changed', :default => 'You changed your e-mail'
-      set_ivars!(:confirmable, record)
+    def update_confirmation(record)
+      @subject = I18n.t 'actionmailer.auth_helpers.update_confirmation', :default => 'Update e-mail confirmation'
+      set_ivars!(record)
     end
 
     def reset_password(record)
       @subject = I18n.t 'actionmailer.auth_helpers.reset_password', :default => 'Reset password'
-      set_ivars!(:recoverable, record)
+      set_ivars!(record)
     end
 
-    def confirmation_code(record)
-      @subject = I18n.t 'actionmailer.auth_helpers.confirmation_code', :default => 'Confirmation code'
-      set_ivars!(:confirmable, record)
+    def resend_confirmation(record)
+      @subject = I18n.t 'actionmailer.auth_helpers.resend_confirmation', :default => 'Confirmation code'
+      set_ivars!(record)
     end
 
     protected
 
-      def set_ivars!(assign, record)
-        @from         = self.class.sender
-        @content_type = self.class.content_type
-        @body[assign] = record
-        @recipients   = record.email
-        @sent_on      = Time.now.utc
-        @headers      = {}
+      def set_ivars!(record)
+        @from          = self.class.sender
+        @content_type  = self.class.content_type
+        @recipients    = record.email
+        @sent_on       = Time.now.utc
+        @headers       = {}
+        @body[:record] = record
+        @body[record.class.name.downcase] = record
       end
 
   end
 end
 
-AuthHelpers::Notifier.content_type  = 'text/html'
-AuthHelpers::Notifier.template_root = File.join(File.dirname(__FILE__), '..', '..', 'views')
+AuthHelpers::Notifier.content_type  ||= 'text/html'
+AuthHelpers::Notifier.template_root ||= File.join(File.dirname(__FILE__), '..', '..', 'views')

data/lib/auth_helpers/spec/confirmable.rb

@@ -10,14 +10,7 @@ module AuthHelpers
               @confirmable = base.described_class.create!(@valid_attributes)
             end
 
-            it { should_not allow_mass_assignment_of(:confirmation_code) }
-
-            it 'should remove confirmation code' do
-              @confirmable.confirm!
-              @confirmable.confirmation_code.should be_nil
-            end
-
-            it 'should set the date account was confirmed' do
+            it 'should set the confirmation date on #confirm!' do
               @confirmable.confirmed_at.should be_nil
               @confirmable.confirm!
               @confirmable.confirmed_at.should_not be_nil
@@ -32,62 +25,63 @@ module AuthHelpers
             end
 
             describe 'on create' do
-              it "should set confirmation_code" do
-                @confirmable.confirmation_code.length.should == 40
+              it "should set confirmed_at to nil" do
+                @confirmable.confirmed_at.should be_nil
               end
 
               it "should set confirmation_sent_at" do
                 @confirmable.confirmation_sent_at.should_not be_blank
               end
 
-              it "should send a new account notification" do
+              it "should send create confirmation notification" do
                 ActionMailer::Base.deliveries.length.should == 1
               end
             end
 
-            describe 'with a valid confirmation code' do
+            describe 'with a valid perishable token' do
               it "should confirm his account" do
-                record = base.described_class.find_and_confirm(@confirmable.confirmation_code)
+                record = base.described_class.find_and_confirm(:perishable_token => @confirmable.perishable_token)
                 record.errors.should be_empty
               end
 
-              it "should clean confirmation code" do
-                base.described_class.find_and_confirm(@confirmable.confirmation_code)
+              it "should set confirmation date" do
+                record = base.described_class.find_and_confirm(:perishable_token => @confirmable.perishable_token)
                 @confirmable.reload
-                @confirmable.confirmation_code.should be_nil
-              end
-
-              it "should set confirmed_at date" do
-                record = base.described_class.find_and_confirm(@confirmable.confirmation_code)
-                record.confirmed_at.should_not be_nil
+                @confirmable.confirmed_at.should_not be_nil
               end
             end
 
-            describe 'with an invalid confirmation code' do
+            describe 'with an invalid perishable token' do
               it "should set an error message" do
-                record = base.described_class.find_and_confirm('invalid_code')
-                record.errors.on(:confirmation_code).should == record.errors.generate_message(:confirmation_code, :invalid)
+                record = base.described_class.find_and_confirm(:perishable_token => "invalid token")
+                record.errors.on(:perishable_token).should == record.errors.generate_message(:perishable_token, :invalid_confirmation, :default => :invalid)
+              end
+
+              it "should return a new record with the perishable token set" do
+                record = base.described_class.find_and_confirm(:perishable_token => "invalid token")
+                record.should be_new_record
+                record.perishable_token.should == "invalid token"
               end
             end
 
             describe 'when lost confirmation code' do
               before(:each){ ActionMailer::Base.deliveries = [] }
 
-              it "should resend confirmation code if account is not confirmed" do
-                record = base.described_class.find_and_resend_confirmation_code(:email => @confirmable.email)
+              it "should resend confirmation instructions if account is not confirmed" do
+                record = base.described_class.find_and_resend_confirmation_instructions(:email => @confirmable.email)
                 record.errors.should be_empty
                 ActionMailer::Base.deliveries.length.should == 1
               end
 
-              it "should not resend confirmation code if account is confirmed" do
+              it "should not resend confirmation instructions if account is confirmed" do
                 @confirmable.confirm!
-                record = base.described_class.find_and_resend_confirmation_code(:email => @confirmable.email)
+                record = base.described_class.find_and_resend_confirmation_instructions(:email => @confirmable.email)
                 record.errors.on(:email).should == record.errors.generate_message(:email, :already_confirmed)
                 ActionMailer::Base.deliveries.length.should == 0
               end
 
-              it "should show a error message on resend confirmation code if e-mail is not valid" do
-                record = base.described_class.find_and_resend_confirmation_code(:email => 'invalid')
+              it "should show a error message on resend confirmation instructions if e-mail is not valid" do
+                record = base.described_class.find_and_resend_confirmation_instructions(:email => 'invalid')
                 record.errors.on(:email).should == record.errors.generate_message(:email, :not_found)
                 ActionMailer::Base.deliveries.length.should == 0
               end

data/lib/auth_helpers/spec/notifier.rb

@@ -6,33 +6,32 @@ module AuthHelpers
       def self.included(base)
         base.class_eval do
           before(:each) do
-            @member = OpenStruct.new(:email               => 'recipient@email.com',
-                                     :confirmation_code   => '0123456789',
-                                     :reset_password_code => 'abcdefghij')
+            @record = OpenStruct.new(:email            => 'recipient@email.com',
+                                     :perishable_token => '0123456789')
           end
 
           it "should deliver new account notification" do
-            email = ::AuthHelpers::Notifier.create_new_account(@member)
+            email = ::AuthHelpers::Notifier.create_create_confirmation(@record)
             email.to.should == [ 'recipient@email.com' ]
-            email.body.should match(/#{@member.confirmation_code}/)
+            email.body.should match(/#{@record.perishable_token}/)
           end
 
           it "should deliver email changed notification" do
-            email = ::AuthHelpers::Notifier.create_email_changed(@member)
+            email = ::AuthHelpers::Notifier.create_update_confirmation(@record)
             email.to.should == [ 'recipient@email.com' ]
-            email.body.should match(/#{@member.confirmation_code}/)
+            email.body.should match(/#{@record.perishable_token}/)
           end
 
           it "should deliver reset password code" do
-            email = ::AuthHelpers::Notifier.create_reset_password(@member)
+            email = ::AuthHelpers::Notifier.create_reset_password(@record)
             email.to.should == [ 'recipient@email.com' ]
-            email.body.should match(/#{@member.reset_password_code}/)
+            email.body.should match(/#{@record.perishable_token}/)
           end
 
           it "should resend confirmation code" do
-            email = ::AuthHelpers::Notifier.create_confirmation_code(@member)
+            email = ::AuthHelpers::Notifier.create_resend_confirmation(@record)
             email.to.should == [ 'recipient@email.com' ]
-            email.body.should match(/#{@member.confirmation_code}/)
+            email.body.should match(/#{@record.perishable_token}/)
           end
         end
       end

data/lib/auth_helpers/spec/recoverable.rb

@@ -10,48 +10,41 @@ module AuthHelpers
               ActionMailer::Base.deliveries = []
             end
 
-            it "should send a reset password code to the user" do
-              record = base.described_class.find_and_send_reset_password_code(:email => @recoverable.email)
+            it "should send a reset password instructions to the user" do
+              record = base.described_class.find_and_send_reset_password_instructions(:email => @recoverable.email)
               record.errors.should be_empty
-              record.reset_password_code.should_not be_blank
-              ActionMailer::Base.deliveries.length.should == 1
+              ActionMailer::Base.deliveries.length.should == 1
             end
 
             describe 'and reset password code is sent' do
               before(:each) do
-                base.described_class.find_and_send_reset_password_code(:email => @recoverable.email)
+                base.described_class.find_and_send_reset_password_instructions(:email => @recoverable.email)
                 @recoverable.reload
               end
 
               it "should reset password if reset password code is valid" do
-                record = base.described_class.find_and_reset_password(:reset_password_code => @recoverable.reset_password_code, :password => '654321', :password_confirmation => '654321')
-                record.errors.should be_empty
-
-                record = base.described_class.find_and_authenticate(:email => @recoverable.email, :password => '654321')
-                record.errors.should be_empty
-              end
-
-              it "should not reset password if the given reset password code is invalid" do
-                record = base.described_class.find_and_reset_password(:reset_password_code => 'invalid_pass_code', :password => '654321', :password_confirmation => '654321')
-                record.errors.on(:reset_password_code).should == record.errors.generate_message(:reset_password_code, :invalid)
-                record = base.described_class.find_and_authenticate(:email => @recoverable.email, :password => '654321')
-                record.errors.should_not be_empty
-              end
-
-              it "should not reset password if password doesn't match confirmation" do
-                record = base.described_class.find_and_reset_password(:reset_password_code => @recoverable.reset_password_code, :password => '654321', :password_confirmation => '123456')
-                record.errors.on(:password).should == record.errors.generate_message(:password, :confirmation)
-
-                record = base.described_class.find_and_authenticate(:email => @recoverable.email, :password => '654321')
-                record.errors.should_not be_empty
-              end
-
-              it "should clean reset_password_code when password is successfully reset" do
-                base.described_class.find_and_reset_password(:reset_password_code => @recoverable.reset_password_code, :password => '654321', :password_confirmation => '654321')
-                @recoverable.reload
-                @recoverable.reset_password_code.should be_nil
+                record = base.described_class.find_and_reset_password(:perishable_token => @recoverable.perishable_token, :password => '654321', :password_confirmation => '654321')
+                record.errors.should be_empty
+
+                @recoverable.reload
+                @recoverable.valid_password?('654321').should be_true
+              end
+
+              it "should not reset password if the given reset password code is invalid" do
+                record = base.described_class.find_and_reset_password(:perishable_token => 'invalid_token', :password => '654321', :password_confirmation => '654321')
+                record.errors.on(:perishable_token).should == record.errors.generate_message(:perishable_token, :invalid_reset_password, :default => :invalid)
+                @recoverable.reload
+                @recoverable.valid_password?('654321').should be_false
               end
-            end
+
+              it "should not reset password if password doesn't match confirmation" do
+                record = base.described_class.find_and_reset_password(:perishable_token => @recoverable.perishable_token, :password => '654321', :password_confirmation => '123456')
+                record.errors.on(:password).should == record.errors.generate_message(:password, :confirmation)
+
+                @recoverable.reload
+                @recoverable.valid_password?('654321').should be_false
+              end
+            end
           end
         end
       end

data/lib/auth_helpers/spec/updatable.rb

@@ -0,0 +1,37 @@
+module AuthHelpers
+  module Spec
+
+    module Updatable
+      def self.included(base)
+        base.class_eval do
+          describe "on update" do
+            before(:each) do
+              @authenticable = base.described_class.create!(@valid_attributes)
+              ActionMailer::Base.deliveries = []
+            end
+
+            it "should ignore e-mail confirmation if e-mail has not changed" do
+              attributes = { :email => @authenticable.email, :email_confirmation => '' }
+              @authenticable.update_attributes(attributes).should be_true
+            end
+
+            it "should ignore password confirmation if password has not changed" do
+              attributes = { :password => @valid_attributes[:password], :password_confirmation => '' }
+              @authenticable.update_attributes(attributes).should be_true
+            end
+
+            if base.described_class.new.respond_to?(:set_confirmation_code, true)
+              it "should send an e-mail if e-mail changes" do
+                attributes = { :email => @valid_attributes[:email].to_s.next, :email_confirmation => @valid_attributes[:email].to_s.next }
+                @authenticable.update_attributes(attributes).should be_true
+                @authenticable.email.should == @valid_attributes[:email].to_s.next
+                ActionMailer::Base.deliveries.length.should == 1
+              end
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/views/auth_helpers/notifier/create_confirmation.erb

@@ -0,0 +1 @@
+Welcome! Your confirmation code is <%= @record.perishable_token %>.

data/views/auth_helpers/notifier/resend_confirmation.erb

@@ -0,0 +1 @@
+Your confirmation code is <%= @record.perishable_token %>.

data/views/auth_helpers/notifier/reset_password.erb

@@ -1 +1 @@
-Your reset password code is <%= @recoverable.reset_password_code %>.
+Your reset password code is <%= @record.perishable_token %>.

data/views/auth_helpers/notifier/update_confirmation.erb

@@ -0,0 +1 @@
+Your new confirmation code is <%= @record.perishable_token %>.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: josevalim-auth_helpers
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -13,16 +13,16 @@ date: 2009-04-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: remarkable_rails
+  name: authlogic
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 3.0.7
+        version: "0"
     version: 
-description: AuthHelpers is a collection of modules to include in your model to deal with authentication.
+description: AuthHelpers is a collection of modules to improve your Authlogic models.
 email: jose.valim@gmail.com
 executables: []
 
@@ -36,25 +36,19 @@ files:
 - README
 - init.rb
 - lib/auth_helpers.rb
-- lib/auth_helpers/migration.rb
 - lib/auth_helpers/notifier.rb
 - lib/auth_helpers/model/associatable.rb
-- lib/auth_helpers/model/authenticable.rb
 - lib/auth_helpers/model/confirmable.rb
 - lib/auth_helpers/model/recoverable.rb
-- lib/auth_helpers/model/rememberable.rb
-- lib/auth_helpers/model/validatable.rb
-- lib/auth_helpers/spec/associatable.rb
-- lib/auth_helpers/spec/authenticable.rb
+- lib/auth_helpers/model/updatable.rb
 - lib/auth_helpers/spec/confirmable.rb
 - lib/auth_helpers/spec/notifier.rb
 - lib/auth_helpers/spec/recoverable.rb
-- lib/auth_helpers/spec/rememberable.rb
-- lib/auth_helpers/spec/validatable.rb
-- views/auth_helpers/notifier/confirmation_code.erb
-- views/auth_helpers/notifier/email_changed.erb
-- views/auth_helpers/notifier/new_account.erb
+- lib/auth_helpers/spec/updatable.rb
+- views/auth_helpers/notifier/create_confirmation.erb
+- views/auth_helpers/notifier/resend_confirmation.erb
 - views/auth_helpers/notifier/reset_password.erb
+- views/auth_helpers/notifier/update_confirmation.erb
 has_rdoc: true
 homepage: http://github.com/josevalim/auth_helpers
 post_install_message: 
@@ -81,6 +75,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: AuthHelpers is a collection of modules to include in your model to deal with authentication.
+summary: AuthHelpers is a collection of modules to improve your Authlogic models.
 test_files: []
 

data/lib/auth_helpers/migration.rb

@@ -1,56 +0,0 @@
-module AuthHelpers
-  # Helpers to migration:
-  #
-  #   create_table :accounts do |t|
-  #     t.extend AuthHelpers::Migration
-  #     
-  #     t.authenticable
-  #     t.confirmable
-  #     t.recoverable
-  #     t.rememberable
-  #     t.timestamps
-  #   end
-  #
-  # However this method does not add indexes. If you need them, here is the declaration:
-  #
-  #   add_index "accounts", ["email"],               :name => "email",               :unique => true
-  #   add_index "accounts", ["token"],               :name => "token",               :unique => true
-  #   add_index "accounts", ["confirmation_code"],   :name => "confirmation_code",   :unique => true
-  #   add_index "accounts", ["reset_password_code"], :name => "reset_password_code", :unique => true
-  #
-  # E-mail index should be slightly changed with you are working with polymorphic
-  # associations.
-  #
-  module Migration
-
-    # Creates email, hashed_password and salt.
-    #
-    def authenticable
-      self.string :email,           :limit => 100, :null => false, :default => ''
-      self.string :hashed_password, :limit =>  40, :null => false, :default => ''
-      self.string :salt,            :limit =>  10, :null => false, :default => ''
-    end
-
-    # Creates confirmation_code, confirmed_at and confirmation_sent_at.
-    #
-    def confirmable
-      self.string   :confirmation_code, :limit =>  40, :null => true
-      self.datetime :confirmed_at
-      self.datetime :confirmation_sent_at
-    end
-
-    # Creates reset_password_code.
-    #
-    def recoverable
-      self.string :reset_password_code, :limit =>  40, :null => true
-    end
-
-    # Creates token and token_created_at.
-    #
-    def rememberable
-      self.string   :token, :limit =>  40, :null => true
-      self.datetime :token_expires_at
-    end
-
-  end
-end