Merge branch 'master' into dataset-update

Conflicts:
README.md
src/dataverseClient.ts
test/dataverseClient.spec.ts

Author: joenio

README.md

@@ -63,6 +63,8 @@ http://demo.dataverse.org/api/datasets/389608/versions/1
 
 `public async updateDataset(datasetId: string, datasetInformation: BasicDatasetInformation): Promise<AxiosResponse> {`
 
+`public async deleteDataset(datasetId: string): Promise<AxiosResponse> {`
+
 ## Build project
 
 In order to build the project, we need to run the following command:
@@ -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

@@ -185,6 +185,11 @@ export class DataverseClient {
     })
   }
 
+  public async deleteDataset(datasetId: string): Promise<AxiosResponse> {
+    const url = `${this.host}/api/datasets/:persistentId/destroy/?persistentId=${datasetId}`
+    return this.deleteRequest(url)
+  }
+
   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 : '')
@@ -203,6 +208,12 @@ export class DataverseClient {
     })
   }
 
+  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 : '')
+    })
+  }
+
   private getHeaders(): DataverseHeaders {
     return {
       'X-Dataverse-key': this.apiToken ? this.apiToken : ''
@@ -223,4 +234,4 @@ export class DataverseClient {
       fq: options.fq
     }
   }
-}
+}

test/dataverseClient.spec.ts

@@ -29,6 +29,7 @@ describe('DataverseClient', () => {
   let axiosPostStub: SinonStub
   let axiosPutStub: SinonStub
   let requestPostStub: SinonStub
+  let axiosDeleteStub: SinonStub
 
   let mapBasicDatasetInformationStub: SinonStub
   let getErrorMessageStub: SinonStub
@@ -65,6 +66,7 @@ describe('DataverseClient', () => {
     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)
 
     mapBasicDatasetInformationStub = sandbox.stub(DatasetUtil, 'mapBasicDatasetInformation').returns(mockDatasetInformation)
     getErrorMessageStub = sandbox.stub(ResponseUtil, 'getErrorMessage').returns(mockErrorMessage)
@@ -1482,6 +1484,7 @@ describe('DataverseClient', () => {
         expect(error.errorCode).to.be.equal(errorCode)
       })
     })
+
   })
 
   describe('updateDataset()', () => {
@@ -1511,4 +1514,16 @@ describe('DataverseClient', () => {
       })
     })
   })
+
+  describe('deleteDataset()', () => {
+    it('should call axios with expected url', async () => {
+      const datasetId: string = random.number().toString()
+
+      await client.deleteDataset(datasetId)
+
+      assert.calledOnce(axiosDeleteStub)
+      assert.calledWithExactly(axiosDeleteStub, `${host}/api/datasets/:persistentId/destroy/?persistentId=${datasetId}`, { headers: { 'X-Dataverse-key': apiToken } })
+    })
+  })
+
 })