RubyGems - sdr-client - Versions diffs - 0.71.0 → 0.72.0 - Mend

sdr-client 0.71.0 → 0.72.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

checksums.yaml +4 -4
data/.rubocop.yml +2 -0
data/.rubocop_todo.yml +16 -5
data/README.md +46 -19
data/exe/sdr +2 -128
data/lib/sdr_client/cli.rb +137 -76
data/lib/sdr_client/deposit/file.rb +4 -4
data/lib/sdr_client/deposit/request.rb +11 -11
data/lib/sdr_client/deposit.rb +4 -4
data/lib/sdr_client/login.rb +3 -1
data/lib/sdr_client/update.rb +125 -10
data/lib/sdr_client/version.rb +1 -1
data/sdr-client.gemspec +2 -1
metadata +21 -7

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e12d569ac9f642a42311a80b9594a64398742274be65bd2298ddea5806aaa62
-  data.tar.gz: ba7c87706cf15a5904a44ac58f2d4303023eda9cef43224ad74e4b3e4ab4957b
+  metadata.gz: 899fec033d20f23ab887672fcfe7c706f9c6e5b02b7fd6975db5560be96b788c
+  data.tar.gz: cb68aa02ff81a59f50bdbc5003407765caa25d3e73d64f663e40c3990d1509df
 SHA512:
-  metadata.gz: 3f64850d5858f86b66a3cc1db3d38723ed35c78c4010f59e92af3affe945cc5bdc43dd13ff473f0e44ba256abb3a6ad1b7fac7bff8c76edca908271b64037bb7
-  data.tar.gz: 6b31ab8f77403f370e0ce7d520f98ec989e670bcb9700c779e039c3a19f84022411fb03e3d6d4ed057ee414f58229526722ae8b219d2285359bc2e99c0ef2d14
+  metadata.gz: a53a001759ad7c941c1713999f1dfcd15a43c4200fff5644605dd277f2e8ce4c52497e8e1662a7b43fb896860f20dfc42380a8249fa47702e9106a5ecf4bf1c1
+  data.tar.gz: f1de6ce23106680288c2994e7ba085a9ef4aed3cbf2ecbbb315c8c4601a01aba134d5bcfd3b316fb7a242a99ebcad89cbf8f22929e2099cad3f001f62ac3c74a

data/.rubocop.yml CHANGED Viewed

@@ -19,7 +19,9 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Exclude:
+    - 'lib/sdr_client/cli.rb'
     - 'lib/sdr_client/deposit/request.rb'
+    - 'lib/sdr_client/update.rb'
 Naming/FileName:
   Exclude:

data/.rubocop_todo.yml CHANGED Viewed

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2022-03-08 23:08:23 UTC using RuboCop version 1.25.1.
+# on 2022-03-11 00:50:54 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,17 +26,19 @@ Lint/UnusedMethodArgument:
     - 'lib/sdr_client/deposit/file_type_file_set_strategy.rb'
     - 'lib/sdr_client/deposit/image_file_set_strategy.rb'
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
     - 'lib/sdr_client/cli.rb'
+    - 'lib/sdr_client/update.rb'
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: IgnoredMethods, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
     - 'lib/sdr_client/cli.rb'
+    - 'lib/sdr_client/update.rb'
 # Offense count: 11
 # Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
@@ -50,12 +52,13 @@ Metrics/MethodLength:
     - 'lib/sdr_client/login.rb'
     - 'lib/sdr_client/update.rb'
-# Offense count: 8
+# Offense count: 10
 # Configuration parameters: Max, CountAsOne.
 RSpec/ExampleLength:
   Exclude:
     - 'spec/sdr_client/deposit_spec.rb'
     - 'spec/sdr_client/model_deposit_spec.rb'
+    - 'spec/sdr_client/update_spec.rb'
 # Offense count: 3
 # Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
@@ -119,6 +122,12 @@ Style/KeywordParametersOrder:
     - 'lib/sdr_client/deposit.rb'
     - 'lib/sdr_client/deposit/request.rb'
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MultilineTernaryOperator:
+  Exclude:
+    - 'lib/sdr_client/update.rb'
 # Offense count: 2
 # Cop supports --auto-correct-all.
 # Configuration parameters: Mode.
@@ -127,12 +136,14 @@ Style/StringConcatenation:
     - 'lib/sdr_client/deposit/create_resource.rb'
     - 'spec/sdr_client/deposit_spec.rb'
-# Offense count: 16
+# Offense count: 19
 # Cop supports --auto-correct.
 # Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
   Exclude:
+    - 'lib/sdr_client/cli.rb'
     - 'lib/sdr_client/deposit/model_process.rb'
+    - 'lib/sdr_client/update.rb'
     - 'spec/sdr_client/deposit/model_process_spec.rb'
     - 'spec/sdr_client/deposit/process_spec.rb'

data/README.md CHANGED Viewed

@@ -17,55 +17,82 @@ We recommend using the latest 3.x release of Ruby.
 ## Usage
+Get general help (e.g., list out commands):
+```
+sdr help
+# or:
+sdr -h
+# or:
+sdr --help
+```
+Get help for a specific command:
+```
+sdr help register
+```
 Log in:
 ```
-sdr --service-url https://sdr-api-server:3000 login
+sdr login --url https://sdr-api-server:3000
+```
+Display version of sdr-client:
+```
+sdr version
 ```
 Register a new object:
 ```
-sdr --service-url https://sdr-api-server:3000 register --label 'hey there' \
+sdr register file1.png file2.png --url https://sdr-api-server:3000 \
+  --label 'hey there' \
   --admin-policy 'druid:bk123gh4567' \
   --collection 'druid:gh456kw9876' \
-  --source-id 'googlebooks:stanford_12345' file1.png file2.png
+  --source-id 'googlebooks:stanford_12345'
 ```
 Deposit (register + accession) a new object:
 ```
-sdr --service-url https://sdr-api-server:3000 deposit --label 'hey there' \
+sdr deposit file1.png file2.png --url https://sdr-api-server:3000 \
+  --label 'hey there' \
   --admin-policy 'druid:bk123gh4567' \
   --collection 'druid:gh456kw9876' \
-  --source-id 'googlebooks:stanford_12345' file1.png file2.png
+  --source-id 'googlebooks:stanford_12345'
 ```
 Deposit a new object, providing metadata for files:
 ```
-sdr --service-url https://sdr-api-server:3000 deposit --label 'hey there' \
+sdr deposit image42.jp2 ocr.html --url https://sdr-api-server:3000 \
+  --label 'hey there' \
   --files-metadata '{"image42.jp2":{"mime_type":"image/jp2"},"ocr.html":{"use":"transcription"}}'
   --admin-policy 'druid:bk123gh4567' \
   --collection 'druid:gh456kw9876' \
-  --source-id 'googlebooks:stanford_12345' image42.jp2 ocr.html
+  --source-id 'googlebooks:stanford_12345'
 ```
 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
+sdr get druid:bw581ng3176 --url https://sdr-api-server:3000
+{"type":"https://cocina.sul.stanford.edu/models/document","externalIdentifier":"druid:bw581ng3176","label":"Something something better title","version":1,"access":{"view":"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":"https://cocina.sul.stanford.edu/models/resources/file","externalIdentifier":"bw581ng3176_1","label":"Test file","version":1,"structural":{"contains":[{"type":"https://cocina.sul.stanford.edu/models/file","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":{"view":"world","download":"world"},"administrative":{"sdrPreserve":true,"shelve":true}}]}}]}}
 ```
-Update an object, changing its admin policy object (APO):
+Update an object:
 ```
-sdr --service-url https://sdr-api-server:3000 update --admin-policy druid:bx911tp9024 druid:bb408qn5061
+# 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
 ```
 ## Testing
-To test running sdr-client against the SDR API, which itself has dependencies on other SDR services, we tend to test against our running SDR QA environment. Make sure you are connected to VPN throughout your testing, and pass `https://sdr-api-qa.stanford.edu` as the value to the `--service-url` flag for the commands above.
+To test running sdr-client against the SDR API, which itself has dependencies on other SDR services, we tend to test against our running SDR QA environment. Make sure you are connected to VPN throughout your testing, and pass `https://sdr-api-qa.stanford.edu` as the value to the `--url` flag for the commands above.
-**WARNING**: if you omit the `--service-url` flag, the sdr-client CLI by default operates against the production environment.
+**WARNING**: if you omit the `--url` flag, the sdr-client CLI by default operates against the production environment.

data/exe/sdr CHANGED Viewed

@@ -2,133 +2,7 @@
 # frozen_string_literal: true
 $LOAD_PATH.unshift 'lib'
-require 'optparse'
-require 'sdr_client'
-options = {}
-global = OptionParser.new do |opts|
-  opts.on('--service-url URL', 'Connect to the host at this URL') do |url|
-    options[:url] = url
-  end
-  opts.on('-h', '--help', 'Display this screen') do
-    SdrClient::CLI.help
-  end
-end
-global.order!
-command = ARGV.shift
-deposit_options = OptionParser.new do |opts|
-  opts.banner = "Usage: sdr #{command} [options]"
-  opts.on('--label LABEL', 'The object label') do |label|
-    options[:label] = label
-  end
-  opts.on('--admin-policy ADMIN_POLICY', 'The druid identifier of the admin policy object') do |apo|
-    options[:apo] = apo
-  end
-  opts.on('--type TYPE', 'The object type to create. ' \
-                         'One of: "image", "book", "document", "map", "manuscript", "media", ' \
-                         '"three_dimensional", "object", "collection", or "admin_policy"') do |type|
-    if %w[image book document map manuscript media three_dimensional object collection admin_policy].include?(type)
-      options[:type] = "http://cocina.sul.stanford.edu/models/#{type}.jsonld"
-    end
-  end
-  opts.on('--collection COLLECTION', 'The druid identifier of the collection object') do |collection|
-    options[:collection] = collection
-  end
-  opts.on('--catkey CATKEY', 'The catkey for this item') do |catkey|
-    options[:catkey] = catkey
-  end
-  opts.on('--source-id SOURCE_ID', 'The source id for this object') do |source_id|
-    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)
-  end
-  opts.on('--access LEVEL', 'The access level for this object. ' \
-                            'Either "world", "stanford", "location-based", "citation-only" or "dark"') do |level|
-    options[:access] = level if %w[world stanford location-based citation-only dark].include?(level)
-  end
-  opts.on('--files-metadata FILES_METADATA', 'A JSON object representing per-file metadata') do |files_metadata|
-    options[:files_metadata] = JSON.parse(files_metadata)
-  end
-  opts.on('--strategy STRATEGY',
-          'The strategy to use for distributing files into filesets. Either "default" or "filename"') do |strategy|
-    strategy_class = case strategy
-                     when 'filename'
-                       SdrClient::Deposit::MatchingFileGroupingStrategy
-                     when 'default'
-                       SdrClient::Deposit::SingleFileGroupingStrategy
-                     else
-                       warn "Unknown strategy #{strategy}"
-                       exit(1)
-                     end
-    options[:grouping_strategy] = strategy_class
-  end
-  opts.on('-h', '--help', 'Display this screen') do
-    puts opts
-    exit
-  end
-end
-update_options = OptionParser.new do |opts|
-  opts.banner = "Usage: sdr #{command} [options]"
-  opts.on('--admin-policy ADMIN_POLICY', 'The druid identifier of the admin policy object') do |apo|
-    options[:apo] = apo
-  end
-  opts.on('-h', '--help', 'Display this screen') do
-    puts opts
-    exit
-  end
-end
-SdrClient::CLI.help unless command
-subcommands = {
-  'deposit' => deposit_options,
-  'get' => OptionParser.new,
-  'login' => OptionParser.new,
-  'register' => deposit_options,
-  'update' => update_options,
-  'version' => OptionParser.new
-}
-unless subcommands.key?(command)
-  puts "unknown command '#{command}'"
-  SdrClient::CLI.help
-end
-subcommands[command].order!
-options[:url] ||= 'https://sdr-api-prod.stanford.edu'
+require 'sdr_client'
-begin
-  SdrClient::CLI.start(command, options, ARGV)
-rescue StandardError => e
-  warn "There was a problem making your request:\n\n"
-  warn e.message
-  puts
-  puts subcommands[command].help
-end
+SdrClient::CLI.start(ARGV)

data/lib/sdr_client/cli.rb CHANGED Viewed

@@ -1,111 +1,172 @@
 # frozen_string_literal: true
-module SdrClient
-  # The command line interface
-  module CLI
-    HELP = <<~HELP
-      DESCRIPTION:
-        The SDR Command Line Interface is a tool to interact with the Stanford Digital Repository.
-      SYNOPSIS:
-        sdr [options] <command>
-        To see help text for each command you can run:
-        sdr [options] <command> help
-      OPTIONS:
-        --service-url (string)
-        Override the command's default URL with the given URL. Default: https://sdr-api-prod.stanford.edu
-        -h, --help
-        Displays this screen
+require 'thor'
+module SdrClient
+  # The SDR command-line interface
+  class CLI < Thor
+    include Thor::Actions
+    # Make sure Thor commands preserve exit statuses
+    # @see https://github.com/rails/thor/wiki/Making-An-Executable
+    def self.exit_on_failure?
+      true
+    end
-      COMMANDS:
-        get
-          Retrieve an object from the SDR
+    # Print out help and exit with error code if command not found
+    def self.handle_no_command_error(command)
+      puts "Command '#{command}' not found, displaying help:"
+      puts
+      puts help
+      exit(1)
+    end
-        deposit
-          Accession an object into the SDR
+    def self.default_url
+      'https://sdr-api-prod.stanford.edu'
+    end
-        register
-          Create a draft object in the SDR and retrieve a Druid identifier
+    package_name 'sdr'
-        update
-          Update an object in the SDR
+    class_option :url, desc: 'URL of SDR API endpoint', type: :string, default: default_url
-        login
-          Will prompt for email & password and exchange it for an login token (saved in ~/.sdr/token)
+    desc 'get DRUID', 'Retrieve an object from the SDR'
+    def get(druid)
+      say SdrClient::Find.run(druid, url: options[:url])
+    rescue SdrClient::Credentials::NoCredentialsError
+      say_error 'Log in first'
+      exit(1)
+    end
-        version
-          Display the sdr-client version
+    desc 'login', 'Prompt for email & password and create a login token (saved in ~/.sdr/token)'
+    def login
+      status = SdrClient::Login.run(
+        url: options[:url],
+        login_service: lambda do
+          {
+            email: ask('Email:'),
+            password: ask('Password:', echo: false)
+          }
+        end
+      )
+      return puts unless status.failure?
-    HELP
+      say_error status.failure
+      exit(1)
+    end
-    def self.start(command, options, arguments = [])
-      case command
-      when 'get'
-        puts SdrClient::Find.run(arguments.first, **options)
-      when 'deposit', 'register'
-        deposit(command, options, arguments)
-      when 'update'
-        if arguments.size != 1 || !arguments.first.is_a?(String)
-          raise "Expected a single druid argument, received #{arguments}"
-        end
+    desc 'version', 'Display the SDR CLI version'
+    def version
+      say SdrClient::VERSION
+    end
-        job_id = SdrClient::Update.run(arguments.first, **options)
-        poll_for_job_complete(job_id: job_id, url: options[:url]) # TODO: add an option that skips this
-      when 'login'
-        status = SdrClient::Login.run(**options)
-        puts status.failure if status.failure?
-      when 'version'
-        puts SdrClient::VERSION
-      else
-        raise "Unknown command #{command}"
-      end
+    desc 'update DRUID', 'Update an object in the SDR'
+    option :skip_polling, type: :boolean, default: false, aliases: '-s', desc: 'Print out job ID instead of polling for result'
+    option :apo, desc: 'Druid identifier of the admin policy object', aliases: '--admin-policy'
+    option :collection, desc: 'Druid identifier of the collection object'
+    option :copyright, desc: 'Copyright statement'
+    option :use_and_reproduction, desc: 'Use and reproduction statement'
+    option :license, desc: 'License URI'
+    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
+    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
     rescue SdrClient::Credentials::NoCredentialsError
-      puts 'Log in first'
+      say_error 'Log in first'
       exit(1)
     end
-    def self.deposit(command, options, arguments)
-      options[:files] = arguments if arguments.present?
-      display_errors(validate_deposit_options(options))
-      job_id = SdrClient::Deposit.run(accession: command == 'deposit', **options)
-      poll_for_job_complete(job_id: job_id, url: options[:url]) # TODO: add an option that skips this
+    desc 'deposit OPTIONAL_FILES', 'Deposit (accession) an object into the SDR'
+    option :skip_polling, type: :boolean, default: false, aliases: '-s', desc: 'Print out job ID instead of polling for result'
+    option :apo, required: true, desc: 'Druid identifier of the admin policy object', aliases: '--admin-policy'
+    option :source_id, required: true, desc: 'Source ID for this object'
+    option :label, desc: 'Object label'
+    option :type, enum: %w[image book document map manuscript media three_dimensional object collection admin_policy], desc: 'The object type'
+    option :collection, desc: 'Druid identifier of the collection object'
+    option :catkey, desc: 'Catkey for this item'
+    option :copyright, desc: 'Copyright statement'
+    option :use_and_reproduction, desc: 'Use and reproduction statement'
+    option :viewing_direction, enum: %w[left-to-right right-to-left], desc: 'Viewing direction (if a book)'
+    option :view, enum: %w[world stanford location-based citation-only dark], desc: 'Access view level for the object'
+    option :files_metadata, desc: 'JSON string representing per-file metadata'
+    option :grouping_strategy, enum: %w[default filename], desc: 'Strategy for grouping files into filesets'
+    def deposit(*files)
+      register_or_deposit(files: files, accession: true)
     end
-    def self.display_errors(errors)
-      return if errors.empty?
+    desc 'register OPTIONAL_FILES', 'Create a draft object in the SDR and retrieve a Druid identifier'
+    option :skip_polling, type: :boolean, default: false, aliases: '-s', desc: 'Print out job ID instead of polling for result'
+    option :apo, required: true, desc: 'Druid identifier of the admin policy object', aliases: '--admin-policy'
+    option :source_id, required: true, desc: 'Source ID for this object'
+    option :label, desc: 'Object label'
+    option :type, enum: %w[image book document map manuscript media three_dimensional object collection admin_policy], desc: 'The object type'
+    option :collection, desc: 'Druid identifier of the collection object'
+    option :catkey, desc: 'Catkey for this item'
+    option :copyright, desc: 'Copyright statement'
+    option :use_and_reproduction, desc: 'Use and reproduction statement'
+    option :viewing_direction, enum: %w[left-to-right right-to-left], desc: 'Viewing direction (if a book)'
+    option :view, enum: %w[world stanford location-based citation-only dark], desc: 'Access view level for the object'
+    option :files_metadata, desc: 'JSON string representing per-file metadata'
+    option :grouping_strategy, enum: %w[default filename], desc: 'Strategy for grouping files into filesets'
+    def register(*files)
+      register_or_deposit(files: files, accession: false)
+    end
-      raise errors.map { |k, v| "#{k} #{v}" }.join("\n")
+    private
+    def register_or_deposit(files:, accession:)
+      opts = munge_options(options, files)
+      skip_polling = opts.delete(:skip_polling)
+      job_id = SdrClient::Deposit.run(accession: accession, **opts)
+      return if skip_polling
+      poll_for_job_complete(job_id: job_id, url: opts[:url])
+    rescue SdrClient::Credentials::NoCredentialsError
+      say_error 'Log in first'
+      exit(1)
     end
-    def self.validate_deposit_options(options)
-      {}.tap do |errors|
-        errors['admin-policy'] = 'is a required argument' unless options[:apo]
-        errors['source-id'] = 'is a required argument' unless options[:source_id]
+    def munge_options(options, files)
+      options.to_h.symbolize_keys.tap do |opts|
+        opts[:files] = files if files.present?
+        opts[:type] = Cocina::Models::ObjectType.public_send(options[:type]) if options[:type]
+        opts[:files_metadata] = JSON.parse(options[:files_metadata]) if options[:files_metadata]
+        if options[:grouping_strategy]
+          opts[:grouping_strategy] = if options[:grouping_strategy] == 'filename'
+                                       SdrClient::Deposit::MatchingFileGroupingStrategy
+                                     else
+                                       SdrClient::Deposit::SingleFileGroupingStrategy
+                                     end
+        end
       end
     end
-    def self.help
-      puts HELP
-      exit
+    def validate_druid!(druid)
+      return if druid.present?
+      say_error "Not a valid druid: #{druid.inspect}"
+      exit(1)
     end
-    def self.poll_for_job_complete(job_id:, url:)
+    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)
       result = nil
-      1.upto(5) do |_n|
+      (1).upto(60) do
         result = SdrClient::BackgroundJobResults.show(url: url, job_id: job_id)
-        break unless %w[pending processing].include? result['status']
+        break unless %w[pending processing].include?(result['status'])
-        sleep 5
+        # the extra args to `say` prevent appending a newline
+        say('.', nil, false)
+        sleep 1
       end
       if result['status'] == 'complete'
-        puts result.dig('output', 'druid')
+        say " success! (druid: #{result.dig('output', 'druid')})"
       else
-        warn "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/deposit/file.rb CHANGED Viewed

@@ -6,16 +6,16 @@ module SdrClient
     class File
       # rubocop:disable Metrics/ParameterLists
       def initialize(external_identifier:, label:, filename:,
-                     access: 'dark', download: 'none', preserve: true, shelve: true,
+                     view: '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
+        @view = view
         @download = download
         @preserve = preserve
-        @shelve = access == 'dark' ? false : shelve
+        @shelve = view == 'dark' ? false : shelve
         @publish = publish
         @mime_type = mime_type
         @md5 = md5
@@ -31,7 +31,7 @@ module SdrClient
           filename: @filename,
           externalIdentifier: @external_identifier,
           access: {
-            view: @access,
+            view: @view,
             download: @download
           },
           administrative: {

data/lib/sdr_client/deposit/request.rb CHANGED Viewed

@@ -13,9 +13,9 @@ module SdrClient
       # Additional metadata includes access, preserve, shelve, publish, md5, sha1
       # rubocop:disable Metrics/ParameterLists
       def initialize(label: nil,
-                     access: 'dark',
+                     view: 'dark',
                      download: 'none',
-                     use_statement: nil,
+                     use_and_reproduction: nil,
                      copyright: nil,
                      apo:,
                      collection: nil,
@@ -36,9 +36,9 @@ module SdrClient
         @embargo_release_date = embargo_release_date
         @embargo_access = embargo_access
         @embargo_download = embargo_download
-        @access = access
+        @view = view
         @download = download
-        @use_statement = use_statement
+        @use_and_reproduction = use_and_reproduction
         @copyright = copyright
         @apo = apo
         @file_sets = file_sets
@@ -62,7 +62,7 @@ module SdrClient
       # @return [Request] a clone of this request with the file_sets added
       def with_file_sets(file_sets)
         Request.new(label: label,
-                    access: access,
+                    view: view,
                     download: download,
                     apo: apo,
                     collection: collection,
@@ -73,7 +73,7 @@ module SdrClient
                     embargo_access: embargo_access,
                     embargo_download: embargo_download,
                     type: type,
-                    use_statement: use_statement,
+                    use_and_reproduction: use_and_reproduction,
                     viewing_direction: viewing_direction,
                     file_sets: file_sets,
                     files_metadata: files_metadata)
@@ -83,7 +83,7 @@ module SdrClient
       # @return [Hash] the metadata for the file
       def for(filename)
         metadata = files_metadata.fetch(filename, {}).with_indifferent_access
-        metadata[:access] = access unless metadata.key?(:access)
+        metadata[:view] = view unless metadata.key?(:view)
         metadata[:download] = download unless metadata.key?(:download)
         metadata
       end
@@ -92,9 +92,9 @@ module SdrClient
       private
-      attr_reader :access, :label, :file_sets, :source_id, :catkey, :apo, :collection,
+      attr_reader :view, :label, :file_sets, :source_id, :catkey, :apo, :collection,
                   :files_metadata, :embargo_release_date, :embargo_access, :embargo_download,
-                  :viewing_direction, :use_statement, :copyright, :download
+                  :viewing_direction, :use_and_reproduction, :copyright, :download
       def administrative
         {
@@ -118,10 +118,10 @@ module SdrClient
       def access_struct
         {
-          view: access,
+          view: view,
           download: download
         }.tap do |json|
-          json[:useAndReproductionStatement] = use_statement if use_statement
+          json[:useAndReproductionStatement] = use_and_reproduction if use_and_reproduction
           json[:copyright] = copyright if copyright
           if embargo_release_date

data/lib/sdr_client/deposit.rb CHANGED Viewed

@@ -12,9 +12,9 @@ module SdrClient
     def self.run(label: nil,
                  type: BOOK_TYPE,
                  viewing_direction: nil,
-                 access: 'dark',
+                 view: 'dark',
                  download: 'none',
-                 use_statement: nil,
+                 use_and_reproduction: nil,
                  copyright: nil,
                  apo:,
                  collection: nil,
@@ -33,10 +33,10 @@ module SdrClient
       augmented_metadata = FileMetadataBuilder.build(files: files, files_metadata: files_metadata)
       metadata = Request.new(label: label,
                              type: type,
-                             access: access,
+                             view: view,
                              download: download,
                              apo: apo,
-                             use_statement: use_statement,
+                             use_and_reproduction: use_and_reproduction,
                              copyright: copyright,
                              collection: collection,
                              source_id: source_id,

data/lib/sdr_client/login.rb CHANGED Viewed

@@ -8,7 +8,9 @@ module SdrClient
     # @return [Result] the status of the call
     def self.run(url:, login_service: LoginPrompt, credential_store: Credentials)
-      request_json = JSON.generate(login_service.run)
+      request_json = JSON.generate(
+        login_service.respond_to?(:run) ? login_service.run : login_service.call
+      )
       response = Faraday.post(url + LOGIN_PATH, request_json, 'Content-Type' => 'application/json')
       case response.status
       when 200

data/lib/sdr_client/update.rb CHANGED Viewed

@@ -2,24 +2,139 @@
 module SdrClient
   # The namespace for the "update" command
-  module Update
+  class Update
     # @return [String] job id for the background job result
-    def self.run(druid, apo:, url:, logger: Logger.new($stdout))
-      cocina_item = Cocina::Models.build(
+    def self.run(druid, **options)
+      new(druid, **options).run
+    end
+    def initialize(druid, **options)
+      @druid = druid
+      @url = options.fetch(:url)
+      @options = options
+    end
+    # @return [String] job id for the background job result
+    def run
+      SdrClient::Deposit::UpdateResource.run(
+        metadata: updated_cocina_item,
+        logger: options[:logger] || Logger.new($stdout),
+        connection: SdrClient::Connection.new(url: url)
+      )
+    end
+    private
+    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) }
+    end
+    def original_cocina_item
+      Cocina::Models.build(
         JSON.parse(
           SdrClient::Find.run(druid, url: url)
         )
       )
+    end
-      SdrClient::Deposit::UpdateResource.run(
-        metadata: cocina_item.new(
-          administrative: cocina_item.administrative.new(
-            hasAdminPolicy: apo
-          )
+    # 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]
+      cocina_item.new(
+        administrative: cocina_item.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]
+      cocina_item.new(
+        structural: cocina_item.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]
+      cocina_item.new(
+        access: cocina_item.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]
+      cocina_item.new(
+        access: cocina_item.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]
+      cocina_item.new(
+        access: cocina_item.access.new(
+          license: options[:license]
+        )
+      )
+    end
+    # 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]
+      cocina_item.new(
+        access: cocina_item.access.new(
+          view: options[:view],
+          download: options[:download],
+          location: options[:location],
+          controlledDigitalLending: !!options[:cdl]
         ),
-        logger: logger,
-        connection: Connection.new(url: url)
+        structural: cocina_item.structural.new(
+          contains: cocina_item.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]
+                    ),
+                    administrative: options[:view] == 'dark' ?
+                      { publish: false, shelve: false, sdrPreserve: file.administrative.sdrPreserve } :
+                      file.administrative
+                  )
+                end
+              )
+            )
+          end
+        )
       )
     end
+    # rubocop:enable Style/DoubleNegation
   end
 end

data/lib/sdr_client/version.rb CHANGED Viewed

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

data/sdr-client.gemspec CHANGED Viewed

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.add_dependency 'activesupport'
-  spec.add_dependency 'cocina-models', '~> 0.68.0'
+  spec.add_dependency 'cocina-models', '~> 0.69.0'
   spec.add_dependency 'dry-monads'
   spec.add_dependency 'faraday', '>= 0.16'
@@ -39,6 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'rubocop-rspec', '~> 2.1'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'thor'
   spec.add_development_dependency 'webmock', '~> 3.7'
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 0.71.0
+  version: 0.72.0
 platform: ruby
 authors:
 - Justin Coyne
-autorequire:
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-09 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.68.0
+        version: 0.69.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.68.0
+        version: 0.69.0
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -242,7 +256,7 @@ metadata:
   source_code_uri: https://github.com/sul-dlss/sdr-client
   changelog_uri: https://github.com/sul-dlss/sdr-client/releases
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -258,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.32
-signing_key:
+signing_key:
 specification_version: 4
 summary: The CLI for https://github.com/sul-dlss/sdr-api
 test_files: []