Preservation Gem Version GitPitch

Extraction and Transformation for Loading by Archivematica's Automation Tools.

Installation

Add this line to your application's Gemfile:

gem 'preservation'

And then execute:

$ bundle

Or install it yourself as:

$ gem install preservation

Usage

Configuration

Configure Preservation. If log_path is omitted, logging (standard library) writes to STDOUT.

Preservation.configure do |config|
  config.db_path     = ENV['ARCHIVEMATICA_DB_PATH']
  config.ingest_path = ENV['ARCHIVEMATICA_INGEST_PATH']
  config.log_path    = ENV['PRESERVATION_LOG_PATH']
end

Transfer

Create a transfer using the Pure Research Information System as a data source.

transfer = Preservation::Transfer::Pure.new base_url:   ENV['PURE_BASE_URL'],
                                            username:   ENV['PURE_USERNAME'],
                                            password:   ENV['PURE_PASSWORD'],
                                            basic_auth: true

For a Pure dataset, if necessary, fetch the metadata, prepare a directory in the ingest path and populate it with the files and JSON description file.

transfer.prepare_dataset uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'

Free up disk space for completed transfers. Can be done at any time.

Preservation::Storage.cleanup

Report

Can be used for scheduled monitoring of transfers.

Preservation::Report::Transfer.exception

Documentation

API in YARD

Detailed usage in GitBook