sdr-client 0.74.0 → 0.75.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e961a5a661471be38fc957cb5ee14985b94d64c47d75300ebee2bec6b5d86f01
-  data.tar.gz: 39bdac093eb599e91c402778605eb5164a9a72a289d56d31727e5edfee9569f2
+  metadata.gz: da8b0699691f353f0141796f1b687b167e47faf343e763b22e006afc7042d4b2
+  data.tar.gz: ac627e37ed720454c5569c7da728257b36988424af0c0f7acc365e63ee3e80e1
 SHA512:
-  metadata.gz: 42a8987a6836d1fbffe02517bf08114ba44595524505ba318a3a3109be2b12bc4cbb67e482a2b67d5045763d24f3192b69726632989d22bab1a140c351d67b44
-  data.tar.gz: 873fb15afd29b719f2f4cefe842e7109fb47f950578364a23f3772323015ed73040d1d79ab174e8ea25f7e59272a86eb3d264c26a36649c25727cee6a62f7eff
+  metadata.gz: 0357af1078af521bf1f3837e121dc844b1e0b1e39ec3c36678517dea2f0795da6e77f553f5e402c21c12e5c5bbe571d205643ce3fbf3e91e82dc99f9157ac7cd
+  data.tar.gz: 3edd8d027451deb5f90667decb7824062833c59bd35e15241238ef617082e33bee83e2a0219e4c6c2a6a000c2c09cd8bb0d5718ce1b58f37d7a22eec0167c790

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2022-03-11 00:50:54 UTC using RuboCop version 1.25.1.
+# on 2022-03-23 20:29:32 UTC using RuboCop version 1.25.1.
 # 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
@@ -26,21 +26,20 @@ Lint/UnusedMethodArgument:
     - 'lib/sdr_client/deposit/file_type_file_set_strategy.rb'
     - 'lib/sdr_client/deposit/image_file_set_strategy.rb'
 
-# Offense count: 2
+# Offense count: 4
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
     - 'lib/sdr_client/cli.rb'
     - 'lib/sdr_client/update.rb'
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: IgnoredMethods, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
-    - 'lib/sdr_client/cli.rb'
     - 'lib/sdr_client/update.rb'
 
-# Offense count: 11
+# Offense count: 12
 # Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Exclude:
@@ -52,7 +51,7 @@ Metrics/MethodLength:
     - 'lib/sdr_client/login.rb'
     - 'lib/sdr_client/update.rb'
 
-# Offense count: 10
+# Offense count: 11
 # Configuration parameters: Max, CountAsOne.
 RSpec/ExampleLength:
   Exclude:
@@ -106,7 +105,7 @@ RSpec/NamedSubject:
     - 'spec/sdr_client/deposit/process_spec.rb'
     - 'spec/sdr_client/login_spec.rb'
 
-# Offense count: 12
+# Offense count: 16
 # Configuration parameters: Max.
 RSpec/NestedGroups:
   Exclude:
@@ -114,6 +113,7 @@ RSpec/NestedGroups:
     - 'spec/sdr_client/deposit/model_process_spec.rb'
     - 'spec/sdr_client/deposit/process_spec.rb'
     - 'spec/sdr_client/login_spec.rb'
+    - 'spec/sdr_client/update_spec.rb'
 
 # Offense count: 19
 # Cop supports --auto-correct.
@@ -136,7 +136,7 @@ Style/StringConcatenation:
     - 'lib/sdr_client/deposit/create_resource.rb'
     - 'spec/sdr_client/deposit_spec.rb'
 
-# Offense count: 19
+# Offense count: 26
 # Cop supports --auto-correct.
 # Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
@@ -147,3 +147,4 @@ Layout/LineLength:
     - 'lib/sdr_client/update.rb'
     - 'spec/sdr_client/deposit/model_process_spec.rb'
     - 'spec/sdr_client/deposit/process_spec.rb'
+    - 'spec/sdr_client/update_spec.rb'

data/README.md

@@ -79,16 +79,25 @@ Update an object:
 ```
 # Change admin policy object (APO)
 sdr update druid:bb408qn5061 --url https://sdr-api-server:3000 --admin-policy druid:bx911tp9024
+
 # Change collection
 sdr update druid:bb408qn5061 --url https://sdr-api-server:3000 --collection druid:pb756dt1672
+
 # Change copyright
 sdr update druid:bb408qn5061 --url https://sdr-api-server:3000 --copyright "Here is a new copyright statement"
+
 # Change use and reproduction statement
 sdr update druid:bb408qn5061 --url https://sdr-api-server:3000 --use-and-reproduction "Here are the terms of use..."
+
 # Change license
 sdr update druid:bb408qn5061 --url https://sdr-api-server:3000 --license "https://www.apache.org/licenses/LICENSE-2.0"
+
 # Change access controls
 sdr update druid:bb408qn5061 --url https://sdr-api-server:3000 --view "location-based" --download "none" --location "music" --cdl false
+
+# Change Cocina wholesale from a file (note that you can use this flag with the
+# others above, and the flags above will replace what's supplied in the cocina file)
+sdr update druid:bb408qn5061 --url https://sdr-api-server:3000 --cocina-file bb408qn5061.json
 ```
 
 ## Testing

data/lib/sdr_client/cli.rb

@@ -69,7 +69,8 @@ module SdrClient
     option :view, enum: %w[world stanford location-based citation-only dark], desc: 'Access view level for the object'
     option :download, enum: %w[world stanford location-based none], desc: 'Access download level for the object'
     option :location, enum: %w[spec music ars art hoover m&m], desc: 'Access location for the object'
-    option :cdl, type: :boolean, default: false
+    option :cdl, type: :boolean, default: false, desc: 'Controlled digital lending'
+    option :cocina_file, desc: 'Path to a file containing Cocina JSON'
     def update(druid)
       validate_druid!(druid)
       job_id = SdrClient::Update.run(druid, **options)
@@ -153,7 +154,7 @@ module SdrClient
 
     def poll_for_job_complete(job_id:, url:)
       # the extra args to `say` prevent appending a newline
-      say('SDR is processing your request', nil, false)
+      say('SDR is processing your request.', nil, false)
       result = nil
       (1).upto(60) do
         result = SdrClient::BackgroundJobResults.show(url: url, job_id: job_id)
@@ -163,10 +164,15 @@ module SdrClient
         say('.', nil, false)
         sleep 1
       end
+
       if result['status'] == 'complete'
-        say " success! (druid: #{result.dig('output', 'druid')})"
+        if (errors = result.dig('output', 'errors'))
+          say_error " errored! #{errors}"
+        else
+          say " success! (druid: #{result.dig('output', 'druid')})"
+        end
       else
-        say_error "Job #{job_id} did not complete\n#{result.inspect}"
+        say_error " job #{job_id} did not complete\n#{result.inspect}"
       end
     end
   end

data/lib/sdr_client/connection.rb

@@ -6,10 +6,10 @@ module SdrClient
     include Dry::Monads[:result]
 
     # @param [Integer] read_timeout the value in seconds to set the read timeout
-    def initialize(url:, token: Credentials.read, read_timeout: 360)
+    def initialize(url:, token: Credentials.read, read_timeout: default_timeout, timeout: default_timeout)
       @url = url
       @token = token
-      @request_options = { read_timeout: read_timeout }
+      @request_options = { read_timeout: read_timeout, timeout: timeout }
     end
 
     def connection
@@ -39,5 +39,11 @@ module SdrClient
     private
 
     attr_reader :url, :token, :request_options
+
+    # NOTE: This is the number of seconds it roughly takes for H2 to
+    #       successfully shunt ~10GB files over to SDR API
+    def default_timeout
+      900
+    end
   end
 end

data/lib/sdr_client/update.rb

@@ -17,7 +17,7 @@ module SdrClient
     # @return [String] job id for the background job result
     def run
       SdrClient::Deposit::UpdateResource.run(
-        metadata: updated_cocina_item,
+        metadata: updated_cocina_object,
         logger: options[:logger] || Logger.new($stdout),
         connection: SdrClient::Connection.new(url: url)
       )
@@ -27,17 +27,18 @@ module SdrClient
 
     attr_reader :druid, :logger, :options, :url
 
-    def updated_cocina_item
-      @updated_cocina_item ||=
-        original_cocina_item.then { |cocina_item| update_apo(cocina_item) }
-                            .then { |cocina_item| update_collection(cocina_item) }
-                            .then { |cocina_item| update_copyright(cocina_item) }
-                            .then { |cocina_item| update_use_and_reproduction(cocina_item) }
-                            .then { |cocina_item| update_license(cocina_item) }
-                            .then { |cocina_item| update_access(cocina_item) }
+    def updated_cocina_object
+      @updated_cocina_object ||=
+        original_cocina_object.then { |cocina_object| update_cocina(cocina_object) }
+                              .then { |cocina_object| update_apo(cocina_object) }
+                              .then { |cocina_object| update_collection(cocina_object) }
+                              .then { |cocina_object| update_copyright(cocina_object) }
+                              .then { |cocina_object| update_use_and_reproduction(cocina_object) }
+                              .then { |cocina_object| update_license(cocina_object) }
+                              .then { |cocina_object| update_access(cocina_object) }
     end
 
-    def original_cocina_item
+    def original_cocina_object
       Cocina::Models.build(
         JSON.parse(
           SdrClient::Find.run(druid, url: url)
@@ -45,56 +46,76 @@ module SdrClient
       )
     end
 
+    def cocina_hash_from_file
+      @cocina_hash_from_file ||= JSON.parse(File.read(options[:cocina_file]), symbolize_names: true)
+    end
+
+    # Update the Cocina in full
+    def update_cocina(cocina_object)
+      return cocina_object unless options[:cocina_file]
+
+      if !File.file?(options[:cocina_file]) || !File.readable?(options[:cocina_file])
+        raise "File not found: #{options[:cocina_file]}"
+      end
+
+      # NOTE: We may want to add more checks later. For now, make sure the identifiers match.
+      if cocina_object.externalIdentifier != cocina_hash_from_file[:externalIdentifier]
+        raise "Cocina in #{options[:cocina_file]} has a different external identifier than #{cocina_object.externalIdentifier}: #{cocina_hash_from_file[:externalIdentifier]}"
+      end
+
+      cocina_object.new(cocina_hash_from_file)
+    end
+
     # Update the APO of a Cocina item if the options specify a new one, else return the original
-    def update_apo(cocina_item)
-      return cocina_item unless options[:apo]
+    def update_apo(cocina_object)
+      return cocina_object unless options[:apo]
 
-      cocina_item.new(
-        administrative: cocina_item.administrative.new(
+      cocina_object.new(
+        administrative: cocina_object.administrative.new(
           hasAdminPolicy: options[:apo]
         )
       )
     end
 
     # Update the collection of a Cocina item if the options specify a new one, else return the original
-    def update_collection(cocina_item)
-      return cocina_item unless options[:collection]
+    def update_collection(cocina_object)
+      return cocina_object unless options[:collection]
 
-      cocina_item.new(
-        structural: cocina_item.structural.new(
+      cocina_object.new(
+        structural: cocina_object.structural.new(
           isMemberOf: Array(options[:collection])
         )
       )
     end
 
     # Update the copyright of a Cocina item if the options specify a new one, else return the original
-    def update_copyright(cocina_item)
-      return cocina_item unless options[:copyright]
+    def update_copyright(cocina_object)
+      return cocina_object unless options[:copyright]
 
-      cocina_item.new(
-        access: cocina_item.access.new(
+      cocina_object.new(
+        access: cocina_object.access.new(
           copyright: options[:copyright]
         )
       )
     end
 
     # Update the use and reproduction statement of a Cocina item if the options specify a new one, else return the original
-    def update_use_and_reproduction(cocina_item)
-      return cocina_item unless options[:use_and_reproduction]
+    def update_use_and_reproduction(cocina_object)
+      return cocina_object unless options[:use_and_reproduction]
 
-      cocina_item.new(
-        access: cocina_item.access.new(
+      cocina_object.new(
+        access: cocina_object.access.new(
           useAndReproductionStatement: options[:use_and_reproduction]
         )
       )
     end
 
     # Update the license of a Cocina item if the options specify a new one, else return the original
-    def update_license(cocina_item)
-      return cocina_item unless options[:license]
+    def update_license(cocina_object)
+      return cocina_object unless options[:license]
 
-      cocina_item.new(
-        access: cocina_item.access.new(
+      cocina_object.new(
+        access: cocina_object.access.new(
           license: options[:license]
         )
       )
@@ -102,18 +123,18 @@ module SdrClient
 
     # rubocop:disable Style/DoubleNegation
     # Update the access of a Cocina item if the options specify a new one, else return the original
-    def update_access(cocina_item)
-      return cocina_item unless options[:view] || options[:download] || options[:location] || options[:cdl]
+    def update_access(cocina_object)
+      return cocina_object unless options[:view] || options[:download] || options[:location] || options[:cdl]
 
-      cocina_item.new(
-        access: cocina_item.access.new(
+      cocina_object.new(
+        access: cocina_object.access.new(
           view: options[:view],
           download: options[:download],
           location: options[:location],
           controlledDigitalLending: !!options[:cdl]
         ),
-        structural: cocina_item.structural.new(
-          contains: cocina_item.structural.contains.map do |file_set|
+        structural: cocina_object.structural.new(
+          contains: cocina_object.structural.contains.map do |file_set|
             file_set.new(
               structural: file_set.structural.new(
                 contains: file_set.structural.contains.map do |file|

data/lib/sdr_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 0.74.0
+  version: 0.75.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-25 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport