folio_client 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad8e1c9733f1bba9dc63d5f8c19edb7f4b40a7c16084c3f434175582d466d70a
-  data.tar.gz: 32beb6817690d4e95a7ce741fbde1466ccc75b7a13489230b0f1d859af6b7baa
+  metadata.gz: e5e7b3edaad66a7bca966c6316eb979f722fe0eb2336def7f45eda9952a2a5ee
+  data.tar.gz: 7d4d555e56d607acbb4649ef59e94e5ab417ee1f4f78fce2a999864f9e8486ee
 SHA512:
-  metadata.gz: c49e0286404a94fc67bc973b40501885410e5b560e24a922664c2d8e9031766fdfb85af55896cadf21ea8eb91fe85eea6829fa35f7a0645d6a543055c63ef44b
-  data.tar.gz: 6f1deeee160c8625a5c84c68c57cfb35e3d28d16af0b08c4423478dc8026ebc8a637dcda752b21b814169c49970c0d399511d9c79020ead609470c90ecb150f8
+  metadata.gz: ad63a3b363409b8561ca3ecf0f94b05f915ffe8ec621915e692f7d805d1f1c140b7626d2c95d613cc35974c08425a313e33ac72cc3249f68a1b3aece8d182688
+  data.tar.gz: 6e0bfb061e5fafda66cc4690726bb69a17e3ccdd474997bb433d3fa9f02d55f2e6c103edc263ab82e22d69c36960576a7acc5ab73f23b7e6364acee487efb99e

data/.autoupdate/postupdate

@@ -0,0 +1,19 @@
+#!/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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    folio_client (0.10.0)
+    folio_client (0.11.0)
       activesupport (>= 4.2, < 8)
       dry-monads
       faraday
@@ -116,6 +116,7 @@ PLATFORMS
   x86_64-darwin-19
   x86_64-darwin-20
   x86_64-darwin-21
+  x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES

data/lib/folio_client/data_import.rb

@@ -7,6 +7,8 @@ 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
@@ -15,6 +17,7 @@ class FolioClient
     # @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
+    # @return [JobStatus] a job status instance to get information about the data import job
     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")
@@ -38,6 +41,14 @@ 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

data/lib/folio_client/source_storage.rb

@@ -13,7 +13,8 @@ class FolioClient
     # 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)
-    # @raises NotFound, MultipleRecordsForIdentifier
+    # @raise [ResourceNotFound]
+    # @raise [MultipleResourcesFound]
     def fetch_marc_hash(instance_hrid:)
       response_hash = client.get("/source-storage/source-records", {instanceHrid: instance_hrid})
 

data/lib/folio_client/unexpected_response.rb

@@ -12,10 +12,12 @@ class FolioClient
         raise ForbiddenError, "The operation requires privileges which the client does not have: #{response.body}"
       when 404
         raise ResourceNotFound, "Endpoint not found or resource does not exist: #{response.body}"
+      when 409
+        raise ConflictError, "Resource cannot be updated: #{response.body}"
       when 422
-        raise ValidationError, "There was a validation problem with the request: #{response.body} "
+        raise ValidationError, "There was a validation problem with the request: #{response.body}"
       when 500
-        raise ServiceUnavailable, "The remote server returned an internal server error."
+        raise ServiceUnavailable, "The remote server returned an internal server error: #{response.body}"
       else
         raise StandardError, "Unexpected response: #{response.status} #{response.body}"
       end

data/lib/folio_client/version.rb

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

data/lib/folio_client.rb

@@ -35,6 +35,9 @@ class FolioClient
   # Error raised when the Folio API returns a 422 Unprocessable Entity
   class ValidationError < Error; end
 
+  # Error raised when the Folio API returns a 409 Conflict
+  class ConflictError < Error; end
+
   DEFAULT_HEADERS = {
     accept: "application/json, text/plain",
     content_type: "application/json"
@@ -44,24 +47,32 @@ 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:)
-    def configure(url:, login_params:, okapi_headers:)
-      instance.config = OpenStruct.new(url: url, login_params: login_params, okapi_headers: okapi_headers, token: nil)
-
+    def configure(url:, login_params:, okapi_headers:, timeout: default_timeout)
+      instance.config = OpenStruct.new(
+        url: url,
+        login_params: login_params,
+        okapi_headers: okapi_headers,
+        timeout: timeout
+      )
+
+      # NOTE: The token cannot be set above, since `#connection` relies on
+      #       `instance.config` parameters having already been set.
       instance.config.token = Authenticator.token(login_params, connection)
 
       self
     end
 
-    delegate :config, :connection, :get, :post, :put, 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?, :interface_details, :job_profiles, :organization_interfaces,
+      :organizations, :post, :put, to: :instance
   end
 
   attr_accessor :config
 
   # Send an authenticated get request
   # @param path [String] the path to the Folio API request
-  # @param request [Hash] params to get to the API
+  # @param params [Hash] params to get to the API
   def get(path, params = {})
     response = TokenWrapper.refresh(config, connection) do
       connection.get(path, params, {"x-okapi-token": config.token})
@@ -120,7 +131,8 @@ class FolioClient
   def connection
     @connection ||= Faraday.new(
       url: config.url,
-      headers: DEFAULT_HEADERS.merge(config.okapi_headers || {})
+      headers: DEFAULT_HEADERS.merge(config.okapi_headers || {}),
+      request: {timeout: config.timeout}
     )
   end
 
@@ -168,28 +180,42 @@ 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)
       .fetch_interface_details(...)
   end
+
+  def default_timeout
+    120
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: folio_client
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Peter Mangiafico
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-28 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -177,6 +177,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".autoupdate/postupdate"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop/custom.yml"
@@ -205,7 +206,7 @@ metadata:
   source_code_uri: https://github.com/sul-dlss/folio_client
   changelog_uri: https://github.com/sul-dlss/folio_client/releases
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -220,8 +221,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.5
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: Interface for interacting with the Folio ILS API.
 test_files: []