5-15 devise（git指南，部分认为重要的内容的译文）

git指南：  https://github.com/plataformatec/devise

维基百科上有how to 的不少文章。

Stackoverflow有大量问题的答案。

全的文档devise:API

 

---

7-20新增：

warden：https://github.com/wardencommunity/warden/wiki/overview

warden是一个devise依赖的框架。env["warden"]是一个环境对象，用于验证

见最下：

---

 

 

devise使用介绍：

---

 

一个Rails基于warden的灵活的验证解决方案

 

• 彻底MVC
• 能够同时有多个models登入
• 基于模块化原则： 只使用你想要的功能。 

 

由10个单独的module组成:

• Database Authenticatable: hashes and stores a password in the database ，用于验证登录的。
• Omniauthable: adds OmniAuth support. ⚠️没看
• Confirmable: sends emails with confirmation instructions and verifies whether an account is already confirmed during sign in.
• Recoverable: 密码忘记后的重置.
• Registerable: 注册，也能够更新和删除帐号,
• Rememberable: manages generating and clearing a token for remembering the user from a saved cookie.
• Trackable: tracks sign in count, timestamps and IP address.
• Timeoutable: expires sessions that have not been active in a specified period of time.在一段时间后seesion过时注销。
• Validatable: 提供验证邮件，密码，可选可客制化 
• Lockable: 屡次输入密码失败后🔒住， 能够经过email或者一段时间后🔓

---

 

安装：

 

1. gem 'devise'
2. rails generate devise:install   #这步骤后能够设置默认url
3. rails generate devise [MODEL]   #通常用user或 member,生成model.
4. rails db:migrate后重新启动rails server.
5. 根据窗口提示：配置3条信息。

 

 

---

Controller filters and helpers

Devise定义了一些helper方法用在controllers和views中。

 

* 创建一个controller并进行用户验证，须要加上：

before_action :authenticate_user! 

   ⚠️， user是_your model name

 

* 肯定用户是否登录   

user_signed_in?

 

*  当前登录用户

current_user 

 

* use_session 可以存取session。 

 

* 须要创建根路径 root  , 由于Devise须要根路径redirect to 

 

---

Configuring Models (有很多例子具体看操做手册。)

model中的Devise方法接受一些options来配置modules。

User model里面默认有一些Devise模块：

  devise :database_authenticatable, :registerable,

         :recoverable, :rememberable, :trackable, :validatable

 还有一些被注释掉的是能够选择的。

这些符号传给devise method可以使用Devise的功能features和假定了一系列的数据列columns,具体的list能够在migration file文件中看到。如（部分）：

 

    create_table :users do |t|

      ## Database authenticatable

      t.string :email,              null: false, default: ""

      t.string :encrypted_password, null: false, default: ""

 

---

 

Strong Parameters(高级的自定义设置)、

 

当客制化views的时候，你须要增长新的属性给forms。

有三个action能够在controller中使用：

There are just three actions in Devise that allow any set of parameters to be passed down to the model, therefore requiring sanitization.

Their names and default permitted parameters are:

在controller有三个动做注册，登入，帐号更新, Devise容许你设置任何参数，而后传给model, 这称为sanitization。

• sign_in(Devise::SessionController#create) -只有验证key能够被permit。（如like）
• sign_up(Devise::RegistrationsController#create) - Permit 验证keys，password, password_confirmation
• account_update( Devise::RegistrationsController#update) -Permit 验证keys，password, password_confirmation和 current_password。

若是你想要容许额外的参数（懒惰方法），可使用before_action方法在ApplcationController:

class ApplicationController < ActionController::Base before_action :configure_permitted_parameters, if: :devise_controller? protected def configure_permitted_parameters devise_parameter_sanitizer.permit(:sign_up, keys: [:username]) end end

具体其余详细设置见，文档git...

---

 

Configuring views

后期客制化views， views打包在gem中，须要复制。

rails generate devise:views 

包括confirmations, mailer, passwords, registrations, sessions, shared, unlocks文件

所以能够选择生成部分视图:

rails generate devise:views -v registrations confirmations 

 

若是Devise有多个，User and Admin, Devise会用相同的views，但咱们能够客制化views。

 

1.  所需作的是在config/initializers/devise.rb中 config.scoped_views = true
2.  而后就可使用视图基于users/sessions/new和admins/sessions/new.

另外，也能够用生成器生成单独的views:

rails generate devise:views users

 

 

---

Configuring controllers

若是客制化视图不够，还能够客制化controller

 

第一步： rails g devise:controllers [scope] 

若是使用users做为scope，控制器建立app/controllers/users/.

另外；使用-c能够指定一个controller。（相似views -v）如：

rails generate devise:controllers users -c=sessions

总共6个控制器：confirmations_controller, omniauth_callbacks_controller, passwords_controller, registrations_controller, sessions_controller, unlocks_controller. 

 

第二步：在router.rb中使用这个controller

devise_for :users, controllers: {sessions: 'users/sessions' }

 

第三步：复制视图，从devise/sessions到users/sessions. 由于controller变了，默认的视图也须要重新定位。

 

第四步：最终，改变或扩展想要的controller actions.

 

---

 

 Configuring routes（详细的文档:devise_for）

 

Devise也支持客制化路径。能够经过devise_for方法，它接受options如

class_name ，controllers大量自定义的配置。

 

---

 

Test

Devise includes some test helpers for controller and integration tests.

In order to use them, you need to include the respective module in your test cases/specs.

在spec目录内存放下面的代码，习惯是spec/support/devise.rb中，或者直接在rails_helper.rb/spec_helper.rb也行。

 

RSpec.configure do |config|

  config.include Devise::Test::ControllerHelper, type: :controller

  config.include Devise::Test::ControllerHelper, type: :view

  config.include Devise::Test::IntegrationHelper, type: :system

  config.include Devise::Test::IntegrationHelper, type: :request

  config.include Devise::Test::IntegrationHelper, type: :feature

#应该能够不写具体类型 

end

而后在控制器测试中能够用，不用本身写登录代码了，不过控制器测试已被弃。

sign_in @user
sign_in @user, scope: :admin

用于集成测试的方法：

sign_in users(:bob)
sign_in users(:bob), scope: :admin

sign_out :user

 

---

Configuring multiple models

能够配置多个Devise model,用于不一样的目的。好比只想要一个数据验证和计时timeout的功能的model.就能够这么设计：

# Create a migration with the required fields
create_table :admins do |t|
  t.string :email
  t.string :encrypted_password
  t.timestamps null: false
end

# Inside your Admin model
devise :database_authenticatable, :timeoutable

# Inside your routes
devise_for :admins

# Inside your protected controller
before_action :authenticate_admin!

# Inside your controllers and views
admin_signed_in?
current_admin
admin_session

---

wardon
warden是一个devise依赖的框架。env["warden"]是一个环境对象，用于验证

具体可看git，rubyChina上有相关帖子。

env['warden'].authenticate(:password) env['warden'].user # the user object