[Feature] Email collect message hooks (#331)

- Add email collect hook on creating conversation
- Merge contact if it already exist

spec/actions/contact_merge_action_spec.rb

@@ -9,9 +9,7 @@ describe ::ContactMergeAction do
 
   before do
     2.times.each { create(:conversation, contact: base_contact) }
-    2.times.each { create(:contact_inbox, contact: base_contact) }
     2.times.each { create(:conversation, contact: mergee_contact) }
-    2.times.each { create(:contact_inbox, contact: mergee_contact) }
   end
 
   describe '#perform' do

spec/builders/messages/incoming_message_builder_spec.rb

@@ -1,6 +1,6 @@
 require 'rails_helper'
 
-describe ::Messages::MessageBuilder do
+describe ::Messages::IncomingMessageBuilder do
   subject(:message_builder) { described_class.new(incoming_fb_text_message, facebook_channel.inbox).perform }
 
   let!(:facebook_channel) { create(:channel_facebook_page) }

spec/controllers/api/v1/widget/messages_controller_spec.rb

@@ -0,0 +1,84 @@
+require 'rails_helper'
+
+RSpec.describe '/api/v1/widget/messages', type: :request do
+  let(:account) { create(:account) }
+  let(:web_widget) { create(:channel_widget, account: account) }
+  let(:contact) { create(:contact, account: account) }
+  let(:contact_inbox) { create(:contact_inbox, contact: contact, inbox: web_widget.inbox) }
+  let(:conversation) { create(:conversation, contact: contact, account: account, inbox: web_widget.inbox, contact_inbox: contact_inbox) }
+  let(:payload) { { source_id: contact_inbox.source_id, inbox_id: web_widget.inbox.id } }
+  let(:token) { ::Widget::TokenService.new(payload: payload).generate_token }
+
+  before do
+    2.times.each { create(:message, account: account, inbox: web_widget.inbox, conversation: conversation) }
+  end
+
+  describe 'GET /api/v1/widget/messages' do
+    context 'when get request is made' do
+      it 'returns messages in conversation' do
+        get api_v1_widget_messages_url,
+            params: { website_token: web_widget.website_token },
+            headers: { 'X-Auth-Token' => token },
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        json_response = JSON.parse(response.body)
+
+        # 2 messages created + 3 messages by the template hook
+        expect(json_response.length).to eq(5)
+      end
+    end
+  end
+
+  describe 'POST /api/v1/widget/messages' do
+    context 'when post request is made' do
+      it 'creates message in conversation' do
+        message_params = { content: 'hello world' }
+        post api_v1_widget_messages_url,
+             params: { website_token: web_widget.website_token, message: message_params },
+             headers: { 'X-Auth-Token' => token },
+             as: :json
+
+        expect(response).to have_http_status(:success)
+        json_response = JSON.parse(response.body)
+        expect(json_response['content']).to eq(message_params[:content])
+      end
+    end
+  end
+
+  describe 'PUT /api/v1/widget/messages' do
+    context 'when put request is made with non existing email' do
+      it 'updates message in conversation and creates a new contact' do
+        message = create(:message, account: account, inbox: web_widget.inbox, conversation: conversation)
+        email = Faker::Internet.email
+        contact_params = { email: email }
+        put api_v1_widget_message_url(message.id),
+            params: { website_token: web_widget.website_token, contact: contact_params },
+            headers: { 'X-Auth-Token' => token },
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        message.reload
+        expect(message.input_submitted_email).to eq(email)
+        expect(message.conversation.contact.email).to eq(email)
+      end
+    end
+
+    context 'when put request is made with existing email' do
+      it 'updates message in conversation and deletes the current contact' do
+        message = create(:message, account: account, inbox: web_widget.inbox, conversation: conversation)
+        email = Faker::Internet.email
+        create(:contact, account: account, email: email)
+        contact_params = { email: email }
+        put api_v1_widget_message_url(message.id),
+            params: { website_token: web_widget.website_token, contact: contact_params },
+            headers: { 'X-Auth-Token' => token },
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        message.reload
+        expect { contact.reload }.to raise_error(ActiveRecord::RecordNotFound)
+      end
+    end
+  end
+end

spec/controllers/widget_tests_controller_spec.rb

@@ -1,12 +1,14 @@
 require 'rails_helper'
 
-describe WidgetTestsController, type: :controller do
-  let(:channel_widget) { create(:channel_widget) }
+describe '/widget_tests', type: :request do
+  before do
+    create(:channel_widget)
+  end
 
-  describe '#index' do
+  describe 'GET /widget_tests' do
     it 'renders the page correctly' do
-      get :index
-      expect(response.status).to eq 200
+      get widget_tests_url
+      expect(response).to be_successful
     end
   end
 end

spec/controllers/widgets_controller_spec.rb

@@ -0,0 +1,17 @@
+require 'rails_helper'
+
+describe '/widget', type: :request do
+  let(:web_widget) { create(:channel_widget) }
+
+  describe 'GET /widget' do
+    it 'renders the page correctly when called with website_token' do
+      get widget_url(website_token: web_widget.website_token)
+      expect(response).to be_successful
+    end
+
+    it 'returns 404 when called with out website_token' do
+      get widget_url
+      expect(response.status).to eq(404)
+    end
+  end
+end

spec/factories/channel/channel_widget.rb

@@ -6,5 +6,8 @@ FactoryBot.define do
     sequence(:website_url) { |n| "https://example-#{n}.com" }
     sequence(:widget_color, &:to_s)
     account
+    after(:create) do |channel_widget|
+      create(:inbox, channel: channel_widget, account: channel_widget.account)
+    end
   end
 end

spec/factories/conversations.rb

@@ -16,6 +16,7 @@ FactoryBot.define do
         channel: create(:channel_widget, account: conversation.account)
       )
       conversation.contact ||= create(:contact, account: conversation.account)
+      conversation.contact_inbox ||= create(:contact_inbox, contact: conversation.contact, inbox: conversation.inbox)
     end
   end
 end

spec/factories/inboxes.rb

@@ -3,7 +3,11 @@
 FactoryBot.define do
   factory :inbox do
     account
-    name { 'Inbox' }
     channel { FactoryBot.build(:channel_widget, account: account) }
+    name { 'Inbox' }
+
+    after(:create) do |inbox|
+      inbox.channel.save!
+    end
   end
 end

spec/factories/messages.rb

@@ -5,9 +5,13 @@ FactoryBot.define do
     content { 'Message' }
     status { 'sent' }
     message_type { 'incoming' }
-    account
-    inbox
-    conversation
-    user
+    content_type { 'text' }
+    account { create(:account) }
+
+    after(:build) do |message|
+      message.user ||= create(:user, account: message.account)
+      message.conversation ||= create(:conversation, account: message.account)
+      message.inbox ||= create(:inbox, account: message.account)
+    end
   end
 end

spec/finders/message_finder_spec.rb

@@ -21,7 +21,7 @@ describe ::MessageFinder do
 
       it 'filter conversations by status' do
         result = message_finder.perform
-        expect(result.count).to be 4
+        expect(result.count).to be 7
       end
     end
 
@@ -30,7 +30,7 @@ describe ::MessageFinder do
 
       it 'filter conversations by status' do
         result = message_finder.perform
-        expect(result.count).to be 2
+        expect(result.count).to be 5
       end
     end
 
@@ -40,7 +40,7 @@ describe ::MessageFinder do
 
       it 'filter conversations by status' do
         result = message_finder.perform
-        expect(result.count).to be 4
+        expect(result.count).to be 7
       end
     end
   end

spec/models/conversation_spec.rb

@@ -57,19 +57,17 @@ RSpec.describe Conversation, type: :model do
       expect(Rails.configuration.dispatcher).to have_received(:dispatch)
         .with(described_class::ASSIGNEE_CHANGED, kind_of(Time), conversation: conversation)
 
-      # create_activity
-      expect(conversation.messages.pluck(:content)).to eq(
-        [
-          "Conversation was marked resolved by #{old_assignee.name}",
-          "Assigned to #{new_assignee.name} by #{old_assignee.name}"
-        ]
-      )
-
       # send_email_notification_to_assignee
       expect(AssignmentMailer).to have_received(:conversation_assigned).with(conversation, new_assignee)
 
       expect(assignment_mailer).to have_received(:deliver_later) if ENV.fetch('SMTP_ADDRESS', nil).present?
     end
+
+    it 'creates conversation activities' do
+      # create_activity
+      expect(conversation.messages.pluck(:content)).to include("Conversation was marked resolved by #{old_assignee.name}")
+      expect(conversation.messages.pluck(:content)).to include("Assigned to #{new_assignee.name} by #{old_assignee.name}")
+    end
   end
 
   describe '.after_create' do
@@ -169,7 +167,7 @@ RSpec.describe Conversation, type: :model do
     end
 
     it 'returns unread messages' do
-      expect(unread_messages).to contain_exactly(message)
+      expect(unread_messages).to include(message)
     end
   end
 

spec/models/message_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Message, type: :model do
+  context 'with validations' do
+    it { is_expected.to validate_presence_of(:inbox_id) }
+    it { is_expected.to validate_presence_of(:conversation_id) }
+    it { is_expected.to validate_presence_of(:account_id) }
+  end
+
+  context 'when message is created' do
+    let(:message) { build(:message) }
+
+    it 'triggers ::MessageTemplates::HookExecutionService' do
+      hook_execution_service = double
+      allow(::MessageTemplates::HookExecutionService).to receive(:new).and_return(hook_execution_service)
+      allow(hook_execution_service).to receive(:perform).and_return(true)
+
+      message.save!
+
+      expect(::MessageTemplates::HookExecutionService).to have_received(:new).with(message: message)
+      expect(hook_execution_service).to have_received(:perform)
+    end
+  end
+end

spec/services/facebook/send_reply_service_spec.rb

@@ -14,7 +14,8 @@ describe Facebook::SendReplyService do
   let!(:facebook_channel) { create(:facebook_page, account: account) }
   let!(:facebook_inbox) { create(:inbox, channel: facebook_channel, account: account) }
   let!(:contact) { create(:contact, account: account) }
-  let(:conversation) { create(:conversation, contact: contact, inbox: facebook_inbox) }
+  let(:contact_inbox) { create(:contact_inbox, contact: contact, inbox: facebook_inbox) }
+  let(:conversation) { create(:conversation, contact: contact, inbox: facebook_inbox, contact_inbox: contact_inbox) }
 
   describe '#perform' do
     context 'without reply' do
@@ -41,7 +42,6 @@ describe Facebook::SendReplyService do
 
     context 'with reply' do
       it 'if message is sent from chatwoot and is outgoing' do
-        create(:contact_inbox, contact: contact, inbox: facebook_inbox)
         create(:message, message_type: :incoming, inbox: facebook_inbox, account: account, conversation: conversation)
         create(:message, message_type: 'outgoing', inbox: facebook_inbox, account: account, conversation: conversation)
         expect(bot).to have_received(:deliver)

spec/services/message_templates/hook_execution_service_spec.rb

@@ -0,0 +1,20 @@
+require 'rails_helper'
+
+describe ::MessageTemplates::HookExecutionService do
+  context 'when it is a first message from web widget' do
+    it 'calls ::MessageTemplates::Template::EmailCollect' do
+      message = create(:message)
+      # this hook will only get executed for conversations with out any template messages
+      message.conversation.messages.template.destroy_all
+
+      email_collect_service = double
+      allow(::MessageTemplates::Template::EmailCollect).to receive(:new).and_return(email_collect_service)
+      allow(email_collect_service).to receive(:perform).and_return(true)
+
+      described_class.new(message: message).perform
+
+      expect(::MessageTemplates::Template::EmailCollect).to have_received(:new).with(conversation: message.conversation)
+      expect(email_collect_service).to have_received(:perform)
+    end
+  end
+end

spec/services/message_templates/template/email_collect_spec.rb

@@ -0,0 +1,12 @@
+require 'rails_helper'
+
+describe ::MessageTemplates::Template::EmailCollect do
+  context 'when this hook is called' do
+    let(:conversation) { create(:conversation) }
+
+    it 'creates the email collect messages' do
+      described_class.new(conversation: conversation).perform
+      expect(conversation.messages.count).to eq(3)
+    end
+  end
+end