devise_invitable 0.4.2 → 0.5.1

data/README.rdoc

@@ -97,6 +97,28 @@ You can also use the generator to generate scoped views:
 
 Please refer to {Devise's README}[http://github.com/plataformatec/devise] for more information about views.
 
+== Configuring controllers
+
+To change the controller's behavior, create a controller that inherits from <tt>Devise::InvitationsController</tt>. The available methods are: new, create, edit, and update. You should read the {original controllers source}[https://raw.github.com/scambra/devise_invitable/master/app/controllers/devise/invitations_controller.rb] before editing any of these actions. Your controller might now look something like this:
+
+   class Users::InvitationsController < Devise::InvitationsController
+     def update
+       if this
+         redirect_to root_path
+       else
+         super
+       end
+     end
+   end
+
+Now just tell Devise that you want to use your controller, the controller above is 'users/invitations', so our routes.rb would have this line:
+
+  devise_for :users, :controllers => { :invitations => 'users/invitations' }
+
+be sure that you generate the views and put them into the controller that you generated, so for this example it would be:
+
+  rails generate devise_invitable:views users/invitations
+
 == Usage
 
 === Send an invitation
@@ -128,10 +150,12 @@ To accept an invitation with a token use the <tt>accept_invitation!</tt> class m
 
 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.
 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).
+
 After an invitation is created and sent, the inviter will be redirected to after_sign_in_path_for(resource_name).
 
+After an invitation is accepted, the invitee will be redirected to after_accept_path_for(resource), which is the same path as after_sign_in_path_for by default. If you want to override the path, override invitations controller and define after_accept_path_for method. This is useful in the common case that a user is invited to a specific location in your application. More on {Devise's README}[http://github.com/plataformatec/devise], "Controller filters and helpers" section.
+
 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).
-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.
 
 The controller sets the invited_by_id attribute for the new user to the current user.  This will let you easily keep track of who invited who.
 
@@ -150,6 +174,13 @@ You would have a User model which is configured as invitable and an Admin model
     end
   end
 
+And include DeviseInvitable::Inviter module into Admin model:
+
+  class Admin < ActiveRecord::Base
+    devise :database_authenticatable, :validatable
+    include DeviseInvitable::Inviter
+  end
+
 == I18n
 
 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:

data/app/controllers/devise/invitations_controller.rb

@@ -18,9 +18,9 @@ class Devise::InvitationsController < ApplicationController
 
     if resource.errors.empty?
       set_flash_message :notice, :send_instructions, :email => self.resource.email
-      redirect_to after_sign_in_path_for(resource_name)
+      respond_with resource, :location => redirect_location(resource_name, resource)
     else
-      render_with_scope :new
+      respond_with_navigational(resource) { render_with_scope :new }
     end
   end
 
@@ -40,9 +40,10 @@ class Devise::InvitationsController < ApplicationController
 
     if resource.errors.empty?
       set_flash_message :notice, :updated
-      sign_in_and_redirect(resource_name, resource)
+      sign_in(resource_name, resource)
+      respond_with resource, :location => after_accept_path_for(resource)
     else
-      render_with_scope :edit
+      respond_with_navigational(resource){ render_with_scope :edit }
     end
   end
 
@@ -55,7 +56,11 @@ class Devise::InvitationsController < ApplicationController
     unless current_inviter.nil? || current_inviter.has_invitations_left?
       build_resource
       set_flash_message :alert, :no_invitations_remaining 
-      render_with_scope :new
+      respond_with_navigational(resource) { render_with_scope :new }
     end
   end
+
+  def after_accept_path_for(resource)
+    after_sign_in_path_for(resource)
+  end
 end

data/lib/devise_invitable/inviter.rb

@@ -0,0 +1,39 @@
+module DeviseInvitable
+  module Inviter
+    extend ActiveSupport::Concern
+
+    included do
+      extend ClassMethods
+      attr_writer :invitation_limit unless respond_to? :invitation_limit
+    end
+
+    def invitation_limit
+      self[:invitation_limit] || self.class.invitation_limit
+    end
+
+    # Return true if this user has invitations left to send
+    def has_invitations_left?
+      if self.class.invitation_limit.present?
+        if invitation_limit
+          return invitation_limit > 0
+        else
+          return self.class.invitation_limit > 0
+        end
+      else
+        return true
+      end
+    end
+
+    protected
+      def decrement_invitation_limit!
+        if self.class.invitation_limit.present?
+          self.invitation_limit ||= self.class.invitation_limit
+          self.update_attribute(:invitation_limit, invitation_limit - 1)
+        end
+      end
+
+    module ClassMethods
+      Devise::Models.config(self, :invitation_limit)
+    end
+  end
+end

data/lib/devise_invitable/model.rb

@@ -24,6 +24,7 @@ module Devise
       attr_accessor :skip_invitation
 
       included do
+        include ::DeviseInvitable::Inviter
         belongs_to :invited_by, :polymorphic => true
       end
 
@@ -41,19 +42,6 @@ module Devise
         persisted? && invitation_token.present?
       end
 
-      # Return true if this user has invitations left to send
-      def has_invitations_left?
-        if self.class.invitation_limit.present?
-          if invitation_limit
-            return invitation_limit > 0
-          else
-            return self.class.invitation_limit > 0
-          end
-        else
-          return true
-        end
-      end
-
       # Reset invitation token and send invitation again
       def invite!
         if new_record? || invited?
@@ -81,13 +69,6 @@ module Devise
       end
 
       protected
-        def decrement_invitation_limit!
-          if self.class.invitation_limit.present?
-            self.invitation_limit ||= self.class.invitation_limit
-            self.update_attribute(:invitation_limit, invitation_limit - 1)
-          end
-        end
-
         # Overriding the method in Devise's :validatable module so password is not required on inviting
         def password_required?
           !@skip_password && super

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '0.4.2'
+  VERSION = '0.5.1'
 end

data/lib/devise_invitable.rb

@@ -1,5 +1,9 @@
 require 'devise'
 
+module DeviseInvitable
+  autoload :Inviter, 'devise_invitable/inviter'
+end
+
 require 'devise_invitable/mailer'
 require 'devise_invitable/routes'
 require 'devise_invitable/schema'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_invitable
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-25 00:00:00 +02:00
+date: 2011-06-24 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,7 +40,7 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         hash: 7
         segments: 
@@ -48,6 +48,13 @@ dependencies:
         - 0
         - 0
         version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 3
+        - 2
+        version: "3.2"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -58,20 +65,19 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 25
         segments: 
         - 1
-        - 2
-        - 0
-        version: 1.2.0
-    - - <=
+        - 3
+        - 1
+        version: 1.3.1
+    - - <
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 5
         segments: 
         - 1
-        - 4
-        - 0
-        version: 1.4.0
+        - 5
+        version: "1.5"
   type: :runtime
   version_requirements: *id003
 description: It adds support for send invitations by email (it requires to be authenticated) and accept the invitation by setting a password.
@@ -98,6 +104,7 @@ files:
 - lib/devise_invitable/controllers/helpers.rb
 - lib/devise_invitable/controllers/url_helpers.rb
 - lib/devise_invitable/version.rb
+- lib/devise_invitable/inviter.rb
 - lib/generators/active_record/devise_invitable_generator.rb
 - lib/generators/active_record/templates/migration.rb
 - lib/generators/devise_invitable/views_generator.rb