dor-services-client 12.17.0 → 13.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28239d64f9889da5c2eb01d1f7c1a724454a3f9d6e5dc04454e6d537d8b1530c
-  data.tar.gz: abffc94573aa3106b599477bff35c786c4ce4d6ba6bc41e9dea37dc43e8b220a
+  metadata.gz: 52d7f1922fb592d9b86bc19bb2613ea2649b294a83e6dc898795514ef75889ab
+  data.tar.gz: 3f455ceee20044d6b2dda3f9f74f25100349a7f390c9de462df2621b051e29da
 SHA512:
-  metadata.gz: 70a705670a2f0ac259b7af85806f909311d2222eb0af263d1bcbd2d96bffb0cf34185e2a9a38f4ba8cd5e1da1f3f9d1c01d4d0c490ddf29873a421d40402212e
-  data.tar.gz: 5ff867b49a8d5a552a6d0d5ffada7298fec9d8e19df029f8b79de2899ed1ab65b4058ddf4c0986ae99f1e6c63749bea999e3f165e3bb369416986f19e7e488ad
+  metadata.gz: 3a11dbc88113dbb5844d483c4514616ddbea9de1c5cce7afcab3e38b1f466e0f4c1f63cf6fe58953a7b6321b02eb408e2196a240ae8850d25b51d32a1785a48f
+  data.tar.gz: f322703d6d85a737bebc790701235f4765c4e2fd7fee248704c1c5dc1c027f991b082634765b415cbfb483e4d2f5c664712e500b67af82823fe00c194037639f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dor-services-client (12.17.0)
+    dor-services-client (13.0.0)
       activesupport (>= 4.2, < 8)
       cocina-models (~> 0.91.0)
       deprecation
@@ -23,7 +23,7 @@ GEM
     attr_extras (7.1.0)
     base64 (0.1.1)
     byebug (11.1.3)
-    cocina-models (0.91.0)
+    cocina-models (0.91.2)
       activesupport
       deprecation
       dry-struct (~> 1.0)
@@ -69,7 +69,8 @@ GEM
       activesupport (>= 3.0, < 8.0)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    faraday (2.7.10)
+    faraday (2.7.11)
+      base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
@@ -80,7 +81,7 @@ GEM
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
     json (2.6.3)
-    jsonpath (1.1.3)
+    jsonpath (1.1.4)
       multi_json
     language_server-protocol (3.17.0.3)
     minitest (5.20.0)
@@ -120,7 +121,7 @@ GEM
     rspec-support (3.12.1)
     rss (0.3.0)
       rexml
-    rubocop (1.56.3)
+    rubocop (1.56.4)
       base64 (~> 0.1.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
@@ -134,11 +135,11 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.18.0)
+    rubocop-capybara (2.19.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.23.1)
+    rubocop-factory_bot (2.24.0)
       rubocop (~> 1.33)
-    rubocop-rspec (2.24.0)
+    rubocop-rspec (2.24.1)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
@@ -157,12 +158,12 @@ GEM
     thor (1.2.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
     webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.11)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   x86_64-darwin-19

data/README.md

@@ -78,18 +78,6 @@ background_jobs_client = Dor::Services::Client.background_job_results
 # Show results of background job
 background_jobs_client.show(job_id: 123)
 
-# Perform MARCXML operations
-marcxml_client = Dor::Services::Client.marcxml
-
-# Retrieve MARCXML for a given barcode
-marcxml_client.marcxml(barcode: '123456789')
-
-# Retrieve MARCXML for a given catkey
-marcxml_client.marcxml(catkey: '987654321')
-
-# Retrieve MARCXML for a given FOLIO instance HRID
-marcxml_client.marcxml(folio_instance_hrid: 'in000123')
-
 # For performing operations on a known, registered object
 object_client = Dor::Services::Client.object(object_identifier)
 
@@ -141,6 +129,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/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/version.rb

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '12.17.0'
+      VERSION = '13.0.0'
     end
   end
 end

data/lib/dor/services/client.rb

@@ -43,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)
@@ -107,11 +111,6 @@ module Dor
         @background_job_results ||= BackgroundJobResults.new(connection: connection, version: DEFAULT_VERSION)
       end
 
-      # @return [Dor::Services::Client::Marcxml] an instance of the `Client::Marcxml` class
-      def marcxml
-        @marcxml ||= Marcxml.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)
@@ -127,8 +126,7 @@ module Dor
           self
         end
 
-        delegate :background_job_results, :marcxml, :objects, :object,
-                 :virtual_objects, :administrative_tags, to: :instance
+        delegate :background_job_results, :objects, :object, :virtual_objects, :administrative_tags, to: :instance
       end
 
       attr_writer :url, :token, :connection, :enable_get_retries

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 12.17.0
+  version: 13.0.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-13 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -245,7 +245,6 @@ files:
 - lib/dor/services/client/connection_wrapper.rb
 - lib/dor/services/client/error_faraday_middleware.rb
 - lib/dor/services/client/events.rb
-- lib/dor/services/client/marcxml.rb
 - lib/dor/services/client/members.rb
 - lib/dor/services/client/mutate.rb
 - lib/dor/services/client/object.rb
@@ -279,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: A client for dor-services-app

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Services
-    class Client
-      # API calls around MARCXML-based operations from dor-services-app
-      class Marcxml < VersionedService
-        # Gets MARCXML corresponding to a barcode or catkey
-        # @param barcode [String] string representing a barcode
-        # @param catkey [String] string representing a catkey
-        # @param folio_instance_hrid [String] string representing a Folio instance HRID
-        # @raise [NotFoundResponse] when the response is a 500 with "Record not found in Symphony"
-        # @raise [UnexpectedResponse] on an unsuccessful response from the server
-        # @return [String] MARCXML
-        def marcxml(barcode: nil, catkey: nil, folio_instance_hrid: nil)
-          check_args(barcode, catkey, folio_instance_hrid)
-
-          resp = connection.get do |req|
-            req.url "#{api_version}/catalog/marcxml"
-            req.params['barcode'] = barcode unless barcode.nil?
-            req.params['catkey'] = catkey unless catkey.nil?
-            req.params['folio_instance_hrid'] = folio_instance_hrid unless folio_instance_hrid.nil?
-          end
-
-          # This method needs its own exception handling logic due to how the endpoint service (Symphony) operates
-
-          # DOR Services App does not respond with a 404 when no match in Symphony or Folio.
-          # Rather, it responds with a 500 containing "Record not found in catalog" in the body.
-          # raise a NotFoundResponse because the resource being requested was not found in the ILS (via dor-services-app)
-          raise NotFoundResponse.new(response: resp) if !resp.success? && resp.body.match?(/Record not found in catalog/)
-
-          raise UnexpectedResponse.new(response: resp) unless resp.success?
-
-          resp.body
-        end
-
-        private
-
-        # rubocop:disable Layout/LineLength
-        def check_args(barcode, catkey, folio_instance_hrid)
-          raise ArgumentError, 'Barcode, catkey, or folio_instance_hrid must be provided' if barcode.nil? && catkey.nil? && folio_instance_hrid.nil?
-          raise ArgumentError, 'Both barcode and a catalog id (catkey or folio_instance_hrid) may not be provided' if !barcode.nil? && (!catkey.nil? || !folio_instance_hrid.nil?)
-        end
-        # rubocop:enable Layout/LineLength
-      end
-    end
-  end
-end