Simple Private Messages 项目技术文档

1. 安装指南

1.1 环境要求

• Ruby on Rails 3 或以上版本（Rails 2.3.x 用户请使用相应分支）
• Bundler

1.2 安装步骤

1. 在 Gemfile 中添加以下内容：

   gem 'simple-private-messages', '0.0.0', :git => 'git://github.com/jongilbraith/simple-private-messages.git'
   

2. 运行以下命令安装 gem：

   bundle install
   

3. 生成私有消息模型，传递两个参数：消息模型的名称和用户模型的名称。例如：

   rails generate simple_private_messages:model User Message
   

4. 在包含消息的模型中添加以下内容：

   has_private_messages
   

   如果使用了非默认的模型名称，需要传递正确的类名，例如：

   has_private_messages :class_name => 'CustomMessage'
   

2. 项目的使用说明

2.1 创建/发送消息

frank = User.find_by_login("frank")
george = User.find_by_login("george")

message = Message.new
message.subject = "Happy Festivus, son"
message.body = "It's time for the Feats of Strength."
message.sender = frank
message.recipient = george
message.save

2.2 阅读消息

message = Message.read_message(id, user)

该方法返回指定 ID 的消息，并确保传入的用户是发送者或接收者。如果消息未读且用户是接收者，则标记为已读。

检查消息是否已读：

message.message_read?

2.3 获取用户接收的消息

newman = User.find_by_login("newman")
newman.received_messages

获取未读消息数量：

newman.unread_message_count

检查是否有未读消息：

newman.unread_messages?

2.4 获取用户发送的消息

newman = User.find_by_login("newman")
newman.sent_messages

2.5 自定义查询

newman.sent_messages.find(:all,
                          :conditions => ["read_at < ?", 2.days.ago],
                          :limit => 20,
                          :order => "created_at ASC")

2.6 删除消息

newman = User.find_by_login("newman")
message = newman.received_messages.find(3)
message.mark_deleted(newman)

该方法会根据用户是发送者还是接收者来标记消息为已删除。如果发送者和接收者都删除了消息，消息将被销毁。

3. 项目API使用文档

3.1 创建消息

• 方法: Message.new
• 参数:
  • subject: 消息主题
  • body: 消息内容
  • sender: 发送者
  • recipient: 接收者
• 返回值: 新创建的消息对象

3.2 阅读消息

• 方法: Message.read_message(id, user)
• 参数:
  • id: 消息ID
  • user: 用户对象
• 返回值: 消息对象

3.3 检查消息是否已读

• 方法: message.message_read?
• 返回值: true 或 false

3.4 获取用户接收的消息

• 方法: user.received_messages
• 返回值: 用户接收的消息列表

3.5 获取用户发送的消息

• 方法: user.sent_messages
• 返回值: 用户发送的消息列表

3.6 删除消息

• 方法: message.mark_deleted(user)
• 参数:
  • user: 用户对象
• 返回值: 无

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Gemfile 中添加以下内容：

gem 'simple-private-messages', '0.0.0', :git => 'git://github.com/jongilbraith/simple-private-messages.git'

然后运行：

bundle install

4.2 生成模型

运行以下命令生成私有消息模型：

rails generate simple_private_messages:model User Message

4.3 配置模型

在包含消息的模型中添加：

has_private_messages

如果使用了非默认的模型名称，需要传递正确的类名。

4.4 生成控制器和视图

运行以下命令生成控制器和视图：

rails generate simple_private_messages:scaffold User Message

通过以上步骤，您可以成功安装并使用 Simple Private Messages 插件。