folio_client 0.15.0 → 0.16.0

data/lib/folio_client/authenticator.rb

@@ -3,24 +3,34 @@
 class FolioClient
   # Fetch a token from the Folio API using login_params
   class Authenticator
-    def self.token(login_params, connection)
-      new(login_params, connection).token
-    end
-
-    def initialize(login_params, connection)
-      @login_params = login_params
-      @connection = connection
+    def self.token
+      new.token
     end
 
     # Request an access_token
-    def token
-      response = connection.post("/authn/login", login_params.to_json)
+    def token # rubocop:disable Metrics/AbcSize
+      response = FolioClient.connection.post(login_endpoint, FolioClient.config.login_params.to_json)
 
       UnexpectedResponse.call(response) unless response.success?
 
-      JSON.parse(response.body)["okapiToken"]
+      # remove legacy_auth once new tokens enabled on Poppy
+      if FolioClient.config.legacy_auth
+        JSON.parse(response.body)['okapiToken']
+      else
+        access_cookie = FolioClient.cookie_jar.cookies.find { |cookie| cookie.name == 'folioAccessToken' }
+
+        raise StandardError, "Problem with folioAccessToken cookie: #{response.headers}, #{response.body}" unless access_cookie
+
+        access_cookie.value
+      end
     end
 
-    attr_reader :login_params, :connection
+    private
+
+    def login_endpoint
+      return '/authn/login-with-expiry' unless FolioClient.config.legacy_auth
+
+      '/authn/login'
+    end
   end
 end

data/lib/folio_client/data_import.rb

@@ -1,32 +1,28 @@
 # frozen_string_literal: true
 
-require "date"
-require "stringio"
+require 'date'
+require 'stringio'
 
 class FolioClient
   # Imports MARC records into FOLIO
   class DataImport
     JOB_PROFILE_ATTRIBUTES = %w[id name description dataType].freeze
 
-    # @param client [FolioClient] the configured client
-    def initialize(client)
-      @client = client
-    end
-
     # @param records [Array<MARC::Record>] records to be imported
     # @param job_profile_id [String] job profile id to use for import
     # @param job_profile_name [String] job profile name to use for import
     # @return [JobStatus] a job status instance to get information about the data import job
+    # rubocop:disable Metrics/MethodLength
     def import(records:, job_profile_id:, job_profile_name:)
-      response_hash = client.post("/data-import/uploadDefinitions", {fileDefinitions: [{name: marc_filename}]})
-      upload_definition_id = response_hash.dig("fileDefinitions", 0, "uploadDefinitionId")
-      job_execution_id = response_hash.dig("fileDefinitions", 0, "jobExecutionId")
-      file_definition_id = response_hash.dig("fileDefinitions", 0, "id")
+      response_hash = client.post('/data-import/uploadDefinitions', { fileDefinitions: [{ name: marc_filename }] })
+      upload_definition_id = response_hash.dig('fileDefinitions', 0, 'uploadDefinitionId')
+      job_execution_id = response_hash.dig('fileDefinitions', 0, 'jobExecutionId')
+      file_definition_id = response_hash.dig('fileDefinitions', 0, 'id')
 
       upload_file_response_hash = client.post(
         "/data-import/uploadDefinitions/#{upload_definition_id}/files/#{file_definition_id}",
         marc_binary(records),
-        content_type: "application/octet-stream"
+        content_type: 'application/octet-stream'
       )
 
       client.post(
@@ -36,25 +32,30 @@ class FolioClient
           jobProfileInfo: {
             id: job_profile_id,
             name: job_profile_name,
-            dataType: "MARC"
+            dataType: 'MARC'
           }
         }
       )
 
-      JobStatus.new(client, job_execution_id: job_execution_id)
+      JobStatus.new(job_execution_id: job_execution_id)
     end
+    # rubocop:enable Metrics/MethodLength
 
     # @return [Array<Hash<String,String>>] a list of job profile hashes
     def job_profiles
       client
-        .get("/data-import-profiles/jobProfiles")
-        .fetch("jobProfiles", [])
+        .get('/data-import-profiles/jobProfiles')
+        .fetch('jobProfiles', [])
         .map { |profile| profile.slice(*JOB_PROFILE_ATTRIBUTES) }
     end
 
     private
 
-    attr_reader :client, :job_profile_id, :job_profile_name
+    attr_reader :job_profile_id, :job_profile_name
+
+    def client
+      FolioClient.instance
+    end
 
     def marc_filename
       @marc_filename ||= "#{DateTime.now.iso8601}.marc"

data/lib/folio_client/inventory.rb

@@ -3,26 +3,19 @@
 class FolioClient
   # Lookup items in the Folio inventory
   class Inventory
-    attr_accessor :client
-
-    # @param client [FolioClient] the configured client
-    def initialize(client)
-      @client = client
-    end
-
     # get instance HRID from barcode
     # @param barcode [String] barcode
     # @return [String,nil] instance HRID if present, otherwise nil.
     def fetch_hrid(barcode:)
       # find the instance UUID for this barcode
-      instance = client.get("/search/instances", {query: "items.barcode==#{barcode}"})
-      instance_uuid = instance.dig("instances", 0, "id")
+      instance = client.get('/search/instances', { query: "items.barcode==#{barcode}" })
+      instance_uuid = instance.dig('instances', 0, 'id')
 
       return nil unless instance_uuid
 
       # next lookup the instance given the instance_uuid so we can fetch the hrid
       result = client.get("/inventory/instances/#{instance_uuid}")
-      result.dig("hrid")
+      result['hrid']
     end
 
     # get instance external ID from HRID
@@ -30,12 +23,12 @@ class FolioClient
     # @return [String,nil] instance external ID if present, otherwise nil.
     # @raise [ResourceNotFound, MultipleResourcesFound] if search does not return exactly 1 result
     def fetch_external_id(hrid:)
-      instance_response = client.get("/search/instances", {query: "hrid==#{hrid}"})
-      record_count = instance_response["totalRecords"]
-      raise ResourceNotFound, "No matching instance found for #{hrid}" if instance_response["totalRecords"] == 0
+      instance_response = client.get('/search/instances', { query: "hrid==#{hrid}" })
+      record_count = instance_response['totalRecords']
+      raise ResourceNotFound, "No matching instance found for #{hrid}" if (instance_response['totalRecords']).zero?
       raise MultipleResourcesFound, "Expected 1 record for #{hrid}, but found #{record_count}" if record_count > 1
 
-      instance_response.dig("instances", 0, "id")
+      instance_response.dig('instances', 0, 'id')
     end
 
     # Retrieve basic information about a instance record.  Example usage: get the external ID and _version for update using
@@ -46,8 +39,8 @@ class FolioClient
     # @return [Hash] information about the record.
     # @raise [ArgumentError] if the caller does not provide exactly one of external_id or hrid
     def fetch_instance_info(external_id: nil, hrid: nil)
-      raise ArgumentError, "must pass exactly one of external_id or HRID" unless external_id.present? || hrid.present?
-      raise ArgumentError, "must pass exactly one of external_id or HRID" if external_id.present? && hrid.present?
+      raise ArgumentError, 'must pass exactly one of external_id or HRID' unless external_id.present? || hrid.present?
+      raise ArgumentError, 'must pass exactly one of external_id or HRID' if external_id.present? && hrid.present?
 
       external_id ||= fetch_external_id(hrid: hrid)
       client.get("/inventory/instances/#{external_id}")
@@ -57,12 +50,12 @@ class FolioClient
     # @param status_id [String] uuid for an instance status code
     # @return true if instance status matches the uuid param, false otherwise
     # @raise [ResourceNotFound] if search by instance HRID returns 0 results
-    def has_instance_status?(hrid:, status_id:)
+    def has_instance_status?(hrid:, status_id:) # rubocop:disable Naming/PredicateName
       # get the instance record and its statusId
-      instance = client.get("/inventory/instances", {query: "hrid==#{hrid}"})
-      raise ResourceNotFound, "No matching instance found for #{hrid}" if instance["totalRecords"] == 0
+      instance = client.get('/inventory/instances', { query: "hrid==#{hrid}" })
+      raise ResourceNotFound, "No matching instance found for #{hrid}" if (instance['totalRecords']).zero?
 
-      instance_status_id = instance.dig("instances", 0, "statusId")
+      instance_status_id = instance.dig('instances', 0, 'statusId')
 
       return false unless instance_status_id
 
@@ -70,5 +63,11 @@ class FolioClient
 
       false
     end
+
+    private
+
+    def client
+      FolioClient.instance
+    end
   end
 end

data/lib/folio_client/job_status.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "timeout"
-require "dry/monads"
+require 'timeout'
+require 'dry/monads'
 
 class FolioClient
   # Wraps operations waiting for results from jobs
@@ -10,10 +10,8 @@ class FolioClient
 
     attr_reader :job_execution_id
 
-    # @param client [FolioClient] the configured client
     # @param job_execution_id [String] ID of the job to be checked on
-    def initialize(client, job_execution_id:)
-      @client = client
+    def initialize(job_execution_id:)
       @job_execution_id = job_execution_id
     end
 
@@ -27,7 +25,7 @@ class FolioClient
     def status
       response_hash = client.get("/change-manager/jobExecutions/#{job_execution_id}")
 
-      return Failure(:pending) if !["COMMITTED", "ERROR"].include?(response_hash["status"])
+      return Failure(:pending) unless %w[COMMITTED ERROR].include?(response_hash['status'])
 
       Success()
     rescue ResourceNotFound
@@ -35,28 +33,33 @@ class FolioClient
       Failure(:not_found)
     end
 
-    def wait_until_complete(wait_secs: default_wait_secs, timeout_secs: default_timeout_secs, max_checks: default_max_checks)
+    def wait_until_complete(wait_secs: default_wait_secs, timeout_secs: default_timeout_secs,
+                            max_checks: default_max_checks)
       wait_with_timeout(wait_secs: wait_secs, timeout_secs: timeout_secs, max_checks: max_checks) { status }
     end
 
+    # rubocop:disable Metrics/AbcSize
     def instance_hrids
       current_status = status
       return current_status unless current_status.success?
 
       @instance_hrids ||= wait_with_timeout do
         response = client
-          .get("/metadata-provider/journalRecords/#{job_execution_id}")
-          .fetch("journalRecords", [])
-          .select { |journal_record| journal_record["entityType"] == "INSTANCE" && journal_record["actionStatus"] == "COMPLETED" }
-          .filter_map { |instance_record| instance_record["entityHrId"] }
+                   .get("/metadata-provider/journalRecords/#{job_execution_id}")
+                   .fetch('journalRecords', [])
+                   .select { |journal_record| journal_record['entityType'] == 'INSTANCE' && journal_record['actionStatus'] == 'COMPLETED' }
+                   .filter_map { |instance_record| instance_record['entityHrId'] }
 
         response.empty? ? Failure() : Success(response)
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
     private
 
-    attr_reader :client
+    def client
+      FolioClient.instance
+    end
 
     def default_wait_secs
       1
@@ -71,7 +74,8 @@ class FolioClient
       10
     end
 
-    def wait_with_timeout(wait_secs: default_wait_secs, timeout_secs: default_timeout_secs, max_checks: default_max_checks)
+    def wait_with_timeout(wait_secs: default_wait_secs, timeout_secs: default_timeout_secs,
+                          max_checks: default_max_checks)
       Timeout.timeout(timeout_secs) do
         loop.with_index do |_, i|
           result = yield
@@ -94,7 +98,8 @@ class FolioClient
     def check_not_found(result, index, max_checks)
       return unless result.failure? && result.failure == :not_found && index > max_checks
 
-      raise ResourceNotFound, "Job #{job_execution_id} not found after #{index} retries. The data import job may still have completed."
+      raise ResourceNotFound,
+            "Job #{job_execution_id} not found after #{index} retries. The data import job may still have completed."
     end
   end
 end

data/lib/folio_client/organizations.rb

@@ -5,39 +5,38 @@ class FolioClient
   # https://s3.amazonaws.com/foliodocs/api/mod-organizations/p/organizations.html
   # https://s3.amazonaws.com/foliodocs/api/mod-organizations-storage/p/interface.html
   class Organizations
-    attr_accessor :client
-
-    # @param client [FolioClient] the configured client
-    def initialize(client)
-      @client = client
-    end
-
     # @param query [String] an optional query to limit the number of organizations returned
     # @param limit [Integer] the number of results to return (defaults to 10,000)
     # @param offset [Integer] the offset for results returned (defaults to 0)
     # @param lang [String] language code for returned results (defaults to 'en')
-    def fetch_list(query: nil, limit: 10000, offset: 0, lang: "en")
-      params = {limit: limit, offset: offset, lang: lang}
+    def fetch_list(query: nil, limit: 10_000, offset: 0, lang: 'en')
+      params = { limit: limit, offset: offset, lang: lang }
       params[:query] = query if query
-      client.get("/organizations/organizations", params)
+      client.get('/organizations/organizations', params)
     end
 
     # @param query [String] an optional query to limit the number of organization interfaces returned
     # @param limit [Integer] the number of results to return (defaults to 10,000)
     # @param offset [Integer] the offset for results returned (defaults to 0)
     # @param lang [String] language code for returned results (defaults to 'en')
-    def fetch_interface_list(query: nil, limit: 10000, offset: 0, lang: "en")
-      params = {limit: limit, offset: offset, lang: lang}
+    def fetch_interface_list(query: nil, limit: 10_000, offset: 0, lang: 'en')
+      params = { limit: limit, offset: offset, lang: lang }
       params[:query] = query if query
-      client.get("/organizations-storage/interfaces", params)
+      client.get('/organizations-storage/interfaces', params)
     end
 
     # @param id [String] id for requested storage interface
     # @param lang [String] language code for returned result (defaults to 'en')
-    def fetch_interface_details(id:, lang: "en")
+    def fetch_interface_details(id:, lang: 'en')
       client.get("/organizations-storage/interfaces/#{id}", {
-        lang: lang
-      })
+                   lang: lang
+                 })
+    end
+
+    private
+
+    def client
+      FolioClient.instance
     end
   end
 end

data/lib/folio_client/records_editor.rb

@@ -1,14 +1,8 @@
 # frozen_string_literal: true
 
 class FolioClient
+  # Edit MARC JSON records in Folio
   class RecordsEditor
-    attr_accessor :client
-
-    # @param client [FolioClient] the configured client
-    def initialize(client)
-      @client = client
-    end
-
     # Given an HRID, retrieves the associated MARC JSON, yields it to the caller as a hash,
     # and attempts to re-save it, using optimistic locking to prevent accidental overwrite,
     # in case another user or process has updated the record in the time between retrieval and
@@ -18,24 +12,32 @@ class FolioClient
     #  HRID; the updated hash will be saved when control is returned from the block.
     # @note in limited manual testing, optimistic locking behaved like so when two edit attempts collided:
     #   * One updating client would eventually raise a timeout.  This updating client would actually write successfully, and version the record.
-    #   * The other updating client would raise a StandardError, with a message like 'duplicate key value violates unique constraint \"idx_records_matched_id_gen\"'.
+    #   * The other updating client would raise a StandardError, with a message like 'duplicate key value violates unique
+    #     constraint \"idx_records_matched_id_gen\"'.
     #     This client would fail to write.
     #   * As opposed to the expected behavior of the "winner" getting a 200 ok response, and the "loser" getting a 409 conflict response.
     # @todo If this is a problem in practice, see if it's possible to have Folio respond in a more standard way; or, workaround with error handling.
     def edit_marc_json(hrid:)
       instance_info = client.fetch_instance_info(hrid: hrid)
 
-      version = instance_info["_version"]
-      external_id = instance_info["id"]
+      version = instance_info['_version']
+      external_id = instance_info['id']
 
-      record_json = client.get("/records-editor/records", {externalId: external_id})
+      record_json = client.get('/records-editor/records', { externalId: external_id })
 
-      parsed_record_id = record_json["parsedRecordId"]
-      record_json["relatedRecordVersion"] = version # setting this field on the JSON we send back is what will allow optimistic locking to catch stale updates
+      parsed_record_id = record_json['parsedRecordId']
+      # setting this field on the JSON we send back is what will allow optimistic locking to catch stale updates
+      record_json['relatedRecordVersion'] = version
 
       yield record_json
 
       client.put("/records-editor/records/#{parsed_record_id}", record_json)
     end
+
+    private
+
+    def client
+      FolioClient.instance
+    end
   end
 end

data/lib/folio_client/source_storage.rb

@@ -5,26 +5,23 @@ class FolioClient
   class SourceStorage
     FIELDS_TO_REMOVE = %w[001 003].freeze
 
-    attr_accessor :client
-
-    # @param client [FolioClient] the configured client
-    def initialize(client)
-      @client = client
-    end
-
     # get marc bib data from folio given an instance HRID
     # @param instance_hrid [String] the key to use for MARC lookup
     # @return [Hash] hash representation of the MARC. should be usable by MARC::Record.new_from_hash (from ruby-marc gem)
     # @raise [ResourceNotFound]
     # @raise [MultipleResourcesFound]
     def fetch_marc_hash(instance_hrid:)
-      response_hash = client.get("/source-storage/source-records", {instanceHrid: instance_hrid})
+      response_hash = client.get('/source-storage/source-records', { instanceHrid: instance_hrid })
 
-      record_count = response_hash["totalRecords"]
+      record_count = response_hash['totalRecords']
       raise ResourceNotFound, "No records found for #{instance_hrid}" if record_count.zero?
-      raise MultipleResourcesFound, "Expected 1 record for #{instance_hrid}, but found #{record_count}" if record_count > 1
 
-      response_hash["sourceRecords"].first["parsedRecord"]["content"]
+      if record_count > 1
+        raise MultipleResourcesFound,
+              "Expected 1 record for #{instance_hrid}, but found #{record_count}"
+      end
+
+      response_hash['sourceRecords'].first['parsedRecord']['content']
     end
 
     # get marc bib data as MARCXML from folio given an instance HRID
@@ -33,12 +30,20 @@ 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)
-      raise ArgumentError, "Either a barcode or a Folio instance HRID must be provided" if barcode.nil? && instance_hrid.nil?
+      if barcode.nil? && instance_hrid.nil?
+        raise ArgumentError,
+              'Either a barcode or a Folio instance HRID must be provided'
+      end
 
       instance_hrid ||= client.fetch_hrid(barcode: barcode)
 
-      raise ResourceNotFound, "Catalog record not found. HRID: #{instance_hrid} | Barcode: #{barcode}" if instance_hrid.blank?
+      if instance_hrid.blank?
+        raise ResourceNotFound,
+              "Catalog record not found. HRID: #{instance_hrid} | Barcode: #{barcode}"
+      end
 
       marc_record = MARC::Record.new_from_hash(
         fetch_marc_hash(instance_hrid: instance_hrid)
@@ -52,10 +57,18 @@ class FolioClient
         updated_marc.fields << field
       end
       # explicitly inject the instance_hrid into the 001 field
-      updated_marc.fields << MARC::ControlField.new("001", instance_hrid)
+      updated_marc.fields << MARC::ControlField.new('001', instance_hrid)
       # explicitly inject FOLIO into the 003 field
-      updated_marc.fields << MARC::ControlField.new("003", "FOLIO")
+      updated_marc.fields << MARC::ControlField.new('003', 'FOLIO')
       updated_marc.to_xml.to_s
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
+
+    private
+
+    def client
+      FolioClient.instance
+    end
   end
 end

data/lib/folio_client/unexpected_response.rb

@@ -4,6 +4,8 @@ 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)
       case response.status
       when 401
@@ -23,4 +25,6 @@ class FolioClient
       end
     end
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
 end

data/lib/folio_client/users.rb

@@ -4,29 +4,28 @@ class FolioClient
   # Query user records in Folio; see
   # https://s3.amazonaws.com/foliodocs/api/mod-users/r/users.html
   class Users
-    attr_accessor :client
-
-    # @param client [FolioClient] the configured client
-    def initialize(client)
-      @client = client
-    end
-
     # @param query [String] an optional query to limit the number of users returned
     # @param limit [Integer] the number of results to return (defaults to 10,000)
     # @param offset [Integer] the offset for results returned (defaults to 0)
     # @param lang [String] language code for returned results (defaults to 'en')
-    def fetch_list(query: nil, limit: 10000, offset: 0, lang: "en")
-      params = {limit: limit, offset: offset, lang: lang}
+    def fetch_list(query: nil, limit: 10_000, offset: 0, lang: 'en')
+      params = { limit: limit, offset: offset, lang: lang }
       params[:query] = query if query
-      client.get("/users", params)
+      client.get('/users', params)
     end
 
     # @param id [String] id for requested user
     # @param lang [String] language code for returned results (defaults to 'en')
-    def fetch_user_details(id:, lang: "en")
+    def fetch_user_details(id:, lang: 'en')
       client.get("/users/#{id}", {
-        lang: lang
-      })
+                   lang: lang
+                 })
+    end
+
+    private
+
+    def client
+      FolioClient.instance
     end
   end
 end

data/lib/folio_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class FolioClient
-  VERSION = "0.15.0"
+  VERSION = '0.16.0'
 end