devise_invitable 0.5.4 → 0.6.1

data/README.rdoc

@@ -51,6 +51,7 @@ or for a model that already exists, define a migration to add DeviseInvitable to
   change_table :users do |t|
     t.string   :invitation_token, :limit => 60
     t.datetime :invitation_sent_at
+    t.datetime :invitation_accepted_at
     t.index    :invitation_token
   end
 
@@ -148,6 +149,18 @@ To accept an invitation with a token use the <tt>accept_invitation!</tt> class m
 
   User.accept_invitation!(:invitation_token => params[:invitation_token], :password => "ad97nwj3o2", :name => "John Doe")
 
+=== Callbacks
+
+A callback event is fired before and after an invitation is accepted (User#accept_invitation!). For example, in your resource model you can add:
+
+  after_invitation_accepted :email_invited_by
+
+  def email_invited_by
+     # ... 
+  end
+
+The callbacks support all options and arguments available to the standard callbacks provided by AR.
+
 == Integration in a Rails application
 
 Since the invitations controller take care of all the creation/acceptation of an invitation, in most cases you wouldn't call the <tt>invite!</tt> and <tt>accept_invitation!</tt> methods directly.
@@ -172,7 +185,7 @@ You would have a User model which is configured as invitable and an Admin model
   class ApplicationController < ActionController::Base
   protected
     def authenticate_inviter!
-      authenticate_admin!(true)
+      authenticate_admin!(:force => true)
     end
   end
 
@@ -183,6 +196,18 @@ And include DeviseInvitable::Inviter module into Admin model:
     include DeviseInvitable::Inviter
   end
 
+== Has many invitations
+
+If you want to get all records invited by a resource, you should define has_many association in the model allowed to send invitations.
+
+For the default behavior, define it like this:
+
+  has_many :invitations, :class_name => self.class.to_s, :as => :invited_by
+
+For the previous example, where admins send invitations to users, define it like this:
+
+  has_many :invitations, :class_name => 'User', :as => :invited_by
+
 == I18n
 
 DeviseInvitable uses flash messages with I18n with the flash keys <tt>:send_instructions</tt>, <tt>:invitation_token_invalid</tt> and <tt>:updated</tt>. To customize your app, you can modify the generated locale file:

data/app/controllers/devise/invitations_controller.rb

@@ -26,7 +26,7 @@ class Devise::InvitationsController < ApplicationController
 
   # GET /resource/invitation/accept?invitation_token=abcdef
   def edit
-    if params[:invitation_token] && self.resource = resource_class.first(:conditions => { :invitation_token => params[:invitation_token] })
+    if params[:invitation_token] && self.resource = resource_class.to_adapter.find_first( :invitation_token => params[:invitation_token] )
       render_with_scope :edit
     else
       set_flash_message(:alert, :invitation_token_invalid)
@@ -55,16 +55,17 @@ class Devise::InvitationsController < ApplicationController
   def has_invitations_left?
     unless current_inviter.nil? || current_inviter.has_invitations_left?
       build_resource
-      set_flash_message :alert, :no_invitations_remaining 
+      set_flash_message :alert, :no_invitations_remaining
       respond_with_navigational(resource) { render_with_scope :new }
     end
   end
 
   def after_invite_path_for(resource)
-    redirect_location(resource_name, resource)
+    after_sign_in_path_for(resource)
   end
 
   def after_accept_path_for(resource)
     after_sign_in_path_for(resource)
   end
 end
+

data/app/views/devise/invitations/new.html.erb

@@ -1,6 +1,6 @@
 <h2>Send invitation</h2>
 
-<%= form_for resource, :as => resource_name, :url => invitation_path(resource_name) do |f| %>
+<%= form_for resource, :as => resource_name, :url => invitation_path(resource_name), :html => {:method => :post} do |f| %>
   <%= devise_error_messages! %>
 
   <p><%= f.label :email %><br />

data/lib/devise_invitable/controllers/helpers.rb

@@ -1,7 +1,7 @@
 module DeviseInvitable::Controllers::Helpers
   protected
   def authenticate_inviter!
-    send(:"authenticate_#{resource_name}!", true)
+    send(:"authenticate_#{resource_name}!", :force => true)
   end
 end
 ActionController::Base.send :include, DeviseInvitable::Controllers::Helpers

data/lib/devise_invitable/mailer.rb

@@ -5,10 +5,5 @@ module DeviseInvitable
     def invitation_instructions(record)
       devise_mail(record, :invitation_instructions)
     end
-    
-    def invitation(record)
-      ActiveSupport::Deprecation.warn('invitation has been renamed to invitation_instructions')
-      invitation_instructions(record)
-    end
   end
 end

data/lib/devise_invitable/model.rb

@@ -24,16 +24,24 @@ module Devise
       attr_accessor :skip_invitation
 
       included do
-        include ::DeviseInvitable::Inviter
+        include ::DeviseInvitable::Inviter        
         belongs_to :invited_by, :polymorphic => true
+        
+        include ActiveSupport::Callbacks
+        define_callbacks :invitation_accepted
+        
+        attr_writer :skip_password
       end
 
-      # Accept an invitation by clearing invitation token and confirming it if model
-      # is confirmable
+      # Accept an invitation by clearing invitation token and and setting invitation_accepted_at
+      # Confirms it if model is confirmable
       def accept_invitation!
         if self.invited? && self.valid?
-          self.invitation_token = nil
-          self.save
+          run_callbacks :invitation_accepted do
+            self.invitation_token = nil
+            self.invitation_accepted_at = Time.now.utc if respond_to? :"invitation_accepted_at="
+            self.save(:validate => false)
+          end
         end
       end
 
@@ -44,15 +52,13 @@ module Devise
 
       # Reset invitation token and send invitation again
       def invite!
-        if new_record? || invited?
-          @skip_password = true
-          self.skip_confirmation! if self.new_record? && self.respond_to?(:skip_confirmation!)
-          generate_invitation_token if self.invitation_token.nil?
-          self.invitation_sent_at = Time.now.utc
-          if save(:validate => self.class.validate_on_invite)
-            self.invited_by.decrement_invitation_limit! if self.invited_by
-            !!deliver_invitation unless @skip_invitation
-          end
+        was_invited = invited?
+        self.skip_confirmation! if self.new_record? && self.respond_to?(:skip_confirmation!)
+        generate_invitation_token if self.invitation_token.nil?
+        self.invitation_sent_at = Time.now.utc
+        if save(:validate => false)
+          self.invited_by.decrement_invitation_limit! if !was_invited and self.invited_by.present?
+          deliver_invitation unless @skip_invitation
         end
       end
 
@@ -67,6 +73,11 @@ module Devise
       def valid_password?(password)
         super unless invited?
       end
+      
+      def reset_password!(new_password, new_password_confirmation)
+        super
+        accept_invitation!
+      end
 
       protected
         # Overriding the method in Devise's :validatable module so password is not required on inviting
@@ -79,12 +90,6 @@ module Devise
           ::Devise.mailer.invitation_instructions(self).deliver
         end
 
-        # Clear invitation token when reset password token is cleared too
-        def clear_reset_password_token
-          self.invitation_token = nil if invited?
-          super
-        end
-
         # Checks if the invitation for the user is within the limit time.
         # We do this by calculating if the difference between today and the
         # invitation sent date does not exceed the invite for time configured.
@@ -121,24 +126,42 @@ module Devise
         # If user is found and still have pending invitation, email is resend unless
         # resend_invitation is set to false
         # Attributes must contain the user email, other attributes will be set in the record
-        def invite!(attributes={}, invited_by=nil, &block)
+        def _invite(attributes={}, invited_by=nil, &block)
           invitable = find_or_initialize_with_error_by(invite_key, attributes.delete(invite_key))
-          invitable.attributes = attributes
+          invitable.assign_attributes(attributes, :as => inviter_role(invited_by))
           invitable.invited_by = invited_by
 
+          invitable.skip_password = true
+          invitable.valid? if self.validate_on_invite
           if invitable.new_record?
-            invitable.errors.clear if invitable.email.try(:match, Devise.email_regexp)
+            invitable.errors.clear if !self.validate_on_invite and invitable.email.try(:match, Devise.email_regexp)
           else
             invitable.errors.add(invite_key, :taken) unless invitable.invited? && self.resend_invitation
           end
 
           if invitable.errors.empty?
             yield invitable if block_given?
-            invitable.invite!
+            mail = invitable.invite!
           end
+          [invitable, mail]
+        end
+        
+        # Override this method if the invitable is using Mass Assignment Security
+        # and the inviter has a non-default role.
+        def inviter_role(inviter)
+          :default
+        end
+
+        def invite!(attributes={}, invited_by=nil, &block)
+          invitable, mail = _invite(attributes, invited_by, &block)
           invitable
         end
 
+        def invite_mail!(attributes={}, invited_by=nil, &block)
+          invitable, mail = _invite(attributes, invited_by, &block)
+          mail
+        end
+
         # Attempt to find a user by it's invitation_token to set it's password.
         # If a user is found, reset it's password and automatically try saving
         # the record. If not user is found, returns a new user containing an
@@ -158,6 +181,16 @@ module Devise
         def invitation_token
           generate_token(:invitation_token)
         end
+        
+        # Callback convenience methods
+        def before_invitation_accepted(*args, &blk)
+          set_callback(:invitation_accepted, :before, *args, &blk)
+        end
+        
+        def after_invitation_accepted(*args, &blk)
+          set_callback(:invitation_accepted, :after, *args, &blk)
+        end
+        
 
         Devise::Models.config(self, :invite_for)
         Devise::Models.config(self, :validate_on_invite)
@@ -168,3 +201,4 @@ module Devise
     end
   end
 end
+

data/lib/devise_invitable/model.rb~

@@ -0,0 +1,210 @@
+module Devise
+  module Models
+    # Invitable is responsible for sending invitation emails.
+    # When an invitation is sent to an email address, an account is created for it.
+    # Invitation email contains a link allowing the user to accept the invitation
+    # by setting a password (as reset password from Devise's recoverable module).
+    #
+    # Configuration:
+    #
+    #   invite_for: The period the generated invitation token is valid, after
+    #               this period, the invited resource won't be able to accept the invitation.
+    #               When invite_for is 0 (the default), the invitation won't expire.
+    #
+    # Examples:
+    #
+    #   User.find(1).invited?                               # => true/false
+    #   User.invite!(:email => 'someone@example.com')       # => send invitation
+    #   User.accept_invitation!(:invitation_token => '...') # => accept invitation with a token
+    #   User.find(1).accept_invitation!                     # => accept invitation
+    #   User.find(1).invite!                                # => reset invitation status and send invitation again
+    module Invitable
+      extend ActiveSupport::Concern
+
+      attr_accessor :skip_invitation
+
+      included do
+        include ::DeviseInvitable::Inviter        
+        belongs_to :invited_by, :polymorphic => true
+        
+        include ActiveSupport::Callbacks
+        define_callbacks :invitation_accepted
+        
+        attr_writer :skip_password
+      end
+
+      # Accept an invitation by clearing invitation token and and setting invitation_accepted_at
+      # Confirms it if model is confirmable
+      def accept_invitation!
+        if self.invited? && self.valid?
+          run_callbacks :invitation_accepted do
+            self.invitation_token = nil
+            self.invitation_accepted_at = Time.now.utc if respond_to? :"invitation_accepted_at="
+            self.save(:validate => false)
+          end
+        end
+      end
+
+      # Verifies whether a user has been invited or not
+      def invited?
+        persisted? && invitation_token.present?
+      end
+
+      # Reset invitation token and send invitation again
+      def invite!
+        was_invited = invited?
+        self.skip_confirmation! if self.new_record? && self.respond_to?(:skip_confirmation!)
+        generate_invitation_token if self.invitation_token.nil?
+        self.invitation_sent_at = Time.now.utc
+        if save(:validate => false)
+          self.invited_by.decrement_invitation_limit! if !was_invited and self.invited_by.present?
+          deliver_invitation unless @skip_invitation
+        end
+      end
+
+      # Verify whether a invitation is active or not. If the user has been
+      # invited, we need to calculate if the invitation time has not expired
+      # for this user, in other words, if the invitation is still valid.
+      def valid_invitation?
+        invited? && invitation_period_valid?
+      end
+
+      # Only verify password when is not invited
+      def valid_password?(password)
+        super unless invited?
+      end
+=begin      
+      def reset_password!(new_password, new_password_confirmation)
+        super
+        accept_invitation!
+      end
+=end
+      protected
+        # Overriding the method in Devise's :validatable module so password is not required on inviting
+        def password_required?
+          !@skip_password && super
+        end
+
+        # Deliver the invitation email
+        def deliver_invitation
+          ::Devise.mailer.invitation_instructions(self).deliver
+        end
+
+        # Clear invitation token when reset password token is cleared too
+        def clear_reset_password_token
+          self.invitation_token = nil if invited?
+          super
+        end
+
+        # Checks if the invitation for the user is within the limit time.
+        # We do this by calculating if the difference between today and the
+        # invitation sent date does not exceed the invite for time configured.
+        # Invite_for is a model configuration, must always be an integer value.
+        #
+        # Example:
+        #
+        #   # invite_for = 1.day and invitation_sent_at = today
+        #   invitation_period_valid?   # returns true
+        #
+        #   # invite_for = 5.days and invitation_sent_at = 4.days.ago
+        #   invitation_period_valid?   # returns true
+        #
+        #   # invite_for = 5.days and invitation_sent_at = 5.days.ago
+        #   invitation_period_valid?   # returns false
+        #
+        #   # invite_for = nil
+        #   invitation_period_valid?   # will always return true
+        #
+        def invitation_period_valid?
+          invitation_sent_at && (self.class.invite_for.to_i.zero? || invitation_sent_at.utc >= self.class.invite_for.ago)
+        end
+
+        # Generates a new random token for invitation, and stores the time
+        # this token is being generated
+        def generate_invitation_token
+          self.invitation_token   = self.class.invitation_token
+        end
+
+      module ClassMethods
+        # Attempt to find a user by it's email. If a record is not found, create a new
+        # user and send invitation to it. If user is found, returns the user with an
+        # email already exists error.
+        # If user is found and still have pending invitation, email is resend unless
+        # resend_invitation is set to false
+        # Attributes must contain the user email, other attributes will be set in the record
+        def _invite(attributes={}, invited_by=nil, &block)
+          invitable = find_or_initialize_with_error_by(invite_key, attributes.delete(invite_key))
+          invitable.assign_attributes(attributes, :as => inviter_role(invited_by))
+          invitable.invited_by = invited_by
+
+          invitable.skip_password = true
+          invitable.valid? if self.validate_on_invite
+          if invitable.new_record?
+            invitable.errors.clear if !self.validate_on_invite and invitable.email.try(:match, Devise.email_regexp)
+          else
+            invitable.errors.add(invite_key, :taken) unless invitable.invited? && self.resend_invitation
+          end
+
+          if invitable.errors.empty?
+            yield invitable if block_given?
+            mail = invitable.invite!
+          end
+          [invitable, mail]
+        end
+        
+        # Override this method if the invitable is using Mass Assignment Security
+        # and the inviter has a non-default role.
+        def inviter_role(inviter)
+          :default
+        end
+
+        def invite!(attributes={}, invited_by=nil, &block)
+          invitable, mail = _invite(attributes, invited_by, &block)
+          invitable
+        end
+
+        def invite_mail!(attributes={}, invited_by=nil, &block)
+          invitable, mail = _invite(attributes, invited_by, &block)
+          mail
+        end
+
+        # Attempt to find a user by it's invitation_token to set it's password.
+        # If a user is found, reset it's password and automatically try saving
+        # the record. If not user is found, returns a new user containing an
+        # error in invitation_token attribute.
+        # Attributes must contain invitation_token, password and confirmation
+        def accept_invitation!(attributes={})
+          invitable = find_or_initialize_with_error_by(:invitation_token, attributes.delete(:invitation_token))
+          invitable.errors.add(:invitation_token, :invalid) if invitable.invitation_token && invitable.persisted? && !invitable.valid_invitation?
+          if invitable.errors.empty?
+            invitable.attributes = attributes
+            invitable.accept_invitation!
+          end
+          invitable
+        end
+
+        # Generate a token checking if one does not already exist in the database.
+        def invitation_token
+          generate_token(:invitation_token)
+        end
+        
+        # Callback convenience methods
+        def before_invitation_accepted(*args, &blk)
+          set_callback(:invitation_accepted, :before, *args, &blk)
+        end
+        
+        def after_invitation_accepted(*args, &blk)
+          set_callback(:invitation_accepted, :after, *args, &blk)
+        end
+        
+
+        Devise::Models.config(self, :invite_for)
+        Devise::Models.config(self, :validate_on_invite)
+        Devise::Models.config(self, :invitation_limit)
+        Devise::Models.config(self, :invite_key)
+        Devise::Models.config(self, :resend_invitation)
+      end
+    end
+  end
+end
+

data/lib/devise_invitable/schema.rb

@@ -16,6 +16,7 @@ module DeviseInvitable
     #   change_table :the_resources do |t|
     #     t.string   :invitation_token, :limit => 60
     #     t.datetime :invitation_sent_at
+    #     t.datetime :invitation_accepted_at
     #     t.index    :invitation_token # for invitable
     #   end
     #
@@ -26,6 +27,7 @@ module DeviseInvitable
     def invitable
       apply_devise_schema :invitation_token,   String, :limit => 60
       apply_devise_schema :invitation_sent_at, DateTime
+      apply_devise_schema :invitation_accepted_at, DateTime
       apply_devise_schema :invitation_limit, Integer
       apply_devise_schema :invited_by_id, Integer
       apply_devise_schema :invited_by_type, String

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '0.5.4'
+  VERSION = '0.6.1'
 end

data/lib/generators/active_record/templates/migration.rb

@@ -3,6 +3,7 @@ class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
     change_table :<%= table_name %> do |t|
       t.string     :invitation_token, :limit => 60
       t.datetime   :invitation_sent_at
+      t.datetime   :invitation_accepted_at
       t.integer    :invitation_limit
       t.references :invited_by, :polymorphic => true
       t.index      :invitation_token # for invitable
@@ -19,7 +20,7 @@ class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
   def self.down
     change_table :<%= table_name %> do |t|
       t.remove_references :invited_by, :polymorphic => true
-      t.remove :invitation_limit, :invitation_sent_at, :invitation_token
+      t.remove :invitation_limit, :invitation_sent_at, :invitation_accepted_at, :invitation_token
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_invitable
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 5
   prerelease: 
   segments: 
   - 0
-  - 5
-  - 4
-  version: 0.5.4
+  - 6
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-27 00:00:00 +02:00
-default_executable: 
+date: 2011-12-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
@@ -40,21 +39,14 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
         - 3
-        - 2
-        version: "3.2"
+        - 1
+        - 0
+        version: 3.1.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -63,14 +55,21 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 11
         segments: 
         - 1
         - 4
+        - 6
+        version: 1.4.6
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
         - 1
-        version: 1.4.1
+        - 6
+        version: "1.6"
   type: :runtime
   version_requirements: *id003
 description: It adds support for send invitations by email (it requires to be authenticated) and accept the invitation by setting a password.
@@ -98,6 +97,7 @@ files:
 - lib/devise_invitable/controllers/url_helpers.rb
 - lib/devise_invitable/version.rb
 - lib/devise_invitable/inviter.rb
+- lib/devise_invitable/model.rb~
 - lib/generators/active_record/devise_invitable_generator.rb
 - lib/generators/active_record/templates/migration.rb
 - lib/generators/devise_invitable/views_generator.rb
@@ -106,7 +106,6 @@ files:
 - lib/generators/mongoid/devise_invitable_generator.rb
 - LICENSE
 - README.rdoc
-has_rdoc: true
 homepage: https://github.com/scambra/devise_invitable
 licenses: []
 
@@ -142,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: An invitation strategy for Devise