sdr-client 0.36.0 → 0.40.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7652ddb5f3116fb2ecefabb265718c0bd2e69d536955a22ebb7139cc287a38a1
-  data.tar.gz: cbb4118974499de9f6c7ad10df1433c4aee712b309ee1c8064cd14602cf08808
+  metadata.gz: 70177617818debc05fccd927736a3191a8071db8730835773699b6d8c0c61967
+  data.tar.gz: 4b6c4969ac82a9ba23ae8b694126db89bf9ad9fa8b2e3fd3f3848b03c6c5b5d7
 SHA512:
-  metadata.gz: d47cc4fbbf26c51df56ba79c4cf97ea3c1add9b8aa2c8f5e78a8bf51f639a15a7bbcbc912f058a2b43d29ced7981623c4f26aafc9b66b5837ae3c17796325f99
-  data.tar.gz: 107a93bbaf7fde4915bcfb2939853946aff4c0d5fbc3bfede4aeea1971cab270969a3b6406df66b9a44dced0cee70e6627e619aefff3d0803242b7c033ea13f0
+  metadata.gz: 0c707edfee7b9c6116853675ebb8ff760888d67488456c7ab7e39d276c03c981a0c7f8dbfeab612130e342aae49f5d3b0b456f877ad4b737af7da1402f274878
+  data.tar.gz: 424fede8c7ec5ce782af2e9603c9c79cb53148de9eee6c626b7f361a09583ba07344d25d81add9d568a165d6eb985a64610a32f4c4f48677f3c4004d120a8a67

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

@@ -68,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'
@@ -79,7 +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_files_metadata_builder'
-require 'sdr_client/deposit/upload_resource'

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/files/direct_upload_response.rb

@@ -5,7 +5,7 @@ module SdrClient
     module Files
       DirectUploadResponse = Struct.new(:id, :key, :checksum, :byte_size, :content_type,
                                         :filename, :metadata, :created_at, :direct_upload,
-                                        :signed_id, keyword_init: true)
+                                        :signed_id, :service_name, keyword_init: true)
     end
   end
 end

data/lib/sdr_client/deposit/model_process.rb

@@ -29,8 +29,8 @@ module SdrClient
                                               logger: logger,
                                               connection: connection)
         new_request_dro = UpdateDroWithFileIdentifiers.update(request_dro: request_dro, upload_responses: upload_responses)
-        UploadResource.run(accession: @accession,
-                           metadata: new_request_dro.to_json,
+        CreateResource.run(accession: @accession,
+                           metadata: new_request_dro,
                            logger: logger,
                            connection: connection)
       end

data/lib/sdr_client/deposit/process.rb

@@ -39,8 +39,8 @@ module SdrClient
                                                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_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/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.36.0'
+  VERSION = '0.40.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.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.36.0
+  version: 0.40.1
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2021-01-08 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,10 +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_files_metadata_builder.rb
-- lib/sdr_client/deposit/upload_resource.rb
+- lib/sdr_client/find.rb
 - lib/sdr_client/login.rb
 - lib/sdr_client/login_prompt.rb
 - lib/sdr_client/version.rb
@@ -236,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: The CLI for https://github.com/sul-dlss/sdr-api