folio_client 0.20.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef1f093f7eb2cfcd38d85fc547d702a9768235b9a4e24f061653225e207978a9
-  data.tar.gz: ffe4c65db99fda6d3cece47f00bb84d490794382342ec2b4be6d4d2ff97a4f1e
+  metadata.gz: c7ff536f92f06403a2d47dd9ede2dab90d0f20d8b6ad52f9c2bd047dd7eb0650
+  data.tar.gz: 3ba0ff3343cbf79bfb383254d18f8cad2bd0c74b0251e4c76bf69b26d6d75ed4
 SHA512:
-  metadata.gz: 514d18193471517981408f5e1193cc13efa0640e3ad3176030aee72629a3b27b0f6ef9b5f9b36ca5197a9280180276d609a7ca0abddd56d5e9885bc6215f81dd
-  data.tar.gz: 885859bc1542aa0ceb2d7cf6c939851e2f9774db332f39c2d66b90773d8a6fea6278cf4267a969ece4e492e277deb51ca94337bf02d4395fb00c5a8da3692aa9
+  metadata.gz: 6e5e9f3c4b84168f41b6afaacffebcaba29bc732ea338a3834a01621dec956e568d5863789da54b4df297bda2915e9119164c0fbf3e4de1c703fc5317df0c4fb
+  data.tar.gz: c9bde04bd107cb50213b2beb8019251dd1cf2452ce842f926420576202df65ee3d54ea1a665afb441ff5d47a367fab8230de0612d88767b73bc9454a35cd9218

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    folio_client (0.20.0)
+    folio_client (1.0.0)
       activesupport (>= 4.2)
+      deprecation
       dry-monads
       faraday
       faraday-cookie_jar
@@ -13,7 +14,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.1.2)
+    activesupport (8.1.3)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
@@ -26,11 +27,11 @@ GEM
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
       uri (>= 0.13.1)
-    addressable (2.8.9)
+    addressable (2.9.0)
       public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.3)
     base64 (0.3.0)
-    bigdecimal (4.0.1)
+    bigdecimal (4.1.1)
     concurrent-ruby (1.3.6)
     connection_pool (3.0.2)
     crack (1.0.1)
@@ -40,6 +41,8 @@ GEM
     debug (1.11.1)
       irb (~> 1.10)
       reline (>= 0.3.8)
+    deprecation (1.1.0)
+      activesupport
     diff-lcs (1.6.2)
     docile (1.4.1)
     domain_name (0.6.20240107)
@@ -63,7 +66,7 @@ GEM
     faraday-net_http (3.4.2)
       net-http (~> 0.5)
     hashdiff (1.2.1)
-    http-cookie (1.1.0)
+    http-cookie (1.1.4)
       domain_name (~> 0.5)
     i18n (1.14.8)
       concurrent-ruby (~> 1.0)
@@ -73,30 +76,25 @@ GEM
       prism (>= 1.3.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.19.1)
-    json-schema (6.2.0)
-      addressable (~> 2.8)
-      bigdecimal (>= 3.1, < 5)
+    json (2.19.3)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
     marc (1.4.0)
       nokogiri (~> 1.0)
       rexml
-    mcp (0.8.0)
-      json-schema (>= 4.1)
-    minitest (6.0.2)
+    minitest (6.0.3)
       drb (~> 2.0)
       prism (~> 1.5)
     net-http (0.9.1)
       uri (>= 0.11.1)
-    nokogiri (1.19.1-arm64-darwin)
+    nokogiri (1.19.2-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.19.1-x86_64-linux-gnu)
+    nokogiri (1.19.2-x86_64-linux-gnu)
       racc (~> 1.4)
     ostruct (0.6.3)
-    parallel (1.27.0)
-    parser (3.3.10.2)
+    parallel (2.0.1)
+    parser (3.3.11.1)
       ast (~> 2.4.1)
       racc
     pp (0.6.3)
@@ -114,7 +112,7 @@ GEM
       erb
       psych (>= 4.0.0)
       tsort
-    regexp_parser (2.11.3)
+    regexp_parser (2.12.0)
     reline (0.6.3)
       io-console (~> 0.5)
     rexml (3.4.4)
@@ -131,19 +129,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.85.1)
+    rubocop (1.86.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
-      mcp (~> 0.6)
-      parallel (~> 1.10)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
       rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.49.0)
+    rubocop-ast (1.49.1)
       parser (>= 3.3.7.2)
       prism (~> 1.7)
     rubocop-capybara (2.22.1)
@@ -179,7 +176,7 @@ GEM
       unicode-emoji (~> 4.1)
     unicode-emoji (4.2.0)
     uri (1.1.1)
-    webmock (3.26.1)
+    webmock (3.26.2)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -206,4 +203,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-  4.0.7
+  4.0.10

data/README.md

@@ -25,9 +25,10 @@ require 'folio_client'
 
 # this will configure the client and request an access token
 client = FolioClient.configure(
-           url: 'https://okapi-dev.stanford.edu',
+           url: 'https://folio-dev.stanford.edu',
            login_params: { username: 'xxx', password: 'yyy' },
-           okapi_headers: { 'X-Okapi-Tenant': 'sul', 'User-Agent': 'FolioApiClient' }
+           tenant_id: 'sul',
+           user_agent: 'FolioApiClient'
          )
 
 response = client.get('/organizations/organizations', {query_string_param: 'abcdef'})
@@ -43,7 +44,7 @@ require 'folio_client'
 client = FolioClient.configure(
     url: Settings.okapi.url,
     login_params: Settings.okapi.login_params,
-    okapi_headers: Settings.okapi.headers,
+    ...
 )
 ```
 

data/api_test.rb

@@ -13,10 +13,8 @@ client =
       username: ENV.fetch('OKAPI_USER', nil),
       password: ENV.fetch('OKAPI_PASSWORD', nil)
     },
-    okapi_headers: {
-      'X-Okapi-Tenant': ENV.fetch('OKAPI_TENANT', nil),
-      'User-Agent': 'folio_client gem (testing)'
-    }
+    tenant_id: ENV.fetch('OKAPI_TENANT', nil),
+    user_agent: 'folio_client gem (testing)'
   )
 
 pp(client.fetch_marc_hash(instance_hrid: 'a666'))

data/folio_client.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '>= 4.2'
+  spec.add_dependency 'deprecation', '>= 0'
   spec.add_dependency 'dry-monads'
   spec.add_dependency 'faraday'
   spec.add_dependency 'faraday-cookie_jar'

data/lib/folio_client/authenticator.rb

@@ -3,13 +3,14 @@
 class FolioClient
   # Fetch a token from the Folio API using login_params
   class Authenticator
-    def self.token
-      new.token
-    end
+    LOGIN_ENDPOINT = '/authn/login-with-expiry'
 
     # Request an access_token
-    def token
-      response = FolioClient.connection.post(login_endpoint, FolioClient.config.login_params.to_json)
+    #
+    # @raise [UnauthorizedError] if the response is not successful or if the
+    # @return [String] the access token
+    def self.refresh_token!
+      response = FolioClient.connection.post(LOGIN_ENDPOINT, FolioClient.config.login_params.to_json)
 
       UnexpectedResponse.call(response) unless response.success?
 
@@ -23,11 +24,5 @@ class FolioClient
 
       access_cookie.value
     end
-
-    private
-
-    def login_endpoint
-      '/authn/login-with-expiry'
-    end
   end
 end

data/lib/folio_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class FolioClient
-  VERSION = '0.20.0'
+  VERSION = '1.0.0'
 end

data/lib/folio_client.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require 'http/cookie' # Workaround for https://github.com/sparklemotion/http-cookie/issues/62
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/object/blank'
+require 'deprecation'
 require 'faraday'
 require 'faraday-cookie_jar'
 require 'marc'
@@ -9,93 +11,102 @@ require 'ostruct'
 require 'singleton'
 require 'zeitwerk'
 
-# Load the gem's internal dependencies: use Zeitwerk instead of needing to manually require classes
+# Autoload gem internals.
 Zeitwerk::Loader.for_gem.setup
 
-# Client for interacting with the Folio API
-# rubocop:disable Metrics/ClassLength
-class FolioClient
+# Client for interacting with the Folio API.
+class FolioClient # rubocop:disable Metrics/ClassLength
   include Singleton
 
-  # Base class for all FolioClient errors
+  # Base class for all FolioClient errors.
   class Error < StandardError; end
 
-  # Error raised by the Folio Auth API returns a 401 Unauthorized
+  # Raised when the Folio Auth API returns 401 Unauthorized.
   class UnauthorizedError < Error; end
 
-  # Error raised when the Folio API returns a 404 NotFound, or returns 0 results when one was expected
+  # Raised when the Folio API returns 404 Not Found, or when 0 results are
+  # returned where one was expected.
   class ResourceNotFound < Error; end
 
-  # Error raised when e.g. exactly one result was expected, but more than one was returned
+  # Raised when exactly one resource was expected but multiple were returned.
   class MultipleResourcesFound < Error; end
 
-  # Error raised when the Folio API returns a 403 Forbidden
+  # Raised when the Folio API returns 403 Forbidden.
   class ForbiddenError < Error; end
 
-  # Error raised when the Folio API returns a 500
+  # Raised when the Folio API returns 500-level availability errors.
   class ServiceUnavailable < Error; end
 
-  # Error raised when the Folio API returns a 422 Unprocessable Entity
+  # Raised when the Folio API returns 422 Unprocessable Entity.
   class ValidationError < Error; end
 
-  # Error raised when the Folio API returns a 409 Conflict
+  # Raised when the Folio API returns 409 Conflict.
   class ConflictError < Error; end
 
-  # Error raised when the Folio API returns a 400 Bad Request
+  # Raised when the Folio API returns 400 Bad Request.
   class BadRequestError < Error; end
 
-  DEFAULT_HEADERS = {
-    accept: 'application/json, text/plain',
-    content_type: 'application/json'
-  }.freeze
-
   class << self
-    # @param url [String] the folio API URL
-    # @param login_params [Hash] the folio client login params (username:, password:)
-    # @param okapi_headers [Hash] the okapi specific headers to add (X-Okapi-Tenant:, User-Agent:)
-    # @return [FolioClient] the configured Singleton class
-    def configure(url:, login_params:, okapi_headers:, timeout: default_timeout, **)
-      # rubocop:disable Style/OpenStructUse
-      instance.config = OpenStruct.new(
-        # For the initial token, use a dummy value to avoid hitting any APIs
-        # during configuration, allowing `with_token_refresh_when_unauthorized` to handle
-        # auto-magic token refreshing. Why not immediately get a valid token? Our apps
-        # commonly invoke client `.configure` methods in the initializer in all
-        # application environments, even those that are never expected to
-        # connect to production APIs, such as local development machines.
-        #
-        # NOTE: `nil` and blank string cannot be used as dummy values here as
-        # they lead to a malformed request to be sent, which triggers an
-        # exception not rescued by `with_token_refresh_when_unauthorized`
-        token: 'a temporary dummy token to avoid hitting the API before it is needed',
+    extend Deprecation
+
+    Config = Struct.new('Config', :url, :login_params, :timeout, :tenant_id, :user_agent) do
+      # Build default headers for Folio-bound requests.
+      # @return [Hash<Symbol,String>] default request headers
+      def headers
+        {
+          accept: 'application/json, text/plain',
+          content_type: 'application/json',
+          user_agent: user_agent,
+          'X-Okapi-Tenant': tenant_id
+        }
+      end
+    end
+
+    # Configure the singleton FolioClient instance.
+    # @example
+    #   FolioClient.configure(
+    #     url: 'https://folio.example.edu',
+    #     login_params: { username: 'svc-user', password: 'secret' },
+    #     tenant_id: 'sul'
+    #   )
+    # @param url [String] Folio API base URL
+    # @param login_params [Hash] authentication payload (e.g., +username+, +password+)
+    # @param tenant_id [String, nil] Folio tenant identifier
+    # @param user_agent [String, nil] user agent string included on outbound requests
+    # @param timeout [Integer] request timeout, in seconds
+    # @return [Class<FolioClient>] the configured singleton class for chaining
+    def configure(url:, login_params:, tenant_id: nil, user_agent: nil, timeout: nil)
+      instance.config = Config.new(
         url: url,
         login_params: login_params,
-        okapi_headers: okapi_headers,
-        timeout: timeout
+        tenant_id: tenant_id,
+        timeout: timeout || default_timeout,
+        user_agent: user_agent || default_user_agent
       )
-      # rubocop:enable Style/OpenStructUse
 
       self
     end
 
-    delegate :config, :connection, :cookie_jar, :create_holdings, :data_import, :default_timeout,
-             :edit_marc_json, :fetch_external_id, :fetch_holdings, :fetch_hrid,
-             :fetch_instance_info, :fetch_location, :fetch_marc_hash, :fetch_marc_xml,
-             :force_token_refresh!, :get, :has_instance_status?,
-             :http_get_headers, :http_post_and_put_headers, :interface_details,
-             :job_profiles, :organization_interfaces, :organizations, :update_holdings, :users,
-             :user_details, :post, :put, to: :instance
+    # The client is intended to be used as a singleton via {.configure}, but the
+    # instance methods are also available on the class itself for convenience.
+    # Instead of maintaining a giant list of delegations to the singleton
+    # instance, we can just delegate everything. This makes the client easier to
+    # extend with additional instance methods without needing to update the
+    # delegation list.
+    delegate_missing_to :instance
   end
 
+  # @return [FolioClient::Config, nil] active runtime configuration
   attr_accessor :config
 
-  # Send an authenticated get request
-  # @param path [String] the path to the Folio API request
-  # @param params [Hash] params to get to the API
-  # @return [Hash, nil] the parsed response body or nil
+  # Send an authenticated GET request.
+  # @param path [String] API path relative to configured +url+
+  # @param params [Hash] query parameters
+  # @return [Hash, Array, nil] parsed JSON body, or +nil+ for empty body
+  # @raise [FolioClient::Error] when Folio responds with an unexpected status
   def get(path, params = {})
     response = with_token_refresh_when_unauthorized do
-      connection.get(path, params, { 'x-okapi-token': config.token })
+      connection.get(path, params)
     end
 
     UnexpectedResponse.call(response) unless response.success?
@@ -103,19 +114,18 @@ class FolioClient
     JSON.parse(response.body) if response.body.present?
   end
 
-  # Send an authenticated post request
-  # If the body is JSON, it will be automatically serialized
-  # @param path [String] the path to the Folio API request
-  # @param body [Object] body to post to the API as JSON
-  # @return [Hash, nil] the parsed response body or nil
+  # Send an authenticated POST request.
+  # If +content_type+ is +application/json+, +body+ is serialized with +to_json+.
+  # Otherwise +body+ is sent unchanged.
+  # @param path [String] API path relative to configured +url+
+  # @param body [Hash, String, nil] request payload
+  # @param content_type [String] MIME type of request body
+  # @return [Hash, Array, nil] parsed JSON body, or +nil+ for empty body
+  # @raise [FolioClient::Error] when Folio responds with an unexpected status
   def post(path, body = nil, content_type: 'application/json')
     req_body = content_type == 'application/json' ? body&.to_json : body
     response = with_token_refresh_when_unauthorized do
-      req_headers = {
-        'x-okapi-token': config.token,
-        'content-type': content_type
-      }
-      connection.post(path, req_body, req_headers)
+      connection.post(path, req_body, { content_type: content_type })
     end
 
     UnexpectedResponse.call(response) unless response.success?
@@ -123,19 +133,19 @@ class FolioClient
     JSON.parse(response.body) if response.body.present?
   end
 
-  # Send an authenticated put request
-  # If the body is JSON, it will be automatically serialized
-  # @param path [String] the path to the Folio API request
-  # @param body [Object] body to put to the API as JSON
-  # @return [Hash, nil] the parsed response body or nil
+  # Send an authenticated PUT request.
+  # If +content_type+ is +application/json+, +body+ is serialized with +to_json+.
+  # Otherwise +body+ is sent unchanged.
+  # @param path [String] API path relative to configured +url+
+  # @param body [Hash, String, nil] request payload
+  # @param content_type [String] MIME type of request body
+  # @param exception_args [Hash] supplemental context forwarded to +UnexpectedResponse+
+  # @return [Hash, Array, nil] parsed JSON body, or +nil+ for empty body
+  # @raise [FolioClient::Error] when Folio responds with an unexpected status
   def put(path, body = nil, content_type: 'application/json', **exception_args)
     req_body = content_type == 'application/json' ? body&.to_json : body
     response = with_token_refresh_when_unauthorized do
-      req_headers = {
-        'x-okapi-token': config.token,
-        'content-type': content_type
-      }
-      connection.put(path, req_body, req_headers)
+      connection.put(path, req_body, { content_type: content_type })
     end
 
     UnexpectedResponse.call(response, **exception_args) unless response.success?
@@ -143,11 +153,12 @@ class FolioClient
     JSON.parse(response.body) if response.body.present?
   end
 
-  # the base connection to the Folio API
+  # Build (or memoize) the base Faraday connection.
+  # @return [Faraday::Connection] configured HTTP connection
   def connection
     @connection ||= Faraday.new(
       url: config.url,
-      headers: DEFAULT_HEADERS.merge(config.okapi_headers || {}),
+      headers: config.headers,
       request: { timeout: config.timeout }
     ) do |faraday|
       faraday.use :cookie_jar, jar: cookie_jar
@@ -155,170 +166,215 @@ class FolioClient
     end
   end
 
+  # Build (or memoize) the cookie jar used by Faraday to store authentication cookies.
+  # @return [HTTP::CookieJar] cookie storage for session-aware requests
   def cookie_jar
     @cookie_jar ||= HTTP::CookieJar.new
   end
 
-  # Public methods available on the FolioClient below
-
+  # Fetch a Folio HRID by instance identifier or query context.
   # @see Inventory#fetch_hrid
+  # @return [Object] delegated return value from +Inventory#fetch_hrid+
   def fetch_hrid(...)
-    Inventory
-      .new
-      .fetch_hrid(...)
+    inventory.fetch_hrid(...)
   end
 
+  # Fetch the Folio external id for a matching record.
   # @see Inventory#fetch_external_id
+  # @return [Object] delegated return value from +Inventory#fetch_external_id+
   def fetch_external_id(...)
-    Inventory
-      .new
-      .fetch_external_id(...)
+    inventory.fetch_external_id(...)
   end
 
+  # Fetch inventory instance details.
   # @see Inventory#fetch_instance_info
+  # @return [Object] delegated return value from +Inventory#fetch_instance_info+
   def fetch_instance_info(...)
-    Inventory
-      .new
-      .fetch_instance_info(...)
+    inventory.fetch_instance_info(...)
   end
 
+  # Fetch location details from inventory.
   # @see Inventory#fetch_location
+  # @return [Object] delegated return value from +Inventory#fetch_location+
   def fetch_location(...)
-    Inventory
-      .new
-      .fetch_location(...)
+    inventory.fetch_location(...)
   end
 
+  # Fetch holdings associated with a record.
   # @see Inventory#fetch_holdings
+  # @return [Object] delegated return value from +Inventory#fetch_holdings+
   def fetch_holdings(...)
-    Inventory
-      .new
-      .fetch_holdings(...)
+    inventory.fetch_holdings(...)
   end
 
+  # Update an existing holdings record.
   # @see Inventory#update_holdings
+  # @return [Object] delegated return value from +Inventory#update_holdings+
   def update_holdings(...)
-    Inventory
-      .new
-      .update_holdings(...)
+    inventory.update_holdings(...)
   end
 
+  # Create a new holdings record.
   # @see Inventory#create_holdings
+  # @return [Object] delegated return value from +Inventory#create_holdings+
   def create_holdings(...)
-    Inventory
-      .new
-      .create_holdings(...)
+    inventory.create_holdings(...)
   end
 
+  # Fetch MARC data as a Ruby hash.
   # @see SourceStorage#fetch_marc_hash
+  # @return [Object] delegated return value from +SourceStorage#fetch_marc_hash+
   def fetch_marc_hash(...)
-    SourceStorage
-      .new
-      .fetch_marc_hash(...)
+    source_storage.fetch_marc_hash(...)
   end
 
+  # Fetch MARC data as XML.
   # @see SourceStorage#fetch_marc_xml
+  # @return [Object] delegated return value from +SourceStorage#fetch_marc_xml+
   def fetch_marc_xml(...)
-    SourceStorage
-      .new
-      .fetch_marc_xml(...)
+    source_storage.fetch_marc_xml(...)
   end
 
+  # Determine whether an instance has the requested status.
   # @see Inventory#has_instance_status?
+  # @return [Boolean] delegated predicate result
   def has_instance_status?(...) # rubocop:disable Naming/PredicatePrefix
-    Inventory
-      .new
-      .has_instance_status?(...)
+    inventory.has_instance_status?(...)
   end
 
-  # @ see DataImport#import
+  # Run an inventory data import workflow.
+  # @see DataImport#import
+  # @return [Object] delegated return value from +DataImport#import+
   def data_import(...)
-    DataImport
-      .new
-      .import(...)
+    data_import_service.import(...)
   end
 
-  # @ see DataImport#job_profiles
+  # List available data-import job profiles.
+  # @see DataImport#job_profiles
+  # @return [Object] delegated return value from +DataImport#job_profiles+
   def job_profiles(...)
-    DataImport
-      .new
-      .job_profiles(...)
+    data_import_service.job_profiles(...)
   end
 
+  # Edit MARC-in-JSON records.
   # @see RecordsEditor#edit_marc_json
+  # @return [Object] delegated return value from +RecordsEditor#edit_marc_json+
   def edit_marc_json(...)
-    RecordsEditor
-      .new
-      .edit_marc_json(...)
+    records_editor.edit_marc_json(...)
   end
 
+  # List organizations.
   # @see Organizations#fetch_list
+  # @return [Object] delegated return value from +Organizations#fetch_list+
   def organizations(...)
-    Organizations
-      .new
-      .fetch_list(...)
+    organizations_service.fetch_list(...)
   end
 
+  # List interfaces for organizations.
   # @see Organizations#fetch_interface_list
+  # @return [Object] delegated return value from +Organizations#fetch_interface_list+
   def organization_interfaces(...)
-    Organizations
-      .new
-      .fetch_interface_list(...)
+    organizations_service.fetch_interface_list(...)
   end
 
+  # Fetch detailed interface information for an organization interface.
   # @see Organizations#fetch_interface_details
+  # @return [Object] delegated return value from +Organizations#fetch_interface_details+
   def interface_details(...)
-    Organizations
-      .new
-      .fetch_interface_details(...)
+    organizations_service.fetch_interface_details(...)
   end
 
+  # List users.
   # @see Users#fetch_list
+  # @return [Object] delegated return value from +Users#fetch_list+
   def users(...)
-    Users
-      .new
-      .fetch_list(...)
+    users_service.fetch_list(...)
   end
 
+  # Fetch details for a user.
   # @see Users#fetch_user_details
+  # @return [Object] delegated return value from +Users#fetch_user_details+
   def user_details(...)
-    Users
-      .new
-      .fetch_user_details(...)
+    users_service.fetch_user_details(...)
   end
 
+  # Force a refresh of the current auth token.
+  #
+  # @return [Object] return value from +Authenticator.refresh_token!+
+  def force_token_refresh!
+    Authenticator.refresh_token!
+  end
+
+  # Default HTTP timeout in seconds.
+  #
+  # @return [Integer]
   def default_timeout
-    120
+    180
   end
 
-  def force_token_refresh!
-    config.token = Authenticator.token
+  # Default user-agent string used for outbound requests.
+  #
+  # @return [String]
+  def default_user_agent
+    "folio_client #{VERSION}"
   end
 
   private
 
-  # Wraps API operations to request new access token if expired.
-  # @yieldreturn response [Faraday::Response] the response to inspect
-  #
-  # @note You likely want to make sure you're wrapping a _single_ HTTP request in this
-  # method, because 1) all calls in the block will be retried from the top if there's
-  # an authN failure detected, and 2) only the response returned by the block will be
-  # inspected for authN failure.
-  # Related: consider that the client instance and its token will live across many
-  # invocations of the FolioClient methods once the client is configured by a consuming application,
-  # since this class is a Singleton.  Thus, a token may expire between any two calls (i.e. it
-  # isn't necessary for a set of operations to collectively take longer than the token lifetime for
-  # expiry to fall in the middle of that related set of HTTP calls).
+  STATUSES_REQUIRING_TOKEN_REFRESH = [401, 403].freeze
+  private_constant :STATUSES_REQUIRING_TOKEN_REFRESH
+
+  # Wrap API operations to refresh and retry when auth has expired.
+  # @yieldreturn [Faraday::Response] response from a single HTTP request
+  # @return [Faraday::Response] original or retried response
+  # @note Wrap one HTTP call per block. If auth fails, the entire block is retried.
+  #   Only the final response yielded by the block is inspected for auth failure.
+  # @note Because this class is a Singleton, its token can outlive many client calls.
+  #   Expiration can occur between any two invocations, even when those calls are
+  #   logically related from the caller's perspective.
   def with_token_refresh_when_unauthorized
     response = yield
 
-    # if unauthorized, token has likely expired. try to get a new token and then retry the same request(s).
-    if [401, 403].include?(response.status)
-      force_token_refresh!
-      response = yield
-    end
+    return response unless STATUSES_REQUIRING_TOKEN_REFRESH.include?(response.status)
+
+    force_token_refresh!
+
+    yield
+  end
+
+  # Build an inventory service object.
+  # @return [Inventory]
+  def inventory
+    Inventory.new
+  end
+
+  # Build a source-storage service object.
+  # @return [SourceStorage]
+  def source_storage
+    SourceStorage.new
+  end
+
+  # Build a data-import service object.
+  # @return [DataImport]
+  def data_import_service
+    DataImport.new
+  end
+
+  # Build a records-editor service object.
+  # @return [RecordsEditor]
+  def records_editor
+    RecordsEditor.new
+  end
+
+  # Build an organizations service object.
+  # @return [Organizations]
+  def organizations_service
+    Organizations.new
+  end
 
-    response
+  # Build a users service object.
+  # @return [Users]
+  def users_service
+    Users.new
   end
 end
-# rubocop:enable Metrics/ClassLength

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: folio_client
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Peter Mangiafico
 bindir: exe
 cert_chain: []
-date: 2026-03-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: deprecation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement
@@ -295,7 +309,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.8
 specification_version: 4
 summary: Interface for interacting with the Folio ILS API.
 test_files: []