OmniAuth::Identity 技术文档

1. 安装指南

要获取 RubyGems 上的最新版本并将此 gem 添加到您的 Gemfile，请运行以下命令：

bundle add omniauth-identity

如果 git 仓库中有尚未正式发布的最新提交，只需指定仓库地址即可：

gem "omniauth-identity", git: "https://github.com/omniauth/omniauth-identity.git"

2. 项目的使用说明

OmniAuth::Identity gem 为应用程序提供了一种使用传统的用户名/密码基于身份验证系统的方式，无需放弃 OmniAuth 提供的简单身份验证流程。Identity 旨在尽可能保持无特性状态：它提供用户管理的基本结构，然后不再干预。

在 Rails 中，您像使用其他 OmniAuth 提供商一样使用 omniauth-identity：作为 Rack 中间件。在 Rails 的初始化文件中（如 config/initializers/omniauth.rb），基本的电子邮件/密码身份验证设置可能如下所示：

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :identity, fields: [:email, :password], timeout: 5000
end

3. 项目API使用文档

OmniAuth::Identity 通过 OmniAuth middleware 提供了一个简单的 API，以支持基于用户名和密码的身份验证。当用户尝试通过提供邮箱和密码进行认证时，OmniAuth 会调用相应的 provider，并在成功时返回一个包含用户信息的散列表。

以下是一个基本的 OmniAuth 身份认证流程：

• 用户在表单中输入邮箱和密码。
• 表单提交到 OmniAuth middleware。
• 如果认证成功，OmniAuth 将返回一个散列表，其中包含了用户的基本信息。
• 这些信息可以用于创建或更新用户记录，并管理用户的会话。

4. 项目安装方式

请遵循以下步骤安装 OmniAuth::Identity：

• 将 gem 添加到您的 Gemfile 文件中。
• 运行 bundle install 命令安装 gem。
• 根据 Rails 应用程序的配置，在 config/initializers/omniauth.rb 文件中配置 OmniAuth middleware。

通过以上步骤，您可以在您的 Rails 应用程序中顺利集成 OmniAuth::Identity 进行用户身份验证。