我如何安装自己用 Ruby 编写的插件？

开发
1

我有一个包含 discourse 用户电子邮件的 CSV 文件。我需要创建一个每天运行的脚本，向特定用户发送特定的电子邮件模板。然后，我需要每天使用下一组用户运行此脚本。我该怎么做？

根据 https://ask.discourse.com/，我需要创建代码来自动化此过程，并将代码和数据放在*plugins*文件夹中。代码建议如下：

# frozen_string_literal: true
# name: auto-email
# about: A custom plugin to send bulk emails using automation and CSV files
# version: 0.3

require 'csv'

after_initialize do
  if defined?(DiscourseAutomation)
    # Define a unique scriptable for the automation
    DiscourseAutomation::Scriptable::AUTO_EMAIL_SCRIPT = "auto_email_script"

    add_automation_scriptable(DiscourseAutomation::Scriptable::AUTO_EMAIL_SCRIPT) do
      # Define fields for the automations UI:
      field :email_template, component: :message # Email body to be sent
      field :csv_file_name, component: :text # Name of CSV file in the "data" folder

      script do |context, fields, automation|
        # Define the path to the data folder
        data_folder_path = Rails.root.join("plugins", "auto-email", "data")

        # Get the CSV file name from the admin automation field
        csv_file_name = fields["csv_file_name"]["value"]
        csv_file_path = File.join(data_folder_path, csv_file_name)

        # Ensure the file exists
        unless File.exist?(csv_file_path)
          Rails.logger.warn("CSV file #{csv_file_path} not found!")
          next
        end

        # Parse the CSV file
        begin
          users = CSV.read(csv_file_path, headers: true).map(&:to_hash)
        rescue StandardError => e
          Rails.logger.error("Error reading CSV file (#{csv_file_name}): #{e.message}")
          next
        end

        # Get the email message content from the automation field
        email_body = fields["email_template"]["value"]

        # Iterate through users from the CSV and send emails
        users.each do |user_data|
          email = user_data["email"] || user_data["normalized_email"]
          user = User.find_by_email(email)
          
          if user
            begin
              # Send an automated email using SystemMessage
              SystemMessage.new(user).send_email(
                "custom_email_template", # Ensure this email template exists
                message_body: email_body
              )
              Rails.logger.info("Email sent to: #{email}")
            rescue StandardError => e
              Rails.logger.error("Failed to send email to #{email}: #{e.message}")
            end
          else
            Rails.logger.warn("No user found with email: #{email}")
          end
        end
      end
    end
  end
end

我的插件结构如下：
/var/discourse/plugins/auto-email/
├── README.rb
├── data/
├── mamapedia_users_data_01.csv
├── lib/
├── plugin.rb

但是，当我重启或重建应用程序时，在管理面板中看不到新插件。日志中也没有任何错误。

我哪里做错了？我还需要做些什么？

4 个赞
2

我将从开发 Discourse 插件 - 第 1 部分 - 创建一个基本插件开始。

8 个赞
3

我试过那个了，很简单。但不幸的是，它对我不起作用。

我在两个不同的应用程序中测试了相同的解决方案。这是我使用的 plugin.rb 文件：

# name: auto-email
# about: A super simple plugin to demonstrate how plugins work
# version: 0.0.1
# authors: Xavier Garzon

我还检查了容器中的插件文件夹（/var/www/discourse/plugins），似乎我的插件没有被复制。也许这是问题的一部分。

对于第二个测试，我也尝试了：

./launcher rebuild app --clean

和

./launcher restart app

这是我正在运行的版本：
3.4.0.beta4-dev
(9f41ce7fce)

1 个赞
4

你的插件放在 GitHub 仓库了吗？

你不能只是把 plugin.rb 放在 /lib 目录下，它必须放在 plugins 目录下，并且在生产环境中，你需要按照 在自托管站点上安装插件 中的说明通过 GitHub 添加它。

是的。如果不在那里，它就不存在。

你真的应该阅读所有这些插件主题。你也应该在开发环境中进行测试。

4 个赞