dor-services-client 12.16.0 → 12.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec7edce5ca401aae71ab8e4b98b1b1c44c646e4565f25ba615ff8b0536ad807f
-  data.tar.gz: faabe27c830efb9135f1d171ca6a78193ce46c5edf98455850a9d555c470e336
+  metadata.gz: a474115832894037ecf11cebc49b133d19d18c5bf43eb24c41a58a8efd7fd0a3
+  data.tar.gz: c39cdb3823ebfcc28acc4cbff90a680560507c3099f15826abc1a2d122b17839
 SHA512:
-  metadata.gz: 1150fe0e08f2ea9a6bfe9a9bb198c85e661c0cb856b4d4c50392da8c69ce478d81cbc88d6c9936f95f2cedefbe3ab147944b69764fd3b0cd52ed7761eda1ae2d
-  data.tar.gz: 72c6d2a0c24e2cce44ead61de2f5eed38234b72fcbf75a0131e14e0c5b4126b2d0a3cbeeb69e18d614061a43f5a409791956f14cedf168c900576b6bd6b47a15
+  metadata.gz: e986337c48ceab9a1a84479caa51f580c1e6cd6ab5c876fb85c64c5a5985824f23d86b9a4b9ab6a548c482532f23859e726b21f0063325f3d82c42d4f8c32da1
+  data.tar.gz: 86170854e8d54022a93e7a70f8527d1028153ab3f0cd1d49ac4cedb8caec39e8b1836a4b3832e38b479848a53cd4c822f2c69ddeefa5f75956c49a0f88677c9d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dor-services-client (12.16.0)
+    dor-services-client (12.18.0)
       activesupport (>= 4.2, < 8)
       cocina-models (~> 0.91.0)
       deprecation

data/README.md

@@ -141,6 +141,9 @@ object_client.version.close
 # Return the Cocina metadata
 object_client.find
 
+# Returns "lite" Cocina metadata (excluding specified attributes)
+object_client.find_lite(structural: false, geographic: false)
+
 # Query for an object's collections
 object_client.collections
 

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

@@ -24,8 +24,7 @@ module Dor
         # @raise [UnexpectedResponse] when the response is not successful.
         def start(params = {})
           resp = connection.post do |req|
-            req.url path
-            req.params = params
+            req.url with_querystring(url: path, params: params)
           end
           return true if resp.success?
 

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

@@ -6,7 +6,7 @@ module Dor
   module Services
     class Client
       # API calls that are about a repository object
-      class Object < VersionedService
+      class Object < VersionedService # rubocop:disable Metrics/ClassLength
         extend Deprecation
         attr_reader :object_identifier
 
@@ -52,6 +52,35 @@ module Dor
           build_cocina_from_response(resp, validate: validate)
         end
 
+        BASE_ALLOWED_FIELDS = %i[external_identifier cocina_version label version administrative description].freeze
+        DRO_ALLOWED_FIELDS = BASE_ALLOWED_FIELDS + %i[content_type access identification structural geographic]
+
+        # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/ParameterLists
+        def find_lite(administrative: true, description: true, access: true, structural: true, identification: true, geographic: true)
+          fields = []
+          fields << :administrative if administrative
+          fields << :description if description
+          fields << :access if access
+          fields << :structural if structural
+          fields << :identification if identification
+          fields << :geographic if geographic
+
+          resp = connection.post '/graphql', query(fields),
+                                 'Content-Type' => 'application/json'
+          raise_exception_based_on_response!(resp) unless resp.success?
+          resp_json = JSON.parse(resp.body)
+          # GraphQL returns 200 even when an error
+          raise_graphql_exception(resp, resp_json)
+          Cocina::Models.build_lite(resp_json['data']['cocinaObject'])
+        end
+        # rubocop:enable Metrics/MethodLength
+        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/CyclomaticComplexity
+        # rubocop:enable Metrics/ParameterLists
+
         # 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>]
@@ -140,6 +169,35 @@ module Dor
         def object_path
           "#{api_version}/objects/#{object_identifier}"
         end
+
+        DEFAULT_FIELDS = %i[externalIdentifier type version label cocinaVersion].freeze
+
+        def query(fields)
+          all_fields = DEFAULT_FIELDS + fields
+          {
+            query:
+          <<~GQL
+            {
+              cocinaObject(externalIdentifier: "#{object_identifier}") {
+                #{all_fields.join("\n")}
+              }
+            }
+          GQL
+          }.to_json
+        end
+
+        def raise_graphql_exception(resp, resp_json)
+          return unless resp_json['errors'].present?
+
+          exception_class = not_found_exception?(resp_json['errors'].first) ? NotFoundResponse : UnexpectedResponse
+          raise exception_class.new(response: resp,
+                                    object_identifier: object_identifier,
+                                    graphql_errors: resp_json['errors'])
+        end
+
+        def not_found_exception?(error)
+          error['message'] == 'Cocina object not found'
+        end
       end
     end
   end

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

@@ -59,9 +59,8 @@ module Dor
         # @return [Cocina::Models::DROWithMetadata|CollectionWithMetadata|AdminPolicyWithMetadata] cocina model with updated version
         def open(**params)
           resp = connection.post do |req|
-            req.url open_new_version_path
+            req.url with_querystring(url: open_new_version_path, params: params)
             req.headers['Content-Type'] = 'application/json'
-            req.body = params.to_json if params.any?
           end
 
           raise_exception_based_on_response!(resp) unless resp.success?
@@ -79,9 +78,8 @@ module Dor
         # @return [String] a message confirming successful closing
         def close(**params)
           resp = connection.post do |req|
-            req.url close_version_path
+            req.url with_querystring(url: close_version_path, params: params)
             req.headers['Content-Type'] = 'application/json'
-            req.body = params.to_json if params.any?
           end
           return resp.body if resp.success?
 

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

@@ -14,11 +14,10 @@ module Dor
         # @return [Cocina::Models::DROWithMetadata,Cocina::Models::CollectionWithMetadata,Cocina::Models::AdminPolicyWithMetadata] the returned model
         def register(params:, assign_doi: false, validate: false)
           resp = connection.post do |req|
-            req.url objects_path
+            req.url with_querystring(url: objects_path, params: { assign_doi: assign_doi })
             req.headers['Content-Type'] = 'application/json'
             # asking the service to return JSON (else it'll be plain text)
             req.headers['Accept'] = 'application/json'
-            req.params[:assign_doi] = true if assign_doi
             req.body = params.to_json
           end
 

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '12.16.0'
+      VERSION = '12.18.0'
     end
   end
 end

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

@@ -25,6 +25,12 @@ module Dor
           AsyncResult.new(url: url)
         end
 
+        def with_querystring(url:, params:)
+          return url if params.blank?
+
+          "#{url}?#{params.to_query}"
+        end
+
         private
 
         attr_reader :connection, :api_version

data/lib/dor/services/client.rb

@@ -5,6 +5,7 @@ require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/object/blank'
 require 'active_support/json'
 require 'active_support/core_ext/object/json'
+require 'active_support/core_ext/object/to_query'
 require 'cocina/models'
 require 'faraday'
 require 'faraday/retry'
@@ -42,17 +43,21 @@ module Dor
         # @param [Faraday::Response] response
         # @param [String] object_identifier (nil)
         # @param [Hash<String,Object>] errors (nil) the JSON-API errors object
+        # @param [Hash<String,Object>] graphql_errors (nil) the GraphQL errors object
         # rubocop:disable Lint/MissingSuper
-        def initialize(response:, object_identifier: nil, errors: nil)
+        def initialize(response:, object_identifier: nil, errors: nil, graphql_errors: nil)
           @response = response
           @object_identifier = object_identifier
           @errors = errors
+          @graphql_errors = graphql_errors
         end
         # rubocop:enable Lint/MissingSuper
 
-        attr_accessor :errors
+        attr_accessor :errors, :graphql_errors
 
         def to_s
+          # For GraphQL errors, see https://graphql-ruby.org/errors/execution_errors
+          return graphql_errors.map { |e| e['message'] }.join(', ') if graphql_errors.present?
           return errors.map { |e| "#{e['title']} (#{e['detail']})" }.join(', ') if errors.present?
 
           ResponseErrorFormatter.format(response: @response, object_identifier: @object_identifier)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 12.16.0
+  version: 12.18.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-11 00:00:00.000000000 Z
+date: 2023-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport