dor-services-client 10.1.0 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d5e8a1919cb3cf3e1ad0ae59f1d29a0a30d181d330146ddb0cc8a580f5e37a8
-  data.tar.gz: abc969bfa3b1aae80c666d5ab244ca8ca3ebf2bbfe73fde20dabeffa8dfdefea
+  metadata.gz: 9d123cfe73a0981439bec1c66e49f10bb6dd5d0d43bebf72eebaede03f4ae6ae
+  data.tar.gz: 0f2f18cc38f22bca07062506662f0feaa1613e7179f4ab86379d3d60dca74394
 SHA512:
-  metadata.gz: 969b9fde995a8598ef1fa33c6aefb18e0fae6aa42fb38ff30ed1c8e6e939622e45921d5c26dbcf19668eb52930a81fd18e44e005345ee51a98da80dcde5f2fe9
-  data.tar.gz: edfe4f38b84cde8a1da06b527d16d1b8a46ccba945db6944809bc1d9748f56d328e449d3921668018e1bc966812a123a70a3508858331e9ac6892992e02f0391
+  metadata.gz: 45638215f8d33a565923e1c75368d649faa675bcd9491914b6d9fd73f5bb72ac9c2d3b9c32a2754ac6307545ed9ad88e85e05c298a3c141bafbe44defeae5ded
+  data.tar.gz: fddfd25949ecda8603982e4008321dce816dd2633d51db01c97de3b589c5341092c7fe90f3df164446ce85162c4ed8bb6a80dbbf33472ae4831b376ede539b29

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

@@ -138,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.76.0' # leave pinned to patch level until cocina-models hits 1.0
+  spec.add_dependency 'cocina-models', '~> 0.79.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

@@ -17,7 +17,7 @@ module Dor
         # @param params [Hash<Symbol,String>] optional parameter hash
         # @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] :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)

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
@@ -87,47 +61,6 @@ module Dor
           raise_exception_based_on_response!(resp, object_identifier)
         end
 
-        # Update the MODS XML metadata
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @return [boolean] true on success
-        def update_mods(mods_xml)
-          resp = connection.put do |req|
-            req.url "#{base_path}/mods"
-            req.headers['Content-Type'] = 'application/xml'
-            req.body = mods_xml
-          end
-          return if resp.success?
-
-          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/mutate.rb

@@ -28,13 +28,14 @@ module Dor
         # Updates the object
         # @param [Cocina::Models::DROWithMetadata|CollectionWithMetadata|AdminPolicyWithMetadata|DRO|Collection|AdminPolicy] params model object
         # @param [boolean] skip_lock do not provide ETag
+        # @param [boolean] validate validate the response object
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
         # @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)
+        def update(params:, skip_lock: false, validate: false)
           raise ArgumentError, 'Cocina object not provided.' unless params.respond_to?(:externalIdentifier)
 
           # Raised if Cocina::Models::*WithMetadata not provided.
@@ -51,7 +52,7 @@ module Dor
 
           raise_exception_based_on_response!(resp) unless resp.success?
 
-          build_cocina_from_response(resp)
+          build_cocina_from_response(resp, validate: validate)
         end
         # rubocop:enable Metrics/AbcSize
         # rubocop:enable Metrics/MethodLength

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

@@ -43,39 +43,19 @@ module Dor
         end
 
         # Retrieves the Cocina model
+        # @param [boolean] validate validate the response object
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
         # @return [Cocina::Models::DROWithMetadata,Cocina::Models::CollectionWithMetadata,Cocina::Models::AdminPolicyWithMetadata] the returned model
-        def find
+        def find(validate: false)
           resp = connection.get do |req|
             req.url object_path
           end
           raise_exception_based_on_response!(resp) unless resp.success?
 
-          build_cocina_from_response(resp)
+          build_cocina_from_response(resp, validate: validate)
         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/objects.rb

@@ -10,8 +10,9 @@ module Dor
         # Creates a new object in DOR
         # @param params [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAdminPolicy]
         # @param assign_doi [Boolean]
+        # @param [boolean] validate validate the response object
         # @return [Cocina::Models::DROWithMetadata,Cocina::Models::CollectionWithMetadata,Cocina::Models::AdminPolicyWithMetadata] the returned model
-        def register(params:, assign_doi: false)
+        def register(params:, assign_doi: false, validate: false)
           resp = connection.post do |req|
             req.url "#{api_version}/objects"
             req.headers['Content-Type'] = 'application/json'
@@ -23,7 +24,7 @@ module Dor
 
           raise_exception_based_on_response!(resp) unless resp.success?
 
-          build_cocina_from_response(resp)
+          build_cocina_from_response(resp, validate: validate)
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '10.1.0'
+      VERSION = '12.0.0'
     end
   end
 end

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

@@ -41,8 +41,8 @@ module Dor
                                     errors: data.fetch('errors', []))
         end
 
-        def build_cocina_from_response(response)
-          cocina_object = Cocina::Models.build(JSON.parse(response.body))
+        def build_cocina_from_response(response, validate: false)
+          cocina_object = Cocina::Models.build(JSON.parse(response.body), validate: validate)
           Cocina::Models.with_metadata(cocina_object, response.headers['ETag'], created: date_from_header(response, 'X-Created-At'),
                                                                                 modified: date_from_header(response, 'Last-Modified'))
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 10.1.0
+  version: 12.0.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-28 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: 0.79.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: 0.79.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