added updateDataset(...) to update metadata dataset

This new method make a request to the following address:

* PUT /api/datasets/:persistentId/versions/:draft?persistentId=$datasetId
* The body request should be a json with dataset metadata like as
  in addBasicDataset()

This Dataverse API endpoint let ordinary users to update or replace dataset
metadata. If the dataset is in a DRAFT state then the metadata will be
replaced, if the dataset already in a published state then a new DRAFT version
will be created.

See Dataverse API specs for details:

* https://guides.dataverse.org/en/latest/api/native-api.html#update-metadata-for-a-dataset

Author: joenio

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> {`
+
 ## Build project
 
 In order to build the project, we need to run the following command:

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'
+      }
+    })
+  }
+
   private async getRequest(url: string, options: { params?: object, headers?: DataverseHeaders, responseType?: ResponseType } = { headers: this.getHeaders() }): Promise<AxiosResponse> {
     return await axios.get(url, options).catch(error => {
       throw new DataverseException(error.response.status, error.response.data ? error.response.data.message : '')
@@ -185,6 +197,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 getHeaders(): DataverseHeaders {
     return {
       'X-Dataverse-key': this.apiToken ? this.apiToken : ''

test/dataverseClient.spec.ts

@@ -27,6 +27,7 @@ describe('DataverseClient', () => {
 
   let axiosGetStub: SinonStub
   let axiosPostStub: SinonStub
+  let axiosPutStub: SinonStub
   let requestPostStub: SinonStub
 
   let mapBasicDatasetInformationStub: SinonStub
@@ -62,6 +63,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)
 
     mapBasicDatasetInformationStub = sandbox.stub(DatasetUtil, 'mapBasicDatasetInformation').returns(mockDatasetInformation)
@@ -1481,4 +1483,31 @@ describe('DataverseClient', () => {
       })
     })
   })
-})
+
+  describe('updateDataset()', () => {
+    it('should call axios with expected url', async () => {
+      const datasetId = random.number().toString()
+      const datasetInformation: BasicDatasetInformation = {
+        title: 's',
+        descriptions: [{ text: 'some ', date: '2019-09-09' }],
+        authors: [
+          {
+            fullname: 'tester tests'
+          }
+        ],
+        contact: [{ email: 'tai@theagilemonkeys.com', fullname: 'Tai Nguyen' }],
+        subject: [DatasetSubjects.AGRICULTURAL_SCIENCE]
+      }
+
+      await client.updateDataset(datasetId, datasetInformation)
+
+      assert.calledOnce(axiosPutStub)
+      assert.calledWithExactly(axiosPutStub, `${host}/api/datasets/:persistentId/versions/:draft?persistentId=${datasetId}`, {
+        headers: {
+          'X-Dataverse-key': apiToken,
+          'Content-Type': 'application/json'
+        }
+      })
+    })
+  })
+})