feat: APIs to filter reports (#2889)

Fixes #2823

spec/builders/v2/report_builder_spec.rb

@@ -5,6 +5,8 @@ describe ::V2::ReportBuilder do
   let!(:user) { create(:user, account: account) }
   let!(:inbox) { create(:inbox, account: account) }
   let(:inbox_member) { create(:inbox_member, user: user, inbox: inbox) }
+  let!(:label_1) { create(:label, title: 'Label_1', account: account) }
+  let!(:label_2) { create(:label, title: 'Label_2', account: account) }
 
   # Running jobs inline to calculate the exact metrics
   around do |test|
@@ -17,35 +19,42 @@ describe ::V2::ReportBuilder do
   end
 
   describe '#timeseries' do
-    context 'when report type is account' do
-      before do
-        10.times do
-          conversation = create(:conversation, account: account,
-                                               inbox: inbox, assignee: user,
-                                               created_at: Time.zone.today)
-          create_list(:message, 5, message_type: 'outgoing',
-                                   account: account, inbox: inbox,
-                                   conversation: conversation, created_at: Time.zone.today + 2.hours)
-          create_list(:message, 2, message_type: 'incoming',
-                                   account: account, inbox: inbox,
-                                   conversation: conversation,
-                                   created_at: Time.zone.today + 3.hours)
-        end
-        5.times do
-          conversation = create(:conversation, account: account,
-                                               inbox: inbox, assignee: user,
-                                               created_at: (Time.zone.today - 2.days))
-          create_list(:message, 3, message_type: 'outgoing',
-                                   account: account, inbox: inbox,
-                                   conversation: conversation,
-                                   created_at: (Time.zone.today - 2.days))
-          create_list(:message, 1, message_type: 'incoming',
-                                   account: account, inbox: inbox,
-                                   conversation: conversation,
-                                   created_at: (Time.zone.today - 2.days))
-        end
+    before do
+      10.times do
+        conversation = create(:conversation, account: account,
+                                             inbox: inbox, assignee: user,
+                                             created_at: Time.zone.today)
+        create_list(:message, 5, message_type: 'outgoing',
+                                 account: account, inbox: inbox,
+                                 conversation: conversation, created_at: Time.zone.today + 2.hours)
+        create_list(:message, 2, message_type: 'incoming',
+                                 account: account, inbox: inbox,
+                                 conversation: conversation,
+                                 created_at: Time.zone.today + 3.hours)
+        conversation.update_labels('label_1')
+        conversation.label_list
+        conversation.save!
       end
 
+      5.times do
+        conversation = create(:conversation, account: account,
+                                             inbox: inbox, assignee: user,
+                                             created_at: (Time.zone.today - 2.days))
+        create_list(:message, 3, message_type: 'outgoing',
+                                 account: account, inbox: inbox,
+                                 conversation: conversation,
+                                 created_at: (Time.zone.today - 2.days))
+        create_list(:message, 1, message_type: 'incoming',
+                                 account: account, inbox: inbox,
+                                 conversation: conversation,
+                                 created_at: (Time.zone.today - 2.days))
+        conversation.update_labels('label_2')
+        conversation.label_list
+        conversation.save!
+      end
+    end
+
+    context 'when report type is account' do
       it 'return conversations count' do
         params = {
           metric: 'conversations_count',
@@ -139,5 +148,105 @@ describe ::V2::ReportBuilder do
         expect(metrics[:resolutions_count]).to be 0
       end
     end
+
+    context 'when report type is label' do
+      it 'return conversations count' do
+        params = {
+          metric: 'conversations_count',
+          type: :label,
+          id: label_2.id,
+          since: (Time.zone.today - 3.days).to_time.to_i.to_s,
+          until: Time.zone.today.to_time.to_i.to_s
+        }
+
+        builder = V2::ReportBuilder.new(account, params)
+        metrics = builder.timeseries
+
+        expect(metrics[Time.zone.today - 2.days]).to be 5
+      end
+
+      it 'return incoming messages count' do
+        params = {
+          metric: 'incoming_messages_count',
+          type: :label,
+          id: label_1.id,
+          since: (Time.zone.today - 3.days).to_time.to_i.to_s,
+          until: Time.zone.today.to_time.to_i.to_s
+        }
+
+        builder = V2::ReportBuilder.new(account, params)
+        metrics = builder.timeseries
+
+        expect(metrics[Time.zone.today]).to be 20
+        expect(metrics[Time.zone.today - 2.days]).to be 5
+      end
+
+      it 'return outgoing messages count' do
+        params = {
+          metric: 'outgoing_messages_count',
+          type: :label,
+          id: label_1.id,
+          since: (Time.zone.today - 3.days).to_time.to_i.to_s,
+          until: Time.zone.today.to_time.to_i.to_s
+        }
+
+        builder = V2::ReportBuilder.new(account, params)
+        metrics = builder.timeseries
+
+        expect(metrics[Time.zone.today]).to be 50
+        expect(metrics[Time.zone.today - 2.days]).to be 15
+      end
+
+      it 'return resolutions count' do
+        params = {
+          metric: 'resolutions_count',
+          type: :label,
+          id: label_2.id,
+          since: (Time.zone.today - 3.days).to_time.to_i.to_s,
+          until: Time.zone.today.to_time.to_i.to_s
+        }
+
+        conversations = account.conversations.where('created_at < ?', 1.day.ago)
+        conversations.each(&:resolved!)
+        builder = V2::ReportBuilder.new(account, params)
+        metrics = builder.timeseries
+
+        expect(metrics[Time.zone.today - 2.days]).to be 5
+      end
+
+      it 'returns average first response time' do
+        FactoryBot.create(:event, conversation: label_2.conversations.last, account: account, name: 'first_response')
+
+        params = {
+          metric: 'avg_first_response_time',
+          type: :label,
+          id: label_2.id,
+          since: (Time.zone.today - 3.days).to_time.to_i.to_s,
+          until: Time.zone.today.to_time.to_i.to_s
+        }
+
+        builder = V2::ReportBuilder.new(account, params)
+        metrics = builder.timeseries
+        expect(metrics[Time.zone.today].to_f).to be 0.15e1
+      end
+
+      it 'returns summary' do
+        params = {
+          type: :label,
+          id: label_2.id,
+          since: (Time.zone.today - 3.days).to_time.to_i.to_s,
+          until: Time.zone.today.to_time.to_i.to_s
+        }
+
+        builder = V2::ReportBuilder.new(account, params)
+        metrics = builder.summary
+
+        expect(metrics[:conversations_count]).to be 5
+        expect(metrics[:incoming_messages_count]).to be 25
+        expect(metrics[:outgoing_messages_count]).to be 65
+        expect(metrics[:avg_resolution_time]).to be 0
+        expect(metrics[:resolutions_count]).to be 0
+      end
+    end
   end
 end

spec/controllers/api/v2/accounts/report_controller_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe 'Reports API', type: :request do
   describe 'GET /api/v2/accounts/:account_id/reports/account' do
     context 'when it is an unauthenticated user' do
       it 'returns unauthorized' do
-        get "/api/v2/accounts/#{account.id}/reports/account"
+        get "/api/v2/accounts/#{account.id}/reports"
 
         expect(response).to have_http_status(:unauthorized)
       end
@@ -31,7 +31,7 @@ RSpec.describe 'Reports API', type: :request do
       }
 
       it 'returns unauthorized for agents' do
-        get "/api/v2/accounts/#{account.id}/reports/account",
+        get "/api/v2/accounts/#{account.id}/reports",
             params: params,
             headers: agent.create_new_auth_token,
             as: :json
@@ -40,7 +40,7 @@ RSpec.describe 'Reports API', type: :request do
       end
 
       it 'return timeseries metrics' do
-        get "/api/v2/accounts/#{account.id}/reports/account",
+        get "/api/v2/accounts/#{account.id}/reports",
             params: params,
             headers: admin.create_new_auth_token,
             as: :json
@@ -55,10 +55,10 @@ RSpec.describe 'Reports API', type: :request do
     end
   end
 
-  describe 'GET /api/v2/accounts/:account_id/reports/account_summary' do
+  describe 'GET /api/v2/accounts/:account_id/reports/summary' do
     context 'when it is an unauthenticated user' do
       it 'returns unauthorized' do
-        get "/api/v2/accounts/#{account.id}/reports/account_summary"
+        get "/api/v2/accounts/#{account.id}/reports/summary"
 
         expect(response).to have_http_status(:unauthorized)
       end
@@ -72,7 +72,7 @@ RSpec.describe 'Reports API', type: :request do
       }
 
       it 'returns unauthorized for agents' do
-        get "/api/v2/accounts/#{account.id}/reports/account_summary",
+        get "/api/v2/accounts/#{account.id}/reports/summary",
             params: params,
             headers: agent.create_new_auth_token,
             as: :json
@@ -81,7 +81,7 @@ RSpec.describe 'Reports API', type: :request do
       end
 
       it 'returns summary metrics' do
-        get "/api/v2/accounts/#{account.id}/reports/account_summary",
+        get "/api/v2/accounts/#{account.id}/reports/summary",
             params: params,
             headers: admin.create_new_auth_token,
             as: :json
@@ -142,7 +142,7 @@ RSpec.describe 'Reports API', type: :request do
         until: Time.zone.today.to_time.to_i.to_s
       }
 
-      it 'returns unauthorized for agents' do
+      it 'returns unauthorized for inboxes' do
         get "/api/v2/accounts/#{account.id}/reports/inboxes",
             params: params,
             headers: agent.create_new_auth_token
@@ -159,4 +159,37 @@ RSpec.describe 'Reports API', type: :request do
       end
     end
   end
+
+  describe 'GET /api/v2/accounts/:account_id/reports/labels' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        get "/api/v2/accounts/#{account.id}/reports/labels.csv"
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated user' do
+      params = {
+        since: 30.days.ago.to_i.to_s,
+        until: Time.zone.today.to_time.to_i.to_s
+      }
+
+      it 'returns unauthorized for labels' do
+        get "/api/v2/accounts/#{account.id}/reports/labels.csv",
+            params: params,
+            headers: agent.create_new_auth_token
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+
+      it 'returns summary' do
+        get "/api/v2/accounts/#{account.id}/reports/labels.csv",
+            params: params,
+            headers: admin.create_new_auth_token
+
+        expect(response).to have_http_status(:success)
+      end
+    end
+  end
 end