sdr-client 0.68.0 → 0.71.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56d9c570c19831deea82ad5c2591705f30a92a92ed93b2c8183a029613cffb35
-  data.tar.gz: 603460d6cd1fa94a3a8acac42ae5da6162bd3e64234b0a1927ee39075552d828
+  metadata.gz: 4e12d569ac9f642a42311a80b9594a64398742274be65bd2298ddea5806aaa62
+  data.tar.gz: ba7c87706cf15a5904a44ac58f2d4303023eda9cef43224ad74e4b3e4ab4957b
 SHA512:
-  metadata.gz: 4ab960d543b9f21c76233ee0bddfeb0be18a0161a38f2ee87c02b3d52fd525617807767d3e1fa497edcab1400bf370a458fd262b7f2612b02ff45187a7df926a
-  data.tar.gz: b71e409b03e83ece3241ff20613d2e1c5f44be0d406248d932ede20bea8c6b4e6d192c49a4e45e6c7d1f6ad890a560bba426964412f52ed022108e1f75b2d42e
+  metadata.gz: 3f64850d5858f86b66a3cc1db3d38723ed35c78c4010f59e92af3affe945cc5bdc43dd13ff473f0e44ba256abb3a6ad1b7fac7bff8c76edca908271b64037bb7
+  data.tar.gz: 6b31ab8f77403f370e0ce7d520f98ec989e670bcb9700c779e039c3a19f84022411fb03e3d6d4ed057ee414f58229526722ae8b219d2285359bc2e99c0ef2d14

data/.github/pull_request_template.md

@@ -1,12 +1,9 @@
-## Why was this change made?
+## Why was this change made? 🤔
 
 
 
-## How was this change tested?
-
-
-
-## Which documentation and/or configurations were updated?
+## How was this change tested? 🤨
 
+⚡ ⚠ If this change has cross service impact, ***run [integration tests](https://github.com/sul-dlss/infrastructure-integration-test) that use sdr-api*** (e.g.create_object_h2_spec.rb) and/or test in [stage|qa] environment, in addition to specs. ⚡
 
 

data/.rubocop.yml

@@ -137,3 +137,7 @@ RSpec/FactoryBot/SyntaxMethods: # new in 2.7
   Enabled: true
 RSpec/Rails/AvoidSetupHook: # new in 2.4
   Enabled: true
+RSpec/BeEq: # new in 2.9.0
+  Enabled: true
+RSpec/BeNil: # new in 2.9.0
+  Enabled: true

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2022-02-15 02:08:38 UTC using RuboCop version 1.25.1.
+# on 2022-03-08 23:08:23 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,7 +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: 10
+# Offense count: 1
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/sdr_client/cli.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/sdr_client/cli.rb'
+
+# Offense count: 11
 # Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Exclude:
@@ -36,8 +48,9 @@ Metrics/MethodLength:
     - 'lib/sdr_client/deposit/process.rb'
     - 'lib/sdr_client/deposit/request.rb'
     - 'lib/sdr_client/login.rb'
+    - 'lib/sdr_client/update.rb'
 
-# Offense count: 6
+# Offense count: 8
 # Configuration parameters: Max, CountAsOne.
 RSpec/ExampleLength:
   Exclude:
@@ -60,7 +73,7 @@ RSpec/MessageSpies:
   Exclude:
     - 'spec/sdr_client/deposit_spec.rb'
 
-# Offense count: 10
+# Offense count: 12
 # Configuration parameters: Max.
 RSpec/MultipleExpectations:
   Exclude:

data/README.md

@@ -5,20 +5,21 @@
 
 # Sdr::Client
 
-This is a CLI for interacting with the Stanford Digital Repository API.
-The code for the SDR API server is at https://github.com/sul-dlss/sdr-api
+This is a Ruby-based CLI for interacting with the Stanford Digital Repository API. The code for the SDR API server is at https://github.com/sul-dlss/sdr-api
 
 This provides a way for consumers to easily and correctly deposit files to the SDR without requiring access to the `/dor` NFS mount or to use Hydrus.  A primary design goal was for this to have as few dependencies as possible so that it can be easily distributed by `gem install sdr-client` and then it can be used as a CLI.
 
 ## Install
 
+We recommend using the latest 3.x release of Ruby.
+
 `gem install sdr-client`
 
 ## Usage
 
 Log in:
 ```
-sdr --service-url http://sdr-api-server:3000 login
+sdr --service-url https://sdr-api-server:3000 login
 ```
 
 Register a new object:
@@ -56,3 +57,15 @@ Display version of sdr-client:
 ```
 sdr version
 ```
+
+Update an object, changing its admin policy object (APO):
+```
+sdr --service-url https://sdr-api-server:3000 update --admin-policy druid:bx911tp9024 druid:bb408qn5061
+```
+
+
+## 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.
+
+**WARNING**: if you omit the `--service-url` flag, the sdr-client CLI by default operates against the production environment.

data/exe/sdr

@@ -91,13 +91,27 @@ deposit_options = OptionParser.new do |opts|
   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 = {
-  'get' => OptionParser.new,
   'deposit' => deposit_options,
-  'register' => deposit_options,
+  'get' => OptionParser.new,
   'login' => OptionParser.new,
+  'register' => deposit_options,
+  'update' => update_options,
   'version' => OptionParser.new
 }
 

data/lib/sdr_client/cli.rb

@@ -16,7 +16,7 @@ module SdrClient
 
       OPTIONS:
         --service-url (string)
-        Override the command's default URL with the given URL.
+        Override the command's default URL with the given URL. Default: https://sdr-api-prod.stanford.edu
 
         -h, --help
         Displays this screen
@@ -30,10 +30,13 @@ module SdrClient
           Accession an object into the SDR
 
         register
-          Create a draft object in SDR and retrieve a Druid identifier.
+          Create a draft object in the SDR and retrieve a Druid identifier
+
+        update
+          Update an object in the SDR
 
         login
-          Will prompt for email & password and exchange it for an login token, which it saves in ~/.sdr/token
+          Will prompt for email & password and exchange it for an login token (saved in ~/.sdr/token)
 
         version
           Display the sdr-client version
@@ -46,8 +49,15 @@ module SdrClient
         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
+
+        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)
+        status = SdrClient::Login.run(**options)
         puts status.failure if status.failure?
       when 'version'
         puts SdrClient::VERSION

data/lib/sdr_client/deposit/file.rb

@@ -26,12 +26,12 @@ module SdrClient
 
       def as_json
         {
-          type: 'http://cocina.sul.stanford.edu/models/file.jsonld',
+          type: Cocina::Models::ObjectType.file,
           label: @label,
           filename: @filename,
           externalIdentifier: @external_identifier,
           access: {
-            access: @access,
+            view: @access,
             download: @download
           },
           administrative: {

data/lib/sdr_client/deposit/file_type_file_set_strategy.rb

@@ -7,7 +7,7 @@ module SdrClient
       # @param [Array<SdrClient::Deposit::Files>] files the files that are part of this strategy
       # @return [String] The URI that represents the type of file_set
       def self.run(files: [])
-        Cocina::Models::Vocab::Resources.file
+        Cocina::Models::FileSetType.file
       end
     end
   end

data/lib/sdr_client/deposit/image_file_set_strategy.rb

@@ -7,7 +7,7 @@ module SdrClient
       # @param [Array<SdrClient::Deposit::Files>] files the files that are part of this strategy
       # @return [String] The URI that represents the type of file_set
       def self.run(files: [])
-        Cocina::Models::Vocab::Resources.image
+        Cocina::Models::FileSetType.image
       end
     end
   end

data/lib/sdr_client/deposit/request.rb

@@ -7,7 +7,7 @@ module SdrClient
       # @param [String] label the required object label
       # @param [Time|nil] embargo_release_date when the item should be released from embargo or nil if no embargo
       # @param [String] embargo_access access after embargo has expired if embargoed
-      # @param [String] type (http://cocina.sul.stanford.edu/models/object.jsonld) the required object type.
+      # @param [String] type (https://cocina.sul.stanford.edu/models/object) the required object type.
       # @param [Array<FileSet>] file_sets the file sets to attach.
       # @param [Hash<String, Hash<String, String>>] files_metadata file name, hash of additional file metadata
       # Additional metadata includes access, preserve, shelve, publish, md5, sha1
@@ -24,7 +24,7 @@ module SdrClient
                      embargo_release_date: nil,
                      embargo_access: 'world',
                      embargo_download: 'world',
-                     type: 'http://cocina.sul.stanford.edu/models/object.jsonld',
+                     type: Cocina::Models::ObjectType.object,
                      viewing_direction: nil,
                      file_sets: [],
                      files_metadata: {})
@@ -118,7 +118,7 @@ module SdrClient
 
       def access_struct
         {
-          access: access,
+          view: access,
           download: download
         }.tap do |json|
           json[:useAndReproductionStatement] = use_statement if use_statement
@@ -127,7 +127,7 @@ module SdrClient
           if embargo_release_date
             json[:embargo] = {
               releaseDate: embargo_release_date.strftime('%FT%T%:z'),
-              access: embargo_access,
+              view: embargo_access,
               download: embargo_download
             }
           end

data/lib/sdr_client/deposit/update_resource.rb

@@ -35,7 +35,7 @@ module SdrClient
 
       def metadata_request
         json = metadata.to_json
-        logger.debug("Starting upload metadata: #{json}")
+        logger.debug("Starting update metadata: #{json}")
 
         connection.put(path(metadata), json,
                        'Content-Type' => 'application/json',

data/lib/sdr_client/deposit.rb

@@ -5,7 +5,7 @@ require 'logger'
 module SdrClient
   # The namespace for the "deposit" command
   module Deposit
-    BOOK_TYPE = 'http://cocina.sul.stanford.edu/models/book.jsonld'
+    BOOK_TYPE = Cocina::Models::ObjectType.book
     # rubocop:disable Metrics/ParameterLists
     # rubocop:disable Metrics/MethodLength
     # @return [String] job id for the background job result

data/lib/sdr_client/find.rb

@@ -6,12 +6,15 @@ 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
+    # @return [String] JSON for the given Cocina object or an error
     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)
+      unless response.success?
+        logger.error("There was an HTTP #{response.status} error making the request: #{response.body}")
+      end
       response.body
     end
   end

data/lib/sdr_client/update.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SdrClient
+  # The namespace for the "update" command
+  module 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(
+        JSON.parse(
+          SdrClient::Find.run(druid, url: url)
+        )
+      )
+
+      SdrClient::Deposit::UpdateResource.run(
+        metadata: cocina_item.new(
+          administrative: cocina_item.administrative.new(
+            hasAdminPolicy: apo
+          )
+        ),
+        logger: logger,
+        connection: Connection.new(url: url)
+      )
+    end
+  end
+end

data/lib/sdr_client/version.rb

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

data/lib/sdr_client.rb

@@ -10,6 +10,7 @@ require 'cocina/models'
 
 require 'sdr_client/version'
 require 'sdr_client/deposit'
+require 'sdr_client/update'
 require 'sdr_client/credentials'
 require 'sdr_client/find'
 require 'sdr_client/login'

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.66.0'
+  spec.add_dependency 'cocina-models', '~> 0.68.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.68.0
+  version: 0.71.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-25 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.66.0
+        version: 0.68.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.66.0
+        version: 0.68.0
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement
@@ -232,6 +232,7 @@ files:
 - lib/sdr_client/find.rb
 - lib/sdr_client/login.rb
 - lib/sdr_client/login_prompt.rb
+- lib/sdr_client/update.rb
 - lib/sdr_client/version.rb
 - sdr-client.gemspec
 homepage: https://github.com/sul-dlss/sdr-client