devise_invitable 2.0.2 → 2.0.12

data/README.rdoc

@@ -1,439 +0,0 @@
-= DeviseInvitable
-{<img src="https://badge.fury.io/rb/devise_invitable.svg"/>}[http://badge.fury.io/rb/devise_invitable] {<img src="https://travis-ci.org/scambra/devise_invitable.svg"/>}[https://travis-ci.org/scambra/devise_invitable] {<img src="https://codeclimate.com/github/scambra/devise_invitable/badges/gpa.svg"/>}[https://codeclimate.com/github/scambra/devise_invitable]
-
-It adds support to Devise[https://github.com/plataformatec/devise] for sending invitations by email (it requires to be authenticated) and accept the invitation setting the password.
-
-== Requirements
-
-The latest version of DeviseInvitable works with Devise >= 4.6.
-
-If you want to use devise_invitable with earlier Devise releases (4.0 <= x < 4.6), use version 1.7.5.
-
-== Installation
-
-Install DeviseInvitable gem:
-
-  gem install devise_invitable
-
-Add DeviseInvitable to your Gemfile:
-
-  gem 'devise_invitable', '~> 2.0.0'
-
-=== Automatic installation
-
-Run the following generator to add DeviseInvitable’s configuration option in the Devise configuration file (<tt>config/initializers/devise.rb</tt>):
-
-  rails generate devise_invitable:install
-
-When you are done, you are ready to add DeviseInvitable to any of your Devise models using the following generator:
-
-  rails generate devise_invitable MODEL
-
-Replace MODEL by the class name you want to add DeviseInvitable, like <tt>User</tt>, <tt>Admin</tt>, etc. This will add the <tt>:invitable</tt> flag to your model's Devise modules. The generator will also create a migration file (if your ORM supports them).
-
-=== Manual installation
-
-Follow the walkthrough for Devise and after it's done, follow this walkthrough.
-
-== Devise Configuration
-Add <tt>:invitable</tt> to the <tt>devise</tt> call in your model (we’re assuming here you already have a User model with some Devise modules):
-
-  class User < ActiveRecord::Base
-    devise :database_authenticatable, :confirmable, :invitable
-  end
-
-== ActiveRecord Migration
-Add <tt>t.invitable</tt> to your Devise model migration:
-
-  create_table :users do
-    ...
-      ## Invitable
-      t.string   :invitation_token
-      t.datetime :invitation_created_at
-      t.datetime :invitation_sent_at
-      t.datetime :invitation_accepted_at
-      t.integer  :invitation_limit
-      t.integer  :invited_by_id
-      t.string   :invited_by_type
-    ...
-  end
-  add_index :users, :invitation_token, unique: true
-
-or for a model that already exists, define a migration to add DeviseInvitable to your model:
-
-  def change
-      add_column :users, :invitation_token, :string
-      add_column :users, :invitation_created_at, :datetime
-      add_column :users, :invitation_sent_at, :datetime
-      add_column :users, :invitation_accepted_at, :datetime
-      add_column :users, :invitation_limit, :integer
-      add_column :users, :invited_by_id, :integer
-      add_column :users, :invited_by_type, :string
-      add_index :users, :invitation_token, unique: true
-  end
-
-If you previously used devise_invitable with a <tt>:limit</tt> on <tt>:invitation_token</tt>, remove it:
-
-  def up
-    change_column :users, :invitation_token, :string, limit: nil
-  end
-
-  def down
-    change_column :users, :invitation_token, :string, limit: 60
-  end
-
-== Mongoid Field Definitions
-If you are using Mongoid, define the following fields and indexes within your invitable model:
-
-  field :invitation_token, type: String
-  field :invitation_created_at, type: Time
-  field :invitation_sent_at, type: Time
-  field :invitation_accepted_at, type: Time
-  field :invitation_limit, type: Integer
-
-  index( { invitation_token: 1 }, { background: true} )
-  index( { invitation_by_id: 1 }, { background: true} )
-
-You do not need to define a <tt>belongs_to</tt> relationship, as DeviseInvitable does this on your behalf:
-  belongs_to :invited_by, polymorphic: true
-
-Remember to create indexes within the MongoDB database after deploying your changes.
-  rake db:mongoid:create_indexes
-
-== Model configuration
-
-DeviseInvitable adds some new configuration options:
-
-* <tt>invite_for</tt>: The period the generated invitation token is valid. After this period, the invited resource won't be able to accept the invitation. When <tt>invite_for</tt> is <tt>0</tt> (the default), the invitation won't expire.
-
-You can set this configuration option in the Devise initializer as follow:
-
-  # ==> 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
-
-or directly as parameters to the <tt>devise</tt> method:
-
-  devise :database_authenticatable, :confirmable, :invitable, invite_for: 2.weeks
-
-* <tt>invitation_limit</tt>: The number of invitations users can send. The default value of <tt>nil</tt> means users can send as many invites as they want, there is no limit for any user, <tt>invitation_limit</tt> column is not used.  A setting of <tt>0</tt> means they can't send invitations. A setting <tt>n > 0</tt> means they can send <tt>n</tt> invitations. You can change <tt>invitation_limit</tt> column for some users so they can send more or less invitations, even with global <tt>invitation_limit = 0</tt>.
-
-* <tt>invite_key</tt>: 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 <tt>===</tt> operator (including procs and regexes). The default value is looking for users by email and validating with <tt>Devise.email_regexp</tt>.
-
-* <tt>validate_on_invite</tt>: force a record to be valid before being actually invited.
-
-* <tt>resend_invitation</tt>: resend invitation if user with invited status is invited again. Enabled by default.
-
-* <tt>invited_by_class_name</tt>: the class name of the inviting model. If this is <tt>nil</tt>, polymorphic association is used.
-
-* <tt>invited_by_foreign_key</tt>: the foreign key to the inviting model (only used if <tt>invited_by_class_name</tt> is set, otherwise <tt>:invited_by_id</tt>)
-
-* <tt>invited_by_counter_cache</tt>: the column name used for counter_cache column. If this is <tt>nil</tt> (default value), the <tt>invited_by</tt> association is declared without <tt>counter_cache</tt>.
-
-* <tt>allow_insecure_sign_in_after_accept</tt>: automatically sign in the user after they set a password. Enabled by default.
-
-* <tt>require_password_on_accepting</tt>: require password when user accepts the invitation. Enabled by default. Disable if you don't want to ask or enforce to set password while accepting, because is set when user is invited or it will be set later.
-
-For more details, see <tt>config/initializers/devise.rb</tt> (after you invoked the <tt>devise_invitable:install</tt> generator described above).
-
-== Configuring views
-
-All the views are packaged inside the gem. If you'd like to customize the views, invoke the following generator and it will copy all the views to your application:
-
-  rails generate devise_invitable:views
-
-You can also use the generator to generate scoped views:
-
-  rails generate devise_invitable:views users
-
-Then turn scoped views on in <tt>config/initializers/devise.rb</tt>:
-
-  config.scoped_views = true
-
-Please refer to {Devise's README}[https://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: <tt>new</tt>, <tt>create</tt>, <tt>edit</tt>, and <tt>update</tt>. Refer to the {original controllers source}[https://github.com/scambra/devise_invitable/blob/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 some_condition
-         redirect_to root_path
-       else
-         super
-       end
-     end
-   end
-
-Now just tell Devise that you want to use your controller, the controller above is <tt>'users/invitations'</tt>, 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
-
-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
-        super { |user| user.skip_invitation = true }
-      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}[https://github.com/plataformatec/devise#strong-parameters]
-
-There are just two actions in DeviseInvitable that allows any set of parameters to be passed down to the model, therefore requiring sanitization. Their names and the permited parameters by default are:
-
-* <tt>invite</tt> (Devise::InvitationsController#create) - Permits only the authentication keys (like <tt>email</tt>)
-* <tt>accept_invitation</tt> (Devise::InvitationsController#update) - Permits <tt>invitation_token</tt> plus <tt>password</tt> and <tt>password_confirmation</tt>.
-
-Here is an example of what your application controller might need to include in order to add these parameters to the invitation view:
-
-  before_action :configure_permitted_parameters, if: :devise_controller?
-
-  protected
-
-    def configure_permitted_parameters
-      devise_parameter_sanitizer.permit(:accept_invitation, keys: [:first_name, :last_name, :phone])
-    end
-
-
-== Usage
-
-=== Send an invitation
-
-To send an invitation to a user, use the <tt>invite!</tt> class method. <b>Note: This will create a user, and send an email for the invite.</b> <tt>:email</tt> must be present in the parameters hash. You can also include other attributes in the hash. The record will not be validated.
-
-  User.invite!(email: 'new_user@example.com', name: 'John Doe')
-  # => an invitation email will be sent to new_user@example.com
-
-If you want to create the invitation but not send it, you can set <tt>skip_invitation</tt> to <tt>true</tt>.
-
-  user = User.invite!(email: 'new_user@example.com', name: 'John Doe') do |u|
-    u.skip_invitation = true
-  end
-  # => the record will be created, but the invitation email will not be sent
-
-When generating the <tt>accept_user_invitation_url</tt> yourself, you must use the <tt>raw_invitation_token</tt>. 
-This value is temporarily available when you invite a user and will be decrypted when received.
-
-  accept_user_invitation_url(invitation_token: user.raw_invitation_token)
-
-When <tt>skip_invitation</tt> is used, you must also then set the <tt>invitation_sent_at</tt> field when the user is sent their token. Failure to do so will yield "Invalid invitation token" error when the user attempts to accept the invite.
-You can set the column, or call <tt>deliver_invitation</tt> to send the invitation and set the column:
-
-  user.deliver_invitation
-
-You can add <tt>:skip_invitation</tt> to attributes hash if <tt>skip_invitation</tt> is added to <tt>attr_accessible</tt>.
-
-  User.invite!(email: 'new_user@example.com', name: 'John Doe', skip_invitation: true)
-  # => the record will be created, but the invitation email will not be sent
-
-<tt>skip_invitation</tt> skips sending the email, but sets <tt>invitation_token</tt>, so <tt>invited_to_sign_up?</tt> on the
-resulting user returns <tt>true</tt>.
-
-To check if a particular user is created by invitation, irrespective to state of invitation one can use <tt>created_by_invite?</tt>
-
-**Warning**
-
-When using <tt>skip_invitation</tt> you must send the email with the user object instance that generated the tokens, as <tt>user.raw_invitation_token</tt> is available only to the instance and is not persisted in the database.
-
-You can also set <tt>invited_by</tt> when using the <tt>invite!</tt> class method:
-
-  User.invite!({ email: 'new_user@example.com' }, current_user) # current_user will be set as invited_by
-
-=== Sending an invitation after user creation
-
-You can send an invitation to an existing user if your workflow creates them separately:
-
-  user = User.find(42)
-  user.invite!(current_user)  # current user is optional to set the invited_by attribute
-
-=== Find by invitation token
-
-To find by invitation token use the <tt>find_by_invitation_token</tt> class method.
-
-  user = User.find_by_invitation_token(params[:invitation_token], true)
-
-=== Accept an invitation
-
-To accept an invitation with a token use the <tt>accept_invitation!</tt> class method. <tt>:invitation_token</tt> must be present in the parameters hash. You can also include other attributes in the hash.
-
-  User.accept_invitation!(invitation_token: params[:invitation_token], password: 'ad97nwj3o2', name: 'John Doe')
-
-=== Callbacks
-
-A callback event is fired before and after an invitation is created (User#invite!) or accepted (User#accept_invitation!). For example, in your resource model you can add:
-
-  before_invitation_created :email_admins
-  after_invitation_accepted :email_invited_by
-
-  def email_admins
-    # ...
-  end
-
-  def email_invited_by
-    # ...
-  end
-
-The callbacks support all options and arguments available to the standard callbacks provided by ActiveRecord.
-
-=== Scopes
-
-A pair of scopes to find those users that have accepted, and those that have not accepted, invitations are defined:
-
-  User.invitation_accepted     # => returns all Users for whom the invitation_accepted_at attribute is not nil
-  User.invitation_not_accepted # => returns all Users for whom the invitation_accepted_at attribute is nil
-  User.created_by_invite       # => returns all Users who are created by invitations, irrespective to invitation status
-
-== Integration in a Rails application
-
-Since the invitations controller takes 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 <tt>after_invite_path_for(inviter, invitee)</tt>, which is the same path as <tt>signed_in_root_path</tt> by default.
-
-After an invitation is accepted, the invitee will be redirected to <tt>after_accept_path_for(resource)</tt>, which is the same path as <tt>signed_in_root_path</tt> by default. If you want to override the path, override invitations controller and define <tt>after_accept_path_for</tt> 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}[https://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 <tt>invitation_token</tt> is not present or not valid, the invited is redirected to <tt>after_sign_out_path_for(resource_name)</tt>.
-
-The controller sets the <tt>invited_by_id</tt> attribute for the new user to the current user.  This will let you easily keep track of who invited whom.
-
-== Controller filter
-
-InvitationsController uses <tt>authenticate_inviter!</tt> filter to restrict who can send invitations. You can override this method in your <tt>ApplicationController</tt>.
-
-Default behavior requires authentication of the same resource as the invited one. For example, if your model <tt>User</tt> is invitable, it will allow all authenticated users to send invitations to other users.
-
-You would have a <tt>User</tt> model which is configured as invitable and an <tt>Admin</tt> model which is not. If you want to allow only admins to send invitations, simply overwrite the <tt>authenticate_inviter!</tt> method as follow:
-
-  class ApplicationController < ActionController::Base
-    protected
-
-      def authenticate_inviter!
-        authenticate_admin!(force: true)
-      end
-  end
-
-And include <tt>DeviseInvitable::Inviter</tt> module into <tt>Admin</tt> model:
-
-  class Admin < ActiveRecord::Base
-    devise :database_authenticatable, :validatable
-    include DeviseInvitable::Inviter
-  end
-
-== Has many invitations
-
-If you want to get all records invited by a resource, you should define <tt>has_many</tt> association in the model allowed to send invitations.
-
-For the default behavior, define it like this:
-
-  has_many :invitations, class_name: self.to_s, as: :invited_by
-
-For the previous example, where admins send invitations to users, define it like this:
-
-  has_many :invitations, class_name: 'User', as: :invited_by
-
-== 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:
-
-  en:
-    devise:
-      invitations:
-        send_instructions: 'An invitation email has been sent to %{email}.'
-        invitation_token_invalid: 'The invitation token provided is not valid!'
-        updated: 'Your password was set successfully. You are now signed in.'
-        updated_not_active: 'Your password was set successfully.'
-
-You can also create distinct messages based on the resource you've configured using the singular name given in routes:
-
-  en:
-    devise:
-      invitations:
-        user:
-          send_instructions: 'A new user invitation has been sent to %{email}.'
-          invitation_token_invalid: 'Your invitation token is not valid!'
-          updated: 'Welcome on board! You are now signed in.'
-          updated_not_active: 'Welcome on board! Sign in to continue.'
-
-The DeviseInvitable mailer uses the same pattern as Devise to create mail subject messages:
-
-  en:
-    devise:
-      mailer:
-        invitation_instructions:
-          subject: 'You got an invitation!'
-          user_subject: 'You got a user invitation!'
-
-Take a look at the {generated locale file}[https://github.com/scambra/devise_invitable/blob/master/config/locales/en.yml] to check all available messages.
-
-Check out wiki[https://github.com/scambra/devise_invitable/wiki/I18n] for translations.
-
-=== Use with sub schema
-If you are using sub schema in you application, you need to make sure that you are prioritizing your sub schema scheme over Warden in Rack.
-For instance, if you are using the Apartment gem go inside your <tt>config/application.rb</tt> file, add the following lines:
-
-  module YourSite
-    class Application < Rails::Application
-      ...
-      Rails.application.config.middleware.insert_before Warden::Manager, Apartment::Elevators::Subdomain
-    end
-  end
-
-== Other ORMs
-
-DeviseInvitable supports ActiveRecord and Mongoid, like Devise.
-
-== Wiki
-
-It's possible to find additional information about DeviseInvitable on the Wiki:
-
-https://github.com/scambra/devise_invitable/wiki
-
-== Testing
-
-To run tests:
-
-  bundle install
-  bundle exec rake test
-
-== Contributors
-
-Check them all at:
-
-https://github.com/scambra/devise_invitable/contributors
-
-Special thanks to rymai[https://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.
-* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2019 Sergio Cambra. See LICENSE for details.