client.rb in dor-services-client-3.0.0

- old
+ new

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 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)
     case basename
     when 'sdr'
@@ -27,10 +27,16 @@
 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
       class NotFoundResponse < Error; end
 
@@ -39,16 +45,13 @@
       class UnexpectedResponse < Error; end
 
       # 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
       def object(object_identifier)
         raise ArgumentError, '`object_identifier` argument cannot be `nil` in call to `#object(object_identifier)' if object_identifier.nil?
@@ -69,34 +72,36 @@
       # @return [Dor::Services::Client::VirtualObjects] an instance of the `Client::VirtualObjects` class
       def virtual_objects
         @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
 
           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')
       end
 
@@ -108,10 +113,10 @@
           # @note when token & token_header are nil, this line is required else
           #       the Faraday instance will be passed an empty block, which
           #       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
 
       def user_agent
         "dor-services-client #{Dor::Services::Client::VERSION}"