fix: add use case of downloading responses

Author: ChengShi-1

src/guestbooks/domain/models/GuestbookResponse.ts

@@ -0,0 +1,5 @@
+export interface GuestbookResponse {
+  [key: string]: unknown
+  guestbookId?: number
+  dataverseId?: number
+}

src/guestbooks/domain/repositories/IGuestbooksRepository.ts

@@ -1,5 +1,6 @@
 import { CreateGuestbookDTO } from '../dtos/CreateGuestbookDTO'
 import { Guestbook } from '../models/Guestbook'
+import { GuestbookResponse } from '../models/GuestbookResponse'
 
 export interface IGuestbooksRepository {
   createGuestbook(
@@ -11,6 +12,14 @@ export interface IGuestbooksRepository {
     collectionIdOrAlias: number | string,
     includeStats?: boolean
   ): Promise<Guestbook[]>
+  getGuestbookResponsesByDataverseId(
+    dataverseId: number | string,
+    guestbookId?: number
+  ): Promise<GuestbookResponse[]>
+  downloadGuestbookResponsesByDataverseId(
+    dataverseId: number | string,
+    guestbookId?: number
+  ): Promise<string>
   setGuestbookEnabled(
     collectionIdOrAlias: number | string,
     guestbookId: number,

src/guestbooks/domain/useCases/DownloadGuestbookResponsesByDataverseId.ts

@@ -0,0 +1,20 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { IGuestbooksRepository } from '../repositories/IGuestbooksRepository'
+
+export class DownloadGuestbookResponsesByDataverseId implements UseCase<string> {
+  constructor(private readonly guestbooksRepository: IGuestbooksRepository) {}
+
+  /**
+   * Downloads all guestbook responses for a dataverse collection.
+   *
+   * The dataverse can be identified by either its alias/identifier or numeric database id.
+   * The returned string is the raw response body from the Dataverse API, which is typically
+   * saved by callers as a CSV file or printed directly.
+   *
+   * @param {number | string} dataverseId - Dataverse alias/identifier or numeric database id.
+   * @returns {Promise<string>} Raw response body returned by the Dataverse API.
+   */
+  async execute(dataverseId: number | string): Promise<string> {
+    return await this.guestbooksRepository.downloadGuestbookResponsesByDataverseId(dataverseId)
+  }
+}

src/guestbooks/domain/useCases/DownloadGuestbookResponsesOfAGuestbook.ts

@@ -0,0 +1,24 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { IGuestbooksRepository } from '../repositories/IGuestbooksRepository'
+
+export class DownloadGuestbookResponsesOfAGuestbook implements UseCase<string> {
+  constructor(private readonly guestbooksRepository: IGuestbooksRepository) {}
+
+  /**
+   * Downloads guestbook responses for one guestbook in a dataverse collection.
+   *
+   * The dataverse can be identified by either its alias/identifier or numeric database id.
+   * The returned string is the raw response body from the Dataverse API, which is typically
+   * saved by callers as a CSV file or printed directly.
+   *
+   * @param {number | string} dataverseId - Dataverse alias/identifier or numeric database id.
+   * @param {number} guestbookId - Guestbook identifier to restrict the export.
+   * @returns {Promise<string>} Raw response body returned by the Dataverse API.
+   */
+  async execute(dataverseId: number | string, guestbookId: number): Promise<string> {
+    return await this.guestbooksRepository.downloadGuestbookResponsesByDataverseId(
+      dataverseId,
+      guestbookId
+    )
+  }
+}

src/guestbooks/domain/useCases/GetGuestbookResponsesByDataverseId.ts

@@ -0,0 +1,17 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { GuestbookResponse } from '../models/GuestbookResponse'
+import { IGuestbooksRepository } from '../repositories/IGuestbooksRepository'
+
+export class GetGuestbookResponsesByDataverseId implements UseCase<GuestbookResponse[]> {
+  constructor(private readonly guestbooksRepository: IGuestbooksRepository) {}
+
+  /**
+   * Returns all guestbook responses for a dataverse collection.
+   *
+   * @param {number | string} dataverseId - Dataverse identifier.
+   * @returns {Promise<GuestbookResponse[]>}
+   */
+  async execute(dataverseId: number | string): Promise<GuestbookResponse[]> {
+    return await this.guestbooksRepository.getGuestbookResponsesByDataverseId(dataverseId)
+  }
+}

src/guestbooks/domain/useCases/GetGuestbookResponsesOfAGuestbook.ts

@@ -0,0 +1,21 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { GuestbookResponse } from '../models/GuestbookResponse'
+import { IGuestbooksRepository } from '../repositories/IGuestbooksRepository'
+
+export class GetGuestbookResponsesOfAGuestbook implements UseCase<GuestbookResponse[]> {
+  constructor(private readonly guestbooksRepository: IGuestbooksRepository) {}
+
+  /**
+   * Returns guestbook responses for one guestbook in a dataverse collection.
+   *
+   * @param {number | string} dataverseId - Dataverse identifier.
+   * @param {number} guestbookId - Guestbook identifier filter.
+   * @returns {Promise<GuestbookResponse[]>}
+   */
+  async execute(dataverseId: number | string, guestbookId: number): Promise<GuestbookResponse[]> {
+    return await this.guestbooksRepository.getGuestbookResponsesByDataverseId(
+      dataverseId,
+      guestbookId
+    )
+  }
+}

src/guestbooks/index.ts

@@ -1,6 +1,10 @@
 import { GuestbooksRepository } from './infra/repositories/GuestbooksRepository'
 import { CreateGuestbook } from './domain/useCases/CreateGuestbook'
+import { DownloadGuestbookResponsesByDataverseId } from './domain/useCases/DownloadGuestbookResponsesByDataverseId'
+import { DownloadGuestbookResponsesOfAGuestbook } from './domain/useCases/DownloadGuestbookResponsesOfAGuestbook'
 import { GetGuestbook } from './domain/useCases/GetGuestbook'
+import { GetGuestbookResponsesByDataverseId } from './domain/useCases/GetGuestbookResponsesByDataverseId'
+import { GetGuestbookResponsesOfAGuestbook } from './domain/useCases/GetGuestbookResponsesOfAGuestbook'
 import { GetGuestbooksByCollectionId } from './domain/useCases/GetGuestbooksByCollectionId'
 import { SetGuestbookEnabled } from './domain/useCases/SetGuestbookEnabled'
 import { AssignDatasetGuestbook } from './domain/useCases/AssignDatasetGuestbook'
@@ -9,15 +13,31 @@ import { RemoveDatasetGuestbook } from './domain/useCases/RemoveDatasetGuestbook
 const guestbooksRepository = new GuestbooksRepository()
 
 const createGuestbook = new CreateGuestbook(guestbooksRepository)
+const downloadGuestbookResponsesByDataverseId = new DownloadGuestbookResponsesByDataverseId(
+  guestbooksRepository
+)
+const downloadGuestbookResponsesOfAGuestbook = new DownloadGuestbookResponsesOfAGuestbook(
+  guestbooksRepository
+)
 const getGuestbook = new GetGuestbook(guestbooksRepository)
+const getGuestbookResponsesByDataverseId = new GetGuestbookResponsesByDataverseId(
+  guestbooksRepository
+)
+const getGuestbookResponsesOfAGuestbook = new GetGuestbookResponsesOfAGuestbook(
+  guestbooksRepository
+)
 const getGuestbooksByCollectionId = new GetGuestbooksByCollectionId(guestbooksRepository)
 const setGuestbookEnabled = new SetGuestbookEnabled(guestbooksRepository)
 const assignDatasetGuestbook = new AssignDatasetGuestbook(guestbooksRepository)
 const removeDatasetGuestbook = new RemoveDatasetGuestbook(guestbooksRepository)
 
 export {
   createGuestbook,
+  downloadGuestbookResponsesByDataverseId,
+  downloadGuestbookResponsesOfAGuestbook,
   getGuestbook,
+  getGuestbookResponsesByDataverseId,
+  getGuestbookResponsesOfAGuestbook,
   getGuestbooksByCollectionId,
   setGuestbookEnabled,
   assignDatasetGuestbook,
@@ -30,3 +50,4 @@ export {
   CreateGuestbookOptionDTO
 } from './domain/dtos/CreateGuestbookDTO'
 export { Guestbook, GuestbookCustomQuestion, GuestbookOption } from './domain/models/Guestbook'
+export { GuestbookResponse } from './domain/models/GuestbookResponse'

src/guestbooks/infra/repositories/GuestbooksRepository.ts

@@ -1,11 +1,13 @@
 import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
 import { CreateGuestbookDTO } from '../../domain/dtos/CreateGuestbookDTO'
 import { Guestbook } from '../../domain/models/Guestbook'
+import { GuestbookResponse } from '../../domain/models/GuestbookResponse'
 import { IGuestbooksRepository } from '../../domain/repositories/IGuestbooksRepository'
 
 export class GuestbooksRepository extends ApiRepository implements IGuestbooksRepository {
   private readonly guestbooksResourceName: string = 'guestbooks'
   private readonly datasetsResourceName: string = 'datasets'
+  private readonly dataversesResourceName: string = 'dataverses'
 
   public async createGuestbook(
     collectionIdOrAlias: number | string,
@@ -47,6 +49,34 @@ export class GuestbooksRepository extends ApiRepository implements IGuestbooksRe
       })
   }
 
+  public async getGuestbookResponsesByDataverseId(
+    dataverseId: number | string,
+    guestbookId?: number
+  ): Promise<GuestbookResponse[]> {
+    const endpoint = `/${this.dataversesResourceName}/${dataverseId}/guestbookResponses`
+    const queryParams = guestbookId === undefined ? {} : { guestbookId }
+
+    return this.doGet(endpoint, true, queryParams)
+      .then((response) => response.data.data as GuestbookResponse[])
+      .catch((error) => {
+        throw error
+      })
+  }
+
+  public async downloadGuestbookResponsesByDataverseId(
+    dataverseId: number | string,
+    guestbookId?: number
+  ): Promise<string> {
+    const endpoint = `/${this.dataversesResourceName}/${dataverseId}/guestbookResponses`
+    const queryParams = guestbookId === undefined ? {} : { guestbookId }
+
+    return this.doGet(endpoint, true, queryParams)
+      .then((response) => response.data as string)
+      .catch((error) => {
+        throw error
+      })
+  }
+
   public async setGuestbookEnabled(
     collectionIdOrAlias: number | string,
     guestbookId: number,

test/integration/guestbooks/GuestbooksRepository.test.ts

@@ -249,6 +249,43 @@ describe('GuestbooksRepository', () => {
     })
   })
 
+  describe('downloadGuestbookResponsesByDataverseId', () => {
+    test('should download all guestbook responses for a dataverse collection', async () => {
+      const setup = await createGuestbookDownloadSetup('all responses export test')
+
+      try {
+        const actual = await sut.downloadGuestbookResponsesByDataverseId(testCollectionAlias)
+
+        expect(actual).toContain('Guestbook, Dataset, Dataset PID, Date, Type, File Name')
+        expect(actual).toContain(setup.guestbookName)
+        expect(actual).toContain(setup.datasetPersistentId)
+        expect(actual).toContain(setup.email)
+        expect(actual).toContain(testTextFile1Name)
+      } finally {
+        await cleanupGuestbookDownloadSetup(setup)
+      }
+    })
+
+    test('should download responses only for the specified guestbook', async () => {
+      const setup = await createGuestbookDownloadSetup('single guestbook export test')
+
+      try {
+        const actual = await sut.downloadGuestbookResponsesByDataverseId(
+          testCollectionAlias,
+          setup.guestbookId
+        )
+
+        expect(actual).toContain('Guestbook, Dataset, Dataset PID, Date, Type, File Name')
+        expect(actual).toContain(setup.guestbookName)
+        expect(actual).toContain(setup.datasetPersistentId)
+        expect(actual).toContain(setup.email)
+        expect(actual).toContain(testTextFile1Name)
+      } finally {
+        await cleanupGuestbookDownloadSetup(setup)
+      }
+    })
+  })
+
   describe('setGuestbookEnabled', () => {
     test('should disable guestbook', async () => {
       createdGuestbookId = await sut.createGuestbook(testCollectionId, createGuestbookDTO)
@@ -346,4 +383,70 @@ describe('GuestbooksRepository', () => {
       })
     })
   })
+
+  const createGuestbookDownloadSetup = async (guestbookName: string) => {
+    const uniqueSuffix = Date.now().toString()
+    const guestbookId = await sut.createGuestbook(testCollectionAlias, {
+      ...createGuestbookDTO,
+      name: `${guestbookName}-${uniqueSuffix}`,
+      customQuestions: []
+    })
+    const datasetIds = await createDataset.execute(
+      TestConstants.TEST_NEW_DATASET_DTO,
+      testCollectionAlias
+    )
+    await uploadFileViaApi(datasetIds.numericId, testTextFile1Name)
+    const datasetFiles = await filesRepository.getDatasetFiles(
+      datasetIds.numericId,
+      DatasetNotNumberedVersion.LATEST,
+      false,
+      FileOrderCriteria.NAME_AZ
+    )
+    const fileId = datasetFiles.files[0].id
+    const email = `guestbook-download-${uniqueSuffix}@example.edu`
+
+    await sut.assignDatasetGuestbook(datasetIds.numericId, guestbookId)
+    await publishDatasetViaApi(datasetIds.numericId)
+    await waitForNoLocks(datasetIds.numericId, 10)
+
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.BEARER_TOKEN,
+      undefined,
+      undefined,
+      () => null
+    )
+    await accessRepository.submitGuestbookForDatafileDownload(fileId, {
+      guestbookResponse: {
+        name: `Guestbook Download ${uniqueSuffix}`,
+        email
+      }
+    })
+
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.API_KEY,
+      process.env.TEST_API_KEY
+    )
+
+    return {
+      guestbookId,
+      guestbookName: `${guestbookName}-${uniqueSuffix}`,
+      datasetNumericId: datasetIds.numericId,
+      datasetPersistentId: datasetIds.persistentId,
+      email
+    }
+  }
+
+  const cleanupGuestbookDownloadSetup = async (setup: {
+    datasetNumericId: number
+    datasetPersistentId: string
+  }) => {
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.API_KEY,
+      process.env.TEST_API_KEY
+    )
+    await deletePublishedDatasetViaApi(setup.datasetPersistentId)
+  }
 })

test/testHelpers/collections/collectionHelper.ts

@@ -134,7 +134,7 @@ export async function setStorageDriverViaApi(
 ): Promise<void> {
   try {
     return await axios.put(
-      `${TestConstants.TEST_API_URL}/admin/dataverse/${collectionAlias}/storageDriver`,
+      `${TestConstants.TEST_API_URL}/dataverses/${collectionAlias}/storageDriver`,
       driverLabel,
       {
         headers: { 'Content-Type': 'text/plain', 'X-Dataverse-Key': process.env.TEST_API_KEY }