Chore: Routine Bugfixes and enhancements (#979)

- Fix slack scopes
- Docs for authentication
Fixes: #704 , #973

app/services/base/send_on_channel_service.rb

@@ -0,0 +1,55 @@
+#######################################
+# To create an external channel reply service
+# - Inherit this as the base class.
+# - Implement `channel_class` method in your child class.
+# - Implement `perform_reply` method in your child class.
+# - Implement additional custom logic for your `perform_reply` method.
+# - When required override the validation_methods.
+# - Use Childclass.new.perform.
+######################################
+class Base::SendOnChannelService
+  pattr_initialize [:message!]
+
+  def perform
+    validate_target_channel
+    return unless outgoing_message?
+    return if invalid_message?
+
+    perform_reply
+  end
+
+  private
+
+  delegate :conversation, to: :message
+  delegate :contact, :contact_inbox, :inbox, to: :conversation
+  delegate :channel, to: :inbox
+
+  def channel_class
+    raise 'Overwrite this method in child class'
+  end
+
+  def perform_reply
+    raise 'Overwrite this method in child class'
+  end
+
+  def outgoing_message_originated_from_channel?
+    # TODO: we need to refactor this logic as more integrations comes by
+    # chatwoot messages won't have source id at the moment
+    # outgoing messages may be created in slack which should be send to the channel
+    message.source_id.present? && !message.source_id.starts_with?('slack_')
+  end
+
+  def outgoing_message?
+    message.outgoing? || message.template?
+  end
+
+  def invalid_message?
+    # private notes aren't send to the channels
+    # we should also avoid the case of message loops, when outgoing messages are created from channel
+    message.private? || outgoing_message_originated_from_channel?
+  end
+
+  def validate_target_channel
+    raise 'Invalid channel service was called' if inbox.channel.class != channel_class
+  end
+end

app/services/facebook/send_on_facebook_service.rb

@@ -1,37 +1,14 @@
-class Facebook::SendReplyService
-  pattr_initialize [:message!]
-
-  def perform
-    return if message.private
-    return if inbox.channel.class.to_s != 'Channel::FacebookPage'
-    return unless outgoing_message_from_chatwoot?
-
-    FacebookBot::Bot.deliver(delivery_params, access_token: message.channel_token)
-  end
-
+class Facebook::SendOnFacebookService < Base::SendOnChannelService
   private
 
-  delegate :contact, to: :conversation
-
-  def inbox
-    @inbox ||= message.inbox
+  def channel_class
+    Channel::FacebookPage
   end
 
-  def conversation
-    @conversation ||= message.conversation
+  def perform_reply
+    FacebookBot::Bot.deliver(delivery_params, access_token: message.channel_token)
   end
 
-  def outgoing_message_from_chatwoot?
-    # messages sent directly from chatwoot won't have source_id.
-    (message.outgoing? || message.template?) && !message.source_id
-  end
-
-  # def reopen_lock
-  #   if message.incoming? && conversation.locked?
-  #     conversation.unlock!
-  #   end
-  # end
-
   def fb_text_message_params
     {
       recipient: { id: contact.get_source_id(inbox.id) },

app/services/twilio/send_on_twilio_service.rb

@@ -1,22 +1,15 @@
-class Twilio::OutgoingMessageService
-  pattr_initialize [:message!]
+class Twilio::SendOnTwilioService < Base::SendOnChannelService
+  private
 
-  def perform
-    return if message.private
-    return if message.source_id
-    return if inbox.channel.class.to_s != 'Channel::TwilioSms'
-    return unless outgoing_message?
+  def channel_class
+    Channel::TwilioSms
+  end
 
+  def perform_reply
     twilio_message = client.messages.create(message_params)
     message.update!(source_id: twilio_message.sid)
   end
 
-  private
-
-  delegate :conversation, to: :message
-  delegate :contact, to: :conversation
-  delegate :contact_inbox, to: :conversation
-
   def message_params
     params = {
       body: message.content,

app/services/twitter/send_on_twitter_service.rb

@@ -1,16 +1,17 @@
-class Twitter::SendReplyService
+class Twitter::SendOnTwitterService < Base::SendOnChannelService
   pattr_initialize [:message!]
 
-  def perform
-    return if message.private
-    return if message.source_id
-    return if inbox.channel.class.to_s != 'Channel::TwitterProfile'
-    return unless outgoing_message_from_chatwoot?
+  private
 
-    send_reply
+  delegate :additional_attributes, to: :contact
+
+  def channel_class
+    Channel::TwitterProfile
   end
 
-  private
+  def perform_reply
+    conversation_type == 'tweet' ? send_tweet_reply : send_direct_message
+  end
 
   def twitter_client
     Twitty::Facade.new do |config|
@@ -50,19 +51,4 @@ class Twitter::SendReplyService
       Rails.logger.info 'TWITTER_TWEET_REPLY_ERROR' + response.body
     end
   end
-
-  def send_reply
-    conversation_type == 'tweet' ? send_tweet_reply : send_direct_message
-  end
-
-  def outgoing_message_from_chatwoot?
-    (message.outgoing? || message.template?)
-  end
-
-  delegate :additional_attributes, to: :contact
-  delegate :contact, to: :conversation
-  delegate :contact_inbox, to: :conversation
-  delegate :conversation, to: :message
-  delegate :inbox, to: :conversation
-  delegate :channel, to: :inbox
 end