sdr-client 0.13.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99655b642622c2a87d9021fb1a30b4ffad6cf50eafded596239a1e6a4c9e835e
-  data.tar.gz: 240394c4ccb55140a986abd586a052f6e64ea3900b1df1da6b18e0a08fb93acb
+  metadata.gz: 51cea2d7a34db14a8fbef003f8e02b8db1483344724e2d1201fce2b3075f7fb7
+  data.tar.gz: 0654575a55dca1ee8bc9764c02a5d512e90cba6ad257780f1938643968e8dd58
 SHA512:
-  metadata.gz: 6970ec37d84de3ec38011c5a84e1b5c18d0fa333435203d63f5624331e7f1fc8c6129766c81e66c90e320adb150782c7edc218c54ed9f55345a312b490cfc1d1
-  data.tar.gz: 47b286e6ec4ebdcce13306ed2627fcb0f661447528b80bfafe371bb960cacb3018aaa6d565470be31254caffa9ff17e3cd0fd50e375f89725f842ccc2676c19b
+  metadata.gz: 6b304533c8b61c34b03a4e40875b2bd3c8d2e50bf5fba6c104327a769248aaaaace4151e5a8033f2b214e87316f8065b63c880057a0a631adb94a74ff779097a
+  data.tar.gz: b43e02b8160340b06bebf30642f65f885f73c25398d5f5190bd7453f0a99939f1d824535eefe83601b572f7e221b79069459d2959bef7401bd45bf5600ef2fd9

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-01-10 17:16:01 -0600 using RuboCop version 0.79.0.
+# on 2020-03-02 15:54:47 -0600 using RuboCop version 0.79.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -10,7 +10,7 @@
 Metrics/AbcSize:
   Max: 16
 
-# Offense count: 1
+# Offense count: 4
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
-  Max: 13
+  Max: 14

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/exe/sdr

@@ -70,11 +70,24 @@ subcommands = {
       options[:source_id] = source_id
     end
 
+    opts.on('--copyright COPYRIGHT', 'The copyright statement') do |copyright|
+      options[:copyright] = copyright
+    end
+
+    opts.on('--use-statement STATEMENT', 'The use and reproduction statement') do |use_statement|
+      options[:use_statement] = use_statement
+    end
+
     opts.on('--viewing-direction DIRECTION', 'The viewing direction (if a book). ' \
             'Either "left-to-right" or "right-to-left"') do |viewing_direction|
       options[:viewing_direction] = viewing_direction if %w[left-to-right right-to-left].include?(viewing_direction)
     end
 
+    opts.on('--access LEVEL', 'The access level for this object. ' \
+            'Either "world", "stanford", "location-based", "citation-only" or "dark"') do |level|
+      options[:access] = level if %w[world stanford location-based citation-only dark].include?(level)
+    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

data/lib/sdr_client/deposit.rb

@@ -6,9 +6,13 @@ module SdrClient
   # The namespace for the "deposit" command
   module Deposit
     # rubocop:disable Metrics/ParameterLists
+    # rubocop:disable Metrics/MethodLength
     def self.run(label: nil,
                  type: 'http://cocina.sul.stanford.edu/models/book.jsonld',
                  viewing_direction: nil,
+                 access: 'dark',
+                 use_statement: nil,
+                 copyright: nil,
                  apo:,
                  collection: nil,
                  catkey: nil,
@@ -22,19 +26,24 @@ 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,
                              apo: apo,
+                             use_statement: use_statement,
+                             copyright: copyright,
                              collection: collection,
                              source_id: source_id,
                              catkey: catkey,
                              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
+    # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/ParameterLists
   end
 end
@@ -44,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/deposit/request.rb

@@ -13,6 +13,9 @@ module SdrClient
       # Additional metadata includes access, preserve, shelve, md5, sha1
       # rubocop:disable Metrics/ParameterLists
       def initialize(label: nil,
+                     access: 'dark',
+                     use_statement: nil,
+                     copyright: nil,
                      apo:,
                      collection: nil,
                      source_id:,
@@ -30,6 +33,9 @@ module SdrClient
         @catkey = catkey
         @embargo_release_date = embargo_release_date
         @embargo_access = embargo_access
+        @access = access
+        @use_statement = use_statement
+        @copyright = copyright
         @apo = apo
         @file_sets = file_sets
         @files_metadata = files_metadata
@@ -39,7 +45,7 @@ module SdrClient
 
       def as_json
         {
-          access: access,
+          access: access_struct,
           type: type,
           administrative: administrative,
           identification: identification,
@@ -52,13 +58,16 @@ module SdrClient
       # @return [Request] a clone of this request with the file_sets added
       def with_file_sets(file_sets)
         Request.new(label: label,
+                    access: access,
                     apo: apo,
                     collection: collection,
+                    copyright: copyright,
                     source_id: source_id,
                     catkey: catkey,
                     embargo_release_date: embargo_release_date,
                     embargo_access: embargo_access,
                     type: type,
+                    use_statement: use_statement,
                     viewing_direction: viewing_direction,
                     file_sets: file_sets,
                     files_metadata: files_metadata)
@@ -72,9 +81,9 @@ module SdrClient
 
       private
 
-      attr_reader :label, :file_sets, :source_id, :catkey, :apo, :collection,
+      attr_reader :access, :label, :file_sets, :source_id, :catkey, :apo, :collection,
                   :type, :files_metadata, :embargo_release_date, :embargo_access,
-                  :viewing_direction
+                  :viewing_direction, :use_statement, :copyright
 
       def administrative
         {
@@ -96,8 +105,11 @@ module SdrClient
         end
       end
 
-      def access
-        {}.tap do |json|
+      def access_struct
+        { access: access }.tap do |json|
+          json[:useAndReproductionStatement] = use_statement if use_statement
+          json[:copyright] = copyright if copyright
+
           if embargo_release_date
             json[:embargo] = {
               releaseDate: embargo_release_date.strftime('%FT%T%:z'),

data/lib/sdr_client/deposit/upload_files.rb

@@ -35,7 +35,7 @@ module SdrClient
           file_name = ::File.basename(path)
           obj[path] = Files::DirectUploadRequest.from_file(path,
                                                            file_name: file_name,
-                                                           content_type: metadata.for(file_name)[:mime_type])
+                                                           content_type: metadata.for(file_name)['mime_type'])
         end
       end
 

data/lib/sdr_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SdrClient
-  VERSION = '0.13.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.13.2
+  version: 0.16.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-20 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