前回作った todo アプリケーションにメールアドレス変更機能と、エラーメッセージ・メールの日本語化を追加します。

メールアドレス変更機能

change_email プラグインをインストールします。

ruby script/plugin install git://github.com/kusakari/change_email.git

依存しているプラグインをインストールします。（valid-attributes）

ruby script/plugin install git://github.com/kusakari/valid_attributes.git

メールアドレス保存用のコードを自動生成します。

ruby script/generate change_email email user

migrate します。

rake db:migrate

これで、以下の URL からメールアドレスを変更することができます。（ログイン後のみ）

http://localhost:3000/change_email

エラーメッセージの日本語化

RailsJa プラグインをインストールします。

ruby script/plugin install git://github.com/kusakari/rails-ja.git

次に、app/models/todo.rb を変更します。

以下のようにして、@@humanized_attribute_names にアトリビュートごとの名称を設定します。

human_model_name は日本語モデル名を返すようにします。

class Todo < ActiveRecord::Base
  validates_presence_of     :name
  validates_length_of       :name,    :within => 1..100
  class << self
    @@humanized_attribute_names = {
      "name" => "タスク名",
    }
    def human_model_name
      "Todo"
    end
  end
end

メールの日本語対応

ActionMailerJa プラグインはインストールするだけで日本語対応できる ActionMailer 拡張です。

ruby script/plugin install git://github.com/kusakari/actionmailer-ja.git

ActionMailerJa はメールヘッダの Subject, From, Cc, Recipients の日本語化にも対応しているため、

例えば、app/models/user_mailer.rb の場合、以下のように変更します。

class UserMailer < ActionMailer::Base
  def signup_notification(user)
    setup_email(user)
    @subject    += '新しいアカウントを有効にして下さい'

    @body[:url]  = "#{$SERVICE_URL}/activate/#{user.activation_code}"

  end

  def activation(user)
    setup_email(user)
    @subject    += 'アカウントが有効になりました'
    @body[:url]  = "#{$SERVICE_URL}"
  end

  protected
    def setup_email(user)
      @recipients  = "#{user.email}"
      @from        = "TODOアプリケーション <#{$ADMIN_EMAIL}>"
      @subject     = "[YOURSITE] "
      @sent_on     = Time.now
      @body[:user] = user
    end
end

以上でメールアドレスの変更機能と、エラーメッセージ・メールの日本語対応ができました。

僕が現時点で Ruby on Rails を選択するのは、他のフレームワークでは、

ここまでの機能を同じくらい高速で汎用的に開発することはできないと思っているからです。

これはもちろん Ruby という言語によるものが大きいと思います。

ということで Ruby on Rails のメリットを最大限活かせるように、プラグインやジェネレータを積極的に作っていきたいと思います。

数回に分けてログインアプリケーションを一通り作るためのまとめを書いてみます。

Project の作成

今回は何でもいいので、とりあえず todo を作成してみます。

rails todo

Plugin Install

必要なプラグインをあらかじめインストールしておきます。

restful-authentication

ruby script/plugin install git://github.com/technoweenie/restful-authentication.git

aasm

gem sources -a http://gems.github.com
gem install rubyist-aasm

forgot_password

ruby script/plugin install git://github.com/greenisus/forgot_password.git

Generate

sessions_controller と user モデルを作成します。

ruby script/generate authenticated user sessions --include-activation --aasm

passwords_controller と password モデルを作成します。

ruby script/generate forgot_password password user

その他修正箇所

このままでは動作しないので、aasm 関係を読み込むように修正します。

vendor/plugins/restful-authentication/init.rb

require File.dirname(__FILE__) + '/lib/authentication'
require File.dirname(__FILE__) + '/lib/authentication/by_password'
require File.dirname(__FILE__) + '/lib/authentication/by_cookie_token'
+require 'aasm'
+require File.dirname(__FILE__) + '/lib/authorization/aasm_roles'

アクティベーション用の route を追加。
config/routes.rb

（省略）
  map.activate '/activate/:activation_code', :controller => 'users', :action => 'activate'
（省略）

メールの設定をします。

config/environment.rb

（省略）
Rails::Initializer.run do |config|
（省略）
  config.active_record.observers = :user_observer

  config.action_mailer.raise_delivery_errors = true
  config.action_mailer.delivery_method = :smtp
  config.action_mailer.smtp_settings = {
    :address => 'SMTP サーバ',
    :port => 587, # or 25
    :domain => 'ドメイン',
    :authentication => :login,
    :user_name => 'SMTP AUTH ユーザーID',
    :password => 'SMTP AUTH パスワード'
  }
end

$ADMIN_EMAIL = '管理者のメールアドレス'
$SERVICE_URL = 'http://localhost:3000'

メールアドレスと URL を設定します。

app/models/user_mailer.rb

class UserMailer < ActionMailer::Base
  def signup_notification(user)
    setup_email(user)
    @subject    += 'Please activate your new account'

    @body[:url]  = "#{$SERVICE_URL}/activate/#{user.activation_code}"

  end

  def activation(user)
    setup_email(user)
    @subject    += 'Your account has been activated!'
    @body[:url]  = "#{$SERVICE_URL}"
  end

  protected
    def setup_email(user)
      @recipients  = "#{user.email}"
      @from        = $ADMIN_EMAIL
      @subject     = "[YOURSITE] "
      @sent_on     = Time.now
      @body[:user] = user
    end
end

app/models/password_mailer.rb

class PasswordMailer < ActionMailer::Base

  def forgot_password(password)
    setup_email(password.user)
    @subject    += 'You have requested to change your password'
    @body[:url]  = "#{$SERVICE_URL}/change_password/#{password.reset_code}"
  end

  def reset_password(user)
    setup_email(user)
    @subject    += 'Your password has been reset.'
  end

  protected
    def setup_email(user)
      @recipients  = "#{user.email}"
      @from        = $ADMIN_EMAIL
      @subject     = "[YOURSITE] "
      @sent_on     = Time.now
      @body[:user] = user
    end
end

今回はすべてのコントローラのアクションを認証対象とするため、

application.rb で AuthenticatedSystem を読み込み、login_required を設定します。

app/controllers/application.rb

class ApplicationController < ActionController::Base

（省略）
  include AuthenticatedSystem

  before_filter :login_required

end

認証が必要ないアクションは except に指定します。

app/controllers/users_controller.rb

class UsersController < ApplicationController
  before_filter :login_required, :except => [ :new,
                                              :create,
                                              :activate,
                                              :suspend,
                                              :unsuspend,
                                              :destroy,
                                              :purge,
                                            ]

（省略）

end

sessions_controller は認証が必要ないため、skip_before_filter を設定します。

app/controllers/sessions_controller.rb

class SessionsController < ApplicationController
  skip_before_filter :login_required

（省略）

end

起動準備

config/database.yml を設定して下さい。

todo scaffold を作成。

ruby script/generate scaffold todo name:string

app/views/layouts/todo.html.erb を application.html.erb に変更します。

データベースとテーブルの作成。

rake db:create

rake db:migrate

ここまで設定することで、httpd を起動すると以下の動作確認することができます。

• ユーザー登録
• ログイン
• ログアウト
• パスワードリセット
• アクティベーション（メール、パスワードリセット）

httpd は以下のコマンドで起動できます。

ruby script/server

動作確認のための URL は以下の通り。

# 会員登録
htt://localhost:3000/signup
# ログイン
htt://localhost:3000/login
# ログアウト
htt://localhost:3000/logout
# todo 一覧
htt://localhost:3000/todos

次回はこの todo にメールアドレス変更機能を追加し、日本語化してみます。

参考

aasmとは何か？acts_as_state_machineとの違いは？