devise_invitable 1.0.0 → 1.0.1

data/README.rdoc

@@ -1,10 +1,11 @@
 = DeviseInvitable
+{<img src="https://secure.travis-ci.org/scambra/devise_invitable.png"/>}[http://travis-ci.org/scambra/devise_invitable]
 
 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.
 
 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]
 
-== Installation for Rails ~> 3.0 and Devise ~> 1.2
+== Installation
 
 Install DeviseInvitable gem, it will also install dependencies (such as devise and warden):
 
@@ -12,8 +13,8 @@ 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', '~> 0.7.0'
+  gem 'devise',           '>= 2.0.0'
+  gem 'devise_invitable', '~> 1.0.0'
 
 === Automatic installation
 
@@ -50,7 +51,7 @@ Add t.invitable to your Devise model migration:
       t.string   :invited_by_type
     ...
   end
-  add_index :users, :invitation_token
+  add_index :users, :invitation_token, :unique => true
 
 or for a model that already exists, define a migration to add DeviseInvitable to your model:
 
@@ -65,9 +66,9 @@ or for a model that already exists, define a migration to add DeviseInvitable to
   end
 
   # Allow null encrypted_password
-  change_column_null :users, :encrypted_password, true
+  change_column :users, :encrypted_password, :string, :null => true
   # Allow null password_salt (add it if you are using Devise's encryptable module)
-  change_column_null :users, :password_salt, true
+  change_column :users, :password_salt, :string, :null => true
 
 == Model configuration
 
@@ -165,7 +166,7 @@ A callback event is fired before and after an invitation is accepted (User#accep
   after_invitation_accepted :email_invited_by
 
   def email_invited_by
-     # ... 
+     # ...
   end
 
 The callbacks support all options and arguments available to the standard callbacks provided by AR.
@@ -262,7 +263,7 @@ http://github.com/scambra/devise_invitable/contributors
 Special thanks to rymai[http://github.com/rymai] for the Rails 3 support, his fork was a great help.
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a future version unintentionally.

data/lib/devise_invitable/controllers/registrations.rb

@@ -0,0 +1,36 @@
+module DeviseInvitable::Controllers::Registrations
+  def self.included(controller)
+    controller.send :around_filter, :destroy_if_previously_invited, :only => :create
+  end
+
+  protected
+
+  def destroy_if_previously_invited
+    invitation_info = {}
+
+    hash = params[resource_name]
+    if hash && hash[:email]
+      resource = resource_class.first(:conditions => { :email => hash[:email], :encrypted_password => '' })
+      if resource
+        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]
+        resource.destroy
+      end
+    end
+
+    # execute the action (create)
+    yield
+    # Note that the after_filter is executed at THIS position !
+
+    # 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.first(:conditions => { :email => hash[:email], :invited_by_id => nil })
+    if resource
+      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.save!
+    end
+  end
+end

data/lib/devise_invitable/controllers/url_helpers.rb

@@ -13,7 +13,7 @@ module DeviseInvitable
                 else
                   resource.class.name.underscore
               end
-              
+
               send("#{action}\#{resource}_invitation_#{path_or_url}", *args)
             end
           URL_HELPERS

data/lib/devise_invitable/model.rb

@@ -56,6 +56,11 @@ module Devise
         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
+        
+        # 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

data/lib/devise_invitable/rails.rb

@@ -1,16 +1,16 @@
 module DeviseInvitable
   class Engine < ::Rails::Engine
-    
+
     ActiveSupport.on_load(:action_controller) { include DeviseInvitable::Controllers::UrlHelpers }
     ActiveSupport.on_load(:action_view)       { include DeviseInvitable::Controllers::UrlHelpers }
-    
+
     # 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.
     config.to_prepare do
       require 'devise/mailer'
       Devise::Mailer.send :include, DeviseInvitable::Mailer
+      Devise::RegistrationsController.send :include, DeviseInvitable::Controllers::Registrations
     end
-    
   end
 end

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/devise_invitable.rb

@@ -7,11 +7,12 @@ end
 require 'devise_invitable/mailer'
 require 'devise_invitable/routes'
 require 'devise_invitable/controllers/url_helpers'
+require 'devise_invitable/controllers/registrations'
 require 'devise_invitable/controllers/helpers'
 require 'devise_invitable/rails'
 
 module Devise
-  # Public: Validity period of the invitation token (default: 0). If 
+  # Public: Validity period of the invitation token (default: 0). If
   # invite_for is 0 or nil, the invitation will never expire.
   # Set invite_for in the Devise configuration file (in config/initializers/devise.rb).
   #
@@ -19,7 +20,7 @@ module Devise
   mattr_accessor :invite_for
   @@invite_for = 0
 
-  # Public: Flag that force a record to be valid before being actually invited 
+  # Public: Flag that force a record to be valid before being actually invited
   # (default: false).
   #
   # Examples (in config/initializers/devise.rb)
@@ -35,7 +36,7 @@ module Devise
   #   config.invitation_limit = nil
   mattr_accessor :invitation_limit
   @@invitation_limit = nil
-  
+
   # Public: The key to be used to check existing users when sending an invitation
   #
   # Examples (in config/initializers/devise.rb)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_invitable
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-31 00:00:00 Z
+date: 2012-04-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
@@ -25,12 +25,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 25
+        hash: 19
         segments: 
         - 1
+        - 1
         - 0
-        - 7
-        version: 1.0.7
+        version: 1.1.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -54,7 +54,7 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         hash: 15
         segments: 
@@ -79,21 +79,21 @@ files:
 - app/views/devise/invitations/new.html.erb
 - app/views/devise/mailer/invitation_instructions.html.erb
 - config/locales/en.yml
-- lib/devise_invitable.rb
+- lib/devise_invitable/controllers/helpers.rb
+- lib/devise_invitable/controllers/registrations.rb
+- lib/devise_invitable/controllers/url_helpers.rb
+- lib/devise_invitable/inviter.rb
 - lib/devise_invitable/mailer.rb
 - lib/devise_invitable/model.rb
 - lib/devise_invitable/rails.rb
 - lib/devise_invitable/routes.rb
-- lib/devise_invitable/controllers/helpers.rb
-- lib/devise_invitable/controllers/url_helpers.rb
 - lib/devise_invitable/version.rb
-- lib/devise_invitable/inviter.rb
-- lib/devise_invitable/model.rb~
+- lib/devise_invitable.rb
 - lib/generators/active_record/devise_invitable_generator.rb
 - lib/generators/active_record/templates/migration.rb
-- lib/generators/devise_invitable/views_generator.rb
 - lib/generators/devise_invitable/devise_invitable_generator.rb
 - lib/generators/devise_invitable/install_generator.rb
+- lib/generators/devise_invitable/views_generator.rb
 - lib/generators/mongoid/devise_invitable_generator.rb
 - LICENSE
 - README.rdoc
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: An invitation strategy for Devise

data/lib/devise_invitable/model.rb~

@@ -1,210 +0,0 @@
-module Devise
-  module Models
-    # Invitable is responsible for sending invitation emails.
-    # When an invitation is sent to an email address, an account is created for it.
-    # Invitation email contains a link allowing the user to accept the invitation
-    # by setting a password (as reset password from Devise's recoverable module).
-    #
-    # Configuration:
-    #
-    #   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.
-    #
-    # Examples:
-    #
-    #   User.find(1).invited?                               # => true/false
-    #   User.invite!(:email => 'someone@example.com')       # => send invitation
-    #   User.accept_invitation!(:invitation_token => '...') # => accept invitation with a token
-    #   User.find(1).accept_invitation!                     # => accept invitation
-    #   User.find(1).invite!                                # => reset invitation status and send invitation again
-    module Invitable
-      extend ActiveSupport::Concern
-
-      attr_accessor :skip_invitation
-
-      included do
-        include ::DeviseInvitable::Inviter        
-        belongs_to :invited_by, :polymorphic => true
-        
-        include ActiveSupport::Callbacks
-        define_callbacks :invitation_accepted
-        
-        attr_writer :skip_password
-      end
-
-      # Accept an invitation by clearing invitation token and and setting invitation_accepted_at
-      # Confirms it if model is confirmable
-      def accept_invitation!
-        if self.invited? && 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.save(:validate => false)
-          end
-        end
-      end
-
-      # Verifies whether a user has been invited or not
-      def invited?
-        persisted? && invitation_token.present?
-      end
-
-      # Reset invitation token and send invitation again
-      def invite!
-        was_invited = invited?
-        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
-        if save(:validate => false)
-          self.invited_by.decrement_invitation_limit! if !was_invited and self.invited_by.present?
-          deliver_invitation unless @skip_invitation
-        end
-      end
-
-      # Verify whether a invitation is active or not. If the user has been
-      # invited, we need to calculate if the invitation time has not expired
-      # for this user, in other words, if the invitation is still valid.
-      def valid_invitation?
-        invited? && invitation_period_valid?
-      end
-
-      # Only verify password when is not invited
-      def valid_password?(password)
-        super unless invited?
-      end
-=begin      
-      def reset_password!(new_password, new_password_confirmation)
-        super
-        accept_invitation!
-      end
-=end
-      protected
-        # Overriding the method in Devise's :validatable module so password is not required on inviting
-        def password_required?
-          !@skip_password && super
-        end
-
-        # Deliver the invitation email
-        def deliver_invitation
-          ::Devise.mailer.invitation_instructions(self).deliver
-        end
-
-        # Clear invitation token when reset password token is cleared too
-        def clear_reset_password_token
-          self.invitation_token = nil if invited?
-          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.
-        # Invite_for is a model configuration, must always be an integer value.
-        #
-        # Example:
-        #
-        #   # invite_for = 1.day and invitation_sent_at = today
-        #   invitation_period_valid?   # returns true
-        #
-        #   # invite_for = 5.days and invitation_sent_at = 4.days.ago
-        #   invitation_period_valid?   # returns true
-        #
-        #   # invite_for = 5.days and invitation_sent_at = 5.days.ago
-        #   invitation_period_valid?   # returns false
-        #
-        #   # invite_for = nil
-        #   invitation_period_valid?   # will always return true
-        #
-        def invitation_period_valid?
-          invitation_sent_at && (self.class.invite_for.to_i.zero? || invitation_sent_at.utc >= self.class.invite_for.ago)
-        end
-
-        # Generates a new random token for invitation, and stores the time
-        # this token is being generated
-        def generate_invitation_token
-          self.invitation_token   = self.class.invitation_token
-        end
-
-      module ClassMethods
-        # 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.
-        # If user is found and still have pending invitation, email is resend unless
-        # resend_invitation is set to false
-        # Attributes must contain the user email, other attributes will be set in the record
-        def _invite(attributes={}, invited_by=nil, &block)
-          invitable = find_or_initialize_with_error_by(invite_key, attributes.delete(invite_key))
-          invitable.assign_attributes(attributes, :as => inviter_role(invited_by))
-          invitable.invited_by = invited_by
-
-          invitable.skip_password = true
-          invitable.valid? if self.validate_on_invite
-          if invitable.new_record?
-            invitable.errors.clear if !self.validate_on_invite and invitable.email.try(:match, Devise.email_regexp)
-          else
-            invitable.errors.add(invite_key, :taken) unless invitable.invited? && self.resend_invitation
-          end
-
-          if invitable.errors.empty?
-            yield invitable if block_given?
-            mail = invitable.invite!
-          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)
-          :default
-        end
-
-        def invite!(attributes={}, invited_by=nil, &block)
-          invitable, mail = _invite(attributes, invited_by, &block)
-          invitable
-        end
-
-        def invite_mail!(attributes={}, invited_by=nil, &block)
-          invitable, mail = _invite(attributes, invited_by, &block)
-          mail
-        end
-
-        # Attempt to find a user by it's invitation_token to set it's password.
-        # If a user is found, reset it's password and automatically try saving
-        # the record. If not user is found, returns a new user containing an
-        # error in invitation_token attribute.
-        # Attributes must contain invitation_token, password and confirmation
-        def accept_invitation!(attributes={})
-          invitable = find_or_initialize_with_error_by(:invitation_token, attributes.delete(:invitation_token))
-          invitable.errors.add(:invitation_token, :invalid) if invitable.invitation_token && invitable.persisted? && !invitable.valid_invitation?
-          if invitable.errors.empty?
-            invitable.attributes = attributes
-            invitable.accept_invitation!
-          end
-          invitable
-        end
-
-        # Generate a token checking if one does not already exist in the database.
-        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)
-        Devise::Models.config(self, :invitation_limit)
-        Devise::Models.config(self, :invite_key)
-        Devise::Models.config(self, :resend_invitation)
-      end
-    end
-  end
-end
-