MENU
  1. ホーム
  2. Ruby
  3. Ruby on RailsでDeviseを使ったユーザー認証機能の実装方法を徹底解説

Ruby on RailsでDeviseを使ったユーザー認証機能の実装方法を徹底解説

Ruby

Ruby on Railsにおいてユーザー認証は、アプリケーションのセキュリティを確保する上で欠かせない機能です。多くのWebアプリケーションは、ユーザーごとに異なる権限や設定を提供し、ログインや登録、パスワード管理などの機能を備えています。こうした機能を手軽に実装するために利用されるのが「Devise」というRubyのGemです。Deviseは、認証機能を柔軟にカスタマイズできるフレームワークであり、実装の手間を大幅に省くことができます。本記事では、Deviseを用いたユーザー認証機能の基本的なセットアップから、実際の運用に役立つ応用機能の導入方法まで、ステップバイステップで解説していきます。これにより、Railsアプリケーションにおける堅牢でユーザーフレンドリーな認証機能の実装を目指します。

目次
  1. Deviseとは
  2. Deviseのインストール
    1. 1. GemfileにDeviseを追加
    2. 2. バンドルインストールの実行
    3. 3. Deviseのインストーラ実行
  3. ユーザーモデルの作成
    1. 1. ユーザーモデルの生成
    2. 2. マイグレーションの実行
    3. 3. ユーザーモデルの確認
  4. 認証機能のカスタマイズ
    1. 1. カスタムフィールドの追加
    2. 2. Userモデルへのフィールド追加
    3. 3. サインアップフォームのカスタマイズ
    4. 4. ストロングパラメータの設定
  5. ログインとログアウトの実装
    1. 1. ルーティング設定の確認
    2. 2. ログインとログアウトのリンク追加
    3. 3. ログイン後のリダイレクト先の設定
    4. 4. Flashメッセージの設定
  6. パスワードリセット機能の導入
    1. 1. パスワードリセットのメール設定
    2. 2. パスワードリセット用のルーティング
    3. 3. パスワードリセットリンクのカスタマイズ
    4. 4. パスワードリセットのメールテンプレート
    5. 5. パスワードリセットプロセスの確認
  7. ユーザーページのアクセス制限
    1. 1. before_actionを使用してアクセス制限を設定
    2. 2. アクセス制御によるエラーハンドリング
    3. 3. コントローラーごとのアクセス制限
    4. 4. アクセス制限に関するテスト
  8. 認証機能のテスト方法
    1. 1. RSpecとCapybaraのセットアップ
    2. 2. ユーザー認証のテスト
    3. 3. ログインフォームの機能テスト
    4. 4. パスワードリセット機能のテスト
  9. 応用：ソーシャルログイン機能の追加
    1. 1. OmniAuthとOmniAuthプロバイダのインストール
    2. 2. Deviseの設定変更
    3. 3. コールバックルートの設定
    4. 4. Omniauthコールバックコントローラーの作成
    5. 5. Userモデルにソーシャルアカウント情報を保存する設定
    6. 6. ログインリンクの追加
  10. まとめ

Deviseとは

Deviseは、Ruby on Railsでユーザー認証機能を実装するための強力な認証Gemです。オープンソースであり、ユーザーの登録、ログイン、パスワードリセットなど、一般的な認証機能を標準で提供しています。Deviseの大きな特徴は、柔軟でカスタマイズしやすい構造にあり、必要に応じて認証プロセスやデータベースモデルを拡張することが可能です。また、セキュリティ面にも配慮されており、パスワードのハッシュ化やタイムアウト機能なども備えています。Deviseを使用することで、短期間で堅牢なユーザー認証機能を構築できるため、幅広いRailsプロジェクトで採用されています。

Deviseのインストール

DeviseをRailsプロジェクトにインストールするには、まずGemfileにDeviseを追加し、バンドルインストールを行います。以下はその手順です。

1. GemfileにDeviseを追加

RailsプロジェクトのGemfileを開き、以下の行を追加します。

gem 'devise'

2. バンドルインストールの実行

ターミナルで以下のコマンドを実行して、Deviseをインストールします。

bundle install

3. Deviseのインストーラ実行

インストールが完了したら、Deviseのセットアップ用インストーラを実行します。このコマンドにより、必要な初期設定ファイルが生成されます。

rails generate devise:install

インストール完了後、config/initializers/devise.rbが生成され、ここでDeviseの設定を細かく調整できます。次に、ユーザーモデルの設定に進みます。

ユーザーモデルの作成


Deviseでユーザー認証機能を利用するには、認証を管理するためのユーザーモデルを作成する必要があります。以下にその手順を示します。

1. ユーザーモデルの生成


ターミナルで以下のコマンドを実行し、Deviseによるユーザーモデルを生成します。

rails generate devise User

このコマンドにより、Userモデルおよびマイグレーションファイルが作成され、認証に必要なカラム（例えばemailやencrypted_passwordなど）が自動的に追加されます。

2. マイグレーションの実行


作成されたマイグレーションをデータベースに適用するため、以下のコマンドを実行してデータベースを更新します。

rails db:migrate

これにより、ユーザー情報を保存するためのusersテーブルがデータベースに作成されます。

3. ユーザーモデルの確認


生成されたUserモデルには、Deviseによる認証機能が組み込まれており、ユーザーの登録、ログイン、パスワード管理などの基本的な認証操作が可能です。また、追加のフィールドが必要な場合は、後ほどこのモデルにカスタムフィールドを追加できます。

以上で、基本的なユーザーモデルの作成が完了し、認証の基盤が整いました。次は、Deviseの機能をさらにカスタマイズしていきます。

認証機能のカスタマイズ


Deviseを用いて作成した認証機能は、基本的な動作をすぐに利用できますが、アプリケーションの要件に応じてフィールドやバリデーションを追加することで、より適切にカスタマイズできます。ここでは、カスタムフィールドの追加とバリデーション設定の手順について解説します。

1. カスタムフィールドの追加


ユーザーの名前やプロフィール情報など、追加のフィールドが必要な場合は、マイグレーションを作成して対応します。例えば、usernameフィールドを追加する場合、以下のコマンドを実行します。

rails generate migration AddUsernameToUsers username:string

生成されたマイグレーションファイルを確認し、問題がなければデータベースを更新します。

rails db:migrate

2. Userモデルへのフィールド追加


マイグレーションが完了したら、Userモデルにバリデーションやデフォルト値を設定します。例えば、usernameが必須フィールドで、ユニークである必要がある場合、Userモデルに以下のバリデーションを追加します。

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

  validates :username, presence: true, uniqueness: true
end

3. サインアップフォームのカスタマイズ


次に、サインアップフォームで新しいフィールドを入力できるようにします。Deviseのビューをカスタマイズするため、以下のコマンドを実行してDeviseのビューをコピーします。

rails generate devise:views

app/views/devise/registrations/new.html.erbにあるサインアップフォームに、新しいusernameフィールドを追加します。

<div class="field">
  <%= f.label :username %><br />
  <%= f.text_field :username, autofocus: true %>
</div>

4. ストロングパラメータの設定


新しいフィールドを許可するため、ApplicationControllerにDeviseのストロングパラメータ設定を追加します。before_actionを使用して、追加フィールドを許可します。

class ApplicationController < ActionController::Base
  before_action :configure_permitted_parameters, if: :devise_controller?

  protected

  def configure_permitted_parameters
    devise_parameter_sanitizer.permit(:sign_up, keys: [:username])
    devise_parameter_sanitizer.permit(:account_update, keys: [:username])
  end
end

これで、ユーザー認証に必要なカスタムフィールドが追加され、適切に動作するようになります。次は、ログインとログアウトの実装について説明します。

ログインとログアウトの実装


ユーザー認証の基本的な機能であるログインとログアウトを実装し、ユーザーがアプリケーションにアクセスできる状態を整えます。Deviseでは、これらの機能があらかじめ提供されているため、簡単に利用できます。以下では、ログインとログアウトの設定およびそのカスタマイズ方法を説明します。

1. ルーティング設定の確認


Deviseのインストール時に、config/routes.rbファイルにデフォルトでDeviseのルーティングが追加されています。このルーティングにより、サインインやサインアウト、サインアップなどのURLが自動的に設定されます。

devise_for :users

このコードによって、以下のようなルーティングが提供されます：

  • サインイン: /users/sign_in
  • サインアウト: /users/sign_out
  • サインアップ: /users/sign_up

2. ログインとログアウトのリンク追加


ユーザーがログインおよびログアウトできるように、ナビゲーションバーやトップページにリンクを追加します。通常、app/views/layouts/application.html.erbにリンクを設定します。

<% if user_signed_in? %>
  <p>こんにちは、<%= current_user.username %>さん</p>
  <%= link_to 'ログアウト', destroy_user_session_path, method: :delete %>
<% else %>
  <%= link_to 'ログイン', new_user_session_path %> |
  <%= link_to 'サインアップ', new_user_registration_path %>
<% end %>

これにより、ユーザーがログインしている場合には「ログアウト」リンクが、未ログイン状態では「ログイン」と「サインアップ」リンクが表示されます。

3. ログイン後のリダイレクト先の設定


ログイン後やログアウト後のリダイレクト先をカスタマイズするには、ApplicationControllerにafter_sign_in_path_forメソッドやafter_sign_out_path_forメソッドを定義します。

class ApplicationController < ActionController::Base
  protected

  def after_sign_in_path_for(resource)
    user_dashboard_path # 例：ユーザーダッシュボードにリダイレクト
  end

  def after_sign_out_path_for(resource_or_scope)
    root_path # 例：ホームページにリダイレクト
  end
end

4. Flashメッセージの設定


ログイン・ログアウト時にFlashメッセージを表示するため、app/views/layouts/application.html.erbにFlashメッセージ表示部分を追加します。

<% flash.each do |key, message| %>
  <div class="alert <%= key %>"><%= message %></div>
<% end %>

これにより、ログイン成功時やログアウト時にメッセージが表示され、ユーザーにアクションの結果を知らせることができます。

以上で、ログインとログアウト機能の設定が完了しました。次に、パスワードリセット機能の導入方法について解説します。

パスワードリセット機能の導入


Deviseには、パスワードを忘れたユーザーが自分でリセットできる機能が標準で備わっています。このセクションでは、パスワードリセット機能の導入方法と、ユーザーがスムーズに利用できるようにするための設定について解説します。

1. パスワードリセットのメール設定


Deviseでは、パスワードリセットリンクを含むメールをユーザーに送信するため、アプリケーションにメールの設定が必要です。config/environments/development.rbに以下のように設定を追加します（本番環境では適切なSMTP設定を行ってください）。

config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
config.action_mailer.delivery_method = :smtp
config.action_mailer.smtp_settings = {
  address: 'smtp.example.com',
  port: 587,
  user_name: 'your_username',
  password: 'your_password',
  authentication: 'plain',
  enable_starttls_auto: true
}

これにより、開発環境でのメール送信が可能になります。

2. パスワードリセット用のルーティング


devise_for :usersのルーティングにより、パスワードリセット関連のルーティングが自動的に生成されます。以下は、ユーザーがパスワードリセットのためにアクセスするURLです。

  • パスワードリセットリクエスト: /users/password/new
  • パスワードリセットメール送信: /users/password

3. パスワードリセットリンクのカスタマイズ


ナビゲーションやログイン画面に「パスワードを忘れましたか？」リンクを追加します。Deviseのビューを使用している場合、以下のようにリンクをapp/views/devise/sessions/new.html.erbに追加します。

<%= link_to 'パスワードを忘れましたか？', new_user_password_path %>

このリンクをクリックすると、ユーザーは登録したメールアドレスにリセットリンクを受け取るためのフォームに遷移します。

4. パスワードリセットのメールテンプレート


パスワードリセットメールの内容をカスタマイズするには、Deviseのメールテンプレートを編集します。テンプレートファイルはapp/views/devise/mailer/reset_password_instructions.html.erbにあり、ここでメール本文をカスタマイズできます。

<p><%= @resource.username %>さん、</p>
<p>パスワードリセットのリクエストを受け付けました。以下のリンクをクリックしてパスワードを再設定してください。</p>
<p><%= link_to 'パスワードをリセットする', edit_password_url(@resource, reset_password_token: @token) %></p>

5. パスワードリセットプロセスの確認


パスワードリセットのフローが正常に動作することを確認するため、テストユーザーで一度試してみましょう。パスワードリセットフォームにメールアドレスを入力し、送信後に受信したメール内のリンクをクリックして新しいパスワードを設定します。

以上で、Deviseのパスワードリセット機能が実装され、ユーザーがパスワードを忘れた場合にも安全にアカウントを復旧できるようになります。次は、ユーザーページのアクセス制限方法について説明します。

ユーザーページのアクセス制限


認証システムでは、ログインしているユーザーのみが特定のページにアクセスできるように制限をかけることが重要です。Deviseを使えば、簡単にアクセス制御を実装できます。ここでは、特定のページをログインユーザーに限定する方法や、アクセス制限におけるベストプラクティスを紹介します。

1. before_actionを使用してアクセス制限を設定


コントローラーにbefore_actionフィルタを追加し、特定のアクションに対して認証済みのユーザーのみアクセスできるようにします。以下は、UsersControllerでアクセス制限を設定する例です。

class UsersController < ApplicationController
  before_action :authenticate_user!, only: [:show, :edit, :update]

  def show
    # ユーザープロファイル表示
  end

  def edit
    # プロファイル編集画面
  end

  def update
    # プロファイルの更新
  end
end

ここでauthenticate_user!メソッドはDeviseの提供するメソッドで、ユーザーがログインしていない場合はサインインページへリダイレクトされます。

2. アクセス制御によるエラーハンドリング


ユーザーがアクセス権限のないページに直接アクセスした場合、エラーメッセージを表示させることが望ましいです。ApplicationControllerに以下の設定を追加することで、アクセス制限が適用された場合のエラーメッセージをカスタマイズできます。

class ApplicationController < ActionController::Base
  rescue_from CanCan::AccessDenied do |exception|
    redirect_to root_path, alert: "アクセスが許可されていません。"
  end
end

3. コントローラーごとのアクセス制限


一部のページだけでなく、コントローラー全体にわたってアクセス制限をかける場合、ApplicationControllerに設定を追加することで簡潔に管理できます。

class ApplicationController < ActionController::Base
  before_action :authenticate_user!
end

これにより、すべてのコントローラーでユーザーが認証されているかが確認され、ログインしていない場合はサインインページへリダイレクトされます。ただし、特定のコントローラーやアクションでアクセス制限を解除する必要がある場合は、そのコントローラー内でskip_before_actionを使って設定を上書きできます。

class HomeController < ApplicationController
  skip_before_action :authenticate_user!, only: [:index]

  def index
    # 公開ページ
  end
end

4. アクセス制限に関するテスト


アクセス制限が正しく機能しているか確認するために、テスト環境でユーザーの認証状態に基づくアクセス許可・制限をテストします。RSpecを使用して、未ログインユーザーのリダイレクトやエラーメッセージの表示を検証します。

以上で、特定のページをログインユーザーに限定するアクセス制限の設定が完了しました。次は、認証機能のテスト方法について解説します。

認証機能のテスト方法


ユーザー認証機能が適切に動作するかどうかを確認するためには、テストを行うことが不可欠です。ここでは、RSpecとCapybaraを使って、Deviseの認証機能のテスト方法を解説します。テストを通じて、ユーザーが期待通りに認証・認可されているかを確認し、アプリケーションの品質を高めましょう。

1. RSpecとCapybaraのセットアップ


テストを行うために、GemfileにRSpecとCapybaraを追加し、インストールします。

group :development, :test do
  gem 'rspec-rails'
  gem 'capybara'
end

ターミナルで以下のコマンドを実行し、RSpecをセットアップします。

bundle install
rails generate rspec:install

2. ユーザー認証のテスト


Deviseのsign_inとsign_outをテストするために、RSpecのリクエストスペックを作成します。ここでは、未ログインユーザーが認証が必要なページにアクセスしたとき、ログインページへリダイレクトされることを確認します。

require 'rails_helper'

RSpec.describe "Users", type: :request do
  describe "GET /users/profile" do
    context "未ログインユーザー" do
      it "ログインページにリダイレクトされる" do
        get user_profile_path
        expect(response).to redirect_to(new_user_session_path)
      end
    end

    context "ログイン済みユーザー" do
      before do
        @user = FactoryBot.create(:user)
        sign_in @user
      end

      it "正常にアクセスできる" do
        get user_profile_path
        expect(response).to have_http_status(:success)
      end
    end
  end
end

このテストでは、Deviseのsign_inヘルパーを使用してログイン状態をシミュレートし、未ログインおよびログイン済みの双方でアクセスが適切に制限されているか確認します。

3. ログインフォームの機能テスト


Capybaraを使用して、ログインフォームの機能テストも行います。spec/features/user_authentication_spec.rbに以下のテストを追加します。

require 'rails_helper'

RSpec.feature "UserAuthentication", type: :feature do
  scenario "ユーザーが正しい情報でログインできる" do
    user = FactoryBot.create(:user, email: "test@example.com", password: "password")

    visit new_user_session_path
    fill_in "Email", with: "test@example.com"
    fill_in "Password", with: "password"
    click_button "Log in"

    expect(page).to have_content("ログインしました")
  end

  scenario "ユーザーが無効な情報でログインできない" do
    visit new_user_session_path
    fill_in "Email", with: "wrong@example.com"
    fill_in "Password", with: "wrongpassword"
    click_button "Log in"

    expect(page).to have_content("メールアドレスまたはパスワードが正しくありません")
  end
end

このテストでは、ユーザーが正しいメールアドレスとパスワードでログインできるか、また無効な情報でログインしようとした場合にエラーメッセージが表示されるかを確認します。

4. パスワードリセット機能のテスト


パスワードリセットのテストを行い、リセットメールの送信やリセットリンクの動作を確認します。

RSpec.describe "PasswordResets", type: :request do
  let(:user) { FactoryBot.create(:user) }

  it "パスワードリセットメールを送信する" do
    post user_password_path, params: { user: { email: user.email } }
    expect(ActionMailer::Base.deliveries.size).to eq(1)
    expect(ActionMailer::Base.deliveries.last.to).to include(user.email)
  end
end

このテストにより、リセットリクエストが受信されるとパスワードリセットメールが送信されることを確認します。

これで、Deviseの認証機能の基本的なテスト設定が完了です。次は、応用機能としてソーシャルログインの追加について解説します。

応用：ソーシャルログイン機能の追加


ソーシャルログイン機能を追加することで、ユーザーがGoogleやFacebookなどの外部アカウントでログインできるようにします。これにより、ユーザー登録やログインがより簡単になるため、ユーザーエクスペリエンスが向上します。Deviseと併せて「OmniAuth」というGemを使用し、OAuth認証によるソーシャルログインを実装します。

1. OmniAuthとOmniAuthプロバイダのインストール


Gemfileにomniauthと使用するプロバイダ（例: GoogleやFacebook）を追加します。ここではGoogleを例にします。

gem 'devise'
gem 'omniauth'
gem 'omniauth-google-oauth2'

ターミナルでインストールを実行します。

bundle install

2. Deviseの設定変更


Deviseの設定ファイルconfig/initializers/devise.rbに、OmniAuthの設定を追加します。GoogleのクライアントIDとクライアントシークレットは、Google Cloud ConsoleでOAuthクライアントを設定して取得します。

config.omniauth :google_oauth2, "GOOGLE_CLIENT_ID", "GOOGLE_CLIENT_SECRET", {}

3. コールバックルートの設定


ソーシャルログインのコールバックURLを設定するために、routes.rbに以下のようなルートを追加します。

devise_for :users, controllers: { omniauth_callbacks: 'users/omniauth_callbacks' }

4. Omniauthコールバックコントローラーの作成


Users::OmniauthCallbacksControllerを作成し、認証情報を受け取ってユーザーを登録またはログインする処理を追加します。

class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
  def google_oauth2
    @user = User.from_omniauth(request.env["omniauth.auth"])

    if @user.persisted?
      sign_in_and_redirect @user, event: :authentication
      set_flash_message(:notice, :success, kind: "Google") if is_navigational_format?
    else
      session["devise.google_data"] = request.env["omniauth.auth"].except("extra")
      redirect_to new_user_registration_url, alert: "Google認証に失敗しました。"
    end
  end
end

5. Userモデルにソーシャルアカウント情報を保存する設定


Userモデルにソーシャル認証情報を保持するため、必要なカラムを追加し、from_omniauthメソッドを定義します。

rails generate migration AddOmniauthToUsers provider:string uid:string
rails db:migrate

Userモデルに以下のメソッドを追加します。

class User < ApplicationRecord
  devise :database_authenticatable, :registerable,
         :recoverable, :rememberable, :validatable, :omniauthable, omniauth_providers: [:google_oauth2]

  def self.from_omniauth(auth)
    where(provider: auth.provider, uid: auth.uid).first_or_create do |user|
      user.email = auth.info.email
      user.password = Devise.friendly_token[0, 20]
    end
  end
end

これにより、ソーシャルアカウントでの認証情報が保存され、既存ユーザーのログインや新規ユーザー登録が可能になります。

6. ログインリンクの追加


ログインページにGoogleログインボタンを追加し、ユーザーがソーシャルログインを利用できるようにします。

<%= link_to "Googleでログイン", user_google_oauth2_omniauth_authorize_path %>

以上で、DeviseにGoogleアカウントを使ったソーシャルログイン機能が統合されました。他のプロバイダも同様の手順で設定できます。これにより、ユーザーは外部アカウントを使ったログインが可能になり、利便性が向上します。次は、記事のまとめに移ります。

まとめ


本記事では、Ruby on RailsでDeviseを利用したユーザー認証機能の実装手順を解説しました。Deviseの基本的なインストールとユーザーモデルの作成から始まり、ログイン・ログアウト機能やパスワードリセット、アクセス制限の設定方法について学びました。また、RSpecやCapybaraを使った認証機能のテスト方法や、OmniAuthを利用したソーシャルログイン機能の追加も紹介しました。

Deviseを活用することで、セキュアで柔軟な認証機能を短期間で実装できるため、Railsアプリケーションのユーザー体験が向上します。適切な認証と認可の設定により、アプリケーションのセキュリティが強化され、維持管理もしやすくなります。今回の知識を活かして、実際のプロジェクトでのユーザー認証機能を実装してみてください。

Ruby
ユーザー認証 Ruby Rails Devise

コメント

コメントする

目次
  1. Deviseとは
  2. Deviseのインストール
    1. 1. GemfileにDeviseを追加
    2. 2. バンドルインストールの実行
    3. 3. Deviseのインストーラ実行
  3. ユーザーモデルの作成
    1. 1. ユーザーモデルの生成
    2. 2. マイグレーションの実行
    3. 3. ユーザーモデルの確認
  4. 認証機能のカスタマイズ
    1. 1. カスタムフィールドの追加
    2. 2. Userモデルへのフィールド追加
    3. 3. サインアップフォームのカスタマイズ
    4. 4. ストロングパラメータの設定
  5. ログインとログアウトの実装
    1. 1. ルーティング設定の確認
    2. 2. ログインとログアウトのリンク追加
    3. 3. ログイン後のリダイレクト先の設定
    4. 4. Flashメッセージの設定
  6. パスワードリセット機能の導入
    1. 1. パスワードリセットのメール設定
    2. 2. パスワードリセット用のルーティング
    3. 3. パスワードリセットリンクのカスタマイズ
    4. 4. パスワードリセットのメールテンプレート
    5. 5. パスワードリセットプロセスの確認
  7. ユーザーページのアクセス制限
    1. 1. before_actionを使用してアクセス制限を設定
    2. 2. アクセス制御によるエラーハンドリング
    3. 3. コントローラーごとのアクセス制限
    4. 4. アクセス制限に関するテスト
  8. 認証機能のテスト方法
    1. 1. RSpecとCapybaraのセットアップ
    2. 2. ユーザー認証のテスト
    3. 3. ログインフォームの機能テスト
    4. 4. パスワードリセット機能のテスト
  9. 応用：ソーシャルログイン機能の追加
    1. 1. OmniAuthとOmniAuthプロバイダのインストール
    2. 2. Deviseの設定変更
    3. 3. コールバックルートの設定
    4. 4. Omniauthコールバックコントローラーの作成
    5. 5. Userモデルにソーシャルアカウント情報を保存する設定
    6. 6. ログインリンクの追加
  10. まとめ