dor-services-client 15.10.0 → 15.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8467ba23bd9a15f5d6c692298e3525452007fbf4e505f776d57075f5d753e419
-  data.tar.gz: 333641b7ec8b66168f1debebf1cd78a50d7805b6400397ad1d93171094b1f326
+  metadata.gz: 0d25cb073f436c9dd92ecc738e8279216a84088e61d9452a4f7c81c9889e3138
+  data.tar.gz: 2d7db7153e6227ac47e93952ae44600fc0d7f1187127f96521bc4cdcbcd7b7a2
 SHA512:
-  metadata.gz: 5e1c13af8621423fa025523ed9981ab6932ec61f9e3f76af60fba0e32c967df4a5c4112aeff9718d3033c9df140b9fa3c30c986b80cf0b1c194da0254d39473c
-  data.tar.gz: f9867cced6f822a9cf8da1b3c86ae03952d4dd523015af67bd1b1ad45ab17d2e8a014b8c2fbe3e560e1fc81ce9a663075ed91c4aa6305e3e6956e207d161930a
+  metadata.gz: 59aee4af11f92713f68e2a114af9db4be1cb684fd2d06660463a57c3bf9762dccfffad527c441abfe4cf8ac6a607f010676765b1d01b2792c955216a62b23f12
+  data.tar.gz: 903bc3b83d1c664cd9b198e0a1985ad0e9727bb8fb50502e74faa265c7dbce3dd103e3fbc35e92a4af4617437dbcd2c70abf4dc8a6ff1248606e73a5388e70e9

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    dor-services-client (15.10.0)
+    dor-services-client (15.12.0)
       activesupport (>= 7.0.0)
-      cocina-models (~> 0.103.2)
+      cocina-models (~> 0.104.0)
       deprecation
       faraday (~> 2.0)
       faraday-retry
@@ -31,9 +31,9 @@ GEM
     attr_extras (7.1.0)
     base64 (0.3.0)
     benchmark (0.4.1)
-    bigdecimal (3.2.1)
+    bigdecimal (3.2.2)
     byebug (12.0.0)
-    cocina-models (0.103.2)
+    cocina-models (0.104.0)
       activesupport
       deprecation
       dry-struct (~> 1.0)
@@ -72,7 +72,7 @@ GEM
       dry-types (~> 1.8, >= 1.8.2)
       ice_nine (~> 0.11)
       zeitwerk (~> 2.6)
-    dry-types (1.8.2)
+    dry-types (1.8.3)
       bigdecimal (~> 3.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0)
@@ -87,9 +87,9 @@ GEM
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
-    faraday-net_http (3.4.0)
+    faraday-net_http (3.4.1)
       net-http (>= 0.5.0)
-    faraday-retry (2.3.1)
+    faraday-retry (2.3.2)
       faraday (~> 2.0)
     hashdiff (1.2.0)
     i18n (1.14.7)
@@ -139,7 +139,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.4)
-    rubocop (1.75.8)
+    rubocop (1.77.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -147,10 +147,10 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.44.0, < 2.0)
+      rubocop-ast (>= 1.45.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.44.1)
+    rubocop-ast (1.45.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     rubocop-rspec (3.6.0)
@@ -164,7 +164,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    super_diff (0.15.0)
+    super_diff (0.16.0)
       attr_extras (>= 6.2.4)
       diff-lcs
       patience_diff

data/README.md

@@ -60,7 +60,7 @@ objects_client = Dor::Services::Client.objects
 
 # Register a non-existent object
 objects_client.register(params: {})
-objects_client.register(params: {}, assign_doi: true)
+objects_client.register(params: {}, assign_doi: true, user_name: 'dude')
 
 # Find object by source ID
 objects_client.find(source_id: 'sul:abc123')
@@ -84,7 +84,7 @@ background_jobs_client.show(job_id: 123)
 object_client = Dor::Services::Client.object(object_identifier)
 
 # Update an object
-object_client.update(params: dro)
+object_client.update(params: dro, user_name: 'dude', description: 'things change sometimes')
 
 # Publish an object (push to PURL)
 object_client.publish(workflow: 'releaseWF', lane_id: 'low')
@@ -154,6 +154,9 @@ object_client.reindex
 
 # Search for administrative tags:
 Dor::Services::Client.administrative_tags.search(q: 'Project')
+
+# Get a list of workflow templates
+Dor::Services::Client.workflows.templates
 ```
 
 ## Asynchronous results

data/dor-services-client.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 3.0', '< 4'
 
   spec.add_dependency 'activesupport', '>= 7.0.0'
-  spec.add_dependency 'cocina-models', '~> 0.103.2'
+  spec.add_dependency 'cocina-models', '~> 0.104.0'
   spec.add_dependency 'deprecation', '>= 0'
   spec.add_dependency 'faraday', '~> 2.0'
   spec.add_dependency 'faraday-retry'

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

@@ -29,7 +29,7 @@ module Dor
         # @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
-        # @param [string] who the sunetid of the user performing the update
+        # @param [string] user_name the sunetid of the user performing the update
         # @param [string] description a description of the update
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
@@ -37,7 +37,7 @@ module Dor
         # @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, validate: false, who: nil, description: nil)
+        def update(params:, skip_lock: false, validate: false, user_name: nil, description: nil)
           raise ArgumentError, 'Cocina object not provided.' unless params.respond_to?(:externalIdentifier)
 
           # Raised if Cocina::Models::*WithMetadata not provided.
@@ -45,7 +45,7 @@ module Dor
 
           resp = connection.patch do |req|
             req.url object_path
-            req.params = { event_description: description, event_who: who }.compact
+            req.params = { event_description: description, user_name: user_name }.compact
             req.headers['Content-Type'] = 'application/json'
             # asking the service to return JSON (else it'll be plain text)
             req.headers['Accept'] = 'application/json'
@@ -80,10 +80,9 @@ module Dor
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] if the request is unsuccessful.
         def destroy(user_name: nil)
-          path = object_path
-          path += "?user_name=#{user_name}" if user_name
           resp = connection.delete do |req|
-            req.url path
+            req.url object_path
+            req.params = { user_name: user_name }.compact
           end
           raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
 

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

@@ -10,13 +10,13 @@ module Dor
         # Creates a new object in DOR
         # @param params [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAdminPolicy]
         # @param [boolean] assign a doi to the object
-        # @param [string] who the sunetid of the user registering the object
+        # @param [string] user_name the sunetid of the user registering the object
         # @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, validate: false, who: nil)
+        def register(params:, assign_doi: false, validate: false, user_name: nil)
           resp = connection.post do |req|
             req.url objects_path
-            req.params = { assign_doi: assign_doi, event_who: who }.compact
+            req.params = { assign_doi: assign_doi, user_name: user_name }.compact
             req.headers['Content-Type'] = 'application/json'
             # asking the service to return JSON (else it'll be plain text)
             req.headers['Accept'] = 'application/json'

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '15.10.0'
+      VERSION = '15.12.0'
     end
   end
 end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls around workflows in DOR
+      class Workflows < VersionedService
+        # Retrieves a list of workflow template name
+        # @return [Array<String>] the list of templates
+        def templates
+          resp = connection.post do |req|
+            req.url "#{api_version}/workflow_templates"
+            req.headers['Content-Type'] = 'application/json'
+            req.headers['Accept'] = 'application/json'
+          end
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          JSON.parse(resp.body)
+        end
+      end
+    end
+  end
+end

data/lib/dor/services/client.rb

@@ -116,6 +116,11 @@ module Dor
         @background_job_results ||= BackgroundJobResults.new(connection: connection, version: DEFAULT_VERSION)
       end
 
+      # @return [Dor::Services::Client::Workflows] an instance of the `Client::Workflows` class
+      def workflows
+        @workflows ||= Workflows.new(connection: connection, version: DEFAULT_VERSION)
+      end
+
       class << self
         # @param [String] url the base url of the endpoint the client should connect to (required)
         # @param [String] token a bearer token for HTTP authentication (required)
@@ -133,7 +138,7 @@ module Dor
           self
         end
 
-        delegate :background_job_results, :objects, :object, :virtual_objects, :administrative_tags, to: :instance
+        delegate :background_job_results, :objects, :object, :virtual_objects, :administrative_tags, :workflows, to: :instance
       end
 
       attr_writer :url, :token, :connection, :enable_get_retries, :logger

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 15.10.0
+  version: 15.12.0
 platform: ruby
 authors:
 - Justin Coyne
 - Michael Giarlo
 bindir: exe
 cert_chain: []
-date: 2025-06-05 00:00:00.000000000 Z
+date: 2025-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.103.2
+        version: 0.104.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.103.2
+        version: 0.104.0
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -248,6 +248,7 @@ files:
 - lib/dor/services/client/version.rb
 - lib/dor/services/client/versioned_service.rb
 - lib/dor/services/client/virtual_objects.rb
+- lib/dor/services/client/workflows.rb
 - lib/dor/services/client/workspace.rb
 homepage: https://github.com/sul-dlss/dor-services-client
 licenses: []
@@ -270,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A client for dor-services-app
 test_files: []