sdr-client 0.24.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f92b0d70c5366c86418ad01a473b5d53bebb37d859bedb6c4691aef20a6132ef
-  data.tar.gz: e446643bfe2f36ccf1c9c9427fe08d2d7c18243fe473130a53b4c97666fdce6d
+  metadata.gz: 8218f375715174e3c821a50017c93d6ea7608dec9e6d8eb3079da95687079ccf
+  data.tar.gz: bcf2362444e2fcaff1da53670d421d2886a37c2e0cad1a49c312bf8d41d7decb
 SHA512:
-  metadata.gz: aa71b48545dba510d6dea80de35e2877c032c242c55100d2a7f843e135bcce1f58e70420125ea5a53cd58ace6d3b276af151f279ef6ece4860d794c15fec1acc
-  data.tar.gz: d0c599640567dbfb29a93d49d278aa9699d4ce8dab5071d594e22d135952ad05102e929098347fa38cc41ba6392435c7f282cdce60a6c88f6e41447f9b42f808
+  metadata.gz: c864d1c6642d3625a3d02e7d19cce2f434835baa67dd8d71e6060ed2ab45676eb7b4b7f930e1d2dac74cf640da29832fdab2e4c006e5cbed9723568274364972
+  data.tar.gz: aaa132697e45bad33b362b3bb7c9eb431c2f718115c7cab985619376b29f62b1b9451c2e3a4276f6ab29b415e943ddced44527340c3d2526ba1d4459948a919a

data/.github/pull_request_template.md

@@ -2,4 +2,11 @@
 
 
 
-## Was the documentation (README, wiki) updated?
+## How was this change tested?
+
+
+
+## Which documentation and/or configurations were updated?
+
+
+

data/.rubocop_todo.yml

@@ -1,16 +1,17 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-03-02 15:54:47 -0600 using RuboCop version 0.79.0.
+# on 2020-04-27 08:24:29 -0400 using RuboCop version 0.82.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
   Max: 16
 
-# Offense count: 4
+# Offense count: 7
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
-  Max: 14
+  Max: 15

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'sdr/client'
+require 'sdr_client'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/exe/sdr

@@ -6,37 +6,13 @@ 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
-    puts <<~HELP
-      DESCRIPTION:
-        The SDR Command Line Interface is a tool to interact with the Stanford Digital Repository.
-
-      SYNOPSIS:
-        sdr [options] <command>
-
-      OPTIONS:
-        --service-url (string)
-        Override the command's default URL with the given URL.
-
-        -h, --help
-        Displays this screen
-
-      COMMANDS
-        deposit
-        accession object into the SDR
-
-        register
-        create a draft object in SDR
-
-        login
-        Will prompt for email & password and exchange it for an login token, which it saves in ~/.sdr/token
-
-    HELP
-    exit
+    SdrClient::CLI.help
   end
 end
 
@@ -44,6 +20,7 @@ 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
@@ -54,8 +31,8 @@ deposit_options = OptionParser.new do |opts|
 
   opts.on('--type TYPE', 'The object type to create. ' \
           'One of: "image", "book", "document", "map", "manuscript", "media", ' \
-          '"three_dimensional", "collection", or "admin_policy"') do |type|
-    if %w[image book document map manuscript media three_dimensional collection admin_policy].include?(type)
+          '"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
@@ -114,6 +91,8 @@ deposit_options = OptionParser.new do |opts|
   end
 end
 
+SdrClient::CLI.help unless command
+
 subcommands = {
   'deposit' => deposit_options,
   'register' => deposit_options,
@@ -122,10 +101,19 @@ subcommands = {
 
 unless subcommands.key?(command)
   puts "unknown command '#{command}'"
-  exit
+  SdrClient::CLI.help
 end
 
 subcommands[command].order!
 
 options[:files] = ARGV unless ARGV.empty?
-SdrClient::CLI.start(command, options)
+options[:url] ||= 'https://sdr-api-prod.stanford.edu'
+
+begin
+  SdrClient::CLI.start(command, options)
+rescue StandardError => e
+  warn "There was a problem making your request:\n\n"
+  warn e.message
+  puts
+  puts subcommands[command].help
+end

data/lib/sdr_client.rb

@@ -9,12 +9,12 @@ require 'cocina/models'
 
 require 'sdr_client/version'
 require 'sdr_client/deposit'
-require 'sdr_client/model_deposit'
 require 'sdr_client/credentials'
 require 'sdr_client/login'
 require 'sdr_client/login_prompt'
 require 'sdr_client/cli'
 require 'sdr_client/connection'
+require 'sdr_client/background_job_results'
 
 module SdrClient
   class Error < StandardError; end

data/lib/sdr_client/background_job_results.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module SdrClient
+  # API calls around background job results from dor-services-app
+  module BackgroundJobResults
+    # Get status/result of a background job
+    # @param url [String] url for the service
+    # @param job_id [String] required string representing a job identifier
+    # @return [Hash] result of background job
+    def self.show(url:, job_id:)
+      connection = Connection.new(url: "#{url}/v1/background_job_results/#{job_id}").connection
+      resp = connection.get
+
+      raise "unexpected response: #{resp.status} #{resp.body}" unless resp.success?
+
+      JSON.parse(resp.body).with_indifferent_access
+    end
+  end
+end

data/lib/sdr_client/cli.rb

@@ -3,15 +3,46 @@
 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.
+
+        -h, --help
+        Displays this screen
+
+
+      COMMANDS:
+        deposit
+          Accession an object into the SDR
+
+        register
+          Create a draft object in SDR and retrieve a Druid identifier.
+
+        login
+          Will prompt for email & password and exchange it for an login token, which it saves in ~/.sdr/token
+
+    HELP
+
     def self.start(command, options)
       case command
-      when 'deposit'
-        SdrClient::Deposit.run(accession: true, **options)
-      when 'register'
-        SdrClient::Deposit.run(accession: false, **options)
+      when 'deposit', 'register'
+        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
       when 'login'
         status = SdrClient::Login.run(options)
-        puts status.value if status.failure?
+        puts status.failure if status.failure?
       else
         raise "Unknown command #{command}"
       end
@@ -19,5 +50,38 @@ module SdrClient
       puts 'Log in first'
       exit(1)
     end
+
+    def self.display_errors(errors)
+      return if errors.empty?
+
+      raise errors.map { |k, v| "#{k} #{v}" }.join("\n")
+    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]
+      end
+    end
+
+    def self.help
+      puts HELP
+      exit
+    end
+
+    def self.poll_for_job_complete(job_id:, url:)
+      result = nil
+      1.upto(5) do |_n|
+        result = SdrClient::BackgroundJobResults.show(url: url, job_id: job_id)
+        break unless %w[pending processing].include? result['status']
+
+        sleep 5
+      end
+      if result['status'] == 'complete'
+        puts result.dig('output', 'druid')
+      else
+        warn "Job #{job_id} did not complete\n#{result.inspect}"
+      end
+    end
   end
 end

data/lib/sdr_client/deposit.rb

@@ -8,10 +8,12 @@ module SdrClient
     BOOK_TYPE = 'http://cocina.sul.stanford.edu/models/book.jsonld'
     # rubocop:disable Metrics/ParameterLists
     # rubocop:disable Metrics/MethodLength
+    # @return [String] job id for the background job result
     def self.run(label: nil,
                  type: BOOK_TYPE,
                  viewing_direction: nil,
                  access: 'dark',
+                 download: 'none',
                  use_statement: nil,
                  copyright: nil,
                  apo:,
@@ -30,6 +32,7 @@ module SdrClient
       metadata = Request.new(label: label,
                              type: type,
                              access: access,
+                             download: download,
                              apo: apo,
                              use_statement: use_statement,
                              copyright: copyright,
@@ -48,6 +51,19 @@ module SdrClient
     end
     # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/ParameterLists
+
+    def self.model_run(request_dro:,
+                       files: [],
+                       url:,
+                       accession:,
+                       logger: Logger.new(STDOUT))
+      connection = Connection.new(url: url)
+      ModelProcess.new(request_dro: request_dro,
+                       connection: connection,
+                       files: files,
+                       logger: logger,
+                       accession: accession).run
+    end
   end
 end
 require 'json'
@@ -60,6 +76,7 @@ require 'sdr_client/deposit/file_metadata_builder'
 require 'sdr_client/deposit/file_set'
 require 'sdr_client/deposit/request'
 require 'sdr_client/deposit/metadata_builder'
+require 'sdr_client/deposit/model_process'
 require 'sdr_client/deposit/process'
 require 'sdr_client/deposit/upload_files'
 require 'sdr_client/deposit/upload_resource'

data/lib/sdr_client/deposit/file_metadata_builder_operations/mime_type.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'digest'
+require 'shellwords'
 
 module SdrClient
   module Deposit
@@ -9,7 +9,8 @@ module SdrClient
       class MimeType
         NAME = 'mime_type'
         def self.for(file_path:, **)
-          `file --mime-type -b #{file_path}`.chomp
+          argv = Shellwords.escape(file_path)
+          `file --mime-type -b #{argv}`.chomp
         end
       end
     end

data/lib/sdr_client/deposit/process.rb

@@ -26,6 +26,7 @@ module SdrClient
       # rubocop:enable Metrics/ParameterLists
 
       # rubocop:disable Metrics/AbcSize
+      # @return [String] job id for the background job result
       def run
         check_files_exist
         upload_responses = UploadFiles.new(files: files,

data/lib/sdr_client/deposit/request.rb

@@ -14,6 +14,7 @@ module SdrClient
       # rubocop:disable Metrics/ParameterLists
       def initialize(label: nil,
                      access: 'dark',
+                     download: 'none',
                      use_statement: nil,
                      copyright: nil,
                      apo:,
@@ -34,6 +35,7 @@ module SdrClient
         @embargo_release_date = embargo_release_date
         @embargo_access = embargo_access
         @access = access
+        @download = download
         @use_statement = use_statement
         @copyright = copyright
         @apo = apo
@@ -59,6 +61,7 @@ module SdrClient
       def with_file_sets(file_sets)
         Request.new(label: label,
                     access: access,
+                    download: download,
                     apo: apo,
                     collection: collection,
                     copyright: copyright,
@@ -85,7 +88,7 @@ module SdrClient
 
       attr_reader :access, :label, :file_sets, :source_id, :catkey, :apo, :collection,
                   :files_metadata, :embargo_release_date, :embargo_access,
-                  :viewing_direction, :use_statement, :copyright
+                  :viewing_direction, :use_statement, :copyright, :download
 
       def administrative
         {
@@ -108,7 +111,10 @@ module SdrClient
       end
 
       def access_struct
-        { access: access }.tap do |json|
+        {
+          access: access,
+          download: download
+        }.tap do |json|
           json[:useAndReproductionStatement] = use_statement if use_statement
           json[:copyright] = copyright if copyright
 

data/lib/sdr_client/deposit/upload_resource.rb

@@ -21,14 +21,14 @@ module SdrClient
       end
 
       # @param [Hash<Symbol,String>] the result of the metadata call
-      # @return [Hash<Symbol,String>] the result of the metadata call
+      # @return [String] job id for the background job result
       def run
         response = metadata_request
         unexpected_response(response) unless response.status == 201
 
         logger.info("Response from server: #{response.body}")
 
-        { druid: JSON.parse(response.body)['druid'], background_job: response.headers['Location'] }
+        JSON.parse(response.body)['jobId']
       end
 
       private

data/lib/sdr_client/version.rb

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

data/sdr-client.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport'
-  spec.add_dependency 'cocina-models', '~> 0.32.0'
+  spec.add_dependency 'cocina-models', '~> 0.33.0'
   spec.add_dependency 'dry-monads'
   spec.add_dependency 'faraday', '>= 0.16'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.28.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.33.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.33.0
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +188,7 @@ files:
 - exe/sdr
 - lib/sdr-client.rb
 - lib/sdr_client.rb
+- lib/sdr_client/background_job_results.rb
 - lib/sdr_client/cli.rb
 - lib/sdr_client/connection.rb
 - lib/sdr_client/credentials.rb
@@ -210,7 +211,6 @@ files:
 - lib/sdr_client/deposit/upload_resource.rb
 - lib/sdr_client/login.rb
 - lib/sdr_client/login_prompt.rb
-- lib/sdr_client/model_deposit.rb
 - lib/sdr_client/version.rb
 - sdr-client.gemspec
 homepage: https://github.com/sul-dlss/sdr-client

data/lib/sdr_client/model_deposit.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require 'logger'
-
-module SdrClient
-  # The namespace for the "deposit" command
-  module Deposit
-    def self.model_run(request_dro:,
-                       files: [],
-                       url:,
-                       accession:,
-                       logger: Logger.new(STDOUT))
-      connection = Connection.new(url: url)
-      ModelProcess.new(request_dro: request_dro,
-                       connection: connection,
-                       files: files,
-                       logger: logger,
-                       accession: accession).run
-    end
-  end
-end
-require 'sdr_client/deposit/model_process'