folio_client 0.14.0 → 0.16.0

data/lib/folio_client.rb

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/module/delegation"
-require "active_support/core_ext/object/blank"
-require "faraday"
-require "marc"
-require "ostruct"
-require "singleton"
-require "zeitwerk"
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/object/blank'
+require 'faraday'
+require 'faraday-cookie_jar'
+require 'marc'
+require 'ostruct'
+require 'singleton'
+require 'zeitwerk'
 
 # Load the gem's internal dependencies: use Zeitwerk instead of needing to manually require classes
 Zeitwerk::Loader.for_gem.setup
 
 # Client for interacting with the Folio API
+# rubocop:disable Metrics/ClassLength
 class FolioClient
   include Singleton
 
@@ -40,16 +42,18 @@ class FolioClient
   class ConflictError < Error; end
 
   DEFAULT_HEADERS = {
-    accept: "application/json, text/plain",
-    content_type: "application/json"
+    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:)
+    # @param legacy_auth [Boolean] true to use legacy /login rather than Poppy /login-with-expiry endpoint
     # @return [FolioClient] the configured Singleton class
-    def configure(url:, login_params:, okapi_headers:, timeout: default_timeout)
+    def configure(url:, login_params:, okapi_headers:, timeout: default_timeout, legacy_auth: true)
+      # 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
@@ -61,23 +65,26 @@ class FolioClient
         # 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",
+        token: 'a temporary dummy token to avoid hitting the API before it is needed',
         url: url,
         login_params: login_params,
         okapi_headers: okapi_headers,
-        timeout: timeout
+        timeout: timeout,
+        legacy_auth: legacy_auth # default true until we have new token endpoint enabled in Poppy
       )
+      # rubocop:enable Style/OpenStructUse
 
       self
     end
 
-    delegate :config, :connection, :data_import, :default_timeout,
-      :edit_marc_json, :fetch_external_id, :fetch_hrid, :fetch_instance_info,
-      :fetch_marc_hash, :fetch_marc_xml, :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 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
+  end
 
   attr_accessor :config
 
@@ -86,7 +93,7 @@ class FolioClient
   # @param params [Hash] params to get to the API
   def get(path, params = {})
     response = with_token_refresh_when_unauthorized do
-      connection.get(path, params, {"x-okapi-token": config.token})
+      connection.get(path, params, { 'x-okapi-token': config.token })
     end
 
     UnexpectedResponse.call(response) unless response.success?
@@ -100,12 +107,13 @@ class FolioClient
   # 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
-  def post(path, body = nil, content_type: "application/json")
-    req_body = (content_type == "application/json") ? body&.to_json : body
+  # rubocop:disable Metrics/MethodLength
+  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
+        'x-okapi-token': config.token,
+        'content-type': content_type
       }
       connection.post(path, req_body, req_headers)
     end
@@ -116,17 +124,19 @@ class FolioClient
 
     JSON.parse(response.body)
   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
-  def put(path, body = nil, content_type: "application/json")
-    req_body = (content_type == "application/json") ? body&.to_json : body
+  # rubocop:disable Metrics/MethodLength
+  def put(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
+        'x-okapi-token': config.token,
+        'content-type': content_type
       }
       connection.put(path, req_body, req_headers)
     end
@@ -137,14 +147,22 @@ class FolioClient
 
     JSON.parse(response.body)
   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 || {}),
-      request: {timeout: config.timeout}
-    )
+      request: { timeout: config.timeout }
+    ) do |faraday|
+      faraday.use :cookie_jar, jar: cookie_jar
+      faraday.adapter Faraday.default_adapter
+    end
+  end
+
+  def cookie_jar
+    @cookie_jar ||= HTTP::CookieJar.new
   end
 
   # Public methods available on the FolioClient below
@@ -152,98 +170,98 @@ class FolioClient
   # @see Inventory#fetch_hrid
   def fetch_hrid(...)
     Inventory
-      .new(self)
+      .new
       .fetch_hrid(...)
   end
 
   # @see Inventory#fetch_external_id
   def fetch_external_id(...)
     Inventory
-      .new(self)
+      .new
       .fetch_external_id(...)
   end
 
   # @see Inventory#fetch_instance_info
   def fetch_instance_info(...)
     Inventory
-      .new(self)
+      .new
       .fetch_instance_info(...)
   end
 
   # @see SourceStorage#fetch_marc_hash
   def fetch_marc_hash(...)
     SourceStorage
-      .new(self)
+      .new
       .fetch_marc_hash(...)
   end
 
   # @see SourceStorage#fetch_marc_xml
   def fetch_marc_xml(...)
     SourceStorage
-      .new(self)
+      .new
       .fetch_marc_xml(...)
   end
 
   # @see Inventory#has_instance_status?
-  def has_instance_status?(...)
+  def has_instance_status?(...) # rubocop:disable Naming/PredicateName
     Inventory
-      .new(self)
+      .new
       .has_instance_status?(...)
   end
 
   # @ see DataImport#import
   def data_import(...)
     DataImport
-      .new(self)
+      .new
       .import(...)
   end
 
   # @ see DataImport#job_profiles
   def job_profiles(...)
     DataImport
-      .new(self)
+      .new
       .job_profiles(...)
   end
 
   # @see RecordsEditor#edit_marc_json
   def edit_marc_json(...)
     RecordsEditor
-      .new(self)
+      .new
       .edit_marc_json(...)
   end
 
   # @see Organizations#fetch_list
   def organizations(...)
     Organizations
-      .new(self)
+      .new
       .fetch_list(...)
   end
 
   # @see Organizations#fetch_interface_list
   def organization_interfaces(...)
     Organizations
-      .new(self)
+      .new
       .fetch_interface_list(...)
   end
 
   # @see Organizations#fetch_interface_details
   def interface_details(...)
     Organizations
-      .new(self)
+      .new
       .fetch_interface_details(...)
   end
 
   # @see Users#fetch_list
   def users(...)
     Users
-      .new(self)
+      .new
       .fetch_list(...)
   end
 
   # @see Users#fetch_user_details
   def user_details(...)
     Users
-      .new(self)
+      .new
       .fetch_user_details(...)
   end
 
@@ -251,6 +269,10 @@ class FolioClient
     120
   end
 
+  def force_token_refresh!
+    config.token = Authenticator.token
+  end
+
   private
 
   # Wraps API operations to request new access token if expired.
@@ -269,11 +291,12 @@ class FolioClient
     response = yield
 
     # if unauthorized, token has likely expired. try to get a new token and then retry the same request(s).
-    if response.status == 401
-      config.token = Authenticator.token(config.login_params, connection)
+    if response.status == 401 || response.status == 403
+      force_token_refresh!
       response = yield
     end
 
     response
   end
 end
+# rubocop:enable Metrics/ClassLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: folio_client
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Peter Mangiafico
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-09 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  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: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -45,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: zeitwerk
+  name: faraday-cookie_jar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,7 +87,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dry-monads
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -115,7 +129,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,7 +143,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -143,7 +157,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -177,11 +205,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".autoupdate/postupdate"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop/custom.yml"
-- ".standard.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -215,14 +240,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Interface for interacting with the Folio ILS API.

data/.autoupdate/postupdate

@@ -1,19 +0,0 @@
-#!/bin/bash --login
-
-# This script is called by our weekly dependency update job in Jenkins after updating Ruby and other deps
-
-# Switch to Ruby 3.1 for FolioClient (3.0 is default in Jenkinsfile)
-rvm use 3.1.2@folio_client --create &&
-    gem install bundler &&
-    bundle install --gemfile Gemfile
-
-standardrb --fix > folio_client_standard.txt
-
-retVal=$?
-
-git commit -am "Update to latest standard style guide"
-
-if [ $retVal -ne 0 ]; then
-    echo "ERROR UPDATING RUBY TO STANDARD STYLE (folio_client)"
-    cat folio_client_standard.txt
-fi

data/.rubocop/custom.yml

@@ -1,84 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.0
-  DisplayCopNames: true
-  SuggestExtensions: false
-  Exclude:
-    - bin/**
-    - vendor/bundle/**/*
-
-# Per team developer playbook
-RSpec/MultipleMemoizedHelpers:
-  Enabled: false
-RSpec/MultipleExpectations:
-  Max: 3
-RSpec/ExampleLength:
-  Max: 15
-
-RSpec/BeEq: # new in 2.9.0
-  Enabled: true
-RSpec/BeNil: # new in 2.9.0
-  Enabled: true
-RSpec/ChangeByZero: # new in 2.11
-  Enabled: true
-RSpec/ClassCheck: # new in 2.13
-  Enabled: true
-RSpec/ExcessiveDocstringSpacing: # new in 2.5
-  Enabled: true
-RSpec/IdenticalEqualityAssertion: # new in 2.4
-  Enabled: true
-RSpec/NoExpectationExample: # new in 2.13
-  Enabled: true
-RSpec/SortMetadata: # new in 2.14
-  Enabled: true
-RSpec/SubjectDeclaration: # new in 2.5
-  Enabled: true
-RSpec/VerifiedDoubleReference: # new in 2.10.0
-  Enabled: true
-FactoryBot/ConsistentParenthesesStyle: # new in 2.14
-  Enabled: true
-FactoryBot/SyntaxMethods: # new in 2.7
-  Enabled: true
-RSpec/Rails/AvoidSetupHook: # new in 2.4
-  Enabled: true
-RSpec/Rails/HaveHttpStatus: # new in 2.12
-  Enabled: true
-RSpec/Rails/InferredSpecType: # new in 2.14
-  Enabled: true
-Capybara/MatchStyle: # new in 2.17
-  Enabled: true
-Capybara/NegationMatcher: # new in 2.14
-  Enabled: true
-Capybara/SpecificActions: # new in 2.14
-  Enabled: true
-Capybara/SpecificFinders: # new in 2.13
-  Enabled: true
-Capybara/SpecificMatcher: # new in 2.12
-  Enabled: true
-RSpec/DuplicatedMetadata: # new in 2.16
-  Enabled: true
-RSpec/PendingWithoutReason: # new in 2.16
-  Enabled: true
-FactoryBot/FactoryNameStyle: # new in 2.16
-  Enabled: true
-RSpec/Rails/MinitestAssertions: # new in 2.17
-  Enabled: true
-RSpec/RedundantAround: # new in 2.19
-  Enabled: true
-RSpec/SkipBlockInsideExample: # new in 2.19
-  Enabled: true
-RSpec/Rails/TravelAround: # new in 2.19
-  Enabled: true
-FactoryBot/AssociationStyle: # new in 2.23
-  Enabled: true
-FactoryBot/FactoryAssociationWithStrategy: # new in 2.23
-  Enabled: true
-FactoryBot/RedundantFactoryOption: # new in 2.23
-  Enabled: true
-RSpec/BeEmpty: # new in 2.20
-  Enabled: true
-RSpec/ContainExactly: # new in 2.19
-  Enabled: true
-RSpec/IndexedLet: # new in 2.20
-  Enabled: true
-RSpec/MatchArray: # new in 2.19
-  Enabled: true

data/.standard.yml

@@ -1 +0,0 @@
-parallel: true