sra-exlibris v1.0.0

SRA-Exlibris-Request

This module is part of the Bond University Centre for Research in Evidence-Based Practice Systematic Review Assistant suite of tools.

This module forms the reference request tool.

var exlibrisRequest = require('sra-exlibis-request');

new sraExlibrisRequest()
	.set({
		exlibris: {
			apiKey: 'YOUR API KEY'
		},
		user: {
			email: 'someone@somewhere', // User making request
		},
	})
	.set('request.source', 'SRA') // Set some extra request fields
	.set('request.note', 'SRA')
	.set('validator', (ref, eref) => { // Custom validator code
		if (!ref.type) return 'No reference type specified';
		if (ref.type == 'book') {
			if (!eref.title) return 'Missing book title';
			if (!eref.journal) return 'Missing journal';
			eref.pickup_location = 'MAIN',
			eref.format = 'PHYSICAL';
			eref.citation_type = 'BK';
		}
		return true;
	})
	.requestAll(refs, function(err, res) { // Request a bunch of references (maybe use reflib - https://github.com/hash-bang/Reflib-Node - to read in a library?)
		expect(err).to.be.not.ok;
		done();
	})

See the testkits for more examples.

API

ExlibrisRequest (class)

The main ExlibrisRequest class is used to setup the instance with initial settings and provide an API.

Supported Settings:

Notes:

• The debug.execRequest flag is disabled by default. Set this to true to make the library submit requests, although you should test without this enabled first
• All functions are chainable

ExlibrisRequest.set(config, value)

Used to quickly set one or more config values. See the main constructor for a list of settings.

ExlibrisRequest
	.set('key1', 'value1')
	.set('key2', 'value2')
	.set('key3.subKey1', 'value3')

ExlibrisRequest.set({
	key1: 'value1',
	key2: 'value2',
	key3: {
		subKey1: 'value3',
	},
})

ExlibrisRequest.request(ref, options, cb)

Make a citation request to Exlibris.

The reference should be in the reflib format.

Options can be specified to override the defaults. Callback is optional.

ExlibrisRequest.requestAll(refs, options, cb)

Similar to request() but places requests in batch.

See the request function for details.

Events

The ExlibrisRequest instance can also fire events.