dor-services-client 14.10.0 → 14.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0617e31e85fd412f80cfce8eecfbc05c3a9e9039158ed7e93bb7a8b5dd73f44f
-  data.tar.gz: f555839734ce309b4a8d161691b9903f2c4dcafde73b85607c71ba14eba00b93
+  metadata.gz: c0c0ec136ed9ea12e5a6c0efc2c2663a5657f49bc2b956ff057586da83c360a5
+  data.tar.gz: bb9c3b96fc62eb5456f85cea0e08de070e3831df74230fff530575d4df2b791e
 SHA512:
-  metadata.gz: e3b3c31bff0f82e979e23a0a2749122a44a4646f73594b9fa9e7b4c3fcc992908acd8f77f6436a1b530bba8035c5c1649fded38a638b014b6d265b22d28aac1d
-  data.tar.gz: f34661793f42deeca10cd7abd9ce2420aa1c3a9950cf64342eeaa05bdd6f5b0674defc2c2608fb5476ba43ef1d2bd42765eb16c3f4536783ee46a8343da12590
+  metadata.gz: 9f1094a15841a375b9f3542064a4f64b30b1d701e91a2db1b923e056383bdc0ecf35ec1067f9eefcb426e7f3cc7e2acd90d64854e6b59c7458e8f20158c35c7e
+  data.tar.gz: 908f23a64f6c4028f2a6eddb1956ccb0b9823195a6b4a667029ce2dabe6103604fc3f489cdf68e4aa8d4eb982eb1c9c2319330803716ec56385326f504a0acd2

data/.circleci/config.yml

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dor-services-client (14.10.0)
+    dor-services-client (14.11.0)
       activesupport (>= 4.2, < 8)
       cocina-models (~> 0.97.0)
       deprecation
@@ -44,8 +44,10 @@ GEM
       super_diff
       thor
       zeitwerk (~> 2.1)
-    commonmarker (0.23.10)
-    concurrent-ruby (1.2.3)
+    commonmarker (1.1.3-arm64-darwin)
+    commonmarker (1.1.3-x86_64-darwin)
+    commonmarker (1.1.3-x86_64-linux)
+    concurrent-ruby (1.3.1)
     connection_pool (2.4.1)
     crack (1.0.0)
       bigdecimal
@@ -93,7 +95,7 @@ GEM
     jsonpath (1.1.5)
       multi_json
     language_server-protocol (3.17.0.3)
-    minitest (5.23.0)
+    minitest (5.23.1)
     multi_json (1.15.0)
     mutex_m (0.2.0)
     net-http (0.4.1)
@@ -104,21 +106,21 @@ GEM
       racc (~> 1.4)
     nokogiri (1.16.5-x86_64-linux)
       racc (~> 1.4)
-    openapi3_parser (0.9.2)
-      commonmarker (~> 0.17)
+    openapi3_parser (0.10.0)
+      commonmarker (>= 1.0)
     openapi_parser (1.0.0)
     optimist (3.1.0)
     parallel (1.24.0)
-    parser (3.3.1.0)
+    parser (3.3.2.0)
       ast (~> 2.4.1)
       racc
     patience_diff (1.2.0)
       optimist (~> 3.0)
     public_suffix (5.0.5)
-    racc (1.7.3)
+    racc (1.8.0)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.9.1)
+    regexp_parser (2.9.2)
     rexml (3.2.8)
       strscan (>= 3.0.9)
     rspec (3.13.0)
@@ -134,7 +136,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.63.5)
+    rubocop (1.64.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -151,7 +153,7 @@ GEM
       rubocop (~> 1.41)
     rubocop-factory_bot (2.25.1)
       rubocop (~> 1.41)
-    rubocop-rspec (2.29.2)
+    rubocop-rspec (2.30.0)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
@@ -175,11 +177,11 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
     uri (0.13.0)
-    webmock (3.23.0)
+    webmock (3.23.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.14)
+    zeitwerk (2.6.15)
 
 PLATFORMS
   arm64-darwin-23

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # A tag that indicates the item or collection should be released.
+      class ReleaseTag < Dry::Struct
+        transform_keys(&:to_sym)
+        schema schema.strict
+        # Who did this release
+        # example: petucket
+        attribute? :who, Types::Strict::String
+        # What is being released. This item or the whole collection.
+        # example: self
+        attribute :what, Types::Strict::String.enum('self', 'collection')
+        # When did this action happen
+        attribute? :date, Types::Params::DateTime
+        # What platform is it released to
+        # example: Searchworks
+        attribute? :to, Types::Strict::String
+        attribute :release, Types::Strict::Bool.default(false)
+      end
+    end
+  end
+end

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

@@ -13,7 +13,7 @@ module Dor
 
         # Create a release tag for an object
         #
-        # @param tag [Cocina::Models::ReleaseTag]
+        # @param tag [ReleaseTag]
         # @return [Boolean] true if successful
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] if the request is unsuccessful.
@@ -32,7 +32,7 @@ module Dor
         #
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] if the request is unsuccessful.
-        # @return [Array<Cocina::Models::ReleaseTag>]
+        # @return [Array<ReleaseTag>]
         def list
           resp = connection.get do |req|
             req.url "#{api_version}/objects/#{object_identifier}/release_tags"
@@ -40,7 +40,7 @@ module Dor
 
           raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
 
-          JSON.parse(resp.body).map { |tag_data| Cocina::Models::ReleaseTag.new(tag_data) }
+          JSON.parse(resp.body).map { |tag_data| ReleaseTag.new(tag_data) }
         end
 
         private

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '14.10.0'
+      VERSION = '14.12.0'
     end
   end
 end

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

@@ -12,16 +12,24 @@ module Dor
         end
 
         # Initializes a new workspace
-        # @param source [String] the path to the object
+        # @param source [String] the path to the object (optional)
+        # @param content [Boolean] determines if the content directory should be created (defaults to false)
+        # @param metadata [Boolean] determines if the metadata directory should be created (defaults to false)
         # @raise [UnexpectedResponse] if the request is unsuccessful.
-        # @return nil
-        def create(source:)
+        # @return [String] the path to the directory created
+        # rubocop:disable Metrics/AbcSize
+        def create(source: nil, content: false, metadata: false)
           resp = connection.post do |req|
             req.url workspace_path
-            req.params['source'] = source
+            req.params['source'] = source if source
+            req.params['content'] = content
+            req.params['metadata'] = metadata
           end
+          return JSON.parse(resp.body)['path'] if resp.success?
+
           raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
         end
+        # rubocop:enable Metrics/AbcSize
 
         # Cleans up a workspace
         # @raise [NotFoundResponse] when the response is a 404 (object not found)

data/lib/dor/services/client.rb

@@ -78,6 +78,10 @@ module Dor
       # Error that is raised when the remote server returns a 400 Bad Request; apps should not retry the request
       class BadRequestError < UnexpectedResponse; end
 
+      module Types
+        include Dry.Types()
+      end
+
       # @param object_identifier [String] the pid for the object
       # @raise [ArgumentError] when `object_identifier` is `nil`
       # @return [Dor::Services::Client::Object] an instance of the `Client::Object` class

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 14.10.0
+  version: 14.12.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-17 00:00:00.000000000 Z
+date: 2024-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -249,6 +249,7 @@ files:
 - lib/dor/services/client/object.rb
 - lib/dor/services/client/object_version.rb
 - lib/dor/services/client/objects.rb
+- lib/dor/services/client/release_tag.rb
 - lib/dor/services/client/release_tags.rb
 - lib/dor/services/client/response_error_formatter.rb
 - lib/dor/services/client/transfer.rb