folio_client 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e45342fc554ea5de7c33e31a2bc41fd1b550cf1d60a52edd47b18f2c861846e
-  data.tar.gz: 13b0ddc4db0c2f73c31b2db26c48c9295ffa836e1e5e491b3308382d61021e72
+  metadata.gz: 51efd566f32da4e9349cde6c853d91b25db7db35be7f046e5cc8ae445470c25e
+  data.tar.gz: b244ae8d8d496baeb51c3e43834bc2f330fe04cbb943ad2e652efdfacbe0a6aa
 SHA512:
-  metadata.gz: 5087d3b4a53111f8d442756e4ef4d7d5213c4232650fb46216c48aa877ea12c4bf5a2686ac90cbc575be3c1b7b271079357a00dd25a96f6cd7fc32a2738741f8
-  data.tar.gz: 1094cccbea7e0d3cfc5f0b602c78b1b1b85aa2374cd1f264dcdf569c3b7bd907153f5f9342ddc5ccc7a3a45e68e5462060f5c4452cbc1c2c5a87fd6f4bd903d8
+  metadata.gz: 16a20ff6ec80f84d828f773ff8c3b1eeeda67dd0472674134aa975a822b37d0d9f86c65ef3ccb03d26c800ffa3a001386d973a77c03ab8d1ef9aeda7dfd312f4
+  data.tar.gz: e34c0b895a3bfea9174a6836c0a5af28afd1de88743430ba3b2d75494ebe42675e8e1b7a9015823e1e065ba28ed6dbbea864111cf5dd05fc3f5f7b8daf3938b7

data/.rspec

@@ -1,3 +1,2 @@
---format documentation
 --color
 --require spec_helper

data/.rubocop/custom.yml

@@ -9,6 +9,8 @@ AllCops:
 # Per team developer playbook
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
+RSpec/MultipleExpectations:
+  Max: 3
 
 RSpec/BeEq: # new in 2.9.0
   Enabled: true
@@ -40,3 +42,21 @@ 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
+RSpec/FactoryBot/FactoryNameStyle: # new in 2.16
+  Enabled: true
+RSpec/Rails/MinitestAssertions: # new in 2.17
+  Enabled: true

data/.rubocop_todo.yml

@@ -1,30 +1,7 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-02-10 00:58:06 UTC using RuboCop version 1.44.1.
+# on 2023-03-03 17:57:09 UTC using RuboCop version 1.44.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 20
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
-# SupportedStyles: space, no_space, compact
-# SupportedStylesForEmptyBraces: space, no_space
-Layout/SpaceInsideHashLiteralBraces:
-  Exclude:
-    - 'lib/folio_client.rb'
-    - 'spec/folio_client/authenticator_spec.rb'
-    - 'spec/folio_client_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: be, be_nil
-RSpec/BeNil:
-  Exclude:
-    - 'spec/folio_client_spec.rb'
-
-# Offense count: 1
-RSpec/MultipleExpectations:
-  Max: 3

data/Gemfile.lock

@@ -1,9 +1,11 @@
 PATH
   remote: .
   specs:
-    folio_client (0.6.0)
+    folio_client (0.7.0)
       activesupport (>= 4.2, < 8)
+      dry-monads
       faraday
+      marc
       zeitwerk
 
 GEM
@@ -23,6 +25,13 @@ GEM
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
+    dry-core (1.0.0)
+      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-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
@@ -32,7 +41,11 @@ GEM
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
-    minitest (5.17.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.0)
       ast (~> 2.4.1)
@@ -64,7 +77,7 @@ GEM
       rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.26.0)
+    rubocop-ast (1.27.0)
       parser (>= 3.2.1.0)
     rubocop-capybara (2.17.1)
       rubocop (~> 1.41)
@@ -74,8 +87,9 @@ GEM
     rubocop-rspec (2.18.1)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
-    ruby-progressbar (1.11.0)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
+    scrub_rb (1.0.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -88,6 +102,9 @@ GEM
       rubocop-performance (= 1.15.2)
     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)
       addressable (>= 2.8.0)

data/README.md

@@ -70,6 +70,16 @@ client.fetch_marc_hash(instance_hrid: "a7927874")
  => {"fields"=>
   [{"003"=>"FOLIO"}....]
   }
+
+# Import a MARC record
+data_importer = client.data_import(marc: my_marc, 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")
 ```
 
 ## Development

data/Rakefile

@@ -2,11 +2,9 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
 require "rubocop/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: %i[rubocop spec]

data/folio_client.gemspec

@@ -34,6 +34,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport", ">= 4.2", "< 8"
   spec.add_dependency "faraday"
   spec.add_dependency "zeitwerk"
+  spec.add_dependency "marc"
+  spec.add_dependency "dry-monads"
 
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/folio_client/data_import.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "date"
+require "marc"
+require "stringio"
+
+class FolioClient
+  # Imports MARC records into FOLIO
+  class DataImport
+    # @param client [FolioClient] the configured client
+    def initialize(client)
+      @client = client
+    end
+
+    # @param record [MARC::Record] record 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:)
+      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")
+
+      client.post(
+        "/data-import/uploadDefinitions/#{upload_definition_id}/processFiles",
+        {
+          uploadDefinition: upload_file_response_hash,
+          jobProfileInfo: {
+            id: job_profile_id,
+            name: job_profile_name,
+            dataType: "MARC"
+          }
+        }
+      )
+
+      JobStatus.new(client, job_execution_id: job_execution_id)
+    end
+
+    private
+
+    attr_reader :client, :marc, :job_profile_id, :job_profile_name
+
+    def marc_filename
+      @marc_filename ||= "#{DateTime.now.iso8601}.marc"
+    end
+
+    def marc_binary(marc)
+      StringIO.open do |io|
+        MARC::Writer.new(io) do |writer|
+          writer.write(marc)
+        end
+        io.string
+      end
+    end
+  end
+end

data/lib/folio_client/job_status.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "timeout"
+require "dry/monads"
+
+class FolioClient
+  # Wraps operations waiting for results from jobs
+  class JobStatus
+    include Dry::Monads[:result]
+
+    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
+      @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
+    def status
+      response_hash = client.get("/metadata-provider/jobSummary/#{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?
+
+      Success()
+    rescue ResourceNotFound
+      # Checking the status immediately after starting the import may result in a 404.
+      Failure(:not_found)
+    end
+
+    def wait_until_complete(wait_secs: default_wait_secs, timeout_secs: default_timeout_secs)
+      wait_with_timeout(wait_secs: wait_secs, timeout_secs: timeout_secs) { status }
+    end
+
+    def instance_hrid
+      current_status = status
+      return current_status unless current_status.success?
+
+      @instance_hrid ||= 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)
+
+        response.nil? ? Failure() : Success(response)
+      end
+    end
+
+    private
+
+    attr_reader :client
+
+    def default_wait_secs
+      1
+    end
+
+    def default_timeout_secs
+      5 * 60
+    end
+
+    def wait_with_timeout(wait_secs: default_wait_secs, timeout_secs: default_timeout_secs)
+      Timeout.timeout(timeout_secs) do
+        loop.with_index do |_, i|
+          result = yield
+
+          # If a 404, wait a bit longer before raising an error.
+          check_not_found(result, i)
+          return result if done_waiting?(result)
+
+          sleep(wait_secs)
+        end
+      end
+    rescue Timeout::Error
+      Failure(:timeout)
+    end
+
+    def done_waiting?(result)
+      result.success? || (result.failure? && result.failure == :error)
+    end
+
+    def check_not_found(result, index)
+      return unless result.failure? && result.failure == :not_found && index > 2
+
+      raise ResourceNotFound, "Job not found"
+    end
+  end
+end

data/lib/folio_client/token_wrapper.rb

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

data/lib/folio_client/version.rb

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

data/lib/folio_client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/object/blank"
 require "faraday"
 require "singleton"
 require "ostruct"
@@ -49,7 +50,7 @@ class FolioClient
     end
 
     delegate :config, :connection, :get, :post, to: :instance
-    delegate :fetch_hrid, :fetch_marc_hash, :has_instance_status?, to: :instance
+    delegate :fetch_hrid, :fetch_marc_hash, :has_instance_status?, :data_import, to: :instance
   end
 
   attr_accessor :config
@@ -58,21 +59,35 @@ class FolioClient
   # @param path [String] the path to the Folio API request
   # @param request [Hash] params to get to the API
   def get(path, params = {})
-    response = connection.get(path, params, {"x-okapi-token": config.token})
+    response = TokenWrapper.refresh(config, connection) do
+      connection.get(path, params, {"x-okapi-token": config.token})
+    end
 
     UnexpectedResponse.call(response) unless response.success?
 
+    return nil if response.body.blank?
+
     JSON.parse(response.body)
   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 request [json] request body to post to the API
-  def post(path, request = nil)
-    response = connection.post(path, request, {"x-okapi-token": config.token})
+  # @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
+      req_headers = {
+        "x-okapi-token": config.token,
+        "content-type": content_type
+      }
+      connection.post(path, req_body, req_headers)
+    end
 
     UnexpectedResponse.call(response) unless response.success?
 
+    return nil if response.body.blank?
+
     JSON.parse(response.body)
   end
 
@@ -85,25 +100,27 @@ class FolioClient
   end
 
   # Public methods available on the FolioClient below
-  # Wrap methods in `TokenWrapper` to ensure a new token is fetched automatically if expired
   def fetch_hrid(...)
-    TokenWrapper.refresh(config, connection) do
-      inventory = Inventory.new(self)
-      inventory.fetch_hrid(...)
-    end
+    Inventory
+      .new(self)
+      .fetch_hrid(...)
   end
 
   def fetch_marc_hash(...)
-    TokenWrapper.refresh(config, connection) do
-      source_storage = SourceStorage.new(self)
-      source_storage.fetch_marc_hash(...)
-    end
+    SourceStorage
+      .new(self)
+      .fetch_marc_hash(...)
   end
 
   def has_instance_status?(...)
-    TokenWrapper.refresh(config, connection) do
-      inventory = Inventory.new(self)
-      inventory.has_instance_status?(...)
-    end
+    Inventory
+      .new(self)
+      .has_instance_status?(...)
+  end
+
+  def data_import(...)
+    DataImport
+      .new(self)
+      .import(...)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: folio_client
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Peter Mangiafico
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-28 00:00:00.000000000 Z
+date: 2023-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -58,6 +58,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: marc
+  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
+    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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -162,7 +190,9 @@ files:
 - folio_client.gemspec
 - lib/folio_client.rb
 - lib/folio_client/authenticator.rb
+- lib/folio_client/data_import.rb
 - lib/folio_client/inventory.rb
+- lib/folio_client/job_status.rb
 - lib/folio_client/source_storage.rb
 - lib/folio_client/token_wrapper.rb
 - lib/folio_client/unexpected_response.rb
@@ -189,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.5
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Interface for interacting with the Folio ILS API.