dor-services-client 10.0.0 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92add95b112e8d9c6cdce2ba2e91e08d4a49cb4d3329868c34441fe272fcc9c2
-  data.tar.gz: 18e2a92e7a11955f46ce18f832a0942dbbac87e300d3910e9cbddbb8ee7681fa
+  metadata.gz: fe7dfec36a8319421bee77745fe97ce0b82d42ae37496dfa0b53da9924520855
+  data.tar.gz: c52d59d1f89e919d634403fad5008034ffff6a49bc7cc36de512bac0075fb4b2
 SHA512:
-  metadata.gz: aab5c196702ecdf1fca112cc9e65ab4e0136a9f4d79a0f96e8b31a7d4b71cf3d2daa978cf59234190fba35d0674f31449f6a8c4ac5a2fac9c9fd38e933a4102e
-  data.tar.gz: 8882218dba3fa8266a19ea4c299569fd62c1b41b32119bf897b65d4333687df943c407e84bb3f48d213317caa40b8245ea4810eaf6e69f32b836bc6e262cc2aa
+  metadata.gz: f9698a746b759eff42f1b12ab31413c5c28527f1080649b8a8d9e62d56200871ae7907308d32161efaae83aa0507e95367e1d1566f401046246f200978e9253a
+  data.tar.gz: d76e0a78928835868bcc058369ea0f38933290110d42517d7b7440ccaa27eb3f45f41432de90e4b7e19031faeea2332f3236f1293edd462fc1feefc05aea6111

data/.rubocop.yml

@@ -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
@@ -136,14 +138,6 @@ object_client.metadata.descriptive
 # Get the public XML representation
 object_client.metadata.public_xml
 
-# Update legacy XML representation
-object_client.metadata.legacy_update(
-  descriptive: {
-    updated: Time.now,
-    content: '<descMetadata/>'
-  }
-)
-
 # Return the Cocina metadata
 object_client.find
 

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.78.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 event - 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/metadata.rb

@@ -13,32 +13,6 @@ module Dor
           @object_identifier = object_identifier
         end
 
-        # Updates using the legacy SDR/Fedora3 metadata
-        # @param [Hash<Symbol,Hash>] opts the options for legacy update
-        # @option opts [Hash] :administrative Data for administrative metadata
-        # @option opts [Hash] :content Data for structural metadata
-        # @option opts [Hash] :descriptive Data for descriptive metadata
-        # @option opts [Hash] :geo Data for geographic metadata
-        # @option opts [Hash] :identity Data for identity metadata
-        # @option opts [Hash] :provenance Data for provenance metadata
-        # @option opts [Hash] :relationships Data for RELS-EXT metadata
-        # @option opts [Hash] :rights Data for access rights metadata
-        # @option opts [Hash] :technical Data for technical metadata
-        # @option opts [Hash] :version Data for version metadata
-        # @example:
-        #  legacy_update(descriptive: { updated: '2001-12-20', content: '<descMetadata />' })
-        def legacy_update(opts)
-          opts = opts.slice(:administrative, :content, :descriptive, :geo, :identity, :provenance, :relationships, :rights, :technical, :version)
-          resp = connection.patch do |req|
-            req.url "#{base_path}/legacy"
-            req.headers['Content-Type'] = 'application/json'
-            req.body = opts.to_json
-          end
-          return if resp.success?
-
-          raise_exception_based_on_response!(resp, object_identifier)
-        end
-
         # @return [String, NilClass] The Dublin Core XML representation of the object or nil if response is 404
         # @raise [UnexpectedResponse] on an unsuccessful response from the server
         def dublin_core
@@ -101,33 +75,6 @@ module Dor
           raise_exception_based_on_response!(resp, object_identifier)
         end
 
-        # rubocop:disable Lint/StructNewOverride
-        Datastream = Struct.new(:label, :dsid, :pid, :size, :mimeType, :versionId, keyword_init: true)
-        # rubocop:enable Lint/StructNewOverride
-
-        # @return [Array] the list of datastreams for the item
-        # @raise [UnexpectedResponse] on an unsuccessful response from the server
-        def datastreams
-          resp = connection.get do |req|
-            req.url "#{base_path}/datastreams"
-          end
-          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
-
-          JSON.parse(resp.body).map { |params| Datastream.new(**params.symbolize_keys!) }
-        end
-
-        # @param [String] dsid the identifier for the datastream
-        # @return [String] the contents of the specified datastream
-        # @raise [UnexpectedResponse] on an unsuccessful response from the server
-        def datastream(dsid)
-          resp = connection.get do |req|
-            req.url "#{base_path}/datastreams/#{dsid}"
-          end
-          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
-
-          resp.body
-        end
-
         private
 
         attr_reader :object_identifier

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,7 +50,10 @@ module Dor
         # rubocop:enable Metrics/MethodLength
 
         # Open new version for an object
-        # @param params [Hash] optional params (see dor-services-app)
+        # @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 [Cocina::Models::DROWithMetadata|CollectionWithMetadata|AdminPolicyWithMetadata] cocina model with updated version
@@ -69,7 +70,10 @@ module Dor
         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

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '10.0.0'
+      VERSION = '11.0.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 10.0.0
+  version: 11.0.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
+date: 2022-05-04 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.78.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.78.0
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -280,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: A client for dor-services-app

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