sdr-client 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e8f69b9d4d664873ab3b08a6bc148fdf79e899f225ae31e745601f71fb7a183
-  data.tar.gz: 673b32c6e7358680608d583eae9ca57aafa464d8ce968b920f0b3b2adb36eac0
+  metadata.gz: '0578c4fbb93d5b8118a9d55f9751f1b50b633d15405411a31b8a4376b3d2f297'
+  data.tar.gz: 0bc45cbbe780f1e386685bca4cd500ca8ed8b227ddd0377c290c36b918a5dd96
 SHA512:
-  metadata.gz: ce3d3f552e3e70d1e078f1f21f684635719f8437252673c5eb100f69bcf86a8db2c36596eb0770415e77f46c95f3b48c544b5fe409c604875b45284cbda69480
-  data.tar.gz: fa511f36501e0ec134aa383615d3cc21a3d5d2b3944eae18add53feb8fa9049c49e83f2da58bfc2053b0f8149eac48ba8442172740a6b2adc250cdbca3cd390e
+  metadata.gz: 8cc065044b53e035c4eb73901ab635684c8b956ec280713ad50293e410a6525c5d15d274acaf7cf266f3a7f31a77309c85a9067449f03885ca1abde0b0e4d53a
+  data.tar.gz: 7a03cfd0cbf6a48e2fea9c71fb587c74e58b624a6ce1a299c55534c7fce9043d0a4dd0c4682f914ad54b4074bf4fda4ee95e3c70ac3d17d77d0b0a6c9a786bf0

data/README.md

@@ -27,3 +27,12 @@ sdr --service-url https://sdr-api-server:3000 deposit --label 'hey there' \
   --collection 'druid:gh456kw9876' \
   --source-id 'googlebooks:stanford_12345' file1.png file2.png
 ```
+
+Deposit a new object, providing metadata for files:
+```
+sdr --service-url https://sdr-api-server:3000 deposit --label 'hey there' \
+  --files-metadata '{"image42.jp2":{"mime_type":"image/jp2"},"ocr.html":{"use":"transcription"}}'
+  --admin-policy 'druid:bk123gh4567' \
+  --collection 'druid:gh456kw9876' \
+  --source-id 'googlebooks:stanford_12345' image42.jp2 ocr.html
+```

data/exe/sdr

@@ -49,6 +49,7 @@ subcommands = {
     opts.on('--admin-policy ADMIN_POLICY', 'The druid identifier of the admin policy object') do |apo|
       options[:apo] = apo
     end
+
     opts.on('--collection COLLECTION', 'The druid identifier of the collection object') do |collection|
       options[:collection] = collection
     end
@@ -61,6 +62,10 @@ subcommands = {
       options[:source_id] = source_id
     end
 
+    opts.on('--files-metadata FILES_METADATA', 'A JSON object representing per-file metadata') do |files_metadata|
+      options[:files_metadata] = JSON.parse(files_metadata)
+    end
+
     opts.on('--strategy STRATEGY',
             'The strategy to use for distributing files into filesets. Either "default" or "filename"') do |strategy|
       strategy_class = case strategy

data/lib/sdr_client/deposit.rb

@@ -24,9 +24,10 @@ module SdrClient
                              apo: apo,
                              collection: collection,
                              source_id: source_id,
-                             catkey: catkey)
+                             catkey: catkey,
+                             files_metadata: files_metadata)
       Process.new(metadata: metadata, url: url, token: token, files: files,
-                  files_metadata: files_metadata, grouping_strategy: grouping_strategy, logger: logger).run
+                  grouping_strategy: grouping_strategy, logger: logger).run
     end
     # rubocop:enable Metrics/ParameterLists
   end

data/lib/sdr_client/deposit/file.rb

@@ -7,7 +7,7 @@ module SdrClient
       # rubocop:disable Metrics/ParameterLists
       def initialize(external_identifier:, label:, filename:,
                      access: 'dark', preserve: false, shelve: false,
-                     mime_type: nil, md5: nil, sha1: nil)
+                     mime_type: nil, md5: nil, sha1: nil, use: nil)
         @external_identifier = external_identifier
         @label = label
         @filename = filename
@@ -17,6 +17,7 @@ module SdrClient
         @mime_type = mime_type
         @md5 = md5
         @sha1 = sha1
+        @use = use
       end
       # rubocop:enable Metrics/ParameterLists
 
@@ -37,6 +38,7 @@ module SdrClient
         }.tap do |json|
           json['hasMessageDigests'] = message_digests unless message_digests.empty?
           json['hasMimeType'] = @mime_type if @mime_type
+          json['use'] = @use if @use
         end
       end
       # rubocop:enable Metrics/MethodLength

data/lib/sdr_client/deposit/file_set.rb

@@ -4,6 +4,10 @@ module SdrClient
   module Deposit
     # This represents the FileSet metadata that we send to the server for doing a deposit
     class FileSet
+      # @param [Array] uploads
+      # @param [Hash<String,Hash<String,String>>] the file level metadata
+      # @param [Array] files
+      # @param [String] label
       def initialize(uploads: [], uploads_metadata: {}, files: [], label:)
         @label = label
         @files = if !uploads.empty?
@@ -29,6 +33,8 @@ module SdrClient
 
       attr_reader :files, :label
 
+      # This creates the metadata for each file and symbolizes the keys
+      # @return [Hash<Symbol,String>]
       def file_args(upload, upload_metadata)
         args = {
           external_identifier: upload.signed_id,

data/lib/sdr_client/deposit/metadata_builder.rb

@@ -8,14 +8,12 @@ module SdrClient
     class MetadataBuilder
       # @param [Request] metadata information about the object
       # @param [Class] grouping_strategy class whose run method groups an array of uploads
-      # @param [Hash<String, Hash<String, String>>] files_metadata file name, hash of additional file metadata
       # Additional metadata includes access, preserve, shelve, md5, sha1
       # @param [Logger] logger the logger to use
-      def initialize(metadata:, grouping_strategy:, files_metadata:, logger:)
+      def initialize(metadata:, grouping_strategy:, logger:)
         @metadata = metadata
         @logger = logger
         @grouping_strategy = grouping_strategy
-        @files_metadata = files_metadata
       end
 
       def with_uploads(upload_responses)
@@ -25,7 +23,7 @@ module SdrClient
 
       private
 
-      attr_reader :metadata, :files, :logger, :grouping_strategy, :files_metadata
+      attr_reader :metadata, :files, :logger, :grouping_strategy
 
       # @param [Array<SdrClient::Deposit::Files::DirectUploadResponse>] uploads the uploaded files to attach.
       # @return [Array<SdrClient::Deposit::FileSet>] the uploads transformed to filesets
@@ -33,7 +31,7 @@ module SdrClient
         grouped_uploads = grouping_strategy.run(uploads: uploads)
         grouped_uploads.map.with_index(1) do |upload_group, i|
           metadata_group = {}
-          upload_group.each { |upload| metadata_group[upload.filename] = files_metadata.fetch(upload.filename, {}) }
+          upload_group.each { |upload| metadata_group[upload.filename] = metadata.for(upload.filename) }
           FileSet.new(uploads: upload_group, uploads_metadata: metadata_group, label: "Object #{i}")
         end
       end

data/lib/sdr_client/deposit/process.rb

@@ -12,29 +12,27 @@ module SdrClient
       # @param [String] url the server to send to
       # @param [String] token the bearer auth token for the server
       # @param [Array<String>] files a list of file names to upload
-      # @param [Hash<String, Hash<String, String>>] files_metadata file name, hash of additional file metadata
-      # Additional metadata includes access, preserve, shelve, md5, sha1
       # @param [Logger] logger the logger to use
       # rubocop:disable Metrics/ParameterLists
       def initialize(metadata:, grouping_strategy: SingleFileGroupingStrategy, url:,
-                     token:, files: [], files_metadata: {}, logger: Logger.new(STDOUT))
+                     token:, files: [], logger: Logger.new(STDOUT))
         @files = files
         @url = url
         @token = token
         @metadata = metadata
         @logger = logger
         @grouping_strategy = grouping_strategy
-        @files_metadata = files_metadata
       end
       # rubocop:enable Metrics/ParameterLists
 
       def run
         check_files_exist
-        upload_responses = UploadFiles.new(files: files, logger: logger,
-                                           connection: connection, files_metadata: files_metadata).run
+        upload_responses = UploadFiles.new(files: files,
+                                           logger: logger,
+                                           connection: connection,
+                                           metadata: metadata).run
         metadata_builder = MetadataBuilder.new(metadata: metadata,
                                                grouping_strategy: grouping_strategy,
-                                               files_metadata: files_metadata,
                                                logger: logger)
         request = metadata_builder.with_uploads(upload_responses)
         upload_metadata(request.as_json)
@@ -42,7 +40,7 @@ module SdrClient
 
       private
 
-      attr_reader :metadata, :files, :url, :token, :logger, :grouping_strategy, :files_metadata
+      attr_reader :metadata, :files, :url, :token, :logger, :grouping_strategy
 
       def check_files_exist
         logger.info('checking to see if files exist')
@@ -76,22 +74,6 @@ module SdrClient
           conn.adapter :net_http
         end
       end
-
-      # @param [Array<SdrClient::Deposit::Files::DirectUploadResponse>] uploads the uploaded files to attach.
-      # @return [Array<SdrClient::Deposit::FileSet>] the uploads transformed to filesets
-      def build_filesets(uploads:)
-        grouped_uploads = grouping_strategy.run(uploads: uploads)
-        grouped_uploads.map.with_index(1) do |upload_group, i|
-          metadata_group = {}
-          upload_group.each { |upload| metadata_group[upload.filename] = file_metadata_for(upload.filename) }
-          FileSet.new(uploads: upload_group, uploads_metadata: metadata_group, label: "Object #{i}")
-        end
-      end
-
-      # @return [Hash<Symbol,String>] the file metadata for this file
-      def file_metadata_for(filename)
-        files_metadata.fetch(filename, {})
-      end
     end
   end
 end

data/lib/sdr_client/deposit/request.rb

@@ -7,6 +7,8 @@ module SdrClient
       # @param [String] label the required object label
       # @param [String] type (http://cocina.sul.stanford.edu/models/object.jsonld) the required object type.
       # @param [Array<FileSet>] file_sets the file sets to attach.
+      # @param [Hash<String, Hash<String, String>>] files_metadata file name, hash of additional file metadata
+      # Additional metadata includes access, preserve, shelve, md5, sha1
       # rubocop:disable Metrics/ParameterLists
       def initialize(label: nil,
                      apo:,
@@ -14,7 +16,8 @@ module SdrClient
                      source_id:,
                      catkey: nil,
                      type: 'http://cocina.sul.stanford.edu/models/object.jsonld',
-                     file_sets: [])
+                     file_sets: [],
+                     files_metadata: {})
         @label = label
         @type = type
         @source_id = source_id
@@ -22,6 +25,7 @@ module SdrClient
         @catkey = catkey
         @apo = apo
         @file_sets = file_sets
+        @files_metadata = files_metadata
       end
       # rubocop:enable Metrics/ParameterLists
 
@@ -45,12 +49,20 @@ module SdrClient
                     source_id: source_id,
                     catkey: catkey,
                     type: type,
-                    file_sets: file_sets)
+                    file_sets: file_sets,
+                    files_metadata: files_metadata)
+      end
+
+      # @param [String] filename
+      # @return [Hash] the metadata for the file
+      def for(filename)
+        files_metadata.fetch(filename, {})
       end
 
       private
 
-      attr_reader :label, :file_sets, :source_id, :catkey, :apo, :collection, :type
+      attr_reader :label, :file_sets, :source_id, :catkey, :apo, :collection,
+                  :type, :files_metadata
 
       def administrative
         {

data/lib/sdr_client/deposit/upload_files.rb

@@ -10,10 +10,10 @@ module SdrClient
       # @param [Array<String>] files a list of file names to upload
       # @param [Logger] logger the logger to use
       # @param [Faraday::Connection] connection
-      # @param [Hash<String, Hash<String, String>>] files_metadata file name, hash of additional file metadata
-      def initialize(files:, files_metadata:, logger:, connection:)
+      # @param [Request] metadata information about the object
+      def initialize(files:, metadata:, logger:, connection:)
         @files = files
-        @files_metadata = files_metadata
+        @metadata = metadata
         @logger = logger
         @connection = connection
       end
@@ -28,14 +28,14 @@ module SdrClient
 
       private
 
-      attr_reader :files, :files_metadata, :logger, :connection
+      attr_reader :files, :metadata, :logger, :connection
 
       def collect_file_metadata
         files.each_with_object({}) do |path, obj|
           file_name = ::File.basename(path)
           obj[path] = Files::DirectUploadRequest.from_file(path,
                                                            file_name: file_name,
-                                                           content_type: file_metadata_for(file_name)[:mime_type])
+                                                           content_type: metadata.for(file_name)[:mime_type])
         end
       end
 
@@ -77,11 +77,6 @@ module SdrClient
 
         raise "unexpected response: #{upload_response.inspect}" unless upload_response.status == 204
       end
-
-      # @return [Hash<Symbol,String>] the file metadata for this file
-      def file_metadata_for(filename)
-        files_metadata.fetch(filename, {})
-      end
     end
   end
 end

data/lib/sdr_client/version.rb

@@ -1,6 +1,5 @@
-
 # frozen_string_literal: true
 
 module SdrClient
-  VERSION = '0.8.1'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2020-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads