Added: create collection use case, pending data access logic

Author: GPortas

docs/useCases.md

@@ -11,6 +11,8 @@ The different use cases currently available in the package are classified below,
 - [Collections](#Collections)
   - [Collections read use cases](#collections-read-use-cases)
     - [Get a Collection](#get-a-collection)
+  - [Collections write use cases](#collections-write-use-cases)
+    - [Create a Collection](#create-a-collection)
 - [Datasets](#Datasets)
   - [Datasets read use cases](#datasets-read-use-cases)
     - [Get a Dataset](#get-a-dataset)

src/collections/domain/dtos/CollectionDTO.ts

@@ -0,0 +1,18 @@
+export interface CollectionDTO {
+  alias: string
+  name: string
+  contacts: string[]
+  type: CollectionType
+}
+
+export enum CollectionType {
+  RESEARCHERS,
+  RESEARCH_PROJECTS,
+  JOURNALS,
+  ORGANIZATIONS_INSTITUTIONS,
+  TEACHING_COURSES,
+  UNCATEGORIZED,
+  LABORATORY,
+  RESEARCH_GROUP,
+  DEPARTMENT
+}

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -1,5 +1,7 @@
+import { CollectionDTO } from '../dtos/CollectionDTO'
 import { Collection } from '../models/Collection'
 
 export interface ICollectionsRepository {
   getCollection(collectionIdOrAlias: number | string): Promise<Collection>
+  createCollection(collectionDTO: CollectionDTO): Promise<void>
 }

src/collections/domain/useCases/CreateCollection.ts

@@ -0,0 +1,18 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { CollectionDTO } from '../dtos/CollectionDTO'
+import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
+
+export class CreateCollection implements UseCase<void> {
+  private collectionsRepository: ICollectionsRepository
+
+  constructor(collectionsRepository: ICollectionsRepository) {
+    this.collectionsRepository = collectionsRepository
+  }
+
+  /**
+   * TODO
+   */
+  async execute(newCollection: CollectionDTO): Promise<void> {
+    await this.collectionsRepository.createCollection(newCollection)
+  }
+}

src/collections/infra/repositories/CollectionsRepository.ts

@@ -2,6 +2,7 @@ import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
 import { ICollectionsRepository } from '../../domain/repositories/ICollectionsRepository'
 import { transformCollectionResponseToCollection } from './transformers/collectionTransformers'
 import { Collection, ROOT_COLLECTION_ALIAS } from '../../domain/models/Collection'
+import { CollectionDTO } from '../../domain/dtos/CollectionDTO'
 
 export class CollectionsRepository extends ApiRepository implements ICollectionsRepository {
   private readonly collectionsResourceName: string = 'dataverses'
@@ -17,4 +18,9 @@ export class CollectionsRepository extends ApiRepository implements ICollections
         throw error
       })
   }
+
+  public async createCollection(collectionDTO: CollectionDTO): Promise<void> {
+    console.log(collectionDTO.alias)
+    // TODO
+  }
 }

test/testHelpers/collections/collectionHelper.ts

@@ -3,6 +3,7 @@ import { DvObjectType } from '../../../src'
 import { CollectionPayload } from '../../../src/collections/infra/repositories/transformers/CollectionPayload'
 import { TestConstants } from '../TestConstants'
 import axios from 'axios'
+import { CollectionDTO, CollectionType } from '../../../src/collections/domain/dtos/CollectionDTO'
 
 const COLLECTION_ID = 11111
 const COLLECTION_IS_RELEASED = 'true'
@@ -100,3 +101,12 @@ export async function setStorageDriverViaApi(
     throw new Error(`Error while setting storage driver for collection ${collectionAlias}`)
   }
 }
+
+export const createCollectionDTO = (): CollectionDTO => {
+  return {
+    alias: 'test-collection',
+    name: 'Test Collection',
+    contacts: ['[email protected]'],
+    type: CollectionType.DEPARTMENT
+  }
+}

test/unit/collections/CreateCollection.test.ts

@@ -0,0 +1,26 @@
+import { CreateCollection } from '../../../src/collections/domain/useCases/CreateCollection'
+import { ICollectionsRepository } from '../../../src/collections/domain/repositories/ICollectionsRepository'
+import { WriteError } from '../../../src'
+import { createCollectionDTO } from '../../testHelpers/collections/collectionHelper'
+
+describe('execute', () => {
+  const testCollectionDTO = createCollectionDTO()
+
+  test('should return undefined on repository success', async () => {
+    const collectionRepositoryStub: ICollectionsRepository = {} as ICollectionsRepository
+    collectionRepositoryStub.createCollection = jest.fn().mockResolvedValue(undefined)
+    const testCreateCollection = new CreateCollection(collectionRepositoryStub)
+
+    const actual = await testCreateCollection.execute(testCollectionDTO)
+
+    expect(actual).toEqual(undefined)
+  })
+
+  test('should return error result on repository error', async () => {
+    const collectionRepositoryStub: ICollectionsRepository = {} as ICollectionsRepository
+    collectionRepositoryStub.createCollection = jest.fn().mockRejectedValue(new WriteError())
+    const testCreateCollection = new CreateCollection(collectionRepositoryStub)
+
+    await expect(testCreateCollection.execute(testCollectionDTO)).rejects.toThrow(WriteError)
+  })
+})