folio_client 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef1f093f7eb2cfcd38d85fc547d702a9768235b9a4e24f061653225e207978a9
-  data.tar.gz: ffe4c65db99fda6d3cece47f00bb84d490794382342ec2b4be6d4d2ff97a4f1e
+  metadata.gz: d8c16843f867a9647afa4265ac90ce5d853e3e4ed4bd543dd209913302e8fd1e
+  data.tar.gz: e9e6f447bd7a23b75e2b38ccfbb641d26880ab9c6db815a13f47bae0a6ef6788
 SHA512:
-  metadata.gz: 514d18193471517981408f5e1193cc13efa0640e3ad3176030aee72629a3b27b0f6ef9b5f9b36ca5197a9280180276d609a7ca0abddd56d5e9885bc6215f81dd
-  data.tar.gz: 885859bc1542aa0ceb2d7cf6c939851e2f9774db332f39c2d66b90773d8a6fea6278cf4267a969ece4e492e277deb51ca94337bf02d4395fb00c5a8da3692aa9
+  metadata.gz: caa83ad6b9dd3d56312791ca3d5917b86895c456067b8eabacc41e27a283bb6db5dfde2fb7137eb9eb4bf599851e875bdaaf29f32f0157682c27759d1df23845
+  data.tar.gz: d5ce53af19a71d1c32d89d3cfe566e0eec8f103655c1514644e639c3ff0200316ea559d2ecc2685309e4a393bf0889b8e3953358e8aaea5748681aec213a4990

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    folio_client (0.20.0)
+    folio_client (0.21.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)
@@ -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 (1.28.0)
+    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,11 +129,10 @@ 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.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
-      mcp (~> 0.6)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
@@ -143,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)
@@ -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.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,
+    ...
 )
 ```
 

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 = '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'
@@ -44,47 +46,53 @@ class FolioClient
   # Error raised when the Folio API returns a 400 Bad Request
   class BadRequestError < Error; end
 
-  DEFAULT_HEADERS = {
-    accept: 'application/json, text/plain',
-    content_type: 'application/json'
-  }.freeze
-
   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, :create_holdings, :data_import, :default_timeout,
-             :edit_marc_json, :fetch_external_id, :fetch_holdings, :fetch_hrid,
+             :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
+             :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
@@ -95,7 +103,7 @@ class FolioClient
   # @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?
@@ -111,11 +119,7 @@ class FolioClient
   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?
@@ -131,11 +135,7 @@ class FolioClient
   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?
@@ -147,7 +147,7 @@ class FolioClient
   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
@@ -288,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.20.0
+  version: 0.21.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: []