18/04/2020 Railsチュートリアル Ruby on Rails 学習メモ

らくだ🐫にもできるRailsチュートリアル｜12.1

12章でやること
パスワードを忘れた時に再設定できるようにする仕組みを作る
見本は本文参照の事
11章ですでにパスワード再設定用のメーラーが生成されているので、そこにリソースとデータモデルを追加してパスワードの再設定を実装していく。
全体の流れはこちら

ユーザーがパスワードの再設定をリクエストすると、ユーザーが送信したメールアドレスをキーにしてデータベースからユーザーを見つける

該当のメールアドレスがデータベースにある場合は、再設定用トークンとそれに対応するリセットダイジェストを生成する

再設定用ダイジェストはデータベースに保存しておき、再設定用トークンはメールアドレスと一緒に、ユーザーに送信する有効化用メールのリンクに仕込んでおく

ユーザーがメールのリンクをクリックしたら、メールアドレスをキーとしてユーザーを探し、データベース内に保存しておいた再設定用ダイジェストと比較する (トークンを認証する)

認証に成功したら、パスワード変更用のフォームをユーザーに表示する

12.1 PasswordResetsリソース

branchを作ってから作業開始！

アカウント有効化リソースの際はeditアクションだけを使ったけど、
再設定では再設定用のフォームが必要→対応するviewを描写する必要がある→それぞれのアクションが必要
などから、RESTfulなルーティングが必要になる

12.1.1 PasswordResetsコントローラ

早速コントローラを生成

今回はビューも扱うので、newアクションとeditアクションも一緒に生成している点に注意してください。

# new editアクションを持ったPasswordResetsコントローラーを生成（テストは生成しない）
$ rails generate controller PasswordResets new edit --no-test-framework

1 2	# new editアクションを持ったPasswordResetsコントローラーを生成（テストは生成しない） $ rails generate controller PasswordResets new edit --no-test-framework

コントローラの単体テストをする代わりに、前章（11.3.3）から統合テストでカバーしていくため

パスワード再設定用リソースを追加

新しいパスワードを再設定するためのフォームとUserモデル内のパスワードを変更するためのフォームが必要なので↓下記

Rails.application.routes.draw do

  get 'password_resets/new'

  get 'password_resets/edit'

  root 'static_pages#home'
  get  '/help',    to:'static_pages#help'
  get  '/about',   to:'static_pages#about'
  get  '/contact', to:'static_pages#contact'
  
  get  '/signup',  to:'users#new'
  post '/signup',  to: 'users#create'
  
  get    '/login',   to: 'sessions#new'
  post   '/login',   to: 'sessions#create'
  delete '/logout',  to: 'sessions#destroy'
  resources :users
  # account_activationsresourceのeditへのルーティングのみを生成
  resources :account_activations, only: [:edit]
  #password_resetsのnew、create、edit、updateのルーティングを生成 
  resources :password_resets,     only: [:new, :create, :edit, :update]
end

Rails.application.routes.draw do

get 'password_resets/new'

get 'password_resets/edit'

root 'static_pages#home'

get '/help', to:'static_pages#help'

get '/about', to:'static_pages#about'

get '/contact', to:'static_pages#contact'

get '/signup', to:'users#new'

post '/signup', to: 'users#create'

get '/login', to: 'sessions#new'

post '/login', to: 'sessions#create'

delete '/logout', to: 'sessions#destroy'

resources :users

# account_activationsresourceのeditへのルーティングのみを生成

resources :account_activations, only: [:edit]

#password_resetsのnew、create、edit、updateのルーティングを生成

resources :password_resets, only: [:new, :create, :edit, :update]

end

パスワード再設定画面へのリンクを追加

<% provide(:title, "Log in") %>
<h1>Log in</h1>

<div class="row">
  <div class="col-md-6 col-md-offset-3">
    <%= form_for(:session, url: login_path) do |f| %>

      <%= f.label :email, User.human_attribute_name(:email) %>
      <%= f.email_field :email, class: 'form-control' %>

      <%= f.label :password, User.human_attribute_name(:password) %>
      <%= link_to t('.forgot_password'), new_password_reset_path %>
      <%= f.password_field :password, class: 'form-control' %>
      
      <%= f.label :remember_me, class: "checkbox inline" do %>
        <%= f.check_box :remember_me %>
        <span><%= t('.remember_me_checkbox') %></span>
      <% end %>

      <%= f.submit t('.login'), class: "btn btn-primary" %>
    <% end %>

    <p><%= t('.new_user?') %><%= link_to t('.signup'), signup_path %></p>
  </div>
</div>

<% provide(:title, "Log in") %>

<%= form_for(:session, url: login_path) do |f| %>

<%= f.label :email, User.human_attribute_name(:email) %>

<%= f.email_field :email, class: 'form-control' %>

<%= f.label :password, User.human_attribute_name(:password) %>

<%= link_to t('.forgot_password'), new_password_reset_path %>

<%= f.password_field :password, class: 'form-control' %>

<%= f.label :remember_me, class: "checkbox inline" do %>

<%= f.check_box :remember_me %>

<% end %>

<%= f.submit t('.login'), class: "btn btn-primary" %>

<% end %>

</div>

ログインフォームの「パスワード」の横にリンクが来るように設置

演習

この時点で、テストスイートが greenになっていることを確認してみましょう。

表 12.1の名前付きルートでは、_pathではなく_urlを使うように記してあります。なぜでしょうか? 考えてみましょう。ヒント: アカウント有効化で行った演習 (11.1.1.1) と同じ理由です。

GREEN
ページ内の相対リンクからではなく、メール本文の絶対リンクからリクエストを送るため

12.1.2 新しいパスワードの設定

パスワードの再設定もアカウント有効化の場合と同じく、トークン用の仮想的な属性とそれに対応するダイジェストを用意する
何度も言われているように、トークンをハッシュ化せずに平文でDBに保存するとセキュリティ上大問題となる！

攻撃者がユーザーのメールアドレスにパスワード再設定のリクエストを送信し、このメールと盗んだトークンを組み合わせて攻撃者がパスワード再設定リンクを開けば、アカウントを奪い取ることができてしまう、ということです。

→パスワードの再設定では！必ず！ダイジェストを使用する！！
また、再設定用のリンクはなるべく短時間で期限切れするようにしたい（本文には数時間とあるけど、30分以内に～とかよく見るよね）
→再設定用のメール送信時刻も記録する必要がある

パスワード再設定用のカラムをUserモデルに追加

上記に基づいてreset_digest属性とreset_sent_at属性をUserモデルに追加する

$ rails generate migration add_reset_to_users reset_digest:string \
> reset_sent_at:datetime
Running via Spring preloader in process 13970
      invoke  active_record
      create    db/migrate/タイムスタンプ_add_reset_to_users.rb
$ rails db:migrate

$ rails generate migration add_reset_to_users reset_digest:string \

> reset_sent_at:datetime

Running via Spring preloader in process 13970

invoke active_record

create db/migrate/タイムスタンプ_add_reset_to_users.rb

$ rails db:migrate

パスワード再設定用のカラムを追加したUserモデル→RailsTutorial本文

パスワード再設定画面を作成

ログインフォームのコードを参考にパスワードを再設定するためのフォームを作成する

<% provide(:title, "Forgot password") %>
<h1><%= t('.forgot_password?') %></h1>

<div class="row">
  <div class="col-md-6 col-md-offset-3">
    <%= form_for(:password_reset, url: password_resets_path) do |f| %>
      <%= f.label :email, User.human_attribute_name(:email) %>
      <%= f.email_field :email, class: 'form-control' %>

      <%= f.submit t('.reset'), class: "btn btn-primary" %>
    <% end %>
  </div>
</div>

<% provide(:title, "Forgot password") %>

<%= form_for(:password_reset, url: password_resets_path) do |f| %>

<%= f.label :email, User.human_attribute_name(:email) %>

<%= f.email_field :email, class: 'form-control' %>

<%= f.submit t('.reset'), class: "btn btn-primary" %>

<% end %>

</div>

演習

リスト 12.4のform_forメソッドでは、なぜ@password_resetではなく:password_resetを使っているのでしょうか? 考えてみてください。

password_resetはpassword_resetモデルがない→インスタンス変数に相当するものがない→form_forヘルパーに追加の情報を独自に渡す必要がある（渡すオブジェクトがないのでリソースの名前とそれに対応するURLを具体的に指定する必要がある）

12.1.3 createアクションでパスワード再設定

createアクションの動き

フォームから送信を行なった後、メールアドレスをキーとしてユーザーをデータベースから見つけ、パスワード再設定用トークンと送信時のタイムスタンプでデータベースの属性を更新する必要があります。それに続いてルートURLにリダイレクトし、フラッシュメッセージをユーザーに表示します。送信が無効の場合は、ログイン (リスト 8.11) と同様にnewページを出力してflash.nowメッセージを表示します。変更の結果をリスト 12.5に示します。

class PasswordResetsController < ApplicationController
  def new
  end

  def create
    # @userに代入→（フォームに入力された）email(を小文字にしたやつ）を持ったuserをDBから見つけてる
    @user = User.find_by(email: params[:password_reset][:email].downcase)
    # もし　@userが存在すれば
    if @user
      # @userのパスワード再設定の属性を設定する（create_reset_digestはapp/models/user.rbにある）
      @user.create_reset_digest
      # @userにパスワード再設定メールを送る（send_password_reset_emailはapp/models/user.rbにある）
      @user.send_password_reset_email
      # （インフォで）flashメッセージを表示
      flash[:info] = "Email sent with password reset instructions"
      # rootにリダイレクト
      redirect_to root_url
    # （@userが）存在しなければ
    else
      # （デンジャーで）flashメッセージを表示
      flash.now[:danger] = "Email address not found"
      # newを描画
      render 'new'
    end
  end

  def edit
  end
end

class PasswordResetsController < ApplicationController

def new

end

def create

# @userに代入→（フォームに入力された）email(を小文字にしたやつ）を持ったuserをDBから見つけてる

@user = User.find_by(email: params[:password_reset][:email].downcase)

# もし　@userが存在すれば

if @user

# @userのパスワード再設定の属性を設定する（create_reset_digestはapp/models/user.rbにある）

@user.create_reset_digest

# @userにパスワード再設定メールを送る（send_password_reset_emailはapp/models/user.rbにある）

@user.send_password_reset_email

# （インフォで）flashメッセージを表示

flash[:info] = "Email sent with password reset instructions"

# rootにリダイレクト

redirect_to root_url

# （@userが）存在しなければ

else

# （デンジャーで）flashメッセージを表示

flash.now[:danger] = "Email address not found"

# newを描画

render 'new'

end

def edit

end

Userモデルにメソッドを追加

class User < ApplicationRecord
  #仮想の属性:remember_token、:activation_token、:reset_tokenをUserクラスに定義
  attr_accessor :remember_token, :activation_token, :reset_token
・
・
・
  # パスワード再設定の属性を設定する
  def create_reset_digest
    # （呼び出し先で考えると）@userのreset_tokenに代入→User.new_token
    self.reset_token = User.new_token
    # :reset_digestの値をUser.digest(reset_token)で上書き保存
    update_attribute(:reset_digest, User.digest(reset_token))
    # :reset_sent_atの値をTime.zone.nowで上書き保存
    update_attribute(:reset_sent_at, Time.zone.now)
  end

  # パスワード再設定のメールを送信する
  def send_password_reset_email
    UserMailer.password_reset(self).deliver_now
  end

    private
・
・
・

class User < ApplicationRecord

#仮想の属性:remember_token、:activation_token、:reset_tokenをUserクラスに定義

attr_accessor :remember_token, :activation_token, :reset_token

・

# パスワード再設定の属性を設定する

def create_reset_digest

# （呼び出し先で考えると）@userのreset_tokenに代入→User.new_token

self.reset_token = User.new_token

# :reset_digestの値をUser.digest(reset_token)で上書き保存

update_attribute(:reset_digest, User.digest(reset_token))

# :reset_sent_atの値をTime.zone.nowで上書き保存

update_attribute(:reset_sent_at, Time.zone.now)

end

# パスワード再設定のメールを送信する

def send_password_reset_email

UserMailer.password_reset(self).deliver_now

end

private

・

現状、無効なメールアドレスを入力した場合は正常に作動するけど
有効なメールアドレスを入力した場合はエラーになる
（パスワード再設定のメイラーメソッドを定義する必要があるので次の章でやるっぽい）

演習

試しに有効なメールアドレスをフォームから送信してみましょう (図 12.6)。どんなエラーメッセージが表示されたでしょうか?

コンソールに移り、先ほどの演習課題で送信した結果、(エラーと表示されてはいるものの) 該当するuserオブジェクトにはreset_digestとreset_sent_atがあることを確認してみましょう。また、それぞれの値はどのようになっていますか?

1.

引数のエラー→PasswordResetsController#create→問題のあるソース（app/mailers/user_mailer.rb:10:in `password_reset’）
2.

=> #<User id: 1, name: "Example User", email: "example@railstutorial.org",
    created_at: "2020-04-09 04:57:00", updated_at: "2020-04-14 07:10:23",
    password_digest: "$2a$10$69GKTgVlsOK/eis0pLfdw.xyqVvphrb030yUp.UCmCV...",
    remember_digest: nil, admin: true,
    activation_digest: "$2a$10$y3BA/9QXPjjE51k3UFPRoeLq5pE3uhVhXXaaWOXuTWb...",
    activated: true, activated_at: "2020-04-09 04:57:00",
    # ダイジェストが入力されている
    reset_digest: "$2a$10$SA0jULevKYw6Sgfq/fSJFe9hx80aBnD5kNavM11rO07...",
    #メールが送信された（はずの）時刻が入力されている
    reset_sent_at: "2020-04-14 07:10:23">

=> #<User id: 1, name: "Example User", email: "example@railstutorial.org",

created_at: "2020-04-09 04:57:00", updated_at: "2020-04-14 07:10:23",

password_digest: "$2a$10$69GKTgVlsOK/eis0pLfdw.xyqVvphrb030yUp.UCmCV...",

remember_digest: nil, admin: true,

activation_digest: "$2a$10$y3BA/9QXPjjE51k3UFPRoeLq5pE3uhVhXXaaWOXuTWb...",

activated: true, activated_at: "2020-04-09 04:57:00",

# ダイジェストが入力されている

reset_digest: "$2a$10$SA0jULevKYw6Sgfq/fSJFe9hx80aBnD5kNavM11rO07...",

#メールが送信された（はずの）時刻が入力されている

reset_sent_at: "2020-04-14 07:10:23">

まとめとか感想

フォームについて、わけ！わか！らん！となってかなり遡って見直したりしました
Railsチュートリアル内の話だし、実際はもっと違うのかもしれないとかも思いつつだけど
~~自力でひとまず納得できたので良しとしましょうそうしましょう！~~
「@password_resetではなく:password_resetを使っているのでしょうか? 」の回答にモヤっとしたものが残るけど進めていくうちにわかるかもしれないのでとりあえずほかにメモった。
あとアレ。タイポの癖ってあるよね😢

らくだ🐫にもできるRailsチュートリアルとは

「ド」が付く素人のらくだ🐫が勉強するRailsチュートリアルの学習記録です。
自分用に記録していますが、お役に立つことがあれば幸いです。

調べたとはいえらくだ🐫なりの解釈や説明が含まれます。間違っている部分もあるかと思います。そんな所は教えて頂けますと幸いなのですが、このブログにはコメント機能がありません💧お手数おかけしますがTwitterなどでご連絡いただければ幸いです