Feature: Api to toggle typing status on a conversation (#807)

- api to toggle typing status on a conversation
- clients receive webhook events on the same

Addresses: #718 , #719 , #775

spec/controllers/api/v1/accounts/conversations_controller_spec.rb

@@ -122,6 +122,34 @@ RSpec.describe 'Conversations API', type: :request do
     end
   end
 
+  describe 'POST /api/v1/accounts/{account.id}/conversations/:id/toggle_typing_status' do
+    let(:conversation) { create(:conversation, account: account) }
+
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        post "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/toggle_typing_status"
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated user' do
+      let(:agent) { create(:user, account: account, role: :agent) }
+
+      it 'toggles the conversation status' do
+        allow(Rails.configuration.dispatcher).to receive(:dispatch)
+        post "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/toggle_typing_status",
+             headers: agent.create_new_auth_token,
+             params: { typing_status: 'on' },
+             as: :json
+
+        expect(response).to have_http_status(:success)
+        expect(Rails.configuration.dispatcher).to have_received(:dispatch)
+          .with(Conversation::CONVERSATION_TYPING_ON, kind_of(Time), { conversation: conversation, user: agent })
+      end
+    end
+  end
+
   describe 'POST /api/v1/accounts/{account.id}/conversations/:id/update_last_seen' do
     let(:conversation) { create(:conversation, account: account) }
 

spec/listeners/action_cable_listener_spec.rb

@@ -29,4 +29,36 @@ describe ActionCableListener do
       listener.message_created(event)
     end
   end
+
+  describe '#typing_on' do
+    let(:event_name) { :'conversation.typing_on' }
+    let!(:event) { Events::Base.new(event_name, Time.zone.now, conversation: conversation, user: agent) }
+
+    it 'sends message to account admins, inbox agents and the contact' do
+      # HACK: to reload conversation inbox members
+      expect(conversation.inbox.reload.inbox_members.count).to eq(1)
+      expect(ActionCableBroadcastJob).to receive(:perform_later).with(
+        [agent.pubsub_token, admin.pubsub_token, conversation.contact.pubsub_token],
+        'conversation.typing_on', conversation: conversation.push_event_data,
+                                  user: agent.push_event_data
+      )
+      listener.conversation_typing_on(event)
+    end
+  end
+
+  describe '#typing_off' do
+    let(:event_name) { :'conversation.typing_off' }
+    let!(:event) { Events::Base.new(event_name, Time.zone.now, conversation: conversation, user: agent) }
+
+    it 'sends message to account admins, inbox agents and the contact' do
+      # HACK: to reload conversation inbox members
+      expect(conversation.inbox.reload.inbox_members.count).to eq(1)
+      expect(ActionCableBroadcastJob).to receive(:perform_later).with(
+        [agent.pubsub_token, admin.pubsub_token, conversation.contact.pubsub_token],
+        'conversation.typing_off', conversation: conversation.push_event_data,
+                                   user: agent.push_event_data
+      )
+      listener.conversation_typing_off(event)
+    end
+  end
 end