Zizia

Object import for Hyrax.

Usage

In your project's Gemfile, add: gem 'zizia', then run bundle install.

Add the engine to routes.rb:

  mount Zizia::Engine => '/'

Add the helpers to the ApplicationController

helper Zizia::Engine.helpers

Give admin users permission to import in your Ability.custom_permissions:

    can :manage, Zizia::CsvImport if current_user.admin?
    can :manage, Zizia::CsvImportDetail if current_user.admin?

Add links to /csv_imports/new and /importer_documentation/csv in the Hyrax dashboard.
In your Rails application's application.css and application.js include Zizia's assets:

 *= require zizia/application

Run rake db:migrate

The spec/dummy folder in this application is a complete Hyrax application with Zizia installed. You can use that as an example for adding this to your current Hyrax application or copy that to create a new application with Zizia installed.

To do a basic Hyrax import, first ensure that a work type is registered with your Hyrax application. Then write a class like this:

require 'zizia'

class MyImporter
  def initialize(csv_file)
    @csv_file = csv_file
    raise "Cannot find expected input file #{csv_file}" unless File.exist?(csv_file)
  end

  def import
    attrs = {
      collection_id: collection_id,     # pass a collection id to the record importer and all records will be added to that collection
      depositor_id: depositor_id,       # pass a Hyrax user_key here and that Hyrax user will own all objects created during this import
      deduplication_field: 'identifier' # pass a field with a persistent identifier (e.g., ARK) and it will check to see if a record with that identifier already
    }                                   # exists, update its metadata if so, and only if it doesn't find a record with that identifier will it make a new object.

    file = File.open(@csv_file)
    parser = Zizia::CsvParser.new(file: file)
    record_importer = Zizia::HyraxRecordImporter.new(attributes: attrs)
    Zizia::Importer.new(parser: parser, record_importer: record_importer).import
    file.close # unless a block is passed to File.open, the file must be explicitly closed
  end
end

You can find an example csv file for import to Hyrax in the fixtures directory. Files for attachment should have the filename in a column with a heading of files, and the location of the files should be specified via an environment variables called IMPORT_PATH. If IMPORT_PATH is not set, HyraxRecordImporter will look in /opt/data by default.

Customizing

To input any kind of file other than CSV, you need to provide a Parser (out of the box, we support simple CSV import with CsvParser). We will be writing guides about how to support custom mappers (for metadata outside of Hyrax's core and basic metadata fields).

Development

git clone https://github.com/curationexperts/zizia
cd zizia

bundle install
bundle exec rake ci

MaggieZhaoYale/zizia

Zizia

Usage

Customizing

Development