Devise_OAuth2_Providable 技术文档

本文档旨在帮助用户安装、配置和使用 Devise_OAuth2_Providable 项目，该项目是一个为 Rails 应用程序提供 OAuth2 认证支持的 Rails3 引擎。

1. 安装指南

安装宝石

首先，确保您的项目中已经安装了 Devise 认证库。然后在您的 Gemfile 中添加以下代码：

gem 'devise_oauth2_providable'

接下来，运行以下命令来安装宝石：

$ bundle install

数据库迁移

安装宝石后，需要为 OAuth2 模型运行数据库迁移：

$ rake devise_oauth2_providable:install:migrations
$ rake db:migrate

添加 OAuth2 路由

在 config/routes.rb 文件中添加以下代码来配置 OAuth2 路由：

# config/routes.rb
Rails.application.routes.draw do
  mount Devise::Oauth2Providable::Engine => '/oauth2'
end

配置用户模型

确保您的用户模型支持 OAuth2 流程：

class User
  devise :oauth2_providable,
         :oauth2_password_grantable,
         :oauth2_refresh_token_grantable,
         :oauth2_authorization_code_grantable
end

(可选) 配置令牌过期设置

在 config/application.rb 文件中，您可以自定义令牌的过期时间：

# config/application.rb
config.devise_oauth2_providable.access_token_expires_in         = 1.second # 默认 15 分钟
config.devise_oauth2_providable.refresh_token_expires_in        = 1.minute # 默认 1 个月
config.devise_oauth2_providable.authorization_token_expires_in  = 5.seconds # 默认 1 分钟

2. 项目的使用说明

Devise_OAuth2_Providable 提供了以下 OAuth2 相关的模型：

• Client: 存储唯一的 client_id 和 client_secret。
• AccessToken: 用于后续请求的短期令牌，默认过期时间为 15 分钟。
• RefreshToken: 用于请求新访问令牌的长期令牌，默认过期时间为 1 个月。
• AuthorizationCode: 在用户完成授权流程后创建的非常短命的令牌，默认过期时间为 1 分钟。

3. 项目 API 使用文档

以下是与 OAuth2 相关的主要端点：

• /oauth2/authorize: 开始客户端授权流程的端点，支持授权码和隐式授权类型。
• /oauth2/token: 请求访问令牌的端点，支持不同的授权类型。

4. 项目安装方式

请遵循以下步骤来安装 Devise_OAuth2_Providable：

1. 将宝石添加到 Gemfile。
2. 运行 bundle install。
3. 运行数据库迁移。
4. 配置 OAuth2 路由。
5. 配置用户模型和令牌过期时间。

以上步骤将帮助您成功集成 Devise_OAuth2_Providable 到您的 Rails 应用程序中。