sdr-client 0.88.0 → 0.91.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 306e1af071e673f1d0c15b8158d49e25b83266ffa46282034774a07a54a7ff1e
-  data.tar.gz: 98bc8d20f6a46e3f89e7f8250c56962944ae74fc19b028a8d7df06323d3d5e48
+  metadata.gz: f8233c4bc5f385175264ff828603971ecf6f0e65e5ed5d973ce8eed2bf42be8e
+  data.tar.gz: 63cbe0407ada26d325730ad992a74964ae83cc3390a2a2ccd3b446b070c78969
 SHA512:
-  metadata.gz: 57312c7aa2947b0233f080030de611344dd6d3fffbca9af480c14eeb93b53f70f0dcce20a31721e1a92ca7f22efa87595bbbdff917b8e21bc8f6ee7142af32cb
-  data.tar.gz: 7ab17c0b16f0c44a35c7cfa1418363fa108c2061b3d78b209c8bcb314761bcbaf83a4541151adb5d92a86af2c6c70285f384a94c0d111a2b163af730c8cc6e9e
+  metadata.gz: 3b7fa91c363c8d88d53f168e17e9627cb773bdea6d51c2e3891e1ed5fdbcd57db731e9f021e7edc40b2426834e3d1c962627769126d605ba1f99134069dcdbb7
+  data.tar.gz: fbdbc1fafad4c9c1a47379fe697b8573b44cbd368b4a76ccdb7998898a93c3e9898286c8abf4b46326bd1c30ceed9ea1608fb3ba748e5cc44bb4415b8bb4581a

data/.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2.1
 orbs:
-  ruby-rails: sul-dlss/ruby-rails@2.0.0
+  ruby-rails: sul-dlss/ruby-rails@3.1.2
 workflows:
   build:
     jobs:

data/.rubocop.yml

@@ -157,3 +157,21 @@ RSpec/BeNil: # new in 2.9.0
   Enabled: true
 RSpec/VerifiedDoubleReference: # new in 2.10.0
   Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+RSpec/ChangeByZero: # new in 2.11.0
+  Enabled: true
+RSpec/Capybara/SpecificMatcher: # new in 2.12
+  Enabled: true
+RSpec/Rails/HaveHttpStatus: # new in 2.12
+  Enabled: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sdr-client (0.88.0)
+    sdr-client (0.91.0)
       activesupport
       cocina-models (~> 0.83.0)
       dry-monads
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -43,15 +43,11 @@ GEM
       activesupport
     diff-lcs (1.5.0)
     docile (1.4.0)
-    dry-configurable (0.15.0)
+    dry-container (0.10.1)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.6)
-    dry-container (0.9.0)
+    dry-core (0.8.1)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.13, >= 0.13.0)
-    dry-core (0.7.1)
-      concurrent-ruby (~> 1.0)
-    dry-inflector (0.2.1)
+    dry-inflector (0.3.0)
     dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
@@ -68,31 +64,35 @@ GEM
       dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    edtf (3.0.8)
+    edtf (3.1.0)
       activesupport (>= 3.0, < 8.0)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    faraday (2.3.0)
-      faraday-net_http (~> 2.0)
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.3)
+    faraday-net_http (3.0.0)
     hashdiff (1.0.1)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
     json (2.6.2)
     jsonpath (1.1.2)
       multi_json
+    mini_portile2 (2.8.0)
     minitest (5.16.2)
     multi_json (1.15.0)
-    nokogiri (1.13.6-x86_64-darwin)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    nokogiri (1.13.8-x86_64-darwin)
       racc (~> 1.4)
     openapi3_parser (0.9.2)
       commonmarker (~> 0.17)
     openapi_parser (0.15.0)
     optimist (3.0.1)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     patience_diff (1.2.0)
       optimist (~> 3.0)
@@ -119,17 +119,17 @@ GEM
       rspec-core (>= 2, < 4, != 2.12.0)
     rss (0.2.9)
       rexml
-    rubocop (1.31.1)
+    rubocop (1.35.0)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
+    rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
@@ -148,10 +148,10 @@ GEM
       diff-lcs
       patience_diff
     thor (1.2.1)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.2.0)
-    webmock (3.14.0)
+    webmock (3.17.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -159,6 +159,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2.0)

data/README.md

@@ -95,9 +95,12 @@ sdr update druid:bb408qn5061 --url https://sdr-api-server:3000 --license "https:
 # 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)
+# Change Cocina wholesale, either:
+# 1. From a file
 sdr update druid:bb408qn5061 --url https://sdr-api-server:3000 --cocina-file bb408qn5061.json
+# 2. Piped in on the command-line
+sdr get druid:b408qn5061 --url https://sdr-api-server:3000 | exe/remove_w3cdtf_encoding_from_event_dates | sdr update druid:bb408qn5061 --url https://sdr-api-server:3000 --cocina-pipe
+# Note that you can use either of these flags with the others above, and the flags above will replace what's supplied in the cocina file or pipe
 ```
 
 ## Testing

data/exe/remove_w3cdtf_encoding_from_event_dates

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift 'lib'
+
+require 'sdr_client'
+
+output = JSON.parse($stdin.read).tap do |hash|
+  hash.dig('description', 'event').each do |event|
+    event['date'].each do |event_date|
+      event_date.delete('encoding') if event_date.dig('encoding', 'code') == 'w3cdtf'
+    end
+  end
+end.to_json
+
+puts output

data/lib/sdr_client/cli.rb

@@ -31,7 +31,7 @@ module SdrClient
 
     desc 'get DRUID', 'Retrieve an object from the SDR'
     def get(druid)
-      say SdrClient::Find.run(druid, url: options[:url])
+      say SdrClient::Find.run(druid, url: options[:url], logger: Logger.new($stderr))
     rescue SdrClient::Credentials::NoCredentialsError
       say_error 'Log in first'
       exit(1)
@@ -71,10 +71,11 @@ module SdrClient
     option :location, enum: %w[spec music ars art hoover m&m], desc: 'Access location for the object'
     option :cdl, type: :boolean, default: false, desc: 'Controlled digital lending'
     option :cocina_file, desc: 'Path to a file containing Cocina JSON'
+    option :cocina_pipe, type: :boolean, default: false, desc: 'Indicate Cocina JSON is being piped in'
     def update(druid)
       validate_druid!(druid)
       job_id = SdrClient::Update.run(druid, **options)
-      poll_for_job_complete(job_id: job_id, url: options[:url]) # TODO: add an option that skips this
+      poll_for_job_complete(job_id: job_id, url: options[:url])
     rescue SdrClient::Credentials::NoCredentialsError
       say_error 'Log in first'
       exit(1)
@@ -156,7 +157,7 @@ module SdrClient
       # the extra args to `say` prevent appending a newline
       say('SDR is processing your request.', nil, false)
       result = nil
-      (1).upto(60) do
+      1.upto(60) do
         result = SdrClient::BackgroundJobResults.show(url: url, job_id: job_id)
         break unless %w[pending processing].include?(result['status'])
 

data/lib/sdr_client/credentials.rb

@@ -8,7 +8,7 @@ module SdrClient
     # @param [String] a json string that contains a field 'token'
     def self.write(body)
       json = JSON.parse(body)
-      Dir.mkdir(credentials_path, 0o700) unless Dir.exist?(credentials_path)
+      FileUtils.mkdir_p(credentials_path, mode: 0o700)
       File.atomic_write(credentials_file) do |file|
         file.write(json.fetch('token'))
       end

data/lib/sdr_client/deposit/create_resource.rb

@@ -5,26 +5,26 @@ module SdrClient
     # Creates a resource (metadata) in SDR
     class CreateResource
       DRO_PATH = '/v1/resources'
-
-      def self.run(accession:, metadata:, logger:, connection:, assign_doi: false)
-        new(accession: accession,
-            assign_doi: assign_doi,
-            metadata: metadata,
-            logger: logger,
-            connection: connection).run
+      def self.run(**args)
+        new(**args).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:, assign_doi:, metadata:, logger:, connection:)
+      # @param [String] priority what processing priority should be used
+      #                          either 'low' or 'default'
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(accession:, metadata:, logger:, connection:, assign_doi: false, priority: nil)
         @accession = accession
+        @priority = priority
         @assign_doi = assign_doi
         @metadata = metadata
         @logger = logger
         @connection = connection
       end
+      # rubocop:enable Metrics/ParameterLists
 
       # @param [Hash<Symbol,String>] the result of the metadata call
       # @return [String] job id for the background job result
@@ -39,7 +39,7 @@ module SdrClient
 
       private
 
-      attr_reader :metadata, :logger, :connection
+      attr_reader :metadata, :logger, :connection, :priority
 
       def metadata_request
         json = metadata.to_json
@@ -60,6 +60,7 @@ module SdrClient
 
       def path
         params = { accession: accession? }
+        params[:priority] = priority if priority
         params[:assign_doi] = true if assign_doi? # false is default
         DRO_PATH + '?' + params.map { |k, v| "#{k}=#{v}" }.join('&')
       end

data/lib/sdr_client/deposit/model_process.rb

@@ -9,12 +9,15 @@ module SdrClient
       # @param [Cocina::Model::RequestDRO] request_dro for depositing
       # @param [Connection] connection the connection to use
       # @param [Boolean] accession should the accessionWF be started
+      # @param [String] priority (nil) what processing priority should be used
+      #                          either 'low' or 'default'
       # @param [Array<String>] files a list of file names to upload
       # @param [Boolean] assign_doi should a DOI be assigned to this item
       # @param [Logger] logger the logger to use
       def initialize(request_dro:, # rubocop:disable Metrics/ParameterLists
                      connection:,
                      accession:,
+                     priority: nil,
                      files: [],
                      assign_doi: false,
                      logger: Logger.new($stdout))
@@ -23,6 +26,7 @@ module SdrClient
         @request_dro = request_dro
         @logger = logger
         @accession = accession
+        @priority = priority
         @assign_doi = assign_doi
       end
 
@@ -36,6 +40,7 @@ module SdrClient
                                               connection: connection)
         new_request_dro = UpdateDroWithFileIdentifiers.update(request_dro: request_dro, upload_responses: upload_responses)
         CreateResource.run(accession: @accession,
+                           priority: @priority,
                            assign_doi: @assign_doi,
                            metadata: new_request_dro,
                            logger: logger,

data/lib/sdr_client/deposit/process.rb

@@ -9,6 +9,8 @@ module SdrClient
       # @param [Request] metadata information about the object
       # @param [String] connection the server connection to use
       # @param [Boolean] accession should the accessionWF be started
+      # @param [String] priority (nil) what processing priority should be used
+      #                          either 'low' or 'default'
       # @param [Class] grouping_strategy class whose run method groups an array of uploads
       # @param [Class] file_set_type_strategy class whose run method determines file_set type
       # @param [Array<String>] files a list of file names to upload
@@ -19,6 +21,7 @@ module SdrClient
       def initialize(metadata:,
                      connection:,
                      accession:,
+                     priority: nil,
                      grouping_strategy: SingleFileGroupingStrategy,
                      file_set_type_strategy: FileTypeFileSetStrategy,
                      files: [],
@@ -31,6 +34,7 @@ module SdrClient
         @grouping_strategy = grouping_strategy
         @file_set_type_strategy = file_set_type_strategy
         @accession = accession
+        @priority = priority
         @assign_doi = assign_doi
       end
       # rubocop:enable Metrics/ParameterLists
@@ -51,6 +55,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,
+                           priority: @priority,
                            assign_doi: @assign_doi,
                            metadata: model,
                            logger: logger,

data/lib/sdr_client/deposit/update_resource.rb

@@ -6,16 +6,18 @@ module SdrClient
     class UpdateResource
       DRO_PATH = '/v1/resources/%<id>s'
 
-      def self.run(metadata:, logger:, connection:)
-        new(metadata: metadata, logger: logger, connection: connection).run
+      def self.run(metadata:, logger:, connection:, version_description: nil)
+        new(metadata: metadata, logger: logger, connection: connection, version_description: version_description).run
       end
 
       # @param [Cocina::Models::DRO] metadata
       # @param [Hash<Symbol,String>] the result of the metadata call
-      def initialize(metadata:, logger:, connection:)
+      # @param [String] version_description
+      def initialize(metadata:, logger:, connection:, version_description: nil)
         @metadata = metadata
         @logger = logger
         @connection = connection
+        @version_description = version_description
       end
 
       # @param [Hash<Symbol,String>] the result of the metadata call
@@ -31,7 +33,7 @@ module SdrClient
 
       private
 
-      attr_reader :metadata, :logger, :connection
+      attr_reader :metadata, :logger, :connection, :version_description
 
       def metadata_request
         json = metadata.to_json
@@ -39,7 +41,9 @@ module SdrClient
 
         connection.put(path(metadata), json,
                        'Content-Type' => 'application/json',
-                       'X-Cocina-Models-Version' => Cocina::Models::VERSION)
+                       'X-Cocina-Models-Version' => Cocina::Models::VERSION) do |req|
+                         req.params['versionDescription'] = version_description if version_description
+                       end
       end
 
       def path(metadata)

data/lib/sdr_client/deposit.rb

@@ -27,6 +27,7 @@ module SdrClient
                  files: [],
                  files_metadata: {},
                  accession: false,
+                 priority: nil,
                  grouping_strategy: SingleFileGroupingStrategy,
                  file_set_type_strategy: FileTypeFileSetStrategy,
                  logger: Logger.new($stdout))
@@ -51,24 +52,27 @@ module SdrClient
                   grouping_strategy: grouping_strategy,
                   file_set_type_strategy: file_set_type_strategy,
                   accession: accession,
+                  priority: priority,
                   logger: logger).run
     end
     # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/ParameterLists
 
     # @param [Array<String>] files absolute paths to files
     def self.model_run(request_dro:,
                        files: [],
                        url:,
                        accession:,
+                       priority: nil,
                        logger: Logger.new($stdout))
       connection = Connection.new(url: url)
       ModelProcess.new(request_dro: request_dro,
                        connection: connection,
                        files: files,
                        logger: logger,
-                       accession: accession).run
+                       accession: accession,
+                       priority: priority).run
     end
+    # rubocop:enable Metrics/ParameterLists
   end
 end
 require 'json'

data/lib/sdr_client/update.rb

@@ -50,10 +50,22 @@ module SdrClient
       @cocina_hash_from_file ||= JSON.parse(File.read(options[:cocina_file]), symbolize_names: true)
     end
 
+    def cocina_hash_from_pipe
+      @cocina_hash_from_pipe ||= JSON.parse($stdin.read, symbolize_names: true)
+    end
+
     # Update the Cocina in full
     def update_cocina(cocina_object)
-      return cocina_object unless options[:cocina_file]
+      if options[:cocina_file]
+        update_cocina_from_file(cocina_object)
+      elsif options[:cocina_pipe]
+        update_cocina_from_pipe(cocina_object)
+      else
+        cocina_object
+      end
+    end
 
+    def update_cocina_from_file(cocina_object)
       if !File.file?(options[:cocina_file]) || !File.readable?(options[:cocina_file])
         raise "File not found: #{options[:cocina_file]}"
       end
@@ -66,6 +78,17 @@ module SdrClient
       cocina_object.new(cocina_hash_from_file)
     end
 
+    def update_cocina_from_pipe(cocina_object)
+      raise 'No pipe provided' unless $stdin.stat.pipe?
+
+      # NOTE: We may want to add more checks later. For now, make sure the identifiers match.
+      if cocina_object.externalIdentifier != cocina_hash_from_pipe[:externalIdentifier]
+        raise "Cocina piped in has a different external identifier than #{cocina_object.externalIdentifier}: #{cocina_hash_from_pipe[:externalIdentifier]}"
+      end
+
+      cocina_object.new(cocina_hash_from_pipe)
+    end
+
     # Update the APO of a Cocina item if the options specify a new one, else return the original
     def update_apo(cocina_object)
       return cocina_object unless options[:apo]

data/lib/sdr_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 0.88.0
+  version: 0.91.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-05 00:00:00.000000000 Z
+date: 2022-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -197,6 +197,7 @@ description: This provides a way to deposit repository objects into the Stanford
 email:
 - jcoyne@justincoyne.com
 executables:
+- remove_w3cdtf_encoding_from_event_dates
 - sdr
 extensions: []
 extra_rdoc_files: []
@@ -214,6 +215,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/remove_w3cdtf_encoding_from_event_dates
 - exe/sdr
 - lib/sdr-client.rb
 - lib/sdr_client.rb