sdr-client 0.15.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fbf18f89def752a295fe6004aef3a08aed6809d023041aad877619a8309865f
-  data.tar.gz: 608e8c9670b3c929f8a7639c20ed34f4b924f561aed295a42162620ef007d146
+  metadata.gz: 51cea2d7a34db14a8fbef003f8e02b8db1483344724e2d1201fce2b3075f7fb7
+  data.tar.gz: 0654575a55dca1ee8bc9764c02a5d512e90cba6ad257780f1938643968e8dd58
 SHA512:
-  metadata.gz: 65633ede9a98646d7e722a6b7d42c761c2a8bc04aec21010ba7187ccfdd3fc5ebd79781140f566b0733a2cb9b87c1f0d14f2cf05de3a483dc45d2ea9fa3c6ed5
-  data.tar.gz: 752f5ce61da771161af8e66e7e0f2ad98ba9e2b6cdf406aa4f82cbf35d9b3ca77926fc5a3a4615393abe67aebd0368342f93145b6137b0f212e9611c39fd5c4c
+  metadata.gz: 6b304533c8b61c34b03a4e40875b2bd3c8d2e50bf5fba6c104327a769248aaaaace4151e5a8033f2b214e87316f8065b63c880057a0a631adb94a74ff779097a
+  data.tar.gz: b43e02b8160340b06bebf30642f65f885f73c25398d5f5190bd7453f0a99939f1d824535eefe83601b572f7e221b79069459d2959bef7401bd45bf5600ef2fd9

data/README.md

@@ -8,6 +8,8 @@
 This is a CLI for interacting with the Stanford Digital Repository API.
 The code for the SDR API server is at https://github.com/sul-dlss/sdr-api
 
+This provides a way for consumers to easily and correctly deposit files to the SDR without requiring access to the `/dor` NFS mount or to use Hydrus.  A primary design goal was for this to have as few dependencies as possible so that it can be easily distributed by `gem install sdr-client` and then it can be used as a CLI.
+
 ## Install
 
 `gem install sdr-client`

data/lib/sdr_client/deposit.rb

@@ -26,6 +26,7 @@ module SdrClient
                  logger: Logger.new(STDOUT))
       token = Credentials.read
 
+      augmented_metadata = FileMetadataBuilder.build(files: files, files_metadata: files_metadata)
       metadata = Request.new(label: label,
                              type: type,
                              access: access,
@@ -38,7 +39,7 @@ module SdrClient
                              embargo_release_date: embargo_release_date,
                              embargo_access: embargo_access,
                              viewing_direction: viewing_direction,
-                             files_metadata: files_metadata)
+                             files_metadata: augmented_metadata)
       Process.new(metadata: metadata, url: url, token: token, files: files,
                   grouping_strategy: grouping_strategy, logger: logger).run
     end
@@ -52,6 +53,7 @@ require 'sdr_client/deposit/matching_file_grouping_strategy'
 require 'sdr_client/deposit/files/direct_upload_request'
 require 'sdr_client/deposit/files/direct_upload_response'
 require 'sdr_client/deposit/file'
+require 'sdr_client/deposit/file_metadata_builder'
 require 'sdr_client/deposit/file_set'
 require 'sdr_client/deposit/request'
 require 'sdr_client/deposit/upload_files'

data/lib/sdr_client/deposit/file_metadata_builder.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'sdr_client/deposit/file_metadata_builder_operations/mime_type'
+require 'sdr_client/deposit/file_metadata_builder_operations/md5'
+require 'sdr_client/deposit/file_metadata_builder_operations/sha1'
+
+module SdrClient
+  module Deposit
+    # Build basic metadata for files, iterating over a series of operations
+    # The available options are here: https://github.com/sul-dlss/sdr-client/blob/v0.8.1/lib/sdr_client/deposit/file.rb#L8-L10
+    class FileMetadataBuilder
+      OPERATIONS = [
+        FileMetadataBuilderOperations::MimeType,
+        FileMetadataBuilderOperations::MD5,
+        FileMetadataBuilderOperations::SHA1
+      ].freeze
+      private_constant :OPERATIONS
+
+      # @param (see #initialize)
+      # @return (see #build)
+      def self.build(files:, files_metadata:)
+        new(files: files, files_metadata: files_metadata.dup).build
+      end
+
+      # @param [Array<String>] files the list of files for which to generate metadata
+      def initialize(files:, files_metadata:)
+        @files = files
+        @files_metadata = files_metadata
+      end
+
+      # @return [Hash<String, Hash<String, String>>]
+      def build
+        files.each do |file_path|
+          file_key = ::File.basename(file_path)
+          OPERATIONS.each do |operation|
+            result = operation.for(file_path: file_path)
+            next if result.nil?
+
+            files_metadata[file_key] ||= {}
+            files_metadata[file_key][operation::NAME] = result
+          end
+        end
+        files_metadata
+      end
+
+      private
+
+      attr_reader :files, :files_metadata
+    end
+  end
+end

data/lib/sdr_client/deposit/file_metadata_builder_operations/md5.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module SdrClient
+  module Deposit
+    module FileMetadataBuilderOperations
+      # MD5 for this file.
+      class MD5
+        NAME = 'md5'
+        def self.for(file_path:, **)
+          Digest::MD5.file(file_path).hexdigest
+        end
+      end
+    end
+  end
+end

data/lib/sdr_client/deposit/file_metadata_builder_operations/mime_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module SdrClient
+  module Deposit
+    module FileMetadataBuilderOperations
+      # Mime-type for this file.
+      class MimeType
+        NAME = 'mime_type'
+        def self.for(file_path:, **)
+          `file --mime-type -b #{file_path}`.chomp
+        end
+      end
+    end
+  end
+end

data/lib/sdr_client/deposit/file_metadata_builder_operations/sha1.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module SdrClient
+  module Deposit
+    module FileMetadataBuilderOperations
+      # SHA1 for this file.
+      class SHA1
+        NAME = 'sha1'
+        def self.for(file_path:, **)
+          Digest::SHA1.file(file_path).hexdigest
+        end
+      end
+    end
+  end
+end

data/lib/sdr_client/deposit/metadata_builder.rb

@@ -30,9 +30,16 @@ module SdrClient
       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] = metadata.for(upload.filename) }
-          FileSet.new(uploads: upload_group, uploads_metadata: metadata_group, label: "Object #{i}")
+          FileSet.new(uploads: upload_group,
+                      uploads_metadata: metadata_group(upload_group),
+                      label: "Object #{i}")
+        end
+      end
+
+      # Get the metadata for the files belonging to a fileset
+      def metadata_group(upload_group)
+        upload_group.each_with_object({}) do |upload, obj|
+          obj[upload.filename] = metadata.for(upload.filename)
         end
       end
     end

data/lib/sdr_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 0.15.2
+  version: 0.16.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -164,6 +164,10 @@ files:
 - lib/sdr_client/credentials.rb
 - lib/sdr_client/deposit.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
+- lib/sdr_client/deposit/file_metadata_builder_operations/mime_type.rb
+- lib/sdr_client/deposit/file_metadata_builder_operations/sha1.rb
 - lib/sdr_client/deposit/file_set.rb
 - lib/sdr_client/deposit/files/direct_upload_request.rb
 - lib/sdr_client/deposit/files/direct_upload_response.rb