dor-services-client 2.6.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c7df3ec5c52111c42883e1b2f4acb0cc94bfda0a012f9afee44cf5497dc44e1
-  data.tar.gz: dcedf9c6b29ccdfe0e13250903630823893e531836f5f1800899829c55480e2f
+  metadata.gz: bed8dcd19dcbcd18cb303450debe16dc2f32060e66acc3506a547870789bae5e
+  data.tar.gz: a7c4880010e32aceedd6a3fdfd5e81a8501e50f0e01cdd1d79ef1b2d5f6695a4
 SHA512:
-  metadata.gz: 17fc69850386d011507a8134419a10714ef1c80cefcacba1a14ea8f406db9e0e82ce0fbc6cc8384f6d2efe3c1226edfa78a0e30f01a16332c5c8e15f98f37b33
-  data.tar.gz: 60d9556b954999ec29148a23e3c0169853584a3ccc6ee5b94afeb2b04d8f8e9386d275f4923ffef3b01c28b02d02fb46c33d528603e4fc21a96b2bf64d6ab32d
+  metadata.gz: 414ba947b6c25d3219f53538cea66f6f16d4c742a413dfea18800145eb083c72dcd6d45db4762ee7cf17b1cd1d1f68d125c118f7af138526d2ed9d58546e39ac
+  data.tar.gz: 5b6784ff405e9b96e29c9a2e74c4ec6cbc16ccb585dd9793d542bf340e60a792d163e6c076b9c9a18cb92b070c63c82661dd1d3097b366fb460a701a07452433

data/README.md

@@ -40,12 +40,11 @@ private
 
 def client
   @client ||= Dor::Services::Client.configure(url: Settings.dor_services.url,
-                                              token: Settings.dor_services.token,
-                                              token_header: Settings.dor_services.token_header)
+                                              token: Settings.dor_services.token)
 end
 ```
 
-Note that the client may **not** be used without first having been configured, and the `url` keyword is **required**. The `token` and `token_header` arguments are optional (though when using the client with staging and production servers, you will always need to supply these in practice). For more about dor-services-app's token-based authentication, see [its README](https://github.com/sul-dlss/dor-services-app#authentication).
+Note that the client may **not** be used without first having been configured, and the `url` keyword is **required**. The `token` argument is optional (though when using the client with staging and production servers, you will always need to supply it in practice). For more about dor-services-app's token-based authentication, see [its README](https://github.com/sul-dlss/dor-services-app#authentication).
 
 ## API Coverage
 
@@ -64,6 +63,12 @@ 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
+background_jobs_client = Dor::Services::Client.background_job_results
+
+# Show results of background job
+background_jobs_client.show(job_id: 123)
+
 # For performing operations on a known, registered object
 object_client = Dor::Services::Client.object(object_identifier)
 
@@ -76,9 +81,6 @@ object_client.update_marc_record
 # Copy metadata from Symphony into descMetadata
 object_client.refresh_metadata
 
-# Add constituents to an object (virtual-merge)
-object_client.add_constituents(child_druids:)
-
 # Send a notification to goobi
 object_client.notify_goobi
 

data/dor-services-client.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '>= 4.2', '< 7'
-  spec.add_dependency 'cocina-models', '~> 0.1.0'
+  spec.add_dependency 'cocina-models', '~> 0.4.0'
   spec.add_dependency 'faraday', '~> 0.15'
   spec.add_dependency 'moab-versioning', '~> 4.0'
   spec.add_dependency 'nokogiri', '~> 1.8'

data/lib/dor/services/client.rb

@@ -3,10 +3,10 @@
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/object/blank'
+require 'cocina/models'
 require 'faraday'
 require 'singleton'
 require 'zeitwerk'
-require 'cocina/models'
 
 class DorServicesClientInflector < Zeitwerk::Inflector
   def camelize(basename, _abspath)
@@ -29,6 +29,12 @@ loader.setup
 module Dor
   module Services
     class Client
+      include Singleton
+
+      DEFAULT_VERSION = 'v1'
+      TOKEN_HEADER = 'Authorization'
+
+      # Base class for Dor::Services::Client exceptions
       class Error < StandardError; end
 
       # Error that is raised when the remote server returns a 404 Not Found
@@ -41,12 +47,9 @@ module Dor
       # Error that is raised when the remote server returns some unparsable response
       class MalformedResponse < Error; end
 
+      # Error that wraps Faraday connection exceptions
       class ConnectionFailed < Error; end
 
-      DEFAULT_VERSION = 'v1'
-
-      include Singleton
-
       # @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
@@ -71,15 +74,17 @@ module Dor
         @virtual_objects ||= VirtualObjects.new(connection: connection, version: DEFAULT_VERSION)
       end
 
+      # @return [Dor::Services::Client::BackgroundJobResults] an instance of the `Client::BackgroundJobResults` class
+      def background_job_results
+        @background_job_results ||= BackgroundJobResults.new(connection: connection, version: DEFAULT_VERSION)
+      end
+
       class << self
-        # @param [String] url
-        # @param [String] token a bearer token for HTTP auth
-        # @param [String] token_header ('Authorization') set this to something if you are also using
-        #                              basic auth, or the headers will collide
-        def configure(url:, token: nil, token_header: 'Authorization')
+        # @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)
+        def configure(url:, token:)
           instance.url = url
           instance.token = token
-          instance.token_header = token_header
 
           # Force connection to be re-established when `.configure` is called
           instance.connection = nil
@@ -87,14 +92,14 @@ module Dor
           self
         end
 
-        delegate :objects, :object, :virtual_objects, to: :instance
+        delegate :objects, :object, :virtual_objects, :background_job_results, to: :instance
       end
 
-      attr_writer :url, :token, :token_header, :connection
+      attr_writer :url, :token, :connection
 
       private
 
-      attr_reader :token, :token_header
+      attr_reader :token
 
       def url
         @url || raise(Error, 'url has not yet been configured')
@@ -110,7 +115,7 @@ module Dor
           #       causes the adapter not to be set. Thus, everything breaks.
           builder.adapter Faraday.default_adapter
           builder.headers[:user_agent] = user_agent
-          builder.headers[token_header] = "Bearer #{token}" if token
+          builder.headers[TOKEN_HEADER] = "Bearer #{token}"
         end
       end
 

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Dor
+  module Services
+    class Client
+      # API calls around background job results from dor-services-app
+      class BackgroundJobResults < VersionedService
+        # Get status/result of a background job
+        # @param job_id [String] required string representing a job identifier
+        # @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 show(job_id:)
+          resp = connection.get do |req|
+            req.url "#{api_version}/background_job_results/#{job_id}"
+            req.headers['Accept'] = 'application/json'
+          end
+          # We expect this endpoint to semi-regularly return 422 responses, so do
+          # not bother raising the exception
+          return JSON.parse(resp.body).with_indifferent_access if resp.success? || resp.status == 422
+
+          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
+end

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

@@ -103,19 +103,6 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
-        # TODO: Remove once Argo is using `VirtualObjects#create` instead.
-        # Does a virtual-merge of the children into the parent
-        # @param [Array<String>] child_druids the identifier of the children
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [boolean] true on success
-        def add_constituents(child_druids:)
-          resp =  connection.put object_path, constituent_ids: child_druids
-          return true if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
         # Notify the external Goobi system for a new object that was registered in DOR
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '2.6.2'
+      VERSION = '3.0.0'
     end
   end
 end

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

@@ -9,7 +9,7 @@ module Dor
         # @param virtual_objects [Array] required array of virtual object params (see dor-services-app)
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] on an unsuccessful response from the server
-        # @return [NilClass] nil if no errors
+        # @return [String] URL from Location response header if no errors
         def create(virtual_objects:)
           resp = connection.post do |req|
             req.url "#{api_version}/virtual_objects"
@@ -17,7 +17,7 @@ module Dor
             req.headers['Accept'] = 'application/json'
             req.body = { virtual_objects: virtual_objects }.to_json
           end
-          return if resp.success?
+          return resp.headers['Location'] if resp.success?
 
           raise_exception_based_on_response!(resp)
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 2.6.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2019-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +206,7 @@ files:
 - bin/setup
 - dor-services-client.gemspec
 - lib/dor/services/client.rb
+- lib/dor/services/client/background_job_results.rb
 - lib/dor/services/client/collections.rb
 - lib/dor/services/client/embargo.rb
 - lib/dor/services/client/error_faraday_middleware.rb