下記のような感じで <code>binding.irb</code> を差し込むことによって、そこでブレークしてくれます。<pre><code>class SessionsController &lt; ApplicationController
&nbsp; def create
 reset_session
&nbsp; &nbsp; auth = request.env['omniauth.auth']
binding.irb
&nbsp; &nbsp; user = User.find_or_create_by(uid: auth.uid, provider: auth.provider) do |u|
&nbsp; &nbsp; &nbsp; u.email = auth.info.email
&nbsp; &nbsp; &nbsp; u.name = auth.info.name
&nbsp; &nbsp; end
……
end</code></pre>

コード中に binding.irb を差し込みます

view にも差し込めて結構便利だったりします。<pre><code>&lt;% binding.irb %&gt;
&lt;% if session[:user_id] %&gt;
&nbsp; &lt;p&gt;Signed in as &lt;%= current_user.name %&gt;&lt;/p&gt;
&nbsp; &lt;%= link_to 'Sign out', logout_path, method: :delete %&gt;
&lt;% else %&gt;
&nbsp; &lt;%= link_to 'Sign in with Cognito', '/auth/cognito' %&gt;
&lt;% end %&gt;</code></pre>

View にも差し込めます

binding.irb

今さら聞けない Ruby on Rails デバッグ方法

まず、<code>Gemfile</code> に以下の行を追加します。<pre><code>gem 'omniauth'
gem 'omniauth-openid-connect'</code></pre> その後、以下のコマンドを実行して gem をインストールします。<pre><code>bash
bundle install</code></pre>

OmniAuth gem のインストール

<code>.env</code> に <code>CLIENT_ID</code> , <code>CLIENT_SECRET</code> を記載します。<pre><code>COGNITO_DOMAIN= 'https://aaaa.com'
CLIENT_ID= 'xxxxx'
CLIENT_SECRET= 'yyyy'</code></pre> <code>COGNITO_DOMAIN</code>: Cognito のドメイン<code>CLIENT_ID</code>: Cognito のクライアント ID<code>CLIENT_SECRET</code>: Cognito のクライアントシークレット

環境変数の設定

次に、<code>config/initializers/omniauth.rb</code> に以下の設定を追加します。<pre><code>Rails.application.config.middleware.use OmniAuth::Builder do
&nbsp; provider :openid_connect, {
&nbsp; &nbsp; name: :cognito,
&nbsp; &nbsp; scope: [:openid, :email, :profile],
&nbsp; &nbsp; response_type: :code,
&nbsp; &nbsp; discovery: true,
&nbsp; &nbsp; client_options: {
&nbsp; &nbsp; &nbsp; port: 443,
&nbsp; &nbsp; &nbsp; scheme: 'https',
&nbsp; &nbsp; &nbsp; host: ENV['COGNITO_DOMAIN'],
&nbsp; &nbsp; &nbsp; identifier: ENV['CLIENT_ID'],
&nbsp; &nbsp; &nbsp; secret: ENV['CLIENT_SECRET'],
&nbsp; &nbsp; &nbsp; redirect_uri: 'http://localhost:3000/auth/cognito/callback'
&nbsp; &nbsp; }
&nbsp; }
end</code></pre> <code>redirect_uri</code>: 認証後のリダイレクト先 (ローカル環境の場合: <code>http://localhost:3000/auth/cognito/callback</code>)

config の設定

<code>app/sesson_controller.rb</code> を設定します。<pre><code>class SessionsController &lt; ApplicationController
&nbsp; def create
 reset_session
&nbsp; &nbsp; auth = request.env['omniauth.auth']
&nbsp; &nbsp; user = User.find_or_create_by(uid: auth.uid, provider: auth.provider) do |u|
&nbsp; &nbsp; &nbsp; u.email = auth.info.email
&nbsp; &nbsp; &nbsp; u.name = auth.info.name
&nbsp; &nbsp; end

&nbsp; &nbsp; session[:user_id] = user.id
&nbsp; &nbsp; redirect_to root_path, notice: 'Signed in!'
&nbsp; end

&nbsp; def destroy
&nbsp; &nbsp; reset_session
&nbsp; &nbsp; redirect_to root_path, notice: 'Signed out!'
&nbsp; end

&nbsp; def failure
&nbsp; &nbsp; redirect_to root_path, alert: 'Authentication failed, please try again.'
&nbsp; end
end</code></pre>

コントローラの設定

ルーティングに OmniAuth のコールバック URL を追加するために、<code>config/routes.rb</code> を編集します。<pre><code>Rails.application.routes.draw do
&nbsp; get '/auth/:provider/callback', to: 'sessions#create'
&nbsp; get '/auth/failure', to: 'sessions#failure'
&nbsp; delete '/logout', to: 'sessions#destroy'

&nbsp; root 'home#index'
end</code></pre>

ルーティングの設定

ユーザー情報を保存するための <code>User</code> モデルを作成します。<pre><code>rails generate model User provider:string uid:string name:string email:string
rails db:migrate</code></pre>

User モデルの設定

ログインボタンやログアウトリンクをビューに追加します。例えば、<code>app/views/home/index.html.erb</code> に以下のように記述します。<pre><code>&lt;% if session[:user_id] %&gt;
&nbsp; &lt;p&gt;Signed in as &lt;%= current_user.name %&gt;&lt;/p&gt;
&nbsp; &lt;%= link_to 'Sign out', logout_path, method: :delete %&gt;
&lt;% else %&gt;
&nbsp; &lt;%= link_to 'Sign in with Cognito', '/auth/cognito' %&gt;
&lt;% end %&gt;</code></pre> <code>current_user</code> ヘルパーを追加するために、<code>app/controllers/application_controller.rb</code> に以下のメソッドを追加します。<pre><code>class ApplicationController &lt; ActionController::Base
&nbsp; helper_method :current_user

&nbsp; def current_user
&nbsp; &nbsp; @current_user ||= User.find(session[:user_id]) if session[:user_id]
&nbsp; end
end</code></pre>

ビューの設定

以上で、SSO認証(openid_connect) の実装が完了します。簡単に認証が実装できていいですね！

最後に

実装

AWS Cognito を使って SSO 認証してみた

今使っている gem のバージョンと最新の gem のバージョンがどれくらい異なっているか確認します。下記コマンドで、最新でない gem のリストが取得できますので、確認してみましょう。<pre><code>bundle outdated</code></pre>

gem の状態を確認する

rubocop を使って、記述に問題がないかを確認します。また、 rspec を使って自動テストがすべて通ることを確認します。

コードの状態を最新に保つ

Ruby on Rails アップデート手順

下記コマンドで、 develop, test の gem をアップデートします。<pre><code>bundle update -g development -g test</code></pre>

develop, test の gem をアップデートする

<code>bundle outdated</code>の結果を見て、メジャーバージョン番号が変わっているgemを1つずつ慎重にアップデートします。<pre><code>bundle update [gem]</code></pre><code>bundle update [gem]</code> の実行結果が依存関係でエラーになる場合、最新バージョンではなく、古いバージョンを指定するなどして、エラーが発生しないようにします。どうしても依存関係エラーが発生する場合は、バージョンアップをスキップすることも選択肢にいれましょう。

gem のアップデートをする

rubocop で記述に問題ないか確認したり、rspec で自動テストを実行したり、実際に画面を操作したりして、今まで通り使えているかどうかを確認します。

動作確認

Ruby on Rails のマイナーバージョン、またはメジャーバージョンを上げる前に、パッチバージョンを最新に上げます。たとえば、Rails 6.0.5.9 を Rails 6.1 に上げる前に、Rails 6.0.6.1 に上げます。<pre><code>Gemfile
 # Railsのパッチバージョンを上げる
-gem 'rails', '6.0.5.9'
+gem 'rails', '6.0.6'</code></pre> <pre><code>bundle update rails</code></pre>

rails gem 最新のパッチバージョンに更新する

rails gem メジャーバージョン、もしくはマイナーバージョンを更新します。<pre><code>Gemfile
 # Railsのパッチバージョンを上げる
-gem 'rails', '6.0.6'
+gem 'rails', '6.1.7.8'</code></pre> <pre><code>bundle update rails</code></pre> エラーが発生する場合は、エラーメッセージをよく見て、依存関係に問題がないかよく確認します。<code>~&gt; </code> がついている部分など、バージョンを手動で上げないとエラーになったりします。

rails gem メジャーバージョン、もしくはマイナーバージョンを更新する

<code>rails app:update</code>　を実行します。<pre><code>rails app:update</code></pre> <blockquote>上書き更新されるファイルは次のように対応方法を質問されるので、 Y/n/a/q/d/hのいずれかのキーを入力します。</blockquote><pre><code>Overwrite /myapp/config/application.rb? (enter "h" for help) [Ynaqdh]</code></pre> <blockquote>各キーの意味は次の通りです。</blockquote><pre><code>Y - Yes。上書き実行
n - No。上書きしない
a - All。このファイル以降の全ファイルを上書き
q - Quit。処理中断
d - Diff。新旧ファイルのdiffを表示
h - Help。入力する各キーの意味を表示</code></pre>

rails app:update の実行

<blockquote><code>rails app:update</code> にて、Y で上書き実行すると、それまで使っていた重要な設定が失われることがあります。 その場合は git の diff をチェックしながら、上書きされて消えてしまった設定を自力で戻していきます。</blockquote>

重要な設定を元に戻す

<blockquote>新しいバージョンの Ruby on Rails では、前のバージョンとデフォルト設定が異なるものがあります。 <code>app:update</code>タスクでは、アプリケーションを新しいデフォルト設定に1つずつアップグレードできるように、 <code>config/initializers/newframeworkdefaults_X.Y.rb</code>ファイルが作成されます。 このファイル内のコメントを解除して、新しいデフォルト設定を有効にする必要があります。 アプリケーションを新しいデフォルト設定で動かせる準備が整ったら、 このファイルを削除して<code>config.load_defaults</code>の値を反映させてやります。</blockquote>

フレームワークのデフォルトを設定する

<blockquote><code>app:update</code>コマンドを実行しても、Gemfile のようにまったく更新されないファイルもあります。 ですが、<code>rails new</code>した直後の Gemfile を比較すると、デフォルトでインストールされる gem の種類やバージョンには違いがあります。 Ruby on Railsのバージョンを上げたのであれば、こういった部分も新しいRailsに合わせておく方が安心です。</blockquote> https://railsdiff.org/6.0.6.1/6.1.7.8

新しく追加された gem を確認する

rubocop で記述に問題ないか確認したり、rspec で自動テストを実行したり、実際に画面を操作したりして、今まで通り使えているかどうかを確認します。﻿

繰り返し実施

繰り返し実施しているなかで、Ruby on Rails アプリで使用している Ruby のバージョンが古い場合は、最新にする必要があります。<blockquote>Rubyは後方互換性をかなり重視しているので、バージョンを上げてもトラブルが起きる可能性は低いはずです。 ですが、それでもゼロとは言えないので、Rubyのバージョンを上げたらテストがすべてパスすることを確認してください。</blockquote>

BuildersIO produced by YOKU

#Ruby on Rails の記事一覧

今さら聞けない Ruby on Rails デバッグ方法

AWS Cognito を使って SSO 認証してみた

Ruby On Rails のアップデート手順

Docker+Go+GinのAPI開発環境を5分で作る

【AWS】boto3でDynamoDBを操作するときによく使うメソッド

Nuxt.jsをS3にデプロイしてCloudFront経由でアクセスする