sdr-client 0.19.0 → 0.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ae3d332b62dd4908555f961ffa5f9ebc12e0388836f36f855672731d8b940a1
-  data.tar.gz: 97c3c18fc7e4ed98b5577ea24390eef9f2ecbf8c24970c92fd3d3097a13b5492
+  metadata.gz: ef6a0e67af5c582f3b632f331026fad31f94076dc4801c12757f768f4ea62498
+  data.tar.gz: 1bde2dc32b1e498e5262b8eae90fdfb6656230e7be0cd22f3014b6f01eab24b6
 SHA512:
-  metadata.gz: f03baa42607cd68d3b814e46df38dda0567ca78082292faaf5ec47dfe518b68e0399f25305a89bed835bf68cde2e680f553646b4c921490ae06c7e426a812c5f
-  data.tar.gz: d392e1bfda994e6266ca4e6e1834036e76a5cfd37008c6ceda87ed6c20d4cbae9becef1fe8f47e3631f824dae7ae883735e0718dec7161488763d891f9d57121
+  metadata.gz: b63ab57e61e0576862ac5f256009489d2eda0c383e92e2ccf0869b205f7f452bb8e1099daeddcfd58809a85b929a51da986c1944146ee69d23a6b065d6510ac1
+  data.tar.gz: 9cb2e996ffcef442079961310c3185b5780561f1046dd5f5b5da682edd2a0703729fb39964c69160cc0467683ac65ca54cec43954ee2201573b45cff39b43ef6

data/.rubocop.yml

@@ -9,6 +9,8 @@ AllCops:
 
 Layout/LineLength:
   Max: 120
+  Exclude:
+    - 'spec/sdr_client/deposit/process_spec.rb'
 
 Metrics/BlockLength:
   Exclude:

data/README.md

@@ -21,8 +21,15 @@ Log in:
 sdr --service-url http://sdr-api-server:3000 login
 ```
 
+Register a new object:
+```
+sdr --service-url https://sdr-api-server:3000 register --label 'hey there' \
+  --admin-policy 'druid:bk123gh4567' \
+  --collection 'druid:gh456kw9876' \
+  --source-id 'googlebooks:stanford_12345' file1.png file2.png
+```
 
-Deposit a new object:
+Deposit (register + accession) a new object:
 ```
 sdr --service-url https://sdr-api-server:3000 deposit --label 'hey there' \
   --admin-policy 'druid:bk123gh4567' \

data/exe/sdr

@@ -27,7 +27,10 @@ global = OptionParser.new do |opts|
 
       COMMANDS
         deposit
-        deposit files to the SDR
+        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
@@ -40,77 +43,80 @@ end
 global.order!
 command = ARGV.shift
 
-subcommands = {
-  'deposit' => OptionParser.new do |opts|
-    opts.on('--label LABEL', 'The object label') do |label|
-      options[:label] = label
-    end
+deposit_options = OptionParser.new do |opts|
+  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('--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", "collection", or "admin_policy"') do |type|
-      if %w[image book document map manuscript media three_dimensional collection admin_policy].include?(type)
-        options[:type] = "http://cocina.sul.stanford.edu/models/#{type}.jsonld"
-      end
+  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)
+      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('--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('--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('--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('--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('--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('--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('--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('--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('--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,
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+end
+
+subcommands = {
+  'deposit' => deposit_options,
+  'register' => deposit_options,
   'login' => OptionParser.new
 }
 

data/lib/sdr_client.rb

@@ -4,6 +4,8 @@ require 'dry/monads'
 require 'faraday'
 require 'active_support'
 require 'active_support/core_ext/object/json'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'cocina/models'
 
 require 'sdr_client/version'
 require 'sdr_client/deposit'

data/lib/sdr_client/cli.rb

@@ -6,7 +6,9 @@ module SdrClient
     def self.start(command, options)
       case command
       when 'deposit'
-        SdrClient::Deposit.run(options)
+        SdrClient::Deposit.run(accession: true, **options)
+      when 'register'
+        SdrClient::Deposit.run(accession: false, **options)
       when 'login'
         status = SdrClient::Login.run(options)
         puts status.value if status.failure?

data/lib/sdr_client/connection.rb

@@ -3,6 +3,8 @@
 module SdrClient
   # The connection to the server
   class Connection
+    include Dry::Monads[:result]
+
     def initialize(url:, token: Credentials.read)
       @url = url
       @token = token
@@ -15,6 +17,21 @@ module SdrClient
       end
     end
 
+    # This is only available to certain blessed accounts (argo) as it gives the
+    # token that allows you to act as any other user. Thus the caller must authenticate
+    # the user (e.g. using Shibboleth) before calling this method with their email address.
+    # @param [String] the email address of the person to proxy to.
+    # @return [Result] the token for the account
+    def proxy(to)
+      response = connection.post("/v1/auth/proxy?to=#{to}")
+      case response.status
+      when 200
+        Success(response.body)
+      else
+        Failure("Status: #{response.status}\n#{response.body}")
+      end
+    end
+
     delegate :put, :post, to: :connection
 
     private

data/lib/sdr_client/deposit.rb

@@ -23,6 +23,7 @@ module SdrClient
                  url:,
                  files: [],
                  files_metadata: {},
+                 accession: false,
                  grouping_strategy: SingleFileGroupingStrategy,
                  logger: Logger.new(STDOUT))
       augmented_metadata = FileMetadataBuilder.build(files: files, files_metadata: files_metadata)
@@ -41,7 +42,9 @@ module SdrClient
                              files_metadata: augmented_metadata)
       connection = Connection.new(url: url)
       Process.new(metadata: metadata, connection: connection, files: files,
-                  grouping_strategy: grouping_strategy, logger: logger).run
+                  grouping_strategy: grouping_strategy,
+                  accession: accession,
+                  logger: logger).run
     end
     # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/ParameterLists
@@ -56,6 +59,7 @@ require 'sdr_client/deposit/file'
 require 'sdr_client/deposit/file_metadata_builder'
 require 'sdr_client/deposit/file_set'
 require 'sdr_client/deposit/request'
-require 'sdr_client/deposit/upload_files'
 require 'sdr_client/deposit/metadata_builder'
 require 'sdr_client/deposit/process'
+require 'sdr_client/deposit/upload_files'
+require 'sdr_client/deposit/upload_resource'

data/lib/sdr_client/deposit/file.rb

@@ -34,9 +34,10 @@ module SdrClient
           administrative: {
             sdrPreserve: @preserve,
             shelve: @shelve
-          }
+          },
+          version: 1,
+          hasMessageDigests: message_digests
         }.tap do |json|
-          json['hasMessageDigests'] = message_digests unless message_digests.empty?
           json['hasMimeType'] = @mime_type if @mime_type
           json['use'] = @use if @use
         end

data/lib/sdr_client/deposit/file_set.rb

@@ -25,7 +25,8 @@ module SdrClient
           "label": label,
           structural: {
             contains: files.map(&:as_json)
-          }
+          },
+          version: 1
         }
       end
 

data/lib/sdr_client/deposit/model_process.rb

@@ -6,19 +6,18 @@ module SdrClient
   module Deposit
     # The process for doing a deposit from a Cocina Model
     class ModelProcess
-      DRO_PATH = '/v1/resources'
       # @param [Cocina::Model::RequestDRO] request_dro for depositing
-      # @param [String] url the server to send to
-      # @param [String] token the bearer auth token for the server
+      # @param [Connection] connection the connection to use
       # @param [Array<String>] files a list of file names to upload
+      # @param [Boolean] accession should the accessionWF be started
       # @param [Logger] logger the logger to use
-      def initialize(request_dro:, url:,
-                     token:, files: [], logger: Logger.new(STDOUT))
+      def initialize(request_dro:, connection:,
+                     files: [], accession:, logger: Logger.new(STDOUT))
         @files = files
-        @url = url
-        @token = token
+        @connection = connection
         @request_dro = request_dro
         @logger = logger
+        @accession = accession
       end
 
       def run
@@ -30,12 +29,15 @@ module SdrClient
                                            connection: connection,
                                            mime_types: mime_types).run
         new_request_dro = with_external_identifiers(upload_responses)
-        upload_request_dro(new_request_dro.to_json)
+        UploadResource.run(accession: @accession,
+                           metadata: new_request_dro.to_json,
+                           logger: logger,
+                           connection: connection)
       end
 
       private
 
-      attr_reader :request_dro, :files, :url, :token, :logger
+      attr_reader :request_dro, :files, :logger, :connection
 
       def check_files_exist
         logger.info('checking to see if files exist')
@@ -59,31 +61,6 @@ module SdrClient
         end
       end
 
-      # @return [Hash<Symbol,String>] the result of the metadata call
-      def upload_request_dro(request_json)
-        logger.info("Starting upload metadata: #{request_json}")
-        response = connection.post(DRO_PATH, request_json, 'Content-Type' => 'application/json')
-        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'] }
-      end
-
-      def unexpected_response(response)
-        raise "There was an error with your request: #{response.body}" if response.status == 400
-        raise 'There was an error with your credentials. Perhaps they have expired?' if response.status == 401
-
-        raise "unexpected response: #{response.status} #{response.body}"
-      end
-
-      def connection
-        @connection ||= Faraday.new(url: url) do |conn|
-          conn.authorization :Bearer, token
-          conn.adapter :net_http
-        end
-      end
-
       # Map of filenames to mimetypes
       def mime_types
         @mime_types ||=

data/lib/sdr_client/deposit/process.rb

@@ -6,21 +6,26 @@ module SdrClient
   module Deposit
     # The process for doing a deposit
     class Process
-      DRO_PATH = '/v1/resources'
       # @param [Request] metadata information about the object
       # @param [Class] grouping_strategy class whose run method groups an array of uploads
       # @param [String] connection the server connection to use
       # @param [Array<String>] files a list of file names to upload
+      # @param [Boolean] accession should the accessionWF be started
       # @param [Logger] logger the logger to use
+      #
+      # rubocop:disable Metrics/ParameterLists
       def initialize(metadata:, grouping_strategy: SingleFileGroupingStrategy,
-                     connection:, files: [], logger: Logger.new(STDOUT))
+                     connection:, files: [], accession:, logger: Logger.new(STDOUT))
         @files = files
         @connection = connection
         @metadata = metadata
         @logger = logger
         @grouping_strategy = grouping_strategy
+        @accession = accession
       end
+      # rubocop:enable Metrics/ParameterLists
 
+      # rubocop:disable Metrics/AbcSize
       def run
         check_files_exist
         upload_responses = UploadFiles.new(files: files,
@@ -31,8 +36,13 @@ module SdrClient
                                                grouping_strategy: grouping_strategy,
                                                logger: logger)
         request = metadata_builder.with_uploads(upload_responses)
-        upload_metadata(request.as_json)
+        model = Cocina::Models.build_request(request.as_json.with_indifferent_access)
+        UploadResource.run(accession: @accession,
+                           metadata: JSON.generate(model.to_h),
+                           logger: logger,
+                           connection: connection)
       end
+      # rubocop:enable Metrics/AbcSize
 
       private
 
@@ -45,25 +55,6 @@ module SdrClient
         end
       end
 
-      # @return [Hash<Symbol,String>] the result of the metadata call
-      def upload_metadata(metadata)
-        logger.info("Starting upload metadata: #{metadata}")
-        request_json = JSON.generate(metadata)
-        response = connection.post(DRO_PATH, request_json, 'Content-Type' => 'application/json')
-        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'] }
-      end
-
-      def unexpected_response(response)
-        raise "There was an error with your request: #{response.body}" if response.status == 400
-        raise 'There was an error with your credentials. Perhaps they have expired?' if response.status == 401
-
-        raise "unexpected response: #{response.status} #{response.body}"
-      end
-
       def mime_types
         @mime_types ||=
           Hash[

data/lib/sdr_client/deposit/request.rb

@@ -49,10 +49,10 @@ module SdrClient
           type: type,
           administrative: administrative,
           identification: identification,
-          structural: structural
-        }.tap do |json|
-          json[:label] = label if label
-        end
+          structural: structural,
+          version: 1,
+          label: label.nil? ? ':auto' : label
+        }
       end
 
       # @return [Request] a clone of this request with the file_sets added

data/lib/sdr_client/deposit/upload_resource.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module SdrClient
+  module Deposit
+    # Uploads a resource (metadata) to the server
+    class UploadResource
+      DRO_PATH = '/v1/resources'
+
+      def self.run(accession:, metadata:, logger:, connection:)
+        new(accession: accession, metadata: metadata, logger: logger, connection: connection).run
+      end
+
+      # @param [Boolean] accession should the accessionWF be started
+      # @param [String] metadata
+      # @param [Hash<Symbol,String>] the result of the metadata call
+      def initialize(accession:, metadata:, logger:, connection:)
+        @accession = accession
+        @metadata = metadata
+        @logger = logger
+        @connection = connection
+      end
+
+      # @param [Hash<Symbol,String>] the result of the metadata call
+      # @return [Hash<Symbol,String>] the result of the metadata call
+      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'] }
+      end
+
+      private
+
+      attr_reader :metadata, :logger, :connection
+
+      def metadata_request
+        logger.debug("Starting upload metadata: #{metadata}")
+
+        connection.post(path, metadata, 'Content-Type' => 'application/json')
+      end
+
+      def unexpected_response(response)
+        raise "There was an error with your request: #{response.body}" if response.status == 400
+        raise 'There was an error with your credentials. Perhaps they have expired?' if response.status == 401
+
+        raise "unexpected response: #{response.status} #{response.body}"
+      end
+
+      def accession?
+        @accession
+      end
+
+      def path
+        path = DRO_PATH
+        path += '?accession=true' if accession?
+        path
+      end
+    end
+  end
+end

data/lib/sdr_client/login.rb

@@ -7,12 +7,12 @@ module SdrClient
     extend Dry::Monads[:result]
 
     # @return [Result] the status of the call
-    def self.run(url:, login_service: LoginPrompt)
+    def self.run(url:, login_service: LoginPrompt, credential_store: Credentials)
       request_json = JSON.generate(login_service.run)
       response = Faraday.post(url + LOGIN_PATH, request_json, 'Content-Type' => 'application/json')
       case response.status
       when 200
-        Credentials.write(response.body)
+        credential_store.write(response.body)
         Success()
       when 400
         Failure('Email address is not a valid email')

data/lib/sdr_client/model_deposit.rb

@@ -8,10 +8,14 @@ module SdrClient
     def self.model_run(request_dro:,
                        files: [],
                        url:,
+                       accession:,
                        logger: Logger.new(STDOUT))
-      token = Credentials.read
-
-      ModelProcess.new(request_dro: request_dro, url: url, token: token, files: files, logger: logger).run
+      connection = Connection.new(url: url)
+      ModelProcess.new(request_dro: request_dro,
+                       connection: connection,
+                       files: files,
+                       logger: logger,
+                       accession: accession).run
     end
   end
 end

data/lib/sdr_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SdrClient
-  VERSION = '0.19.0'
+  VERSION = '0.23.1'
 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.29.0'
+  spec.add_dependency 'cocina-models', '~> 0.31.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.19.0
+  version: 0.23.1
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2020-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.0
+        version: 0.31.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.0
+        version: 0.31.0
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +207,7 @@ files:
 - lib/sdr_client/deposit/request.rb
 - lib/sdr_client/deposit/single_file_grouping_strategy.rb
 - lib/sdr_client/deposit/upload_files.rb
+- lib/sdr_client/deposit/upload_resource.rb
 - lib/sdr_client/login.rb
 - lib/sdr_client/login_prompt.rb
 - lib/sdr_client/model_deposit.rb