Merge pull request #32 from joenio/dataset-update

added `updateDataset(...)` to update metadata dataset

Author: tainguyenbui

README.md

@@ -61,6 +61,8 @@ http://demo.dataverse.org/api/datasets/389608/versions/1
 
 `public async publishDataset(datasetId: string, versionUpgradeType: DatasetVersionUpgradeType = DatasetVersionUpgradeType.MAJOR): Promise<AxiosResponse> {`
 
+`public async updateDataset(datasetId: string, datasetInformation: BasicDatasetInformation): Promise<AxiosResponse> {`
+
 `public async deleteDataset(datasetId: string): Promise<AxiosResponse> {`
 
 ## Build project
@@ -110,4 +112,4 @@ Automated publishing of versions could be automated when merging to master. Belo
 5. Publish, `npm publish`
 
 ## Contributing
-[If you are interested in contributing, please click here](/CONTRIBUTING.md)
+[If you are interested in contributing, please click here](/CONTRIBUTING.md)

src/dataverseClient.ts

@@ -173,6 +173,18 @@ export class DataverseClient {
     return this.postRequest(url, '')
   }
 
+  public async updateDataset(datasetId: string, datasetInformation: BasicDatasetInformation): Promise<AxiosResponse> {
+    const url = `${this.host}/api/datasets/:persistentId/versions/:draft?persistentId=${datasetId}`
+    const payload: any = DatasetUtil.mapBasicDatasetInformation(datasetInformation)
+
+    return this.putRequest(url, payload.datasetVersion, {
+      headers: {
+        ...this.getHeaders(),
+        'Content-Type': 'application/json'
+      }
+    })
+  }
+
   public async deleteDataset(datasetId: string): Promise<AxiosResponse> {
     const url = `${this.host}/api/datasets/:persistentId/destroy/?persistentId=${datasetId}`
     return this.deleteRequest(url)
@@ -190,6 +202,12 @@ export class DataverseClient {
     })
   }
 
+  private async putRequest(url: string, data: string | object, options: { params?: object, headers?: DataverseHeaders } = { headers: this.getHeaders() }): Promise<AxiosResponse> {
+    return await axios.put(url, JSON.stringify(data), options).catch(error => {
+      throw new DataverseException(error.response.status, error.response.data ? error.response.data.message : '')
+    })
+  }
+
   private async deleteRequest(url: string, options: { params?: object, headers?: DataverseHeaders, responseType?: ResponseType } = { headers: this.getHeaders() }): Promise<AxiosResponse> {
     return await axios.delete(url, options).catch(error => {
       throw new DataverseException(error.response.status, error.response.data ? error.response.data.message : '')
@@ -216,4 +234,4 @@ export class DataverseClient {
       fq: options.fq
     }
   }
-}
+}

test/dataverseClient.spec.ts

@@ -4,7 +4,7 @@ import { expect } from 'chai'
 import axios from 'axios'
 import request from 'request-promise'
 import path from 'path'
-import { internet, random, system } from 'faker'
+import { internet, random, system, name, date } from 'faker'
 import { DataverseException } from '../src/exceptions/dataverseException'
 import { DataverseMetricType } from '../src/@types/dataverseMetricType'
 import { DatasetSubjects } from '../src/@types/datasetSubjects'
@@ -27,6 +27,7 @@ describe('DataverseClient', () => {
 
   let axiosGetStub: SinonStub
   let axiosPostStub: SinonStub
+  let axiosPutStub: SinonStub
   let requestPostStub: SinonStub
   let axiosDeleteStub: SinonStub
 
@@ -63,6 +64,7 @@ describe('DataverseClient', () => {
 
     axiosGetStub = sandbox.stub(axios, 'get').resolves(mockResponse)
     axiosPostStub = sandbox.stub(axios, 'post').resolves(mockResponse)
+    axiosPutStub = sandbox.stub(axios, 'put').resolves(mockResponse)
     requestPostStub = sandbox.stub(request, 'post').resolves(mockResponse)
     axiosDeleteStub = sandbox.stub(axios, 'delete').resolves(mockResponse)
 
@@ -1485,6 +1487,34 @@ describe('DataverseClient', () => {
 
   })
 
+  describe('updateDataset()', () => {
+    it('should call axios with expected url', async () => {
+      const datasetId = random.number().toString()
+      const datasetInformation: BasicDatasetInformation = {
+        title: random.words(),
+        descriptions: [{ text: random.words(), date: date.recent().toString() }],
+        authors: [
+          {
+            fullname: name.findName()
+          }
+        ],
+        contact: [{ email: internet.email(), fullname: name.findName() }],
+        subject: [DatasetSubjects.AGRICULTURAL_SCIENCE]
+      }
+
+      await client.updateDataset(datasetId, datasetInformation)
+
+      assert.calledOnce(axiosPutStub)
+      const payload: any = DatasetUtil.mapBasicDatasetInformation(datasetInformation)
+      assert.calledWithExactly(axiosPutStub, `${host}/api/datasets/:persistentId/versions/:draft?persistentId=${datasetId}`, JSON.stringify(payload.datasetVersion), {
+        headers: {
+          'X-Dataverse-key': apiToken,
+          'Content-Type': 'application/json'
+        }
+      })
+    })
+  })
+
   describe('deleteDataset()', () => {
     it('should call axios with expected url', async () => {
       const datasetId: string = random.number().toString()