Merge pull request #358 from IQSS/get-licenses

Use Case for Getting Available Licenses Terms

Author: ofahimIQSS

docs/useCases.md

@@ -89,6 +89,8 @@ The different use cases currently available in the package are classified below,
   - [Get Maximum Embargo Duration In Months](#get-maximum-embargo-duration-in-months)
   - [Get ZIP Download Limit](#get-zip-download-limit)
   - [Get Application Terms of Use](#get-application-terms-of-use)
+- [Licenses](#Licenses)
+  - [Get Available Standard License Terms](#get-available-standard-license-terms)
 - [Contact](#Contact)
   - [Send Feedback to Object Contacts](#send-feedback-to-object-contacts)
 - [Notifications](#Notifications)
@@ -2089,6 +2091,26 @@ getApplicationTermsOfUse.execute().then((termsOfUse: string) => {
 
 _See [use case](../src/info/domain/useCases/GetApplicationTermsOfUse.ts) implementation_.
 
+## Licenses
+
+### Get Available Standard License Terms
+
+Returns a list of available standard licenses that can be selected for a dataset.
+
+##### Example call:
+
+```typescript
+import { getAvailableStandardLicenses, License } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getAvailableStandardLicenses.execute().then((licenses: License[]) => {
+  /* ... */
+})
+```
+
+_See [use case](../src/licenses/domain/useCases/GetAvailableStandardLicenses.ts) implementation_.
+
 ## Contact
 
 #### Send Feedback to Object Contacts

src/index.ts

@@ -10,3 +10,4 @@ export * from './files'
 export * from './contactInfo'
 export * from './notifications'
 export * from './search'
+export * from './licenses'

src/licenses/domain/models/License.ts

@@ -0,0 +1,14 @@
+export interface License {
+  id: number
+  name: string
+  shortDescription?: string
+  uri: string
+  iconUri?: string
+  active: boolean
+  isDefault: boolean
+  sortOrder: number
+  rightsIdentifier?: string
+  rightsIdentifierScheme?: string
+  schemeUri?: string
+  languageCode?: string
+}

src/licenses/domain/repositories/ILicensesRepository.ts

@@ -0,0 +1,5 @@
+import { License } from '../models/License'
+
+export interface ILicensesRepository {
+  getAvailableStandardLicenses(): Promise<License[]>
+}

src/licenses/domain/repositories/transformers/LicensePayload.ts

@@ -0,0 +1,14 @@
+export interface LicensePayload {
+  id: number
+  name: string
+  shortDescription?: string
+  uri: string
+  iconUrl?: string
+  active: boolean
+  isDefault: boolean
+  sortOrder: number
+  rightsIdentifier?: string
+  rightsIdentifierScheme?: string
+  schemeUri?: string
+  languageCode?: string
+}

src/licenses/domain/repositories/transformers/licenseTransformers.ts

@@ -0,0 +1,22 @@
+import { AxiosResponse } from 'axios'
+import { License } from '../../models/License'
+import { LicensePayload } from './LicensePayload'
+
+export const transformPayloadToLicense = (response: AxiosResponse): License[] => {
+  const payload = response.data.data as LicensePayload[]
+
+  return payload.map((license: LicensePayload) => ({
+    id: license.id,
+    name: license.name,
+    shortDescription: license.shortDescription,
+    uri: license.uri,
+    iconUri: license.iconUrl, // in payload, it is called iconUrl, but iconUri is the name matching everywhere else
+    active: license.active,
+    isDefault: license.isDefault,
+    sortOrder: license.sortOrder,
+    rightsIdentifier: license.rightsIdentifier,
+    rightsIdentifierScheme: license.rightsIdentifierScheme,
+    schemeUri: license.schemeUri,
+    languageCode: license.languageCode
+  }))
+}

src/licenses/domain/useCases/GetAvailableStandardLicenses.ts

@@ -0,0 +1,20 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { License } from '../models/License'
+import { ILicensesRepository } from '../repositories/ILicensesRepository'
+
+export class GetAvailableStandardLicenses implements UseCase<License[]> {
+  private licensesRepository: ILicensesRepository
+
+  constructor(licensesRepository: ILicensesRepository) {
+    this.licensesRepository = licensesRepository
+  }
+
+  /**
+   * Returns the list of available standard license terms that can be selected for a dataset.
+   *
+   * @returns {Promise<License[]>}
+   */
+  async execute(): Promise<License[]> {
+    return await this.licensesRepository.getAvailableStandardLicenses()
+  }
+}

src/licenses/index.ts

@@ -0,0 +1,10 @@
+import { LicensesRepository } from './infra/repositories/LicensesRepository'
+import { GetAvailableStandardLicenses } from './domain/useCases/GetAvailableStandardLicenses'
+
+const licensesRepository = new LicensesRepository()
+
+const getAvailableStandardLicenses = new GetAvailableStandardLicenses(licensesRepository)
+
+export { getAvailableStandardLicenses }
+
+export { License } from './domain/models/License'

src/licenses/infra/repositories/LicensesRepository.ts

@@ -0,0 +1,15 @@
+import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
+import { ILicensesRepository } from '../../domain/repositories/ILicensesRepository'
+import { License } from '../../domain/models/License'
+
+export class LicensesRepository extends ApiRepository implements ILicensesRepository {
+  private readonly licensesResourceName: string = 'licenses'
+
+  public async getAvailableStandardLicenses(): Promise<License[]> {
+    return this.doGet(this.buildApiEndpoint(this.licensesResourceName))
+      .then((response) => response.data.data)
+      .catch((error) => {
+        throw error
+      })
+  }
+}

test/functional/licenses/GetAvailableStandardLicenses.test.ts

@@ -0,0 +1,51 @@
+import { ApiConfig, getAvailableStandardLicenses, License } from '../../../src'
+import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
+import { TestConstants } from '../../testHelpers/TestConstants'
+
+describe('getAvailableStandardLicenses', () => {
+  describe('execute', () => {
+    beforeAll(async () => {
+      ApiConfig.init(
+        TestConstants.TEST_API_URL,
+        DataverseApiAuthMechanism.API_KEY,
+        process.env.TEST_API_KEY
+      )
+    })
+
+    test('should return available standard license terms', async () => {
+      const actualLicenses: License[] = await getAvailableStandardLicenses.execute()
+      const expectedLicenses = [
+        {
+          id: 1,
+          name: 'CC0 1.0',
+          shortDescription: 'Creative Commons CC0 1.0 Universal Public Domain Dedication.',
+          uri: 'http://creativecommons.org/publicdomain/zero/1.0',
+          iconUrl: 'https://licensebuttons.net/p/zero/1.0/88x31.png',
+          active: true,
+          isDefault: true,
+          sortOrder: 0,
+          rightsIdentifier: 'CC0-1.0',
+          rightsIdentifierScheme: 'SPDX',
+          schemeUri: 'https://spdx.org/licenses/',
+          languageCode: 'en'
+        },
+        {
+          id: 2,
+          name: 'CC BY 4.0',
+          shortDescription: 'Creative Commons Attribution 4.0 International License.',
+          uri: 'http://creativecommons.org/licenses/by/4.0',
+          iconUrl: 'https://licensebuttons.net/l/by/4.0/88x31.png',
+          active: true,
+          isDefault: false,
+          sortOrder: 2,
+          rightsIdentifier: 'CC-BY-4.0',
+          rightsIdentifierScheme: 'SPDX',
+          schemeUri: 'https://spdx.org/licenses/',
+          languageCode: 'en'
+        }
+      ]
+
+      expect(actualLicenses).toEqual(expectedLicenses)
+    })
+  })
+})