Module: SdrClient::Deposit

Defined in:
lib/sdr_client/deposit.rb,
lib/sdr_client/deposit/file.rb,
lib/sdr_client/deposit/process.rb,
lib/sdr_client/deposit/request.rb,
lib/sdr_client/deposit/file_set.rb,
lib/sdr_client/deposit/upload_files.rb,
lib/sdr_client/deposit/model_process.rb,
lib/sdr_client/deposit/create_resource.rb,
lib/sdr_client/deposit/update_resource.rb,
lib/sdr_client/deposit/metadata_builder.rb,
lib/sdr_client/deposit/file_metadata_builder.rb,
lib/sdr_client/deposit/image_file_set_strategy.rb,
lib/sdr_client/deposit/file_type_file_set_strategy.rb,
lib/sdr_client/deposit/files/direct_upload_request.rb,
lib/sdr_client/deposit/files/direct_upload_response.rb,
lib/sdr_client/deposit/single_file_grouping_strategy.rb,
lib/sdr_client/deposit/upload_files_metadata_builder.rb,
lib/sdr_client/deposit/matching_file_grouping_strategy.rb,
lib/sdr_client/deposit/update_dro_with_file_identifiers.rb,
lib/sdr_client/deposit/file_metadata_builder_operations/md5.rb,
lib/sdr_client/deposit/file_metadata_builder_operations/sha1.rb,
lib/sdr_client/deposit/file_metadata_builder_operations/mime_type.rb

Overview

The namespace for the “deposit” command

Defined Under Namespace

Modules: FileMetadataBuilderOperations, Files Classes: CreateResource, File, FileMetadataBuilder, FileSet, FileTypeFileSetStrategy, ImageFileSetStrategy, MatchingFileGroupingStrategy, MetadataBuilder, ModelProcess, Process, Request, SingleFileGroupingStrategy, UpdateDroWithFileIdentifiers, UpdateResource, UploadFiles, UploadFilesMetadataBuilder

Constant Summary collapse

BOOK_TYPE = 
Cocina::Models::ObjectType.book

Class Method Summary collapse

Class Method Details

.model_run(request_dro:, files: [], basepath: Dir.getwd, url:, accession:, priority: nil, logger: Logger.new($stdout)) ⇒ Object

Parameters:

  • files (Array<String>) (defaults to: []) —

    relative paths to files



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/sdr_client/deposit.rb', line 70

def self.model_run(request_dro:,
                   files: [],
                   basepath: Dir.getwd,
                   url:,
                   accession:,
                   priority: nil,
                   logger: Logger.new($stdout))
  connection = Connection.new(url: url)
  ModelProcess.new(request_dro: request_dro,
                   connection: connection,
                   files: files,
                   basepath: basepath,
                   logger: logger,
                   accession: accession,
                   priority: priority).run
end

.run(label: nil, type: BOOK_TYPE, viewing_direction: nil, view: 'dark', download: 'none', use_and_reproduction: nil, copyright: nil, apo:, collection: nil, catkey: nil, embargo_release_date: nil, embargo_access: 'world', embargo_download: 'world', source_id:, url:, files: [], files_metadata: {}, basepath: Dir.getwd, accession: false, priority: nil, grouping_strategy: SingleFileGroupingStrategy, file_set_type_strategy: FileTypeFileSetStrategy, logger: Logger.new($stdout)) ⇒ String

rubocop:disable Metrics/ParameterLists rubocop:disable Metrics/MethodLength params [Array<String>] files a list of relative filepaths to upload params [String] basepath filepath to which filepaths are relative, defaults to current directory params [Hash<String,Hash>] file_metadata relative filepath, hash of metadata per-file metadata

Returns:

  • (String) —

    job id for the background job result



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/sdr_client/deposit.rb', line 15

def self.run(label: nil,
             type: BOOK_TYPE,
             viewing_direction: nil,
             view: 'dark',
             download: 'none',
             use_and_reproduction: nil,
             copyright: nil,
             apo:,
             collection: nil,
             catkey: nil,
             embargo_release_date: nil,
             embargo_access: 'world',
             embargo_download: 'world',
             source_id:,
             url:,
             files: [],
             files_metadata: {},
             basepath: Dir.getwd,
             accession: false,
             priority: nil,
             grouping_strategy: SingleFileGroupingStrategy,
             file_set_type_strategy: FileTypeFileSetStrategy,
             logger: Logger.new($stdout))
  # augmented_metadata is a map of relative filepaths to file metadata
  augmented_metadata = FileMetadataBuilder.build(files: files, files_metadata: files_metadata, basepath: basepath)
  request = Request.new(label: label,
                        type: type,
                        view: view,
                        download: download,
                        apo: apo,
                        use_and_reproduction: use_and_reproduction,
                        copyright: copyright,
                        collection: collection,
                        source_id: source_id,
                        catkey: catkey,
                        embargo_release_date: embargo_release_date,
                        embargo_access: embargo_access,
                        embargo_download: embargo_download,
                        viewing_direction: viewing_direction,
                        files_metadata: augmented_metadata)
  connection = Connection.new(url: url)
  Process.new(metadata: request,
              connection: connection,
              files: files,
              basepath: basepath,
              grouping_strategy: grouping_strategy,
              file_set_type_strategy: file_set_type_strategy,
              accession: accession,
              priority: priority,
              logger: logger).run
end