sdr-client 0.34.0 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 711cf2c30a41b1194087e917446a0daf2f6170308edae27d8f2735212aa3dc32
-  data.tar.gz: 9b987db8aac5ce702b5fd4b9ba7344527356c82cbeaf66552be4c67079791166
+  metadata.gz: 86f67e8ca2c7149cde2793a9af9a111e886b5baeeb6d1ee5a587836f193df4df
+  data.tar.gz: 7b4a8b2c31387f0070dd9f75670afb43bbd6b36319ae49b450319bfb2a36c99f
 SHA512:
-  metadata.gz: 0f0e764c4795efc2155ee7e0a1dc3de3e257e7b514edb6bc571cc8c9868f29509052d428ced2a1ed4477d95a1ae6809936d2abbc24a92da97cc965b355ae3106
-  data.tar.gz: d83a746ad39535ba46cc0330dbd45d2da132fb4de29da11022563f13ce97533c5ad45c320da71607c66598656ec545feffafc56fae5bd770edf520b9797c3dc0
+  metadata.gz: 9a5cdd8af6d06b4e29e61e3e1471c76354d33013144ef62ea3c9503574bc7b926d3e2a1dfba3d18cb873dc3b6ff86c2632208e8ffc929b7d8fe230eb0228b9e0
+  data.tar.gz: 8e2fd6e136621e5450b986c2eb3790052d36c411c98fe71174ce8542b61ca99d789bba811b3d7e1f4ed3c8b823f9bb6abb512e1a3fabdb738f57a8f0ded52089

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:,
@@ -67,6 +68,7 @@ module SdrClient
   end
 end
 require 'json'
+require 'sdr_client/deposit/create_resource'
 require 'sdr_client/deposit/single_file_grouping_strategy'
 require 'sdr_client/deposit/matching_file_grouping_strategy'
 require 'sdr_client/deposit/files/direct_upload_request'
@@ -78,5 +80,8 @@ 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/unexpected_response'
+require 'sdr_client/deposit/update_resource'
+require 'sdr_client/deposit/update_dro_with_file_identifiers'
 require 'sdr_client/deposit/upload_files'
-require 'sdr_client/deposit/upload_resource'
+require 'sdr_client/deposit/upload_files_metadata_builder'

data/lib/sdr_client/deposit/{upload_resource.rb → create_resource.rb}

@@ -2,8 +2,8 @@
 
 module SdrClient
   module Deposit
-    # Uploads a resource (metadata) to the server
-    class UploadResource
+    # Creates a resource (metadata) in SDR
+    class CreateResource
       DRO_PATH = '/v1/resources'
 
       def self.run(accession:, metadata:, logger:, connection:)
@@ -11,7 +11,7 @@ module SdrClient
       end
 
       # @param [Boolean] accession should the accessionWF be started
-      # @param [String] metadata
+      # @param [Cocina::Models::RequestDRO, Cocina::Models::RequestCollection] metadata
       # @param [Hash<Symbol,String>] the result of the metadata call
       def initialize(accession:, metadata:, logger:, connection:)
         @accession = accession
@@ -24,7 +24,7 @@ module SdrClient
       # @return [String] job id for the background job result
       def run
         response = metadata_request
-        unexpected_response(response) unless response.status == 201
+        UnexpectedResponse.call(response) unless response.status == 201
 
         logger.info("Response from server: #{response.body}")
 
@@ -36,16 +36,10 @@ module SdrClient
       attr_reader :metadata, :logger, :connection
 
       def metadata_request
-        logger.debug("Starting upload metadata: #{metadata}")
+        json = metadata.to_json
+        logger.debug("Starting upload metadata: #{json}")
 
-        connection.post(path, metadata, 'Content-Type' => 'application/json')
-      end
-
-      def unexpected_response(response)
-        raise "There was an error with your request: #{response.body}" if response.status == 400
-        raise 'There was an error with your credentials. Perhaps they have expired?' if response.status == 401
-
-        raise "unexpected response: #{response.status} #{response.body}"
+        connection.post(path, json, 'Content-Type' => 'application/json')
       end
 
       def accession?

data/lib/sdr_client/deposit/model_process.rb

@@ -24,13 +24,13 @@ 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)
-        UploadResource.run(accession: @accession,
-                           metadata: new_request_dro.to_json,
+        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)
+        CreateResource.run(accession: @accession,
+                           metadata: new_request_dro,
                            logger: logger,
                            connection: connection)
       end
@@ -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,17 +29,18 @@ 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)
         request = metadata_builder.with_uploads(upload_responses)
         model = Cocina::Models.build_request(request.as_json.with_indifferent_access)
-        UploadResource.run(accession: @accession,
-                           metadata: JSON.generate(model.to_h),
+        CreateResource.run(accession: @accession,
+                           metadata: model,
                            logger: logger,
                            connection: connection)
       end

data/lib/sdr_client/deposit/unexpected_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SdrClient
+  module Deposit
+    # Handles unexpected responses when manipulating resources
+    class UnexpectedResponse
+      # @param [Faraday::Response] response
+      def self.call(response)
+        raise "There was an error with your request: #{response.body}" if response.status == 400
+        raise 'There was an error with your credentials. Perhaps they have expired?' if response.status == 401
+
+        raise "unexpected response: #{response.status} #{response.body}"
+      end
+    end
+  end
+end

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/update_resource.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module SdrClient
+  module Deposit
+    # Updates a resource (metadata) in SDR
+    class UpdateResource
+      DRO_PATH = '/v1/resources/%<id>s'
+
+      def self.run(metadata:, logger:, connection:)
+        new(metadata: metadata, logger: logger, connection: connection).run
+      end
+
+      # @param [Cocina::Models::DRO] metadata
+      # @param [Hash<Symbol,String>] the result of the metadata call
+      def initialize(metadata:, logger:, connection:)
+        @metadata = metadata
+        @logger = logger
+        @connection = connection
+      end
+
+      # @param [Hash<Symbol,String>] the result of the metadata call
+      # @return [String] job id for the background job result
+      def run
+        response = metadata_request
+        UnexpectedResponse.call(response) unless response.status == 202
+
+        logger.info("Response from server: #{response.body}")
+
+        JSON.parse(response.body)['jobId']
+      end
+
+      private
+
+      attr_reader :metadata, :logger, :connection
+
+      def metadata_request
+        json = metadata.to_json
+        logger.debug("Starting upload metadata: #{json}")
+
+        connection.put(path(metadata), json, 'Content-Type' => 'application/json')
+      end
+
+      def path(metadata)
+        format(DRO_PATH, id: metadata.externalIdentifier)
+      end
+    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.34.0'
+  VERSION = '0.38.0'
 end

data/sdr-client.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport'
-  spec.add_dependency 'cocina-models', '~> 0.41.0'
+  spec.add_dependency 'cocina-models', '~> 0.43.0'
   spec.add_dependency 'dry-monads'
   spec.add_dependency 'faraday', '>= 0.16'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 0.34.0
+  version: 0.38.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-21 00:00:00.000000000 Z
+date: 2020-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.41.0
+        version: 0.43.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.41.0
+        version: 0.43.0
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement
@@ -193,6 +193,7 @@ files:
 - lib/sdr_client/connection.rb
 - lib/sdr_client/credentials.rb
 - lib/sdr_client/deposit.rb
+- lib/sdr_client/deposit/create_resource.rb
 - lib/sdr_client/deposit/file.rb
 - lib/sdr_client/deposit/file_metadata_builder.rb
 - lib/sdr_client/deposit/file_metadata_builder_operations/md5.rb
@@ -207,8 +208,11 @@ 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/unexpected_response.rb
+- lib/sdr_client/deposit/update_dro_with_file_identifiers.rb
+- lib/sdr_client/deposit/update_resource.rb
 - lib/sdr_client/deposit/upload_files.rb
-- lib/sdr_client/deposit/upload_resource.rb
+- lib/sdr_client/deposit/upload_files_metadata_builder.rb
 - lib/sdr_client/login.rb
 - lib/sdr_client/login_prompt.rb
 - lib/sdr_client/version.rb