【Rails7】Devise + SendGrid を利用し、Heroku(本番環境)でメール認証を使えるようにする

gem 'devise'
# ↓パスワードなどを環境変数するgem
gem 'dotenv-rails'

$ rails g devise:install

===============================================================================

Depending on your application's configuration some manual setup may be required:

  1. Ensure you have defined default url options in your environments files. Here
     is an example of default_url_options appropriate for a development environment
     in config/environments/development.rb:

       config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }

     In production, :host should be set to the actual host of your application.

     * Required for all applications. *

  2. Ensure you have defined root_url to *something* in your config/routes.rb.
     For example:

       root to: "home#index"
     
     * Not required for API-only Applications *

  3. Ensure you have flash messages in app/views/layouts/application.html.erb.
     For example:

       <p class="notice"><%= notice %></p>
       <p class="alert"><%= alert %></p>

     * Not required for API-only Applications *

  4. You can copy Devise views (for customization) to your app by running:

       rails g devise:views
       
     * Not required *

===============================================================================

config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }

config.action_mailer.default_url_options = { host: 'https://Herokuのアプリ名.herokuapp.com' }

root "home#index"

<p class="notice"><%= notice %></p>
<p class="alert"><%= alert %></p>

$ rails g devise:views

$ rails g devise user

# frozen_string_literal: true

class DeviseCreateUsers < ActiveRecord::Migration[7.0]
  def change
    create_table :users do |t|
      ## Database authenticatable
      t.string :username
      t.string :email,              null: false, default: ""
      t.string :encrypted_password, null: false, default: ""

      ## Recoverable
      t.string   :reset_password_token
      t.datetime :reset_password_sent_at

      ## Rememberable
      t.datetime :remember_created_at

      ## Trackable
      # t.integer  :sign_in_count, default: 0, null: false
      # t.datetime :current_sign_in_at
      # t.datetime :last_sign_in_at
      # t.string   :current_sign_in_ip
      # t.string   :last_sign_in_ip

      ## Confirmable ←コメントアウトを解除する（メール認証用のカラム）
      t.string   :confirmation_token
      t.datetime :confirmed_at
      t.datetime :confirmation_sent_at
      t.string   :unconfirmed_email # Only if using reconfirmable

      ## Lockable
      # t.integer  :failed_attempts, default: 0, null: false # Only if lock strategy is :failed_attempts
      # t.string   :unlock_token # Only if unlock strategy is :email or :both
      # t.datetime :locked_at


      t.timestamps null: false
    end

    add_index :users, :email,                unique: true
    add_index :users, :reset_password_token, unique: true
    # add_index :users, :confirmation_token,   unique: true
    # add_index :users, :unlock_token,         unique: true
  end
end

class User < ApplicationRecord
  devise :database_authenticatable, :registerable,
         :recoverable, :rememberable, :validatable, :confirmable
end

$ rails db:migrate

  config.action_mailer.perform_caching = false
  config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
  config.action_mailer.raise_delivery_errors = true
  config.action_mailer.delivery_method = :smtp
  # SendGrid の場合
  config.action_mailer.smtp_settings = {
    :address => 'smtp.sendgrid.net',
    :port => 587,
    :domain => 'localhost',
    :user_name => 'apikey',
    :password => ENV['SENDGRID_API_KEY'],
    :authentication => :plain,
    :enable_starttls_auto => true
  }

  # Gmail の場合
  config.action_mailer.smtp_settings = {
  :enable_starttls_auto => true,
  :address => "smtp.gmail.com",

  :port => 587,
  :domain => 'smtp.gmail.com',
  :user_name => ENV['GMAIL_ADDRESS'],
  :password => ENV['GMAIL_PASSWORD'],
  :authentication => 'login'
}

# Gmail
GMAIL_ADDRESS = "Gmailのメールアドレス"
GMAIL_PASSWORD = "Gmailのパスワード"

# 送信元のメールアドレス
SENDER_ADDRESS = "送信元のメールアドレス"

# SendGrid
SENDGRID_API_KEY = "SendGridのAPIキー"

/public/assets

# Ignore master key for decrypting credentials and more.
/config/master.key

# ↓最下部に追記
/.env

  config.action_mailer.default_url_options = { host: 'https://Herokuのアプリ名.herokuapp.com' }
  config.action_mailer.raise_delivery_errors = true
  config.action_mailer.delivery_method = :smtp
  config.action_mailer.perform_deliveries = true
  config.action_mailer.default :charset => "utf-8"
  config.action_mailer.smtp_settings = {
    :address => 'smtp.sendgrid.net',
    :port => 587,
    :domain => 'heroku.com',
    :user_name => 'apikey',
    :password => ENV['SENDGRID_API_KEY'],
    :authentication => :plain,
    :enable_starttls_auto => true
  }

class ApplicationMailer < ActionMailer::Base
  default from: ENV['SENDER_ADDRESS']
  layout "mailer"
end

Devise.setup do |config|
  ・・・
  # config.mailer_sender = 'please-change-me-at-config-initializers-devise@example.com'
  # ↓以下のように変更
  config.mailer_sender = ENV['SENDER_ADDRESS']
　・・・
end

config.i18n.default_locale = :ja

# 変更前
config.time_zone = "Central Time (US & Canada)"
# 変更後
config.time_zone = "Tokyo"