devise_invitable 1.3.2 → 1.3.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec084ea3f59520fb7b2cfb978cd79d53ec5c1488
+  data.tar.gz: 257a48340805f6bfe02bc4fd1279a8694ab24c5c
+SHA512:
+  metadata.gz: 51c1385e5d2235ef7d3004208e489ecd241e99ade5afd8d7f5a1289e48cc7e9af6ba599b058862b82c5eb9c64ee02dc63d1be1526d692ccd86c33099bda8c8a8
+  data.tar.gz: 86ff8fa5e4f3990ca8c5dee25acc0e663204b671337e479fc19cfc0c5d2145d79f85f5a68c1ac53790b8a4c967050e13b0a070cf8943c6c4d639684ad68898b7

data/README.rdoc

@@ -1,7 +1,7 @@
 = DeviseInvitable
 {<img src="https://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.
+It adds support to devise[http://github.com/plataformatec/devise] for sending invitations by email (it requires to be authenticated) and accept the invitation setting the password.
 
 DeviseInvitable currently supports Rails 3 and 4, 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]
 
@@ -172,6 +172,30 @@ be sure that you generate the views and put them into the controller that you ge
 
   rails generate devise_invitable:views users/invitations
 
+To change behaviour of inviting or accepting users, you can simply override two methods:
+
+  class Users::InvitationsController < Devise::InvitationsController
+    private
+
+    # this is called when creating invitation
+    # should return an instance of resource class
+    def invite_resource
+      ## skip sending emails on invite
+      resource_class.invite!(invite_params, current_inviter) do |u|
+        u.skip_invitation = true
+      end
+    end
+
+    # this is called when accepting invitation
+    # should return an instance of resource class
+    def accept_resource
+      resource = resource_class.accept_invitation!(update_resource_params)
+      ## Report accepting invitation to analytics
+      Analytics.report('invite.accept', resource.id)
+      resource
+    end
+  end
+
 == Strong Parameters
 
 When you customize your own views, you may end up adding new attributes to forms. Rails 4 moved the parameter sanitization from the model to the controller, causing DeviseInvitable to handle this concern at the controller as well. Read about it in {devise README}[http://github.com/plataformatec/devise#strong-parameters]

data/app/controllers/devise/invitations_controller.rb

@@ -17,6 +17,7 @@ class Devise::InvitationsController < DeviseController
     self.resource = invite_resource
 
     if resource.errors.empty?
+      yield resource if block_given?
       set_flash_message :notice, :send_instructions, :email => self.resource.email if self.resource.invitation_sent_at
       respond_with resource, :location => after_invite_path_for(resource)
     else
@@ -32,9 +33,10 @@ class Devise::InvitationsController < DeviseController
 
   # PUT /resource/invitation
   def update
-    self.resource = resource_class.accept_invitation!(update_resource_params)
+    self.resource = accept_resource
 
     if resource.errors.empty?
+      yield resource if block_given?
       flash_message = resource.active_for_authentication? ? :updated : :updated_not_active                                                                                        
       set_flash_message :notice, flash_message
       sign_in(resource_name, resource)
@@ -56,6 +58,10 @@ class Devise::InvitationsController < DeviseController
   def invite_resource
     resource_class.invite!(invite_params, current_inviter)
   end
+  
+  def accept_resource
+    resource_class.accept_invitation!(update_resource_params)
+  end
 
   def current_inviter
     @current_inviter ||= authenticate_inviter!

data/lib/devise_invitable/model.rb

@@ -29,11 +29,20 @@ module Devise
 
       included do
         include ::DeviseInvitable::Inviter
-        if Devise.invited_by_class_name
-          belongs_to :invited_by, :class_name => Devise.invited_by_class_name
+        belongs_to_options = if Devise.invited_by_class_name
+          {:class_name => Devise.invited_by_class_name}
         else
-          belongs_to :invited_by, :polymorphic => true
+          {:polymorphic => true}
         end
+        if defined?(ActiveRecord) && self < ActiveRecord::Base
+          counter_cache = Devise.invited_by_counter_cache
+          if !counter_cache && Devise.invited_by_class_name
+            klass = Devise.invited_by_class_name.constantize
+            counter_cache = klass.table_exists? && klass.columns_hash['invitations_count'].try('name')
+          end
+          belongs_to_options.merge! :counter_cache => counter_cache if counter_cache
+        end
+        belongs_to :invited_by, belongs_to_options
 
         include ActiveSupport::Callbacks
         define_callbacks :invitation_accepted
@@ -57,9 +66,8 @@ module Devise
       def self.required_fields(klass)
         fields = [:invitation_token, :invitation_created_at, :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 << :invitations_count if defined?(ActiveRecord) && self < ActiveRecord::Base
+        fields -= [:invited_by_type] if Devise.invited_by_class_name
         fields
       end
 
@@ -81,12 +89,6 @@ module Devise
         end
       end
 
-      # Verifies whether a user has accepted an invitation (or is accepting it), or was never invited
-      def accepting_or_not_invited?
-        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?
@@ -279,19 +281,11 @@ module Devise
           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)
-          end
           invitable.errors.add(:invitation_token, :invalid) if invitable.invitation_token && invitable.persisted? && !invitable.valid_invitation?
           invitable.invitation_token = original_token
           invitable unless only_valid && invitable.errors.present?
         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)

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '1.3.2'
+  VERSION = '1.3.4'
 end

data/lib/devise_invitable.rb

@@ -61,6 +61,11 @@ module Devise
   # the #invited_by association is declared to be polymorphic. (default: nil)
   mattr_accessor :invited_by_class_name
   @@invited_by_class_name = nil
+
+  # Public: The column name used for counter_cache column. If this is nil,
+  # the #invited_by association is declared without counter_cache. (default: nil)
+  mattr_accessor :invited_by_counter_cache
+  @@invited_by_counter_cache = nil
 end
 
 Devise.add_module :invitable, :controller => :invitations, :model => 'devise_invitable/model', :route => {:invitation => [nil, :new, :accept]}

data/lib/generators/active_record/templates/migration.rb

@@ -7,6 +7,8 @@ class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
       t.datetime   :invitation_accepted_at
       t.integer    :invitation_limit
       t.references :invited_by, :polymorphic => true
+      t.integer    :invitations_count, default: 0
+      t.index      :invitations_count
       t.index      :invitation_token, :unique => true # for invitable
       t.index      :invited_by_id
     end
@@ -21,7 +23,7 @@ class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
   def down
     change_table :<%= table_name %> do |t|
       t.remove_references :invited_by, :polymorphic => true
-      t.remove :invitation_limit, :invitation_sent_at, :invitation_accepted_at, :invitation_token, :invitation_created_at
+      t.remove :invitations_count, :invitation_limit, :invitation_sent_at, :invitation_accepted_at, :invitation_token, :invitation_created_at
     end
   end
 end

data/lib/generators/devise_invitable/install_generator.rb

@@ -43,6 +43,20 @@ module DeviseInvitable
   # Default: false
   # config.validate_on_invite = true
 
+  # Resend invitation if user with invited status is invited again
+  # Default: true
+  # config.resend_invitation = false
+
+  # The class name of the inviting model. If this is nil,
+  # the #invited_by association is declared to be polymorphic.
+  # Default: nil
+  # config.invited_by_class_name = 'User'
+
+  # The column name used for counter_cache column. If this is nil,
+  # the #invited_by association is declared without counter_cache.
+  # Default: nil
+  # config.invited_by_counter_cache = :invitations_count
+
 CONTENT
             end
           end

data/test/models/invitable_test.rb

@@ -11,6 +11,16 @@ class InvitableTest < ActiveSupport::TestCase
     assert_nil new_user.invitation_token
   end
 
+  test 'should update the invitations count counter cache' do
+    if defined?(ActiveRecord)
+      current_user = new_user
+      2.times do |index|
+        User.invite!({:email => "valid#{index}@email.com"}, current_user)
+      end
+      assert_equal current_user.reload.invitations_count, 2
+    end
+  end
+
   test 'should not generate the raw invitation token after creating a record' do
     assert_nil new_user.raw_invitation_token
   end
@@ -538,13 +548,13 @@ class InvitableTest < ActiveSupport::TestCase
 
   test 'should pass validation before accept if field is required in post-invited instance' do
     user = User.invite!(:email => "valid@email.com")
-    user.testing_accepting_or_not_invited = true
+    user.testing_accepted_or_not_invited = true
     assert_equal true, user.valid?
   end
 
   test 'should fail validation after accept if field is required in post-invited instance' do
     user = User.invite!(:email => "valid@email.com")
-    user.testing_accepting_or_not_invited = true
+    user.testing_accepted_or_not_invited = true
     user.accept_invitation!
     assert_equal false, user.valid?
   end
@@ -552,7 +562,7 @@ class InvitableTest < ActiveSupport::TestCase
   test 'should pass validation after accept if field is required in post-invited instance' do
     user = User.invite!(:email => "valid@email.com")
     user.username = 'test'
-    user.testing_accepting_or_not_invited = true
+    user.testing_accepted_or_not_invited = true
     user.bio = "Test"
     user.accept_invitation!
     assert_equal true, user.valid?

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

@@ -39,12 +39,12 @@ class User < PARENT_MODEL_CLASS
   attr_accessor :callback_works, :bio, :token
   validates :username, :length => { :maximum => 20 }
   
-  attr_accessor :testing_accepting_or_not_invited
-  validates :username, :presence => true, :if => :testing_accepting_or_not_invited_validator?
+  attr_accessor :testing_accepted_or_not_invited
+  validates :username, :presence => true, :if => :testing_accepted_or_not_invited_validator?
   validates :bio, :presence => true, :if => :invitation_accepted?
 
-  def testing_accepting_or_not_invited_validator?
-    testing_accepting_or_not_invited && accepting_or_not_invited?
+  def testing_accepted_or_not_invited_validator?
+    testing_accepted_or_not_invited && accepted_or_not_invited?
   end
 
   after_invitation_accepted do |object|

data/test/rails_app/config/initializers/devise.rb

@@ -90,6 +90,45 @@ Devise.setup do |config|
   # Setup a pepper to generate the encrypted password.
   # config.pepper = "e31589192aeea8807cb7d8686b0f8484d6cbfaaa65443d45144519ed1d4ffbc6ccb73b21a69ece276d94f2cac95d83990d824f36f301d6f585ededd1bf90d67d"
 
+  # ==> Configuration for :invitable
+  # 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.
+  # config.invite_for = 2.weeks
+
+  # Number of invitations users can send.
+  # - 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
+
+  # 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
+  # Default: false
+  # config.validate_on_invite = true
+
+  # Resend invitation if user with invited status is invited again
+  # Default: true
+  # config.resend_invitation = false
+
+  # The class name of the inviting model. If this is nil,
+  # the #invited_by association is declared to be polymorphic.
+  # Default: nil
+  # config.invited_by_class_name = 'User'
+
+  # The column name used for counter_cache column. If this is nil,
+  # the #invited_by association is declared without counter_cache.
+  # Default: nil
+  config.invited_by_counter_cache = :invitations_count
+
   # ==> Configuration for :confirmable
   # A period that the user is allowed to access the website even without
   # confirming his account. For instance, if set to 2.days, the user will be

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

@@ -27,15 +27,20 @@ class CreateTables < ActiveRecord::Migration
       t.integer  :invitation_limit
       t.integer  :invited_by_id
       t.string   :invited_by_type
+      t.integer :invitations_count, :default => 0
 
       t.timestamps
     end
     add_index :users, :invitation_token, :unique => true
+    add_index :users, :invitations_count
 
     create_table :admins do |t|
       ## Database authenticatable
       t.string :email,              :null => true, :default => ""
       t.string :encrypted_password, :null => true, :default => ""
+
+      t.integer :invitations_count, :default => 0
     end
+    add_index :admins, :invitations_count
   end
 end

metadata

@@ -1,38 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: devise_invitable
 version: !ruby/object:Gem::Version
-  version: 1.3.2
-  prerelease: 
+  version: 1.3.4
 platform: ruby
 authors:
 - Sergio Cambra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-04 00:00:00.000000000 Z
+date: 2014-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.6
     - - <
@@ -41,9 +37,8 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.6
     - - <
@@ -52,19 +47,17 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
 description: It adds support for send invitations by email (it requires to be authenticated)
   and accept the invitation by setting a password.
 email:
@@ -154,6 +147,7 @@ files:
 homepage: https://github.com/scambra/devise_invitable
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --main
@@ -162,22 +156,20 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An invitation strategy for Devise
 test_files:
 - test/functional/controller_helpers_test.rb