DOI Extractor

Use

The DOI Extractor is a command line tool for generating, submitting, downloading, and packaging a set of extracts for DOI archival. It currently supports 4 commands: cancel, create, download, and status.

Cancel

Cancels a submitted DOI extract group. Will fail all associated pending extracts.

Create

Creates a new DOI extract group and its associated extracts, then submits them. Optionally takes an email address and will send a notification when all extracts are ready to download.

Download

Once all extracts for a DOI group are complete, this command will download and package them.

Status

Prints summary information about recent DOI extracts or detailed information about a particular extract

Further Information

See doi_extractor <COMMAND> --help for more detailed options.

Examples

Create and submit a new DOI extract group for USA

doi_extractor create -p usa -v 6.5 -E delbert@umn.edu

Check the status of a submitted extract group

doi_extractor status -p usa -i 5

Download the completed extracts to the default location

doi_extractor download -p usa -i 5

Deployment

The DOI Extractor is a gem that gets installed to the shared jruby environment (/pkg/mpctools/jruby).

It may be deployed using capistrano: cap production deploy

Ruby Version Notes

This gem uses capistrano 3.8, which is not supported under jruby 1.7. For deployment, use a modern ruby (MRI works fine).

The CI build uses jruby to ensure the Gemfile is valid in that env and that all specs pass.