devise_invitable 1.1.6 → 1.1.8

data/README.rdoc

@@ -32,12 +32,14 @@ Replace MODEL by the class name you want to add DeviseInvitable, like User, Admi
 
 Follow the walkthrough for Devise and after it's done, follow this walkthrough.
 
+== Devise Configuration
 Add :invitable to the <tt>devise</tt> call in your model (we’re assuming here you already have a User model with some Devise modules):
 
   class User < ActiveRecord::Base
     devise :database_authenticatable, :confirmable, :invitable
   end
 
+== ActiveRecord Migration
 Add t.invitable to your Devise model migration:
 
   create_table :users do
@@ -67,6 +69,25 @@ or for a model that already exists, define a migration to add DeviseInvitable to
 
   # Allow null encrypted_password
   change_column :users, :encrypted_password, :string, :null => true
+  # Allow null password_salt (add it if you are using Devise's encryptable module)
+  change_column :users, :password_salt, :string, :null => true
+
+== Mongoid Field Definitions
+If you are using Mongoid, define the following fields and indexes within your invitable model:
+
+  field :invitation_token, type: String
+  field :invitation_sent_at, type: Time
+  field :invitation_accepted_at, type: Time
+  field :invitation_limit, type: Integer
+
+  index( {invitation_token: 1}, {:background => true} )
+  index( {invitation_by_id: 1}, {:background => true} )
+
+You do not need to define a belongs_to relationship, as DeviseInvitable does this on your behalf:
+  belongs_to :invited_by, :polymorphic => true
+
+Remember to create indexes within the MongoDB database after deploying your changes.
+  rake db:mongoid:create_indexes
 
 == Model configuration
 
@@ -148,11 +169,21 @@ If you want to create the invitation but not send it, you can set <tt>skip_invit
   end
   # => the record will be created, but the invitation email will not be sent
 
+When skip_invitation is used, you must also then set the invitation_sent_at field when the user is sent their 
+token. Failure to do so will yield "Invalid invitation token" errors when the user attempts to accept the invite.
+You can set it like so:
+
+  user.invitation_sent_at = Time.now.utc
+  user.save!
+
 You can add :skip_invitation to attributes hash if skip_invitation is added to attr_accessible.
 
   User.invite!(:email => "new_user@example.com", :name => "John Doe", :skip_invitation => true)
   # => the record will be created, but the invitation email will not be sent
 
+Skip_invitation skips sending the email, but sets invitation_token, so invited_to_sign_up? on the
+resulting user returns true.
+
 You can send an invitation to an existing user if your workflow creates them separately:
 
   user = User.find(42)

data/app/controllers/devise/invitations_controller.rb

@@ -1,8 +1,9 @@
 class Devise::InvitationsController < DeviseController
 
-  before_filter :authenticate_inviter!, :only => [:new, :create]
-  before_filter :has_invitations_left?, :only => [:create]
-  before_filter :require_no_authentication, :only => [:edit, :update]
+  prepend_before_filter :authenticate_inviter!, :only => [:new, :create]
+  prepend_before_filter :has_invitations_left?, :only => [:create]
+  prepend_before_filter :require_no_authentication, :only => [:edit, :update, :destroy]
+  prepend_before_filter :resource_from_invitation_token, :only => [:edit, :destroy]
   helper_method :after_sign_in_path_for
 
   # GET /resource/invitation/new
@@ -25,12 +26,7 @@ class Devise::InvitationsController < DeviseController
 
   # GET /resource/invitation/accept?invitation_token=abcdef
   def edit
-    if params[:invitation_token] && self.resource = resource_class.to_adapter.find_first( :invitation_token => params[:invitation_token] )
-      render :edit
-    else
-      set_flash_message(:alert, :invitation_token_invalid)
-      redirect_to after_sign_out_path_for(resource_name)
-    end
+    render :edit
   end
 
   # PUT /resource/invitation
@@ -46,6 +42,13 @@ class Devise::InvitationsController < DeviseController
       respond_with_navigational(resource){ render :edit }
     end
   end
+  
+  # GET /resource/invitation/remove?invitation_token=abcdef
+  def destroy
+    resource.destroy
+    set_flash_message :notice, :invitation_removed
+    redirect_to after_sign_out_path_for(resource_name)
+  end
 
   protected
   def current_inviter
@@ -59,5 +62,13 @@ class Devise::InvitationsController < DeviseController
       respond_with_navigational(resource) { render :new }
     end
   end
+  
+  def resource_from_invitation_token
+    unless params[:invitation_token] && self.resource = resource_class.to_adapter.find_first(params.slice(:invitation_token))
+      set_flash_message(:alert, :invitation_token_invalid)
+      redirect_to after_sign_out_path_for(resource_name)
+    end
+  end
+  
 end
 

data/app/controllers/devise_invitable/registrations_controller.rb

@@ -7,7 +7,7 @@ class DeviseInvitable::RegistrationsController < Devise::RegistrationsController
       self.resource = resource_class.where(:email => hash[:email], :encrypted_password => '').first
       if self.resource
         self.resource.attributes = hash
-        self.resource.accept_invitation!
+        self.resource.accept_invitation
       end
     end
     self.resource ||= super

data/config/locales/en.yml

@@ -5,6 +5,7 @@ en:
       invitation_token_invalid: 'The invitation token provided is not valid!'
       updated: 'Your password was set successfully. You are now signed in.'
       no_invitations_remaining: "No invitations remaining"
+      invitation_removed: 'Your invitation was removed.'
       new:
         header: "Send invitation"
         submit_button: "Send an invitation"

data/lib/devise_invitable/model.rb

@@ -36,13 +36,17 @@ module Devise
 
         include ActiveSupport::Callbacks
         define_callbacks :invitation_accepted
+        before_update :generate_confirmation_token, :if => :confirmation_required_for_invited?
+        after_update :send_on_create_confirmation_instructions, :if => :confirmation_required_for_invited?
 
         attr_writer :skip_password
 
-        scope :invitation_not_accepted, lambda { where(:invitation_accepted_at => nil) }
+        scope :active, lambda { where(:invitation_token => nil) }
         if defined?(Mongoid) && self < Mongoid::Document
+          scope :invitation_not_accepted, lambda { where(:invitation_accepted_at => nil, :invitation_token.ne => nil) }
           scope :invitation_accepted, lambda { where(:invitation_accepted_at.ne => nil) }
         else
+          scope :invitation_not_accepted, lambda { where(arel_table[:invitation_token].not_eq(nil)).where(:invitation_accepted_at => nil) }
           scope :invitation_accepted, lambda { where(arel_table[:invitation_accepted_at].not_eq(nil)) }
 
           [:before_invitation_accepted, :after_invitation_accepted].each do |callback_method|
@@ -71,12 +75,17 @@ module Devise
       end
 
       # Accept an invitation by clearing invitation token and and setting invitation_accepted_at
-      # Confirms it if model is confirmable
+      def accept_invitation
+        self.invitation_accepted_at = Time.now.utc
+        self.invitation_token = nil
+      end
+
+      # Accept an invitation by clearing invitation token and and setting invitation_accepted_at
+      # Saves the model and confirms it if model is confirmable, running invitation_accepted callbacks
       def accept_invitation!
         if self.invited_to_sign_up? && self.valid?
-          self.invitation_accepted_at = Time.now.utc
           run_callbacks :invitation_accepted do
-            self.invitation_token = nil
+            self.accept_invitation
             self.confirmed_at = self.invitation_accepted_at if self.respond_to?(:confirmed_at)
             self.save(:validate => false)
           end
@@ -115,17 +124,17 @@ module Devise
 
         # Required to workaround confirmable model's confirmation_required? method
         # being implemented to check for non-nil value of confirmed_at
-        if self.new_record? && self.respond_to?(:confirmation_required?)
+        if self.new_record? && self.respond_to?(:confirmation_required?, true)
           def self.confirmation_required?; false; end
         end
 
         generate_invitation_token if self.invitation_token.nil?
-        self.invitation_sent_at = Time.now.utc
+        self.invitation_sent_at = Time.now.utc unless @skip_invitation
         self.invited_by = invited_by if invited_by
 
         # Call these before_validate methods since we aren't validating on save
-        self.downcase_keys if self.new_record? && self.respond_to?(:downcase_keys)
-        self.strip_whitespace if self.new_record? && self.respond_to?(:strip_whitespace)
+        self.downcase_keys if self.new_record? && self.respond_to?(:downcase_keys, true)
+        self.strip_whitespace if self.new_record? && self.respond_to?(:strip_whitespace, true)
 
         if save(:validate => false)
           self.invited_by.decrement_invitation_limit! if !was_invited and self.invited_by.present?
@@ -163,6 +172,10 @@ module Devise
           !@skip_password && super
         end
 
+        def confirmation_required_for_invited?
+          respond_to?(:confirmation_required?, true) && confirmation_required? && invitation_accepted?
+        end
+
         # Deliver the invitation email
         def deliver_invitation
           send_devise_notification(:invitation_instructions)

data/lib/devise_invitable/routes.rb

@@ -6,6 +6,7 @@ module ActionDispatch::Routing
       resource :invitation, :only => [:new, :create, :update],
         :path => mapping.path_names[:invitation], :controller => controllers[:invitations] do
         get :edit, :path => mapping.path_names[:accept], :as => :accept
+        get :destroy, :path => mapping.path_names[:remove], :as => :remove
       end
     end
 

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '1.1.6'
+  VERSION = '1.1.8'
 end

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

@@ -6,7 +6,7 @@ class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
       t.datetime   :invitation_accepted_at
       t.integer    :invitation_limit
       t.references :invited_by, :polymorphic => true
-      t.index      :invitation_token # for invitable
+      t.index      :invitation_token, :unique => true # for invitable
       t.index      :invited_by_id
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_invitable
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 3
   prerelease: 
   segments: 
   - 1
   - 1
-  - 6
-  version: 1.1.6
+  - 8
+  version: 1.1.8
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-21 00:00:00 Z
+date: 2013-05-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
@@ -34,23 +34,22 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: devise
+  name: railties
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 7
         segments: 
-        - 2
-        - 1
-        - 2
-        version: 2.1.2
+        - 3
+        - 0
+        version: "3.0"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: railties
+  name: actionmailer
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -65,18 +64,19 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: actionmailer
+  name: devise
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 15
         segments: 
-        - 3
-        - 0
-        version: "3.0"
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
   type: :runtime
   version_requirements: *id004
 description: It adds support for send invitations by email (it requires to be authenticated) and accept the invitation by setting a password.
@@ -162,3 +162,4 @@ specification_version: 3
 summary: An invitation strategy for Devise
 test_files: []
 
+has_rdoc: