devise_invitable 0.3.7 → 0.4.rc
Sign up to get free protection for your applications and to get access to all the features.
- data/README.rdoc +44 -41
- data/app/controllers/devise/invitations_controller.rb +8 -5
- data/app/controllers/devise/invitations_controller.rb~ +48 -0
- data/app/views/devise/mailer/invitation_instructions.html.erb +8 -0
- data/config/locales/en.yml +5 -4
- data/lib/devise_invitable.rb +8 -8
- data/lib/devise_invitable/controllers/helpers.rb +0 -5
- data/lib/devise_invitable/mailer.rb +8 -2
- data/lib/devise_invitable/model.rb +26 -40
- data/lib/devise_invitable/model.rb~ +129 -0
- data/lib/devise_invitable/rails.rb +2 -5
- data/lib/devise_invitable/routes.rb +8 -5
- data/lib/devise_invitable/schema.rb +24 -2
- data/lib/devise_invitable/version.rb +1 -1
- data/lib/generators/active_record/templates/migration.rb +5 -3
- data/lib/generators/devise_invitable/devise_invitable_generator.rb +4 -0
- data/lib/generators/devise_invitable/install_generator.rb +7 -2
- metadata +49 -42
data/README.rdoc
CHANGED
@@ -2,26 +2,26 @@
|
|
2
2
|
|
3
3
|
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.
|
4
4
|
|
5
|
-
DeviseInvitable currently only support
|
5
|
+
DeviseInvitable currently only support Rails 3, 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]
|
6
6
|
|
7
|
-
== Installation for Rails ~> 3.0
|
7
|
+
== Installation for Rails ~> 3.0 and Devise ~> 1.1
|
8
8
|
|
9
|
-
Install
|
9
|
+
Install DeviseInvitable gem, it will also install dependencies (such as devise and warden):
|
10
10
|
|
11
|
-
|
11
|
+
gem install devise_invitable
|
12
12
|
|
13
|
-
|
13
|
+
Add DeviseInvitable to your Gemfile (and Devise if you weren't using them):
|
14
14
|
|
15
|
-
gem 'devise'
|
16
|
-
gem 'devise_invitable'
|
15
|
+
gem 'devise', '~> 1.1.3'
|
16
|
+
gem 'devise_invitable', '~> 0.3.4'
|
17
17
|
|
18
18
|
=== Automatic installation
|
19
19
|
|
20
|
-
|
20
|
+
Run the following generator to add DeviseInvitable’s configuration option in the Devise configuration file (config/initializers/devise.rb):
|
21
21
|
|
22
22
|
rails generate devise_invitable:install
|
23
23
|
|
24
|
-
|
24
|
+
When you are done, you are ready to add DeviseInvitable to any of your Devise models using the following generator:
|
25
25
|
|
26
26
|
rails generate devise_invitable MODEL
|
27
27
|
|
@@ -31,7 +31,7 @@ Replace MODEL by the class name you want to add DeviseInvitable, like User, Admi
|
|
31
31
|
|
32
32
|
Follow the walkthrough for Devise and after it's done, follow this walkthrough.
|
33
33
|
|
34
|
-
Add :invitable to the
|
34
|
+
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):
|
35
35
|
|
36
36
|
class User < ActiveRecord::Base
|
37
37
|
devise :database_authenticatable, :confirmable, :invitable
|
@@ -46,39 +46,38 @@ Add t.invitable to your Devise model migration:
|
|
46
46
|
end
|
47
47
|
add_index :users, :invitation_token
|
48
48
|
|
49
|
-
or for a model that
|
49
|
+
or for a model that already exists, define a migration to add DeviseInvitable to your model:
|
50
50
|
|
51
51
|
change_table :users do |t|
|
52
|
-
t.string :invitation_token, :limit =>
|
52
|
+
t.string :invitation_token, :limit => 60
|
53
53
|
t.datetime :invitation_sent_at
|
54
54
|
t.index :invitation_token
|
55
55
|
end
|
56
56
|
|
57
|
-
# Allow null encrypted_password
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
DeviseInvitable doesn't use _attr_accessible_ or _attr_protected_, so be sure to define attributes as accessible or protected in your model.
|
57
|
+
# Allow null encrypted_password
|
58
|
+
change_column_null :users, :encrypted_password, true
|
59
|
+
# Allow null password_salt (add it if you are using Devise's encryptable module)
|
60
|
+
change_column_null :users, :password_salt, true
|
62
61
|
|
63
62
|
== Model configuration
|
64
63
|
|
65
64
|
DeviseInvitable adds a new configuration option:
|
66
65
|
|
67
|
-
|
66
|
+
* 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.
|
68
67
|
|
69
|
-
You can set
|
68
|
+
You can set this configuration option in the Devise initializer as follow:
|
70
69
|
|
71
70
|
# ==> Configuration for :invitable
|
72
|
-
#
|
73
|
-
#
|
74
|
-
#
|
71
|
+
# The period the generated invitation token is valid, after
|
72
|
+
# this period, the invited resource won't be able to accept the invitation.
|
73
|
+
# When invite_for is 0 (the default), the invitation won't expire.
|
75
74
|
# config.invite_for = 2.weeks
|
76
75
|
|
77
|
-
or directly as parameters to the <tt>devise</tt> method
|
76
|
+
or directly as parameters to the <tt>devise</tt> method:
|
78
77
|
|
79
78
|
devise :database_authenticatable, :confirmable, :invitable, :invite_for => 2.weeks
|
80
79
|
|
81
|
-
For details, see <tt>config/
|
80
|
+
For more details, see <tt>config/initializers/devise.rb</tt> (after you invoked the "devise_invitable:install" generator described above).
|
82
81
|
|
83
82
|
== Configuring views
|
84
83
|
|
@@ -96,31 +95,33 @@ Please refer to {Devise's README}[http://github.com/plataformatec/devise] for mo
|
|
96
95
|
|
97
96
|
=== Send an invitation
|
98
97
|
|
99
|
-
To send an invitation to a user, use the <tt>invite!</tt> class method.
|
100
|
-
You can also include other attributes in the hash. The record will not be validated.
|
98
|
+
To send an invitation to a user, use the <tt>invite!</tt> class method. <tt>:email</tt> must be present in the parameters hash. You can also include other attributes in the hash. The record will not be validated.
|
101
99
|
|
102
|
-
User.invite(:email => "new_user@example.com", :name => "John Doe")
|
100
|
+
User.invite!(:email => "new_user@example.com", :name => "John Doe")
|
103
101
|
# => an invitation email will be sent to new_user@example.com
|
104
102
|
|
105
103
|
=== Accept an invitation
|
106
104
|
|
107
|
-
To accept an invitation with a token use the <tt>accept_invitation
|
105
|
+
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.
|
108
106
|
|
109
|
-
User.accept_invitation(:invitation_token => params[:invitation_token], :password => "ad97nwj3o2", :name => "John Doe")
|
107
|
+
User.accept_invitation!(:invitation_token => params[:invitation_token], :password => "ad97nwj3o2", :name => "John Doe")
|
110
108
|
|
111
109
|
== Integration in a Rails application
|
112
110
|
|
113
|
-
Since the invitations controller take care of all the
|
114
|
-
Instead, in your views, put a link to <tt>new_user_invitation_path</tt> or <tt>new_invitation_path(:user)</tt> or even <tt>/users/invitation/new</tt> to prepare and send an invitation.
|
115
|
-
|
111
|
+
Since the invitations controller take care of all the creation/acceptation of an invitation, in most cases you wouldn't call the <tt>invite!</tt> and <tt>accept_invitation!</tt> methods directly.
|
112
|
+
Instead, in your views, put a link to <tt>new_user_invitation_path</tt> or <tt>new_invitation_path(:user)</tt> or even <tt>/users/invitation/new</tt> to prepare and send an invitation (to a user in this example).
|
113
|
+
After an invitation is created and sent, the inviter will be redirected to after_sign_in_path_for(resource_name).
|
114
|
+
|
115
|
+
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).
|
116
|
+
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.
|
116
117
|
|
117
118
|
== Controller filter
|
118
119
|
|
119
120
|
InvitationsController uses authenticate_inviter! filter to restrict who can send invitations. You can override this method in your ApplicationController.
|
120
121
|
|
121
|
-
Default behavior requires authentication of the same resource. For example, if your model User is
|
122
|
+
Default behavior requires authentication of the same resource as the invited one. For example, if your model User is invitable, it will allow all authenticated users to send invitations to other users.
|
122
123
|
|
123
|
-
You would have a User model which is configured as invitable and an Admin model which is not. If you
|
124
|
+
You would have a User model which is configured as invitable and an Admin model which is not. If you want to allow only admins to send invitations, simply overwrite the authenticate_inviter! method as follow:
|
124
125
|
|
125
126
|
class ApplicationController < ActionController::Base
|
126
127
|
protected
|
@@ -131,12 +132,13 @@ You would have a User model which is configured as invitable and an Admin model
|
|
131
132
|
|
132
133
|
== I18n
|
133
134
|
|
134
|
-
DeviseInvitable uses flash messages with I18n with the flash keys <tt>:send_instructions</tt> and <tt>:updated</tt>. To customize your app, you can modify the generated locale file:
|
135
|
+
DeviseInvitable uses flash messages with I18n with the flash keys <tt>:send_instructions</tt>, <tt>:invitation_token_invalid</tt> and <tt>:updated</tt>. To customize your app, you can modify the generated locale file:
|
135
136
|
|
136
137
|
en:
|
137
138
|
devise:
|
138
139
|
invitations:
|
139
|
-
send_instructions: 'An email
|
140
|
+
send_instructions: 'An invitation email has been sent to %{email}.'
|
141
|
+
invitation_token_invalid: 'The invitation token provided is not valid!'
|
140
142
|
updated: 'Your password was set successfully. You are now signed in.'
|
141
143
|
|
142
144
|
You can also create distinct messages based on the resource you've configured using the singular name given in routes:
|
@@ -145,17 +147,18 @@ You can also create distinct messages based on the resource you've configured us
|
|
145
147
|
devise:
|
146
148
|
invitations:
|
147
149
|
user:
|
148
|
-
send_instructions: 'A new user invitation has been sent.'
|
150
|
+
send_instructions: 'A new user invitation has been sent to %{email}.'
|
151
|
+
invitation_token_invalid: 'Your invitation token is not valid!'
|
149
152
|
updated: 'Welcome on board! You are now signed in.'
|
150
153
|
|
151
|
-
The DeviseInvitable mailer uses the
|
154
|
+
The DeviseInvitable mailer uses the same pattern as Devise to create mail subject messages:
|
152
155
|
|
153
156
|
en:
|
154
157
|
devise:
|
155
158
|
mailer:
|
156
|
-
|
159
|
+
invitation_instructions:
|
157
160
|
subject: 'You got an invitation!'
|
158
|
-
user_subject: 'You got
|
161
|
+
user_subject: 'You got a user invitation!'
|
159
162
|
|
160
163
|
Take a look at the generated locale file (in <tt>config/locales/devise_invitable.en.yml</tt>) to check all available messages.
|
161
164
|
|
@@ -169,7 +172,7 @@ Check them all at:
|
|
169
172
|
|
170
173
|
http://github.com/scambra/devise_invitable/contributors
|
171
174
|
|
172
|
-
Special thanks to rymai[http://github.com/rymai] for
|
175
|
+
Special thanks to rymai[http://github.com/rymai] for the Rails 3 support, his fork was a great help.
|
173
176
|
|
174
177
|
== Note on Patches/Pull Requests
|
175
178
|
|
@@ -16,8 +16,8 @@ class Devise::InvitationsController < ApplicationController
|
|
16
16
|
self.resource = resource_class.invite!(params[resource_name])
|
17
17
|
|
18
18
|
if resource.errors.empty?
|
19
|
-
set_flash_message :notice, :send_instructions
|
20
|
-
redirect_to
|
19
|
+
set_flash_message :notice, :send_instructions, :email => self.resource.email
|
20
|
+
redirect_to after_sign_in_path_for(resource_name)
|
21
21
|
else
|
22
22
|
render_with_scope :new
|
23
23
|
end
|
@@ -25,9 +25,12 @@ class Devise::InvitationsController < ApplicationController
|
|
25
25
|
|
26
26
|
# GET /resource/invitation/accept?invitation_token=abcdef
|
27
27
|
def edit
|
28
|
-
self.resource = resource_class.
|
29
|
-
|
30
|
-
|
28
|
+
if params[:invitation_token] && self.resource = resource_class.first(:conditions => { :invitation_token => params[:invitation_token] })
|
29
|
+
render_with_scope :edit
|
30
|
+
else
|
31
|
+
set_flash_message(:alert, :invitation_token_invalid)
|
32
|
+
redirect_to after_sign_out_path_for(resource_name)
|
33
|
+
end
|
31
34
|
end
|
32
35
|
|
33
36
|
# PUT /resource/invitation
|
@@ -0,0 +1,48 @@
|
|
1
|
+
class Devise::InvitationsController < ApplicationController
|
2
|
+
include Devise::Controllers::InternalHelpers
|
3
|
+
|
4
|
+
before_filter :authenticate_inviter!, :only => [:new, :create]
|
5
|
+
before_filter :require_no_authentication, :only => [:edit, :update]
|
6
|
+
helper_method :after_sign_in_path_for
|
7
|
+
|
8
|
+
# GET /resource/invitation/new
|
9
|
+
def new
|
10
|
+
build_resource
|
11
|
+
render_with_scope :new
|
12
|
+
end
|
13
|
+
|
14
|
+
# POST /resource/invitation
|
15
|
+
def create
|
16
|
+
self.resource = resource_class.invite!(params[resource_name])
|
17
|
+
|
18
|
+
if resource.errors.empty?
|
19
|
+
puts params.inspect
|
20
|
+
set_flash_message :notice, :send_instructions, :email => self.resource.email
|
21
|
+
redirect_to after_sign_in_path_for(resource_name)
|
22
|
+
else
|
23
|
+
render_with_scope :new
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
# GET /resource/invitation/accept?invitation_token=abcdef
|
28
|
+
def edit
|
29
|
+
if params[:invitation_token] && self.resource = resource_class.first(:conditions => { :invitation_token => params[:invitation_token] })
|
30
|
+
render_with_scope :edit
|
31
|
+
else
|
32
|
+
set_flash_message(:alert, :invitation_token_invalid)
|
33
|
+
redirect_to after_sign_out_path_for(resource_name)
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
# PUT /resource/invitation
|
38
|
+
def update
|
39
|
+
self.resource = resource_class.accept_invitation!(params[resource_name])
|
40
|
+
|
41
|
+
if resource.errors.empty?
|
42
|
+
set_flash_message :notice, :updated
|
43
|
+
sign_in_and_redirect(resource_name, resource)
|
44
|
+
else
|
45
|
+
render_with_scope :edit
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
@@ -0,0 +1,8 @@
|
|
1
|
+
<p>Hello <%= @resource.email %>!</p>
|
2
|
+
|
3
|
+
<p>Someone has invited you to <%= root_url %>, you can accept it through the link below.</p>
|
4
|
+
|
5
|
+
<p><%= link_to 'Accept invitation', accept_invitation_url(@resource, :invitation_token => @resource.invitation_token) %></p>
|
6
|
+
|
7
|
+
<p>If you don't want to accept the invitation, please ignore this email.<br />
|
8
|
+
Your account won't be created until you access the link above and set your password.</p>
|
data/config/locales/en.yml
CHANGED
@@ -1,8 +1,9 @@
|
|
1
1
|
en:
|
2
2
|
devise:
|
3
3
|
invitations:
|
4
|
-
send_instructions: 'An email
|
4
|
+
send_instructions: 'An invitation email has been sent to %{email}.'
|
5
|
+
invitation_token_invalid: 'The invitation token provided is not valid!'
|
5
6
|
updated: 'Your password was set successfully. You are now signed in.'
|
6
|
-
|
7
|
-
|
8
|
-
|
7
|
+
mailer:
|
8
|
+
invitation_instructions:
|
9
|
+
subject: 'Invitation instructions'
|
data/lib/devise_invitable.rb
CHANGED
@@ -1,16 +1,16 @@
|
|
1
1
|
require 'devise'
|
2
2
|
|
3
|
-
module Devise
|
4
|
-
# Time interval where the invitation token is valid.
|
5
|
-
mattr_accessor :invite_for
|
6
|
-
@@invite_for = 0
|
7
|
-
end
|
8
|
-
|
9
|
-
Devise.add_module :invitable, :controller => :invitations, :model => 'devise_invitable/model', :route => :invitation
|
10
|
-
|
11
3
|
require 'devise_invitable/mailer'
|
12
4
|
require 'devise_invitable/routes'
|
13
5
|
require 'devise_invitable/schema'
|
14
6
|
require 'devise_invitable/controllers/url_helpers'
|
15
7
|
require 'devise_invitable/controllers/helpers'
|
16
8
|
require 'devise_invitable/rails'
|
9
|
+
|
10
|
+
module Devise
|
11
|
+
# The period the generated invitation token is valid.
|
12
|
+
mattr_accessor :invite_for
|
13
|
+
@@invite_for = 0
|
14
|
+
end
|
15
|
+
|
16
|
+
Devise.add_module :invitable, :controller => :invitations, :model => 'devise_invitable/model', :route => :invitation
|
@@ -1,10 +1,5 @@
|
|
1
1
|
module DeviseInvitable::Controllers::Helpers
|
2
2
|
protected
|
3
|
-
def authenticate_resource!
|
4
|
-
ActiveSupport::Deprecation.warn('authenticate_resource! has been renamed to authenticate_inviter!')
|
5
|
-
authenticate_inviter!
|
6
|
-
end
|
7
|
-
|
8
3
|
def authenticate_inviter!
|
9
4
|
send(:"authenticate_#{resource_name}!")
|
10
5
|
end
|
@@ -1,8 +1,14 @@
|
|
1
1
|
module DeviseInvitable
|
2
2
|
module Mailer
|
3
|
-
|
3
|
+
|
4
|
+
# Deliver an invitation email
|
5
|
+
def invitation_instructions(record)
|
6
|
+
setup_mail(record, :invitation_instructions)
|
7
|
+
end
|
8
|
+
|
4
9
|
def invitation(record)
|
5
|
-
|
10
|
+
ActiveSupport::Deprecation.warn('invitation has been renamed to invitation_instructions')
|
11
|
+
invitation_instructions(record)
|
6
12
|
end
|
7
13
|
end
|
8
14
|
end
|
@@ -1,22 +1,23 @@
|
|
1
1
|
module Devise
|
2
2
|
module Models
|
3
|
-
# Invitable is responsible
|
4
|
-
# When an invitation is sent to an email, an account is created for it.
|
5
|
-
#
|
3
|
+
# Invitable is responsible for sending invitation emails.
|
4
|
+
# When an invitation is sent to an email address, an account is created for it.
|
5
|
+
# Invitation email contains a link allowing the user to accept the invitation
|
6
|
+
# by setting a password (as reset password from Devise's recoverable module).
|
6
7
|
#
|
7
8
|
# Configuration:
|
8
9
|
#
|
9
|
-
# invite_for:
|
10
|
-
#
|
11
|
-
#
|
10
|
+
# invite_for: The period the generated invitation token is valid, after
|
11
|
+
# this period, the invited resource won't be able to accept the invitation.
|
12
|
+
# When invite_for is 0 (the default), the invitation won't expire.
|
12
13
|
#
|
13
14
|
# Examples:
|
14
15
|
#
|
15
|
-
# User.find(1).invited?
|
16
|
-
# User.invite!(:email => 'someone@example.com')
|
17
|
-
# User.accept_invitation!(:invitation_token => '...')
|
18
|
-
# User.find(1).accept_invitation!
|
19
|
-
# User.find(1).invite!
|
16
|
+
# User.find(1).invited? # => true/false
|
17
|
+
# User.invite!(:email => 'someone@example.com') # => send invitation
|
18
|
+
# User.accept_invitation!(:invitation_token => '...') # => accept invitation with a token
|
19
|
+
# User.find(1).accept_invitation! # => accept invitation
|
20
|
+
# User.find(1).invite! # => reset invitation status and send invitation again
|
20
21
|
module Invitable
|
21
22
|
extend ActiveSupport::Concern
|
22
23
|
|
@@ -34,26 +35,17 @@ module Devise
|
|
34
35
|
persisted? && invitation_token.present?
|
35
36
|
end
|
36
37
|
|
37
|
-
# Send invitation by email
|
38
|
-
def send_invitation
|
39
|
-
::Devise.mailer.invitation(self).deliver
|
40
|
-
end
|
41
|
-
|
42
38
|
# Reset invitation token and send invitation again
|
43
39
|
def invite!
|
44
40
|
if new_record? || invited?
|
45
|
-
self.skip_confirmation! if self.new_record?
|
46
|
-
generate_invitation_token
|
47
|
-
|
48
|
-
|
41
|
+
self.skip_confirmation! if self.new_record? && self.respond_to?(:skip_confirmation!)
|
42
|
+
generate_invitation_token if self.invitation_token.nil?
|
43
|
+
self.invitation_sent_at = Time.now.utc
|
44
|
+
save(:validate => false)
|
45
|
+
::Devise.mailer.invitation_instructions(self).deliver
|
49
46
|
end
|
50
47
|
end
|
51
48
|
|
52
|
-
def resend_invitation!
|
53
|
-
ActiveSupport::Deprecation.warn('resend_invitation! has been renamed to invite!')
|
54
|
-
self.invite!
|
55
|
-
end
|
56
|
-
|
57
49
|
# Verify whether a invitation is active or not. If the user has been
|
58
50
|
# invited, we need to calculate if the invitation time has not expired
|
59
51
|
# for this user, in other words, if the invitation is still valid.
|
@@ -61,11 +53,6 @@ module Devise
|
|
61
53
|
invited? && invitation_period_valid?
|
62
54
|
end
|
63
55
|
|
64
|
-
# Only verify password when is not invited
|
65
|
-
def valid_password?(password)
|
66
|
-
super unless invited?
|
67
|
-
end
|
68
|
-
|
69
56
|
protected
|
70
57
|
|
71
58
|
# Checks if the invitation for the user is within the limit time.
|
@@ -94,8 +81,7 @@ module Devise
|
|
94
81
|
# Generates a new random token for invitation, and stores the time
|
95
82
|
# this token is being generated
|
96
83
|
def generate_invitation_token
|
97
|
-
self.invitation_token
|
98
|
-
self.invitation_sent_at = Time.now.utc
|
84
|
+
self.invitation_token = self.class.invitation_token
|
99
85
|
end
|
100
86
|
|
101
87
|
module ClassMethods
|
@@ -108,7 +94,7 @@ module Devise
|
|
108
94
|
invitable.attributes = attributes
|
109
95
|
|
110
96
|
if invitable.new_record?
|
111
|
-
invitable.errors.clear if invitable.email.match Devise.email_regexp
|
97
|
+
invitable.errors.clear if invitable.email.try(:match, Devise.email_regexp)
|
112
98
|
else
|
113
99
|
invitable.errors.add(:email, :taken) unless invitable.invited?
|
114
100
|
end
|
@@ -117,19 +103,14 @@ module Devise
|
|
117
103
|
invitable
|
118
104
|
end
|
119
105
|
|
120
|
-
def send_invitation(attributes = {})
|
121
|
-
ActiveSupport::Deprecation.warn('send_invitation has been renamed to invite!')
|
122
|
-
self.invite!(attributes)
|
123
|
-
end
|
124
|
-
|
125
106
|
# Attempt to find a user by it's invitation_token to set it's password.
|
126
107
|
# If a user is found, reset it's password and automatically try saving
|
127
108
|
# the record. If not user is found, returns a new user containing an
|
128
109
|
# error in invitation_token attribute.
|
129
110
|
# Attributes must contain invitation_token, password and confirmation
|
130
111
|
def accept_invitation!(attributes={})
|
131
|
-
invitable = find_or_initialize_with_error_by(:invitation_token, attributes
|
132
|
-
invitable.errors.add(:invitation_token, :invalid) if
|
112
|
+
invitable = find_or_initialize_with_error_by(:invitation_token, attributes.delete(:invitation_token))
|
113
|
+
invitable.errors.add(:invitation_token, :invalid) if invitable.invitation_token && invitable.persisted? && !invitable.valid_invitation?
|
133
114
|
if invitable.errors.empty?
|
134
115
|
invitable.attributes = attributes
|
135
116
|
invitable.accept_invitation!
|
@@ -137,6 +118,11 @@ module Devise
|
|
137
118
|
invitable
|
138
119
|
end
|
139
120
|
|
121
|
+
# Generate a token checking if one does not already exist in the database.
|
122
|
+
def invitation_token
|
123
|
+
generate_token(:invitation_token)
|
124
|
+
end
|
125
|
+
|
140
126
|
Devise::Models.config(self, :invite_for)
|
141
127
|
end
|
142
128
|
end
|
@@ -0,0 +1,129 @@
|
|
1
|
+
module Devise
|
2
|
+
module Models
|
3
|
+
# Invitable is responsible to send emails with invitations.
|
4
|
+
# When an invitation is sent to an email, an account is created for it.
|
5
|
+
# An invitation has a link to set the password, as reset password from recoverable.
|
6
|
+
#
|
7
|
+
# Configuration:
|
8
|
+
#
|
9
|
+
# invite_for: the time you want the user will have to confirm the account after
|
10
|
+
# is invited. When invite_for is zero, the invitation won't expire.
|
11
|
+
# By default invite_for is 0.
|
12
|
+
#
|
13
|
+
# Examples:
|
14
|
+
#
|
15
|
+
# User.find(1).invited? # true/false
|
16
|
+
# User.invite!(:email => 'someone@example.com') # send invitation
|
17
|
+
# User.accept_invitation!(:invitation_token => '...') # accept invitation with a token
|
18
|
+
# User.find(1).accept_invitation! # accept invitation
|
19
|
+
# User.find(1).invite! # reset invitation status and send invitation again
|
20
|
+
module Invitable
|
21
|
+
extend ActiveSupport::Concern
|
22
|
+
|
23
|
+
# Accept an invitation by clearing invitation token and confirming it if model
|
24
|
+
# is confirmable
|
25
|
+
def accept_invitation!
|
26
|
+
if self.invited?
|
27
|
+
self.invitation_token = nil
|
28
|
+
self.save
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
# Verifies whether a user has been invited or not
|
33
|
+
def invited?
|
34
|
+
persisted? && invitation_token.present?
|
35
|
+
end
|
36
|
+
|
37
|
+
# Send invitation by email
|
38
|
+
def send_invitation
|
39
|
+
::Devise.mailer.invitation(self).deliver
|
40
|
+
end
|
41
|
+
|
42
|
+
# Reset invitation token and send invitation again
|
43
|
+
def invite!
|
44
|
+
if new_record? || invited?
|
45
|
+
self.skip_confirmation! if self.new_record? and self.respond_to? :skip_confirmation!
|
46
|
+
generate_invitation_token
|
47
|
+
save(:validate=>false)
|
48
|
+
send_invitation
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
# Verify whether a invitation is active or not. If the user has been
|
53
|
+
# invited, we need to calculate if the invitation time has not expired
|
54
|
+
# for this user, in other words, if the invitation is still valid.
|
55
|
+
def valid_invitation?
|
56
|
+
invited? && invitation_period_valid?
|
57
|
+
end
|
58
|
+
|
59
|
+
protected
|
60
|
+
|
61
|
+
# Checks if the invitation for the user is within the limit time.
|
62
|
+
# We do this by calculating if the difference between today and the
|
63
|
+
# invitation sent date does not exceed the invite for time configured.
|
64
|
+
# Invite_for is a model configuration, must always be an integer value.
|
65
|
+
#
|
66
|
+
# Example:
|
67
|
+
#
|
68
|
+
# # invite_for = 1.day and invitation_sent_at = today
|
69
|
+
# invitation_period_valid? # returns true
|
70
|
+
#
|
71
|
+
# # invite_for = 5.days and invitation_sent_at = 4.days.ago
|
72
|
+
# invitation_period_valid? # returns true
|
73
|
+
#
|
74
|
+
# # invite_for = 5.days and invitation_sent_at = 5.days.ago
|
75
|
+
# invitation_period_valid? # returns false
|
76
|
+
#
|
77
|
+
# # invite_for = nil
|
78
|
+
# invitation_period_valid? # will always return true
|
79
|
+
#
|
80
|
+
def invitation_period_valid?
|
81
|
+
invitation_sent_at && (self.class.invite_for.to_i.zero? || invitation_sent_at.utc >= self.class.invite_for.ago)
|
82
|
+
end
|
83
|
+
|
84
|
+
# Generates a new random token for invitation, and stores the time
|
85
|
+
# this token is being generated
|
86
|
+
def generate_invitation_token
|
87
|
+
self.invitation_token = Devise.friendly_token
|
88
|
+
self.invitation_sent_at = Time.now.utc
|
89
|
+
end
|
90
|
+
|
91
|
+
module ClassMethods
|
92
|
+
# Attempt to find a user by it's email. If a record is not found, create a new
|
93
|
+
# user and send invitation to it. If user is found, returns the user with an
|
94
|
+
# email already exists error.
|
95
|
+
# Attributes must contain the user email, other attributes will be set in the record
|
96
|
+
def invite!(attributes={})
|
97
|
+
invitable = find_or_initialize_with_error_by(:email, attributes.delete(:email))
|
98
|
+
invitable.attributes = attributes
|
99
|
+
|
100
|
+
if invitable.new_record?
|
101
|
+
invitable.errors.clear if invitable.email.try(:match, Devise.email_regexp)
|
102
|
+
else
|
103
|
+
invitable.errors.add(:email, :taken) unless invitable.invited?
|
104
|
+
end
|
105
|
+
|
106
|
+
invitable.invite! if invitable.errors.empty?
|
107
|
+
invitable
|
108
|
+
end
|
109
|
+
|
110
|
+
# Attempt to find a user by it's invitation_token to set it's password.
|
111
|
+
# If a user is found, reset it's password and automatically try saving
|
112
|
+
# the record. If not user is found, returns a new user containing an
|
113
|
+
# error in invitation_token attribute.
|
114
|
+
# Attributes must contain invitation_token, password and confirmation
|
115
|
+
def accept_invitation!(attributes={})
|
116
|
+
invitable = find_or_initialize_with_error_by(:invitation_token, attributes.delete(:invitation_token))
|
117
|
+
invitable.errors.add(:invitation_token, :invalid) if attributes[:invitation_token] && !invitable.new_record? && !invitable.valid_invitation?
|
118
|
+
if invitable.errors.empty?
|
119
|
+
invitable.attributes = attributes
|
120
|
+
invitable.accept_invitation!
|
121
|
+
end
|
122
|
+
invitable
|
123
|
+
end
|
124
|
+
|
125
|
+
Devise::Models.config(self, :invite_for)
|
126
|
+
end
|
127
|
+
end
|
128
|
+
end
|
129
|
+
end
|
@@ -2,12 +2,9 @@ module DeviseInvitable
|
|
2
2
|
class Engine < ::Rails::Engine
|
3
3
|
|
4
4
|
ActiveSupport.on_load(:action_controller) { include DeviseInvitable::Controllers::UrlHelpers }
|
5
|
-
ActiveSupport.on_load(:action_view)
|
5
|
+
ActiveSupport.on_load(:action_view) { include DeviseInvitable::Controllers::UrlHelpers }
|
6
6
|
|
7
|
-
|
8
|
-
# mailer is reloaded like the rest of the user's app. Got to make sure that our mailer methods
|
9
|
-
# are included each time Devise::Mailer is (re)loaded.
|
10
|
-
config.to_prepare do
|
7
|
+
config.after_initialize do
|
11
8
|
require 'devise/mailer'
|
12
9
|
Devise::Mailer.send :include, DeviseInvitable::Mailer
|
13
10
|
end
|
@@ -1,10 +1,13 @@
|
|
1
1
|
module ActionDispatch::Routing
|
2
2
|
class Mapper
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
3
|
+
|
4
|
+
protected
|
5
|
+
def devise_invitation(mapping, controllers)
|
6
|
+
resource :invitation, :only => [:new, :create, :update],
|
7
|
+
:path => mapping.path_names[:invitation], :controller => controllers[:invitations] do
|
8
|
+
get :edit, :path => mapping.path_names[:accept], :as => :accept
|
8
9
|
end
|
10
|
+
end
|
11
|
+
|
9
12
|
end
|
10
13
|
end
|
@@ -1,8 +1,30 @@
|
|
1
1
|
module DeviseInvitable
|
2
2
|
module Schema
|
3
|
-
#
|
3
|
+
# Add invitation_token and invitation_sent_at columns in the resource's database table.
|
4
|
+
#
|
5
|
+
# Examples
|
6
|
+
#
|
7
|
+
# # For a new resource migration:
|
8
|
+
# create_table :the_resources do
|
9
|
+
# t.database_authenticatable :null => false # you need at least this
|
10
|
+
# t.invitable
|
11
|
+
# ...
|
12
|
+
# end
|
13
|
+
# add_index :the_resources, :invitation_token # for invitable
|
14
|
+
#
|
15
|
+
# # or if the resource's table already exists, define a migration and put this in:
|
16
|
+
# change_table :the_resources do |t|
|
17
|
+
# t.string :invitation_token, :limit => 60
|
18
|
+
# t.datetime :invitation_sent_at
|
19
|
+
# t.index :invitation_token # for invitable
|
20
|
+
# end
|
21
|
+
#
|
22
|
+
# # And allow encrypted_password to be null:
|
23
|
+
# change_column :the_resources, :encrypted_password, :string, :null => true
|
24
|
+
# # the following line is only if you use Devise's encryptable module!
|
25
|
+
# change_column :the_resources, :password_salt, :string, :null => true
|
4
26
|
def invitable
|
5
|
-
apply_devise_schema :invitation_token, String, :limit =>
|
27
|
+
apply_devise_schema :invitation_token, String, :limit => 60
|
6
28
|
apply_devise_schema :invitation_sent_at, DateTime
|
7
29
|
end
|
8
30
|
end
|
@@ -1,14 +1,16 @@
|
|
1
1
|
class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
|
2
2
|
def self.up
|
3
3
|
change_table :<%= table_name %> do |t|
|
4
|
-
t.string :invitation_token, :limit =>
|
4
|
+
t.string :invitation_token, :limit => 60
|
5
5
|
t.datetime :invitation_sent_at
|
6
6
|
t.index :invitation_token # for invitable
|
7
7
|
end
|
8
8
|
|
9
9
|
# And allow null encrypted_password and password_salt:
|
10
|
-
|
11
|
-
|
10
|
+
change_column_null :<%= table_name %>, :encrypted_password, true
|
11
|
+
<% if class_name.constantize.columns_hash['password_salt'] -%>
|
12
|
+
change_column_null :<%= table_name %>, :password_salt, true
|
13
|
+
<% end -%>
|
12
14
|
end
|
13
15
|
|
14
16
|
def self.down
|
@@ -5,6 +5,10 @@ module DeviseInvitable
|
|
5
5
|
|
6
6
|
desc "Add :invitable directive in the given model. Also generate migration for ActiveRecord"
|
7
7
|
|
8
|
+
# def devise_generate_model
|
9
|
+
# invoke "devise", [name]
|
10
|
+
# end
|
11
|
+
|
8
12
|
def inject_devise_invitable_content
|
9
13
|
path = File.join("app", "models", "#{file_path}.rb")
|
10
14
|
inject_into_file(path, "invitable, :", :after => "devise :") if File.exists?(path)
|
@@ -4,6 +4,10 @@ module DeviseInvitable
|
|
4
4
|
source_root File.expand_path("../../templates", __FILE__)
|
5
5
|
desc "Add DeviseInvitable config variables to the Devise initializer and copy DeviseInvitable locale files to your application."
|
6
6
|
|
7
|
+
# def devise_install
|
8
|
+
# invoke "devise:install"
|
9
|
+
# end
|
10
|
+
|
7
11
|
def add_config_options_to_initializer
|
8
12
|
devise_initializer_path = "config/initializers/devise.rb"
|
9
13
|
if File.exist?(devise_initializer_path)
|
@@ -15,8 +19,9 @@ module DeviseInvitable
|
|
15
19
|
inject_into_file(devise_initializer_path, :before => " # ==> Configuration for :confirmable\n") do
|
16
20
|
<<-CONTENT
|
17
21
|
# ==> Configuration for :invitable
|
18
|
-
#
|
19
|
-
#
|
22
|
+
# The period the generated invitation token is valid, after
|
23
|
+
# this period, the invited resource won't be able to accept the invitation.
|
24
|
+
# When invite_for is 0 (the default), the invitation won't expire.
|
20
25
|
# config.invite_for = 2.weeks
|
21
26
|
|
22
27
|
CONTENT
|
metadata
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: devise_invitable
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
hash:
|
5
|
-
prerelease:
|
4
|
+
hash: 7712090
|
5
|
+
prerelease: true
|
6
6
|
segments:
|
7
7
|
- 0
|
8
|
-
-
|
9
|
-
-
|
10
|
-
version: 0.
|
8
|
+
- 4
|
9
|
+
- rc
|
10
|
+
version: 0.4.rc
|
11
11
|
platform: ruby
|
12
12
|
authors:
|
13
13
|
- Sergio Cambra
|
@@ -15,70 +15,74 @@ autorequire:
|
|
15
15
|
bindir: bin
|
16
16
|
cert_chain: []
|
17
17
|
|
18
|
-
date: 2011-
|
18
|
+
date: 2011-01-06 00:00:00 +01:00
|
19
19
|
default_executable:
|
20
20
|
dependencies:
|
21
21
|
- !ruby/object:Gem::Dependency
|
22
|
-
name:
|
22
|
+
name: rspec-rails
|
23
23
|
prerelease: false
|
24
24
|
requirement: &id001 !ruby/object:Gem::Requirement
|
25
25
|
none: false
|
26
26
|
requirements:
|
27
|
-
- -
|
27
|
+
- - ~>
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
hash:
|
29
|
+
hash: 11
|
30
30
|
segments:
|
31
|
+
- 2
|
32
|
+
- 1
|
31
33
|
- 0
|
32
|
-
|
33
|
-
- 8
|
34
|
-
version: 0.9.8
|
34
|
+
version: 2.1.0
|
35
35
|
type: :development
|
36
36
|
version_requirements: *id001
|
37
37
|
- !ruby/object:Gem::Dependency
|
38
|
-
name:
|
38
|
+
name: steak
|
39
39
|
prerelease: false
|
40
40
|
requirement: &id002 !ruby/object:Gem::Requirement
|
41
41
|
none: false
|
42
42
|
requirements:
|
43
|
-
- -
|
43
|
+
- - ~>
|
44
44
|
- !ruby/object:Gem::Version
|
45
|
-
hash:
|
45
|
+
hash: 15424051
|
46
46
|
segments:
|
47
|
+
- 1
|
48
|
+
- 0
|
47
49
|
- 0
|
50
|
+
- rc
|
48
51
|
- 3
|
49
|
-
|
50
|
-
version: 0.3.9
|
52
|
+
version: 1.0.0.rc.3
|
51
53
|
type: :development
|
52
54
|
version_requirements: *id002
|
53
55
|
- !ruby/object:Gem::Dependency
|
54
|
-
name:
|
56
|
+
name: bundler
|
55
57
|
prerelease: false
|
56
58
|
requirement: &id003 !ruby/object:Gem::Requirement
|
57
59
|
none: false
|
58
60
|
requirements:
|
59
61
|
- - ~>
|
60
62
|
- !ruby/object:Gem::Version
|
61
|
-
hash:
|
63
|
+
hash: 25
|
62
64
|
segments:
|
63
|
-
-
|
64
|
-
- 0
|
65
|
+
- 1
|
65
66
|
- 0
|
66
|
-
|
67
|
+
- 7
|
68
|
+
version: 1.0.7
|
67
69
|
type: :development
|
68
70
|
version_requirements: *id003
|
69
71
|
- !ruby/object:Gem::Dependency
|
70
|
-
name:
|
72
|
+
name: rails
|
71
73
|
prerelease: false
|
72
74
|
requirement: &id004 !ruby/object:Gem::Requirement
|
73
75
|
none: false
|
74
76
|
requirements:
|
75
|
-
- -
|
77
|
+
- - ~>
|
76
78
|
- !ruby/object:Gem::Version
|
77
|
-
hash:
|
79
|
+
hash: 7
|
78
80
|
segments:
|
81
|
+
- 3
|
79
82
|
- 0
|
80
|
-
|
81
|
-
|
83
|
+
- 0
|
84
|
+
version: 3.0.0
|
85
|
+
type: :runtime
|
82
86
|
version_requirements: *id004
|
83
87
|
- !ruby/object:Gem::Dependency
|
84
88
|
name: devise
|
@@ -88,12 +92,12 @@ dependencies:
|
|
88
92
|
requirements:
|
89
93
|
- - ~>
|
90
94
|
- !ruby/object:Gem::Version
|
91
|
-
hash:
|
95
|
+
hash: 7712074
|
92
96
|
segments:
|
93
97
|
- 1
|
94
|
-
-
|
95
|
-
-
|
96
|
-
version: 1.
|
98
|
+
- 2
|
99
|
+
- rc
|
100
|
+
version: 1.2.rc
|
97
101
|
type: :runtime
|
98
102
|
version_requirements: *id005
|
99
103
|
description: It adds support for send invitations by email (it requires to be authenticated) and accept the invitation by setting a password.
|
@@ -106,29 +110,32 @@ extensions: []
|
|
106
110
|
extra_rdoc_files: []
|
107
111
|
|
108
112
|
files:
|
109
|
-
- app/controllers/devise/invitations_controller.rb
|
110
113
|
- app/views/devise/invitations/edit.html.erb
|
111
114
|
- app/views/devise/invitations/new.html.erb
|
115
|
+
- app/views/devise/mailer/invitation_instructions.html.erb
|
112
116
|
- app/views/devise/mailer/invitation.html.erb
|
117
|
+
- app/controllers/devise/invitations_controller.rb~
|
118
|
+
- app/controllers/devise/invitations_controller.rb
|
113
119
|
- config/locales/en.yml
|
114
|
-
- lib/devise_invitable.rb
|
115
|
-
- lib/devise_invitable/mailer.rb
|
116
|
-
- lib/devise_invitable/model.rb
|
117
120
|
- lib/devise_invitable/rails.rb
|
118
|
-
- lib/devise_invitable/routes.rb
|
119
121
|
- lib/devise_invitable/schema.rb
|
122
|
+
- lib/devise_invitable/mailer.rb
|
123
|
+
- lib/devise_invitable/routes.rb
|
124
|
+
- lib/devise_invitable/version.rb
|
125
|
+
- lib/devise_invitable/model.rb
|
126
|
+
- lib/devise_invitable/model.rb~
|
120
127
|
- lib/devise_invitable/controllers/helpers.rb
|
121
128
|
- lib/devise_invitable/controllers/url_helpers.rb
|
122
|
-
- lib/devise_invitable
|
123
|
-
- lib/generators/active_record/devise_invitable_generator.rb
|
124
|
-
- lib/generators/active_record/templates/migration.rb
|
129
|
+
- lib/devise_invitable.rb
|
125
130
|
- lib/generators/devise_invitable/views_generator.rb
|
126
131
|
- lib/generators/devise_invitable/devise_invitable_generator.rb
|
127
132
|
- lib/generators/devise_invitable/install_generator.rb
|
133
|
+
- lib/generators/active_record/devise_invitable_generator.rb
|
134
|
+
- lib/generators/active_record/templates/migration.rb
|
128
135
|
- LICENSE
|
129
136
|
- README.rdoc
|
130
137
|
has_rdoc: true
|
131
|
-
homepage:
|
138
|
+
homepage: http://github.com/rymai/devise_invitable
|
132
139
|
licenses: []
|
133
140
|
|
134
141
|
post_install_message:
|
@@ -152,7 +159,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
152
159
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
153
160
|
none: false
|
154
161
|
requirements:
|
155
|
-
- -
|
162
|
+
- - ~>
|
156
163
|
- !ruby/object:Gem::Version
|
157
164
|
hash: 23
|
158
165
|
segments:
|
@@ -163,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
163
170
|
requirements: []
|
164
171
|
|
165
172
|
rubyforge_project:
|
166
|
-
rubygems_version: 1.
|
173
|
+
rubygems_version: 1.3.7
|
167
174
|
signing_key:
|
168
175
|
specification_version: 3
|
169
176
|
summary: An invitation strategy for Devise
|