dor-services-client 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bc4758395797b8e5b89c28b1db1587628728e0983e1f85f2985875b80b1f907
-  data.tar.gz: f6e2af51ab5b85c9b5295779f2bb8cf3466deed3016bf9fd281f17657e414919
+  metadata.gz: ce0f327c126168128a603bb0c50b455922a6542e61a186c141851d5b2f11cf7c
+  data.tar.gz: 060ce3ba245a689a518ec8be58a9666c0b45d61b31d01f7577fcba22738c89aa
 SHA512:
-  metadata.gz: ada4de8d9117375cda2225b2491a57f96c599fd44a77273e2c04c85e1b9a75acdbc82e0da641cb7e1cba16f1ee8b4b0e8e3fdf26eb325c1dff2b02b06d9773f5
-  data.tar.gz: 14b7d08e789e16c122631b18989786e2e2a44a78f010ce8d943694001786f475a9120bb1341d6f2c4cc6f432ae9d261881a436ad4cd5db90f1f7d3209d98a534
+  metadata.gz: a9e5a35b526047c84571bb35238cc1743daabfd1a4fb6315d45c21efb9066ea22c29c28a5e3f1a4e879c1b01f44c6cb7c866b124b0b8013bbc80a3b688f7b125
+  data.tar.gz: f69c66c22201e36ecee91ed7ad64267d23fdc2413d2a39b879d433f189088af9ddf77d6288be3027ec91116d5c5030068738b39e2571cc711b402354ba480c8e

data/README.md

@@ -51,24 +51,30 @@ Note that the client may **not** be used without first having been configured, a
 Dor::Services:Client provides a number of methods to simplify connecting to the RESTful HTTP API of dor-services-app. In this section we list all of the available methods, reflecting how much of the API the client covers. For details see the [API docs](https://www.rubydoc.info/github/sul-dlss/dor-services-client/master/Dor/Services/Client)
 
 ```ruby
-# For performing operations on one or more objects
+# Perform operations on one or more objects
 objects_client = Dor::Services::Client.objects
 
-# For registering a non-existent object
+# Register a non-existent object
 objects_client.register(params: {})
 
-# For interacting with virtual objects
+# Interact with virtual objects
 virtual_objects_client = Dor::Services::Client.virtual_objects
 
 # Create a batch of virtual objects
 virtual_objects_client.create(virtual_objects: [{ parent_id: '', child_ids: [''] }])
 
-# For getting background job results
+# Retrieve background job results
 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 a catkey for a given barcode
+marcxml_client.catkey(barcode: 'foobarcode')
+
 # For performing operations on a known, registered object
 object_client = Dor::Services::Client.object(object_identifier)
 

data/lib/dor/services/client.rb

@@ -66,6 +66,11 @@ 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)
@@ -79,7 +84,7 @@ module Dor
           self
         end
 
-        delegate :objects, :object, :virtual_objects, :background_job_results, to: :instance
+        delegate :background_job_results, :marcxml, :objects, :object, :virtual_objects, to: :instance
       end
 
       attr_writer :url, :token, :connection

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

@@ -22,13 +22,6 @@ module Dor
 
           raise_exception_based_on_response!(resp)
         end
-
-        private
-
-        def raise_exception_based_on_response!(response)
-          raise (response.status == 404 ? NotFoundResponse : UnexpectedResponse),
-                ResponseErrorFormatter.format(response: response)
-        end
       end
     end
   end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    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] result of background job
+        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?
+          raise NotFoundResponse if resp.success? && resp.body.blank?
+
+          raise_exception_based_on_response!(resp)
+        end
+      end
+    end
+  end
+end

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

@@ -150,11 +150,6 @@ module Dor
         def object_path
           "#{api_version}/objects/#{object_identifier}"
         end
-
-        def raise_exception_based_on_response!(response)
-          raise (response.status == 404 ? NotFoundResponse : UnexpectedResponse),
-                ResponseErrorFormatter.format(response: response)
-        end
       end
     end
   end

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

@@ -85,11 +85,6 @@ module Dor
           "#{api_version}/objects/#{object_identifier}"
         end
 
-        def raise_exception_based_on_response!(response)
-          raise (response.status == 404 ? NotFoundResponse : UnexpectedResponse),
-                ResponseErrorFormatter.format(response: response)
-        end
-
         # Make request to server to open a new version
         # @param params [Hash] optional params (see dor-services-app)
         # @raise [NotFoundResponse] when the response is a 404 (object not found)

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '4.0.0'
+      VERSION = '4.1.0'
     end
   end
 end

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

@@ -18,6 +18,11 @@ module Dor
         private
 
         attr_reader :connection, :api_version
+
+        def raise_exception_based_on_response!(response)
+          raise (response.status == 404 ? NotFoundResponse : UnexpectedResponse),
+                ResponseErrorFormatter.format(response: response)
+        end
       end
     end
   end

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

@@ -21,13 +21,6 @@ module Dor
 
           raise_exception_based_on_response!(resp)
         end
-
-        private
-
-        def raise_exception_based_on_response!(response)
-          raise (response.status == 404 ? NotFoundResponse : UnexpectedResponse),
-                ResponseErrorFormatter.format(response: response)
-        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-07 00:00:00.000000000 Z
+date: 2020-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -213,6 +213,7 @@ files:
 - lib/dor/services/client/embargo.rb
 - lib/dor/services/client/error_faraday_middleware.rb
 - lib/dor/services/client/files.rb
+- lib/dor/services/client/marcxml.rb
 - lib/dor/services/client/metadata.rb
 - lib/dor/services/client/object.rb
 - lib/dor/services/client/object_version.rb
@@ -241,7 +242,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A client for dor-services-app