feat: Team APIs (#1654)

Co-authored-by: Pranav Raj S <pranav@chatwoot.com>

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

@@ -0,0 +1,106 @@
+require 'rails_helper'
+
+RSpec.describe 'Team Members API', type: :request do
+  let(:account) { create(:account) }
+  let!(:team) { create(:team, account: account) }
+
+  describe 'GET /api/v1/accounts/{account.id}/teams/{team_id}/team_members' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        get "/api/v1/accounts/#{account.id}/teams/#{team.id}/team_members"
+
+        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 'returns all the teams' do
+        create(:team_member, team: team, user: agent)
+        get "/api/v1/accounts/#{account.id}/teams/#{team.id}/team_members",
+            headers: agent.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        expect(JSON.parse(response.body).first['id']).to eq(agent.id)
+      end
+    end
+  end
+
+  describe 'POST /api/v1/accounts/{account.id}/teams/{team_id}/team_members' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        post "/api/v1/accounts/#{account.id}/teams/#{team.id}/team_members"
+
+        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) }
+      let(:administrator) { create(:user, account: account, role: :administrator) }
+
+      it 'returns unathorized for agent' do
+        params = { user_id: agent.id }
+
+        post "/api/v1/accounts/#{account.id}/teams/#{team.id}/team_members",
+             params: params,
+             headers: agent.create_new_auth_token,
+             as: :json
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+
+      it 'add a new team member when its administrator' do
+        params = { user_id: agent.id }
+
+        post "/api/v1/accounts/#{account.id}/teams/#{team.id}/team_members",
+             params: params,
+             headers: administrator.create_new_auth_token,
+             as: :json
+
+        expect(response).to have_http_status(:success)
+        json_response = JSON.parse(response.body)
+        expect(json_response['id']).to eq(agent.id)
+      end
+    end
+  end
+
+  describe 'DELETE /api/v1/accounts/{account.id}/teams/{team_id}/team_members' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        delete "/api/v1/accounts/#{account.id}/teams/#{team.id}/team_members"
+
+        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) }
+      let(:administrator) { create(:user, account: account, role: :administrator) }
+
+      it 'return unauthorized for agent' do
+        params = { user_id: agent.id }
+        delete "/api/v1/accounts/#{account.id}/teams/#{team.id}/team_members",
+               params: params,
+               headers: agent.create_new_auth_token,
+               as: :json
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+
+      it 'destroys the team member when its administrator' do
+        params = { user_id: agent.id }
+        create(:team_member, team: team, user: agent)
+        delete "/api/v1/accounts/#{account.id}/teams/#{team.id}",
+               params: params,
+               headers: administrator.create_new_auth_token,
+               as: :json
+
+        expect(response).to have_http_status(:success)
+        expect(team.team_members.count).to eq(0)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,160 @@
+require 'rails_helper'
+
+RSpec.describe 'Teams API', type: :request do
+  let(:account) { create(:account) }
+  let!(:team) { create(:team, account: account) }
+
+  describe 'GET /api/v1/accounts/{account.id}/teams' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        get "/api/v1/accounts/#{account.id}/teams"
+
+        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 'returns all the teams' do
+        get "/api/v1/accounts/#{account.id}/teams",
+            headers: agent.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        expect(JSON.parse(response.body).first['id']).to eq(account.teams.first.id)
+      end
+    end
+  end
+
+  describe 'GET /api/v1/accounts/{account.id}/teams/{team_id}' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        get "/api/v1/accounts/#{account.id}/teams/#{team.id}"
+
+        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 'returns all the teams' do
+        get "/api/v1/accounts/#{account.id}/teams/#{team.id}",
+            headers: agent.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        expect(JSON.parse(response.body)['id']).to eq(team.id)
+      end
+    end
+  end
+
+  describe 'POST /api/v1/accounts/{account.id}/teams' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        post "/api/v1/accounts/#{account.id}/teams"
+
+        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) }
+      let(:administrator) { create(:user, account: account, role: :administrator) }
+
+      it 'returns unathorized for agent' do
+        params = { name: 'Test Team' }
+
+        post "/api/v1/accounts/#{account.id}/teams",
+             params: params,
+             headers: agent.create_new_auth_token,
+             as: :json
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+
+      it 'creates a new team when its administrator' do
+        params = { name: 'Test Team' }
+
+        post "/api/v1/accounts/#{account.id}/teams",
+             params: params,
+             headers: administrator.create_new_auth_token,
+             as: :json
+
+        expect(response).to have_http_status(:success)
+        expect(Team.count).to eq(2)
+      end
+    end
+  end
+
+  describe 'PUT /api/v1/accounts/{account.id}/teams/:id' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        put "/api/v1/accounts/#{account.id}/teams/#{team.id}"
+
+        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) }
+      let(:administrator) { create(:user, account: account, role: :administrator) }
+
+      it 'returns unauthorized for agent' do
+        params = { name: 'New Team' }
+
+        put "/api/v1/accounts/#{account.id}/teams/#{team.id}",
+            params: params,
+            headers: agent.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+
+      it 'updates an existing team when its an administrator' do
+        params = { name: 'New Team' }
+
+        put "/api/v1/accounts/#{account.id}/teams/#{team.id}",
+            params: params,
+            headers: administrator.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        expect(team.reload.name).to eq('New Team')
+      end
+    end
+  end
+
+  describe 'DELETE /api/v1/accounts/{account.id}/teams/:id' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        delete "/api/v1/accounts/#{account.id}/teams/#{team.id}"
+
+        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) }
+      let(:administrator) { create(:user, account: account, role: :administrator) }
+
+      it 'return unauthorized for agent' do
+        delete "/api/v1/accounts/#{account.id}/teams/#{team.id}",
+               headers: agent.create_new_auth_token,
+               as: :json
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+
+      it 'destroys the team when its administrator' do
+        delete "/api/v1/accounts/#{account.id}/teams/#{team.id}",
+               headers: administrator.create_new_auth_token,
+               as: :json
+
+        expect(response).to have_http_status(:success)
+        expect(Team.count).to eq(0)
+      end
+    end
+  end
+end

spec/factories/team_members.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :team_member do
+    user
+    team
+  end
+end

spec/factories/teams.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :team do
+    name { 'MyString' }
+    description { 'MyText' }
+    allow_auto_assign { true }
+    account
+  end
+end

spec/models/account_spec.rb

@@ -20,4 +20,5 @@ RSpec.describe Account do
   it { is_expected.to have_many(:events) }
   it { is_expected.to have_many(:kbase_portals).dependent(:destroy) }
   it { is_expected.to have_many(:kbase_categories).dependent(:destroy) }
+  it { is_expected.to have_many(:teams).dependent(:destroy) }
 end

spec/models/conversation_spec.rb

@@ -3,6 +3,10 @@
 require 'rails_helper'
 
 RSpec.describe Conversation, type: :model do
+  describe 'associations' do
+    it { is_expected.to belong_to(:account) }
+  end
+
   describe '.before_create' do
     let(:conversation) { build(:conversation, display_id: nil) }
 

spec/models/team_member_spec.rb

@@ -0,0 +1,8 @@
+require 'rails_helper'
+
+RSpec.describe TeamMember, type: :model do
+  describe 'associations' do
+    it { is_expected.to belong_to(:team) }
+    it { is_expected.to belong_to(:user) }
+  end
+end

spec/models/team_spec.rb

@@ -0,0 +1,9 @@
+require 'rails_helper'
+
+RSpec.describe Team, type: :model do
+  describe 'associations' do
+    it { is_expected.to belong_to(:account) }
+    it { is_expected.to have_many(:conversations) }
+    it { is_expected.to have_many(:team_members) }
+  end
+end

spec/models/user_spec.rb

@@ -19,6 +19,7 @@ RSpec.describe User do
     it { is_expected.to have_many(:notification_settings).dependent(:destroy) }
     it { is_expected.to have_many(:messages) }
     it { is_expected.to have_many(:events) }
+    it { is_expected.to have_many(:teams) }
   end
 
   describe 'concerns' do