devise_invitable 0.5.6 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/README.rdoc
CHANGED
|
@@ -149,6 +149,18 @@ To accept an invitation with a token use the <tt>accept_invitation!</tt> class m
|
|
|
149
149
|
|
|
150
150
|
User.accept_invitation!(:invitation_token => params[:invitation_token], :password => "ad97nwj3o2", :name => "John Doe")
|
|
151
151
|
|
|
152
|
+
=== Callbacks
|
|
153
|
+
|
|
154
|
+
A callback event is fired before and after an invitation is accepted (User#accept_invitation!). For example, in your resource model you can add:
|
|
155
|
+
|
|
156
|
+
after_invitation_accepted :email_invited_by
|
|
157
|
+
|
|
158
|
+
def email_invited_by
|
|
159
|
+
# ...
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
The callbacks support all options and arguments available to the standard callbacks provided by AR.
|
|
163
|
+
|
|
152
164
|
== Integration in a Rails application
|
|
153
165
|
|
|
154
166
|
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.
|
|
@@ -173,7 +185,7 @@ You would have a User model which is configured as invitable and an Admin model
|
|
|
173
185
|
class ApplicationController < ActionController::Base
|
|
174
186
|
protected
|
|
175
187
|
def authenticate_inviter!
|
|
176
|
-
authenticate_admin!(true)
|
|
188
|
+
authenticate_admin!(:force => true)
|
|
177
189
|
end
|
|
178
190
|
end
|
|
179
191
|
|
|
@@ -26,7 +26,7 @@ class Devise::InvitationsController < ApplicationController
|
|
|
26
26
|
|
|
27
27
|
# GET /resource/invitation/accept?invitation_token=abcdef
|
|
28
28
|
def edit
|
|
29
|
-
if params[:invitation_token] && self.resource = resource_class.
|
|
29
|
+
if params[:invitation_token] && self.resource = resource_class.to_adapter.find_first( :invitation_token => params[:invitation_token] )
|
|
30
30
|
render_with_scope :edit
|
|
31
31
|
else
|
|
32
32
|
set_flash_message(:alert, :invitation_token_invalid)
|
|
@@ -55,7 +55,7 @@ class Devise::InvitationsController < ApplicationController
|
|
|
55
55
|
def has_invitations_left?
|
|
56
56
|
unless current_inviter.nil? || current_inviter.has_invitations_left?
|
|
57
57
|
build_resource
|
|
58
|
-
set_flash_message :alert, :no_invitations_remaining
|
|
58
|
+
set_flash_message :alert, :no_invitations_remaining
|
|
59
59
|
respond_with_navigational(resource) { render_with_scope :new }
|
|
60
60
|
end
|
|
61
61
|
end
|
|
@@ -68,3 +68,4 @@ class Devise::InvitationsController < ApplicationController
|
|
|
68
68
|
after_sign_in_path_for(resource)
|
|
69
69
|
end
|
|
70
70
|
end
|
|
71
|
+
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
module DeviseInvitable::Controllers::Helpers
|
|
2
2
|
protected
|
|
3
3
|
def authenticate_inviter!
|
|
4
|
-
send(:"authenticate_#{resource_name}!", true)
|
|
4
|
+
send(:"authenticate_#{resource_name}!", :force => true)
|
|
5
5
|
end
|
|
6
6
|
end
|
|
7
7
|
ActionController::Base.send :include, DeviseInvitable::Controllers::Helpers
|
|
@@ -5,10 +5,5 @@ module DeviseInvitable
|
|
|
5
5
|
def invitation_instructions(record)
|
|
6
6
|
devise_mail(record, :invitation_instructions)
|
|
7
7
|
end
|
|
8
|
-
|
|
9
|
-
def invitation(record)
|
|
10
|
-
ActiveSupport::Deprecation.warn('invitation has been renamed to invitation_instructions')
|
|
11
|
-
invitation_instructions(record)
|
|
12
|
-
end
|
|
13
8
|
end
|
|
14
9
|
end
|
|
@@ -24,17 +24,22 @@ module Devise
|
|
|
24
24
|
attr_accessor :skip_invitation
|
|
25
25
|
|
|
26
26
|
included do
|
|
27
|
-
include ::DeviseInvitable::Inviter
|
|
27
|
+
include ::DeviseInvitable::Inviter
|
|
28
28
|
belongs_to :invited_by, :polymorphic => true
|
|
29
|
+
|
|
30
|
+
include ActiveSupport::Callbacks
|
|
31
|
+
define_callbacks :invitation_accepted
|
|
29
32
|
end
|
|
30
33
|
|
|
31
34
|
# Accept an invitation by clearing invitation token and confirming it if model
|
|
32
35
|
# is confirmable
|
|
33
36
|
def accept_invitation!
|
|
34
37
|
if self.invited? && self.valid?
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
+
run_callbacks :invitation_accepted do
|
|
39
|
+
self.invitation_token = nil
|
|
40
|
+
self.invitation_accepted_at = Time.now.utc if respond_to? :"invitation_accepted_at="
|
|
41
|
+
self.save(:validate => false)
|
|
42
|
+
end
|
|
38
43
|
end
|
|
39
44
|
end
|
|
40
45
|
|
|
@@ -46,11 +51,12 @@ module Devise
|
|
|
46
51
|
# Reset invitation token and send invitation again
|
|
47
52
|
def invite!
|
|
48
53
|
@skip_password = true
|
|
54
|
+
was_invited = invited?
|
|
49
55
|
self.skip_confirmation! if self.new_record? && self.respond_to?(:skip_confirmation!)
|
|
50
56
|
generate_invitation_token if self.invitation_token.nil?
|
|
51
57
|
self.invitation_sent_at = Time.now.utc
|
|
52
|
-
if save(:validate =>
|
|
53
|
-
self.invited_by.decrement_invitation_limit! if self.invited_by
|
|
58
|
+
if save(:validate => false)
|
|
59
|
+
self.invited_by.decrement_invitation_limit! if !was_invited and self.invited_by.present?
|
|
54
60
|
deliver_invitation unless @skip_invitation
|
|
55
61
|
end
|
|
56
62
|
end
|
|
@@ -125,29 +131,30 @@ module Devise
|
|
|
125
131
|
invitable.attributes = attributes
|
|
126
132
|
invitable.invited_by = invited_by
|
|
127
133
|
|
|
134
|
+
invitable.valid? if self.validate_on_invite
|
|
128
135
|
if invitable.new_record?
|
|
129
|
-
invitable.errors.clear if invitable.email.try(:match, Devise.email_regexp)
|
|
136
|
+
invitable.errors.clear if !self.validate_on_invite and invitable.email.try(:match, Devise.email_regexp)
|
|
130
137
|
else
|
|
131
138
|
invitable.errors.add(invite_key, :taken) unless invitable.invited? && self.resend_invitation
|
|
132
139
|
end
|
|
133
140
|
|
|
134
|
-
if
|
|
141
|
+
if invitable.errors.empty?
|
|
135
142
|
yield invitable if block_given?
|
|
136
143
|
mail = invitable.invite!
|
|
137
144
|
end
|
|
138
145
|
[invitable, mail]
|
|
139
146
|
end
|
|
140
|
-
|
|
147
|
+
|
|
141
148
|
def invite!(attributes={}, invited_by=nil, &block)
|
|
142
149
|
invitable, mail = _invite(attributes, invited_by, &block)
|
|
143
150
|
invitable
|
|
144
151
|
end
|
|
145
|
-
|
|
152
|
+
|
|
146
153
|
def invite_mail!(attributes={}, invited_by=nil, &block)
|
|
147
154
|
invitable, mail = _invite(attributes, invited_by, &block)
|
|
148
155
|
mail
|
|
149
156
|
end
|
|
150
|
-
|
|
157
|
+
|
|
151
158
|
# Attempt to find a user by it's invitation_token to set it's password.
|
|
152
159
|
# If a user is found, reset it's password and automatically try saving
|
|
153
160
|
# the record. If not user is found, returns a new user containing an
|
|
@@ -167,6 +174,16 @@ module Devise
|
|
|
167
174
|
def invitation_token
|
|
168
175
|
generate_token(:invitation_token)
|
|
169
176
|
end
|
|
177
|
+
|
|
178
|
+
# Callback convenience methods
|
|
179
|
+
def before_invitation_accepted(*args, &blk)
|
|
180
|
+
set_callback(:invitation_accepted, :before, *args, &blk)
|
|
181
|
+
end
|
|
182
|
+
|
|
183
|
+
def after_invitation_accepted(*args, &blk)
|
|
184
|
+
set_callback(:invitation_accepted, :after, *args, &blk)
|
|
185
|
+
end
|
|
186
|
+
|
|
170
187
|
|
|
171
188
|
Devise::Models.config(self, :invite_for)
|
|
172
189
|
Devise::Models.config(self, :validate_on_invite)
|
|
@@ -177,3 +194,4 @@ module Devise
|
|
|
177
194
|
end
|
|
178
195
|
end
|
|
179
196
|
end
|
|
197
|
+
|
metadata
CHANGED
|
@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
|
|
|
5
5
|
prerelease:
|
|
6
6
|
segments:
|
|
7
7
|
- 0
|
|
8
|
-
- 5
|
|
9
8
|
- 6
|
|
10
|
-
|
|
9
|
+
- 0
|
|
10
|
+
version: 0.6.0
|
|
11
11
|
platform: ruby
|
|
12
12
|
authors:
|
|
13
13
|
- Sergio Cambra
|
|
@@ -15,7 +15,7 @@ autorequire:
|
|
|
15
15
|
bindir: bin
|
|
16
16
|
cert_chain: []
|
|
17
17
|
|
|
18
|
-
date: 2011-
|
|
18
|
+
date: 2011-11-15 00:00:00 Z
|
|
19
19
|
dependencies:
|
|
20
20
|
- !ruby/object:Gem::Dependency
|
|
21
21
|
name: bundler
|
|
@@ -62,14 +62,21 @@ dependencies:
|
|
|
62
62
|
requirement: &id003 !ruby/object:Gem::Requirement
|
|
63
63
|
none: false
|
|
64
64
|
requirements:
|
|
65
|
-
- -
|
|
65
|
+
- - ">="
|
|
66
66
|
- !ruby/object:Gem::Version
|
|
67
|
-
hash:
|
|
67
|
+
hash: 11
|
|
68
68
|
segments:
|
|
69
69
|
- 1
|
|
70
70
|
- 4
|
|
71
|
+
- 6
|
|
72
|
+
version: 1.4.6
|
|
73
|
+
- - <
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
hash: 3
|
|
76
|
+
segments:
|
|
71
77
|
- 1
|
|
72
|
-
|
|
78
|
+
- 6
|
|
79
|
+
version: "1.6"
|
|
73
80
|
type: :runtime
|
|
74
81
|
version_requirements: *id003
|
|
75
82
|
description: It adds support for send invitations by email (it requires to be authenticated) and accept the invitation by setting a password.
|