Add use cases for new settings

Author: ekraffmiller

src/info/domain/repositories/IDataverseInfoRepository.ts

@@ -7,4 +7,6 @@ export interface IDataverseInfoRepository {
   getMaxEmbargoDurationInMonths(): Promise<number>
   getApplicationTermsOfUse(lang?: string): Promise<string>
   getAvailableDatasetMetadataExportFormats(): Promise<DatasetMetadataExportFormats>
+  getDatasetPublishPopupCustomText(): Promise<string>
+  getPublishDatasetDisclaimerText(): Promise<string>
 }

src/info/domain/useCases/GetDatasetPublishPopupCustomText.ts

@@ -0,0 +1,19 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { IDataverseInfoRepository } from '../repositories/IDataverseInfoRepository'
+
+export class GetDatasetPublishPopupCustomText implements UseCase<string> {
+  private dataverseInfoRepository: IDataverseInfoRepository
+
+  constructor(dataverseInfoRepository: IDataverseInfoRepository) {
+    this.dataverseInfoRepository = dataverseInfoRepository
+  }
+
+  /**
+   * Returns a string containing custom text for the Publish Dataset modal.
+   *
+   * @returns {Promise<string>}
+   */
+  async execute(): Promise<string> {
+    return await this.dataverseInfoRepository.getDatasetPublishPopupCustomText()
+  }
+}

src/info/domain/useCases/GetPublishDatasetDisclaimerText.ts

@@ -0,0 +1,19 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { IDataverseInfoRepository } from '../repositories/IDataverseInfoRepository'
+
+export class GetPublishDatasetDisclaimerText implements UseCase<string> {
+  private dataverseInfoRepository: IDataverseInfoRepository
+
+  constructor(dataverseInfoRepository: IDataverseInfoRepository) {
+    this.dataverseInfoRepository = dataverseInfoRepository
+  }
+
+  /**
+   * Returns a string containing the disclaimer text for the Publish Dataset modal.
+   *
+   * @returns {Promise<string>}
+   */
+  async execute(): Promise<string> {
+    return await this.dataverseInfoRepository.getPublishDatasetDisclaimerText()
+  }
+}

src/info/infra/repositories/DataverseInfoRepository.ts

@@ -66,4 +66,26 @@ export class DataverseInfoRepository extends ApiRepository implements IDataverse
         throw error
       })
   }
+  public async getDatasetPublishPopupCustomText(): Promise<string> {
+    return this.doGet(
+      this.buildApiEndpoint(this.infoResourceName, `settings/:DatasetPublishPopupCustomText`)
+    )
+      .then((response: AxiosResponse<{ data: { message: string } }>) => {
+        return response.data.data.message
+      })
+      .catch((error) => {
+        throw error
+      })
+  }
+  public async getPublishDatasetDisclaimerText(): Promise<string> {
+    return this.doGet(
+      this.buildApiEndpoint(this.infoResourceName, `settings/:PublishDatasetDisclaimerText`)
+    )
+      .then((response: AxiosResponse<{ data: { message: string } }>) => {
+        return response.data.data.message
+      })
+      .catch((error) => {
+        throw error
+      })
+  }
 }

test/integration/info/DataverseInfoRepository.test.ts

@@ -7,7 +7,9 @@ import { TestConstants } from '../../testHelpers/TestConstants'
 import {
   deleteApplicationTermsOfUseViaApi,
   setApplicationTermsOfUseViaApi,
-  setMaxEmbargoDurationInMonthsViaApi
+  setDatasetPublishPopupCustomTextViaApi,
+  setMaxEmbargoDurationInMonthsViaApi,
+  setPublishDatasetDisclaimerTextViaApi
 } from '../../testHelpers/info/infoHelper'
 import { ReadError } from '../../../src/core/domain/repositories/ReadError'
 
@@ -53,7 +55,40 @@ describe('DataverseInfoRepository', () => {
       expect(actual).toBe(testMaxEmbargoDurationInMonths)
     })
   })
+  describe('getPublishDatasetDisclaimerText', () => {
+    test('should return error when the setting does not exist', async () => {
+      const errorExpected: ReadError = new ReadError(
+        '[404] Setting :PublishDatasetDisclaimerText not found'
+      )
+
+      await expect(sut.getPublishDatasetDisclaimerText()).rejects.toThrow(errorExpected)
+    })
 
+    test('should return text when the setting exists', async () => {
+      const testPublishDatasetDisclaimerText = 'please read and accept'
+      await setPublishDatasetDisclaimerTextViaApi(testPublishDatasetDisclaimerText)
+      const actual = await sut.getPublishDatasetDisclaimerText()
+
+      expect(actual).toBe(testPublishDatasetDisclaimerText)
+    })
+  })
+  describe('getDatasetPublishPopupCustomText', () => {
+    test('should return error when the setting does not exist', async () => {
+      const errorExpected: ReadError = new ReadError(
+        '[404] Setting :DatasetPublishPopupCustomText not found'
+      )
+
+      await expect(sut.getDatasetPublishPopupCustomText()).rejects.toThrow(errorExpected)
+    })
+
+    test('should return text when the setting exists', async () => {
+      const testDatasetPublishPopupCustomText = 'custom publish popup text'
+      await setDatasetPublishPopupCustomTextViaApi(testDatasetPublishPopupCustomText)
+      const actual = await sut.getDatasetPublishPopupCustomText()
+
+      expect(actual).toBe(testDatasetPublishPopupCustomText)
+    })
+  })
   describe('getApplicationTermsOfUse', () => {
     test('should return no terms message when terms are not set', async () => {
       const defaultNoTermsOfUseMessage =

test/testHelpers/info/infoHelper.ts

@@ -24,7 +24,28 @@ export const setApplicationTermsOfUseViaApi = async (
     }
   )
 }
-
+export const setDatasetPublishPopupCustomTextViaApi = async (
+  datasetPublishPopupCustomText: string
+): Promise<AxiosResponse> => {
+  return await axios.put(
+    `${TestConstants.TEST_API_URL}/admin/settings/:DatasetPublishPopupCustomText`,
+    datasetPublishPopupCustomText,
+    {
+      headers: { 'Content-Type': 'text/plain' }
+    }
+  )
+}
+export const setPublishDatasetDisclaimerTextViaApi = async (
+  publishDatasetDisclaimerText: string
+): Promise<AxiosResponse> => {
+  return await axios.put(
+    `${TestConstants.TEST_API_URL}/admin/settings/:PublishDatasetDisclaimerText`,
+    publishDatasetDisclaimerText,
+    {
+      headers: { 'Content-Type': 'text/plain' }
+    }
+  )
+}
 export const deleteApplicationTermsOfUseViaApi = async (): Promise<AxiosResponse> => {
   return await axios.delete(`${TestConstants.TEST_API_URL}/admin/settings/:ApplicationTermsOfUse`)
 }