dor-services-client 9.1.1 → 10.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0cdf365381c6038c6b2cc8450158528c83f1daf5e7d41cff74f8fc5b48a6848
-  data.tar.gz: c82464b2f24334a7f7640d17435d5c0dc7de72d898ed3de6034747dd0555026d
+  metadata.gz: 06256135ae4d1e556af51bd67aa764f3bdf4095503b5e7c41daf9fa32093be49
+  data.tar.gz: 9007c044ff70251c24b9216b447b4190c4162b4f97b8ce2d8c488223d75d0d92
 SHA512:
-  metadata.gz: ad1b643a11d1254d44dcbcdad0ac308a16eaadc0ad658407247e23250c6a1c0ba466ced3ebab25652cd7d72d0cec73fbf8ccaa2ee9b44b25d817f1d2ea77a960
-  data.tar.gz: c88e40ce8d62e1e64d77e8f31a856a27bc7d88af254a3116d70621cb83fbcd3b189e5c40b28bea42c73d73f1a32adade49aff0ee570dcdcbdaa0f2e310d07d71
+  metadata.gz: 5ec452bfeb53407eed48aa5342a339e4137c95542547fcf098c7b9d91ba9cb0930e1afb3d42a2ce5c6e6bc0a779e6bd4555250cdb4fb37d566eb1d034b450f4f
+  data.tar.gz: eda0ad02dec02532b6430a46d997d9df4d5aeb963274efd9f08fedbb645d41721b81791d6a7641b7bd0e9834e9a02bafc8ae9e1ce4ece19e747a61b253351837

data/.rubocop.yml

@@ -13,7 +13,7 @@ Metrics/BlockLength:
     - 'spec/**/*'
 
 RSpec/MultipleMemoizedHelpers:
-  Max: 10
+  Enabled: false
 
 RSpec/ExampleLength:
   Max: 10
@@ -134,3 +134,22 @@ RSpec/FactoryBot/SyntaxMethods: # new in 2.7
   Enabled: true
 RSpec/Rails/AvoidSetupHook: # new in 2.4
   Enabled: true
+
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+RSpec/BeEq: # new in 2.9.0
+  Enabled: true
+RSpec/BeNil: # new in 2.9.0
+  Enabled: true
+RSpec/VerifiedDoubleReference: # new in 2.10.0
+  Enabled: true

data/Gemfile

@@ -4,7 +4,7 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem 'activesupport', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
+gem 'activesupport', ENV.fetch('RAILS_VERSION', nil) if ENV['RAILS_VERSION']
 
 # Specify your gem's dependencies in dor-services-client.gemspec
 gemspec

data/README.md

@@ -123,9 +123,11 @@ object_client.notify_goobi
 # Manage versions
 object_client.version.inventory
 object_client.version.current
-object_client.version.openable?(**params)
-object_client.version.open(**params)
-object_client.version.close(description: 'Changed title', significance: 'minor')
+object_client.version.openable?
+# see dor-services-app openapi.yml for optional params
+object_client.version.open(description: 'Changed title', significance: 'minor')
+# see dor-services-app openapi.yml for optional params
+object_client.version.close
 
 # Get the Dublin Core XML representation
 object_client.metadata.dublin_core

data/dor-services-client.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.7', '< 4' # dor-services-app needs 2.7 due to fedora3
 
   spec.add_dependency 'activesupport', '>= 4.2', '< 8'
-  spec.add_dependency 'cocina-models', '~> 0.75.0' # leave pinned to patch level until cocina-models hits 1.0
+  spec.add_dependency 'cocina-models', '~> 0.77.0' # leave pinned to patch level until cocina-models hits 1.0
   spec.add_dependency 'deprecation', '>= 0'
   spec.add_dependency 'faraday', '~> 2.0'
   spec.add_dependency 'faraday-retry'

data/lib/dor/services/client/accession.rb

@@ -15,10 +15,10 @@ module Dor
 
         # Start accession on an object (start specified workflow, assemblyWF by default, and version if needed)
         # @param params [Hash<Symbol,String>] optional parameter hash
-        # @option params [String] :significance set significance (major/minor/patch) of version change
-        # @option params [String] :description set description of version change
-        # @option params [String] :opening_user_name add opening username to the events datastream
-        # @option params [String] :workflow the workflow to start (defaults to 'assemblyWF')
+        # @option params [String] :significance set significance (major/minor/patch) of version change - required
+        # @option params [String] :description set description of version change - required
+        # @option params [String] :opening_user_name add opening username to the events datastream - optional
+        # @option params [String] :workflow the workflow to start - defaults to 'assemblyWF'
         # @return [Boolean] true on success
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.

data/lib/dor/services/client/mutate.rb

@@ -33,7 +33,10 @@ module Dor
         # @raise [BadRequestError] when ETag not provided.
         # @return [Cocina::Models::DROWithMetadata,Cocina::Models::CollectionWithMetadata,Cocina::Models::AdminPolicyWithMetadata] the returned model
         # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
         def update(params:, skip_lock: false)
+          raise ArgumentError, 'Cocina object not provided.' unless params.respond_to?(:externalIdentifier)
+
           # Raised if Cocina::Models::*WithMetadata not provided.
           raise ArgumentError, 'ETag not provided.' unless skip_lock || params.respond_to?(:lock)
 
@@ -42,7 +45,7 @@ module Dor
             req.headers['Content-Type'] = 'application/json'
             # asking the service to return JSON (else it'll be plain text)
             req.headers['Accept'] = 'application/json'
-            req.headers['If-Match'] = params[:lock] unless skip_lock
+            req.headers['If-Match'] = params.lock unless skip_lock
             req.body = build_json_from_cocina(params)
           end
 
@@ -51,6 +54,7 @@ module Dor
           build_cocina_from_response(resp)
         end
         # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/MethodLength
 
         # Pull in metadata from Symphony and updates descriptive metadata
         # @raise [NotFoundResponse] when the response is a 404 (object not found)

data/lib/dor/services/client/object.rb

@@ -55,27 +55,6 @@ module Dor
           build_cocina_from_response(resp)
         end
 
-        # Retrieves the Cocina model and response metadata
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [Array<Cocina::Models::DRO,Cocina::Models::Collection,Cocina::Models::AdminPolicy,ObjectMetadata>] a tuple where
-        #          the first is the model and the second is a ObjectMetadata object
-        def find_with_metadata
-          resp = connection.get do |req|
-            req.url object_path
-          end
-          raise_exception_based_on_response!(resp) unless resp.success?
-
-          model = Cocina::Models.build(JSON.parse(resp.body))
-
-          # Don't use #slice here as Faraday will downcase the keys.
-          metadata = ObjectMetadata.new(updated_at: resp.headers['Last-Modified'],
-                                        created_at: resp.headers['X-Created-At'],
-                                        etag: resp.headers['ETag'])
-          [model, metadata]
-        end
-        deprecation_deprecate find_with_metadata: 'Use find instead with provides models with metadata.'
-
         # Get a list of the collections. (Similar to Valkyrie's find_inverse_references_by)
         # @raise [UnexpectedResponse] if the request is unsuccessful.
         # @return [Array<Cocina::Models::DRO>]

data/lib/dor/services/client/object_version.rb

@@ -27,15 +27,13 @@ module Dor
         end
 
         # Determines if a new version can be opened for a DOR object.
-        # @param params [Hash] optional params (see dor-services-app)
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
         # @return [Boolean] true if a new version can be opened
         # rubocop:disable Metrics/MethodLength
-        def openable?(**params)
+        def openable?
           resp = connection.get do |req|
             req.url "#{base_path}/openable"
-            req.params = params
           end
 
           raise_exception_based_on_response!(resp) unless resp.success?
@@ -52,20 +50,30 @@ module Dor
         # rubocop:enable Metrics/MethodLength
 
         # Open new version for an object
-        # @param params [Hash] optional params (see dor-services-app)
-        # @raise [MalformedResponse] when the response is not parseable.
+        # @param description [String] a description of the object version being opened - required
+        # @param significance [String] 'major' 'minor' or 'admin' - required
+        # @param opening_user_name [String] sunetid - defaults to nil
+        # @param assume_accessioned [Boolean] if true, does not check whether object has been accessioned; defaults to false
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [String] the current version
+        # @return [Cocina::Models::DROWithMetadata|CollectionWithMetadata|AdminPolicyWithMetadata] cocina model with updated version
         def open(**params)
-          version = open_new_version_response(**params)
-          raise MalformedResponse, "Version of #{object_identifier} is empty" if version.empty?
+          resp = connection.post do |req|
+            req.url open_new_version_path
+            req.headers['Content-Type'] = 'application/json'
+            req.body = params.to_json if params.any?
+          end
 
-          version
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          build_cocina_from_response(resp)
         end
 
         # Close current version for an object
-        # @param params [Hash] optional params (see dor-services-app)
+        # @param description [String] (optional) - a description of the object version being opened
+        # @param significance [String] (optional) - 'major' 'minor' or 'admin'
+        # @param user_name [String] (optional) - sunetid
+        # @param start_accession [Boolean] (optional) - whether to start accessioning workflow; defaults to true
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
         # @return [String] a message confirming successful closing
@@ -99,22 +107,6 @@ module Dor
           "#{api_version}/objects/#{object_identifier}"
         end
 
-        # Make request to server to open a new version
-        # @param params [Hash] optional params (see dor-services-app)
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] on an unsuccessful response from the server
-        # @return [String] the plain text from the server
-        def open_new_version_response(**params)
-          resp = connection.post do |req|
-            req.url open_new_version_path
-            req.headers['Content-Type'] = 'application/json'
-            req.body = params.to_json if params.any?
-          end
-          return resp.body if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
         def base_path
           "#{object_path}/versions"
         end

data/lib/dor/services/client/objects.rb

@@ -8,9 +8,9 @@ module Dor
       # API calls that are about a repository objects
       class Objects < VersionedService
         # Creates a new object in DOR
-        # @param params [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAPO]
+        # @param params [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAdminPolicy]
         # @param assign_doi [Boolean]
-        # @return [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAPO] the returned model
+        # @return [Cocina::Models::DROWithMetadata,Cocina::Models::CollectionWithMetadata,Cocina::Models::AdminPolicyWithMetadata] the returned model
         def register(params:, assign_doi: false)
           resp = connection.post do |req|
             req.url "#{api_version}/objects"

data/lib/dor/services/client/version.rb

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '9.1.1'
+      VERSION = '10.2.0'
     end
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 9.1.1
+  version: 10.2.0
 platform: ruby
 authors:
 - Justin Coyne
 - Michael Giarlo
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.77.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.77.0
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -213,7 +213,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - jcoyne@justincoyne.com
 - leftwing@alumni.rutgers.edu
@@ -249,7 +249,6 @@ files:
 - lib/dor/services/client/metadata.rb
 - lib/dor/services/client/mutate.rb
 - lib/dor/services/client/object.rb
-- lib/dor/services/client/object_metadata.rb
 - lib/dor/services/client/object_version.rb
 - lib/dor/services/client/objects.rb
 - lib/dor/services/client/response_error_formatter.rb
@@ -262,7 +261,7 @@ homepage: https://github.com/sul-dlss/dor-services-client
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -280,8 +279,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.2.32
+signing_key: 
 specification_version: 4
 summary: A client for dor-services-app
 test_files: []

data/lib/dor/services/client/object_metadata.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require 'deprecation'
-
-module Dor
-  module Services
-    class Client
-      # An object representing metadata about the cocina object returned by the object show method
-      class ObjectMetadata
-        extend Deprecation
-
-        attr_reader :created_at, :updated_at, :etag
-
-        def initialize(created_at:, updated_at:, etag: nil)
-          @created_at = created_at
-          @updated_at = updated_at
-          @etag = etag
-        end
-
-        def [](key)
-          case key
-          when 'Last-Modified'
-            updated_at
-          when 'X-Created-At'
-            created_at
-          else
-            raise KeyError, 'Unknown key'
-          end
-        end
-        deprecation_deprecate(:[] => 'Hash accessor is no longer used, use object accessor instead')
-      end
-    end
-  end
-end