LSS 123487 ClaimsEvidence Files service functions (#25382)

Author: wayne-weibel

modules/claims_evidence_api/lib/claims_evidence_api/service/base.rb

@@ -10,7 +10,7 @@
 module ClaimsEvidenceApi
   module Service
     # Base service class for API
-    class Base < Common::Client::Base
+    class Base < ::Common::Client::Base
       configuration ClaimsEvidenceApi::Configuration
 
       include ClaimsEvidenceApi::Exceptions::Service

modules/claims_evidence_api/lib/claims_evidence_api/service/files.rb

@@ -51,6 +51,7 @@ def update(uuid, provider_data: {})
       # POST overwrite a file in a vbms folder, but retain the uuid
       # @see https://fwdproxy-prod.vfs.va.gov:4469/api/v1/rest/swagger-ui.html#/File/update
       #
+      # @param uuid [String] The UUID of the file data
       # @param file_path [String] the path to the file to upload
       # @param provider_data [Hash] metadata to be associated with the file
       def overwrite(uuid, file_path, provider_data:)
@@ -64,6 +65,26 @@ def overwrite(uuid, file_path, provider_data:)
         perform :post, "files/#{uuid}", params, headers
       end
 
+      # GET retrieve the associated period of service record to from a document
+      # @see https://fwdproxy-prod.vfs.va.gov:4469/api/v1/rest/swagger-ui.html#/Period%20Of%20Service
+      #
+      # only certain documents will have associated period of service records
+      #
+      # @param uuid [String] The UUID of the file data
+      def period_of_service(uuid)
+        perform :get, "files/#{uuid}/periodOfService", {}
+      end
+
+      # GET file content for a given version as a pdf
+      # @see https://fwdproxy-prod.vfs.va.gov:4469/api/v1/rest/swagger-ui.html#/Version%20Content
+      #
+      # @param uuid [String] The UUID of the file data
+      # @param version [String] version UUID of the file data
+      def download(uuid, version)
+        headers = { 'Accept' => 'application/pdf' }
+        perform :get, "files/#{uuid}/#{version}/content", {}, headers
+      end
+
       private
 
       # @see ClaimsEvidenceApi::Service::Base#endpoint

modules/claims_evidence_api/spec/lib/claims_evidence_api/service/files_spec.rb

@@ -14,6 +14,7 @@
   let(:headers) { { 'X-Folder-URI' => folder_identifier } }
 
   let(:uuid) { SecureRandom.hex }
+  let(:version) { SecureRandom.hex }
   let(:file_path) { Common::FileHelpers.generate_random_file('TEST FILE', '.test') }
   let(:file_name) { File.basename(file_path) }
   let(:provider_data) do
@@ -120,4 +121,21 @@
       expect { service.overwrite(uuid, file_path, provider_data: {}) }.to raise_error JSON::Schema::ValidationError
     end
   end
+
+  describe '#period_of_service' do
+    it 'performs a GET' do
+      path = "files/#{uuid}/periodOfService"
+      expect(service).to receive(:perform).with(:get, path, {})
+      service.period_of_service(uuid)
+    end
+  end
+
+  describe '#download' do
+    it 'performs a GET for a specific file version' do
+      download_headers = { 'Accept' => 'application/pdf' }
+      path = "files/#{uuid}/#{version}/content"
+      expect(service).to receive(:perform).with(:get, path, {}, download_headers)
+      service.download(uuid, version)
+    end
+  end
 end