devise_invitable 1.3.0 → 1.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  metadata.gz: f63e9220602bf9934658384637404fdf89b2dfcd4f7b2b7ed77c31cddfbab70e6ca7fa89a2fa2dccf489db7b2e80ff6634cfadf320ee366769b42000da4e9ac5
+  data.tar.gz: d54dfb69ad95bf58f8a69c5c358ba64e9cfdf569536682f6e8614cc2f10550984657cb74353ab64a9fd59e1fed16991b9e8e4e5d120ec3583ad01f36b961bd1c
+SHA1: 
+  metadata.gz: 861482f2cb8845f6335441e94c3da04912511e1b
+  data.tar.gz: 54799f3b072ffc7dcd3080d5f394fa2c62e64990

data/README.rdoc

@@ -124,7 +124,7 @@ or directly as parameters to the <tt>devise</tt> method:
 
 * 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}.
+* 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 values that respond to the === operator(includes procs and regexes). The default value is looking for users by email and validating with Devise.email_regexp {:email => Devise.email_regexp}.
 
 * validate_on_invite: force a record to be valid before being actually invited.
 
@@ -181,6 +181,23 @@ There are just two actions in DeviseInvitable that allows any set of parameters
 * invite (Devise::InvitationsController#create) - Permits only the authentication keys (like email)
 * accept_invitation (Devise::InvitationsController#update) - Permits invitation_token plus password and password_confirmation
 
+Here is an example of what your application controller might need to include in order to add these parameters to the invitation view:
+
+  before_filter :configure_permitted_parameters, if: :devise_controller?
+
+  protected
+
+  def configure_permitted_parameters
+    # Only add some parameters
+    devise_parameter_sanitizer.for(:accept_invitation).concat [:first_name, :last_name, :phone]
+    # Override accepted parameters
+    devise_parameter_sanitizer.for(:accept_invitation) do |u|
+      u.permit(:first_name, :last_name, :phone, :password, :password_confirmation,
+               :invitation_token)
+    end
+  end
+  
+  
 == Usage
 
 === Send an invitation

data/lib/devise_invitable/model.rb

@@ -25,6 +25,7 @@ module Devise
 
       attr_accessor :skip_invitation
       attr_accessor :completing_invite
+      attr_reader   :raw_invitation_token
 
       included do
         include ::DeviseInvitable::Inviter
@@ -146,8 +147,8 @@ module Devise
       end
 
       def clear_errors_on_valid_keys
-        self.class.invite_key.each do |key, regexp|
-          self.errors.delete(key) if regexp.nil? || self.send(key).try(:match, regexp)
+        self.class.invite_key.each do |key, value|
+          self.errors.delete(key) if value === self.send(key)
         end
       end
 
@@ -158,6 +159,11 @@ module Devise
         send_devise_notification(:invitation_instructions, @raw_invitation_token)
       end
 
+      # provide alias to the encrypted invitation_token stored by devise
+      def encrypted_invitation_token
+        self.invitation_token
+      end
+
       protected
         # Overriding the method in Devise's :validatable module so password is not required on inviting
         def password_required?
@@ -221,7 +227,9 @@ module Devise
           invite_key_array = invite_key_fields
           attributes_hash = {}
           invite_key_array.each do |k,v|
-            attributes_hash[k] = attributes.delete(k).to_s.strip
+            attribute = attributes.delete(k)
+            attribute = attribute.to_s.strip if strip_whitespace_keys.include?(k)
+            attributes_hash[k] = attribute
           end
 
           invitable = find_or_initialize_with_errors(invite_key_array, attributes_hash)
@@ -270,7 +278,7 @@ module Devise
 
         def find_by_invitation_token(original_token, only_valid)
           invitation_token = Devise.token_generator.digest(self, :invitation_token, original_token)
-          
+
           invitable = find_or_initialize_with_error_by(:invitation_token, invitation_token)
           if !invitable.persisted? && Devise.allow_insecure_token_lookup
             invitable = find_or_initialize_with_error_by(:invitation_token, original_token)

data/lib/devise_invitable/parameter_sanitizer.rb

@@ -1,11 +1,26 @@
 module DeviseInvitable
   module ParameterSanitizer
     def invite
-      default_params.permit(resource_class.invite_key_fields)
+      default_params.permit self.for(:invite)
     end
 
     def accept_invitation
-      default_params.permit([:password, :password_confirmation, :invitation_token])
+      default_params.permit self.for(:accept_invitation)
+    end
+
+    def self.included(base)
+      base.alias_method_chain :attributes_for, :invitable
+    end
+
+    private
+    def attributes_for_with_invitable(kind)
+      case kind
+      when :invite
+        resource_class.invite_key_fields
+      when :accept_invitation
+        [:password, :password_confirmation, :invitation_token]
+      else attributes_for_without_invitable(kind)
+      end
     end
   end
 end

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

data/test/models/invitable_test.rb

@@ -11,6 +11,10 @@ class InvitableTest < ActiveSupport::TestCase
     assert_nil new_user.invitation_token
   end
 
+  test 'should not generate the raw invitation token after creating a record' do
+    assert_nil new_user.raw_invitation_token
+  end
+
   test 'should regenerate invitation token each time' do
     user = new_user
     user.invite!
@@ -25,6 +29,21 @@ class InvitableTest < ActiveSupport::TestCase
     end
   end
 
+  test 'should alias the invitation_token method with encrypted_invitation_token' do
+    user = new_user
+    user.invite!
+    assert_equal user.invitation_token, user.encrypted_invitation_token
+  end
+
+  test 'should return the correct raw_invitation_token ' do
+    user = new_user
+    raw, enc = Devise.token_generator.generate(user.class, :invitation_token)
+    #stub the generator so the tokens are the same
+    Devise.token_generator.stubs(:generate).returns([raw, enc])
+    user.invite!
+    assert_equal user.raw_invitation_token, raw
+  end
+
   test 'should set invitation created and sent at each time' do
     user = new_user
     user.invite!
@@ -78,19 +97,28 @@ class InvitableTest < ActiveSupport::TestCase
     end
   end
 
-  test 'should invite with mutiple columns for invite key' do
+  test 'should invite with multiple columns for invite key' do
     User.stubs(:invite_key).returns(:email => Devise.email_regexp, :username => /\A.+\z/)
     user = User.invite!(:email => "valid@email.com", :username => "name")
     assert user.persisted?
     assert user.errors.empty?
   end
 
+  test 'should allow non-string columns for invite key' do
+    User.stubs(:invite_key).returns(:email => Devise.email_regexp, :profile_id => :present?.to_proc, :active => true)
+    user = User.invite!(:email => "valid@email.com", :profile_id => 1, :active => true)
+    assert user.persisted?
+    assert user.errors.empty?
+  end
+
   test 'should not invite with some missing columns when invite key is an array' do
-    User.stubs(:invite_key).returns(:email => Devise.email_regexp, :username => /\A.+\z/)
+    User.stubs(:invite_key).returns(:email => Devise.email_regexp, :username => /\A.+\z/, :profile_id => :present?.to_proc, :active => true)
     user = User.invite!(:email => "valid@email.com")
     assert user.new_record?
     assert user.errors.present?
     assert user.errors[:username]
+    assert user.errors[:profile_id]
+    assert user.errors[:active]
     assert user.errors[:email].empty?
   end
 
@@ -503,8 +531,9 @@ class InvitableTest < ActiveSupport::TestCase
 
   test "user.invite! should strip whitespace from the class's strip_whitespace_keys" do
     # Devise default is email
-    user = User.invite!(:email => " valid@email.com ")
+    user = User.invite!(:email => " valid@email.com ", :active => true)
     assert user.email == "valid@email.com"
+    assert user.active == true
   end
 
   test 'should pass validation before accept if field is required in post-invited instance' do

data/test/models_test.rb

@@ -70,5 +70,9 @@ class ModelsTest < ActiveSupport::TestCase
   test 'invitable attributes' do
     assert_nil User.new.invitation_token
     assert_nil User.new.invitation_sent_at
+    #raw token
+    assert_nil User.new.raw_invitation_token
+    #encrypted token - alias to invitation token
+    assert_nil User.new.encrypted_invitation_token
   end
 end

data/test/rails_app/app/models/user.rb

@@ -26,8 +26,10 @@ class User < PARENT_MODEL_CLASS
     field :invited_by_id,          :type => Integer
     field :invited_by_type,        :type => String
 
-
     field :username
+    field :profile_id
+    field :active
+
     validates_presence_of :email
     validates_presence_of :encrypted_password, :if => :password_required?
   end

data/test/rails_app/db/migrate/20100401102949_create_tables.rb

@@ -16,6 +16,8 @@ class CreateTables < ActiveRecord::Migration
       t.string   :unconfirmed_email # Only if using reconfirmable
 
       t.string :username
+      t.integer :profile_id
+      t.boolean :active
 
       ## Invitable
       t.string   :invitation_token, :limit => 60

metadata

@@ -1,13 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: devise_invitable
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 1
-  - 3
-  - 0
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -15,21 +9,15 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-10-03 00:00:00 Z
+date: 2013-11-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 1
-        - 0
         version: 1.1.0
   type: :development
   version_requirements: *id001
@@ -37,21 +25,12 @@ dependencies:
   name: actionmailer
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 3
-        - 2
-        - 6
         version: 3.2.6
     - - <
       - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 5
         version: "5"
   type: :runtime
   version_requirements: *id002
@@ -59,15 +38,9 @@ dependencies:
   name: devise
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 3
-        - 1
-        - 0
         version: 3.1.0
   type: :runtime
   version_requirements: *id003
@@ -163,6 +136,8 @@ files:
 homepage: https://github.com/scambra/devise_invitable
 licenses: 
 - MIT
+metadata: {}
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -171,33 +146,21 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 59
-      segments: 
-      - 1
-      - 8
-      - 6
       version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An invitation strategy for Devise
 test_files: 
 - test/functional/controller_helpers_test.rb
@@ -251,3 +214,4 @@ test_files:
 - test/rails_app/script/rails
 - test/routes_test.rb
 - test/test_helper.rb
+has_rdoc: