Authlogic 项目技术文档

1. 安装指南

1.1 安装依赖

首先，确保你已经安装了 Ruby 和 Rails。然后，在你的 Rails 项目的 Gemfile 中添加以下内容：

gem 'authlogic'

接着，运行以下命令来安装依赖：

bundle install

1.2 生成迁移文件

为了使用 Authlogic，你需要创建一个 users 表。你可以使用以下迁移文件来创建该表：

class CreateUser < ActiveRecord::Migration
  def change
    create_table :users do |t|
      t.string :email
      t.index :email, unique: true
      t.string :login
      t.string :crypted_password
      t.string :password_salt
      t.string :persistence_token
      t.index :persistence_token, unique: true
      t.string :single_access_token
      t.index :single_access_token, unique: true
      t.string :perishable_token
      t.index :perishable_token, unique: true
      t.integer :login_count, default: 0, null: false
      t.integer :failed_login_count, default: 0, null: false
      t.datetime :last_request_at
      t.datetime :current_login_at
      t.datetime :last_login_at
      t.string :current_login_ip
      t.string :last_login_ip
      t.boolean :active, default: false
      t.boolean :approved, default: false
      t.boolean :confirmed, default: false
      t.timestamps
    end
  end
end

运行以下命令来执行迁移：

rails db:migrate

2. 项目的使用说明

2.1 创建用户模型

在 app/models/user.rb 中创建 User 模型，并添加 acts_as_authentic 方法：

class User < ApplicationRecord
  acts_as_authentic

  validates :email,
    format: { with: /@/, message: "should look like an email address." },
    length: { maximum: 100 },
    uniqueness: { case_sensitive: false, if: :will_save_change_to_email? }

  validates :login,
    format: { with: /\A[a-z0-9]+\z/, message: "should use only letters and numbers." },
    length: { within: 3..100 },
    uniqueness: { case_sensitive: false, if: :will_save_change_to_login? }

  validates :password,
    confirmation: { if: :require_password? },
    length: { minimum: 8, if: :require_password? }
  validates :password_confirmation,
    length: { minimum: 8, if: :require_password? }
end

2.2 创建用户会话模型

在 app/models/user_session.rb 中创建 UserSession 模型：

class UserSession < Authlogic::Session::Base
end

2.3 创建控制器

在 app/controllers/user_sessions_controller.rb 中创建 UserSessionsController：

class UserSessionsController < ApplicationController
  def new
    @user_session = UserSession.new
  end

  def create
    @user_session = UserSession.new(user_session_params.to_h)
    if @user_session.save
      redirect_to root_url
    else
      render :new, status: 422
    end
  end

  def destroy
    current_user_session.destroy
    redirect_to new_user_session_url
  end

  private

  def user_session_params
    params.require(:user_session).permit(:login, :password, :remember_me)
  end
end

2.4 配置路由

在 config/routes.rb 中添加以下路由：

Rails.application.routes.draw do
  resources :users
  resource :user_session
end

2.5 添加辅助方法

在 app/controllers/application_controller.rb 中添加辅助方法：

class ApplicationController < ActionController::Base
  helper_method :current_user_session, :current_user

  private
    def current_user_session
      return @current_user_session if defined?(@current_user_session)
      @current_user_session = UserSession.find
    end

    def current_user
      return @current_user if defined?(@current_user)
      @current_user = current_user_session && current_user_session.user
    end
end

3. 项目API使用文档

3.1 创建会话

你可以通过以下方式创建一个用户会话：

UserSession.create(:login => "bjohnson", :password => "my password", :remember_me => true)

或者：

session = UserSession.new(:login => "bjohnson", :password => "my password", :remember_me => true)
session.save

3.2 销毁会话

你可以通过以下方式销毁一个用户会话：

session.destroy

3.3 查找会话

你可以通过以下方式查找当前的用户会话：

session = UserSession.find

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Gemfile 中添加以下内容：

gem 'authlogic'

然后运行：

bundle install

4.2 手动安装

你也可以通过以下命令手动安装：

gem install authlogic

安装完成后，在你的 Rails 项目中引入 authlogic：

require 'authlogic'

通过以上步骤，你已经成功安装并配置了 Authlogic，可以开始在你的 Rails 项目中使用它进行用户认证。