feat: New APIs for search (#6564)

- Adding new API endpoints for search
- Migrations to add appropriate indexes

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

@@ -0,0 +1,118 @@
+require 'rails_helper'
+
+RSpec.describe 'Search', type: :request do
+  let(:account) { create(:account) }
+  let(:agent) { create(:user, account: account, role: :agent) }
+
+  before do
+    contact = create(:contact, email: 'test@example.com', account: account)
+    conversation = create(:conversation, account: account, contact_id: contact.id)
+    create(:message, conversation: conversation, account: account, content: 'test1')
+    create(:message, conversation: conversation, account: account, content: 'test2')
+    create(:contact_inbox, contact_id: contact.id, inbox_id: conversation.inbox.id)
+    create(:inbox_member, user: agent, inbox: conversation.inbox)
+  end
+
+  describe 'GET /api/v1/accounts/{account.id}/search' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        get "/api/v1/accounts/#{account.id}/search", params: { q: 'test' }
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated user' do
+      it 'returns all conversations with messages containing the search query' do
+        get "/api/v1/accounts/#{account.id}/search",
+            headers: agent.create_new_auth_token,
+            params: { q: 'test' },
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        response_data = JSON.parse(response.body, symbolize_names: true)
+
+        expect(response_data[:payload][:messages].first[:content]).to eq 'test1'
+        expect(response_data[:payload].keys).to match_array [:contacts, :conversations, :messages]
+        expect(response_data[:payload][:messages].length).to eq 2
+        expect(response_data[:payload][:conversations].length).to eq 1
+        expect(response_data[:payload][:contacts].length).to eq 1
+      end
+    end
+  end
+
+  describe 'GET /api/v1/accounts/{account.id}/search/contacts' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        get "/api/v1/accounts/#{account.id}/search/contacts", params: { q: 'test' }
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated user' do
+      it 'returns all conversations with messages containing the search query' do
+        get "/api/v1/accounts/#{account.id}/search/contacts",
+            headers: agent.create_new_auth_token,
+            params: { q: 'test' },
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        response_data = JSON.parse(response.body, symbolize_names: true)
+
+        expect(response_data[:payload].keys).to match_array [:contacts]
+        expect(response_data[:payload][:contacts].length).to eq 1
+      end
+    end
+  end
+
+  describe 'GET /api/v1/accounts/{account.id}/search/conversations' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        get "/api/v1/accounts/#{account.id}/search/conversations", params: { q: 'test' }
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated user' do
+      it 'returns all conversations with messages containing the search query' do
+        get "/api/v1/accounts/#{account.id}/search/conversations",
+            headers: agent.create_new_auth_token,
+            params: { q: 'test' },
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        response_data = JSON.parse(response.body, symbolize_names: true)
+
+        expect(response_data[:payload].keys).to match_array [:conversations]
+        expect(response_data[:payload][:conversations].length).to eq 1
+      end
+    end
+  end
+
+  describe 'GET /api/v1/accounts/{account.id}/search/messages' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        get "/api/v1/accounts/#{account.id}/search/messages", params: { q: 'test' }
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated user' do
+      it 'returns all conversations with messages containing the search query' do
+        get "/api/v1/accounts/#{account.id}/search/messages",
+            headers: agent.create_new_auth_token,
+            params: { q: 'test' },
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        response_data = JSON.parse(response.body, symbolize_names: true)
+
+        expect(response_data[:payload].keys).to match_array [:messages]
+        expect(response_data[:payload][:messages].length).to eq 2
+      end
+    end
+  end
+end