dor-services-client 15.67.0 → 15.69.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecbd808105364dbb0e939e9fff80a3df720681c9b06b62e5422bc43c4a45fb34
-  data.tar.gz: f6969b77a83eba79e20509ae34e7afeccadbca351555e463a26659c16efe398b
+  metadata.gz: f7eb1b5eb6201610e9bd4496dcc0709e4a3348639aae0655c25373b98d00c621
+  data.tar.gz: f45e73e423f64393198f41d2ef7f4d954bc0794b470aea4e7b647e2f37cd2e01
 SHA512:
-  metadata.gz: cc2fb1431c27567fed4655fed06c32127b96209e56b732067d703e603f300a0b0633cbc751a9cb63aaba7d9d7fb8f3151ebc8867f75b4572b20794e6f66a8fe2
-  data.tar.gz: 7fe53128c34e19cbc88e1ae9257bc9af650da2d575f2c87321c8628a7781c1ef053cfc2515d4d118d107de174592cca20c96765fbc2fb013c1d582ef28b4e896
+  metadata.gz: ba12e822c3fcbd54f30d140ed114ee680854580b00a9632aa77b6f1081ca31258693836f4b5b325e18bfde34c38c3055cd81c6e4cc6f7c18ceb76de03403ac50
+  data.tar.gz: 5d825bc8d170005932dcd7d9d104c43ad7a3560aa6e99673c245fa6abbf1de01993286cef5aeb4930ea297db304fa88db58a5bd6ea6b6bd6d2deb595e51869d3

data/.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2.1
 orbs:
-  ruby-rails: sul-dlss/ruby-rails@4.12.0
+  ruby-rails: sul-dlss/ruby-rails@4.13.1
 workflows:
   build:
     jobs:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dor-services-client (15.67.0)
+    dor-services-client (15.69.0)
       activesupport (>= 7.0.0)
       cocina-models (~> 0.133.0)
       deprecation
@@ -14,7 +14,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.1.3.1)
+    activesupport (8.1.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
@@ -32,7 +32,7 @@ GEM
     ast (2.4.3)
     attr_extras (7.1.0)
     base64 (0.3.0)
-    bigdecimal (4.1.2)
+    bigdecimal (4.1.3)
     byebug (13.0.0)
       reline (>= 0.6.0)
     cocina-models (0.133.0)
@@ -49,7 +49,7 @@ GEM
       super_diff
       thor
       zeitwerk (~> 2.1)
-    cocina_display (2.10.0)
+    cocina_display (2.13.0)
       activesupport (>= 7)
       edtf (~> 3.2)
       geo_coord (~> 0.2)
@@ -92,7 +92,7 @@ GEM
       activesupport (>= 3.0, < 9.0)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    faraday (2.14.3)
+    faraday (2.14.4)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
@@ -107,15 +107,15 @@ GEM
     i18n (1.15.2)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    io-console (0.8.2)
+    io-console (0.9.4)
     iso8601 (0.13.0)
     janeway-jsonpath (1.1.0)
-    json (2.21.2)
-    jsonschema_rs (0.49.3-arm64-darwin)
+    json (3.0.2)
+    jsonschema_rs (0.58.5-arm64-darwin)
       bigdecimal (>= 3.1, < 5)
-    jsonschema_rs (0.49.3-x86_64-darwin)
+    jsonschema_rs (0.58.5-x86_64-darwin)
       bigdecimal (>= 3.1, < 5)
-    jsonschema_rs (0.49.3-x86_64-linux)
+    jsonschema_rs (0.58.5-x86_64-linux)
       bigdecimal (>= 3.1, < 5)
     language_server-protocol (3.17.0.6)
     lint_roller (1.1.0)
@@ -132,7 +132,7 @@ GEM
     nokogiri (1.19.4-x86_64-linux-gnu)
       racc (~> 1.4)
     optimist (3.2.1)
-    parallel (2.1.0)
+    parallel (2.3.0)
     parser (3.3.12.0)
       ast (~> 2.4.1)
       racc
@@ -143,8 +143,8 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.4.2)
-    regexp_parser (2.12.0)
-    reline (0.6.3)
+    regexp_parser (2.13.1)
+    reline (0.7.0)
       io-console (~> 0.5)
     rexml (3.4.4)
     rspec (3.13.2)
@@ -160,8 +160,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.88.2)
-      json (~> 2.3)
+    rubocop (1.91.0)
+      json (>= 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
       parallel (>= 1.10)
@@ -180,7 +180,7 @@ GEM
       rubocop (~> 1.86, >= 1.86.2)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
-    simplecov (1.0.3)
+    simplecov (1.3.2)
     super_diff (0.19.0)
       attr_extras (>= 6.2.4, < 8)
       diff-lcs (~> 1.5)
@@ -188,11 +188,11 @@ GEM
     thor (1.5.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (3.2.0)
-      unicode-emoji (~> 4.1)
-    unicode-emoji (4.2.0)
+    unicode-display_width (3.3.0)
+      unicode-emoji (~> 4.3)
+    unicode-emoji (4.3.0)
     uri (1.1.1)
-    webmock (3.26.2)
+    webmock (3.26.4)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -220,4 +220,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-  4.0.17
+  4.0.22

data/README.md

@@ -83,6 +83,9 @@ background_jobs_client = Dor::Services::Client.background_job_results
 # Show results of background job
 background_jobs_client.show(job_id: 123)
 
+# List the valid event types
+Dor::Services::Client.event_types.list
+
 # For performing operations on a known, registered object
 object_client = Dor::Services::Client.object(object_identifier)
 
@@ -117,6 +120,8 @@ object_client.version.solr(2)
 object_client.version.open(description: 'Changed title')
 # see dor-services-app openapi.yml for optional params
 object_client.version.close
+# Update the description of the currently open version
+object_client.version.update_description(description: 'Changed title and abstract', user_name: 'some_sunetid')
 
 # Manage user versions
 object_client.user_version.inventory
@@ -159,6 +164,9 @@ object_client.release_tags.list(public: true) # only public release tags (i.e. l
 # Create and list events for an object
 object_client.events.create(type: type, data: data)
 object_client.events.list
+object_client.events.list(event_types: ['version_open', 'version_close'])
+# from is inclusive and to is exclusive; either may be a Time, Date, or ISO 8601 string (UTC if no offset is given)
+object_client.events.list(from: '2026-10-01', to: Time.now)
 
 # Create workspaces
 object_client.workspace.create(source: object_path_string)

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Dor
+  module Services
+    class Client
+      # API calls around event types from dor-services-app
+      class EventTypes < VersionedService
+        # List the valid event types
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        # @return [Array<String>] the valid event types, sorted
+        def list
+          resp = connection.get do |req|
+            req.url "#{api_version}/event_types"
+            req.headers['Accept'] = 'application/json'
+          end
+
+          return JSON.parse(resp.body) if resp.success?
+
+          raise_exception_based_on_response!(resp)
+        end
+      end
+    end
+  end
+end

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

@@ -13,9 +13,10 @@ module Dor
           @object_identifier = object_identifier
         end
 
-        # @param type [String] a type for the event, e.g., publish, shelve
+        # @param type [String] a type for the event, e.g., version_open, publishing_complete. Must be a known event type (see EventTypes#list).
         # @param data [Hash] an unstructured hash of event data
         # @return [Boolean] true if successful
+        # @raise [BadRequestError] when the event is invalid, e.g., the event type is unknown
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] if the request is unsuccessful.
         def create(type:, data:)
@@ -31,11 +32,16 @@ module Dor
         end
 
         # @param event_types [Array<String>,NilClass] an array of event types to filter by, or nil for all
+        # @param from [Time,Date,String,NilClass] only events created at or after this time (inclusive), or nil for no lower bound.
+        #   A String must be an ISO 8601 date or date-time; UTC if no offset is given.
+        # @param to [Time,Date,String,NilClass] only events created before this time (exclusive), or nil for no upper bound.
+        #   A String must be an ISO 8601 date or date-time; UTC if no offset is given.
         # @return [Array<Event>,NilClass] The events for an object or nil if 404
+        # @raise [BadRequestError] when from or to is invalid
         # @raise [UnexpectedResponse] on an unsuccessful response from the server
-        def list(event_types: nil)
+        def list(event_types: nil, from: nil, to: nil)
           resp = connection.get("#{api_version}/objects/#{object_identifier}/events",
-                                { event_types: event_types }.compact)
+                                { event_types: event_types, from: iso8601(from), to: iso8601(to) }.compact)
           return response_to_models(resp) if resp.success?
           return if resp.status == 404
 
@@ -46,6 +52,10 @@ module Dor
 
         attr_reader :object_identifier
 
+        def iso8601(value)
+          value.respond_to?(:iso8601) ? value.iso8601 : value
+        end
+
         def response_to_models(resp)
           JSON.parse(resp.body).map { |data| Event.new(event_type: data['event_type'], data: data['data'], timestamp: data['created_at']) }
         end

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

@@ -123,6 +123,23 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
+        # Update the description of the currently open version for an object
+        # @param description [String] the new description of the version - required
+        # @param user_name [String] (optional) - sunetid
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [ConflictResponse] when the response is a 409 (no version is open)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        def update_description(description:, user_name: nil)
+          resp = connection.patch do |req|
+            req.url "#{base_path}/current"
+            req.headers['Content-Type'] = 'application/json'
+            req.body = { description: description, user_name: user_name }.compact.to_json
+          end
+          return if resp.success?
+
+          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

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '15.67.0'
+      VERSION = '15.69.0'
     end
   end
 end

data/lib/dor/services/client.rb

@@ -122,6 +122,11 @@ module Dor
         @background_job_results ||= BackgroundJobResults.new(connection: connection, version: DEFAULT_VERSION)
       end
 
+      # @return [Dor::Services::Client::EventTypes] an instance of the `Client::EventTypes` class
+      def event_types
+        @event_types ||= EventTypes.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)
@@ -144,7 +149,7 @@ module Dor
           self
         end
 
-        delegate :background_job_results, :objects, :object, :virtual_objects, :administrative_tags, :workflows, to: :instance
+        delegate :background_job_results, :event_types, :objects, :object, :virtual_objects, :administrative_tags, :workflows, to: :instance
       end
 
       attr_writer :url, :token, :connection, :enable_get_retries, :logger

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 15.67.0
+  version: 15.69.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -263,6 +263,7 @@ files:
 - lib/dor/services/client/background_job_results.rb
 - lib/dor/services/client/collections.rb
 - lib/dor/services/client/error_faraday_middleware.rb
+- lib/dor/services/client/event_types.rb
 - lib/dor/services/client/events.rb
 - lib/dor/services/client/invalid_cocina.rb
 - lib/dor/services/client/members.rb
@@ -307,7 +308,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.14
+rubygems_version: 4.0.20
 specification_version: 4
 summary: A client for dor-services-app
 test_files: []