Merge pull request #19 from tainguyenbui/feature/HASI-000_allow_searching_only_published_data

HASI-000 allow searching only published data

Author: tainguyenbui

README.md

@@ -28,12 +28,18 @@ const response = await client.getDataverseInformation('myDataverseAlias')
 
 `public async search(options: SearchOptions): Promise<AxiosResponse> {`
 
+`public async searchOnlyPublished(options: SearchOptions): Promise<AxiosResponse> {`
+
 `public async getFile(fileId: string): Promise<AxiosResponse> {`
 
 `public async getFileMetadata(fileId: string, draftVersion: boolean = false): Promise<AxiosResponse> {`
 
 `public async getLatestDatasetInformation(datasetId: string): Promise<AxiosResponse> {`
 
+`public async getLatestPublishedDatasetVersion(datasetId: string): Promise<AxiosResponse> {`
+
+`public async getDraftDatasetVersion(datasetId: string): Promise<AxiosResponse> {`
+
 `public async getLatestDatasetInformationFromDOI(doi: string): Promise<AxiosResponse> {`
 
 `public async getDatasetVersions(datasetId: string): Promise<AxiosResponse> {`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-dataverse",
-  "version": "1.0.29",
+  "version": "1.0.32",
   "description": "A Dataverse module for JavaScript/TypeScript",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

src/@types/datasetVersionType.ts

@@ -0,0 +1,5 @@
+export enum DatasetVersionType {
+  LATEST_PUBLISHED = ':latest-published',
+  LATEST = ':latest',
+  DRAFT = ':draft'
+}

src/@types/dataverseHeaders.ts

@@ -1,4 +1,4 @@
 export interface DataverseHeaders {
-  'X-Dataverse-key': string,
+  'X-Dataverse-key'?: string,
   'Content-Type'?: string
 }

src/dataverseClient.ts

@@ -7,6 +7,7 @@ import { BasicDatasetInformation } from './@types/basicDataset'
 import { DatasetUtil } from './utils/datasetUtil'
 import request from 'request-promise'
 import { DatasetVersionUpgradeType } from './@types/datasetVersionUpgradeType'
+import { DatasetVersionType } from './@types/datasetVersionType'
 
 export class DataverseClient {
   private readonly host: string
@@ -44,10 +45,14 @@ export class DataverseClient {
     })
   }
 
-  public async search(options: SearchOptions): Promise<AxiosResponse> {
+  public async search(options: SearchOptions, headers: DataverseHeaders = this.getHeaders()): Promise<AxiosResponse> {
     const url = `${this.host}/api/search`
     const requestOptions: DataverseSearchOptions = this.mapSearchOptions(options)
-    return this.getRequest(url, { params: requestOptions })
+    return this.getRequest(url, { params: requestOptions, headers: headers })
+  }
+
+  public async searchOnlyPublished(options: SearchOptions): Promise<AxiosResponse> {
+    return this.search(options, {})
   }
 
   public async getFile(fileId: string): Promise<AxiosResponse> {
@@ -68,6 +73,14 @@ export class DataverseClient {
     return this.getRequest(url)
   }
 
+  public async getLatestPublishedDatasetVersion(datasetId: string): Promise<AxiosResponse> {
+    return this.getDatasetVersion(datasetId, DatasetVersionType.LATEST_PUBLISHED)
+  }
+
+  public async getDraftDatasetVersion(datasetId: string): Promise<AxiosResponse> {
+    return this.getDatasetVersion(datasetId, DatasetVersionType.DRAFT)
+  }
+
   public async getLatestDatasetInformationFromDOI(doi: string): Promise<AxiosResponse> {
     const url = `${this.host}/api/datasets/:persistentId?persistentId=doi:${doi}`
     return this.getRequest(url)

test/dataverseClient.spec.ts

@@ -1,4 +1,4 @@
-import { DataverseClient, DataverseSearchOptions, SearchType } from '../src/index'
+import { DataverseClient, DataverseSearchOptions, SearchOptions, SearchType } from '../src/index'
 import { assert, createSandbox, SinonSandbox, SinonStub } from 'sinon'
 import { expect } from 'chai'
 import axios from 'axios'
@@ -338,6 +338,31 @@ describe('DataverseClient', () => {
     })
   })
 
+  describe('searchOnlyPublished', () => {
+    let searchStub: SinonStub
+
+    beforeEach(() => {
+      searchStub = sandbox
+        .stub(DataverseClient.prototype, 'search')
+    })
+
+    it('should call search with expected options', async () => {
+      const mockQuery = random.word()
+      const type: SearchType = SearchType.DATASET
+      const mockDataverseAlias = random.word()
+      const expectedOptions: SearchOptions = {
+        query: mockQuery,
+        dataverseAlias: mockDataverseAlias,
+        type
+      }
+
+      await client.searchOnlyPublished({ query: mockQuery, type, dataverseAlias: mockDataverseAlias })
+
+      assert.calledOnce(searchStub)
+      assert.calledWithExactly(searchStub, expectedOptions, {})
+    })
+  })
+
   describe('search', () => {
     it('should call axios with expected url and options', async () => {
       const query = random.word()
@@ -357,7 +382,10 @@ describe('DataverseClient', () => {
 
       assert.calledOnce(axiosGetStub)
       assert.calledWithExactly(axiosGetStub, `${host}/api/search`, {
-        params: expectedOptions
+        params: expectedOptions,
+        headers: {
+          'X-Dataverse-key': apiToken
+        }
       })
     })
 
@@ -614,6 +642,43 @@ describe('DataverseClient', () => {
     })
   })
 
+  describe('getLatestPublishedDatasetVersion', () => {
+    let mockDatasetId: string
+
+    let getDatasetVersionStub: SinonStub
+
+    beforeEach(() => {
+      mockDatasetId = random.number().toString()
+      getDatasetVersionStub = sandbox.stub(DataverseClient.prototype, 'getDatasetVersion')
+    })
+
+    it('should call get dataset version with expected input', async () => {
+      await client.getLatestPublishedDatasetVersion(mockDatasetId)
+
+      assert.calledOnce(getDatasetVersionStub)
+      assert.calledWithExactly(getDatasetVersionStub, mockDatasetId, ':latest-published')
+    })
+  })
+
+  describe('getDraftDatasetVersion', () => {
+    let mockDatasetId: string
+
+    let getDatasetVersionStub: SinonStub
+
+    beforeEach(() => {
+      mockDatasetId = random.number().toString()
+
+      getDatasetVersionStub = sandbox.stub(DataverseClient.prototype, 'getDatasetVersion')
+    })
+
+    it('should call get dataset version with expected input', async () => {
+      await client.getDraftDatasetVersion(mockDatasetId)
+
+      assert.calledOnce(getDatasetVersionStub)
+      assert.calledWithExactly(getDatasetVersionStub, mockDatasetId, ':draft')
+    })
+  })
+
   describe('getLatestDatasetInformationFromDOI', () => {
     let doi: string