folio_client 0.19.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 548e644e584af5ba697c8c626c9dace7e06115106068e67ae8b4fbc49c1daa98
-  data.tar.gz: 5ae2b2251ffb4814ea8ed4bab229fc5d4349769b6a2b2ad271cbec10e8526da4
+  metadata.gz: d8c16843f867a9647afa4265ac90ce5d853e3e4ed4bd543dd209913302e8fd1e
+  data.tar.gz: e9e6f447bd7a23b75e2b38ccfbb641d26880ab9c6db815a13f47bae0a6ef6788
 SHA512:
-  metadata.gz: 6b8a03e8784b4e730d066960659a034fe3bc4d95ef4b81f792f29b5a353540aa1fae72970ee65f99a7859d8eeddfb3076ef5153fff51000ebabe296d4e2fb959
-  data.tar.gz: e6ad98a7fb6dd23c15400b9827f68059079fc845d2bfde25cd9bd518249ef5ce6c43edc440520d7aed36ab6dbf4c5e26ee133e56ca51a795922ec23a634a774a
+  metadata.gz: caa83ad6b9dd3d56312791ca3d5917b86895c456067b8eabacc41e27a283bb6db5dfde2fb7137eb9eb4bf599851e875bdaaf29f32f0157682c27759d1df23845
+  data.tar.gz: d5ce53af19a71d1c32d89d3cfe566e0eec8f103655c1514644e639c3ff0200316ea559d2ecc2685309e4a393bf0889b8e3953358e8aaea5748681aec213a4990

data/.rubocop.yml

@@ -6,7 +6,7 @@ plugins:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.4
   DisplayCopNames: true
   SuggestExtensions: false
   Exclude:
@@ -442,4 +442,52 @@ RSpec/IncludeExamples: # new in 3.6
 Capybara/FindAllFirst: # new in 2.22
   Enabled: true
 Capybara/NegationMatcherAfterVisit: # new in 2.22
-  Enabled: true
+  Enabled: true
+Gemspec/AttributeAssignment: # new in 1.77
+  Enabled: true
+Layout/EmptyLinesAfterModuleInclusion: # new in 1.79
+  Enabled: true
+Style/ArrayIntersectWithSingleElement: # new in 1.81
+  Enabled: true
+Style/CollectionQuerying: # new in 1.77
+  Enabled: true
+Style/EmptyClassDefinition: # new in 1.84
+  Enabled: true
+Style/ModuleMemberExistenceCheck: # new in 1.82
+  Enabled: true
+Style/NegativeArrayIndex: # new in 1.84
+  Enabled: true
+Style/ReverseFind: # new in 1.84
+  Enabled: true
+RSpecRails/HttpStatusNameConsistency: # new in 2.32
+  Enabled: true
+RSpec/LeakyLocalVariable: # new in 3.8
+  Enabled: true
+RSpec/Output: # new in 3.9
+  Enabled: true
+Lint/DataDefineOverride: # new in 1.85
+  Enabled: true
+Lint/UnreachablePatternBranch: # new in 1.85
+  Enabled: true
+Style/FileOpen: # new in 1.85
+  Enabled: true
+Style/MapJoin: # new in 1.85
+  Enabled: true
+Style/OneClassPerFile: # new in 1.85
+  Enabled: true
+Style/PartitionInsteadOfDoubleSelect: # new in 1.85
+  Enabled: true
+Style/PredicateWithKind: # new in 1.85
+  Enabled: true
+Style/ReduceToHash: # new in 1.85
+  Enabled: true
+Style/RedundantMinMaxBy: # new in 1.85
+  Enabled: true
+Style/RedundantStructKeywordInit: # new in 1.85
+  Enabled: true
+Style/SelectByKind: # new in 1.85
+  Enabled: true
+Style/SelectByRange: # new in 1.85
+  Enabled: true
+Style/TallyMethod: # new in 1.85
+  Enabled: true

data/Gemfile

@@ -5,4 +5,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in folio_client.gemspec
 gemspec
 
-gem 'byebug'
+gem 'debug'

data/Gemfile.lock

@@ -1,18 +1,20 @@
 PATH
   remote: .
   specs:
-    folio_client (0.19.0)
+    folio_client (0.21.0)
       activesupport (>= 4.2)
+      deprecation
       dry-monads
       faraday
       faraday-cookie_jar
       marc
+      ostruct
       zeitwerk
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.1.2)
+    activesupport (8.1.3)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
@@ -25,18 +27,22 @@ GEM
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
       uri (>= 0.13.1)
-    addressable (2.8.8)
+    addressable (2.9.0)
       public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.3)
     base64 (0.3.0)
-    bigdecimal (4.0.1)
-    byebug (13.0.0)
-      reline (>= 0.6.0)
+    bigdecimal (4.1.1)
     concurrent-ruby (1.3.6)
     connection_pool (3.0.2)
     crack (1.0.1)
       bigdecimal
       rexml
+    date (3.5.1)
+    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)
@@ -49,7 +55,8 @@ GEM
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.1)
       zeitwerk (~> 2.6)
-    faraday (2.14.0)
+    erb (6.0.2)
+    faraday (2.14.1)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
@@ -64,33 +71,48 @@ GEM
     i18n (1.14.8)
       concurrent-ruby (~> 1.0)
     io-console (0.8.2)
-    json (2.18.0)
+    irb (1.17.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    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
-    minitest (6.0.1)
+    minitest (6.0.3)
+      drb (~> 2.0)
       prism (~> 1.5)
     net-http (0.9.1)
       uri (>= 0.11.1)
-    nokogiri (1.19.0-arm64-darwin)
+    nokogiri (1.19.2-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.19.0-x86_64-darwin)
+    nokogiri (1.19.2-x86_64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.19.0-x86_64-linux-gnu)
-      racc (~> 1.4)
-    parallel (1.27.0)
-    parser (3.3.10.1)
+    ostruct (0.6.3)
+    parallel (1.28.0)
+    parser (3.3.11.1)
       ast (~> 2.4.1)
       racc
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
     prism (1.9.0)
-    public_suffix (7.0.2)
+    psych (5.3.1)
+      date
+      stringio
+    public_suffix (7.0.5)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.3.1)
-    regexp_parser (2.11.3)
+    rdoc (7.2.0)
+      erb
+      psych (>= 4.0.0)
+      tsort
+    regexp_parser (2.12.0)
     reline (0.6.3)
       io-console (~> 0.5)
     rexml (3.4.4)
@@ -103,11 +125,11 @@ GEM
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.7)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.84.0)
+    rubocop (1.86.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -118,7 +140,7 @@ GEM
       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)
@@ -146,29 +168,28 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
+    stringio (3.2.0)
+    tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.2.0)
       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)
-    zeitwerk (2.7.4)
+    zeitwerk (2.7.5)
 
 PLATFORMS
   arm64-darwin-23
   arm64-darwin-24
-  x86_64-darwin-19
-  x86_64-darwin-20
-  x86_64-darwin-21
-  x86_64-darwin-22
+  arm64-darwin-25
   x86_64-linux
 
 DEPENDENCIES
-  byebug
+  debug
   folio_client!
   rake (~> 13.0)
   rspec (~> 3.0)
@@ -182,4 +203,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-  4.0.5
+  4.0.9

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,
+    ...
 )
 ```
 
@@ -163,6 +164,86 @@ client.user_details(id: 'bbbadd51-c2f1-4107-a54d-52b39087725c')
 => {"username"=>"testing",
     "id"=>"bbbadd51-c2f1-4107-a54d-52b39087725c",
     "externalSystemId"=>"00324439", ... # same response as above, but for single user
+
+# Get location details by UUID (useful for checking campusId when creating holdings)
+# see https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/location.html#locations__id__get
+client.fetch_location(location_id: 'd9cd0bed-1b49-4b5e-a7bd-064b8d177231')
+=> {"id"=>"d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
+    "name"=>"Miller General Stacks",
+    "code"=>"UA/CB/LC/GS",
+    "isActive"=>true,
+    "description"=>"The very general stacks of Miller",
+    "discoveryDisplayName"=>"Miller General",
+    "institutionId"=>"4b2a3d97-01c3-4ef3-98a5-ae4e853429b4",
+    "campusId"=>"b595d838-b1d5-409e-86ac-af3b41bde0be",
+    "libraryId"=>"e2889f93-92f2-4937-b944-5452a575367e",
+    "details"=>{"a"=>"b", "foo"=>"bar"},
+    "primaryServicePoint"=>"79faacf1-4ba4-42c7-8b2a-566b259e4641",
+    "servicePointIds"=>["79faacf1-4ba4-42c7-8b2a-566b259e4641"]}
+
+# Get holdings records for an instance by HRID (useful for checking permanentLocationId and discoverySuppress)
+# see https://github.com/folio-org/mod-search#search-api
+client.fetch_holdings(hrid: 'in00000000067')
+=> [{"id"=>"7f89e96c-478c-4ca2-bb85-0a1c5b0c6f3e",
+     "instanceId"=>"5108040a-65bc-40ed-bd50-265958301ce4",
+     "permanentLocationId"=>"d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
+     "discoverySuppress"=>false,
+     "hrid"=>"ho00000000010",
+     "holdingsTypeId"=>"03c9c400-b9e3-4a07-ac0e-05ab470233ed",
+     "callNumber"=>"ABC 123"},
+    {"id"=>"8a89e96c-478c-4ca2-bb85-0a1c5b0c6f3f",
+     "instanceId"=>"5108040a-65bc-40ed-bd50-265958301ce4",
+     "permanentLocationId"=>"b595d838-b1d5-409e-86ac-af3b41bde0be",
+     "discoverySuppress"=>true,
+     "hrid"=>"ho00000000011",
+     "holdingsTypeId"=>"03c9c400-b9e3-4a07-ac0e-05ab470233ed",
+     "callNumber"=>"DEF 456"}]
+
+# Update a holdings record for an instance HRID
+holdings_record = 
+  { 'id' => '7f89e96c-478c-4ca2-bb85-0a1c5b0c6f3e',
+    '_version' => 1,
+    'sourceId' => 'f32d531e-df79-46b3-8932-cdd35f7a2264',
+    'hrid' => 'ah1994253_1',
+    'holdingsTypeId' => '5684e4a3-9279-4463-b6ee-20ae21bbec07',
+    'instanceId' => '54ec1f1a-d039-5a39-95f2-71df00061664',
+    'permanentLocationId' => '4573e824-9273-4f13-972f-cff7bf504217',
+    'effectiveLocationId' => '4573e824-9273-4f13-972f-cff7bf504217',
+    'discoverySuppress' => false }
+client.update_holdings(holdings_id: '7f89e96c-478c-4ca2-bb85-0a1c5b0c6f3e', holdings_record:)
+
+#Create a holdings record
+holdings_record =
+  { "instance_id" => "f1b301ce-f5d2-53b5-85eb-e4452bb5a591",
+    "permanent_location_id" => '1b14e21c-8d47-45c7-bc49-456a0086422b',
+    "source_id" => "f32d531e-df79-46b3-8932-cdd35f7a2264",
+    "holdings_type_id" => "996f93e2-5b5e-4cf2-9168-33ced1f95eed",
+    "discovery_suppress" => false }
+client.create_holdings(holdings_record:)
+=> {
+    "id" => "c65bb9dc-ebca-41fc-9c50-0d39085c1987",
+    "_version" => 1,
+    "sourceId" => "f32d531e-df79-46b3-8932-cdd35f7a2264",
+    "hrid" => "ho00000927052",
+    "holdingsTypeId" => "996f93e2-5b5e-4cf2-9168-33ced1f95eed",
+    "formerIds" => [],
+    "instanceId" => "54ec1f1a-d039-5a39-95f2-71df00061664",
+    "permanentLocationId" => "1b14e21c-8d47-45c7-bc49-456a0086422b",
+    "effectiveLocationId" => "1b14e21c-8d47-45c7-bc49-456a0086422b",
+    "electronicAccess" => [],
+    "administrativeNotes" => [],
+    "notes" => [],
+    "holdingsStatements" => [],
+    "holdingsStatementsForIndexes" => [],
+    "holdingsStatementsForSupplements" => [],
+    "discoverySuppress" => false,
+    "statisticalCodeIds" => [],
+    "metadata" =>
+    {"createdDate" => "2026-03-12T18:58:03.576+00:00",
+    "createdByUserId" => "709fdac6-d3f3-5784-8839-fe36ad6ed0b3",
+    "updatedDate" => "2026-03-12T18:58:03.576+00:00",
+    "updatedByUserId" => "709fdac6-d3f3-5784-8839-fe36ad6ed0b3"}
+    }
 ```
 
 ## Development

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

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary = 'Interface for interacting with the Folio ILS API.'
   spec.description = 'This provides API interaction with the Folio ILS API'
   spec.homepage = 'https://github.com/sul-dlss/folio_client'
-  spec.required_ruby_version = '>= 3.0.0'
+  spec.required_ruby_version = '>= 3.4'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/sul-dlss/folio_client'
@@ -32,10 +32,12 @@ 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'
   spec.add_dependency 'marc'
+  spec.add_dependency 'ostruct'
   spec.add_dependency 'zeitwerk'
 
   spec.add_development_dependency 'rake', '~> 13.0'

data/lib/folio_client/authenticator.rb

@@ -3,27 +3,26 @@
 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?
 
       access_cookie = FolioClient.cookie_jar.cookies.find { |cookie| cookie.name == 'folioAccessToken' }
 
-      raise StandardError, "Problem with folioAccessToken cookie: #{response.headers}, #{response.body}" unless access_cookie
+      # NOTE: The client typically delegates raising exceptions (based on HTTP
+      #       responses) to the UnexpectedResponse class, but this call in
+      #       Authenticator is a one-off, unlike any other in the app, so we
+      #       allow it to customize its exception handling.
+      raise UnauthorizedError, "Problem with folioAccessToken cookie: #{response.headers}, #{response.body}" unless access_cookie
 
       access_cookie.value
     end
-
-    private
-
-    def login_endpoint
-      '/authn/login-with-expiry'
-    end
   end
 end

data/lib/folio_client/inventory.rb

@@ -64,6 +64,54 @@ class FolioClient
       false
     end
 
+    # Get location details by UUID
+    # @param location_id [String] UUID of the location
+    # @return [Hash] location data including campusId and other location information
+    # @raise [ResourceNotFound] if location with the given UUID is not found
+    def fetch_location(location_id:)
+      client.get("/locations/#{location_id}")
+    end
+
+    # Get holdings records for an instance by HRID
+    # @see https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/inventory-view.html
+    # @param hrid [String] instance HRID
+    # @return [Array<Hash>] array of holdings records with permanentLocationId, _version, discoverySuppress, and other fields
+    def fetch_holdings(hrid:)
+      instance_uuid = fetch_external_id(hrid: hrid)
+      instance_response = client.get('/inventory-view/instances', { query: "id==#{instance_uuid}" })
+
+      instance_response.dig('instances', 0, 'holdingsRecords') || []
+    end
+
+    # Put an updated holdings record
+    # @see https://s3.amazonaws.com/foliodocs/api/mod-inventory/p/inventory.html#inventory_holdings__holdingsid__put
+    # @param holdings_id [String] UUID of the holdings record to update
+    # @param holdings_record [Hash] holdings record
+    # @raise [ResourceNotFound] if holdings record with the given UUID is not found
+    # @raise [BadRequestError] may occur if the update includes invalid fields or values
+    # @raise [UnexpectedResponse] if the API returns some other error response
+    def update_holdings(holdings_id:, holdings_record:)
+      client.put("/inventory/holdings/#{holdings_id}", holdings_record, exception_subject: "holdings record with ID #{holdings_id}")
+    end
+
+    # Post a new holdings record
+    # @param holdings_record [Hash] holdings record
+    # @return [Hash] the created holdings record, including its id and other fields
+    # @see https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/holdings-storage.html#holdings_storage_holdings_post
+    def create_holdings(holdings_record:)
+      required = %w[instance_id permanent_location_id source_id holdings_type_id]
+      missing = required.select { |field| !holdings_record.key?(field) || holdings_record[field].blank? }
+      raise ArgumentError, "Missing required fields: #{missing.join(', ')}" if missing.any?
+
+      client.post('/holdings-storage/holdings', {
+                    instanceId: holdings_record['instance_id'],
+                    permanentLocationId: holdings_record['permanent_location_id'],
+                    sourceId: holdings_record['source_id'],
+                    holdingsTypeId: holdings_record['holdings_type_id'],
+                    discoverySuppress: false
+                  })
+    end
+
     private
 
     def client

data/lib/folio_client/job_status.rb

@@ -98,6 +98,10 @@ class FolioClient
     def check_not_found(result, index, max_checks)
       return unless result.failure? && result.failure == :not_found && index > max_checks
 
+      # NOTE: The client typically delegates raising exceptions (based on HTTP
+      #       responses) to the UnexpectedResponse class, but the interaction in
+      #       JobStatus is more complex due to waits/loops, so we allow this
+      #       class to do some of its own exception handling.
       raise ResourceNotFound,
             "Job #{job_execution_id} not found after #{index} retries. The data import job may still have completed."
     end

data/lib/folio_client/source_storage.rb

@@ -21,7 +21,7 @@ class FolioClient
               "Expected 1 record for #{instance_hrid}, but found #{record_count}"
       end
 
-      response_hash['sourceRecords'].first['parsedRecord']['content']
+      response_hash.dig('sourceRecords', 0, 'parsedRecord', 'content')
     end
 
     # get marc bib data as MARCXML from folio given an instance HRID
@@ -30,9 +30,7 @@ class FolioClient
     # @return [String] MARCXML string
     # @raise [ResourceNotFound]
     # @raise [MultipleResourcesFound]
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/AbcSize
-    def fetch_marc_xml(instance_hrid: nil, barcode: nil)
+    def fetch_marc_xml(instance_hrid: nil, barcode: nil) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       if barcode.nil? && instance_hrid.nil?
         raise ArgumentError,
               'Either a barcode or a Folio instance HRID must be provided'
@@ -62,8 +60,6 @@ class FolioClient
       updated_marc.fields << MARC::ControlField.new('003', 'FOLIO')
       updated_marc.to_xml.to_s
     end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
 
     private
 

data/lib/folio_client/unexpected_response.rb

@@ -4,16 +4,18 @@ class FolioClient
   # Handles unexpected responses when communicating with Folio
   class UnexpectedResponse
     # @param [Faraday::Response] response
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/AbcSize
-    def self.call(response)
+    def self.call(response, **kwargs) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      subject = kwargs.fetch(:exception_subject, 'resource')
+
       case response.status
+      when 400
+        raise BadRequestError, "Bad request for #{subject}: #{response.body}"
       when 401
         raise UnauthorizedError, "There was a problem with the access token: #{response.body}"
       when 403
         raise ForbiddenError, "The operation requires privileges which the client does not have: #{response.body}"
       when 404
-        raise ResourceNotFound, "Endpoint not found or resource does not exist: #{response.body}"
+        raise ResourceNotFound, "Endpoint not found or #{subject} does not exist: #{response.body}"
       when 409
         raise ConflictError, "Resource cannot be updated: #{response.body}"
       when 422
@@ -21,10 +23,8 @@ class FolioClient
       when 500
         raise ServiceUnavailable, "The remote server returned an internal server error: #{response.body}"
       else
-        raise StandardError, "Unexpected response: #{response.status} #{response.body}"
+        raise Error, "Unexpected response: #{response.status} #{response.body}"
       end
     end
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
 end

data/lib/folio_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class FolioClient
-  VERSION = '0.19.0'
+  VERSION = '0.21.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'
@@ -41,47 +43,56 @@ class FolioClient
   # Error raised when the Folio API returns a 409 Conflict
   class ConflictError < Error; end
 
-  DEFAULT_HEADERS = {
-    accept: 'application/json, text/plain',
-    content_type: 'application/json'
-  }.freeze
+  # Error raised when the Folio API returns a 400 Bad Request
+  class BadRequestError < Error; end
 
   class << self
+    extend Deprecation
+
+    Config = Struct.new('Config', :url, :login_params, :timeout, :tenant_id, :user_agent) do
+      def headers
+        {
+          accept: 'application/json, text/plain',
+          content_type: 'application/json',
+          user_agent: user_agent,
+          'X-Okapi-Tenant': tenant_id
+        }
+      end
+    end
+
     # @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:)
+    # @param tenant_id [String] the ID of the Folio tenant
+    # @param user_agent [String] the user agent string to send in API requests
+    # @param timeout [Integer] the timeout in seconds for API requests
+    # @param unsupported_kwargs [Hash] any additional keyword arguments that are not explicitly supported.
+    #   This is to allow for backward compatibility with previous versions of the client that accepted
+    #   additional configuration options, such as `okapi_headers`, without raising an error. The values
+    #   of any recognized keys in this hash will be used to set the corresponding configuration options,
+    #   and a deprecation warning will be issued for any keys present in this hash.
     # @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',
+    def configure(url:, login_params:, tenant_id: nil, user_agent: default_user_agent, # rubocop:disable Metrics/ParameterLists
+                  timeout: default_timeout, **unsupported_kwargs)
+      Deprecation.warn(FolioClient, "Deprecated keywords: #{unsupported_kwargs.keys.sort.join(', ')}") if unsupported_kwargs.any?
+
+      instance.config = Config.new(
         url: url,
         login_params: login_params,
-        okapi_headers: okapi_headers,
-        timeout: timeout
+        timeout: timeout,
+        tenant_id: tenant_id.presence || unsupported_kwargs.dig(:okapi_headers, :'X-Okapi-Tenant'),
+        user_agent: user_agent.presence || unsupported_kwargs.dig(:okapi_headers, :'User-Agent')
       )
-      # rubocop:enable Style/OpenStructUse
 
       self
     end
 
-    delegate :config, :connection, :cookie_jar, :data_import, :default_timeout,
-             :edit_marc_json, :fetch_external_id, :fetch_hrid,
-             :fetch_instance_info, :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, :users,
-             :user_details, :post, :put, to: :instance
+    delegate :config, :connection, :cookie_jar, :create_holdings, :data_import, :default_timeout,
+             :default_user_agent, :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
   end
 
   attr_accessor :config
@@ -89,69 +100,54 @@ class FolioClient
   # 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
   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?
 
-    return nil if response.body.blank?
-
-    JSON.parse(response.body)
+    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
-  # rubocop:disable Metrics/MethodLength
+  # @return [Hash, nil] the parsed response body or nil
   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?
 
-    return nil if response.body.blank?
-
-    JSON.parse(response.body)
+    JSON.parse(response.body) if response.body.present?
   end
-  # rubocop:enable Metrics/MethodLength
 
   # 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
-  # rubocop:disable Metrics/MethodLength
-  def put(path, body = nil, content_type: 'application/json')
+  # @return [Hash, nil] the parsed response body or nil
+  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) unless response.success?
-
-    return nil if response.body.blank?
+    UnexpectedResponse.call(response, **exception_args) unless response.success?
 
-    JSON.parse(response.body)
+    JSON.parse(response.body) if response.body.present?
   end
-  # rubocop:enable Metrics/MethodLength
 
   # the base connection to the Folio API
   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
@@ -186,6 +182,34 @@ class FolioClient
       .fetch_instance_info(...)
   end
 
+  # @see Inventory#fetch_location
+  def fetch_location(...)
+    Inventory
+      .new
+      .fetch_location(...)
+  end
+
+  # @see Inventory#fetch_holdings
+  def fetch_holdings(...)
+    Inventory
+      .new
+      .fetch_holdings(...)
+  end
+
+  # @see Inventory#update_holdings
+  def update_holdings(...)
+    Inventory
+      .new
+      .update_holdings(...)
+  end
+
+  # @see Inventory#create_holdings
+  def create_holdings(...)
+    Inventory
+      .new
+      .create_holdings(...)
+  end
+
   # @see SourceStorage#fetch_marc_hash
   def fetch_marc_hash(...)
     SourceStorage
@@ -264,11 +288,15 @@ class FolioClient
   end
 
   def default_timeout
-    120
+    180
+  end
+
+  def default_user_agent
+    "folio_client #{FolioClient::VERSION}"
   end
 
   def force_token_refresh!
-    config.token = Authenticator.token
+    Authenticator.refresh_token!
   end
 
   private

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: folio_client
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Peter Mangiafico
 bindir: exe
 cert_chain: []
-date: 2026-02-06 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
@@ -79,6 +93,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  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: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -274,14 +302,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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: []