Deviseを使用したRailsアプリケーションでの認証。 パート1：基本セットアップ

私の意見では、Railsアプリケーションでの認証に最適な宝石の1つです。 残念ながら、ハブを含め、このgemにはロシア語の情報がほとんどないため、このトピックについて説明します。 この記事は主に初心者を対象としており、前述のgemに基づいた認証のセットアップに関する詳細なチュートリアルです。 最初の部分では、基本的なセットアップの手順を説明します。 gemの詳細。



Deviseは、railsアプリケーションで認証機能を提供するruby gemです。 Deviseは、Warden gemと連携して動作します。Wardengemは、ラックベースのルビーアプリケーションでの認証メカニズム自体を提供します。 Deviseの主な機能は次のとおりです。

• ラックベース
• Railsベースの完全なMVCソリューションです。
• 複数のモデルのシステムに同時にログインできます。
• モジュール性に基づく：本当に必要なものだけを使用します。

それでは、Railsアプリケーション用にDeviseのインストールと構成を始めましょう。 読みやすさのためのさらなるプロセスは、別々のステップに分けられます。



注 ：私によるすべてのインストールと構成は、Railsバージョン4.0.1用に作成されました。



ステップ1. GemfileにGemを追加する

gem 'devise'
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

または正確なバージョンを示します（次のバージョンは私のためにrails 4.0.1で安定して動作します）

 gem 'devise', '3.2.2'
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

バンドルを実行して新しいgemをインストールします

 bundle install
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次のgemが依存関係としてインストールされます。

監視員-Rackアプリケーションに認証機能を提供するミドルウェア。

orm_adapter - Ruby ORMの基本機能を使用するための単一のエントリポイントを提供します。

bcrypt-ruby-パスワードを操作するためのシンプルなラッパーを提供します。 暗号化ハッシュ関数bcrypt（）に基づいています。

thread_safe -Ruby用のスレッドセーフなコレクションとユーティリティを提供します。

railtiesは、アプリケーションローダー、プラグイン、ジェネレーター、rakeタスクなどの内部Railsコンポーネントです。



ステップ2.これで、gemはダウンロードされましたが、アプリケーションとは対話しません。 Deviseには便利なジェネレーターがあり、そのうちの1つを使用します。 次のジェネレーターを実行してDeviseをインストールします。

 rails generate devise:install
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このジェネレーターは、操作に必要なすべてのDevise構成設定と、基本ロケール（英語）のファイルを記述する初期化子をインストールします。 また、インストーラーは基本的な構成を実行するように提供します。



ステップ3.インストール後にgemの基本設定を行いましょう

3.1。 次に、各ランタイムのメーラー（送信者）設定を設定する必要があります。 開発環境の場合、次の行をconfig / environment / development.rbファイルに追加します。

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

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

実稼働環境では、キー値：hostを現在の値に置き換える必要があります。



3.2。 ユーザーがログインし、アカウントを確認するか、パスワードを更新すると、Deviseはさらにリダイレクトするためのパスを探します。 デフォルトでは、 user_root_pathが存在する場合はリダイレクトされます。 それ以外の場合、Deviseはroot_pathにリダイレクトします。 したがって、このパスはアプリケーションで定義する必要があります。 config / routes.rb routes ファイルで次のような行を確認します。

 root 'home#index'
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ログイン後、ユーザーをアプリケーションのメインページにリダイレクトすることはあまり論理的ではないことに同意していただけると思います。 この点で、ユーザープロファイルページに正常にログインした後、リダイレクトを構成しましょう。 これを行うには、次のルートをconfig / routes.rbに追加します。

 get 'persons/profile', as: 'user_root'
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

注 ：

1）まず、コントローラーとアクションを作成する必要があります。 これは、便利なジェネレーターを使用してコンソールから実行できます。

 rails generate controller persons profile
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

2）その結果、ジェネレーターは、1つのプロファイルメソッド（アクション）とこのアクションのビューを備えたpersons_controllerコントローラーを作成します。

ルートのリストは、コンソールから取得できます。 次のコマンドを入力するだけです：

 bundle exec rake routes
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

私たちの場合、次のルーターが利用可能でなければなりません

 user_root GET /persons/profile(.:format) persons#profile
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

user_root_path ヘルパーが使用可能になります



また、入力後と終了後の両方で独自のリダイレクトを設定できる別の方法もあります。 これを行うには、 ApplicationController （ app / controllers / application_controller.rb ）の既存のdeviseメソッドafter_sign_in_path_forおよびafter_sign_out_path_forをオーバーライドする必要があります。 個人的には、リダイレクトを構成するこのオプションが好きでした：

 def after_sign_in_path_for(resource) current_user_path end
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ログイン後、ユーザーはcurrent_user_pathヘルパーによって記述されたページにリダイレクトされます

 def after_sign_out_path_for(resource_or_scope) request.referrer end
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ログアウト後、ユーザーは同じページに残ります。



3.3。 通知と警告の出力をテンプレートに追加する必要があります

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

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

3.4。 Railsバージョン3.2を使用してHerokuにアプリケーションをデプロイする場合、次の行をconfig / application.rbに追加します

 config.assets.initialize_on_precompile = false
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

3.5。 ビューファイルをニーズに合わせてカスタマイズできます。 これを行うには、次のコマンドを実行して、gemからアプリケーションにそれらをコピーする必要があります。

 rails generate devise:views
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

app / views / deviseディレクトリには、 gemが使用するすべてのビューファイルがあります。 必要に応じて、アプリケーションの全体的なスタイルに合わせてカスタマイズできます。



ステップ4.次に、認証を行うユーザーモデルを作成します。 ユーザーモデルを生成するので、それをUserと呼びます 。 モデルはadminと呼ばれることもあります：

 rails generate devise User
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このジェネレーターは、以前に存在しなかった場合に新しいモデルを作成し、デフォルトで使用されるモジュールを考慮して構成します。 ほとんどの場合、 app / models / user.rbで次のコードを取得します（コードは多少フォーマットされています）：

 class User < ActiveRecord::Base # Include default devise modules. Others available are: # :confirmable, :lockable, :timeoutable and :omniauthable devise :database_authenticatable, :registerable, :recoverable, :rememberable, :trackable, :validatable end
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Deviseには10個のモジュールがあります。 デフォルトでは、6つのモジュールが接続されています。 このリストを編集できます。 利用可能なすべてのモジュールの説明を以下に示します。



1. データベース認証可能 ：暗号化され、データベースに保存されたパスワードに基づいてシステムに入る機能を提供します。 ログインするには、POSTリクエストを送信するか、HTTP基本認証を使用します。

2. Omniauthable ：Omniauthサポートを追加します （ https://github.com/intridea/omniauth ）。

3. 確認可能：登録時に作成されたアカウントを確認する手順を記載したメールを送信できます。

4. 回復可能 ：忘れたパスワードを回復できます。 回復指示をメールで送信します。

5. 登録可能 ：ユーザー登録を管理し、アカウントを編集および削除できます。

6. Rememberable ：ユーザーはCookieに基づいてCookieを記憶できます。 トークンの作成と削除を制御します。

7. 追跡可能 ：入力数の統計を保持し、時間とITアドレスを考慮します。

8. タイムアウト可能 ：システムでのユーザーアクティビティセッションの期間を担当します。

9.検証可能：電子メールとパスワードの検証ツールを提供します。 モジュールは簡単に構成でき、独自のバリデーターを定義できます。

10. ロック可能 ：設定で指定された失敗した認証試行回数の後にアカウントをロックします。 アカウントは、電子メールまたは一定期間後にロック解除できます。



また、上記で実行したコマンドは、データベース移行ファイルとルートを作成します。 移行ファイルは次のとおりです。

 class DeviseCreateUsers < ActiveRecord::Migration def change create_table(:users) do |t| ## Database authenticatable 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 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
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここで、ユーザーテーブルが作成されていることがわかります（コードの3行目）。 Userモデルに名前を付けたため、テーブルの名前は同じですが、複数あります（ ActiveRecordの命名規則に従って）。 次に、作成時にテーブルに追加されるフィールドについて説明します。 コードからわかるように、6つのDeviseモジュールのみが機能するためにテーブル内のフィールドを必要とする場合があります。



モジュールを使用していない場合は、移行の対応するフィールドをコメント化することを忘れないでください。 また、逆に、モジュールの1つをアクティブにするときは、対応する行のコメントを外すことも忘れないでください。



次のルートがconfig / routes.rbファイルに作成されます ：

 devise_for :users
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コマンドで既存のルートのリストを表示できることを思い出させてください：

 bundle exec rake routes
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ステップ5.そこで、必要なモジュールを接続したモジュールを見つけて、移行ファイルを調べました。 次に、移行を実行する必要があります。これにより、必要なフィールドのセットを持つユーザーテーブルが作成されます。 次のコマンドを実行します。

 bundle exec rake db:migrate
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

手順6.次に、すべての変更を有効にするには、アプリケーションを再起動する必要があります。 これを行わないと、さまざまな種類のエラーが発生する可能性があります。

アプリケーションはUnicornサーバーを実行しているため、再起動します。 Webrickサーバーでアプリケーションをテストする場合は、キーの組み合わせCTRL + Cを使用して停止し、再起動するだけで十分です。

 rails server
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ステップ7.モジュールとアプリケーションは動作する準備ができています。 次のステップは、ログインおよび登録リンクをテンプレートに追加することです。 これは次のように実行できます。

 <% if user_signed_in? %> <span>, <%= current_user.email %></span> <%= link_to '', destroy_user_session_path, :method => :delete %> <% else %> <%= link_to '', new_user_session_path %>  <%= link_to '', new_user_registration_path %> <% end %>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ユーザーがサイトにログインしている場合、「こんにちは、[ユーザーのメール]」と書いて、次に終了するためのリンクを配置します。 ユーザーがまだサイトにアクセスしていない場合、近くに2つの「ログイン」および「登録」リンクがあります。 既存のヘルパーをリンクのパスとして使用します。 ルートが4番目のステップでインストールされ、リストは次のコマンドで表示できることを思い出させてください。 ヘルパーはプレフィックス（左端の列+ '_path'）で構成されます

 bundle exec rake routes
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ステップ8.今度は、意図した目的でDeviseの使用を開始します。サイトの特定のセクションへの不正ユーザーアクセスを制限します。 許可されたユーザーのみが注文を完了することを許可するとします。 これを行うには、適切なコントローラーにフィルターを追加する必要があります。

 class OrdersController < ApplicationController before_filter :authenticate_user!, except => [:show, :index] def index # do something end def show # do something end def create # do something end end
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここでは、コードで、フィルタリングしないコントローラーメソッドのリストを2番目のパラメーターとしてbefore_filterメソッドに渡します。 したがって、承認は注文の実行（ 注文メソッドの操作へのアクセス）にのみ必要です。 すべてのコントローラーメソッドをフィルターする必要がある場合、2番目のパラメーターを送信する必要はありません。 書くだけ：

 before_filter :authenticate_user!
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

便利なヘルパーメソッドのリスト

Deviseには、コントローラーおよびビュー内で使用できる便利なヘルパーが含まれています。 それらのいくつかを以下に示します。

次のヘルパーを使用して、システムへのユーザーログインの事実を確認できます。

 user_signed_in?
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次のヘルパーを使用して、サイトで現在許可されているユーザーのオブジェクトを取得します

 current_user
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次のようにユーザーのメールを表示できます

 current_user.email
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

現在のセッションへのアクセスは、次のようにして取得できます。

 user_session
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

これで最初のパートは終了します。次のパートでは、この素晴らしい認証の宝石の、それほど重要ではなく、それほど興味深いものでもない他の設定について書きます。

使用された文献のリスト：

素材のメインソースとして、公式のgemドキュメント-github.com/plataformatec/deviseが使用されました。これは、独自のカスタマイズエクスペリエンスによって補完されています。