Module: Bulkrax

Defined in:
app/models/bulkrax/import_failed.rb,
lib/bulkrax.rb,
lib/bulkrax/engine.rb,
lib/bulkrax/version.rb,
app/models/bulkrax/entry.rb,
app/models/bulkrax/status.rb,
app/models/bulkrax/exporter.rb,
app/models/bulkrax/importer.rb,
app/models/bulkrax/csv_entry.rb,
app/models/bulkrax/oai_entry.rb,
app/models/bulkrax/rdf_entry.rb,
app/models/bulkrax/xml_entry.rb,
app/jobs/bulkrax/exporter_job.rb,
app/jobs/bulkrax/importer_job.rb,
app/parsers/bulkrax/csv_parser.rb,
app/parsers/bulkrax/xml_parser.rb,
app/models/bulkrax/exporter_run.rb,
app/models/bulkrax/importer_run.rb,
app/models/bulkrax/oai_dc_entry.rb,
app/jobs/bulkrax/application_job.rb,
app/jobs/bulkrax/delete_work_job.rb,
app/jobs/bulkrax/export_work_job.rb,
app/jobs/bulkrax/import_work_job.rb,
app/matchers/bulkrax/csv_matcher.rb,
app/matchers/bulkrax/oai_matcher.rb,
app/models/bulkrax/oai_set_entry.rb,
app/parsers/bulkrax/bagit_parser.rb,
app/parsers/bulkrax/oai_dc_parser.rb,
app/matchers/bulkrax/bagit_matcher.rb,
app/controllers/concerns/bulkrax/api.rb,
app/factories/bulkrax/object_factory.rb,
app/helpers/bulkrax/exporters_helper.rb,
app/helpers/bulkrax/importers_helper.rb,
app/helpers/bulkrax/validation_helper.rb,
app/models/bulkrax/application_record.rb,
app/helpers/bulkrax/application_helper.rb,
app/mailers/bulkrax/application_mailer.rb,
app/parsers/bulkrax/application_parser.rb,
app/models/bulkrax/csv_collection_entry.rb,
app/models/bulkrax/rdf_collection_entry.rb,
app/models/concerns/bulkrax/status_info.rb,
app/jobs/bulkrax/child_relationships_job.rb,
app/jobs/bulkrax/download_cloud_file_job.rb,
app/matchers/bulkrax/application_matcher.rb,
app/models/concerns/bulkrax/file_factory.rb,
app/models/concerns/bulkrax/has_matchers.rb,
app/models/bulkrax/oai_qualified_dc_entry.rb,
app/controllers/bulkrax/entries_controller.rb,
app/jobs/bulkrax/import_work_collection_job.rb,
app/models/concerns/bulkrax/errored_entries.rb,
app/models/concerns/bulkrax/export_behavior.rb,
app/models/concerns/bulkrax/import_behavior.rb,
app/parsers/bulkrax/oai_qualified_dc_parser.rb,
app/controllers/bulkrax/exporters_controller.rb,
app/controllers/bulkrax/importers_controller.rb,
app/models/concerns/bulkrax/download_behavior.rb,
app/controllers/bulkrax/application_controller.rb,
app/models/concerns/bulkrax/has_local_processing.rb,
app/models/concerns/bulkrax/importer_exporter_behavior.rb

Overview

this is a PORO to help pass errors around

Defined Under Namespace

Modules: API, ApplicationHelper, DownloadBehavior, ErroredEntries, ExportBehavior, ExportersHelper, FileFactory, HasLocalProcessing, HasMatchers, ImportBehavior, ImporterExporterBehavior, ImportersHelper, StatusInfo, ValidationHelper Classes: ApplicationController, ApplicationJob, ApplicationMailer, ApplicationMatcher, ApplicationParser, ApplicationRecord, BagitMatcher, BagitParser, ChildRelationshipsJob, ChildWorksError, CollectionsCreatedError, CsvCollectionEntry, CsvEntry, CsvMatcher, CsvParser, DeleteWorkJob, DownloadCloudFileJob, Engine, EntriesController, Entry, ExportWorkJob, Exporter, ExporterJob, ExporterRun, ExportersController, ImportFailed, ImportWorkCollectionJob, ImportWorkJob, Importer, ImporterJob, ImporterRun, ImportersController, InstallGenerator, OAIError, OaiDcEntry, OaiDcParser, OaiEntry, OaiMatcher, OaiQualifiedDcEntry, OaiQualifiedDcParser, OaiSetEntry, ObjectFactory, RdfCollectionEntry, RdfEntry, Status, XmlEntry, XmlParser

Constant Summary collapse

VERSION =
'1.0.1'

Class Method Summary collapse

Class Method Details

.api_definitionObject



145
146
147
148
149
150
151
152
153
# File 'lib/bulkrax.rb', line 145

def self.api_definition
  @api_definition ||= ActiveSupport::HashWithIndifferentAccess.new(
    YAML.safe_load(
      ERB.new(
        File.read(Rails.root.join('config', 'bulkrax_api.yml'))
      ).result
    )
  )
end

.setup {|_self| ... } ⇒ Object

this function maps the vars from your app into your engine

Yields:

  • (_self)

Yield Parameters:

  • _self (Bulkrax)

    the object that the method was called on



158
159
160
# File 'lib/bulkrax.rb', line 158

def self.setup
  yield self
end