Gabriel Grubba 3f8b67d1c1
Feature: add chat integration reference post (#216)
* FEATURE: Add chat integration reference post

This class works similar to a post but it is not a post.

* DEV: change how `excerpt` method works

* feature: Add `send_chat_integration_message` scriptable

add `send_chat_integration_message` scriptable that uses the rules to send a message to the chat provider
add locale strings for the new scriptable
update `ChatIntegrationReferencePost` `excerpt` method
add tests for `ChatIntegrationReferencePost`

* DEV: Add `get_channel_by_name` to every provider

This makes using `trigger_notification` easier with every provider as well.

* DEV: Add `get_channel_name` to all providers

This method gets the name of the channel based on how the provider identifies it.
Updates channel_name in locales yaml
Adds migrate_tag_added_filter_to_all_providers.rb to move all existing rules to use Automation

* DEV: Add removal of old migration data

Update small action locales with strings from core

* DEV: solve review comments

* DEV: update test locale strings

* DEV: remove empty line to trigger lint

* DEV: lint applied

* DEV: Add tests for automation integration

* DEV: add rails logger for when automatio error occurs

* DEV: move migration to be SQL only

Update provider helper to use hashes instead of dot notation

* DEV: update migration with correct table names

* DEV: Update migrate_tag_added_filter_to_all_providers to use smaller SQL queries

Commented out migrate_tag_added_from_filter_to_automation.rb

* DEV: update comments in migration file

* DEV: update indentation in client.en.yml

* DEV: update with review comments

* Update spec/lib/discourse_chat_integration/chat_integration_reference_post_spec.rb

Co-authored-by: Jarek Radosz <jradosz@gmail.com>

* Update spec/lib/discourse_chat_integration/chat_integration_reference_post_spec.rb

Co-authored-by: Jarek Radosz <jradosz@gmail.com>

* Update spec/lib/discourse_chat_integration/chat_integration_reference_post_spec.rb

Co-authored-by: Jarek Radosz <jradosz@gmail.com>

* Update spec/integration/automation_spec.rb

Co-authored-by: Jarek Radosz <jradosz@gmail.com>

* Update lib/discourse_chat_integration/chat_integration_reference_post.rb

Co-authored-by: Jarek Radosz <jradosz@gmail.com>

* DEV: update specs with review comments

* DEV: update typos in tests

* DEV: inlined functions for getting channel name for provider in migration

---------

Co-authored-by: Jarek Radosz <jradosz@gmail.com>
2024-09-11 10:42:52 -03:00

96 lines
3.5 KiB
Ruby

# frozen_string_literal: true
module DiscourseChatIntegration::Provider::GroupmeProvider
PROVIDER_NAME = "groupme".freeze
PROVIDER_ENABLED_SETTING = :chat_integration_groupme_enabled
CHANNEL_IDENTIFIER_KEY = "groupme_instance_name".freeze
CHANNEL_PARAMETERS = [{ key: "groupme_instance_name", regex: '[\s\S]*', unique: true }]
def self.generate_groupme_message(post)
display_name = ::DiscourseChatIntegration::Helper.formatted_display_name(post.user)
topic = post.topic
category = ""
if topic.category&.uncategorized?
category = "#{I18n.t("uncategorized_category_name")}"
elsif topic.category
category =
(
if (topic.category.parent_category)
"#{topic.category.parent_category.name}/#{topic.category.name}"
else
"#{topic.category.name}"
end
)
end
pre_post_text =
"#{display_name} Posted to #{SiteSetting.title}\n\nTopic: #{topic.title} [#{category}]"
read_more = "(Read More: #{post.full_url})"
post_excerpt =
"#{post.excerpt(SiteSetting.chat_integration_groupme_excerpt_length, text_entities: true, strip_links: true, remap_emoji: true)}"
data = { text: "#{pre_post_text}\n\n#{post_excerpt}\n#{read_more}" }
data
end
def self.send_via_webhook(message, channel)
# loop through all the bot IDs
last_error_raised = nil
num_errors = 0
# split on commas, but remove leading/trailing spaces
bot_ids = SiteSetting.chat_integration_groupme_bot_ids.split(/\s*,\s*/)
instance_names = SiteSetting.chat_integration_groupme_instance_names.split(/\s*,\s*/)
unless instance_names.length() == bot_ids.length()
instance_names =
[I18n.t("chat_integration.provider.groupme.errors.instance_names_issue")] * bot_ids.length()
end
name_to_id = Hash[instance_names.zip(bot_ids)]
user_input_channel = channel.data["groupme_instance_name"].strip
instance_names = [user_input_channel] unless user_input_channel.eql? "all"
instance_names.each do |instance_name|
bot_id = name_to_id["#{instance_name}"]
uri = URI("https://api.groupme.com/v3/bots/post")
http = FinalDestination::HTTP.new(uri.host, uri.port)
http.use_ssl = (uri.scheme == "https")
req = Net::HTTP::Post.new(uri, "Content-Type" => "application/json")
message[:bot_id] = bot_id
req.body = message.to_json
response = http.request(req)
unless response.kind_of? Net::HTTPSuccess
num_errors += 1
if response.code.to_s == "404"
error_key = "chat_integration.provider.groupme.errors.not_found"
else
error_key = nil
end
last_error_raised = {
error_key: error_key,
groupme_name: instance_name,
bot_id: bot_id,
request: req.body,
response_code: response.code,
response_body: response.body,
}
end
end
if last_error_raised
successfully_sent = instance_names.length() - num_errors
last_error_raised[:success_rate] = "#{successfully_sent}/#{instance_names.length()}"
raise ::DiscourseChatIntegration::ProviderError.new info: last_error_raised
end
end
def self.trigger_notification(post, channel, rule)
data_package = generate_groupme_message(post)
self.send_via_webhook(data_package, channel)
end
def self.get_channel_by_name(name)
DiscourseChatIntegration::Channel
.with_provider(PROVIDER_NAME)
.with_data_value(CHANNEL_IDENTIFIER_KEY, name)
.first
end
end