sdr-client 2.12.0 → 2.13.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe0ad47a766a04fce46a16e1621cd320ef29a17f1fad3db5f6f541e93538555a
-  data.tar.gz: d8915f97ada0d121b4a2e0c8cb6f125ac3e20486378d53bf7de7a5ab0fe85690
+  metadata.gz: 01d7f308ef15c7ab6a2463ad29c840cd65e9ac2c821a267fe156852f9658451d
+  data.tar.gz: 549912392456aa50d070e708a815aabdb1de2a2fbb0d49c50ef00a9dfe22783a
 SHA512:
-  metadata.gz: 15a80598a92338adec41fc75d53b890a2fe4b95e5c08e16e438d0766ca91a0f75198a282a29dfdaae7bc7ea4d9f2864dca36d07a1cce0fec078b770a776a5b1c
-  data.tar.gz: 47b5e9bce9ac469b559e68bc1a40ba722f6a921d370aa9af6fe80ea27988016e4c68820a2819e667fc697d050ea2d0c4c7a51ec75d83b52caa2cfded4e14baf7
+  metadata.gz: 067e91aa50872e2a517ae3e9f9eeeb2d575aa308ff87dcbb2651baeb3a74e34f450616de6e993c9d67a929a1dc24fec972f97c70108591e9e1c3c1be5f354a2e
+  data.tar.gz: 9f6f99b027fdedff2d834cf71503436bd8e56ac8193de9fe4050cff6946da9c53f68419a446d4c93f6abab235c23fa0fd56cd586483aa906982a4eec909cb46a

data/.rubocop.yml

@@ -22,6 +22,9 @@ Metrics/ClassLength:
     - 'lib/sdr_client/cli.rb'
     - 'lib/sdr_client/deposit/request.rb'
     - 'lib/sdr_client/update.rb'
+    - 'lib/sdr_client/redesigned_client.rb'
+    - 'lib/sdr_client/redesigned_client/cli.rb'
+    - 'lib/sdr_client/redesigned_client/cli/update.rb'
 
 Naming/FileName:
   Exclude:

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2023-09-11 17:08:41 UTC using RuboCop version 1.56.3.
+# on 2024-03-26 19:28:56 UTC using RuboCop version 1.62.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
@@ -20,26 +20,30 @@ Lint/NoReturnInBeginEndBlocks:
 
 # Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
+# Configuration parameters: AutoCorrect, AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
 Lint/UnusedMethodArgument:
   Exclude:
     - 'lib/sdr_client/deposit/file_type_file_set_strategy.rb'
     - 'lib/sdr_client/deposit/image_file_set_strategy.rb'
 
-# Offense count: 4
+# Offense count: 11
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
     - 'lib/sdr_client/cli.rb'
+    - 'lib/sdr_client/redesigned_client.rb'
+    - 'lib/sdr_client/redesigned_client/cli.rb'
+    - 'lib/sdr_client/redesigned_client/cli/update.rb'
     - 'lib/sdr_client/update.rb'
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
+    - 'lib/sdr_client/redesigned_client/cli/update.rb'
     - 'lib/sdr_client/update.rb'
 
-# Offense count: 12
+# Offense count: 15
 # Configuration parameters: CountComments, Max, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Exclude:
@@ -49,14 +53,18 @@ Metrics/MethodLength:
     - 'lib/sdr_client/deposit/process.rb'
     - 'lib/sdr_client/deposit/request.rb'
     - 'lib/sdr_client/login.rb'
+    - 'lib/sdr_client/redesigned_client/cli.rb'
+    - 'lib/sdr_client/redesigned_client/cli/update.rb'
     - 'lib/sdr_client/update.rb'
 
-# Offense count: 11
+# Offense count: 15
 # Configuration parameters: Max, CountAsOne.
 RSpec/ExampleLength:
   Exclude:
-    - 'spec/sdr_client/deposit_spec.rb'
     - 'spec/sdr_client/deposit_model_spec.rb'
+    - 'spec/sdr_client/deposit_spec.rb'
+    - 'spec/sdr_client/redesigned_client/deposit_spec.rb'
+    - 'spec/sdr_client/redesigned_client/upload_files_metadata_builder_spec.rb'
     - 'spec/sdr_client/update_spec.rb'
 
 # Offense count: 1
@@ -66,16 +74,19 @@ RSpec/MessageSpies:
   Exclude:
     - 'spec/sdr_client/deposit_spec.rb'
 
-# Offense count: 13
+# Offense count: 19
 # Configuration parameters: Max.
 RSpec/MultipleExpectations:
   Exclude:
     - 'spec/sdr_client/connection_spec.rb'
     - 'spec/sdr_client/deposit/metadata_builder_spec.rb'
+    - 'spec/sdr_client/deposit_model_spec.rb'
     - 'spec/sdr_client/deposit_spec.rb'
     - 'spec/sdr_client/find_spec.rb'
     - 'spec/sdr_client/login_spec.rb'
-    - 'spec/sdr_client/deposit_model_spec.rb'
+    - 'spec/sdr_client/redesigned_client/deposit_spec.rb'
+    - 'spec/sdr_client/redesigned_client/job_status_spec.rb'
+    - 'spec/sdr_client/redesigned_client/upload_files_spec.rb'
 
 # Offense count: 24
 # Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
@@ -89,7 +100,7 @@ RSpec/NamedSubject:
     - 'spec/sdr_client/deposit/process_spec.rb'
     - 'spec/sdr_client/login_spec.rb'
 
-# Offense count: 19
+# Offense count: 25
 # Configuration parameters: Max, AllowedGroups.
 RSpec/NestedGroups:
   Exclude:
@@ -97,6 +108,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/redesigned_client/job_status_spec.rb'
     - 'spec/sdr_client/update_spec.rb'
 
 # Offense count: 5
@@ -105,15 +117,6 @@ RSpec/ReceiveMessages:
   Exclude:
     - 'spec/sdr_client/update_spec.rb'
 
-# Offense count: 2
-# Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
-# Include: **/*_spec.rb
-RSpec/SpecFilePathFormat:
-  Exclude:
-    - '**/spec/routing/**/*'
-    - 'spec/sdr_client/client_spec.rb'
-    - 'spec/sdr_client/model_deposit_spec.rb'
-
 # Offense count: 21
 # This cop supports safe autocorrection (--autocorrect).
 Style/KeywordParametersOrder:
@@ -121,10 +124,11 @@ Style/KeywordParametersOrder:
     - 'lib/sdr_client/deposit.rb'
     - 'lib/sdr_client/deposit/request.rb'
 
-# Offense count: 1
+# Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 Style/MultilineTernaryOperator:
   Exclude:
+    - 'lib/sdr_client/redesigned_client/cli/update.rb'
     - 'lib/sdr_client/update.rb'
 
 # Offense count: 2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sdr-client (2.12.0)
+    sdr-client (2.13.0.beta1)
       activesupport
       cocina-models (~> 0.96.0)
       config
@@ -97,7 +97,7 @@ GEM
     i18n (1.14.4)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    json (2.7.1)
+    json (2.7.2)
     jsonpath (1.1.5)
       multi_json
     language_server-protocol (3.17.0.3)
@@ -109,9 +109,9 @@ GEM
     mutex_m (0.2.0)
     net-http (0.4.1)
       uri
-    nokogiri (1.16.3-x86_64-darwin)
+    nokogiri (1.16.4-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.3-x86_64-linux)
+    nokogiri (1.16.4-x86_64-linux)
       racc (~> 1.4)
     openapi3_parser (0.9.2)
       commonmarker (~> 0.17)
@@ -123,10 +123,10 @@ GEM
       racc
     patience_diff (1.2.0)
       optimist (~> 3.0)
-    public_suffix (5.0.4)
+    public_suffix (5.0.5)
     racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.1.0)
+    rake (13.2.1)
     regexp_parser (2.9.0)
     rexml (3.2.6)
     rspec (3.13.0)
@@ -146,7 +146,7 @@ GEM
       rspec-core (>= 2, < 4, != 2.12.0)
     rss (0.3.0)
       rexml
-    rubocop (1.62.1)
+    rubocop (1.63.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -165,10 +165,13 @@ GEM
       rubocop (~> 1.41)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.27.1)
+    rubocop-rspec (2.29.1)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.3)
+      rubocop (~> 1.40)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)

data/exe/sdr_redesigned

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift 'lib'
+
+require 'sdr_client'
+require 'sdr_client/redesigned_client'
+require 'sdr_client/redesigned_client/cli'
+
+SdrClient::RedesignedClient::CLI.start(ARGV)

data/lib/sdr_client/redesigned_client/authenticator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module SdrClient
+  class RedesignedClient
+    # Fetch a token from the SDR API using user credentials
+    class Authenticator
+      def self.token
+        new.token
+      end
+
+      # Request an access_token
+      def token
+        response = connection.post(path, request_body)
+
+        UnexpectedResponse.call(response) unless response.success?
+
+        JSON.parse(response.body)['token']
+      end
+
+      private
+
+      def request_body
+        JSON.generate(
+          {
+            email: SdrClient::RedesignedClient.config.email,
+            password: SdrClient::RedesignedClient.config.password
+          }
+        )
+      end
+
+      def path
+        '/v1/auth/login'
+      end
+
+      def connection
+        Faraday.new(url: SdrClient::RedesignedClient.config.url)
+      end
+    end
+  end
+end

data/lib/sdr_client/redesigned_client/cli/config.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'config'
+
+Config.setup do |config|
+  # Name of the constant exposing loaded settings
+  config.const_name = 'Settings'
+
+  # Load environment variables from the `ENV` object and override any
+  # settings defined in files.
+  config.use_env = true
+
+  # Define ENV variable prefix deciding which variables to load into
+  # config.
+  config.env_prefix = 'SETTINGS'
+
+  # What string to use as level separator for settings loaded from ENV
+  # variables. Default value of '.' works well with Heroku, but you might
+  # want to change it for example for '__' to easy override settings from
+  # command line, where using dots in variable names might not be allowed
+  # (eg. Bash).
+  config.env_separator = '__'
+
+  # Ability to process variables names:
+  #   * nil  - no change
+  #   * :downcase - convert to lower case
+  config.env_converter = :downcase
+end
+
+Config.load_and_set_settings(
+  File.join(__dir__, '../../../..', 'config/settings.yml')
+)

data/lib/sdr_client/redesigned_client/cli/credentials.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module SdrClient
+  class RedesignedClient
+    class CLI < Thor
+      # The stored credentials
+      class Credentials
+        # @param [String] a json string that contains a field 'token'
+        def self.write(body)
+          token = JSON.parse(body).fetch('token')
+          FileUtils.mkdir_p(credentials_path, mode: 0o700)
+          File.atomic_write(credentials_file) { |file| file.write(token) }
+          File.chmod(0o600, credentials_file)
+        end
+
+        def self.read
+          return unless ::File.exist?(credentials_file)
+
+          creds = File.read(credentials_file, chomp: true)
+          return if creds.nil?
+
+          creds
+        end
+
+        def self.credentials_path
+          @credentials_path ||= File.join(Dir.home, '.sdr')
+        end
+
+        def self.credentials_file
+          File.join(credentials_path, 'credentials')
+        end
+      end
+    end
+  end
+end

data/lib/sdr_client/redesigned_client/cli/update.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+module SdrClient
+  class RedesignedClient
+    class CLI < Thor
+      # Update a resource given command-line options
+      class Update
+        # @return [String] job id for the background job result
+        def self.run(druid, **options)
+          new(druid, **options).run
+        end
+
+        def initialize(druid, **options)
+          @druid = druid
+          @options = options
+        end
+
+        # @return [String] job id for the background job result
+        def run
+          client.update_model(model: updated_cocina_object)
+        end
+
+        private
+
+        attr_reader :druid, :options
+
+        def client
+          SdrClient::RedesignedClient.instance
+        end
+
+        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_object
+          Cocina::Models.build(
+            client.find(object_id: druid)
+          )
+        end
+
+        def cocina_hash_from_file
+          @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)
+          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
+
+          # 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
+
+        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]
+
+          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_object)
+          return cocina_object unless options[:collection]
+
+          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_object)
+          return cocina_object unless options[:copyright]
+
+          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_object)
+          return cocina_object unless options[:use_and_reproduction]
+
+          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_object)
+          return cocina_object unless options[:license]
+
+          cocina_object.new(
+            access: cocina_object.access.new(
+              license: options[:license]
+            )
+          )
+        end
+
+        # Update the access of a Cocina item if the options specify a new one, else return the original
+        def update_access(cocina_object)
+          return cocina_object unless options[:view] || options[:download] || options[:location] || options[:cdl]
+
+          cocina_object.new(
+            access: cocina_object.access.new(
+              view: options[:view],
+              download: options[:download],
+              location: options[:location],
+              controlledDigitalLending: !!options[:cdl] # rubocop:disable Style/DoubleNegation
+            ),
+            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|
+                      file.new(
+                        access: file.access.new(
+                          view: options[:view],
+                          download: options[:download],
+                          location: options[:location],
+                          controlledDigitalLending: !!options[:cdl] # rubocop:disable Style/DoubleNegation
+                        ),
+                        administrative: options[:view] == 'dark' ?
+                          { publish: false, shelve: false, sdrPreserve: file.administrative.sdrPreserve } :
+                          file.administrative
+                      )
+                    end
+                  )
+                )
+              end
+            )
+          )
+        end
+      end
+    end
+  end
+end