devise_invitable 1.3.2 → 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49059f27df2618f9c0491fd1b7578b33619f2ef5
+  data.tar.gz: da0b1ff3962cba2784b8c082c013fb483ee0517e
+SHA512:
+  metadata.gz: 56e5cc31bd011a67887ea3338ee66682dc398008f4a18f094fec9084b0635efc8684d5251aca72a9d7daecf228ea06aeec84bca49a8dd24bd3750c063f7b2e56
+  data.tar.gz: 162bc6c70f81f0b65ca73233a5ebb5ac53895b5e6c57f4085d522807592feccb29ce93c113e1d67d974fa95ebf026054d137a6a5c01c1af3913bf84df14d2f7a

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 1.4.0
+Override active_for_authentication? and inactive_message instead of valid_password?
+To use counter_cache, invited_by_counter_cache must be set, no more checking of invitations_count to enable counter cache
+
 = 1.3.0
 Now devise 3.1 compatible, @token must be used instead of @resource.invitation_token in mail views
 

data/README.rdoc

@@ -1,7 +1,7 @@
 = DeviseInvitable
 {<img src="https://travis-ci.org/scambra/devise_invitable.png"/>}[http://travis-ci.org/scambra/devise_invitable]
 
-It adds support to devise[http://github.com/plataformatec/devise] for send invitations by email (it requires to be authenticated) and accept the invitation setting the password.
+It adds support to devise[http://github.com/plataformatec/devise] for sending invitations by email (it requires to be authenticated) and accept the invitation setting the password.
 
 DeviseInvitable currently supports Rails 3 and 4, if you want to use it with Rails 2.3 you must install version {0.2.3}[http://rubygems.org/gems/devise_invitable/versions/0.2.3]
 
@@ -16,7 +16,7 @@ Install DeviseInvitable gem, it will also install dependencies (such as devise a
 Add DeviseInvitable to your Gemfile (and Devise if you weren't using them):
 
   gem 'devise',           '>= 2.0.0'
-  gem 'devise_invitable', '~> 1.1.0'
+  gem 'devise_invitable', '~> 1.3.4'
 
 === Automatic installation
 
@@ -172,6 +172,30 @@ be sure that you generate the views and put them into the controller that you ge
 
   rails generate devise_invitable:views users/invitations
 
+To change behaviour of inviting or accepting users, you can simply override two methods:
+
+  class Users::InvitationsController < Devise::InvitationsController
+    private
+
+    # this is called when creating invitation
+    # should return an instance of resource class
+    def invite_resource
+      ## skip sending emails on invite
+      resource_class.invite!(invite_params, current_inviter) do |u|
+        u.skip_invitation = true
+      end
+    end
+
+    # this is called when accepting invitation
+    # should return an instance of resource class
+    def accept_resource
+      resource = resource_class.accept_invitation!(update_resource_params)
+      ## Report accepting invitation to analytics
+      Analytics.report('invite.accept', resource.id)
+      resource
+    end
+  end
+
 == Strong Parameters
 
 When you customize your own views, you may end up adding new attributes to forms. Rails 4 moved the parameter sanitization from the model to the controller, causing DeviseInvitable to handle this concern at the controller as well. Read about it in {devise README}[http://github.com/plataformatec/devise#strong-parameters]
@@ -209,11 +233,16 @@ To send an invitation to a user, use the <tt>invite!</tt> class method. <tt>:ema
 
 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|
+  user = 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
 
+When generating the <tt>accept_user_invitation_url</tt> yourself, you must use the <tt>raw_invitation_token</tt>
+the value is temporarily available when you invite a user and will be decrypted when recieved.
+
+  accept_user_invitation_url(:invitation_token => user.raw_invitation_token)
+
 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:
@@ -228,6 +257,11 @@ You can add :skip_invitation to attributes hash if skip_invitation is added to a
 Skip_invitation skips sending the email, but sets invitation_token, so invited_to_sign_up? on the
 resulting user returns true.
 
+**Warning**
+
+When using skip_invitation you must send the email with the user object instance that generated the tokens, as 
+user.raw_invitation_token is available only to the instance and is not persisted in the database.
+
 You can send an invitation to an existing user if your workflow creates them separately:
 
   user = User.find(42)
@@ -237,6 +271,8 @@ You can also set <tt>invited_by</tt> when using the <tt>invite!</tt> class metho
 
   User.invite!({:email => "new_user@example.com"}, current_user) # current_user will be set as invited_by
 
+
+
 === 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.
@@ -345,6 +381,12 @@ Take a look at the generated locale file (in <tt>config/locales/devise_invitable
 
 DeviseInvitable supports ActiveRecord and Mongoid, like Devise.
 
+== Wiki
+
+It's possible to find additional information about DeviseInvitable on the Wiki:
+
+https://github.com/scambra/devise_invitable/wiki
+
 == Testing
 
 To test DeviseInvitable for the ActiveRecord ORM with RVM, Ruby 1.9.2, and Rubygems 1.8.17:

data/app/controllers/devise/invitations_controller.rb

@@ -17,7 +17,10 @@ class Devise::InvitationsController < DeviseController
     self.resource = invite_resource
 
     if resource.errors.empty?
-      set_flash_message :notice, :send_instructions, :email => self.resource.email if self.resource.invitation_sent_at
+      yield resource if block_given?
+      if is_flashing_format? && self.resource.invitation_sent_at
+        set_flash_message :notice, :send_instructions, :email => self.resource.email
+      end
       respond_with resource, :location => after_invite_path_for(resource)
     else
       respond_with_navigational(resource) { render :new }
@@ -32,46 +35,51 @@ class Devise::InvitationsController < DeviseController
 
   # PUT /resource/invitation
   def update
-    self.resource = resource_class.accept_invitation!(update_resource_params)
+    self.resource = accept_resource
 
     if resource.errors.empty?
-      flash_message = resource.active_for_authentication? ? :updated : :updated_not_active                                                                                        
-      set_flash_message :notice, flash_message
+      yield resource if block_given?
+      flash_message = resource.active_for_authentication? ? :updated : :updated_not_active
+      set_flash_message :notice, flash_message if is_flashing_format?
       sign_in(resource_name, resource)
       respond_with resource, :location => after_accept_path_for(resource)
     else
       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
+    set_flash_message :notice, :invitation_removed if is_flashing_format?
     redirect_to after_sign_out_path_for(resource_name)
   end
 
   protected
 
-  def invite_resource
-    resource_class.invite!(invite_params, current_inviter)
+  def invite_resource(&block)
+    resource_class.invite!(invite_params, current_inviter, &block)
+  end
+
+  def accept_resource
+    resource_class.accept_invitation!(update_resource_params)
   end
 
   def current_inviter
-    @current_inviter ||= authenticate_inviter!
+    authenticate_inviter!
   end
 
   def has_invitations_left?
     unless current_inviter.nil? || current_inviter.has_invitations_left?
       self.resource = resource_class.new
-      set_flash_message :alert, :no_invitations_remaining
+      set_flash_message :alert, :no_invitations_remaining if is_flashing_format?
       respond_with_navigational(resource) { render :new }
     end
   end
-  
+
   def resource_from_invitation_token
     unless params[:invitation_token] && self.resource = resource_class.find_by_invitation_token(params[:invitation_token], true)
-      set_flash_message(:alert, :invitation_token_invalid)
+      set_flash_message(:alert, :invitation_token_invalid) if is_flashing_format?
       redirect_to after_sign_out_path_for(resource_name)
     end
   end
@@ -83,6 +91,6 @@ class Devise::InvitationsController < DeviseController
   def update_resource_params
     devise_parameter_sanitizer.sanitize(:accept_invitation)
   end
-  
+
 end
 

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

@@ -1,8 +1,7 @@
-<p>Hello <%= @resource.email %>!</p>
+<p><%= t("devise.mailer.invitation_instructions.hello", email: @resource.email) %></p>
 
-<p>Someone has invited you to <%= root_url %>, you can accept it through the link below.</p>
+<p><%= t("devise.mailer.invitation_instructions.someone_invited_you", url: root_url) %></p>
 
-<p><%= link_to 'Accept invitation', accept_invitation_url(@resource, :invitation_token => @token) %></p>
+<p><%= link_to t("devise.mailer.invitation_instructions.accept"), accept_invitation_url(@resource, :invitation_token => @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>
+<p><%= t("devise.mailer.invitation_instructions.ignore").html_safe %></p>

data/config/locales/en.yml

@@ -1,5 +1,7 @@
 en:
   devise:
+    failure:
+      invited: 'You have a pending invitation, accept it to finish creating your account.'
     invitations:
       send_instructions: 'An invitation email has been sent to %{email}.'
       invitation_token_invalid: 'The invitation token provided is not valid!'
@@ -15,3 +17,7 @@ en:
     mailer:
       invitation_instructions:
         subject: 'Invitation instructions'
+        hello: 'Hello %{email}'
+        someone_invited_you: 'Someone has invited you to %{url}, you can accept it through the link below.'
+        accept: 'Accept invitation'
+        ignore: "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."

data/lib/devise_invitable/model.rb

@@ -29,18 +29,23 @@ module Devise
 
       included do
         include ::DeviseInvitable::Inviter
-        if Devise.invited_by_class_name
-          belongs_to :invited_by, :class_name => Devise.invited_by_class_name
+        belongs_to_options = if Devise.invited_by_class_name
+          {:class_name => Devise.invited_by_class_name}
         else
-          belongs_to :invited_by, :polymorphic => true
+          {:polymorphic => true}
         end
+        if defined?(ActiveRecord) && defined?(ActiveRecord::Base) && self < ActiveRecord::Base
+          counter_cache = Devise.invited_by_counter_cache
+          belongs_to_options.merge! :counter_cache => counter_cache if counter_cache
+        end
+        belongs_to :invited_by, belongs_to_options
 
         include ActiveSupport::Callbacks
         define_callbacks :invitation_accepted
 
         attr_writer :skip_password
 
-        scope :active, lambda { where(:invitation_token => nil) }
+        scope :no_active_invitation, lambda { where(:invitation_token => nil) }
         if defined?(Mongoid) && defined?(Mongoid::Document) && 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) }
@@ -57,9 +62,8 @@ module Devise
       def self.required_fields(klass)
         fields = [:invitation_token, :invitation_created_at, :invitation_sent_at, :invitation_accepted_at,
          :invitation_limit, :invited_by_id, :invited_by_type]
-        if Devise.invited_by_class_name
-          fields -= [:invited_by_type]
-        end
+        fields << :invitations_count if defined?(ActiveRecord) && self < ActiveRecord::Base
+        fields -= [:invited_by_type] if Devise.invited_by_class_name
         fields
       end
 
@@ -81,12 +85,6 @@ module Devise
         end
       end
 
-      # Verifies whether a user has accepted an invitation (or is accepting it), or was never invited
-      def accepting_or_not_invited?
-        ActiveSupport::Deprecation.warn "accepting_or_not_invited? is deprecated and will be removed from DeviseInvitable 1.1.0 (use accepted_or_not_invited? instead)"
-        accepted_or_not_invited?
-      end
-
       # Verifies whether a user has been invited or not
       def invited_to_sign_up?
         persisted? && invitation_token.present?
@@ -112,7 +110,8 @@ module Devise
           def self.confirmation_required?; false; end
         end
 
-        generate_invitation_token if self.invitation_token.nil? || (!@skip_invitation && @raw_invitation_token.nil?)
+        yield self if block_given?
+        generate_invitation_token if self.invitation_token.nil? || (!@skip_invitation || @raw_invitation_token.nil?)
         self.invitation_created_at = Time.now.utc
         self.invitation_sent_at = self.invitation_created_at unless @skip_invitation
         self.invited_by = invited_by if invited_by
@@ -135,10 +134,14 @@ module Devise
       end
 
       # Only verify password when is not invited
-      def valid_password?(password)
+      def active_for_authentication?
         super unless invited_to_sign_up?
       end
 
+      def inactive_message
+        invited_to_sign_up? ? :invited : super
+      end
+
       def after_password_reset
         super
         accept_invitation! if invited_to_sign_up?
@@ -172,7 +175,7 @@ module Devise
           !@skip_password && 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.
@@ -279,19 +282,11 @@ module Devise
           invitation_token = Devise.token_generator.digest(self, :invitation_token, original_token)
 
           invitable = find_or_initialize_with_error_by(:invitation_token, invitation_token)
-          if !invitable.persisted? && Devise.allow_insecure_token_lookup
-            invitable = find_or_initialize_with_error_by(:invitation_token, original_token)
-          end
           invitable.errors.add(:invitation_token, :invalid) if invitable.invitation_token && invitable.persisted? && !invitable.valid_invitation?
           invitable.invitation_token = original_token
           invitable unless only_valid && invitable.errors.present?
         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)

data/lib/devise_invitable/rails.rb

@@ -7,12 +7,14 @@ module DeviseInvitable
 
     # We use to_prepare instead of after_initialize here because Devise is a Rails engine; its
     # mailer is reloaded like the rest of the user's app.  Got to make sure that our mailer methods
-    # are included each time Devise::Mailer is (re)loaded.
+    # are included each time Devise.mailer is (re)loaded.
     config.to_prepare do
-      require 'devise/mailer'
-      Devise::Mailer.send :include, DeviseInvitable::Mailer
+      Devise.mailer.send :include, DeviseInvitable::Mailer
+      unless Devise.mailer.ancestors.include?(Devise::Mailers::Helpers)
+        Devise.mailer.send :include, Devise::Mailers::Helpers 
+      end
     end
-    # extend mapping with after_initialize becuase is not reloaded
+    # extend mapping with after_initialize because it's not reloaded
     config.after_initialize do
       Devise::Mapping.send :include, DeviseInvitable::Mapping
       Devise::ParameterSanitizer.send :include, DeviseInvitable::ParameterSanitizer

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '1.3.2'
+  VERSION = '1.4.0'
 end

data/lib/devise_invitable.rb

@@ -61,6 +61,11 @@ module Devise
   # the #invited_by association is declared to be polymorphic. (default: nil)
   mattr_accessor :invited_by_class_name
   @@invited_by_class_name = nil
+
+  # Public: The column name used for counter_cache column. If this is nil,
+  # the #invited_by association is declared without counter_cache. (default: nil)
+  mattr_accessor :invited_by_counter_cache
+  @@invited_by_counter_cache = nil
 end
 
 Devise.add_module :invitable, :controller => :invitations, :model => 'devise_invitable/model', :route => {:invitation => [nil, :new, :accept]}

data/lib/generators/active_record/devise_invitable_generator.rb

@@ -6,7 +6,7 @@ module ActiveRecord
       source_root File.expand_path("../templates", __FILE__)
 
       def copy_devise_migration
-        migration_template "migration.rb", "db/migrate/devise_invitable_add_to_#{table_name}"
+        migration_template "migration.rb", "db/migrate/devise_invitable_add_to_#{table_name}.rb"
       end
     end
   end

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

@@ -7,6 +7,8 @@ class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
       t.datetime   :invitation_accepted_at
       t.integer    :invitation_limit
       t.references :invited_by, :polymorphic => true
+      t.integer    :invitations_count, default: 0
+      t.index      :invitations_count
       t.index      :invitation_token, :unique => true # for invitable
       t.index      :invited_by_id
     end
@@ -21,7 +23,11 @@ class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
   def down
     change_table :<%= table_name %> do |t|
       t.remove_references :invited_by, :polymorphic => true
-      t.remove :invitation_limit, :invitation_sent_at, :invitation_accepted_at, :invitation_token, :invitation_created_at
+      t.remove :invitations_count, :invitation_limit, :invitation_sent_at, :invitation_accepted_at, :invitation_token, :invitation_created_at
     end
+    change_column_null    :<%= table_name %>, :encrypted_password, false
+<% if class_name.constantize.columns_hash['password_salt'] -%>
+    change_column_null :<%= table_name %>, :password_salt,false
+<% end -%>
   end
 end

data/lib/generators/devise_invitable/install_generator.rb

@@ -43,6 +43,20 @@ module DeviseInvitable
   # Default: false
   # config.validate_on_invite = true
 
+  # Resend invitation if user with invited status is invited again
+  # Default: true
+  # config.resend_invitation = false
+
+  # The class name of the inviting model. If this is nil,
+  # the #invited_by association is declared to be polymorphic.
+  # Default: nil
+  # config.invited_by_class_name = 'User'
+
+  # The column name used for counter_cache column. If this is nil,
+  # the #invited_by association is declared without counter_cache.
+  # Default: nil
+  # config.invited_by_counter_cache = :invitations_count
+
 CONTENT
             end
           end

data/lib/generators/devise_invitable/templates/simple_form_for/invitations/edit.html.erb

@@ -7,5 +7,5 @@
   <%= f.input :password %>
   <%= f.input :password_confirmation %>
 
-  <%= f.submit t("devise.invitations.edit.submit_button") %>
+  <%= f.button :submit, t("devise.invitations.edit.submit_button") %>
 <% end %>

data/lib/generators/devise_invitable/templates/simple_form_for/invitations/new.html.erb

@@ -7,5 +7,5 @@
   <%= f.input field %>
 <% end -%>
 
-<%= f.submit t("devise.invitations.new.submit_button") %>
+<%= f.button :submit, t("devise.invitations.new.submit_button") %>
 <% end %>

data/test/functional/registrations_controller_test.rb

@@ -25,7 +25,7 @@ class DeviseInvitable::RegistrationsControllerTest < ActionController::TestCase
     sign_out @issuer
 
     @invitee = User.where(:email => invitee_email).first
-    assert_blank @invitee.encrypted_password, "the password should be unset"
+    assert @invitee.encrypted_password.blank?, "the password should be unset"
 
     # sign_up the invitee
     assert_difference('ActionMailer::Base.deliveries.size') do
@@ -42,13 +42,13 @@ class DeviseInvitable::RegistrationsControllerTest < ActionController::TestCase
       @invitee.save!
     end
 
-    assert_present @invitee.encrypted_password
+    assert @invitee.encrypted_password.present?
     assert_not_nil @invitee.invitation_accepted_at
     assert_nil @invitee.invitation_token
-    assert_present @invitee.invited_by_id
-    assert_present @invitee.invited_by_type
+    assert @invitee.invited_by_id.present?
+    assert @invitee.invited_by_type.present?
     assert !@invitee.confirmed?
-    assert_present @invitee.confirmation_token
+    assert @invitee.confirmation_token.present?
   end
 
   test "not invitable resources can register" do
@@ -58,7 +58,7 @@ class DeviseInvitable::RegistrationsControllerTest < ActionController::TestCase
     post :create, :admin => {:email => invitee_email, :password => "1password"}
 
     @invitee = Admin.where(:email => invitee_email).first
-    assert_present @invitee.encrypted_password
+    assert @invitee.encrypted_password.present?
   end
 
   test "missing params on a create should not cause an error" do

data/test/generators_test.rb

@@ -17,18 +17,18 @@ class GeneratorsTest < ActiveSupport::TestCase
 
   test "rails g devise_invitable:install" do
     @output = `cd #{RAILS_APP_PATH} && rails g devise_invitable:install -p`
-    assert @output.match(%r{(inject|insert).+  config/initializers/devise\.rb\n})
-    assert @output.match(%r|create.+  config/locales/devise_invitable\.en\.yml\n|)
+    assert @output.match(%r{(inject|insert).*  config/initializers/devise\.rb\n})
+    assert @output.match(%r|create.*  config/locales/devise_invitable\.en\.yml\n|)
   end
 
   test "rails g devise_invitable Octopussy" do
     @output = `cd #{RAILS_APP_PATH} && rails g devise_invitable Octopussy -p`
-    assert @output.match(%r{(inject|insert).+  app/models/octopussy\.rb\n})
-    assert @output.match(%r|invoke.+  #{DEVISE_ORM}\n|)
+    assert @output.match(%r{(inject|insert).*  app/models/octopussy\.rb\n})
+    assert @output.match(%r|invoke.*  #{DEVISE_ORM}\n|)
     if DEVISE_ORM == :active_record
-      assert @output.match(%r|create.+  db/migrate/\d{14}_devise_invitable_add_to_octopussies\.rb\n|)
+      assert @output.match(%r|create.*  db/migrate/\d{14}_devise_invitable_add_to_octopussies\.rb\n|)
     elsif DEVISE_ORM == :mongoid
-      assert !@output.match(%r|create.+  db/migrate/\d{14}_devise_invitable_add_to_octopussies\.rb\n|)
+      assert !@output.match(%r|create.*  db/migrate/\d{14}_devise_invitable_add_to_octopussies\.rb\n|)
     end
   end
 end

data/test/integration/invitation_test.rb

@@ -80,7 +80,7 @@ class InvitationTest < ActionDispatch::IntegrationTest
     end
     assert_equal user_invitation_path, current_path
     assert page.has_css?('#error_explanation li', :text => /Password .*doesn\'t match/)
-    assert_blank user.encrypted_password
+    assert user.encrypted_password.blank?
   end
 
   test 'not authenticated user with valid data should be able to change his password' do
@@ -99,7 +99,7 @@ class InvitationTest < ActionDispatch::IntegrationTest
     end
     assert_equal user_invitation_path, current_path
     assert page.has_css?('#error_explanation')
-    assert_blank user.encrypted_password
+    assert user.encrypted_password.blank?
 
     set_password :visit => false
     assert page.has_css?('p#notice', :text => 'Your password was set successfully. You are now signed in.')

data/test/integration_tests_helper.rb

@@ -1,9 +1,9 @@
-class ActionController::IntegrationTest
+class ActionDispatch::IntegrationTest
 
   def warden
     request.env['warden']
   end
-  
+
   def create_full_user
     @user ||= begin
       user = User.create!(
@@ -24,7 +24,7 @@ class ActionController::IntegrationTest
     visit send("new_#{resource_name}_session_path")
     fill_in "#{resource_name}_email", :with => user.email
     fill_in "#{resource_name}_password", :with => user.password
-    click_button 'Sign in'
+    click_button 'Log in'
   end
 
   # Fix assert_redirect_to in integration sessions because they don't take into

data/test/models/invitable_test.rb

@@ -11,6 +11,16 @@ class InvitableTest < ActiveSupport::TestCase
     assert_nil new_user.invitation_token
   end
 
+  test 'should update the invitations count counter cache' do
+    if defined?(ActiveRecord)
+      current_user = new_user
+      2.times do |index|
+        User.invite!({:email => "valid#{index}@email.com"}, current_user)
+      end
+      assert_equal current_user.reload.invitations_count, 2
+    end
+  end
+
   test 'should not generate the raw invitation token after creating a record' do
     assert_nil new_user.raw_invitation_token
   end
@@ -18,14 +28,40 @@ class InvitableTest < ActiveSupport::TestCase
   test 'should regenerate invitation token each time' do
     user = new_user
     user.invite!
-    token = user.invitation_token
+
     assert_not_nil user.invitation_token
+    assert_not_nil user.raw_invitation_token
     assert_not_nil user.invitation_created_at
+
     3.times do
       user = User.find(user.id)
-      user.invite!
-      assert_not_equal token, user.invitation_token
-      token = user.invitation_token
+
+      assert_not_same user.invitation_token, lambda {
+        user.invite!
+        user.invitation_token
+      }.call
+      assert_not_nil user.raw_invitation_token
+    end
+  end
+
+  test 'should regenerate invitation token each time even if "skip_invitation" was true' do
+    user = new_user
+    user.skip_invitation = true
+    user.invite!
+
+    assert_not_nil user.invitation_token
+    assert_not_nil user.invitation_created_at
+
+    3.times do
+      user = User.find(user.id)
+      user.skip_invitation = true
+
+      assert_not_same user.invitation_token, lambda {
+        user.invite!
+        user.invitation_token
+      }.call
+      assert_not_nil user.invitation_token
+      assert_not_nil user.raw_invitation_token
     end
   end
 
@@ -147,21 +183,21 @@ class InvitableTest < ActiveSupport::TestCase
 
   test 'should clear invitation token and set invitation_accepted_at while accepting the password' do
     user = User.invite!(:email => "valid@email.com")
-    assert_present user.invitation_token
+    assert user.invitation_token.present?
     assert_nil user.invitation_accepted_at
     user.accept_invitation!
     user.reload
     assert_nil user.invitation_token
-    assert_present user.invitation_accepted_at
+    assert user.invitation_accepted_at.present?
   end
 
   test 'should not clear invitation token or set accepted_at if record is invalid' do
     user = User.invite!(:email => "valid@email.com")
-    assert_present user.invitation_token
+    assert user.invitation_token.present?
     assert_nil user.invitation_accepted_at
     User.accept_invitation!(:invitation_token => user.invitation_token, :password => '123456789', :password_confirmation => '987654321')
     user.reload
-    assert_present user.invitation_token
+    assert user.invitation_token.present?
     assert_nil user.invitation_accepted_at
   end
 
@@ -172,8 +208,8 @@ class InvitableTest < ActiveSupport::TestCase
     user.reset_password_sent_at = Time.now.utc
     user.save
 
-    assert_present user.reset_password_token
-    assert_present user.invitation_token
+    assert user.reset_password_token.present?
+    assert user.invitation_token.present?
     User.reset_password_by_token(:reset_password_token => token, :password => '123456789', :password_confirmation => '123456789')
     assert_nil user.reload.reset_password_token
     assert_nil user.reload.invitation_token
@@ -187,11 +223,11 @@ class InvitableTest < ActiveSupport::TestCase
     user.reset_password_sent_at = Time.now.utc
     user.save
 
-    assert_present user.reset_password_token
-    assert_present user.invitation_token
+    assert user.reset_password_token.present?
+    assert user.invitation_token.present?
     User.reset_password_by_token(:reset_password_token => token, :password => '123456789', :password_confirmation => '12345678')
-    assert_present user.reload.reset_password_token
-    assert_present user.reload.invitation_token
+    assert user.reload.reset_password_token.present?
+    assert user.reload.invitation_token.present?
     assert user.invited_to_sign_up?
   end
 
@@ -202,7 +238,7 @@ class InvitableTest < ActiveSupport::TestCase
     user.reset_password_sent_at = Time.now.utc
     user.save
 
-    assert_present user.reset_password_token
+    assert user.reset_password_token.present?
     assert_nil user.invitation_token
     User.reset_password_by_token(:reset_password_token => token, :password => '123456789', :password_confirmation => '123456789')
     assert_nil user.reload.invitation_token
@@ -221,7 +257,7 @@ class InvitableTest < ActiveSupport::TestCase
   test 'should return a record with invitation token and no errors to send invitation by email' do
     invited_user = User.invite!(:email => "valid@email.com")
     assert invited_user.errors.blank?
-    assert_present invited_user.invitation_token
+    assert invited_user.invitation_token.present?
     assert_equal 'valid@email.com', invited_user.email
     assert invited_user.persisted?
   end
@@ -462,7 +498,18 @@ class InvitableTest < ActiveSupport::TestCase
     assert_no_difference('ActionMailer::Base.deliveries.size') do
       user.invite!
     end
-    assert_present user.invitation_created_at
+    assert user.invitation_created_at.present?
+    assert_nil user.invitation_sent_at
+  end
+
+  test 'user.invite! should not send an invitation if we want to skip the invitation with block' do
+    user = new_user
+    assert_no_difference('ActionMailer::Base.deliveries.size') do
+      user.invite! do |u|
+        u.skip_invitation = true
+      end
+    end
+    assert user.invitation_created_at.present?
     assert_nil user.invitation_sent_at
   end
 
@@ -538,13 +585,13 @@ class InvitableTest < ActiveSupport::TestCase
 
   test 'should pass validation before accept if field is required in post-invited instance' do
     user = User.invite!(:email => "valid@email.com")
-    user.testing_accepting_or_not_invited = true
+    user.testing_accepted_or_not_invited = true
     assert_equal true, user.valid?
   end
 
   test 'should fail validation after accept if field is required in post-invited instance' do
     user = User.invite!(:email => "valid@email.com")
-    user.testing_accepting_or_not_invited = true
+    user.testing_accepted_or_not_invited = true
     user.accept_invitation!
     assert_equal false, user.valid?
   end
@@ -552,7 +599,7 @@ class InvitableTest < ActiveSupport::TestCase
   test 'should pass validation after accept if field is required in post-invited instance' do
     user = User.invite!(:email => "valid@email.com")
     user.username = 'test'
-    user.testing_accepting_or_not_invited = true
+    user.testing_accepted_or_not_invited = true
     user.bio = "Test"
     user.accept_invitation!
     assert_equal true, user.valid?

data/test/rails_app/app/models/user.rb

@@ -39,12 +39,12 @@ class User < PARENT_MODEL_CLASS
   attr_accessor :callback_works, :bio, :token
   validates :username, :length => { :maximum => 20 }
   
-  attr_accessor :testing_accepting_or_not_invited
-  validates :username, :presence => true, :if => :testing_accepting_or_not_invited_validator?
+  attr_accessor :testing_accepted_or_not_invited
+  validates :username, :presence => true, :if => :testing_accepted_or_not_invited_validator?
   validates :bio, :presence => true, :if => :invitation_accepted?
 
-  def testing_accepting_or_not_invited_validator?
-    testing_accepting_or_not_invited && accepting_or_not_invited?
+  def testing_accepted_or_not_invited_validator?
+    testing_accepted_or_not_invited && accepted_or_not_invited?
   end
 
   after_invitation_accepted do |object|

data/test/rails_app/config/initializers/devise.rb

@@ -90,6 +90,45 @@ Devise.setup do |config|
   # Setup a pepper to generate the encrypted password.
   # config.pepper = "e31589192aeea8807cb7d8686b0f8484d6cbfaaa65443d45144519ed1d4ffbc6ccb73b21a69ece276d94f2cac95d83990d824f36f301d6f585ededd1bf90d67d"
 
+  # ==> Configuration for :invitable
+  # 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.
+  # config.invite_for = 2.weeks
+
+  # Number of invitations users can send.
+  # - If invitation_limit is nil, there is no limit for invitations, users can
+  # send unlimited invitations, invitation_limit column is not used.
+  # - If invitation_limit is 0, users can't send invitations by default.
+  # - If invitation_limit n > 0, users can send n invitations.
+  # You can change invitation_limit column for some users so they can send more
+  # or less invitations, even with global invitation_limit = 0
+  # Default: nil
+  # config.invitation_limit = 5
+
+  # The key to be used to check existing users when sending an invitation
+  # and the regexp used to test it when validate_on_invite is not set.
+  # config.invite_key = {:email => /\\A[^@]+@[^@]+\\z/}
+  # config.invite_key = {:email => /\\A[^@]+@[^@]+\\z/, :username => nil}
+
+  # Flag that force a record to be valid before being actually invited
+  # Default: false
+  # config.validate_on_invite = true
+
+  # Resend invitation if user with invited status is invited again
+  # Default: true
+  # config.resend_invitation = false
+
+  # The class name of the inviting model. If this is nil,
+  # the #invited_by association is declared to be polymorphic.
+  # Default: nil
+  # config.invited_by_class_name = 'User'
+
+  # The column name used for counter_cache column. If this is nil,
+  # the #invited_by association is declared without counter_cache.
+  # Default: nil
+  config.invited_by_counter_cache = :invitations_count
+
   # ==> Configuration for :confirmable
   # A period that the user is allowed to access the website even without
   # confirming his account. For instance, if set to 2.days, the user will be

data/test/rails_app/db/migrate/20100401102949_create_tables.rb

@@ -27,15 +27,20 @@ class CreateTables < ActiveRecord::Migration
       t.integer  :invitation_limit
       t.integer  :invited_by_id
       t.string   :invited_by_type
+      t.integer :invitations_count, :default => 0
 
       t.timestamps
     end
     add_index :users, :invitation_token, :unique => true
+    add_index :users, :invitations_count
 
     create_table :admins do |t|
       ## Database authenticatable
       t.string :email,              :null => true, :default => ""
       t.string :encrypted_password, :null => true, :default => ""
+
+      t.integer :invitations_count, :default => 0
     end
+    add_index :admins, :invitations_count
   end
 end

metadata

@@ -1,38 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: devise_invitable
 version: !ruby/object:Gem::Version
-  version: 1.3.2
-  prerelease: 
+  version: 1.4.0
 platform: ruby
 authors:
 - Sergio Cambra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-04 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.6
     - - <
@@ -41,9 +37,8 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.6
     - - <
@@ -52,19 +47,17 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
 description: It adds support for send invitations by email (it requires to be authenticated)
   and accept the invitation by setting a password.
 email:
@@ -154,6 +147,7 @@ files:
 homepage: https://github.com/scambra/devise_invitable
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --main
@@ -162,22 +156,20 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An invitation strategy for Devise
 test_files:
 - test/functional/controller_helpers_test.rb