Declarative Authorization 技术文档

1. 安装指南

1.1 环境要求

• Ruby on Rails：支持 Rails 4，并提供对 Rails 2 的向后兼容。
• 认证机制：需要一个认证机制，确保在 Controller#current_user 中存在 User 对象，并且在模型安全中设置 Authorization.current_user。
• User 模型：User 对象需要响应 :role_symbols 方法，该方法返回一个角色符号数组。

1.2 安装步骤

1. 添加 Gem：在项目的 Gemfile 中添加 declarative_authorization 依赖：

   gem 'declarative_authorization'
   

2. 安装 Gem：运行以下命令安装并打包 Gem：

   $ bundle
   

3. 运行安装器：使用以下命令运行安装器，创建 Role 模型并设置用户与角色的关系：

   $ rails g authorization:install [UserModel=User] [field:type field:type ...] [--create-user --commit --user-belongs-to-role]
   

   • UserModel=User：指定用户模型，默认为 User。
   • --create-user：创建带有指定字段的用户模型。
   • --commit：运行 rake db:migrate 和 rake db:seed。
   • --user-belongs-to-role：设置用户与角色的一对多关系。

4. 生成授权规则：运行以下命令生成默认的授权规则：

   $ rails g authorization:rules
   

2. 项目的使用说明

2.1 控制器授权

• RESTful 控制器：在 RESTful 控制器中，使用 filter_resource_access 方法进行授权：

  class MyRestfulController < ApplicationController
    filter_resource_access
    ...
  end
  

• 非 RESTful 控制器：在非 RESTful 控制器中，使用 filter_access_to 方法进行授权：

  class MyOtherController < ApplicationController
    filter_access_to :all
    ...
  end
  

2.2 视图授权

• 视图中的授权检查：使用 permitted_to? 方法检查当前用户是否有权限执行特定操作：

  <%= link_to 'Edit Post', edit_post_path(@post) if permitted_to? :update, @post %>
  

3. 项目 API 使用文档

3.1 控制器授权 API

• filter_resource_access：用于 RESTful 控制器的授权，自动设置实例变量并调用 filter_access_to 进行授权。
• filter_access_to：用于非 RESTful 控制器的授权，可以指定需要授权的动作。

3.2 视图授权 API

• permitted_to?：用于在视图中检查当前用户是否有权限执行特定操作。

4. 项目安装方式

4.1 通过 Gemfile 安装

在项目的 Gemfile 中添加 declarative_authorization 依赖，并运行 bundle 命令进行安装。

4.2 使用安装器

通过运行 rails g authorization:install 命令，自动生成 Role 模型并设置用户与角色的关系。

4.3 生成授权规则

通过运行 rails g authorization:rules 命令，生成默认的授权规则文件 config/authorization_rules.rb。

---

通过以上步骤，您可以成功安装并使用 Declarative Authorization 插件，实现基于角色的授权管理。