feat: Contact Exports (#7258)

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

@@ -168,6 +168,52 @@ RSpec.describe 'Contacts API', type: :request do
     end
   end
 
+  describe 'POST /api/v1/accounts/{account.id}/contacts/export' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        get "/api/v1/accounts/#{account.id}/contacts/export"
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated user with out permission' do
+      let(:agent) { create(:user, account: account, role: :agent) }
+
+      it 'returns unauthorized' do
+        get "/api/v1/accounts/#{account.id}/contacts/export",
+            headers: agent.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated user' do
+      let(:admin) { create(:user, account: account, role: :administrator) }
+
+      it 'enqueues a contact export job' do
+        expect(Account::ContactsExportJob).to receive(:perform_later).with(account.id, nil).once
+
+        get "/api/v1/accounts/#{account.id}/contacts/export",
+            headers: admin.create_new_auth_token,
+            params: { column_names: nil }
+
+        expect(response).to have_http_status(:success)
+      end
+
+      it 'enqueues a contact export job with sent_columns' do
+        expect(Account::ContactsExportJob).to receive(:perform_later).with(account.id, %w[phone_number email]).once
+
+        get "/api/v1/accounts/#{account.id}/contacts/export",
+            headers: admin.create_new_auth_token,
+            params: { column_names: %w[phone_number email] }
+
+        expect(response).to have_http_status(:success)
+      end
+    end
+  end
+
   describe 'GET /api/v1/accounts/{account.id}/contacts/active' do
     context 'when it is an unauthenticated user' do
       it 'returns unauthorized' do

spec/jobs/account/contacts_export_job_spec.rb

@@ -0,0 +1,50 @@
+require 'rails_helper'
+
+RSpec.describe Account::ContactsExportJob do
+  subject(:job) { described_class.perform_later }
+
+  let!(:account) { create(:account) }
+
+  it 'enqueues the job' do
+    expect { job }.to have_enqueued_job(described_class)
+      .on_queue('low')
+  end
+
+  context 'when export_contacts' do
+    before do
+      create(:contact, account: account, phone_number: '+910808080818', email: 'test1@text.example')
+      8.times do
+        create(:contact, account: account)
+      end
+      create(:contact, account: account, phone_number: '+910808080808', email: 'test2@text.example')
+    end
+
+    it 'generates CSV file and attach to account' do
+      mailer = double
+      allow(AdministratorNotifications::ChannelNotificationsMailer).to receive(:with).with(account: account).and_return(mailer)
+      allow(mailer).to receive(:contact_export_complete)
+
+      described_class.perform_now(account.id, [])
+
+      file_url = Rails.application.routes.url_helpers.rails_blob_url(account.contacts_export)
+
+      expect(account.contacts_export).to be_present
+      expect(file_url).to be_present
+      expect(mailer).to have_received(:contact_export_complete).with(file_url)
+    end
+
+    it 'generates valid data export file' do
+      described_class.perform_now(account.id, [])
+
+      csv_data = CSV.parse(account.contacts_export.download, headers: true)
+      first_row = csv_data[0]
+      last_row = csv_data[csv_data.length - 1]
+      first_contact = account.contacts.first
+      last_contact = account.contacts.last
+
+      expect(csv_data.length).to eq(account.contacts.count)
+      expect([first_row['email'], last_row['email']]).to contain_exactly(first_contact.email, last_contact.email)
+      expect([first_row['phone_number'], last_row['phone_number']]).to contain_exactly(first_contact.phone_number, last_contact.phone_number)
+    end
+  end
+end

spec/mailers/administrator_notifications/channel_notifications_mailer_spec.rb

@@ -10,6 +10,7 @@ RSpec.describe AdministratorNotifications::ChannelNotificationsMailer do
   before do
     allow(described_class).to receive(:new).and_return(class_instance)
     allow(class_instance).to receive(:smtp_config_set_or_development?).and_return(true)
+    Account::ContactsExportJob.perform_now(account.id, [])
   end
 
   describe 'slack_disconnect' do
@@ -55,4 +56,17 @@ RSpec.describe AdministratorNotifications::ChannelNotificationsMailer do
       expect(mail.to).to eq([administrator.email])
     end
   end
+
+  describe 'contact_export_complete' do
+    let!(:file_url) { Rails.application.routes.url_helpers.rails_blob_url(account.contacts_export) }
+    let(:mail) { described_class.with(account: account).contact_export_complete(file_url).deliver_now }
+
+    it 'renders the subject' do
+      expect(mail.subject).to eq("Your contact's export file is available to download.")
+    end
+
+    it 'renders the receiver email' do
+      expect(mail.to).to eq([administrator.email])
+    end
+  end
 end