sdr-client 0.55.1 → 0.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bbde1ddcec86f8c2368ce9b336dae6dc1f52dbcf774bd0e51df25f2ffb15256
-  data.tar.gz: 73b363c29c6b51383379eee5772eaf28b87ab98be850a848194a73986ba91d2c
+  metadata.gz: dc628ea7480d2ef9102b3fa37f37fe23b0fa9ee11d7a883251b465b3f7518112
+  data.tar.gz: 8d0e09c1a92f0ee87be08efbbd359fd4499f671a0a3de9c7edde4afeaca70942
 SHA512:
-  metadata.gz: dbfa9a16a0f897543c93efd08c5fc85de429cfa6457c0ba460361572f403c3b646bafed431eaa431e96ade03d5fe1c2ade8b62e08185df23069818bdb41e8e63
-  data.tar.gz: aa384461001ec16966c6287c9e595005d80a3e9a19c783b1793726ed7551190b4983fca8289f41bb9b2f336332b3732fea64d295249d5338664b593617876ba8
+  metadata.gz: 560557769b5867a0dbcb5c5f7ba9f5bb4ccb3b6e93637fc35df4e5a8f389dc9d4ab06bdacbb220d06d5a4f0af30761836740febe7be516a72355854fd834f581
+  data.tar.gz: 38a5f18f6f4bb293731058f08407dc42790ab2932c0d8ff0d9bcdaeedfb79cb880ae065756953411a2f9a7839539310fdb40982ac212a643fc0c08d789b38f46

data/.rubocop.yml

@@ -13,6 +13,10 @@ Metrics/BlockLength:
   ExcludedMethods:
     - 'OptionParser.new'
 
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/sdr_client/deposit/request.rb'
+
 Naming/FileName:
   Exclude:
     - 'lib/sdr-client.rb'

data/.rubocop_todo.yml

@@ -1,19 +1,33 @@
 # This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2021-03-12 13:21:16 -0600 using RuboCop version 0.79.0.
+# `rubocop --auto-gen-config --auto-gen-only-exclude`
+# on 2021-04-15 12:18:21 -0700 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
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
+# Configuration parameters: Max.
 Metrics/AbcSize:
-  Max: 16
+  Exclude:
+    - 'lib/sdr_client/deposit/model_process.rb'
+
+# Offense count: 1
+# Configuration parameters: Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/sdr_client/cli.rb'
 
 # Offense count: 9
-# Configuration parameters: CountComments, ExcludedMethods.
+# Configuration parameters: CountComments, Max, ExcludedMethods.
 Metrics/MethodLength:
-  Max: 15
+  Exclude:
+    - 'lib/sdr_client/cli.rb'
+    - 'lib/sdr_client/deposit/file.rb'
+    - 'lib/sdr_client/deposit/model_process.rb'
+    - 'lib/sdr_client/deposit/process.rb'
+    - 'lib/sdr_client/deposit/request.rb'
+    - 'lib/sdr_client/login.rb'
 
 # Offense count: 231
 # Cop supports --auto-correct.

data/README.md

@@ -51,3 +51,8 @@ View the object:
 sdr --service-url https://sdr-api-server:3000 get druid:bw581ng3176
 {"type":"http://cocina.sul.stanford.edu/models/document.jsonld","externalIdentifier":"druid:bw581ng3176","label":"Something something better title","version":1,"access":{"access":"stanford","copyright":"This work is copyrighted by the creator.","download":"stanford","useAndReproductionStatement":"This document is available only to the Stanford faculty, staff and student community."},"administrative":{"hasAdminPolicy":"druid:zx485kb6348"},"description":{"title":[{"value":"Something something better title"}],"contributor":[{"name":[{"value":"Hodge, Amy"}],"type":"person","role":[{"value":"Author"},{"value":"author","uri":"http://id.loc.gov/vocabulary/relators/aut","source":{"code":"marcrelator","uri":"http://id.loc.gov/vocabulary/relators/"}},{"value":"Creator"}]}],"form":[{"structuredValue":[{"value":"Text","type":"type"},{"value":"Report","type":"subtype"}],"type":"resource type","source":{"value":"Stanford self-deposit resource types"}},{"value":"reports","type":"genre","uri":"http://vocab.getty.edu/aat/300027267","source":{"code":"aat"}},{"value":"text","type":"resource type","source":{"value":"MODS resource types"}}],"note":[{"value":";alkdfjlsadkjf;l","type":"summary"},{"value":"amyhodge@stanford.edu","type":"contact","displayLabel":"Contact"}],"subject":[{"value":"lkfj","type":"topic"},{"value":";kfj","type":"topic"},{"value":"fjwelkb","type":"topic"}]},"identification":{"sourceId":"hydrus:20"},"structural":{"contains":[{"type":"http://cocina.sul.stanford.edu/models/resources/file.jsonld","externalIdentifier":"bw581ng3176_1","label":"Test file","version":1,"structural":{"contains":[{"type":"http://cocina.sul.stanford.edu/models/file.jsonld","externalIdentifier":"druid:bw581ng3176/test.txt","label":"test.txt","filename":"test.txt","size":11,"version":1,"hasMimeType":"text/plain","hasMessageDigests":[{"type":"sha1","digest":"5d39343e4bb48abd97f759828282f5ebbac56c5e"},{"type":"md5","digest":"63b8812b0c05722a9d6c51cbd2bfb54b"}],"access":{"access":"world","download":"world"},"administrative":{"sdrPreserve":true,"shelve":true}}]}}]}}
 ```
+
+Display version of sdr-client:
+```
+sdr version
+```

data/exe/sdr

@@ -19,9 +19,6 @@ end
 global.order!
 command = ARGV.shift
 
-retrieve_options = OptionParser.new do |opts|
-end
-
 deposit_options = OptionParser.new do |opts|
   opts.banner = "Usage: sdr #{command} [options]"
   opts.on('--label LABEL', 'The object label') do |label|
@@ -97,10 +94,11 @@ end
 SdrClient::CLI.help unless command
 
 subcommands = {
-  'get' => retrieve_options,
+  'get' => OptionParser.new,
   'deposit' => deposit_options,
   'register' => deposit_options,
-  'login' => OptionParser.new
+  'login' => OptionParser.new,
+  'version' => OptionParser.new
 }
 
 unless subcommands.key?(command)

data/lib/sdr_client/cli.rb

@@ -35,6 +35,9 @@ module SdrClient
         login
           Will prompt for email & password and exchange it for an login token, which it saves in ~/.sdr/token
 
+        version
+          Display the sdr-client version
+
     HELP
 
     def self.start(command, options, arguments = [])
@@ -46,6 +49,8 @@ module SdrClient
       when 'login'
         status = SdrClient::Login.run(options)
         puts status.failure if status.failure?
+      when 'version'
+        puts SdrClient::VERSION
       else
         raise "Unknown command #{command}"
       end

data/lib/sdr_client/deposit.rb

@@ -21,6 +21,7 @@ module SdrClient
                  catkey: nil,
                  embargo_release_date: nil,
                  embargo_access: 'world',
+                 embargo_download: 'world',
                  source_id:,
                  url:,
                  files: [],
@@ -41,6 +42,7 @@ module SdrClient
                              catkey: catkey,
                              embargo_release_date: embargo_release_date,
                              embargo_access: embargo_access,
+                             embargo_download: embargo_download,
                              viewing_direction: viewing_direction,
                              files_metadata: augmented_metadata)
       connection = Connection.new(url: url)

data/lib/sdr_client/deposit/create_resource.rb

@@ -6,15 +6,21 @@ module SdrClient
     class CreateResource
       DRO_PATH = '/v1/resources'
 
-      def self.run(accession:, metadata:, logger:, connection:)
-        new(accession: accession, metadata: metadata, logger: logger, connection: connection).run
+      def self.run(accession:, assign_doi: false, metadata:, logger:, connection:)
+        new(accession: accession,
+            assign_doi: assign_doi,
+            metadata: metadata,
+            logger: logger,
+            connection: connection).run
       end
 
       # @param [Boolean] accession should the accessionWF be started
+      # @param [Boolean] assign_doi should a DOI be assigned to this item
       # @param [Cocina::Models::RequestDRO, Cocina::Models::RequestCollection] metadata
       # @param [Hash<Symbol,String>] the result of the metadata call
-      def initialize(accession:, metadata:, logger:, connection:)
+      def initialize(accession:, assign_doi:, metadata:, logger:, connection:)
         @accession = accession
+        @assign_doi = assign_doi
         @metadata = metadata
         @logger = logger
         @connection = connection
@@ -39,15 +45,23 @@ module SdrClient
         json = metadata.to_json
         logger.debug("Starting upload metadata: #{json}")
 
-        connection.post(path, json, 'Content-Type' => 'application/json')
+        connection.post(path, json,
+                        'Content-Type' => 'application/json',
+                        'X-Cocina-Models-Version' => Cocina::Models::VERSION)
       end
 
       def accession?
         @accession
       end
 
+      def assign_doi?
+        @assign_doi
+      end
+
       def path
-        "#{DRO_PATH}?accession=#{accession?}"
+        params = { accession: accession? }
+        params[:assign_doi] = true if assign_doi? # false is default
+        DRO_PATH + '?' + params.map { |k, v| "#{k}=#{v}" }.join('&')
       end
     end
   end

data/lib/sdr_client/deposit/file.rb

@@ -6,15 +6,16 @@ module SdrClient
     class File
       # rubocop:disable Metrics/ParameterLists
       def initialize(external_identifier:, label:, filename:,
-                     access: 'world', preserve: true, shelve: true,
+                     access: 'dark', download: 'none', preserve: true, shelve: true,
                      publish: true, mime_type: nil, md5: nil, sha1: nil,
                      use: nil)
         @external_identifier = external_identifier
         @label = label
         @filename = filename
         @access = access
+        @download = download
         @preserve = preserve
-        @shelve = shelve
+        @shelve = access == 'dark' ? false : shelve
         @publish = publish
         @mime_type = mime_type
         @md5 = md5
@@ -23,7 +24,6 @@ module SdrClient
       end
       # rubocop:enable Metrics/ParameterLists
 
-      # rubocop:disable Metrics/MethodLength
       def as_json
         {
           "type": 'http://cocina.sul.stanford.edu/models/file.jsonld',
@@ -31,7 +31,8 @@ module SdrClient
           filename: @filename,
           externalIdentifier: @external_identifier,
           access: {
-            access: @access
+            access: @access,
+            download: @download
           },
           administrative: {
             sdrPreserve: @preserve,
@@ -45,7 +46,6 @@ module SdrClient
           json['use'] = @use if @use
         end
       end
-      # rubocop:enable Metrics/MethodLength
 
       private
 

data/lib/sdr_client/deposit/file_set.rb

@@ -5,7 +5,7 @@ module SdrClient
     # This represents the FileSet metadata that we send to the server for doing a deposit
     class FileSet
       # @param [Array] uploads
-      # @param [Hash<String,Hash<String,String>>] the file level metadata
+      # @param [Hash<String,Hash<String,String>>] uploads_metadata the file level metadata
       # @param [Array] files
       # @param [String] label
       def initialize(uploads: [], uploads_metadata: {}, files: [], label:)

data/lib/sdr_client/deposit/model_process.rb

@@ -10,14 +10,19 @@ module SdrClient
       # @param [Connection] connection the connection to use
       # @param [Array<String>] files a list of file names to upload
       # @param [Boolean] accession should the accessionWF be started
+      # @param [Boolean] assign_doi should a DOI be assigned to this item
       # @param [Logger] logger the logger to use
-      def initialize(request_dro:, connection:,
-                     files: [], accession:, logger: Logger.new(STDOUT))
+      def initialize(request_dro:, # rubocop:disable Metrics/ParameterLists
+                     connection:,
+                     files: [], accession:,
+                     assign_doi: false,
+                     logger: Logger.new(STDOUT))
         @files = files
         @connection = connection
         @request_dro = request_dro
         @logger = logger
         @accession = accession
+        @assign_doi = assign_doi
       end
 
       def run
@@ -30,6 +35,7 @@ module SdrClient
                                               connection: connection)
         new_request_dro = UpdateDroWithFileIdentifiers.update(request_dro: request_dro, upload_responses: upload_responses)
         CreateResource.run(accession: @accession,
+                           assign_doi: @assign_doi,
                            metadata: new_request_dro,
                            logger: logger,
                            connection: connection)

data/lib/sdr_client/deposit/process.rb

@@ -10,18 +10,21 @@ module SdrClient
       # @param [Class] grouping_strategy class whose run method groups an array of uploads
       # @param [String] connection the server connection to use
       # @param [Array<String>] files a list of file names to upload
+      # @param [Boolean] assign_doi should a DOI be assigned to this item
       # @param [Boolean] accession should the accessionWF be started
       # @param [Logger] logger the logger to use
       #
       # rubocop:disable Metrics/ParameterLists
       def initialize(metadata:, grouping_strategy: SingleFileGroupingStrategy,
-                     connection:, files: [], accession:, logger: Logger.new(STDOUT))
+                     connection:, files: [], accession:, assign_doi: false,
+                     logger: Logger.new(STDOUT))
         @files = files
         @connection = connection
         @metadata = metadata
         @logger = logger
         @grouping_strategy = grouping_strategy
         @accession = accession
+        @assign_doi = assign_doi
       end
       # rubocop:enable Metrics/ParameterLists
 
@@ -40,6 +43,7 @@ module SdrClient
         request = metadata_builder.with_uploads(upload_responses)
         model = Cocina::Models.build_request(request.as_json.with_indifferent_access)
         CreateResource.run(accession: @accession,
+                           assign_doi: @assign_doi,
                            metadata: model,
                            logger: logger,
                            connection: connection)

data/lib/sdr_client/deposit/request.rb

@@ -12,6 +12,7 @@ module SdrClient
       # @param [Hash<String, Hash<String, String>>] files_metadata file name, hash of additional file metadata
       # Additional metadata includes access, preserve, shelve, publish, md5, sha1
       # rubocop:disable Metrics/ParameterLists
+      # rubocop:disable Metrics/AbcSize
       def initialize(label: nil,
                      access: 'dark',
                      download: 'none',
@@ -23,6 +24,7 @@ module SdrClient
                      catkey: nil,
                      embargo_release_date: nil,
                      embargo_access: 'world',
+                     embargo_download: 'world',
                      type: 'http://cocina.sul.stanford.edu/models/object.jsonld',
                      viewing_direction: nil,
                      file_sets: [],
@@ -34,6 +36,7 @@ module SdrClient
         @catkey = catkey
         @embargo_release_date = embargo_release_date
         @embargo_access = embargo_access
+        @embargo_download = embargo_download
         @access = access
         @download = download
         @use_statement = use_statement
@@ -44,6 +47,7 @@ module SdrClient
         @viewing_direction = viewing_direction
       end
       # rubocop:enable Metrics/ParameterLists
+      # rubocop:enable Metrics/AbcSize
 
       def as_json
         {
@@ -58,6 +62,7 @@ module SdrClient
       end
 
       # @return [Request] a clone of this request with the file_sets added
+      # rubocop:disable Metrics/AbcSize
       def with_file_sets(file_sets)
         Request.new(label: label,
                     access: access,
@@ -69,17 +74,22 @@ module SdrClient
                     catkey: catkey,
                     embargo_release_date: embargo_release_date,
                     embargo_access: embargo_access,
+                    embargo_download: embargo_download,
                     type: type,
                     use_statement: use_statement,
                     viewing_direction: viewing_direction,
                     file_sets: file_sets,
                     files_metadata: files_metadata)
       end
+      # rubocop:enable Metrics/AbcSize
 
       # @param [String] filename
       # @return [Hash] the metadata for the file
       def for(filename)
-        files_metadata.fetch(filename, {})
+        metadata = files_metadata.fetch(filename, {}).with_indifferent_access
+        metadata[:access] = access unless metadata.key?(:access)
+        metadata[:download] = download unless metadata.key?(:download)
+        metadata
       end
 
       attr_reader :type
@@ -87,7 +97,7 @@ module SdrClient
       private
 
       attr_reader :access, :label, :file_sets, :source_id, :catkey, :apo, :collection,
-                  :files_metadata, :embargo_release_date, :embargo_access,
+                  :files_metadata, :embargo_release_date, :embargo_access, :embargo_download,
                   :viewing_direction, :use_statement, :copyright, :download
 
       def administrative
@@ -121,7 +131,8 @@ module SdrClient
           if embargo_release_date
             json[:embargo] = {
               releaseDate: embargo_release_date.strftime('%FT%T%:z'),
-              access: embargo_access
+              access: embargo_access,
+              download: embargo_download
             }
           end
         end

data/lib/sdr_client/deposit/update_resource.rb

@@ -37,7 +37,9 @@ module SdrClient
         json = metadata.to_json
         logger.debug("Starting upload metadata: #{json}")
 
-        connection.put(path(metadata), json, 'Content-Type' => 'application/json')
+        connection.put(path(metadata), json,
+                       'Content-Type' => 'application/json',
+                       'X-Cocina-Models-Version' => Cocina::Models::VERSION)
       end
 
       def path(metadata)

data/lib/sdr_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SdrClient
-  VERSION = '0.55.1'
+  VERSION = '0.59.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.58.1'
+  spec.add_dependency 'cocina-models', '~> 0.61.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.55.1
+  version: 0.59.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.58.1
+        version: 0.61.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.58.1
+        version: 0.61.0
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement