Adauth 技术文档

1. 安装指南

首先，将 Adauth gem 添加到您的 Gemfile 文件中：

gem 'adauth'

然后，运行以下命令安装 gem：

bundle install

2. 项目的使用说明

在 Rails 中使用

首先，运行以下命令生成配置文件：

rails g adauth:config

然后在 _config/initializers/adauth.rb_ 文件中填写配置值。

将模型与 Adauth 关联

如果您希望将用户模型与 Adauth 关联，可以使用以下代码：

class User < ActiveRecord::Base
  include Adauth::Rails::ModelBridge

  AdauthMappings = {
    :login => :login,
    :group_strings => :cn_groups
  }

  AdauthSearchField = [:login, :login]
end

这样，当您调用 User.create_from_adauth(adauth_model) 时，它会执行以下操作：

u = User.new
u.login = adauth_model.login
u.group_strings = adauth_model.cn_groups
u.save

这对于任何模型以及您通过 adauth 获取的任何内容都适用。

SessionsController

您可以通过运行以下命令来使用预制的 sessions 控制器：

rails g adauth:sessions

这会添加一些路由、一个 sessions 控制器和一个登录表单。要登录，请访问 /sessions/new 并填写表单，然后提交到 /adauth。如果成功，您将被重定向回 root_path。

在脚本中使用

在脚本或其他程序中使用 Adauth，只需在脚本的开始处调用 Adauth.configure，配置完成后，可以在程序的任何地方像在 Rails 中一样使用 Adauth。

3. 项目 API 使用文档

Adauth 的配置选项详细说明可以在项目的 wiki 中找到。

4. 项目安装方式

Adauth 的安装方式已在上述“安装指南”部分中详细说明。

---

请注意，本技术文档使用 Markdown 格式编写，且不包含任何链接。