sdr-client 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85bf3bb61e2edeca3fd59c4bcb72e65c0ca8a6fa2555095059c774d6adbb5cd9
-  data.tar.gz: 29ef71e2e7778c28b8db875e7c910ee4f477857422d61d59774ab09b0fdb5852
+  metadata.gz: d4ac0ef485cd0ede90e6bcb2b99dcf001f92f3f296720520e6f1d4f5dcccef47
+  data.tar.gz: 52d7af6780779c41dcb67d87b9f87a139568132e612c2118ae5170617b023d06
 SHA512:
-  metadata.gz: 61cc5ce0d28aeddbcd20273a7086d9b4dc0482b76f91b19002496b80e4db7d32471f9b8e827ffc800c58172fb3cf7d1f2ccdf920ca11bd88f5ac141002406703
-  data.tar.gz: c2149a463c52831fee474f8c43e00982fce4ea9f56da629f8b87f1889bb59630419ed6c8c5296b56b6985324195ff1bb700277cbdfa91e9de89388319689b461
+  metadata.gz: 48f9cb820ed8e23aada68d2bd65fe676b94941bb47e618832449df5bbcfe53ffb632fc961e1f5d3279d5fc9a8d6458dc32f28fd5b6e3ba240911cc50a9f137c8
+  data.tar.gz: 6ad9e1dd66c890a2ae771c95d53c3204872fc8c8fc3eb851863f021c1150748134a426b6aedd511b378a9bba29566d828c4eefa9b027462fedeeea0a170c9df7

data/lib/sdr_client/cli.rb

@@ -13,6 +13,9 @@ module SdrClient
       else
         raise "Unknown command #{command}"
       end
+    rescue SdrClient::Credentials::NoCredentialsError
+      puts 'Log in first'
+      exit(1)
     end
   end
 end

data/lib/sdr_client/credentials.rb

@@ -3,6 +3,8 @@
 module SdrClient
   # The stored credentials
   class Credentials
+    class NoCredentialsError < StandardError; end
+
     # @param [String] a json string that contains a field 'token'
     def self.write(body)
       json = JSON.parse(body)
@@ -10,14 +12,12 @@ module SdrClient
       File.open(credentials_file, 'w', 0o600) do |file|
         file.write(json.fetch('token'))
       end
-      puts 'Signed in.'
     end
 
     def self.read
-      return IO.readlines(credentials_file, chomp: true).first if ::File.exist?(credentials_file)
+      raise NoCredentialsError unless ::File.exist?(credentials_file)
 
-      puts 'Log in first'
-      exit(1)
+      IO.readlines(credentials_file, chomp: true).first
     end
 
     def self.credentials_path

data/lib/sdr_client/deposit.rb

@@ -39,4 +39,6 @@ require 'sdr_client/deposit/files/direct_upload_response'
 require 'sdr_client/deposit/file'
 require 'sdr_client/deposit/file_set'
 require 'sdr_client/deposit/request'
+require 'sdr_client/deposit/upload_files'
+require 'sdr_client/deposit/metadata_builder'
 require 'sdr_client/deposit/process'

data/lib/sdr_client/deposit/files/direct_upload_request.rb

@@ -6,12 +6,12 @@ module SdrClient
   module Deposit
     module Files
       DirectUploadRequest = Struct.new(:checksum, :byte_size, :content_type, :filename, keyword_init: true) do
-        def self.from_file(filename)
-          checksum = Digest::MD5.file(filename).base64digest
+        def self.from_file(path, file_name:, content_type:)
+          checksum = Digest::MD5.file(path).base64digest
           new(checksum: checksum,
-              byte_size: ::File.size(filename),
-              content_type: 'text/html',
-              filename: ::File.basename(filename))
+              byte_size: ::File.size(path),
+              content_type: content_type || 'application/octet-stream',
+              filename: file_name)
         end
 
         def as_json

data/lib/sdr_client/deposit/metadata_builder.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module SdrClient
+  module Deposit
+    # Constructs the deposit metadata for the DRO
+    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:)
+        @metadata = metadata
+        @logger = logger
+        @grouping_strategy = grouping_strategy
+        @files_metadata = files_metadata
+      end
+
+      def with_uploads(upload_responses)
+        file_sets = build_filesets(uploads: upload_responses)
+        metadata.with_file_sets(file_sets)
+      end
+
+      private
+
+      attr_reader :metadata, :files, :logger, :grouping_strategy, :files_metadata
+
+      # @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] = files_metadata.fetch(upload.filename, {}) }
+          FileSet.new(uploads: upload_group, uploads_metadata: metadata_group, label: "Object #{i}")
+        end
+      end
+    end
+  end
+end

data/lib/sdr_client/deposit/process.rb

@@ -6,7 +6,6 @@ module SdrClient
   module Deposit
     # The process for doing a deposit
     class Process
-      BLOB_PATH = '/v1/direct_uploads'
       DRO_PATH = '/v1/resources'
       # @param [Request] metadata information about the object
       # @param [Class] grouping_strategy class whose run method groups an array of uploads
@@ -31,11 +30,13 @@ module SdrClient
 
       def run
         check_files_exist
-        file_metadata = collect_file_metadata
-        upload_responses = upload_file_metadata(file_metadata)
-        upload_files(upload_responses)
-        file_sets = build_filesets(uploads: upload_responses.values, files_metadata: files_metadata)
-        request = metadata.with_file_sets(file_sets)
+        upload_responses = UploadFiles.new(files: files, logger: logger,
+                                           connection: connection, files_metadata: files_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)
       end
 
@@ -50,51 +51,6 @@ module SdrClient
         end
       end
 
-      def collect_file_metadata
-        files.each_with_object({}) do |filename, obj|
-          obj[filename] = Files::DirectUploadRequest.from_file(filename)
-        end
-      end
-
-      # @param [Hash<String,Files::DirectUploadRequest>] file_metadata the filenames and their upload request
-      def upload_file_metadata(file_metadata)
-        Hash[file_metadata.map { |filename, metadata| [filename, direct_upload(metadata.to_json)] }]
-      end
-
-      def direct_upload(metadata_json)
-        logger.info("Starting an upload request: #{metadata_json}")
-        response = connection.post(BLOB_PATH, metadata_json, 'Content-Type' => 'application/json')
-        raise "unexpected response: #{response.inspect}" unless response.status == 200
-
-        logger.info("Response from server: #{response.body}")
-
-        Files::DirectUploadResponse.new(JSON.parse(response.body))
-      end
-
-      # @param [Hash<String,Files::DirectUploadResponse>] upload_responses the filenames and their upload response
-      def upload_files(upload_responses)
-        upload_responses.each do |filename, response|
-          upload_file(filename: filename,
-                      url: response.direct_upload.fetch('url'),
-                      content_type: response.content_type,
-                      content_length: response.byte_size)
-
-          logger.info('Upload complete')
-        end
-      end
-
-      def upload_file(filename:, url:, content_type:, content_length:)
-        logger.info("Uploading `#{filename}' to #{url}")
-
-        upload_response = connection.put(url) do |req|
-          req.body = ::File.open(filename)
-          req.headers['Content-Type'] = content_type
-          req.headers['Content-Length'] = content_length.to_s
-        end
-
-        raise "unexpected response: #{upload_response.inspect}" unless upload_response.status == 204
-      end
-
       # @return [Hash<Symbol,String>] the result of the metadata call
       def upload_metadata(metadata)
         logger.info("Starting upload metadata: #{metadata}")
@@ -122,16 +78,20 @@ module SdrClient
       end
 
       # @param [Array<SdrClient::Deposit::Files::DirectUploadResponse>] uploads the uploaded files to attach.
-      # @param [Hash<String,Hash<String, String>>] files_metadata filename, hash of additional file metadata.
       # @return [Array<SdrClient::Deposit::FileSet>] the uploads transformed to filesets
-      def build_filesets(uploads:, files_metadata:)
+      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] = files_metadata.fetch(upload.filename, {}) }
+          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/upload_files.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module SdrClient
+  module Deposit
+    # The file uploading part of a deposit
+    class UploadFiles
+      BLOB_PATH = '/v1/direct_uploads'
+      # @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:)
+        @files = files
+        @files_metadata = files_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_files(upload_responses)
+        upload_responses.values
+      end
+
+      private
+
+      attr_reader :files, :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])
+        end
+      end
+
+      # @param [Hash<String,Files::DirectUploadRequest>] file_metadata the filenames and their upload request
+      def upload_file_metadata(file_metadata)
+        Hash[file_metadata.map { |filename, metadata| [filename, direct_upload(metadata.to_json)] }]
+      end
+
+      def direct_upload(metadata_json)
+        logger.info("Starting an upload request: #{metadata_json}")
+        response = connection.post(BLOB_PATH, metadata_json, 'Content-Type' => 'application/json')
+        raise "unexpected response: #{response.inspect}" unless response.status == 200
+
+        logger.info("Response from server: #{response.body}")
+
+        Files::DirectUploadResponse.new(JSON.parse(response.body))
+      end
+
+      # @param [Hash<String,Files::DirectUploadResponse>] upload_responses the filenames and their upload response
+      def upload_files(upload_responses)
+        upload_responses.each do |filename, response|
+          upload_file(filename: filename,
+                      url: response.direct_upload.fetch('url'),
+                      content_type: response.content_type,
+                      content_length: response.byte_size)
+
+          logger.info('Upload complete')
+        end
+      end
+
+      def upload_file(filename:, url:, content_type:, content_length:)
+        logger.info("Uploading `#{filename}' to #{url}")
+
+        upload_response = connection.put(url) do |req|
+          req.body = ::File.open(filename)
+          req.headers['Content-Type'] = content_type
+          req.headers['Content-Length'] = content_length.to_s
+        end
+
+        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,5 +1,5 @@
 # frozen_string_literal: true
 
 module SdrClient
-  VERSION = '0.7.1'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-30 00:00:00.000000000 Z
+date: 2020-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -168,9 +168,11 @@ files:
 - lib/sdr_client/deposit/files/direct_upload_request.rb
 - lib/sdr_client/deposit/files/direct_upload_response.rb
 - lib/sdr_client/deposit/matching_file_grouping_strategy.rb
+- lib/sdr_client/deposit/metadata_builder.rb
 - 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/upload_files.rb
 - lib/sdr_client/login.rb
 - lib/sdr_client/login_prompt.rb
 - lib/sdr_client/version.rb
@@ -196,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: The CLI for https://github.com/sul-dlss/sdr-api