add custom sorting to ARP POA Request controller

Author: ojbucao

modules/accredited_representative_portal/app/controllers/accredited_representative_portal/v0/power_of_attorney_requests_controller.rb

@@ -19,6 +19,7 @@ def index
         # Validate and normalize pagination parameters
         validated_params = PowerOfAttorneyRequestService::ParamsSchema.validate_and_normalize!(params.to_unsafe_h)
         page_params = validated_params[:page]
+        sort_params = validated_params[:sort]
 
         relation = policy_scope(PowerOfAttorneyRequest)
         status = params[:status].presence
@@ -37,6 +38,10 @@ def index
             MSG
           end
 
+        if sort_params.present? && sort_params[:by].present?
+          relation = apply_custom_sorting(relation, sort_params[:by], sort_params[:order])
+        end
+
         poa_requests = relation.includes(scope_includes)
                                .paginate(page: page_params[:number], per_page: page_params[:size])
 
@@ -96,6 +101,19 @@ def scope_includes
           { resolution: :resolving }
         ]
       end
+
+      def apply_custom_sorting(relation, sort_field, sort_order)
+        return relation unless sort_field.present? && sort_order.present?
+
+        direction = sort_order.to_s.downcase == 'asc' ? :asc : :desc
+
+        case sort_field
+        when 'created_at'
+          relation.order(created_at: direction)
+        else
+          relation
+        end
+      end
     end
   end
 end

modules/accredited_representative_portal/spec/requests/accredited_representative_portal/v0/power_of_attorney_requests_spec.rb

@@ -137,7 +137,61 @@ def load_response_fixture(path_suffix)
         end
       end
 
-      describe 'a variety of POA request configurations' do
+      describe 'sorting' do
+        let!(:poa_requests) do
+          [
+            create(:power_of_attorney_request, :with_veteran_claimant,
+                   created_at: time.to_time - 2.days,
+                   poa_code:),
+            create(:power_of_attorney_request, :with_veteran_claimant,
+                   created_at: time.to_time - 1.day,
+                   poa_code:),
+            create(:power_of_attorney_request, :with_veteran_claimant,
+                   created_at: time.to_time - 3.days,
+                   poa_code:)
+          ]
+        end
+
+        it 'sorts by created_at in ascending order' do
+          get('/accredited_representative_portal/v0/power_of_attorney_requests',
+              params: { sort: { by: 'created_at', order: 'asc' } })
+
+          expect(response).to have_http_status(:ok)
+
+          # check that they're sorted by created_at in ascending order
+          ids = parsed_response.to_h['data'].map { |item| item['id'] }[0..2]
+          expect(ids).to eq([poa_requests[2].id, poa_requests[0].id, poa_requests[1].id])
+        end
+
+        it 'sorts by created_at in descending order' do
+          get('/accredited_representative_portal/v0/power_of_attorney_requests',
+              params: { sort: { by: 'created_at', order: 'desc' } })
+
+          expect(response).to have_http_status(:ok)
+
+          # check that they're sorted by created_at in descending order
+          ids = parsed_response.to_h['data'].map { |item| item['id'] }[1..3]
+          expect(ids).to eq([poa_requests[1].id, poa_requests[0].id, poa_requests[2].id])
+        end
+
+        it 'returns error for invalid sort field' do
+          get('/accredited_representative_portal/v0/power_of_attorney_requests',
+              params: { sort: { by: 'invalid_field' } })
+
+          expect(response).to have_http_status(:bad_request)
+          expect(parsed_response.to_h['errors']).to include(/Invalid parameters/)
+        end
+
+        it 'returns error for invalid sort order' do
+          get('/accredited_representative_portal/v0/power_of_attorney_requests',
+              params: { sort: { by: 'created_at', order: 'invalid' } })
+
+          expect(response).to have_http_status(:bad_request)
+          expect(parsed_response.to_h['errors']).to include(/Invalid parameters/)
+        end
+      end
+
+      describe 'a variety of poa request configurations' do
         let(:poa_requests) do
           [].tap do |memo|
             memo <<