devise_invitable

# DeviseInvitable
[<img src="https://badge.fury.io/rb/devise_invitable.svg"/>](http://badge.fury.io/rb/devise_invitable) [<img
src="https://github.com/scambra/devise_invitable/actions/workflows/ci.yml/badg
e.svg"/>](https://github.com/scambra/devise_invitable/actions/workflows/ci.yml
) [<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 requires Ruby >= 2.7, Rails >= 7.0,
and Devise >= 5.0.

Use DeviseInvitable 2.x with Devise 4.6 through 4.9. For earlier Devise 4
releases, use DeviseInvitable 1.7.5.

## Installation

Install DeviseInvitable gem:

```shell
gem install devise_invitable
```

Add DeviseInvitable to your Gemfile:

```ruby
gem 'devise_invitable', '~> 3.0'
```

### Automatic installation

Run the following generator to add DeviseInvitable’s configuration option in
the Devise configuration file (`config/initializers/devise.rb`):

```shell
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:

```shell
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 shared invitations table is created by the install generator, so
the model generator does not create a migration.

### Manual installation

Follow the walkthrough for Devise and after it's done, follow this
walkthrough.

#### Devise Configuration
Add `:invitable` to the `devise` call in your model (we’re assuming here you
already have a User model with some Devise modules):

```ruby
class User < ActiveRecord::Base
  devise :database_authenticatable, :confirmable, :invitable
end
```

#### Active Record schema

Invitations are stored in the shared `devise_invitations` table generated by
`devise_invitable:install`. It contains the token and lifecycle timestamps,
the configured invite keys, and polymorphic `invitable` and `invited_by`
associations. Invitation columns are not added to each Devise model.

Run the generated migration:

```shell
rails db:migrate
```

Mongoid applications upgrading from 3.0.0 through 3.1.0 can clear existing
terminal digests without a schema migration:

```console
rails devise_invitable:clear_terminal_invitation_digests
```

#### Upgrading from resource-backed invitation columns

Generate one upgrade migration for every model that already uses
`:invitable`:

```shell
rails generate devise_invitable:upgrade User
rails db:migrate
```

Pass every configured invite key when it is not just `email`:

```shell
rails generate devise_invitable:upgrade User --invite-keys email username
```