sdr-client 0.14.0 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88c890262f2a757ff94a2d69978b70efb65dee59a66dd55b3dca60d0ce15aa14
-  data.tar.gz: 2f345dc020bd50f60098061034c128393d65d53df0303e9a1d632dbf5d5b35f8
+  metadata.gz: d6d44bbb8b087e0045328a2b8625654ad9f7eaadf7c968c5ee5402683dc04d26
+  data.tar.gz: 9808626f7cad4548ccce883253245c80fc18fac9cd14353dcb008cb8c1cf365a
 SHA512:
-  metadata.gz: b7c8407114bb7b6054735a1bff35115da421ce9ab8fb616c5193a257639b682f32124e05d4a16b5fd332c843eae9fc90bd3b7a0205434dda702927054346e217
-  data.tar.gz: 984521677d0314c1d4801d7a5616d4170c03cb4c7218fb61c689c52bc6adc1a255026d91505ece960df6ba988198d436177e96b79c0c2a19f25cf7dfc01d8c0a
+  metadata.gz: e14bf4032db046e886a7ef02cc1183fab23806bf0b450527ad8e33f396d3cac1f2d254644e9f9e2179d38c04d200a4cdf09eb07515aabf0e8a7a2c7ad9367fd1
+  data.tar.gz: 39e311b8bb036dd2abff468086103be8e55516b1490d219c4c34e5b68b0c80322af47efd0dcc198ee11e3e24e484d7d206102f20e415ccfa171abd7d61d6fde5

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,6 +70,14 @@ 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)

data/lib/sdr_client/deposit.rb

@@ -5,12 +5,15 @@ require 'logger'
 module SdrClient
   # The namespace for the "deposit" command
   module Deposit
+    BOOK_TYPE = 'http://cocina.sul.stanford.edu/models/book.jsonld'
     # rubocop:disable Metrics/ParameterLists
     # rubocop:disable Metrics/MethodLength
     def self.run(label: nil,
-                 type: 'http://cocina.sul.stanford.edu/models/book.jsonld',
+                 type: BOOK_TYPE,
                  viewing_direction: nil,
                  access: 'dark',
+                 use_statement: nil,
+                 copyright: nil,
                  apo:,
                  collection: nil,
                  catkey: nil,
@@ -24,17 +27,20 @@ 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
@@ -48,6 +54,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

@@ -16,6 +16,8 @@ module SdrClient
         @grouping_strategy = grouping_strategy
       end
 
+      # @param [UploadFiles] upload_responses the uploaded file information
+      # @return [Request] the metadata with fileset information added in.
       def with_uploads(upload_responses)
         file_sets = build_filesets(uploads: upload_responses)
         metadata.with_file_sets(file_sets)
@@ -30,9 +32,25 @@ 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: label(i))
+        end
+      end
+
+      def label(index)
+        case metadata.type
+        when BOOK_TYPE
+          "Page #{index}"
+        else
+          "Object #{index}"
+        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

@@ -14,6 +14,8 @@ module SdrClient
       # rubocop:disable Metrics/ParameterLists
       def initialize(label: nil,
                      access: 'dark',
+                     use_statement: nil,
+                     copyright: nil,
                      apo:,
                      collection: nil,
                      source_id:,
@@ -32,6 +34,8 @@ module SdrClient
         @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
@@ -57,11 +61,13 @@ module SdrClient
                     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)
@@ -73,11 +79,13 @@ module SdrClient
         files_metadata.fetch(filename, {})
       end
 
+      attr_reader :type
+
       private
 
       attr_reader :access, :label, :file_sets, :source_id, :catkey, :apo, :collection,
-                  :type, :files_metadata, :embargo_release_date, :embargo_access,
-                  :viewing_direction
+                  :files_metadata, :embargo_release_date, :embargo_access,
+                  :viewing_direction, :use_statement, :copyright
 
       def administrative
         {
@@ -101,6 +109,9 @@ module SdrClient
 
       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.14.0'
+  VERSION = '0.16.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.1
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-29 00:00:00.000000000 Z
+date: 2020-03-09 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