Merge pull request #33 from joenio/get-dataset-files

added `getDatasetFiles($datasetId)` to download files

Author: tainguyenbui

README.md

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

src/dataverseClient.ts

@@ -190,6 +190,14 @@ export class DataverseClient {
     return this.deleteRequest(url)
   }
 
+  public async getDatasetFiles(datasetId: string): Promise<AxiosResponse> {
+    const url = `${this.host}/api/access/dataset/:persistentId/?persistentId=${datasetId}`
+    return this.getRequest(url, {
+      headers: this.getHeaders(),
+      responseType: 'arraybuffer'
+    })
+  }
+
   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 : '')

test/dataverseClient.spec.ts

@@ -1526,4 +1526,18 @@ describe('DataverseClient', () => {
     })
   })
 
+  describe('getDatasetFiles()', () => {
+    it('should call axios with expected url', async () => {
+      const datasetId: string = random.number.toString()
+
+      await client.getDatasetFiles(datasetId)
+
+      assert.calledOnce(axiosGetStub)
+      assert.calledWithExactly(axiosGetStub, `${host}/api/access/dataset/:persistentId/?persistentId=${datasetId}`, {
+        headers: { 'X-Dataverse-key': apiToken },
+        responseType: 'arraybuffer'
+      })
+    })
+  })
+
 })