Rubyで書いた自作プラグインのインストール方法

開発
1

CSV ファイルに Discourse ユーザーのメールアドレスがあります。毎日実行され、特定のユーザー セットに特定のメール テンプレートを送信するスクリプトを作成する必要があります。その後、毎日、次のユーザー セットでこのスクリプトを実行する必要があります。どうすればよいですか？

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

Developing Discourse Plugins - Part 1 - Create a basic pluginから始めるのが良いでしょう。

「いいね！」 8
3

それを試しましたが、非常にシンプルです。しかし残念ながら、私には機能しません。

同じソリューションを 2 つの異なるアプリでテストしました。使用した 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）も確認しましたが、プラグインがコピーされていないようです。それが問題の一部かもしれません。

この 2 回目のテストでは、次も試しました。

./launcher rebuild app --clean

および

./launcher restart app

実行中のバージョンは次のとおりです。
3.4.0.beta4-dev
(9f41ce7fce)

「いいね！」 1
4

プラグインをGitHubリポジトリに入れましたか？

plugin.rb を /lib に置くだけではいけません。plugins フォルダに入れる必要があります。本番環境では、セルフホストサイトにプラグインをインストールする で説明されているように、GitHub経由で追加する必要があります。

はい。そこになければ、存在しません。

それらのプラグイントピックをすべて読むことを強くお勧めします。また、開発環境でテストを行うこともお勧めします。

「いいね！」 4