feat: SLA CRUD APIs (EE) (#7027)

Fixes: https://linear.app/chatwoot/issue/CW-1613/sla-api

Co-authored-by: Sojan Jose <sojan@pepalo.com>

spec/enterprise/controllers/api/v1/accounts/sla_policies_controller_spec.rb

@@ -0,0 +1,189 @@
+require 'rails_helper'
+
+RSpec.describe 'Enterprise SLA API', type: :request do
+  let(:account) { create(:account) }
+  let(:administrator) { create(:user, account: account, role: :administrator) }
+  let(:agent) { create(:user, account: account, role: :agent) }
+
+  before do
+    create(:sla_policy, account: account, name: 'SLA 1')
+  end
+
+  describe 'GET #index' do
+    context 'when it is an authenticated user' do
+      it 'returns all slas in the account' do
+        get "/api/v1/accounts/#{account.id}/sla_policies",
+            headers: administrator.create_new_auth_token
+        expect(response).to have_http_status(:success)
+        body = JSON.parse(response.body)
+
+        expect(body['payload'][0]).to include('name' => 'SLA 1')
+      end
+    end
+
+    context 'when the user is an agent' do
+      it 'returns slas in the account' do
+        get "/api/v1/accounts/#{account.id}/sla_policies",
+            headers: administrator.create_new_auth_token
+        expect(response).to have_http_status(:success)
+        body = JSON.parse(response.body)
+
+        expect(body['payload'][0]).to include('name' => 'SLA 1')
+      end
+    end
+
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        post "/api/v1/accounts/#{account.id}/sla_policies"
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+  end
+
+  describe 'GET #show' do
+    let(:sla_policy) { create(:sla_policy, account: account) }
+
+    context 'when it is an authenticated user' do
+      it 'shows the sla' do
+        get "/api/v1/accounts/#{account.id}/sla_policies/#{sla_policy.id}",
+            headers: administrator.create_new_auth_token
+
+        expect(response).to have_http_status(:success)
+        body = JSON.parse(response.body)
+
+        expect(body['payload']).to include('name' => sla_policy.name)
+      end
+    end
+
+    context 'when the user is an agent' do
+      it 'shows the sla details' do
+        get "/api/v1/accounts/#{account.id}/sla_policies/#{sla_policy.id}",
+            headers: agent.create_new_auth_token
+
+        expect(response).to have_http_status(:success)
+        body = JSON.parse(response.body)
+
+        expect(body['payload']).to include('name' => sla_policy.name)
+      end
+    end
+
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        post "/api/v1/accounts/#{account.id}/sla_policies"
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+  end
+
+  describe 'POST #create' do
+    let(:valid_params) do
+      { sla_policy: { name: 'SLA 2',
+                      frt_threshold: 1000,
+                      rt_threshold: 1000,
+                      only_during_business_hours: false } }
+    end
+
+    context 'when it is an authenticated user' do
+      it 'creates the sla_policy' do
+        expect do
+          post "/api/v1/accounts/#{account.id}/sla_policies", params: valid_params,
+                                                              headers: administrator.create_new_auth_token
+        end.to change(SlaPolicy, :count).by(1)
+
+        expect(response).to have_http_status(:success)
+        body = JSON.parse(response.body)
+
+        expect(body['payload']).to include('name' => 'SLA 2')
+      end
+    end
+
+    context 'when the user is an agent' do
+      it 'returns unauthorized' do
+        post "/api/v1/accounts/#{account.id}/sla_policies",
+             params: valid_params,
+             headers: agent.create_new_auth_token,
+             as: :json
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        post "/api/v1/accounts/#{account.id}/sla_policies"
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+  end
+
+  describe 'PUT #update' do
+    let(:sla_policy) { create(:sla_policy, account: account) }
+
+    context 'when it is an authenticated user' do
+      it 'updates the sla_policy' do
+        put "/api/v1/accounts/#{account.id}/sla_policies/#{sla_policy.id}",
+            params: { sla_policy: { name: 'SLA 2' } },
+            headers: administrator.create_new_auth_token
+
+        expect(response).to have_http_status(:success)
+        body = JSON.parse(response.body)
+
+        expect(body['payload']).to include('name' => 'SLA 2')
+      end
+    end
+
+    context 'when the user is an agent' do
+      it 'returns unauthorized' do
+        put "/api/v1/accounts/#{account.id}/sla_policies/#{sla_policy.id}",
+            params: { sla_policy: { name: 'SLA 2' } },
+            headers: agent.create_new_auth_token,
+            as: :json
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        put "/api/v1/accounts/#{account.id}/sla_policies/#{sla_policy.id}"
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+  end
+
+  describe 'DELETE #destroy' do
+    let(:sla_policy) { create(:sla_policy, account: account) }
+
+    context 'when it is an authenticated user' do
+      it 'deletes the sla_policy' do
+        delete "/api/v1/accounts/#{account.id}/sla_policies/#{sla_policy.id}",
+               headers: administrator.create_new_auth_token
+
+        expect(response).to have_http_status(:success)
+        expect(SlaPolicy.count).to eq(1)
+      end
+    end
+
+    context 'when the user is an agent' do
+      it 'returns unauthorized' do
+        delete "/api/v1/accounts/#{account.id}/sla_policies/#{sla_policy.id}",
+               headers: agent.create_new_auth_token,
+               as: :json
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        delete "/api/v1/accounts/#{account.id}/sla_policies/#{sla_policy.id}"
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+  end
+end

spec/enterprise/models/account_spec.rb

@@ -3,6 +3,24 @@
 require 'rails_helper'
 
 RSpec.describe Account do
+  include ActiveJob::TestHelper
+
+  describe 'sla_policies' do
+    let!(:account) { create(:account) }
+    let!(:sla_policy) { create(:sla_policy, account: account) }
+
+    it 'returns associated sla policies' do
+      expect(account.sla_policies).to eq([sla_policy])
+    end
+
+    it 'deletes associated sla policies' do
+      perform_enqueued_jobs do
+        account.destroy!
+      end
+      expect { sla_policy.reload }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+
   describe 'usage_limits' do
     before do
       create(:installation_config, name: 'ACCOUNT_AGENTS_LIMIT', value: 20)

spec/enterprise/models/sla_policy_spec.rb

@@ -0,0 +1,22 @@
+require 'rails_helper'
+
+RSpec.describe SlaPolicy, type: :model do
+  include ActiveJob::TestHelper
+  let(:account) { create(:account) }
+  let(:admin) { create(:user, account: account, role: :administrator) }
+
+  describe 'validations' do
+    it { is_expected.to validate_presence_of(:name) }
+  end
+
+  describe 'associations' do
+    it { is_expected.to belong_to(:account) }
+  end
+
+  describe 'validates_factory' do
+    it 'creates valid sla policy object' do
+      sla_policy = create(:sla_policy)
+      expect(sla_policy.name).to eq 'sla_1'
+    end
+  end
+end

spec/factories/sla_policies.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :sla_policy do
+    account
+    name { 'sla_1' }
+    rt_threshold { 1000 }
+    frt_threshold { 2000 }
+    only_during_business_hours { false }
+  end
+end