Udemy 12. サーバーサイドのログイン認証 #05
2020年10月01日に公開

【Rails×JWT】UserクラスからJWTを扱うTokenizableモジュールの作成

今回達成すること

今回はTokenizable(トークナイザブル)モジュールを作成します。

このモジュールは、トークンの発行と発行主の検索を行います。

Userクラスからインクルードすることで

  • ユーザーのトークンを発行する場合は => user.to_token
  • トークンからユーザーを検索する場合は=> User.from_token(token)

のように、Userクラスからトークンを扱えるようになります。

モジュールファイルを作成する

まずは「app/services」ディレクトリの「user_auth」ディレクトリ直下にtokenizable.rbファイルを作成します。

root $ touch api/app/services/user_auth/tokenizable.rb

作成後の「user_auth」ディレクトリ内はこのようになっています。

api/app/services/user_auth
├── auth_token.rb
├── authenticator.rb
└── tokenizable.rb

Tokenizableモジュールを作成する

まずは、tokenizable.rbUserAuthを継承したモジュールを宣言します。

api/app/services/user_auth/tokenizable.rb(以下、省略)
module UserAuth
  module Tokenizable
  end
end

Userクラスからメソッドを呼び出す用意

Userクラスから、Tokenizableモジュールのメソッドを呼び出せるようにself.included(インクルーディッド)メソッドを作成します。

module UserAuth
  module Tokenizable
    # 追加
    def self.included(base)
      base.extend ClassMethods
    end

    ## class method
    module ClassMethods
    end
    # ここまで
  end
end
  • self.included … クラスにモジュールが含まれている場合、このメソッドが実行される。

    UserクラスでTokenizableをインクルードした時にbase.extend ClassMethodsが実行されます。

    参考: RubyMixinチュートリアル - Juixe Techknow

  • base.extend ClassMethodsClassMethodsextendする。

    これにより、UserクラスにClassMethodsモジュール内のメソッドが追加されます。

self.includedのまとめ

  • include => クラスのインスタンスにメソッドが追加され、

  • extend => クラスメソッドが追加されます。

    参考: RailsTips

つまり、Userクラス内でinclude UserAuth::Tokenizableを実行した時に、userインスタンスとUserクラスにTokenizableのメソッドが追加されます。

クラスメソッドを作成する

Userクラスから呼び出すクラスメソッドには、渡されたトークンからユーザーを検索するfrom_tokenメソッドを追加します。

module UserAuth
  module Tokenizable
    def self.included(base)
      base.extend ClassMethods
    end

    ## class method
    module ClassMethods
      # 追加
      def from_token(token)
        auth_token = AuthToken.new(token: token)
        from_token_payload(auth_token.payload)
      end

      private
        def from_token_payload(payload)
          find(payload["sub"])
        end
      # ここまで
    end
  end
end
  • from_token_payload … トークンをデコードしたpayloadのユーザーID(sub)からユーザーを検索し返す。

インスタンスメソッドを作成する

userインスタンスから呼び出すメソッドには、ユーザーのトークンを返すto_tokenメソッドを追加します。

	  ...
      private
        def from_token_payload(payload)
          find(payload["sub"])
        end
    end

    # 追加
    ## instance method
    # トークンを返す
    def to_token
      AuthToken.new(payload: to_token_payload).token
    end

    private
      def to_token_payload
        { sub: id }
      end
    # ここまで
  end
end

以上で、トークンの発行とデコードを行うメソッドが作成できました。

有効期限付きのトークンを返すメソッドの作成

会員登録時のメール認証やパスワードリセットなどは、セキュリティを考慮してトークンの有効期限を短めに設定する必要があります。

その際に使用する「有効期限付きのトークン」を発行するto_lifetime_tokenメソッドを作成します。

api/app/services/user_auth/tokenizable.rb
    ...
    def to_token
      AuthToken.new(payload: to_token_payload).token
    end

    # 追加
    # 有効期限付きのトークンを返す
    def to_lifetime_token(lifetime)
      auth = AuthToken.new(lifetime: lifetime, payload: to_token_payload)
      { token: auth.token, lifetime_text: auth.lifetime_text }
    end

    private
    ...

このメソッドは、トークン(token)と有効期限の日本語テキスト(lifetime_text)を返します。

lifetime_textは、「2時間」などの文字列を返します。

この文字列は、メール本文やフロントに渡す「2時間以内に下記URLへアクセスしてください」のようなメッセージに埋め込む際に使用します。

AuthTokenクラスにlifetime_textメソッドを追加する

lifetime_textメソッドをauth_token.rbに新たに追加します。

api/app/services/user_auth/auth_token.rb
    ....
    def entity_for_user
      User.find @payload["sub"]
    end

    # 追加
    # token_lifetimeの日本語変換を返す
    def lifetime_text
      time, period = @lifetime.inspect.sub(/s\z/,"").split
      time + I18n.t("datetime.periods.#{period}", default: "")
    end

    private
		...
  • @lifetime.inspect.sub(/s\z/,'').split

    • inspect … オブジェクトを人間が読める形式に変換した文字列を返す。

      2.hoursを「“2 hours”」に変換します。

    • sub(/s\z/,'') … "2 hours"から「s」を削除し、「“2 hour”」に変換しています。

    • split … 「“2 hour”」を空白で区切り、配列にしています。[“2”, “hour”]

    以上で、timeには「“2”」の文字列、periodには「“hour”」の文字列が入ります。

  • I18n.t(パス, default: デフォルト値) …「“hour”」を日本語変換するために、 i18nの日本語化ファイルを呼び出しています。

    何もなければ、空の文字列を返すようデフォルト値(default: "")を指定しています。

i18nの日本語化ファイルに期間を追加する

i18nの日本語化ファイルja.ymlに、periodsを追加します。

datetimeの下でerrors:の上あたりに追加してください。

api/config/locales/ja.yml
  ...
  datetime:
    ...
    prompts:
      second: 秒
      minute: 分
      hour: 時
      day: 日
      month: 月
      year: 年
    # 追加
    periods:
      second: 秒
      minute: 分
      hour: 時間
      day: 日
      week: 週間
      month: ヶ月
      year: 年
    # ここまで
  errors:
		...

以上で有効期限付きのトークンを返すメソッドが作成できました。

userモデルでインクルードする

それでは作成したTokenizableモジュールをuser.rbからインクルードします。

api/app/models/user.rb
require "validator/email_validator"

class User < ApplicationRecord
  # include 追加
  include UserAuth::Tokenizable
  before_validation :downcase_email
	...

コンソールで確認してみよう

ユーザークラスで作成したメソッドが使えるかRailsコンソールで確認してみましょう。

root $ docker-compose run --rm api rails c

ユーザーインスタンスからトークンを発行してみます。

> user = User.find(1)
> token = user.to_token
> token
=> "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.ey..."

次はクラスメソッドでこのトークンの持ち主を探してみましょう。

> User.from_token(token)
=>
+----+-------+---------------+----------------+-----------+-------+---------------+----------------+
| id | name  | email         | password_di... | activated | admin | created_at    | updated_at     |
+----+-------+---------------+----------------+-----------+-------+---------------+----------------+
| 1  | user0 | user0@exam... | $2a$12$rYae... | true      | false | 2020-08-25... | 2020-08-25 ... |
+----+-------+---------------+----------------+-----------+-------+---------------+----------------+

無事、ID1を持つユーザーが返されました。

続いて有効期限付きのトークンを発行してみましょう。

> user.to_lifetime_token(2.hours)
=> {:token=>"eyJ0eXAiOiJKV1Q...", :lifetime_text=>"2時間"}

うん、上手く行っていますね。

「ほんまに2時間かぁ?」と思った方はトークンをデコードしてpayloadを確認してみてください。

> token = user.to_lifetime_token(2.hours)
> payload = UserAuth::AuthToken.new(token: token[:token]).payload
> Time.at(payload["exp"])
=> 2020-09-30 17:14:44 +0900

このメソッドを使えば、認証メッセージが簡単に作成できます。

> "#{token[:lifetime_text]}以内に認証してください。"
=> "2時間以内に認証してください。"

確認が取れたらコンソールから抜けましょう。

> exit

以上で今回の作業は終了です。

コミットしとく

コミットしておきましょう。

root $ cd api
api $ git add -A && git commit -m "add_tokenizable.rb" && cd ..
root $

まとめ

今回は、トークンをUserクラスで簡単に扱えるように、Tokenizableモジュールを作成しました。

さて次回は?

次回からは、ここまで作成したモジュール群が正しく機能しているか、認証関連一式のテストを行います。

お楽しみじゃ!(GoToBottom↓)

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
1. このカテゴリーの歩き方 #01
【お知らせ】UdemyでRails × Nuxt.jsの動画を公開することになりました
1. このカテゴリーの歩き方 #02
【随時更新】アプリケーション仕様書
1. このカテゴリーの歩き方 #03
【随時更新】このカテゴリーの歩き方
1. このカテゴリーの歩き方 #04
(Docker+Rails6+Nuxt.js+PostgreSQL)=>Heroku 環境構築~デプロイまでの手順書
2. Docker入門 #01
Docker for Macをインストールする手順
2. Docker入門 #02
分かるDocker解説。仮想環境・コンテナ・Dockerイメージ・Dockerfileとは何か?
2. Docker入門 #03
分かるDocker解説。DockerComposeとは何か?
3. Dockerを使ったRails+Nuxt.js環境構築 #01
【Docker+Rails6+Nuxt.js】今回作成するアプリの開発環境の全体像を知ろう
3. Dockerを使ったRails+Nuxt.js環境構築 #02
【MacOS】Homebrew経由でGitをインストールする方法
3. Dockerを使ったRails+Nuxt.js環境構築 #03
Rails6を動かすAlpineベースのDockerfileを作成する(AlpineLinuxとは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #04
Nuxt.jsを動かすAlpineベースのDockerfileを作成する(C.UTF-8とは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #05
.envファイルを使ったdocker-compose.ymlの環境変数設計
3. Dockerを使ったRails+Nuxt.js環境構築 #06
Rails6・Nuxt.js・PostgreSQLを動かすdocker-compose.ymlファイルを作成する
3. Dockerを使ったRails+Nuxt.js環境構築 #07
docker-compose.ymlを使ってRails6を構築する(PostgreSQLパスワード変更方法)
3. Dockerを使ったRails+Nuxt.js環境構築 #08
docker-compose.ymlを使ってNuxt.jsを構築する
4. 複数プロジェクトのGit管理 #01
複数プロジェクトで行うGit管理の全体像を理解しよう(Gitサブモジュール解説)
4. 複数プロジェクトのGit管理 #02
【Git】既存の子ディレクトリをサブモジュール管理に変更する手順
4. 複数プロジェクトのGit管理 #03
【GitHub】秘密鍵の生成・公開鍵を追加・SSH接続するまでを画像で分かりやすく
4. 複数プロジェクトのGit管理 #04
【GitHub】リモートリポジトリの追加・サブモジュールのリンク設定を行う
5. RailsAPI×Nuxt.js初めてのAPI通信 #01
【Rails6】"Hello" jsonを返すコントローラを作成する
5. RailsAPI×Nuxt.js初めてのAPI通信 #02
【Nxut.js】axiosの初期設定を行う(baseURL・browserBaseURLを解説)
5. RailsAPI×Nuxt.js初めてのAPI通信 #03
【Rails6】Gem rack-corsを導入してCORS設定を行う(オリジン・CORSとは何か)
6. Heroku.ymlを使ったDockerデプロイ #01
デプロイ準備。Herokuへ新規会員登録を行いHerokuCLIをインストールする
6. Heroku.ymlを使ったDockerデプロイ #02
heroku.yml解説編。Docker環境のRails6をHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #03
HerokuCLI-manifestのデプロイ解説編。Docker環境のRails6をHerokuにデプロイする(2/2)
6. Heroku.ymlを使ったDockerデプロイ #04
Dockerfile解説編。Docker環境のNuxt.jsをHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #05
デプロイ完結編。Docker環境のNuxt.jsをHerokuにデプロイする(2/2)
7. モデル開発事前準備 #01
【Rails6】application.rbの初期設定(タイムゾーン・I18n・Zeitwerk)
7. モデル開発事前準備 #02
【Rails6】モデル開発に必要なGemのインストールとHirb.enableの自動化
7. モデル開発事前準備 #03
【Docker+Rails】A server is already running. Check /tmp/pids/server.pidエラーの対応
7. モデル開発事前準備 #04
【Docker】<none>タグのイメージを一括削除する & Rails .gitignoreの編集
8. ユーザーモデル開発 #01
Railsユーザーモデル作成。テーブル設計・ユーザー認証設計を理解する
8. ユーザーモデル開発 #02
Railsユーザーモデルのバリデーション設定(has_secure_password解説)
8. ユーザーモデル開発 #03
Railsバリデーションエラーメッセージの日本語化(ja.yml設定方法)
8. ユーザーモデル開発 #04
EachValidatorクラスのカスタムバリデーション設定(Rails6/lib以下読込)
8. ユーザーモデル開発 #05
Rails環境ごとにSeedデータ切り替えるseeds.rbの書き方
8. ユーザーモデル開発 #06
Rails6から導入された並列テストを理解する
8. ユーザーモデル開発 #07
Railsユーザーモデルバリデーションテスティング(name/email/password)
8. ユーザーモデル開発 #08
Nuxt.jsからRailsのユーザーテーブルを取得しHerokuにデプロイする
9. Nuxt.jsフロント開発事前準備 #01
【Nuxt.js2.13超解説】バージョンアップ手順と6つの新機能+2つの変更点
9. Nuxt.jsフロント開発事前準備 #02
Docker AlpineベースのNode.js上で動くNuxt.jsにVuetifyを導入する
9. Nuxt.jsフロント開発事前準備 #03
VuetifyにカスタムCSSを導入してオリジナルブレイクポイントを作る
9. Nuxt.jsフロント開発事前準備 #04
Nuxt.jsにnuxt-i18nを導入して国際化に対応する
10. ログイン前のレイアウト構築 #01
Nuxt.jsのレイアウト・ページ・コンポーネントの役割を理解しよう
10. ログイン前のレイアウト構築 #02
Nuxt.js ウェルカムページを構成するコンポーネントファイル群を作成しよう(1/4)
10. ログイン前のレイアウト構築 #03
Nuxt.js ウェルカムページにアイキャッチ画像・アプリ名・メニューボタンを表示しよう(2/4)
10. ログイン前のレイアウト構築 #04
Nuxt.js addEventListenerでスクロールを検知しツールバーの色を変化させよう(3/4)
10. ログイン前のレイアウト構築 #05
Nuxt.js ウェルカムページをレスポンシブデザインに対応させよう(4/4)
10. ログイン前のレイアウト構築 #06
Nuxt.js 会員登録ページのレイアウトファイルを作成しよう(1/4)
10. ログイン前のレイアウト構築 #07
Nuxt.js 名前、メール、パスワードのコンポーネントファイルを作成しよう(2/4)
10. ログイン前のレイアウト構築 #08
Nuxt.js 親子コンポーネント間の双方向データバインディングを実装する(3/4)
10. ログイン前のレイアウト構築 #09
Nuxt.js Vuetifyのv-text-fieldを使った会員登録フォームのバリデーション設定(4/4)
10. ログイン前のレイアウト構築 #10
Nuxt.js ログインページ実装とHerokuデプロイまで(router. replaceとpushの違いとは)
11. ログイン後のレイアウト構築 #01
Nuxt.js ログイン後のツールバーを作成しよう(inject解説)
11. ログイン後のレイアウト構築 #02
Nuxt.js アカウントメニューページ・ログアウト機能を実装しよう(nuxt-child解説)
11. ログイン後のレイアウト構築 #03
Nuxt.js ログイン後のトップページにプロジェクト一覧を表示しよう
11. ログイン後のレイアウト構築 #04
Nuxt.js プロジェクトページにVuetifyのナビゲーションドロワーを追加しよう
11. ログイン後のレイアウト構築 #05
Nuxt.js paramsIDからプロジェクトを検索してVuexに保存しよう
12. サーバーサイドのログイン認証 #01
JWTとは何か?(ruby-jwtのインストール)
新着
12. サーバーサイドのログイン認証 #02
【Rails×JWT】ログイン認証解説とJWT初期設定ファイルの作成
新着
12. サーバーサイドのログイン認証 #03
【Rails×JWT】トークン発行とデコードを行うAuthTokenクラスの作成
新着
12. サーバーサイドのログイン認証 #04
【Rails×JWT】 ログイン判定を行うAuthenticatorモジュールの作成
新着
12. サーバーサイドのログイン認証 #05
【Rails×JWT】UserクラスからJWTを扱うTokenizableモジュールの作成
新着
12. サーバーサイドのログイン認証 #06
【Rails×JWT】AuthTokenクラスとAuthenticatorモジュールをテストする
新着
12. サーバーサイドのログイン認証 #07
【Rails×JWT】JWTをCookieに保存するログインコントローラーの実装
新着
12. サーバーサイドのログイン認証 #08
【Rails×JWT】ログインコントローラーのテストとHerokuデプロイ
新着
SPA開発
ブログ構築
小ネタ集