devise_invitable 1.1.4 → 1.1.5

data/README.rdoc

@@ -88,7 +88,7 @@ or directly as parameters to the <tt>devise</tt> method:
 
   devise :database_authenticatable, :confirmable, :invitable, :invite_for => 2.weeks
 
-* invitation_limit: The number of invitations users can send.  The default value of nil means users can send as many invites as they want.  A setting of 0 means they can't send invitations.  A setting n > 0 means they can send n invitations.
+* invitation_limit: The number of invitations users can send.  The default value of nil means users can send as many invites as they want, there is no limit for any user, invitation_limit column is not used.  A setting of 0 means they can't send invitations.  A setting n > 0 means they can send n invitations. You can change invitation_limit column for some users so they can send more or less invitations, even with global invitation_limit = 0.
 
 * invite_key: The key to be used to check existing users when sending an invitation. You can use multiple keys. This value must be a hash with the invite key as hash keys, and regexp to validate format as values. If you don't want to validate the key you can set nil as validation format. The default value is looking for users by email and validating with Devise.email_regexp {:email => Devise.email_regexp}.
 
@@ -272,6 +272,17 @@ Take a look at the generated locale file (in <tt>config/locales/devise_invitable
 
 DeviseInvitable supports ActiveRecord and Mongoid, like Devise.
 
+== Testing
+
+To test DeviseInvitable for the ActiveRecord ORM with RVM, Ruby 1.9.2, and Rubygems 1.8.17:
+
+  rvm use 1.9.2
+  rvm gemset create devise_invitable
+  rvm gemset use devise_invitable
+  gem install bundler
+  bundle
+  rake test DEVISE_ORM=active_record
+
 == Contributors
 
 Check them all at:

data/lib/devise_invitable/mailer.rb

@@ -1,9 +1,16 @@
+require 'devise/version'
+
 module DeviseInvitable
   module Mailer
 
     # Deliver an invitation email
-    def invitation_instructions(record)
-      devise_mail(record, :invitation_instructions)
+    def invitation_instructions(record, opts={})
+      # optional arguments introduced in Devise 2.2.0, remove check once support for < 2.2.0 is dropped.
+      if Gem::Version.new(Devise::VERSION.dup) < Gem::Version.new('2.2.0')
+        devise_mail(record, :invitation_instructions)
+      else
+        devise_mail(record, :invitation_instructions, opts)
+      end
     end
   end
 end

data/lib/devise_invitable/model.rb

@@ -73,8 +73,8 @@ module Devise
       # Accept an invitation by clearing invitation token and and setting invitation_accepted_at
       # Confirms it if model is confirmable
       def accept_invitation!
-        self.invitation_accepted_at = Time.now.utc
         if self.invited_to_sign_up? && self.valid?
+          self.invitation_accepted_at = Time.now.utc
           run_callbacks :invitation_accepted do
             self.invitation_token = nil
             self.confirmed_at = self.invitation_accepted_at if self.respond_to?(:confirmed_at)
@@ -218,7 +218,7 @@ module Devise
           invite_key_array = invite_key_fields
           attributes_hash = {}
           invite_key_array.each do |k,v|
-            attributes_hash[k] = attributes.delete(k)
+            attributes_hash[k] = attributes.delete(k).try(:strip)
           end
 
           invitable = find_or_initialize_with_errors(invite_key_array, attributes_hash)

data/lib/devise_invitable/rails.rb

@@ -13,6 +13,9 @@ module DeviseInvitable
     config.to_prepare do
       require 'devise/mailer'
       Devise::Mailer.send :include, DeviseInvitable::Mailer
+    end
+    # extend mapping with after_initialize becuase is not reloaded
+    config.after_initialize do
       Devise::Mapping.send :include, DeviseInvitable::Mapping
     end
   end

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '1.1.4'
+  VERSION = '1.1.5'
 end

data/lib/generators/devise_invitable/install_generator.rb

@@ -25,9 +25,12 @@ module DeviseInvitable
   # 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.
+  # - If invitation_limit is nil, there is no limit for invitations, users can
+  # send unlimited invitations, invitation_limit column is not used.
+  # - If invitation_limit is 0, users can't send invitations by default.
+  # - If invitation_limit n > 0, users can send n invitations.
+  # You can change invitation_limit column for some users so they can send more
+  # or less invitations, even with global invitation_limit = 0
   # Default: nil
   # config.invitation_limit = 5
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_invitable
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 1
   - 1
-  - 4
-  version: 1.1.4
+  - 5
+  version: 1.1.5
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -15,11 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-05 00:00:00 Z
+date: 2013-01-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: bundler
-  prerelease: false
+  type: :development
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -31,27 +30,27 @@ dependencies:
         - 1
         - 0
         version: 1.1.0
-  type: :development
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: devise
   prerelease: false
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  type: :runtime
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 9
         segments: 
         - 2
         - 1
-        - 0
-        version: 2.1.0
-  type: :runtime
+        - 1
+        version: 2.1.1
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: railties
   prerelease: false
+  name: devise
+- !ruby/object:Gem::Dependency 
+  type: :runtime
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -62,11 +61,11 @@ dependencies:
         - 3
         - 0
         version: "3.0"
-  type: :runtime
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: actionmailer
   prerelease: false
+  name: actionmailer
+- !ruby/object:Gem::Dependency 
+  type: :runtime
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -77,8 +76,9 @@ dependencies:
         - 3
         - 0
         version: "3.0"
-  type: :runtime
   version_requirements: *id004
+  prerelease: false
+  name: railties
 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
@@ -91,34 +91,28 @@ extra_rdoc_files: []
 files: 
 - app/controllers/devise/invitations_controller.rb
 - app/controllers/devise_invitable/registrations_controller.rb
-- app/controllers/devise_invitable/registrations_controller.rb~
-- app/views/devise/invitations/edit.html.erb
 - app/views/devise/invitations/new.html.erb
+- app/views/devise/invitations/edit.html.erb
 - app/views/devise/mailer/invitation_instructions.html.erb
 - config/locales/en.yml
+- lib/generators/active_record/devise_invitable_generator.rb
+- lib/generators/active_record/templates/migration.rb
+- lib/generators/devise_invitable/install_generator.rb
+- lib/generators/devise_invitable/devise_invitable_generator.rb
+- lib/generators/devise_invitable/views_generator.rb
+- lib/generators/devise_invitable/templates/simple_form_for/invitations/new.html.erb
+- lib/generators/devise_invitable/templates/simple_form_for/invitations/edit.html.erb
+- lib/generators/mongoid/devise_invitable_generator.rb
 - lib/devise_invitable.rb
-- lib/devise_invitable/mailer.rb
-- lib/devise_invitable/model.rb
 - lib/devise_invitable/rails.rb
+- lib/devise_invitable/inviter.rb
+- lib/devise_invitable/mapping.rb
 - lib/devise_invitable/routes.rb
 - lib/devise_invitable/version.rb
+- lib/devise_invitable/mailer.rb
+- lib/devise_invitable/model.rb
 - lib/devise_invitable/controllers/helpers.rb
 - lib/devise_invitable/controllers/url_helpers.rb
-- lib/devise_invitable/controllers/registrations.rb~
-- lib/devise_invitable/controllers/helpers.rb~
-- lib/devise_invitable/rails.rb~
-- lib/devise_invitable/inviter.rb
-- lib/devise_invitable/mapping.rb
-- lib/devise_invitable/model.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/templates/simple_form_for/invitations/edit.html.erb
-- lib/generators/devise_invitable/templates/simple_form_for/invitations/new.html.erb
-- lib/generators/mongoid/devise_invitable_generator.rb
-- lib/devise_invitable.rb~
 - LICENSE
 - README.rdoc
 homepage: https://github.com/scambra/devise_invitable
@@ -156,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: An invitation strategy for Devise

data/app/controllers/devise_invitable/registrations_controller.rb~

@@ -1,15 +0,0 @@
-class DeviseInvitable::RegistrationsController < Devise::RegistrationsController
-  protected
-
-  def build_resource(*args)
-    hash = args.pop || resource_params || {}
-    if hash[:email]
-      self.resource = resource_class.where(:email => hash[:email], :encrypted_password => '').first
-      if self.resource
-        self.resource.attributes = hash
-        self.resource.accept_invitation!
-      end
-    end
-    self.resource ||= super(hash, *args)
-  end
-end

data/lib/devise_invitable.rb~

@@ -1,65 +0,0 @@
-module DeviseInvitable
-  autoload :Inviter, 'devise_invitable/inviter'
-  autoload :Mailer, 'devise_invitable/mailer'
-  module Controllers
-    autoload :UrlHelpers, 'devise_invitable/controllers/url_helpers'
-    autoload :Registrations, 'devise_invitable/controllers/registrations'
-    autoload :Helpers, 'devise_invitable/controllers/helpers'
-  end
-end
-
-require 'devise'
-require 'devise_invitable/routes'
-require 'devise_invitable/rails'
-
-module Devise
-  # 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).
-  #
-  #   config.invite_for = 2.weeks # => The invitation token will be valid 2 weeks
-  mattr_accessor :invite_for
-  @@invite_for = 0
-
-  # Public: Flag that force a record to be valid before being actually invited
-  # (default: false).
-  #
-  # Examples (in config/initializers/devise.rb)
-  #
-  #   config.validate_on_invite = true
-  mattr_accessor :validate_on_invite
-  @@validate_on_invite = false
-
-  # Public: number of invitations the user is allowed to send
-  #
-  # Examples (in config/initializers/devise.rb)
-  #
-  #   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,
-  # and the regexp used to test it when validate_on_invite is not set.
-  #
-  # Examples (in config/initializers/devise.rb)
-  #
-  #   config.invite_key = {:email => /\A[^@]+@[^@]+\z/}
-  mattr_accessor :invite_key
-  @@invite_key = {:email => Devise.email_regexp}
-
-  # Public: Resend invitation if user with invited status is invited again
-  # (default: true)
-  #
-  # Example (in config/initializers/devise.rb)
-  #
-  #   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/helpers.rb~

@@ -1,21 +0,0 @@
-module DeviseInvitable::Controllers::Helpers
-  extend ActiveSupport::Concern
-
-  included do
-    hide_action :after_invite_path_for, :after_accept_path_for
-  end
-  
-  def after_invite_path_for(resource)
-    after_sign_in_path_for(resource)
-  end
-  
-  def after_accept_path_for(resource)
-    after_sign_in_path_for(resource)
-  end
-  
-  protected
-  def authenticate_inviter!
-    send(:"authenticate_#{resource_name}!", :force => true)
-  end
-  
-end

data/lib/devise_invitable/controllers/registrations.rb~

@@ -1,21 +0,0 @@
-module DeviseInvitable::Controllers::Registrations
-  def self.included(controller)
-    controller.alias_method_chain :build_resource, :invitation
-  end
-
-  protected
-
-  def build_resource_with_invitation(*args)
-    hash = args.pop || resource_params || {}
-    if hash[:email]
-      self.resource = resource_class.where(:email => hash[:email], :encrypted_password => '').first
-      if self.resource
-        puts self.resource.inspect
-        self.resource.attributes = hash
-        self.resource.accept_invitation!
-        puts self.resource.inspect
-      end
-    end
-    self.resource ||= build_resource_without_invitation(hash, *args)
-  end
-end

data/lib/devise_invitable/model.rb~

@@ -1,224 +0,0 @@
-require 'active_support/deprecation'
-
-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_to_sign_up?                    # => 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
-      attr_accessor :completing_invite
-
-      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!
-        self.completing_invite = true
-        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
-      def accepting_or_not_invited?
-        !!completing_invite || invited_to_sign_up?
-      end
-
-      # Verifies whether a user has been invited or not
-      def invited_to_sign_up?
-        persisted? && invitation_token.present?
-      end
-      
-      def invited?
-        invited_to_sign_up?
-      end
-      deprecate :invited?
-
-      # Reset invitation token and send invitation again
-      def invite!
-        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
-        
-        # 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
-        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_to_sign_up? && invitation_period_valid?
-      end
-
-      # Only verify password when is not invited
-      def valid_password?(password)
-        super unless invited_to_sign_up?
-      end
-      
-      def reset_password!(new_password, new_password_confirmation)
-        super
-        accept_invitation!
-      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
-
-        # 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_to_sign_up? && 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
-

data/lib/devise_invitable/rails.rb~

@@ -1,21 +0,0 @@
-module DeviseInvitable
-  class Engine < ::Rails::Engine
-
-    ActiveSupport.on_load(:action_controller) do
-      include DeviseInvitable::Controllers::UrlHelpers
-      include DeviseInvitable::Controllers::Helpers
-    end
-    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::Mapping.send :include, DeviseInvitable::Mapping
-    end
-    config.after_initialize do
-    end
-  end
-end