ActsAsMessageable 使用与技术文档

本文档旨在帮助用户详细了解和使用 ActsAsMessageable Ruby Gem，该 Gem 为 Rails 应用程序提供灵活且强大的消息系统，实现用户间的私信、对话、消息搜索等功能。

1. 安装指南

首先，将 ActsAsMessageable 添加到您的 Gemfile 中：

对于 Rails 3 及以上版本

gem 'acts-as-messageable'

对于 Rails 2 版本

使用这个 分支：

gem 'acts-as-messageable', :git => 'git://github.com/openfirmware/acts-as-messageable.git',
                           :branch => 'rails2.3.11_compatible'

然后执行以下命令安装：

bundle install

2. 项目使用说明

在模型中应用 acts_as_messageable 方法以启用消息功能。以下是如何在用户模型中实现：

class User < ActiveRecord::Base
  acts_as_messageable
end

您还可以自定义一些选项，例如：

class User < ActiveRecord::Base
  acts_as_messageable :table_name => "table_with_messages",
                      :required   => :body,
                      :class_name => "CustomMessages",
                      :dependent  => :destroy,
                      :group_messages => true,
                      :search_scope => :custom_search
end

3. 项目API使用文档

发送消息

@alice = User.first
@bob   = User.last

@alice.send_message(@bob, "Message topic", "Hi bob!")
@bob.send_message(@alice, "Re: Message topic", "Hi alice!")

使用哈希发送消息：

@alice.send_message(@bob, { :body => "Hash body", :topic => "Hash topic" })

自定义必填验证

在用户模型中定义：

class User < ActiveRecord::Base
  acts_as_messageable :required => :body
end

获取对话

@message = @alice.send_message(@bob, "Hello bob!", "How are you?")
@reply_message = @bob.reply_to(@message, "Re: Hello bob!", "I'm fine!")

@alice.received_messages.conversations # => [@reply_message]

搜索消息

records = @alice.messages.search("Search me")

查看收件箱、发件箱和垃圾箱

@alice.received_messages # 收件箱
@alice.sent_messages     # 发件箱
@alice.deleted_messages  # 垃圾箱

读取和删除消息

@message.read           # 读取消息
@message.mark_as_read   # 标记为已读

@message.delete         # 删除消息
@alice.delete_message(@message) # 删除特定消息

恢复消息

@alice.restore_message(@message) # 从垃圾箱恢复消息

启用群消息

class User
  acts_as_messageable :group_messages => true
end

加入其他用户的对话

@message = @alice.send_message(@bob, :topic => "Hello bob!", :body => "What's up?")
@reply_message = @sukhi.reply_to(@message, "Hi there!", "I would like to join this conversation!")

获取对话中的人员

@message.people # => [@alice, @bob, @sukhi]

4. 项目安装方式

根据您的 Rails 版本，安装方式略有不同。首先，将 Gem 添加到 Gemfile 中，然后执行以下迁移命令：

rails g acts_as_messageable:migration [messages] [--uuid]
rake db:migrate

根据需要选择是否启用 UUID 支持。以上步骤将为您的应用程序创建消息表，并准备好使用 ActsAsMessageable。