devise_invitable 1.7.5 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51e6d03ee4dd325ebd51b67efc8efb5916b30031842c5bd327f6597bdc149b96
-  data.tar.gz: 5fa1f5d1470086846959e4cf20a4d1161db9bd9a6030f82de8941e62db2bc157
+  metadata.gz: 0517f954240bfc3c1fd255df0d502d5fdbd461d4e695cd0c5ec725854af50dcf
+  data.tar.gz: 239b887a32e66dbc38fbf1e04625def2f1dea325fcc6d20af0e1befd066dd000
 SHA512:
-  metadata.gz: 2f522400741c8c5668a51ec81864739d8cc4d295912e58f7b060b2532f3b1110290db2a0b4201d0522baa163b485c6ba53f225128d9b4288007f428e2ab0918b
-  data.tar.gz: fe2b630bb65a1e30a939cd2c3b0cf2a6b86488e2acc728792935fdf358e73c414c3e5a06a82c8ce7a003e10c7614251ba085cc4b797ddfd9480da1b28a28cbf1
+  metadata.gz: 957006ebe6e94715459f941b52004a1002e72005e9344baca46679398bc34e360604e3a8a205d9099a4ff5015be597c1c02a89055137db6c12f10ecf03949db7
+  data.tar.gz: 17200aa6cf76d5abf07de1e4c0987f197140087a7a3210df0bf948a6098602eeeab05d65983cc69ef2185f2de741813ebc778a28d476a86bc5b1527bbd918f4c

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 2.0.5
+- Fix NoMethodError in random_password when validatable is not used ([#850](https://github.com/scambra/devise_invitable/pull/850))
+
+## 2.0.4
+- Fix devise deprecations ([#842](https://github.com/scambra/devise_invitable/pull/842))
+- Update translations ([#844](https://github.com/scambra/devise_invitable/pull/844), [#845](https://github.com/scambra/devise_invitable/pull/845))
+- Fix/enforce initial password length to follow devise ([#848](https://github.com/scambra/devise_invitable/pull/848))
+
+## 2.0.3
+- Add locales ([#834](https://github.com/scambra/devise_invitable/pull/834), [#835](https://github.com/scambra/devise_invitable/pull/835))
+- Remove index on invitations_count column ([#830](https://github.com/scambra/devise_invitable/pull/830))
+
+## 2.0.2
+- Fix ruby 2.7 deprecation warning
+
+## 2.0.1
+- Use per-model allow_insecure_sign_in_after_accept ([#790](https://github.com/scambra/devise_invitable/pull/790))
+
+## 2.0.0
+- Remove deprecated devise_error_messages! from templates ([#786](https://github.com/scambra/devise_invitable/pull/785))
+- Drop Devise < 4.6 support ([#786](https://github.com/scambra/devise_invitable/pull/786))
+- Drop Rails 4.2 support ([#785](https://github.com/scambra/devise_invitable/pull/785))
+- Drop Ruby 2.1 support
+
 ## 1.7.5
 - Add add_taken_error ([#768](https://github.com/scambra/devise_invitable/pull/768))
 - Add invitation_taken? ([#769](https://github.com/scambra/devise_invitable/pull/769))

data/README.rdoc

@@ -1,27 +1,27 @@
 = 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.png"/>}[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]
+{<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.
+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.
 
-It works with Devise >= 4.0
-If you want to use devise 3.0.x, you must use 1.2.1 or lower
-If you want to use devise 3.1.x, you must use 1.3.2 or lower
-If you want to use devise >= 3.2, you must use 1.6.1 or lower
+== 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, it will also install dependencies (such as devise and warden):
+Install DeviseInvitable gem:
 
   gem install devise_invitable
 
-Add DeviseInvitable to your Gemfile (and Devise if you weren't using them):
+Add DeviseInvitable to your Gemfile:
 
-  gem 'devise',           '~> 4.2'
-  gem 'devise_invitable', '~> 1.7.0'
+  gem 'devise_invitable', '~> 2.0.0'
 
 === Automatic installation
 
-Run the following generator to add DeviseInvitable’s configuration option in the Devise configuration file (config/initializers/devise.rb):
+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
 
@@ -29,21 +29,21 @@ When you are done, you are ready to add DeviseInvitable to any of your Devise mo
 
   rails generate devise_invitable MODEL
 
-Replace MODEL by the class name you want to add DeviseInvitable, like User, Admin, etc. This will add the :invitable flag to your model's Devise modules. The generator will also create a migration file (if your ORM supports them). Continue reading this file to understand exactly what the generator produces and how to use it.
+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 :invitable to the <tt>devise</tt> call in your model (we’re assuming here you already have a User model with some Devise modules):
+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 t.invitable to your Devise model migration:
+Add <tt>t.invitable</tt> to your Devise model migration:
 
   create_table :users do
     ...
@@ -57,7 +57,7 @@ Add t.invitable to your Devise model migration:
       t.string   :invited_by_type
     ...
   end
-  add_index :users, :invitation_token, :unique => true
+  add_index :users, :invitation_token, unique: true
 
 or for a model that already exists, define a migration to add DeviseInvitable to your model:
 
@@ -69,22 +69,17 @@ or for a model that already exists, define a migration to add DeviseInvitable to
       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
-
-      # Allow null encrypted_password
-      change_column_null :users, :encrypted_password, :string, true
-      # Allow null password_salt (add it if you are using Devise's encryptable module)
-      change_column_null :users, :password_salt, :string, true
+      add_index :users, :invitation_token, unique: true
   end
 
-If you previously used devise_invitable with a :limit on :invitation_token, remove it:
+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
+    change_column :users, :invitation_token, :string, limit: nil
   end
 
   def down
-    change_column :users, :invitation_token, :string, :limit => 60
+    change_column :users, :invitation_token, :string, limit: 60
   end
 
 == Mongoid Field Definitions
@@ -96,11 +91,11 @@ If you are using Mongoid, define the following fields and indexes within your in
   field :invitation_accepted_at, type: Time
   field :invitation_limit, type: Integer
 
-  index( {invitation_token: 1}, {:background => true} )
-  index( {invitation_by_id: 1}, {:background => true} )
+  index( { invitation_token: 1 }, { background: true} )
+  index( { invitation_by_id: 1 }, { background: true} )
 
-You do not need to define a belongs_to relationship, as DeviseInvitable does this on your behalf:
-  belongs_to :invited_by, :polymorphic => 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
@@ -109,39 +104,39 @@ Remember to create indexes within the MongoDB database after deploying your chan
 
 DeviseInvitable adds some new configuration options:
 
-* 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.
+* <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.
+  # 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
+  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, 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.
+* <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>.
 
-* 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}.
+* <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>.
 
-* validate_on_invite: force a record to be valid before being actually invited.
+* <tt>validate_on_invite</tt>: force a record to be valid before being actually invited.
 
-* resend_invitation: resend invitation if user with invited status is invited again. Enabled by default.
+* <tt>resend_invitation</tt>: resend invitation if user with invited status is invited again. Enabled by default.
 
-* invited_by_class_name: the class name of the inviting model. If this is nil, polymorphic association is used.
+* <tt>invited_by_class_name</tt>: the class name of the inviting model. If this is <tt>nil</tt>, polymorphic association is used.
 
-* invited_by_foreign_key: the foreign key to the inviting model (only used if invited_by_class_name is set, otherwise :invited_by_id)
+* <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>)
 
-* invited_by_counter_cache: the column name used for counter_cache column. If this is nil (default value), the invited_by association is declared without counter_cache.
+* <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>.
 
-* allow_insecure_sign_in_after_accept: automatically sign in the user after they set a password. Enabled by default.
+* <tt>allow_insecure_sign_in_after_accept</tt>: automatically sign in the user after they set a password. Enabled by default.
 
-* require_password_on_accepting: 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.
+* <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 "devise_invitable:install" generator described above).
+For more details, see <tt>config/initializers/devise.rb</tt> (after you invoked the <tt>devise_invitable:install</tt> generator described above).
 
 == Configuring views
 
@@ -153,7 +148,7 @@ You can also use the generator to generate scoped views:
 
   rails generate devise_invitable:views users
 
-Then turn scoped views on in config/initializers/devise.rb:
+Then turn scoped views on in <tt>config/initializers/devise.rb</tt>:
 
   config.scoped_views = true
 
@@ -161,7 +156,7 @@ Please refer to {Devise's README}[https://github.com/plataformatec/devise] for m
 
 == Configuring controllers
 
-To change the controller's behavior, create a controller that inherits from <tt>Devise::InvitationsController</tt>. The available methods are: new, create, edit, and update. You should read 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:
+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
@@ -173,9 +168,9 @@ To change the controller's behavior, create a controller that inherits from <tt>
      end
    end
 
-Now just tell Devise that you want to use your controller, the controller above is 'users/invitations', so our routes.rb would have this line:
+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' }
+  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:
 
@@ -186,33 +181,31 @@ To change behaviour of inviting or accepting users, you can simply override two
   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 do |u|
-        u.skip_invitation = true
+      # This is called when creating invitation.
+      # It should return an instance of resource class.
+      def invite_resource
+        # skip sending emails on invite
+        super { |user| user.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
+      # This is called when accepting invitation.
+      # It 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]
+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:
 
-* invite (Devise::InvitationsController#create) - Permits only the authentication keys (like email)
-* accept_invitation (Devise::InvitationsController#update) - Permits invitation_token plus password and password_confirmation
+* <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:
 
@@ -220,9 +213,9 @@ Here is an example of what your application controller might need to include in
 
   protected
 
-  def configure_permitted_parameters
-    devise_parameter_sanitizer.permit(:accept_invitation, keys: [:first_name, :last_name, :phone])
-  end
+    def configure_permitted_parameters
+      devise_parameter_sanitizer.permit(:accept_invitation, keys: [:first_name, :last_name, :phone])
+    end
 
 
 == Usage
@@ -231,45 +224,43 @@ Here is an example of what your application controller might need to include in
 
 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")
+  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 true.
+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|
+  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>
-the value is temporarily available when you invite a user and will be decrypted when recieved.
+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)
+  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 <tt>Invalid invitation token</tt> error when the user attempts to accept the invite.
-You can set column, or call <tt>deliver_invitation</tt> to sent invitation and set column:
+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)
+  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 true.
+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 skip_invitation you must send the email with the user object instance that generated the tokens, as
-user.raw_invitation_token is available only to the instance and is not persisted in the database.
+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
+  User.invite!({ email: 'new_user@example.com' }, current_user) # current_user will be set as invited_by
 
 === Sending an invitation after user creation
 
@@ -284,12 +275,11 @@ To find by invitation token use the <tt>find_by_invitation_token</tt> class meth
 
   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")
+  User.accept_invitation!(invitation_token: params[:invitation_token], password: 'ad97nwj3o2', name: 'John Doe')
 
 === Callbacks
 
@@ -306,7 +296,7 @@ A callback event is fired before and after an invitation is created (User#invite
     # ...
   end
 
-The callbacks support all options and arguments available to the standard callbacks provided by AR.
+The callbacks support all options and arguments available to the standard callbacks provided by ActiveRecord.
 
 === Scopes
 
@@ -318,33 +308,34 @@ A pair of scopes to find those users that have accepted, and those that have not
 
 == Integration in a Rails application
 
-Since the invitations controller take 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.
+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 after_invite_path_for(inviter, invitee), which is the same path as signed_in_root_path by default.
+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 after_accept_path_for(resource), which is the same path as signed_in_root_path by default. If you want to override the path, override invitations controller and define after_accept_path_for 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.
+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 invitation_token is not present or not valid, the invited is redirected to after_sign_out_path_for(resource_name).
+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 invited_by_id attribute for the new user to the current user.  This will let you easily keep track of who invited who.
+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 authenticate_inviter! filter to restrict who can send invitations. You can override this method in your ApplicationController.
+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 User is invitable, it will allow all authenticated users to send invitations to other users.
+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 User model which is configured as invitable and an Admin model which is not. If you want to allow only admins to send invitations, simply overwrite the authenticate_inviter! method as follow:
+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
+    protected
+
+      def authenticate_inviter!
+        authenticate_admin!(force: true)
+      end
   end
 
-And include DeviseInvitable::Inviter module into Admin model:
+And include <tt>DeviseInvitable::Inviter</tt> module into <tt>Admin</tt> model:
 
   class Admin < ActiveRecord::Base
     devise :database_authenticatable, :validatable
@@ -353,15 +344,15 @@ And include DeviseInvitable::Inviter module into Admin model:
 
 == Has many invitations
 
-If you want to get all records invited by a resource, you should define has_many association in the model allowed to send 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
+  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
+  has_many :invitations, class_name: 'User', as: :invited_by
 
 == I18n
 
@@ -395,9 +386,9 @@ The DeviseInvitable mailer uses the same pattern as Devise to create mail subjec
           subject: 'You got an invitation!'
           user_subject: 'You got a user invitation!'
 
-Take a look at the generated locale file (in <tt>config/locales/devise_invitable.en.yml</tt>) to check all available messages.
+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.
 
-Translations are not included in gem (and they won't), they are available at wiki[https://github.com/scambra/devise_invitable/wiki/I18n].
+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.
@@ -406,7 +397,7 @@ For instance, if you are using the Apartment gem go inside your <tt>config/appli
   module YourSite
     class Application < Rails::Application
       ...
-      Rails.application.config.middleware.insert_before "Warden::Manager", Apartment::Elevators::Subdomain
+      Rails.application.config.middleware.insert_before Warden::Manager, Apartment::Elevators::Subdomain
     end
   end
 
@@ -422,14 +413,10 @@ https://github.com/scambra/devise_invitable/wiki
 
 == Testing
 
-To test DeviseInvitable for the ActiveRecord ORM with RVM, Ruby 2.2.2:
+To run tests:
 
-  rvm use 2.2.2
-  rvm gemset create devise_invitable
-  rvm gemset use devise_invitable
-  gem install bundler
-  bundle
-  rake test DEVISE_ORM=active_record
+  bundle install
+  bundle exec rake test
 
 == Contributors
 
@@ -449,4 +436,4 @@ Special thanks to rymai[https://github.com/rymai] for the Rails 3 support, his f
 
 == Copyright
 
-Copyright (c) 2014 Sergio Cambra. See LICENSE for details.
+Copyright (c) 2019 Sergio Cambra. See LICENSE for details.