folio_client 0.10.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49b7e49d6350ec5da1e3d1b86df567520dbe89c9eed80fb42b8c158c79c3f426
-  data.tar.gz: f957345b73f2071fee40ffbe6f6e4f8082468f383bc7848ff9953ac017917c4b
+  metadata.gz: 7918be772bc1758840166cbb6f0fb66bfbf4765f636118d971efef2192a947df
+  data.tar.gz: 86d3c7e5656e849cf3358ddf7e22463bd65527cedf017a9a31dfdd2606bad88a
 SHA512:
-  metadata.gz: c775d4984eab9d5a89d310da0983dbde38824af07498ed4504cb9b9d0614c4a12c3328dde4c59d96aede407672529d39ebabeb227fe01a6b0380de716704f109
-  data.tar.gz: bc70a108d1a3d70131db2eed2e20343f5c0462c00a2dab65a1484456dfe7e2e19b4b6d616e628531cf664348c9bf85fc88eda94874cdbc859ae614e2a21bbde6
+  metadata.gz: 9471247fec95c9df775cd359896c788d124173477b74f1124d41641f76e6d61438fe7b5e7c10fb3ee7d6efb9f5dba11c9b0b7b45fb9040520f6668cba626fc1d
+  data.tar.gz: 4f0adf00bb277b709a68552e7f2b5119e7b8597723ffc3c4f500d850e2c8470df0249a19e35a98bcfcf2ef6daa3befb8155e57d5f69c8d825fe3b1806cd240a5

data/.rubocop/custom.yml

@@ -34,9 +34,9 @@ RSpec/SubjectDeclaration: # new in 2.5
   Enabled: true
 RSpec/VerifiedDoubleReference: # new in 2.10.0
   Enabled: true
-RSpec/FactoryBot/ConsistentParenthesesStyle: # new in 2.14
+FactoryBot/ConsistentParenthesesStyle: # new in 2.14
   Enabled: true
-RSpec/FactoryBot/SyntaxMethods: # new in 2.7
+FactoryBot/SyntaxMethods: # new in 2.7
   Enabled: true
 RSpec/Rails/AvoidSetupHook: # new in 2.4
   Enabled: true
@@ -58,7 +58,7 @@ RSpec/DuplicatedMetadata: # new in 2.16
   Enabled: true
 RSpec/PendingWithoutReason: # new in 2.16
   Enabled: true
-RSpec/FactoryBot/FactoryNameStyle: # new in 2.16
+FactoryBot/FactoryNameStyle: # new in 2.16
   Enabled: true
 RSpec/Rails/MinitestAssertions: # new in 2.17
   Enabled: true
@@ -68,3 +68,17 @@ 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/.rubocop.yml

@@ -3,12 +3,16 @@ inherit_mode:
     - Exclude
 
 require:
+  - standard
+  - standard-custom
+  - standard-performance
   - rubocop-performance
   - rubocop-rspec
-  - standard
 
 inherit_gem:
   standard: config/base.yml
+  standard-performance: config/base.yml
+  standard-custom: config/base.yml
 
 inherit_from:
   - .rubocop/custom.yml

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    folio_client (0.10.1)
+    folio_client (0.12.0)
       activesupport (>= 4.2, < 8)
       dry-monads
       faraday
@@ -11,82 +11,92 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.3)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.1)
+    addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    base64 (0.1.1)
     byebug (11.1.3)
     concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
-    dry-core (1.0.0)
+    dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
       zeitwerk (~> 2.6)
     dry-monads (1.6.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0, < 2)
       zeitwerk (~> 2.6)
-    faraday (2.7.4)
+    faraday (2.7.11)
+      base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
     hashdiff (1.0.1)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
     marc (1.2.0)
       rexml
       scrub_rb (>= 1.0.1, < 2)
       unf
-    minitest (5.18.0)
-    parallel (1.22.1)
-    parser (3.2.1.1)
+    minitest (5.20.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    public_suffix (5.0.1)
+      racc
+    public_suffix (5.0.3)
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.4)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.48.1)
+    rspec-support (3.12.1)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.1)
+    rubocop-capybara (2.18.0)
       rubocop (~> 1.41)
-    rubocop-performance (1.16.0)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-performance (1.19.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.19.0)
+    rubocop-rspec (2.24.0)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     scrub_rb (1.0.1)
@@ -96,21 +106,29 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.25.3)
+    standard (1.31.1)
       language_server-protocol (~> 3.17.0.2)
-      rubocop (~> 1.48.1)
-      rubocop-performance (~> 1.16.0)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.56.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.2)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.2.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.19.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8.2)
     unicode-display_width (2.4.2)
-    webmock (3.18.1)
+    webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.7)
+    zeitwerk (2.6.11)
 
 PLATFORMS
   x86_64-darwin-19
@@ -130,4 +148,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.4.5
+   2.4.13

data/README.md

@@ -71,15 +71,15 @@ client.fetch_marc_hash(instance_hrid: "a7927874")
   [{"003"=>"FOLIO"}....]
   }
 
-# Import a MARC record into FOLIO
-data_importer = client.data_import(marc: my_marc, job_profile_id: '4ba4f4ab', job_profile_name: 'ETDs')
+# Import MARC records into FOLIO
+data_importer = client.data_import(records: [marc_record1, marc_record2], job_profile_id: '4ba4f4ab', job_profile_name: 'ETDs')
 # If called too quickly, might get Failure(:not_found)
 data_importer.status
  => Failure(:pending)
 data_importer.wait_until_complete
  => Success()
-data_importer.instance_hrid
- => Success("in00000000010")
+data_importer.instance_hrids
+ => Success(["in00000000010", "in00000000011"])
 
 # Get list of organizations (filtered with an optional query)
 # see https://s3.amazonaws.com/foliodocs/api/mod-organizations/p/organizations.html#organizations_organizations_get

data/lib/folio_client/data_import.rb

@@ -7,21 +7,28 @@ 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 record [MARC::Record] record to be imported
+    # @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
-    def import(marc:, job_profile_id:, job_profile_name:)
+    # @return [JobStatus] a job status instance to get information about the data import job
+    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")
 
-      upload_file_response_hash = client.post("/data-import/uploadDefinitions/#{upload_definition_id}/files/#{file_definition_id}", marc_binary(marc), content_type: "application/octet-stream")
+      upload_file_response_hash = client.post(
+        "/data-import/uploadDefinitions/#{upload_definition_id}/files/#{file_definition_id}",
+        marc_binary(records),
+        content_type: "application/octet-stream"
+      )
 
       client.post(
         "/data-import/uploadDefinitions/#{upload_definition_id}/processFiles",
@@ -38,18 +45,26 @@ class FolioClient
       JobStatus.new(client, job_execution_id: job_execution_id)
     end
 
+    # @return [Array<Hash<String,String>>] a list of job profile hashes
+    def job_profiles
+      client
+        .get("/data-import-profiles/jobProfiles")
+        .fetch("jobProfiles", [])
+        .map { |profile| profile.slice(*JOB_PROFILE_ATTRIBUTES) }
+    end
+
     private
 
-    attr_reader :client, :marc, :job_profile_id, :job_profile_name
+    attr_reader :client, :job_profile_id, :job_profile_name
 
     def marc_filename
       @marc_filename ||= "#{DateTime.now.iso8601}.marc"
     end
 
-    def marc_binary(marc)
+    def marc_binary(records)
       StringIO.open do |io|
         MARC::Writer.new(io) do |writer|
-          writer.write(marc)
+          records.each { |record| writer.write(record) }
         end
         io.string
       end

data/lib/folio_client/job_status.rb

@@ -17,15 +17,17 @@ class FolioClient
       @job_execution_id = job_execution_id
     end
 
-    # @return [Dry::Monads::Result] Success if job is complete,
-    # Failure(:pending) if job is still running,
-    # Failure(:error) if job has errors
-    # Failure(:not_found) if job is not found
+    # @todo An "ERROR" approach means one or more records failed, but it does
+    #       not mean they all fail. We will likely need a more nuanced way to
+    #       handle this eventually.
+    #
+    # @return [Dry::Monads::Result] Success() if job is complete,
+    #                               Failure(:pending) if job is still running,
+    #                               Failure(:not_found) if job is not found
     def status
-      response_hash = client.get("/metadata-provider/jobSummary/#{job_execution_id}")
+      response_hash = client.get("/change-manager/jobExecutions/#{job_execution_id}")
 
-      return Failure(:error) if response_hash["totalErrors"].positive?
-      return Failure(:pending) if response_hash.dig("sourceRecordSummary", "totalCreatedEntities").zero? && response_hash.dig("sourceRecordSummary", "totalUpdatedEntities").zero?
+      return Failure(:pending) if !["COMMITTED", "ERROR"].include?(response_hash["status"])
 
       Success()
     rescue ResourceNotFound
@@ -37,18 +39,18 @@ class FolioClient
       wait_with_timeout(wait_secs: wait_secs, timeout_secs: timeout_secs) { status }
     end
 
-    def instance_hrid
+    def instance_hrids
       current_status = status
       return current_status unless current_status.success?
 
-      @instance_hrid ||= wait_with_timeout do
+      @instance_hrids ||= wait_with_timeout do
         response = client
           .get("/metadata-provider/journalRecords/#{job_execution_id}")
           .fetch("journalRecords", [])
-          .find { |journal_record| journal_record["entityType"] == "INSTANCE" }
-          &.fetch("entityHrId", nil)
+          .select { |journal_record| journal_record["entityType"] == "INSTANCE" && journal_record["actionStatus"] == "COMPLETED" }
+          .filter_map { |instance_record| instance_record["entityHrId"] }
 
-        response.nil? ? Failure() : Success(response)
+        response.empty? ? Failure() : Success(response)
       end
     end
 
@@ -61,7 +63,7 @@ class FolioClient
     end
 
     def default_timeout_secs
-      5 * 60
+      10 * 60
     end
 
     def wait_with_timeout(wait_secs: default_wait_secs, timeout_secs: default_timeout_secs)

data/lib/folio_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class FolioClient
-  VERSION = "0.10.1"
+  VERSION = "0.12.0"
 end

data/lib/folio_client.rb

@@ -47,17 +47,34 @@ class FolioClient
     # @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)
-      instance.config = OpenStruct.new(url: url, login_params: login_params, okapi_headers: okapi_headers, token: nil, timeout: timeout)
-
-      instance.config.token = Authenticator.token(login_params, connection)
+      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",
+        url: url,
+        login_params: login_params,
+        okapi_headers: okapi_headers,
+        timeout: timeout
+      )
 
       self
     end
 
-    delegate :config, :connection, :get, :post, :put, :default_timeout, to: :instance
-    delegate :fetch_hrid, :fetch_external_id, :fetch_instance_info, :fetch_marc_hash, :has_instance_status?, :data_import, :edit_marc_json,
-      :organizations, :organization_interfaces, :interface_details, to: :instance
+    delegate :config, :connection, :data_import, :default_timeout,
+      :edit_marc_json, :fetch_external_id, :fetch_hrid, :fetch_instance_info,
+      :fetch_marc_hash, :get, :has_instance_status?, :http_get_headers,
+      :http_post_and_put_headers, :interface_details, :job_profiles,
+      :organization_interfaces, :organizations, :post, :put, to: :instance
   end
 
   attr_accessor :config
@@ -66,7 +83,7 @@ class FolioClient
   # @param path [String] the path to the Folio API request
   # @param params [Hash] params to get to the API
   def get(path, params = {})
-    response = TokenWrapper.refresh(config, connection) do
+    response = with_token_refresh_when_unauthorized do
       connection.get(path, params, {"x-okapi-token": config.token})
     end
 
@@ -83,7 +100,7 @@ class FolioClient
   # @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
-    response = TokenWrapper.refresh(config, connection) do
+    response = with_token_refresh_when_unauthorized do
       req_headers = {
         "x-okapi-token": config.token,
         "content-type": content_type
@@ -104,7 +121,7 @@ class FolioClient
   # @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
-    response = TokenWrapper.refresh(config, connection) do
+    response = with_token_refresh_when_unauthorized do
       req_headers = {
         "x-okapi-token": config.token,
         "content-type": content_type
@@ -172,25 +189,35 @@ class FolioClient
       .import(...)
   end
 
-  # @see RecordsEditor.edit_marc_json
+  # @ see DataImport#job_profiles
+  def job_profiles(...)
+    DataImport
+      .new(self)
+      .job_profiles(...)
+  end
+
+  # @see RecordsEditor#edit_marc_json
   def edit_marc_json(...)
     RecordsEditor
       .new(self)
       .edit_marc_json(...)
   end
 
+  # @see Organizations#fetch_list
   def organizations(...)
     Organizations
       .new(self)
       .fetch_list(...)
   end
 
+  # @see Organizations#fetch_interface_list
   def organization_interfaces(...)
     Organizations
       .new(self)
       .fetch_interface_list(...)
   end
 
+  # @see Organizations#fetch_interface_details
   def interface_details(...)
     Organizations
       .new(self)
@@ -200,4 +227,30 @@ class FolioClient
   def default_timeout
     120
   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).
+  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 response.status == 401
+      config.token = Authenticator.token(config.login_params, connection)
+      response = yield
+    end
+
+    response
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: folio_client
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Peter Mangiafico
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-31 00:00:00.000000000 Z
+date: 2023-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -196,7 +196,6 @@ files:
 - lib/folio_client/organizations.rb
 - lib/folio_client/records_editor.rb
 - lib/folio_client/source_storage.rb
-- lib/folio_client/token_wrapper.rb
 - lib/folio_client/unexpected_response.rb
 - lib/folio_client/version.rb
 homepage: https://github.com/sul-dlss/folio_client
@@ -221,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Interface for interacting with the Folio ILS API.

data/lib/folio_client/token_wrapper.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-class FolioClient
-  # Wraps API operations to request new access token if expired
-  class TokenWrapper
-    def self.refresh(config, connection)
-      yield.tap { |response| UnexpectedResponse.call(response) unless response.success? }
-    rescue UnauthorizedError
-      config.token = Authenticator.token(config.login_params, connection)
-      yield
-    end
-  end
-end