RubyでAPIキーを秘匿化するために.envを導入したので手順をまとめました。

.envとは

.envとは、環境変数を保存するためのテキストファイルです。
データベースの接続情報やAPIキー、トークンなどを保持するために使用します。
ソースコードに直接記述するのではなく、環境変数を使用してこれらの情報を渡すことが一般的です。

dotenvをインストールする

環境変数を.envファイルから読み込むためのGemをインストールします。
Gemfileに以下の内容を追記します。

gem "dotenv"

.envファイルを作成する

.envファイルを作成します。
ディレクトリ構造と各ファイルの中身は以下の通りです。

root/
  ├ .env
  ├ app/
    ├ sample.rb
  ├ Gemfile
  ├ Gemfile.lock

.envファイルに例としてAPI Keyを書き込みます。

APIKEY="123456789"

rubyファイルから読み込む

rubyの実行ファイルから先ほど作成したAPI Keyを読み込みます。

require "dotenv/load"

Dotenv.load

puts(ENV["API_KEY"])

ファイルを実行してAPI Keyが表示されれば成功です。

> ruby sample.rb
123456789

今回はここまでです。