dor-services-client 12.12.0 → 12.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0785a4251d87011c92d747b53287decd18d38d87ced4f7b0314b065e8de1171c'
-  data.tar.gz: 29a9f5bf2a4bd0778163e8219f457b354bd355ff9cb5a8c1150e2cd786d1899e
+  metadata.gz: c94acf8a213cf620164db178ae247a9c2da72c00d66422febe0a8d858588f2cb
+  data.tar.gz: 0fb9ff1ae19620172d7fe52e91b813d3434a1edbe6d2d840e0c87319f3866e8f
 SHA512:
-  metadata.gz: 8ceb855f09e1392aff2e7aed507960e291a3be66062dcd8b78a238774d4a5b82dbfe0ce6aa37fea21122a823dfebf864810991cf29adeba60f97b4b9e0f1cb59
-  data.tar.gz: d5d5920229c2d8e770a5e941da31d8d273dd59076dbe3647e2d155f886025193a030395f3e994c52c02af162467e8519fee059e9141e56f67cee311379e457bb
+  metadata.gz: bc10a436fe0c74780a0e9d3efb4895d55683c79a4443d3a89546409b6ebae65342ba989c14430d9f3a9644150e3a321853ff2dab68c874263566fbf896854542
+  data.tar.gz: fe9d19f2557a2b1e03399071093c2bb7243b62528b9464d5f2a5e184bcbf63e1ecb9ad54b7ce6660799358bb26fd4bcc555f217361e8b15381ce227ec63aec5e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dor-services-client (12.12.0)
+    dor-services-client (12.12.1)
       activesupport (>= 4.2, < 8)
       cocina-models (~> 0.88.0)
       deprecation
@@ -38,7 +38,7 @@ GEM
       thor
       zeitwerk (~> 2.1)
     commonmarker (0.23.8)
-    concurrent-ruby (1.2.0)
+    concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
     deprecation (1.1.0)
@@ -117,14 +117,14 @@ GEM
     rspec-support (3.12.0)
     rss (0.2.9)
       rexml
-    rubocop (1.45.1)
+    rubocop (1.46.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.26.0)
@@ -158,6 +158,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-darwin-20
   x86_64-darwin-21
   x86_64-linux
 

data/README.md

@@ -81,15 +81,15 @@ background_jobs_client.show(job_id: 123)
 # Perform MARCXML operations
 marcxml_client = Dor::Services::Client.marcxml
 
-# Retrieve a catkey for a given barcode
-marcxml_client.catkey(barcode: '123456789')
-
 # 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)
 

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

@@ -5,47 +5,29 @@ module Dor
     class Client
       # API calls around MARCXML-based operations from dor-services-app
       class Marcxml < VersionedService
-        # Get a catkey corresponding to a barcode
-        # @param barcode [String] required string representing a barcode
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] on an unsuccessful response from the server
-        # @return [String] catkey
-        def catkey(barcode:)
-          resp = connection.get do |req|
-            req.url "#{api_version}/catalog/catkey"
-            req.params['barcode'] = barcode
-          end
-
-          return resp.body if resp.success? && resp.body.present?
-
-          # This method needs its own exception handling logic due to how the endpoint service (SearchWorks) operates
-          # 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.blank?
-
-          raise UnexpectedResponse.new(response: resp)
-        end
-
         # Gets MARCXML corresponding to a barcode or catkey
-        # @param barcode [String] required string representing a barcode
-        # @param catkey [String] required string representing a 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)
-          check_args(barcode, catkey)
+        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.
-          # Rather, it responds with a 500 containing "Record not found in Symphony" in the body.
+          # 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 Symphony/)
+          raise NotFoundResponse.new(response: resp) if !resp.success? && resp.body.match?(/Record not found in catalog/)
 
           raise UnexpectedResponse.new(response: resp) unless resp.success?
 
@@ -54,10 +36,12 @@ module Dor
 
         private
 
-        def check_args(barcode, catkey)
-          raise ArgumentError, 'Barcode or catkey must be provided' if barcode.nil? && catkey.nil?
-          raise ArgumentError, 'Both barcode and catkey may not be provided' if !barcode.nil? && !catkey.nil?
+        # 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

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '12.12.0'
+      VERSION = '12.12.1'
     end
   end
 end

data/lib/dor/services/client.rb

@@ -27,7 +27,7 @@ module Dor
       # Base class for Dor::Services::Client exceptions
       class Error < StandardError; end
 
-      # Error that is raised when the ultimate remote server returns a 404 Not Found for the id in our request (e.g. for druid, barcode, catkey)
+      # Error that is raised when the ultimate remote server returns a 404 Not Found for the id in our request (e.g. druid, barcode, catkey, folio_instance_hrid)
       class NotFoundResponse < Error; end
 
       # Error that is raised when the remote server returns some unparsable response

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 12.12.0
+  version: 12.12.1
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-22 00:00:00.000000000 Z
+date: 2023-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -280,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: A client for dor-services-app