dor-services-client 6.25.0 → 6.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17f90f597dabb405cf4771be6fd03f6ae80e8caf8180ff6a2bb6680e0ff32454
-  data.tar.gz: da5d8d68d8d81516e49908e3d50c192a362a6f8a18ccb46db0ea38ac874af0bd
+  metadata.gz: e44b232de63ec88be66da8ef7f2334860a33e996632b7ecb79ee2e2928af33e1
+  data.tar.gz: 9e373dcc5e8ebeb39b154853898117a88397d3dc263f466a60fcf6c1010c3f31
 SHA512:
-  metadata.gz: cdaaa313ac9f5dfde5bbc1b9073de7c872aa1cb7870bdf89577d1031c5337fa5e214c1b943e0137024893691a2632c87992fa0eb205637ea0eab5ecfada7c7cf
-  data.tar.gz: a8702c0a9a0a7594bd27edc89051720b791dbeaac01be210021891b3e47e1822c789fbb63b4fd2d1a7d79fc60efac78628b32558a2d8dc2d6bc72a9c94ff2ed2
+  metadata.gz: 9f87acf4192e098774c638f061f519ccd6f8b555d8087eeb591517c6892345e079b5d180de532ecb04a3a7e902af4aa4a620dc485b6f7a21ed66cf106e59607c
+  data.tar.gz: ecd7f9b38217c6b8d73d8cc25156fd5ea6c8ded64de91f442e1980fbc800076a1847ebb28a67b1a8edf6a52e861bb8387eafc2e547f0c2dfd91b288c930036de

data/.rubocop.yml

@@ -1,8 +1,10 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
 
 Metrics/BlockLength:
   Exclude:
+    - 'dor-services-client.gemspec'
     - 'spec/**/*'

data/.rubocop_todo.yml

@@ -1,23 +1,18 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-04-23 17:01:17 -0400 using RuboCop version 0.82.0.
+# on 2021-03-17 17:24:07 UTC using RuboCop version 1.11.0.
 # 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
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 2
-# Configuration parameters: IgnoredMethods.
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 20
+  Max: 22
 
 # Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 115
-
-# Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 11
 
@@ -28,9 +23,9 @@ Style/Documentation:
     - 'test/**/*'
     - 'lib/dor/services/client.rb'
 
-# Offense count: 338
+# Offense count: 77
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
-Metrics/LineLength:
+Layout/LineLength:
   Max: 164

data/README.md

@@ -110,10 +110,14 @@ object_client.update_marc_record
 # Copy metadata from Symphony into descMetadata
 object_client.refresh_metadata
 
+# Apply defaults from the item's AdminPolicy to the item itself
+object_client.apply_admin_policy_defaults
+
 # Send a notification to goobi
 object_client.notify_goobi
 
 # Manage versions
+object_client.version.inventory
 object_client.version.current
 object_client.version.openable?(**params)
 object_client.version.open(**params)

data/dor-services-client.gemspec

@@ -22,8 +22,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '~> 2.6'
+
   spec.add_dependency 'activesupport', '>= 4.2', '< 7'
-  spec.add_dependency 'cocina-models', '~> 0.53.0' # leave pinned to patch level until cocina-models hits 1.0
+  spec.add_dependency 'cocina-models', '~> 0.55.0' # leave pinned to patch level until cocina-models hits 1.0
   spec.add_dependency 'deprecation', '>= 0'
   spec.add_dependency 'faraday', '>= 0.15', '< 2'
   spec.add_dependency 'moab-versioning', '~> 4.0'
@@ -33,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.61.0'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
   spec.add_development_dependency 'simplecov', '~> 0.17.0' # CodeClimate cannot use SimpleCov >= 0.18.0 for generating test coverage
   spec.add_development_dependency 'webmock'
 end

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

@@ -7,8 +7,7 @@ module Dor
     class Client
       # API calls that are about searching AdministrativeTags
       class AdministrativeTagSearch < VersionedService
-        # rubocop:disable Naming/UncommunicativeMethodParamName
-        def search(q:)
+        def search(q:) # rubocop:disable Naming/MethodParameterName
           resp = connection.get do |req|
             req.url "#{api_version}/administrative_tags/search?q=#{q}"
           end
@@ -18,7 +17,6 @@ module Dor
 
           raise_exception_based_on_response!(resp)
         end
-        # rubocop:enable Naming/UncommunicativeMethodParamName
       end
     end
   end

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

@@ -51,7 +51,7 @@ module Dor
           raise_exception_based_on_response!(resp, object_identifier)
         end
 
-        # @return [String, NilClass] The descriptive metadata XML representation of the object or nil if response is 404
+        # @return [String, NilClass] The public descriptive metadata XML representation of the object or nil if response is 404
         # @raise [UnexpectedResponse] on an unsuccessful response from the server
         def descriptive
           resp = connection.get do |req|
@@ -63,6 +63,45 @@ module Dor
           raise_exception_based_on_response!(resp, object_identifier)
         end
 
+        # @return [String, NilClass] the dor object's source MODS XML or nil if response is 404
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        def mods
+          resp = connection.get do |req|
+            req.url "#{base_path}/mods"
+          end
+          return resp.body if resp.success?
+          return if resp.status == 404
+
+          raise_exception_based_on_response!(resp, object_identifier)
+        end
+
+        # rubocop:disable Lint/StructNewOverride
+        Datastream = Struct.new(:label, :dsid, :pid, :size, :mimeType, 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) }
+        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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls that update the data.
+      class Mutate < VersionedService
+        # @param object_identifier [String] the pid for the object
+        def initialize(connection:, version:, object_identifier:)
+          super(connection: connection, version: version)
+          @object_identifier = object_identifier
+        end
+
+        # Copies the values from the admin policy to the item
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [boolean] true on success
+        def apply_admin_policy_defaults
+          resp = connection.post do |req|
+            req.url "#{object_path}/apply_admin_policy_defaults"
+          end
+
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          true
+        end
+
+        # Updates the object
+        # @param [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAPO] params model object
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [Cocina::Models::DRO,Cocina::Models::Collection,Cocina::Models::AdminPolicy] the returned model
+        def update(params:)
+          resp = connection.patch do |req|
+            req.url object_path
+            req.headers['Content-Type'] = 'application/json'
+            # asking the service to return JSON (else it'll be plain text)
+            req.headers['Accept'] = 'application/json'
+            req.body = params.to_json
+          end
+
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          Cocina::Models.build(JSON.parse(resp.body))
+        end
+
+        # Pull in metadata from Symphony and updates descriptive metadata
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [boolean] true on success
+        def refresh_metadata
+          resp = connection.post do |req|
+            req.url "#{object_path}/refresh_metadata"
+          end
+
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          true
+        end
+
+        # Destroys an object
+        # @return [Boolean] true if successful
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
+        def destroy
+          resp = connection.delete do |req|
+            req.url object_path
+          end
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
+
+          true
+        end
+
+        private
+
+        def object_path
+          "#{api_version}/objects/#{object_identifier}"
+        end
+
+        attr_reader :object_identifier
+      end
+    end
+  end
+end

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

@@ -73,25 +73,6 @@ module Dor
           [model, metadata]
         end
 
-        # Updates the object
-        # @param [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAPO] params model object
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [Cocina::Models::DRO,Cocina::Models::Collection,Cocina::Models::AdminPolicy] the returned model
-        def update(params:)
-          resp = connection.patch do |req|
-            req.url object_path
-            req.headers['Content-Type'] = 'application/json'
-            # asking the service to return JSON (else it'll be plain text)
-            req.headers['Accept'] = 'application/json'
-            req.body = params.to_json
-          end
-
-          return Cocina::Models.build(JSON.parse(resp.body)) if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
         # 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>]
@@ -106,56 +87,17 @@ module Dor
           Members.new(**parent_params).members
         end
 
-        # Publish an object (send to PURL)
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @param [String] workflow ('accessionWF') which workflow to callback to.
-        # @param [String] lane_id for prioritization (default or low)
-        # @return [boolean] true on success
-        def publish(workflow: nil, lane_id: nil)
-          query_params = [].tap do |params|
-            params << "workflow=#{workflow}" if workflow
-            params << "lane-id=#{lane_id}" if lane_id
-          end
-          query_string = query_params.any? ? "?#{query_params.join('&')}" : ''
-          publish_path = "#{object_path}/publish#{query_string}"
-          resp = connection.post do |req|
-            req.url publish_path
-          end
-          return resp.headers['Location'] if resp.success?
-
-          raise_exception_based_on_response!(resp)
+        def transfer
+          Transfer.new(**parent_params)
         end
 
-        # Preserve an object (send to SDR)
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @param [String] lane_id for prioritization (default or low)
-        # @return [String] URL from Location response header if no errors
-        def preserve(lane_id: nil)
-          query_string = lane_id ? "?lane-id=#{lane_id}" : ''
-          resp = connection.post do |req|
-            req.url "#{object_path}/preserve#{query_string}"
-          end
-          return resp.headers['Location'] if resp.success?
+        delegate :publish, :preserve, :shelve, to: :transfer
 
-          raise_exception_based_on_response!(resp)
+        def mutate
+          Mutate.new(**parent_params)
         end
 
-        # Shelve an object (send to Stacks)
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @param [String] lane_id for prioritization (default or low)
-        # @return [boolean] true on success
-        def shelve(lane_id: nil)
-          query_string = lane_id ? "?lane-id=#{lane_id}" : ''
-          resp = connection.post do |req|
-            req.url "#{object_path}/shelve#{query_string}"
-          end
-          return resp.headers['Location'] if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
+        delegate :refresh_metadata, :update, :destroy, :apply_admin_policy_defaults, to: :mutate
 
         # Update the marc record for the given object
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
@@ -170,19 +112,6 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
-        # Pull in metadata from Symphony and update descMetadata
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [boolean] true on success
-        def refresh_metadata
-          resp = connection.post do |req|
-            req.url "#{object_path}/refresh_metadata"
-          end
-          return true if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
         # Notify the external Goobi system for a new object that was registered in DOR
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.

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

@@ -5,6 +5,8 @@ module Dor
     class Client
       # API calls that are about versions
       class ObjectVersion < VersionedService
+        Version = Struct.new(:versionId, :tag, :message, keyword_init: true)
+
         # @param object_identifier [String] the pid for the object
         def initialize(connection:, version:, object_identifier:)
           super(connection: connection, version: version)
@@ -17,7 +19,7 @@ module Dor
         # @return [String] the version identifier
         def current
           resp = connection.get do |req|
-            req.url "#{object_path}/versions/current"
+            req.url "#{base_path}/current"
           end
           return resp.body if resp.success?
 
@@ -32,15 +34,16 @@ module Dor
         # rubocop:disable Metrics/MethodLength
         def openable?(**params)
           resp = connection.get do |req|
-            req.url "#{object_path}/versions/openable"
+            req.url "#{base_path}/openable"
             req.params = params
           end
 
           raise_exception_based_on_response!(resp) unless resp.success?
 
-          if resp.body == 'true'
+          case resp.body
+          when 'true'
             true
-          elsif resp.body == 'false'
+          when 'false'
             false
           else
             raise MalformedResponse, "Expected true or false, not #{resp.body}"
@@ -77,6 +80,17 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
+        # @return [Array] a list of the versions
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        def inventory
+          resp = connection.get do |req|
+            req.url base_path
+          end
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
+
+          JSON.parse(resp.body).fetch('versions').map { |params| Version.new(**params) }
+        end
+
         private
 
         attr_reader :object_identifier
@@ -101,12 +115,14 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
-        def open_new_version_path
+        def base_path
           "#{object_path}/versions"
         end
 
+        alias open_new_version_path base_path
+
         def close_version_path
-          "#{object_path}/versions/current/close"
+          "#{base_path}/current/close"
         end
       end
     end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls that move data around.
+      class Transfer < VersionedService
+        # @param object_identifier [String] the pid for the object
+        def initialize(connection:, version:, object_identifier:)
+          super(connection: connection, version: version)
+          @object_identifier = object_identifier
+        end
+
+        # Publish an object (send to PURL)
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @param [String] workflow ('accessionWF') which workflow to callback to.
+        # @param [String] lane_id for prioritization (default or low)
+        # @return [boolean] true on success
+        def publish(workflow: nil, lane_id: nil)
+          query_params = [].tap do |params|
+            params << "workflow=#{workflow}" if workflow
+            params << "lane-id=#{lane_id}" if lane_id
+          end
+          query_string = query_params.any? ? "?#{query_params.join('&')}" : ''
+          publish_path = "#{object_path}/publish#{query_string}"
+          resp = connection.post do |req|
+            req.url publish_path
+          end
+          return resp.headers['Location'] if resp.success?
+
+          raise_exception_based_on_response!(resp)
+        end
+
+        # Preserve an object (send to SDR)
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @param [String] lane_id for prioritization (default or low)
+        # @return [String] URL from Location response header if no errors
+        def preserve(lane_id: nil)
+          query_string = lane_id ? "?lane-id=#{lane_id}" : ''
+          resp = connection.post do |req|
+            req.url "#{object_path}/preserve#{query_string}"
+          end
+          return resp.headers['Location'] if resp.success?
+
+          raise_exception_based_on_response!(resp)
+        end
+
+        # Shelve an object (send to Stacks)
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @param [String] lane_id for prioritization (default or low)
+        # @return [boolean] true on success
+        def shelve(lane_id: nil)
+          query_string = lane_id ? "?lane-id=#{lane_id}" : ''
+          resp = connection.post do |req|
+            req.url "#{object_path}/shelve#{query_string}"
+          end
+          return resp.headers['Location'] if resp.success?
+
+          raise_exception_based_on_response!(resp)
+        end
+
+        private
+
+        def object_path
+          "#{api_version}/objects/#{object_identifier}"
+        end
+
+        attr_reader :object_identifier
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '6.25.0'
+      VERSION = '6.29.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 6.25.0
+  version: 6.29.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 0.55.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 0.55.0
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -169,14 +169,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.61.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.61.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -240,11 +240,13 @@ files:
 - lib/dor/services/client/marcxml.rb
 - lib/dor/services/client/members.rb
 - lib/dor/services/client/metadata.rb
+- lib/dor/services/client/mutate.rb
 - lib/dor/services/client/object.rb
 - lib/dor/services/client/object_version.rb
 - lib/dor/services/client/objects.rb
 - lib/dor/services/client/release_tags.rb
 - lib/dor/services/client/response_error_formatter.rb
+- lib/dor/services/client/transfer.rb
 - lib/dor/services/client/version.rb
 - lib/dor/services/client/versioned_service.rb
 - lib/dor/services/client/virtual_objects.rb
@@ -258,16 +260,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A client for dor-services-app