devise_invitable 1.0.2 → 1.0.3

data/README.rdoc

@@ -96,6 +96,8 @@ or directly as parameters to the <tt>devise</tt> method:
 
 * resend_invitation: resend invitation if user with invited status is invited again. Enabled by default.
 
+* invited_by_class_name: The class name of the inviting model. If this is nil, polymorphic association is used.
+
 For more details, see <tt>config/initializers/devise.rb</tt> (after you invoked the "devise_invitable:install" generator described above).
 
 == Configuring views
@@ -153,6 +155,15 @@ You can add :skip_invitation to attributes hash if skip_invitation is added to a
   User.invite!(:email => "new_user@example.com", :name => "John Doe", :skip_invitation => true)
   # => the record will be created, but the invitation email will not be sent
 
+You can send an invitation to an existing user if your workflow creates them separately:
+
+  user = User.find(42)
+  user.invite!(current_user)  # current user is optional to set the invited_by attribute
+
+You can also set <tt>invited_by</tt> when using the <tt>invite!</tt> class method:
+
+  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.
@@ -171,6 +182,13 @@ A callback event is fired before and after an invitation is accepted (User#accep
 
 The callbacks support all options and arguments available to the standard callbacks provided by AR.
 
+=== Scopes
+
+A pair of scopes to find those users that have accepted, and those that have not accepted, invitations are defined:
+
+  User.invitation_accepted # => returns all Users for whom the invitation_accepted_at attribute is not nil
+  User.invitation_not_accepted # => returns all Users for whom the invitation_accepted_at attribute is nil
+
 == Integration in a Rails application
 
 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.

data/app/views/devise/invitations/edit.html.erb

@@ -1,4 +1,4 @@
-<h2>Set your password</h2>
+<h2><%= t 'devise.invitations.edit.header' %></h2>
 
 <%= form_for resource, :as => resource_name, :url => invitation_path(resource_name), :html => { :method => :put } do |f| %>
   <%= devise_error_messages! %>
@@ -10,5 +10,5 @@
   <p><%= f.label :password_confirmation %><br />
   <%= f.password_field :password_confirmation %></p>
 
-  <p><%= f.submit "Set my password" %></p>
+  <p><%= f.submit t("devise.invitations.edit.submit_button") %></p>
 <% end %>

data/app/views/devise/invitations/new.html.erb

@@ -1,4 +1,4 @@
-<h2>Send invitation</h2>
+<h2><%= t "devise.invitations.new.header" %></h2>
 
 <%= form_for resource, :as => resource_name, :url => invitation_path(resource_name), :html => {:method => :post} do |f| %>
   <%= devise_error_messages! %>
@@ -8,7 +8,5 @@
   <%= f.text_field field %></p>
 <% end -%>
 
-  <p><%= f.submit "Send an invitation" %></p>
+  <p><%= f.submit t("devise.invitations.new.submit_button") %></p>
 <% end %>
-
-<%= link_to "Home", after_sign_in_path_for(resource_name) %><br />

data/config/locales/en.yml

@@ -5,6 +5,12 @@ en:
       invitation_token_invalid: 'The invitation token provided is not valid!'
       updated: 'Your password was set successfully. You are now signed in.'
       no_invitations_remaining: "No invitations remaining"
+      new:
+        header: "Send invitation"
+        submit_button: "Send an invitation"
+      edit:
+        header: "Set your password"
+        submit_button: "Set my password"
     mailer:
       invitation_instructions:
         subject: 'Invitation instructions'

data/lib/devise_invitable.rb

@@ -54,6 +54,11 @@ module Devise
   #   config.resend_invitation = false
   mattr_accessor :resend_invitation
   @@resend_invitation = true
+
+  # Public: The class name of the inviting model. If this is nil,
+  # the #invited_by association is declared to be polymorphic. (default: nil)
+  mattr_accessor :invited_by_class_name
+  @@invited_by_class_name = nil
 end
 
 Devise.add_module :invitable, :controller => :invitations, :model => 'devise_invitable/model', :route => :invitation

data/lib/devise_invitable/controllers/registrations.rb

@@ -10,30 +10,29 @@ module DeviseInvitable::Controllers::Registrations
     if hash && hash[:email]
       resource = resource_class.where(:email => hash[:email], :encrypted_password => '').first
       if resource
-        @invitation_info = {}
-        @invitation_info[:invitation_sent_at] = resource[:invitation_sent_at]
-        @invitation_info[:invited_by_id] = resource[:invited_by_id]
-        @invitation_info[:invited_by_type] = resource[:invited_by_type]
+        @invitation_info = Hash[resource.invitation_fields.map {|field|
+          [field, resource[field]]
+        }]
         resource.destroy
       end
     end
   end
-  
+
   def keep_invitation_info
     resource_invitable = resource_class.devise_modules.include?(:invitable)
     destroy_if_previously_invited if resource_invitable
     yield
     reset_invitation_info if resource_invitable
   end
-  
+
   def reset_invitation_info
     # Restore info about the last invitation (for later reference)
     # Reset the invitation_info only, if invited_by_id is still nil at this stage:
     resource = resource_class.where(:email => params[resource_name][:email], :invited_by_id => nil).first
     if resource && @invitation_info
-      resource[:invitation_sent_at] = @invitation_info[:invitation_sent_at]
-      resource[:invited_by_id] = @invitation_info[:invited_by_id]
-      resource[:invited_by_type] = @invitation_info[:invited_by_type]
+      resource.invitation_fields.each do |field|
+        resource[field] = @invitation_info[field]
+      end
       resource.save!
     end
   end

data/lib/devise_invitable/mailer.rb

@@ -1,6 +1,6 @@
 module DeviseInvitable
   module Mailer
-    
+
     # Deliver an invitation email
     def invitation_instructions(record)
       devise_mail(record, :invitation_instructions)

data/lib/devise_invitable/model.rb

@@ -27,55 +27,93 @@ module Devise
       attr_accessor :completing_invite
 
       included do
-        include ::DeviseInvitable::Inviter        
-        belongs_to :invited_by, :polymorphic => true
-        
+        include ::DeviseInvitable::Inviter
+        if Devise.invited_by_class_name
+          belongs_to :invited_by, :class_name => Devise.invited_by_class_name
+        else
+          belongs_to :invited_by, :polymorphic => true
+        end
+
         include ActiveSupport::Callbacks
         define_callbacks :invitation_accepted
-        
+
         attr_writer :skip_password
+
+        scope :invitation_not_accepted, where(:invitation_accepted_at => nil)
+        if defined?(Mongoid) && self < Mongoid::Document
+          scope :invitation_accepted, where(:invitation_accepted_at.ne => nil)
+        else
+          scope :invitation_accepted, where(arel_table[:invitation_accepted_at].not_eq(nil))
+        end
+      end
+
+      def self.required_fields(klass)
+        fields = [:invitation_token, :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
+      end
+
+      def invitation_fields
+        fields = [:invitation_sent_at, :invited_by_id, :invited_by_type]
+        if Devise.invited_by_class_name
+          fields -= :invited_by_type
+        end
+        fields
       end
 
       # Accept an invitation by clearing invitation token and and setting invitation_accepted_at
       # Confirms it if model is confirmable
       def accept_invitation!
-        self.completing_invite = true
+        self.invitation_accepted_at = Time.now.utc
         if self.invited_to_sign_up? && self.valid?
           run_callbacks :invitation_accepted do
             self.invitation_token = nil
-            self.invitation_accepted_at = Time.now.utc if respond_to? :"invitation_accepted_at="
-            self.completing_invite = false
             self.save(:validate => false)
           end
         end
       end
 
-      # Verifies whether a user has accepted an invite, was never invited, or is in the process of accepting an invitation, or not
+      # Verifies whether a user has accepted an invitation (or is accepting it), or was never invited
       def accepting_or_not_invited?
-        !!completing_invite || !invited_to_sign_up?
+        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?
       end
-      
+
+      # Verifies whether a user accepted an invitation (or is accepting it)
+      def invitation_accepted?
+        invitation_accepted_at.present?
+      end
+
+      # Verifies whether a user has accepted an invitation (or is accepting it), or was never invited
+      def accepted_or_not_invited?
+        invitation_accepted? || !invited_to_sign_up?
+      end
+
       def invited?
+        ActiveSupport::Deprecation.warn "invited? is deprecated and will be removed from DeviseInvitable 1.1.0 (use invited_to_sign_up? instead)"
         invited_to_sign_up?
       end
-      deprecate :invited?
 
       # Reset invitation token and send invitation again
-      def invite!
+      def invite!(invited_by = nil)
         was_invited = invited_to_sign_up?
         self.skip_confirmation! if self.new_record? && self.respond_to?(:skip_confirmation!)
         generate_invitation_token if self.invitation_token.nil?
         self.invitation_sent_at = Time.now.utc
+        self.invited_by = invited_by if invited_by
         
         # Call these before_validate methods since we aren't validating on save
         self.downcase_keys if self.new_record? && self.respond_to?(:downcase_keys)
         self.strip_whitespace if self.new_record? && self.respond_to?(:strip_whitespace)
-        
+
         if save(:validate => false)
           self.invited_by.decrement_invitation_limit! if !was_invited and self.invited_by.present?
           deliver_invitation unless @skip_invitation
@@ -93,12 +131,12 @@ module Devise
       def valid_password?(password)
         super unless invited_to_sign_up?
       end
-      
+
       def reset_password!(new_password, new_password_confirmation)
         super
         accept_invitation!
       end
-      
+
       def invite_key_valid?
         return true unless self.class.invite_key.is_a? Hash # FIXME: remove this line when deprecation is removed
         self.class.invite_key.all? do |key, regexp|
@@ -156,7 +194,7 @@ module Devise
             Array(invite_key)
           end
         end
-        
+
         # Attempt to find a user by it's email. If a record is not found, create a new
         # user and send invitation to it. If user is found, returns the user with an
         # email already exists error.
@@ -190,7 +228,7 @@ module Devise
           end
           [invitable, mail]
         end
-        
+
         # Override this method if the invitable is using Mass Assignment Security
         # and the inviter has a non-default role.
         def inviter_role(inviter)
@@ -226,16 +264,16 @@ module Devise
         def invitation_token
           generate_token(:invitation_token)
         end
-        
+
         # Callback convenience methods
         def before_invitation_accepted(*args, &blk)
           set_callback(:invitation_accepted, :before, *args, &blk)
         end
-        
+
         def after_invitation_accepted(*args, &blk)
           set_callback(:invitation_accepted, :after, *args, &blk)
         end
-        
+
 
         Devise::Models.config(self, :invite_for)
         Devise::Models.config(self, :validate_on_invite)

data/lib/devise_invitable/routes.rb

@@ -1,6 +1,6 @@
 module ActionDispatch::Routing
   class Mapper
-    
+
   protected
     def devise_invitation(mapping, controllers)
       resource :invitation, :only => [:new, :create, :update],
@@ -8,6 +8,6 @@ module ActionDispatch::Routing
         get :edit, :path => mapping.path_names[:accept], :as => :accept
       end
     end
-    
+
   end
 end

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/lib/generators/devise_invitable/install_generator.rb

@@ -3,16 +3,16 @@ module DeviseInvitable
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path("../../templates", __FILE__)
       desc "Add DeviseInvitable config variables to the Devise initializer and copy DeviseInvitable locale files to your application."
-      
+
       # def devise_install
       #   invoke "devise:install"
       # end
-      
+
       def add_config_options_to_initializer
         devise_initializer_path = "config/initializers/devise.rb"
         if File.exist?(devise_initializer_path)
           old_content = File.read(devise_initializer_path)
-          
+
           if old_content.match(Regexp.new(/^\s# ==> Configuration for :invitable\n/))
             false
           else
@@ -23,20 +23,20 @@ module DeviseInvitable
   # 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, users can send unlimited invitations.
   # If invitation_limit is 0, users can't send invitations.
   # If invitation_limit n > 0, users can send n invitations.
   # Default: nil
   # config.invitation_limit = 5
-  
+
   # The key to be used to check existing users when sending an invitation
   # 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 
+
+  # Flag that force a record to be valid before being actually invited
   # Default: false
   # config.validate_on_invite = true
 
@@ -45,11 +45,11 @@ CONTENT
           end
         end
       end
-      
+
       def copy_locale
         copy_file "../../../config/locales/en.yml", "config/locales/devise_invitable.en.yml"
       end
-      
+
     end
   end
 end

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

@@ -0,0 +1,11 @@
+<h2><%= t 'devise.invitations.edit.header' %></h2>
+
+<%= simple_form_for resource, :as => resource_name, :url => invitation_path(resource_name), :html => { :method => :put } do |f| %>
+  <%= devise_error_messages! %>
+  <%= f.hidden_field :invitation_token %>
+
+  <%= f.input :password %>
+  <%= f.input :password_confirmation %>
+
+  <%= f.submit t("devise.invitations.edit.submit_button") %>
+<% end %>

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

@@ -0,0 +1,11 @@
+<h2><%= t "devise.invitations.new.header" %></h2>
+
+<%= simple_form_for resource, :as => resource_name, :url => invitation_path(resource_name), :html => {:method => :post} do |f| %>
+  <%= devise_error_messages! %>
+
+<% resource.class.invite_key_fields.each do |field| -%>
+  <%= f.input field %>
+<% end -%>
+
+<%= f.submit t("devise.invitations.new.submit_button") %>
+<% end %>

data/lib/generators/devise_invitable/views_generator.rb

@@ -2,18 +2,40 @@ require 'generators/devise/views_generator'
 
 module DeviseInvitable
   module Generators
-    class ViewsGenerator < Rails::Generators::Base
-      desc 'Copies all DeviseInvitable views to your application.'
+    class InvitationViewsGenerator < Rails::Generators::Base
+      include ::Devise::Generators::ViewPathTemplates
+
+      def copy_views
+        view_directory :invitations
+      end
+    end
+
+    class SimpleFormForGenerator < InvitationViewsGenerator
+      source_root File.expand_path("../templates/simple_form_for", __FILE__)
+    end
 
-      argument :scope, :required => false, :default => nil,
-                       :desc => "The scope to copy views to"
+    class FormForGenerator < InvitationViewsGenerator
+      source_root File.expand_path("../../../../app/views/devise", __FILE__)
+    end
 
+    class MailerViewsGenerator < Rails::Generators::Base
       include ::Devise::Generators::ViewPathTemplates
       source_root File.expand_path("../../../../app/views/devise", __FILE__)
+      desc "Copies Devise mail erb views to your application."
+      hide!
+
       def copy_views
-        view_directory :invitations
         view_directory :mailer
       end
     end
+
+    class ViewsGenerator < Rails::Generators::Base
+      desc 'Copies all DeviseInvitable views to your application.'
+      argument :scope, :required => false, :default => nil, :desc => "The scope to copy views to"
+
+      invoke MailerViewsGenerator
+
+      hook_for :form_builder, :aliases => "-b", :desc => "Form builder to be used", :default => defined?(SimpleForm) ? "simple_form_for" : "form_for"
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_invitable
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-26 00:00:00 Z
+date: 2012-07-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
@@ -23,7 +23,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         hash: 19
         segments: 
@@ -34,7 +34,7 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rails
+  name: railties
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -64,6 +64,21 @@ dependencies:
         version: 2.0.0
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: actionmailer
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id004
 description: It adds support for send invitations by email (it requires to be authenticated) and accept the invitation by setting a password.
 email: 
 - sergio@entrecables.com
@@ -97,6 +112,8 @@ files:
 - lib/generators/active_record/templates/migration.rb
 - lib/generators/active_record/devise_invitable_generator.rb
 - lib/generators/mongoid/devise_invitable_generator.rb
+- lib/generators/devise_invitable/templates/simple_form_for/invitations/edit.html.erb
+- lib/generators/devise_invitable/templates/simple_form_for/invitations/new.html.erb
 - lib/generators/devise_invitable/install_generator.rb
 - lib/generators/devise_invitable/views_generator.rb
 - lib/generators/devise_invitable/devise_invitable_generator.rb