devise_invitable 0.4.rc → 0.4.0

data/README.rdoc

@@ -61,7 +61,7 @@ or for a model that already exists, define a migration to add DeviseInvitable to
 
 == Model configuration
 
-DeviseInvitable adds a new configuration option:
+DeviseInvitable adds three new configuration options:
 
 * 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.
 
@@ -77,6 +77,10 @@ or directly as parameters to the <tt>devise</tt> method:
 
   devise :database_authenticatable, :confirmable, :invitable, :invite_for => 2.weeks
 
+* invitation_limit: The number of invitations users can send.  The default value of nil means users can send as many invites as they want.  A setting of 0 means they can't send invitations.  A setting n > 0 means they can send n invitations.
+
+* invite_key: The key to be used to check existing users when sending an invitation. The key must be an unique field. The default value is looking for users by email.
+
 For more details, see <tt>config/initializers/devise.rb</tt> (after you invoked the "devise_invitable:install" generator described above).
 
 == Configuring views
@@ -100,6 +104,18 @@ To send an invitation to a user, use the <tt>invite!</tt> class method. <tt>:ema
   User.invite!(:email => "new_user@example.com", :name => "John Doe")
   # => an invitation email will be sent to new_user@example.com
 
+If you want to create the invitation but not send it, you can set <tt>skip_invitation</tt> to true.
+
+  User.invite!(:email => "new_user@example.com", :name => "John Doe") do |u|
+    u.skip_invitation = true
+  end
+  # => the record will be created, but the invitation email will not be sent
+
+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
+
 === Accept an invitation
 
 To accept an invitation with a token use the <tt>accept_invitation!</tt> class method. <tt>:invitation_token</tt> must be present in the parameters hash. You can also include other attributes in the hash.
@@ -115,6 +131,8 @@ After an invitation is created and sent, the inviter will be redirected to after
 The invitation email includes a link to accept the invitation that looks like this:  <tt>/users/invitation/accept?invitation_token=abcd123</tt>. When clicked, the invited must set a password in order to accept its invitation. Note that if the invitation_token is not present or not valid, the invited is redirected to after_sign_out_path_for(resource_name).
 You can also overwrite after_sign_in_path_for and after_sign_out_path_for to customize your redirect hooks. More on {Devise's README}[http://github.com/plataformatec/devise], "Controller filters and helpers" section.
 
+The controller sets the invited_by_id attribute for the new user to the current user.  This will let you easily keep track of who invited who.
+
 == Controller filter
 
 InvitationsController uses authenticate_inviter! filter to restrict who can send invitations. You can override this method in your ApplicationController.

data/app/controllers/devise/invitations_controller.rb

@@ -2,6 +2,7 @@ class Devise::InvitationsController < ApplicationController
   include Devise::Controllers::InternalHelpers
 
   before_filter :authenticate_inviter!, :only => [:new, :create]
+  before_filter :has_invitations_left?, :only => [:create]
   before_filter :require_no_authentication, :only => [:edit, :update]
   helper_method :after_sign_in_path_for
 
@@ -13,7 +14,7 @@ class Devise::InvitationsController < ApplicationController
 
   # POST /resource/invitation
   def create
-    self.resource = resource_class.invite!(params[resource_name])
+    self.resource = resource_class.invite!(params[resource_name], current_inviter)
 
     if resource.errors.empty?
       set_flash_message :notice, :send_instructions, :email => self.resource.email
@@ -44,4 +45,17 @@ class Devise::InvitationsController < ApplicationController
       render_with_scope :edit
     end
   end
+
+  protected
+  def current_inviter
+    @current_inviter ||= authenticate_inviter!
+  end
+
+  def has_invitations_left?
+    unless current_inviter.nil? || current_inviter.has_invitations_left?
+      build_resource
+      set_flash_message :alert, :no_invitations_remaining 
+      render_with_scope :new
+    end
+  end
 end

data/config/locales/en.yml

@@ -4,6 +4,7 @@ en:
       send_instructions: 'An invitation email has been sent to %{email}.'
       invitation_token_invalid: 'The invitation token provided is not valid!'
       updated: 'Your password was set successfully. You are now signed in.'
-  mailer:
-    invitation_instructions:
-      subject: 'Invitation instructions'
+      no_invitations_remaining: "No invitations remaining"
+    mailer:
+      invitation_instructions:
+        subject: 'Invitation instructions'

data/lib/devise_invitable/controllers/helpers.rb

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

data/lib/devise_invitable/model.rb

@@ -21,6 +21,12 @@ module Devise
     module Invitable
       extend ActiveSupport::Concern
 
+      attr_accessor :skip_invitation
+
+      included do
+        belongs_to :invited_by, :polymorphic => true
+      end
+
       # Accept an invitation by clearing invitation token and confirming it if model
       # is confirmable
       def accept_invitation!
@@ -35,14 +41,30 @@ module Devise
         persisted? && invitation_token.present?
       end
 
+      # Return true if this user has invitations left to send
+      def has_invitations_left?
+        if self.class.invitation_limit.present?
+          if invitation_limit
+            return invitation_limit > 0
+          else
+            return self.class.invitation_limit > 0
+          end
+        else
+          return true
+        end
+      end
+
       # 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
-          save(:validate => false)
-          ::Devise.mailer.invitation_instructions(self).deliver
+          if save(:validate => self.class.validate_on_invite)
+            self.invited_by.decrement_invitation_limit! if self.invited_by
+            !!deliver_invitation unless @skip_invitation
+          end
         end
       end
 
@@ -53,7 +75,34 @@ module Devise
         invited? && invitation_period_valid?
       end
 
+      # Only verify password when is not invited
+      def valid_password?(password)
+        super unless invited?
+      end
+
       protected
+        def decrement_invitation_limit!
+          if self.class.invitation_limit.present?
+            self.invitation_limit ||= self.class.invitation_limit
+            self.decrement!(:invitation_limit)
+          end
+        end
+
+        # 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
@@ -89,17 +138,21 @@ module Devise
         # user and send invitation to it. If user is found, returns the user with an
         # email already exists error.
         # Attributes must contain the user email, other attributes will be set in the record
-        def invite!(attributes={})
-          invitable = find_or_initialize_with_error_by(:email, attributes.delete(:email))
+        def invite!(attributes={}, invited_by=nil, &block)
+          invitable = find_or_initialize_with_error_by(invite_key, attributes.delete(invite_key))
           invitable.attributes = attributes
+          invitable.invited_by = invited_by
 
           if invitable.new_record?
             invitable.errors.clear if invitable.email.try(:match, Devise.email_regexp)
           else
-            invitable.errors.add(:email, :taken) unless invitable.invited?
+            invitable.errors.add(invite_key, :taken) unless invitable.invited?
           end
 
-          invitable.invite! if invitable.errors.empty?
+          if invitable.errors.empty?
+            yield invitable if block_given?
+            invitable.invite!
+          end
           invitable
         end
 
@@ -124,6 +177,9 @@ module Devise
         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)
       end
     end
   end

data/lib/devise_invitable/schema.rb

@@ -26,6 +26,9 @@ module DeviseInvitable
     def invitable
       apply_devise_schema :invitation_token,   String, :limit => 60
       apply_devise_schema :invitation_sent_at, DateTime
+      apply_devise_schema :invitation_limit, Integer
+      apply_devise_schema :invited_by_id, Integer
+      apply_devise_schema :invited_by_type, String
     end
   end
 end

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '0.4.rc'
+  VERSION = '0.4.0'
 end

data/lib/devise_invitable.rb

@@ -8,9 +8,38 @@ require 'devise_invitable/controllers/helpers'
 require 'devise_invitable/rails'
 
 module Devise
-  # The period the generated invitation token is valid.
+  # Public: Validity period of the invitation token (default: 0). If 
+  # invite_for is 0 or nil, the invitation will never expire.
+  # Set invite_for in the Devise configuration file (in config/initializers/devise.rb).
+  #
+  #   config.invite_for = 2.weeks # => The invitation token will be valid 2 weeks
   mattr_accessor :invite_for
   @@invite_for = 0
+
+  # Public: Flag that force a record to be valid before being actually invited 
+  # (default: false).
+  #
+  # Examples (in config/initializers/devise.rb)
+  #
+  #   config.validate_on_invite = true
+  mattr_accessor :validate_on_invite
+  @@validate_on_invite = false
+
+  # Public: number of invitations the user is allowed to send
+  #
+  # Examples (in config/initializers/devise.rb)
+  #
+  #   config.invitation_limit = nil
+  mattr_accessor :invitation_limit
+  @@invitation_limit = nil
+  
+  # Public: The key to be used to check existing users when sending an invitation
+  #
+  # Examples (in config/initializers/devise.rb)
+  #
+  #   config.invite_key = :email
+  mattr_accessor :invite_key
+  @@invite_key = :email
 end
 
 Devise.add_module :invitable, :controller => :invitations, :model => 'devise_invitable/model', :route => :invitation

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

@@ -1,9 +1,12 @@
 class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
   def self.up
     change_table :<%= table_name %> do |t|
-      t.string   :invitation_token, :limit => 60
-      t.datetime :invitation_sent_at
-      t.index    :invitation_token # for invitable
+      t.string     :invitation_token, :limit => 60
+      t.datetime   :invitation_sent_at
+      t.integer    :invitation_limit
+      t.references :invited_by, :polymorphic => true
+      t.index      :invitation_token # for invitable
+      t.index      :invited_by_id
     end
     
     # And allow null encrypted_password and password_salt:
@@ -14,7 +17,9 @@ class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
   end
   
   def self.down
-    remove_column :<%= table_name %>, :invitation_sent_at
-    remove_column :<%= table_name %>, :invitation_token
+    change_table :<%= table_name %> do |t|
+      remove_references :invited_by, :polymorphic => true
+      remove :invitation_limit, :invitation_sent_at, :invitation_token
+    end
   end
 end

data/lib/generators/devise_invitable/install_generator.rb

@@ -24,6 +24,16 @@ module DeviseInvitable
   # When invite_for is 0 (the default), the invitation won't expire.
   # config.invite_for = 2.weeks
   
+  # Number of invitations users can send.
+  # If invitation_limit is nil, users can send unlimited invitations.
+  # If invitation_limit is 0, users can't send invitations.
+  # If invitation_limit n > 0, users can send n invitations.
+  # Default: nil
+  # config.invitation_limit = 5
+  
+  # The key to be used to check existing users when sending an invitation
+  # config.invite_key = :email
+  
 CONTENT
             end
           end

data/lib/generators/mongoid/devise_invitable_generator.rb

@@ -0,0 +1,8 @@
+require 'generators/devise/orm_helpers'
+
+module Mongoid
+  module Generators
+    class DeviseInvitableGenerator < Rails::Generators::NamedBase
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_invitable
 version: !ruby/object:Gem::Version 
-  hash: 7712090
-  prerelease: true
+  hash: 15
+  prerelease: 
   segments: 
   - 0
   - 4
-  - rc
-  version: 0.4.rc
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -15,47 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-06 00:00:00 +01:00
+date: 2011-03-31 00:00:00 +02:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec-rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 1
-        - 0
-        version: 2.1.0
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: steak
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15424051
-        segments: 
-        - 1
-        - 0
-        - 0
-        - rc
-        - 3
-        version: 1.0.0.rc.3
-  type: :development
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: bundler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -67,11 +33,11 @@ dependencies:
         - 7
         version: 1.0.7
   type: :development
-  version_requirements: *id003
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rails
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -83,23 +49,23 @@ dependencies:
         - 0
         version: 3.0.0
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: devise
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7712074
+        hash: 31
         segments: 
         - 1
         - 2
-        - rc
-        version: 1.2.rc
+        - 0
+        version: 1.2.0
   type: :runtime
-  version_requirements: *id005
+  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.
 email: 
 - sergio@entrecables.com
@@ -110,32 +76,30 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- app/controllers/devise/invitations_controller.rb
 - app/views/devise/invitations/edit.html.erb
 - app/views/devise/invitations/new.html.erb
 - app/views/devise/mailer/invitation_instructions.html.erb
-- app/views/devise/mailer/invitation.html.erb
-- app/controllers/devise/invitations_controller.rb~
-- app/controllers/devise/invitations_controller.rb
 - config/locales/en.yml
-- lib/devise_invitable/rails.rb
-- lib/devise_invitable/schema.rb
+- lib/devise_invitable.rb
 - lib/devise_invitable/mailer.rb
-- lib/devise_invitable/routes.rb
-- lib/devise_invitable/version.rb
 - lib/devise_invitable/model.rb
-- lib/devise_invitable/model.rb~
+- lib/devise_invitable/rails.rb
+- lib/devise_invitable/routes.rb
+- lib/devise_invitable/schema.rb
 - lib/devise_invitable/controllers/helpers.rb
 - lib/devise_invitable/controllers/url_helpers.rb
-- lib/devise_invitable.rb
+- lib/devise_invitable/version.rb
+- lib/generators/active_record/devise_invitable_generator.rb
+- lib/generators/active_record/templates/migration.rb
 - lib/generators/devise_invitable/views_generator.rb
 - lib/generators/devise_invitable/devise_invitable_generator.rb
 - lib/generators/devise_invitable/install_generator.rb
-- lib/generators/active_record/devise_invitable_generator.rb
-- lib/generators/active_record/templates/migration.rb
+- lib/generators/mongoid/devise_invitable_generator.rb
 - LICENSE
 - README.rdoc
 has_rdoc: true
-homepage: http://github.com/rymai/devise_invitable
+homepage: https://github.com/scambra/devise_invitable
 licenses: []
 
 post_install_message: 
@@ -159,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ~>
+  - - ">="
     - !ruby/object:Gem::Version 
       hash: 23
       segments: 
@@ -170,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: An invitation strategy for Devise

data/app/controllers/devise/invitations_controller.rb~

@@ -1,48 +0,0 @@
-class Devise::InvitationsController < ApplicationController
-  include Devise::Controllers::InternalHelpers
-
-  before_filter :authenticate_inviter!, :only => [:new, :create]
-  before_filter :require_no_authentication, :only => [:edit, :update]
-  helper_method :after_sign_in_path_for
-
-  # GET /resource/invitation/new
-  def new
-    build_resource
-    render_with_scope :new
-  end
-
-  # POST /resource/invitation
-  def create
-    self.resource = resource_class.invite!(params[resource_name])
-
-    if resource.errors.empty?
-      puts params.inspect
-      set_flash_message :notice, :send_instructions, :email => self.resource.email
-      redirect_to after_sign_in_path_for(resource_name)
-    else
-      render_with_scope :new
-    end
-  end
-
-  # GET /resource/invitation/accept?invitation_token=abcdef
-  def edit
-    if params[:invitation_token] && self.resource = resource_class.first(:conditions => { :invitation_token => params[:invitation_token] })
-      render_with_scope :edit
-    else
-      set_flash_message(:alert, :invitation_token_invalid)
-      redirect_to after_sign_out_path_for(resource_name)
-    end
-  end
-
-  # PUT /resource/invitation
-  def update
-    self.resource = resource_class.accept_invitation!(params[resource_name])
-
-    if resource.errors.empty?
-      set_flash_message :notice, :updated
-      sign_in_and_redirect(resource_name, resource)
-    else
-      render_with_scope :edit
-    end
-  end
-end

data/app/views/devise/mailer/invitation.html.erb

@@ -1,8 +0,0 @@
-<p>Hello <%= @resource.email %>!</p>
-
-<p>Someone has invited you to <%= root_url %>, you can accept it through the link below.</p>
-
-<p><%= link_to 'Accept invitation', accept_invitation_url(@resource, :invitation_token => @resource.invitation_token) %></p>
-
-<p>If you don't want to accept the invitation, please ignore this email.<br />
-Your account won't be created until you access the link above and set your password.</p>

data/lib/devise_invitable/model.rb~

@@ -1,129 +0,0 @@
-module Devise
-  module Models
-    # Invitable is responsible to send emails with invitations.
-    # When an invitation is sent to an email, an account is created for it.
-    # An invitation has a link to set the password, as reset password from recoverable.
-    #
-    # Configuration:
-    #
-    #   invite_for: the time you want the user will have to confirm the account after
-    #               is invited. When invite_for is zero, the invitation won't expire.
-    #               By default invite_for is 0.
-    #
-    # 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
-
-      # Accept an invitation by clearing invitation token and confirming it if model
-      # is confirmable
-      def accept_invitation!
-        if self.invited?
-          self.invitation_token = nil
-          self.save
-        end
-      end
-
-      # Verifies whether a user has been invited or not
-      def invited?
-        persisted? && invitation_token.present?
-      end
-
-      # Send invitation by email
-      def send_invitation
-        ::Devise.mailer.invitation(self).deliver
-      end
-
-      # Reset invitation token and send invitation again
-      def invite!
-        if new_record? || invited?
-          self.skip_confirmation! if self.new_record? and self.respond_to? :skip_confirmation!
-          generate_invitation_token
-          save(:validate=>false)
-          send_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
-
-      protected
-
-        # 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 = Devise.friendly_token
-          self.invitation_sent_at = Time.now.utc
-        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.
-        # Attributes must contain the user email, other attributes will be set in the record
-        def invite!(attributes={})
-          invitable = find_or_initialize_with_error_by(:email, attributes.delete(:email))
-          invitable.attributes = attributes
-
-          if invitable.new_record?
-            invitable.errors.clear if invitable.email.try(:match, Devise.email_regexp)
-          else
-            invitable.errors.add(:email, :taken) unless invitable.invited?
-          end
-
-          invitable.invite! if invitable.errors.empty?
-          invitable
-        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 attributes[:invitation_token] && !invitable.new_record? && !invitable.valid_invitation?
-          if invitable.errors.empty?
-            invitable.attributes = attributes
-            invitable.accept_invitation!
-          end
-          invitable
-        end
-
-        Devise::Models.config(self, :invite_for)
-      end
-    end
-  end
-end