sdr-client 0.35.1 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 551ee50a8e581a8a0e7cadcffec518168ef2b0fbba5368520ffeaaa086ccb66e
-  data.tar.gz: 5ca9d3232ccfac283d09d68310c9c4fa3355943c90ef5d5bc911f3367bea5396
+  metadata.gz: cf5c97821bfab525a4f0b272b9519f26dd5bf46b164ab475965a1273588a31d0
+  data.tar.gz: 7545a75643e71bcdbd8bddfa6afdff6303e4ce05251746ea49d831669a48fc85
 SHA512:
-  metadata.gz: fa183be1fd002a39f25816b3f990123b3a5324e87f26fda44115537d31aeeace1915f53ba45e4432760ba9e08089da9afcec7b96061fd96ea8108a7d6d0b2cf3
-  data.tar.gz: ee6b43d4d29222f0aaec528ff85e1e2c8c657c9c659fd8089bd105c634a94c59d14275501501af4707c929d9e16606f11b815b267be0d95073d8579e7b2055ea
+  metadata.gz: da880356f2d5bcfac1bc39c765411538e52b9449e4eb8ce3ccdcc5a9fd1ec8044cd5784905b76be318dc705b404df283b3ea0102b63059e877cb1cf36d8458bc
+  data.tar.gz: 6a55918f74cd35898ad80d991ae61102ce7971170d5a29c94a9791cbb3e23d46ea4f38736e05d99c7610ecd95eb22f012ac11dd159efe100ff850889c6457955

data/README.md

@@ -45,3 +45,9 @@ sdr --service-url https://sdr-api-server:3000 deposit --label 'hey there' \
   --collection 'druid:gh456kw9876' \
   --source-id 'googlebooks:stanford_12345' image42.jp2 ocr.html
 ```
+
+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/fileset.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}}]}}]}}
+```

data/exe/sdr

@@ -19,6 +19,9 @@ end
 global.order!
 command = ARGV.shift
 
+retrieve_options = OptionParser.new do |opts|
+end
+
 deposit_options = OptionParser.new do |opts|
   opts.banner = "Usage: sdr #{command} [options]"
   opts.on('--label LABEL', 'The object label') do |label|
@@ -94,6 +97,7 @@ end
 SdrClient::CLI.help unless command
 
 subcommands = {
+  'get' => retrieve_options,
   'deposit' => deposit_options,
   'register' => deposit_options,
   'login' => OptionParser.new
@@ -106,11 +110,10 @@ end
 
 subcommands[command].order!
 
-options[:files] = ARGV unless ARGV.empty?
 options[:url] ||= 'https://sdr-api-prod.stanford.edu'
 
 begin
-  SdrClient::CLI.start(command, options)
+  SdrClient::CLI.start(command, options, ARGV)
 rescue StandardError => e
   warn "There was a problem making your request:\n\n"
   warn e.message

data/lib/sdr_client.rb

@@ -11,6 +11,7 @@ require 'cocina/models'
 require 'sdr_client/version'
 require 'sdr_client/deposit'
 require 'sdr_client/credentials'
+require 'sdr_client/find'
 require 'sdr_client/login'
 require 'sdr_client/login_prompt'
 require 'sdr_client/cli'

data/lib/sdr_client/cli.rb

@@ -23,6 +23,9 @@ module SdrClient
 
 
       COMMANDS:
+        get
+          Retrieve an object from the SDR
+
         deposit
           Accession an object into the SDR
 
@@ -34,12 +37,12 @@ module SdrClient
 
     HELP
 
-    def self.start(command, options)
+    def self.start(command, options, arguments = [])
       case command
+      when 'get'
+        puts SdrClient::Find.run(arguments.first, **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
+        deposit(command, options, arguments)
       when 'login'
         status = SdrClient::Login.run(options)
         puts status.failure if status.failure?
@@ -51,6 +54,13 @@ module SdrClient
       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
+    end
+
     def self.display_errors(errors)
       return if errors.empty?
 

data/lib/sdr_client/connection.rb

@@ -32,7 +32,7 @@ module SdrClient
       end
     end
 
-    delegate :put, :post, to: :connection
+    delegate :put, :post, :get, to: :connection
 
     private
 

data/lib/sdr_client/deposit.rb

@@ -52,6 +52,7 @@ module SdrClient
     # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/ParameterLists
 
+    # @param [Array<String>] files absolute paths to files
     def self.model_run(request_dro:,
                        files: [],
                        url:,
@@ -67,6 +68,7 @@ module SdrClient
   end
 end
 require 'json'
+require 'sdr_client/deposit/create_resource'
 require 'sdr_client/deposit/single_file_grouping_strategy'
 require 'sdr_client/deposit/matching_file_grouping_strategy'
 require 'sdr_client/deposit/files/direct_upload_request'
@@ -78,5 +80,8 @@ 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/unexpected_response'
+require 'sdr_client/deposit/update_resource'
+require 'sdr_client/deposit/update_dro_with_file_identifiers'
 require 'sdr_client/deposit/upload_files'
-require 'sdr_client/deposit/upload_resource'
+require 'sdr_client/deposit/upload_files_metadata_builder'

data/lib/sdr_client/deposit/{upload_resource.rb → create_resource.rb}

@@ -2,8 +2,8 @@
 
 module SdrClient
   module Deposit
-    # Uploads a resource (metadata) to the server
-    class UploadResource
+    # Creates a resource (metadata) in SDR
+    class CreateResource
       DRO_PATH = '/v1/resources'
 
       def self.run(accession:, metadata:, logger:, connection:)
@@ -11,7 +11,7 @@ module SdrClient
       end
 
       # @param [Boolean] accession should the accessionWF be started
-      # @param [String] metadata
+      # @param [Cocina::Models::RequestDRO, Cocina::Models::RequestCollection] metadata
       # @param [Hash<Symbol,String>] the result of the metadata call
       def initialize(accession:, metadata:, logger:, connection:)
         @accession = accession
@@ -24,7 +24,7 @@ module SdrClient
       # @return [String] job id for the background job result
       def run
         response = metadata_request
-        unexpected_response(response) unless response.status == 201
+        UnexpectedResponse.call(response) unless response.status == 201
 
         logger.info("Response from server: #{response.body}")
 
@@ -36,16 +36,10 @@ module SdrClient
       attr_reader :metadata, :logger, :connection
 
       def metadata_request
-        logger.debug("Starting upload metadata: #{metadata}")
+        json = metadata.to_json
+        logger.debug("Starting upload metadata: #{json}")
 
-        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}"
+        connection.post(path, json, 'Content-Type' => 'application/json')
       end
 
       def accession?

data/lib/sdr_client/deposit/model_process.rb

@@ -24,13 +24,13 @@ module SdrClient
         check_files_exist
         child_files_match
 
-        upload_responses = UploadFiles.new(files: files,
-                                           logger: logger,
-                                           connection: connection,
-                                           mime_types: mime_types).run
-        new_request_dro = with_external_identifiers(upload_responses)
-        UploadResource.run(accession: @accession,
-                           metadata: new_request_dro.to_json,
+        file_metadata = UploadFilesMetadataBuilder.build(files: files, mime_types: mime_types)
+        upload_responses = UploadFiles.upload(file_metadata: file_metadata,
+                                              logger: logger,
+                                              connection: connection)
+        new_request_dro = UpdateDroWithFileIdentifiers.update(request_dro: request_dro, upload_responses: upload_responses)
+        CreateResource.run(accession: @accession,
+                           metadata: new_request_dro,
                            logger: logger,
                            connection: connection)
       end
@@ -85,24 +85,6 @@ module SdrClient
           ]
         end
       end
-
-      # rubocop:disable Metrics/AbcSize
-      def with_external_identifiers(upload_responses)
-        signed_id_map = Hash[upload_responses.map { |response| [response.filename, response.signed_id] }]
-
-        # Manipulating request_dro as hash since immutable
-        request_dro_hash = request_dro.to_h
-        if request_dro_hash[:structural]
-          request_dro_hash[:structural][:contains].each do |file_set|
-            file_set[:structural][:contains].each do |file|
-              file[:externalIdentifier] = signed_id_map[file[:filename]]
-            end
-          end
-        end
-
-        Cocina::Models::RequestDRO.new(request_dro_hash)
-      end
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/sdr_client/deposit/process.rb

@@ -29,17 +29,18 @@ module SdrClient
       # @return [String] job id for the background job result
       def run
         check_files_exist
-        upload_responses = UploadFiles.new(files: files,
-                                           logger: logger,
-                                           connection: connection,
-                                           mime_types: mime_types).run
+
+        file_metadata = UploadFilesMetadataBuilder.build(files: files, mime_types: mime_types)
+        upload_responses = UploadFiles.upload(file_metadata: file_metadata,
+                                              logger: logger,
+                                              connection: connection)
         metadata_builder = MetadataBuilder.new(metadata: metadata,
                                                grouping_strategy: grouping_strategy,
                                                logger: logger)
         request = metadata_builder.with_uploads(upload_responses)
         model = Cocina::Models.build_request(request.as_json.with_indifferent_access)
-        UploadResource.run(accession: @accession,
-                           metadata: JSON.generate(model.to_h),
+        CreateResource.run(accession: @accession,
+                           metadata: model,
                            logger: logger,
                            connection: connection)
       end

data/lib/sdr_client/deposit/unexpected_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SdrClient
+  module Deposit
+    # Handles unexpected responses when manipulating resources
+    class UnexpectedResponse
+      # @param [Faraday::Response] response
+      def self.call(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
+    end
+  end
+end

data/lib/sdr_client/deposit/update_dro_with_file_identifiers.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module SdrClient
+  module Deposit
+    # Updates a DRO so that the structural metadata references the uploaded file ids
+    class UpdateDroWithFileIdentifiers
+      # @param [Cocina::Model::RequestDRO] request_dro for depositing
+      # @param [Array<Files::DirectUploadResponse>] upload_responses the responses from uploading files
+      # @returns [Cocina::Models::RequestDRO]
+      def self.update(request_dro:, upload_responses:)
+        # Manipulating request_dro as hash since immutable
+        structural = request_dro.to_h[:structural]
+        return request_dro.new({}) unless structural
+
+        signed_ids = signed_id_map(upload_responses)
+        request_dro.new(structural: updated_structural(structural, signed_ids))
+      end
+
+      def self.signed_id_map(upload_responses)
+        Hash[upload_responses.map { |response| [response.filename, response.signed_id] }]
+      end
+      private_class_method :signed_id_map
+
+      def self.updated_structural(structural, signed_ids)
+        structural[:contains].each do |file_set|
+          file_set[:structural][:contains].each do |file|
+            file[:externalIdentifier] = signed_ids[file[:filename]]
+          end
+        end
+        structural
+      end
+      private_class_method :updated_structural
+    end
+  end
+end

data/lib/sdr_client/deposit/update_resource.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module SdrClient
+  module Deposit
+    # Updates a resource (metadata) in SDR
+    class UpdateResource
+      DRO_PATH = '/v1/resources/%<id>s'
+
+      def self.run(metadata:, logger:, connection:)
+        new(metadata: metadata, logger: logger, connection: connection).run
+      end
+
+      # @param [Cocina::Models::DRO] metadata
+      # @param [Hash<Symbol,String>] the result of the metadata call
+      def initialize(metadata:, logger:, connection:)
+        @metadata = metadata
+        @logger = logger
+        @connection = connection
+      end
+
+      # @param [Hash<Symbol,String>] the result of the metadata call
+      # @return [String] job id for the background job result
+      def run
+        response = metadata_request
+        UnexpectedResponse.call(response) unless response.status == 202
+
+        logger.info("Response from server: #{response.body}")
+
+        JSON.parse(response.body)['jobId']
+      end
+
+      private
+
+      attr_reader :metadata, :logger, :connection
+
+      def metadata_request
+        json = metadata.to_json
+        logger.debug("Starting upload metadata: #{json}")
+
+        connection.put(path(metadata), json, 'Content-Type' => 'application/json')
+      end
+
+      def path(metadata)
+        format(DRO_PATH, id: metadata.externalIdentifier)
+      end
+    end
+  end
+end

data/lib/sdr_client/deposit/upload_files.rb

@@ -7,40 +7,34 @@ module SdrClient
     # The file uploading part of a deposit
     class UploadFiles
       BLOB_PATH = '/v1/direct_uploads'
-      # @param [Array<String>] files a list of filepaths to upload
+      # @param [Hash<String,Files::DirectUploadRequest>] the metadata for uploading the files
       # @param [Logger] logger the logger to use
       # @param [Connection] connection
-      # @param [Hash<String,String] mime_types a map of filenames to mime types
-      def initialize(files:, mime_types:, logger:, connection:)
-        @files = files
-        @mime_types = mime_types
+      def self.upload(file_metadata:, logger:, connection:)
+        new(file_metadata: file_metadata, logger: logger, connection: connection).run
+      end
+
+      # @param [Hash<String,Files::DirectUploadRequest>] the metadata for uploading the files
+      # @param [Logger] logger the logger to use
+      # @param [Connection] connection
+      def initialize(file_metadata:, logger:, connection:)
+        @file_metadata = file_metadata
         @logger = logger
         @connection = connection
       end
 
       # @return [Array<SdrClient::Deposit::Files::DirectUploadResponse>] the responses from the server for the uploads
       def run
-        file_metadata = collect_file_metadata
-        upload_responses = upload_file_metadata(file_metadata)
+        upload_responses = upload_file_metadata
         upload_files(upload_responses)
         upload_responses.values
       end
 
       private
 
-      attr_reader :files, :mime_types, :logger, :connection
-
-      def collect_file_metadata
-        files.each_with_object({}) do |path, obj|
-          file_name = ::File.basename(path)
-          obj[path] = Files::DirectUploadRequest.from_file(path,
-                                                           file_name: file_name,
-                                                           content_type: mime_types[file_name])
-        end
-      end
+      attr_reader :logger, :connection, :file_metadata
 
-      # @param [Hash<String,Files::DirectUploadRequest>] file_metadata the filenames and their upload request
-      def upload_file_metadata(file_metadata)
+      def upload_file_metadata
         Hash[file_metadata.map { |filename, metadata| [filename, direct_upload(metadata.to_json)] }]
       end
 

data/lib/sdr_client/deposit/upload_files_metadata_builder.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module SdrClient
+  module Deposit
+    # Collecting all the metadata about the files for a deposit
+    class UploadFilesMetadataBuilder
+      # @param [Array<String>] files a list of filepaths to upload
+      # @param [Hash<String,String>] mime_types a map of filenames to mime types
+      # @return [Hash<String, Files::DirectUploadRequest>] the metadata for uploading the files
+      def self.build(files:, mime_types:)
+        new(files: files, mime_types: mime_types).build
+      end
+
+      # @param [Array<String>] files a list of filepaths to upload
+      # @param [Hash<String,String>] mime_types a map of filenames to mime types
+      def initialize(files:, mime_types:)
+        @files = files
+        @mime_types = mime_types
+      end
+
+      attr_reader :files, :mime_types
+
+      # @return [Hash<String, Files::DirectUploadRequest>] the metadata for uploading the files
+      def build
+        files.each_with_object({}) do |path, obj|
+          obj[path] = Files::DirectUploadRequest.from_file(path,
+                                                           file_name: filename_for(path),
+                                                           content_type: mime_type_for(path))
+        end
+      end
+
+      # This can be overridden in the case that the file on disk has a different
+      # name than we want to repo to know about.
+      def filename_for(file_path)
+        ::File.basename(file_path)
+      end
+
+      def mime_type_for(file_path)
+        mime_types[filename_for(file_path)]
+      end
+    end
+  end
+end

data/lib/sdr_client/find.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module SdrClient
+  # The namespace for the "get" command
+  module Find
+    DRO_PATH = '/v1/resources/%<id>s'
+    # @return [String] job id for the background job result
+    def self.run(druid, url:, logger: Logger.new(STDOUT))
+      connection = Connection.new(url: url)
+      path = format(DRO_PATH, id: druid)
+      logger.info("Retrieving metadata from: #{path}")
+      response = connection.get(path)
+      response.body
+    end
+  end
+end

data/lib/sdr_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SdrClient
-  VERSION = '0.35.1'
+  VERSION = '0.40.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.42.1'
+  spec.add_dependency 'cocina-models', '~> 0.44.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.35.1
+  version: 0.40.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-26 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.42.1
+        version: 0.44.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.42.1
+        version: 0.44.0
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement
@@ -193,6 +193,7 @@ files:
 - lib/sdr_client/connection.rb
 - lib/sdr_client/credentials.rb
 - lib/sdr_client/deposit.rb
+- lib/sdr_client/deposit/create_resource.rb
 - lib/sdr_client/deposit/file.rb
 - lib/sdr_client/deposit/file_metadata_builder.rb
 - lib/sdr_client/deposit/file_metadata_builder_operations/md5.rb
@@ -207,8 +208,12 @@ files:
 - lib/sdr_client/deposit/process.rb
 - lib/sdr_client/deposit/request.rb
 - lib/sdr_client/deposit/single_file_grouping_strategy.rb
+- lib/sdr_client/deposit/unexpected_response.rb
+- lib/sdr_client/deposit/update_dro_with_file_identifiers.rb
+- lib/sdr_client/deposit/update_resource.rb
 - lib/sdr_client/deposit/upload_files.rb
-- lib/sdr_client/deposit/upload_resource.rb
+- lib/sdr_client/deposit/upload_files_metadata_builder.rb
+- lib/sdr_client/find.rb
 - lib/sdr_client/login.rb
 - lib/sdr_client/login_prompt.rb
 - lib/sdr_client/version.rb
@@ -234,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: The CLI for https://github.com/sul-dlss/sdr-api