devise_invitable 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec084ea3f59520fb7b2cfb978cd79d53ec5c1488
-  data.tar.gz: 257a48340805f6bfe02bc4fd1279a8694ab24c5c
+  metadata.gz: 49059f27df2618f9c0491fd1b7578b33619f2ef5
+  data.tar.gz: da0b1ff3962cba2784b8c082c013fb483ee0517e
 SHA512:
-  metadata.gz: 51c1385e5d2235ef7d3004208e489ecd241e99ade5afd8d7f5a1289e48cc7e9af6ba599b058862b82c5eb9c64ee02dc63d1be1526d692ccd86c33099bda8c8a8
-  data.tar.gz: 86ff8fa5e4f3990ca8c5dee25acc0e663204b671337e479fc19cfc0c5d2145d79f85f5a68c1ac53790b8a4c967050e13b0a070cf8943c6c4d639684ad68898b7
+  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

@@ -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
 
@@ -233,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:
@@ -252,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)
@@ -261,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.
@@ -369,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

@@ -18,7 +18,9 @@ class Devise::InvitationsController < DeviseController
 
     if resource.errors.empty?
       yield resource if block_given?
-      set_flash_message :notice, :send_instructions, :email => self.resource.email if self.resource.invitation_sent_at
+      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 }
@@ -37,47 +39,47 @@ class Devise::InvitationsController < DeviseController
 
     if resource.errors.empty?
       yield resource if block_given?
-      flash_message = resource.active_for_authentication? ? :updated : :updated_not_active                                                                                        
-      set_flash_message :notice, flash_message
+      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
@@ -89,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

@@ -34,12 +34,8 @@ module Devise
         else
           {:polymorphic => true}
         end
-        if defined?(ActiveRecord) && self < ActiveRecord::Base
+        if defined?(ActiveRecord) && defined?(ActiveRecord::Base) && self < ActiveRecord::Base
           counter_cache = Devise.invited_by_counter_cache
-          if !counter_cache && Devise.invited_by_class_name
-            klass = Devise.invited_by_class_name.constantize
-            counter_cache = klass.table_exists? && klass.columns_hash['invitations_count'].try('name')
-          end
           belongs_to_options.merge! :counter_cache => counter_cache if counter_cache
         end
         belongs_to :invited_by, belongs_to_options
@@ -49,7 +45,7 @@ module Devise
 
         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) }
@@ -114,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
@@ -137,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?
@@ -174,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.

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.4'
+  VERSION = '1.4.0'
 end

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

@@ -25,5 +25,9 @@ class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
       t.remove_references :invited_by, :polymorphic => true
       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/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

@@ -28,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
 
@@ -157,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
 
@@ -182,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
@@ -197,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
 
@@ -212,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
@@ -231,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
@@ -472,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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_invitable
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Sergio Cambra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-27 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler