chore: Add Assignable Agents API (#4722)

app/controllers/api/v1/accounts/assignable_agents_controller.rb

@@ -0,0 +1,24 @@
+class Api::V1::Accounts::AssignableAgentsController < Api::V1::Accounts::BaseController
+  before_action :fetch_inboxes
+
+  def index
+    agent_ids = @inboxes.map do |inbox|
+      authorize inbox, :show?
+      member_ids = inbox.members.pluck(:user_id)
+      member_ids
+    end
+    agent_ids = agent_ids.inject(:&)
+    agents = Current.account.users.where(id: agent_ids)
+    @assignable_agents = (agents + Current.account.administrators).uniq
+  end
+
+  private
+
+  def fetch_inboxes
+    @inboxes = Current.account.inboxes.find(permitted_params[:inbox_ids])
+  end
+
+  def permitted_params
+    params.permit(inbox_ids: [])
+  end
+end

app/controllers/api/v1/accounts/inboxes_controller.rb

@@ -12,6 +12,7 @@ class Api::V1::Accounts::InboxesController < Api::V1::Accounts::BaseController
 
   def show; end
 
+  # Deprecated: This API will be removed in 2.7.0
   def assignable_agents
     @assignable_agents = (Current.account.users.where(id: @inbox.members.select(:user_id)) + Current.account.administrators).uniq
   end

app/javascript/dashboard/api/assignableAgents.js

@@ -0,0 +1,16 @@
+/* global axios */
+import ApiClient from './ApiClient';
+
+class AssignableAgents extends ApiClient {
+  constructor() {
+    super('assignable_agents', { accountScoped: true });
+  }
+
+  get(inboxIds) {
+    return axios.get(this.url, {
+      params: { inbox_ids: inboxIds },
+    });
+  }
+}
+
+export default new AssignableAgents();

app/javascript/dashboard/api/inboxes.js

@@ -6,10 +6,6 @@ class Inboxes extends ApiClient {
     super('inboxes', { accountScoped: true });
   }
 
-  getAssignableAgents(inboxId) {
-    return axios.get(`${this.url}/${inboxId}/assignable_agents`);
-  }
-
   getCampaigns(inboxId) {
     return axios.get(`${this.url}/${inboxId}/campaigns`);
   }

app/javascript/dashboard/api/specs/assignableAgents.spec.js

@@ -0,0 +1,18 @@
+import assignableAgentsAPI from '../assignableAgents';
+import describeWithAPIMock from './apiSpecHelper';
+
+describe('#AssignableAgentsAPI', () => {
+  describeWithAPIMock('API calls', context => {
+    it('#getAssignableAgents', () => {
+      assignableAgentsAPI.get([1]);
+      expect(context.axiosMock.get).toHaveBeenCalledWith(
+        '/api/v1/assignable_agents',
+        {
+          params: {
+            inbox_ids: [1],
+          },
+        }
+      );
+    });
+  });
+});

app/javascript/dashboard/api/specs/inboxes.spec.js

@@ -10,17 +10,9 @@ describe('#InboxesAPI', () => {
     expect(inboxesAPI).toHaveProperty('create');
     expect(inboxesAPI).toHaveProperty('update');
     expect(inboxesAPI).toHaveProperty('delete');
-    expect(inboxesAPI).toHaveProperty('getAssignableAgents');
     expect(inboxesAPI).toHaveProperty('getCampaigns');
   });
   describeWithAPIMock('API calls', context => {
-    it('#getAssignableAgents', () => {
-      inboxesAPI.getAssignableAgents(1);
-      expect(context.axiosMock.get).toHaveBeenCalledWith(
-        '/api/v1/inboxes/1/assignable_agents'
-      );
-    });
-
     it('#getCampaigns', () => {
       inboxesAPI.getCampaigns(2);
       expect(context.axiosMock.get).toHaveBeenCalledWith(

app/javascript/dashboard/store/modules/inboxAssignableAgents.js

@@ -1,6 +1,6 @@
 import Vue from 'vue';
 
-import InboxesAPI from 'dashboard/api/inboxes.js';
+import AssignableAgentsAPI from '../../api/assignableAgents';
 
 const state = {
   records: {},
@@ -31,7 +31,7 @@ export const actions = {
     try {
       const {
         data: { payload },
-      } = await InboxesAPI.getAssignableAgents(inboxId);
+      } = await AssignableAgentsAPI.get([inboxId]);
       commit(types.SET_INBOX_ASSIGNABLE_AGENTS, { inboxId, members: payload });
     } catch (error) {
       throw new Error(error);

app/views/api/v1/accounts/assignable_agents/index.json.jbuilder

@@ -0,0 +1,5 @@
+json.payload do
+  json.array! @assignable_agents do |agent|
+    json.partial! 'api/v1/models/agent.json.jbuilder', resource: agent
+  end
+end