sdr-client 0.35.1 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 551ee50a8e581a8a0e7cadcffec518168ef2b0fbba5368520ffeaaa086ccb66e
-  data.tar.gz: 5ca9d3232ccfac283d09d68310c9c4fa3355943c90ef5d5bc911f3367bea5396
+  metadata.gz: 7652ddb5f3116fb2ecefabb265718c0bd2e69d536955a22ebb7139cc287a38a1
+  data.tar.gz: cbb4118974499de9f6c7ad10df1433c4aee712b309ee1c8064cd14602cf08808
 SHA512:
-  metadata.gz: fa183be1fd002a39f25816b3f990123b3a5324e87f26fda44115537d31aeeace1915f53ba45e4432760ba9e08089da9afcec7b96061fd96ea8108a7d6d0b2cf3
-  data.tar.gz: ee6b43d4d29222f0aaec528ff85e1e2c8c657c9c659fd8089bd105c634a94c59d14275501501af4707c929d9e16606f11b815b267be0d95073d8579e7b2055ea
+  metadata.gz: d47cc4fbbf26c51df56ba79c4cf97ea3c1add9b8aa2c8f5e78a8bf51f639a15a7bbcbc912f058a2b43d29ced7981623c4f26aafc9b66b5837ae3c17796325f99
+  data.tar.gz: 107a93bbaf7fde4915bcfb2939853946aff4c0d5fbc3bfede4aeea1971cab270969a3b6406df66b9a44dced0cee70e6627e619aefff3d0803242b7c033ea13f0

data/lib/sdr_client/deposit.rb

@@ -52,6 +52,7 @@ module SdrClient
     # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/ParameterLists
 
+    # @param [Array<String>] files absolute paths to files
     def self.model_run(request_dro:,
                        files: [],
                        url:,
@@ -78,5 +79,7 @@ require 'sdr_client/deposit/request'
 require 'sdr_client/deposit/metadata_builder'
 require 'sdr_client/deposit/model_process'
 require 'sdr_client/deposit/process'
+require 'sdr_client/deposit/update_dro_with_file_identifiers'
 require 'sdr_client/deposit/upload_files'
+require 'sdr_client/deposit/upload_files_metadata_builder'
 require 'sdr_client/deposit/upload_resource'

data/lib/sdr_client/deposit/model_process.rb

@@ -24,11 +24,11 @@ module SdrClient
         check_files_exist
         child_files_match
 
-        upload_responses = UploadFiles.new(files: files,
-                                           logger: logger,
-                                           connection: connection,
-                                           mime_types: mime_types).run
-        new_request_dro = with_external_identifiers(upload_responses)
+        file_metadata = UploadFilesMetadataBuilder.build(files: files, mime_types: mime_types)
+        upload_responses = UploadFiles.upload(file_metadata: file_metadata,
+                                              logger: logger,
+                                              connection: connection)
+        new_request_dro = UpdateDroWithFileIdentifiers.update(request_dro: request_dro, upload_responses: upload_responses)
         UploadResource.run(accession: @accession,
                            metadata: new_request_dro.to_json,
                            logger: logger,
@@ -85,24 +85,6 @@ module SdrClient
           ]
         end
       end
-
-      # rubocop:disable Metrics/AbcSize
-      def with_external_identifiers(upload_responses)
-        signed_id_map = Hash[upload_responses.map { |response| [response.filename, response.signed_id] }]
-
-        # Manipulating request_dro as hash since immutable
-        request_dro_hash = request_dro.to_h
-        if request_dro_hash[:structural]
-          request_dro_hash[:structural][:contains].each do |file_set|
-            file_set[:structural][:contains].each do |file|
-              file[:externalIdentifier] = signed_id_map[file[:filename]]
-            end
-          end
-        end
-
-        Cocina::Models::RequestDRO.new(request_dro_hash)
-      end
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/sdr_client/deposit/process.rb

@@ -29,10 +29,11 @@ module SdrClient
       # @return [String] job id for the background job result
       def run
         check_files_exist
-        upload_responses = UploadFiles.new(files: files,
-                                           logger: logger,
-                                           connection: connection,
-                                           mime_types: mime_types).run
+
+        file_metadata = UploadFilesMetadataBuilder.build(files: files, mime_types: mime_types)
+        upload_responses = UploadFiles.upload(file_metadata: file_metadata,
+                                              logger: logger,
+                                              connection: connection)
         metadata_builder = MetadataBuilder.new(metadata: metadata,
                                                grouping_strategy: grouping_strategy,
                                                logger: logger)

data/lib/sdr_client/deposit/update_dro_with_file_identifiers.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module SdrClient
+  module Deposit
+    # Updates a DRO so that the structural metadata references the uploaded file ids
+    class UpdateDroWithFileIdentifiers
+      # @param [Cocina::Model::RequestDRO] request_dro for depositing
+      # @param [Array<Files::DirectUploadResponse>] upload_responses the responses from uploading files
+      # @returns [Cocina::Models::RequestDRO]
+      def self.update(request_dro:, upload_responses:)
+        # Manipulating request_dro as hash since immutable
+        structural = request_dro.to_h[:structural]
+        return request_dro.new({}) unless structural
+
+        signed_ids = signed_id_map(upload_responses)
+        request_dro.new(structural: updated_structural(structural, signed_ids))
+      end
+
+      def self.signed_id_map(upload_responses)
+        Hash[upload_responses.map { |response| [response.filename, response.signed_id] }]
+      end
+      private_class_method :signed_id_map
+
+      def self.updated_structural(structural, signed_ids)
+        structural[:contains].each do |file_set|
+          file_set[:structural][:contains].each do |file|
+            file[:externalIdentifier] = signed_ids[file[:filename]]
+          end
+        end
+        structural
+      end
+      private_class_method :updated_structural
+    end
+  end
+end

data/lib/sdr_client/deposit/upload_files.rb

@@ -7,40 +7,34 @@ module SdrClient
     # The file uploading part of a deposit
     class UploadFiles
       BLOB_PATH = '/v1/direct_uploads'
-      # @param [Array<String>] files a list of filepaths to upload
+      # @param [Hash<String,Files::DirectUploadRequest>] the metadata for uploading the files
       # @param [Logger] logger the logger to use
       # @param [Connection] connection
-      # @param [Hash<String,String] mime_types a map of filenames to mime types
-      def initialize(files:, mime_types:, logger:, connection:)
-        @files = files
-        @mime_types = mime_types
+      def self.upload(file_metadata:, logger:, connection:)
+        new(file_metadata: file_metadata, logger: logger, connection: connection).run
+      end
+
+      # @param [Hash<String,Files::DirectUploadRequest>] the metadata for uploading the files
+      # @param [Logger] logger the logger to use
+      # @param [Connection] connection
+      def initialize(file_metadata:, logger:, connection:)
+        @file_metadata = file_metadata
         @logger = logger
         @connection = connection
       end
 
       # @return [Array<SdrClient::Deposit::Files::DirectUploadResponse>] the responses from the server for the uploads
       def run
-        file_metadata = collect_file_metadata
-        upload_responses = upload_file_metadata(file_metadata)
+        upload_responses = upload_file_metadata
         upload_files(upload_responses)
         upload_responses.values
       end
 
       private
 
-      attr_reader :files, :mime_types, :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: mime_types[file_name])
-        end
-      end
+      attr_reader :logger, :connection, :file_metadata
 
-      # @param [Hash<String,Files::DirectUploadRequest>] file_metadata the filenames and their upload request
-      def upload_file_metadata(file_metadata)
+      def upload_file_metadata
         Hash[file_metadata.map { |filename, metadata| [filename, direct_upload(metadata.to_json)] }]
       end
 

data/lib/sdr_client/deposit/upload_files_metadata_builder.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module SdrClient
+  module Deposit
+    # Collecting all the metadata about the files for a deposit
+    class UploadFilesMetadataBuilder
+      # @param [Array<String>] files a list of filepaths to upload
+      # @param [Hash<String,String>] mime_types a map of filenames to mime types
+      # @return [Hash<String, Files::DirectUploadRequest>] the metadata for uploading the files
+      def self.build(files:, mime_types:)
+        new(files: files, mime_types: mime_types).build
+      end
+
+      # @param [Array<String>] files a list of filepaths to upload
+      # @param [Hash<String,String>] mime_types a map of filenames to mime types
+      def initialize(files:, mime_types:)
+        @files = files
+        @mime_types = mime_types
+      end
+
+      attr_reader :files, :mime_types
+
+      # @return [Hash<String, Files::DirectUploadRequest>] the metadata for uploading the files
+      def build
+        files.each_with_object({}) do |path, obj|
+          obj[path] = Files::DirectUploadRequest.from_file(path,
+                                                           file_name: filename_for(path),
+                                                           content_type: mime_type_for(path))
+        end
+      end
+
+      # This can be overridden in the case that the file on disk has a different
+      # name than we want to repo to know about.
+      def filename_for(file_path)
+        ::File.basename(file_path)
+      end
+
+      def mime_type_for(file_path)
+        mime_types[filename_for(file_path)]
+      end
+    end
+  end
+end

data/lib/sdr_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SdrClient
-  VERSION = '0.35.1'
+  VERSION = '0.36.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 0.35.1
+  version: 0.36.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-26 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -207,7 +207,9 @@ files:
 - lib/sdr_client/deposit/process.rb
 - lib/sdr_client/deposit/request.rb
 - lib/sdr_client/deposit/single_file_grouping_strategy.rb
+- lib/sdr_client/deposit/update_dro_with_file_identifiers.rb
 - lib/sdr_client/deposit/upload_files.rb
+- lib/sdr_client/deposit/upload_files_metadata_builder.rb
 - lib/sdr_client/deposit/upload_resource.rb
 - lib/sdr_client/login.rb
 - lib/sdr_client/login_prompt.rb
@@ -234,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: The CLI for https://github.com/sul-dlss/sdr-api