folio_client 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 726191de10d2f5974ac8294f2c4f93a75146631dd2c86200d2de53f9c72cd76f
-  data.tar.gz: 2ec95c6e87c4541fb1b2b7050c2bd84d5bd3a46f948b0b711b8f042f58ddf6e5
+  metadata.gz: f400cbad25cc1f7a7a4af985a510c597af5dea7b18cf636d5e6cb8196b4ef059
+  data.tar.gz: 26d9485bebd8780fafe498b15827575703316c229ed8c35e361aee3246ee70fd
 SHA512:
-  metadata.gz: ce0de774a34bbc7eda7a97d26e9ac12d49297a804994425045fe7a8b85017401f54dd11fd43952e4f75e799e232979475f3881eb6f9a211e6f4e32df48168424
-  data.tar.gz: eb31f66db330ab973060794cfcfb30471c02d21529c5242f62fc11a5d97542f1ce13587af5f8d6b2057d5b709951f9c49690725937e39f3d84236df144da3b73
+  metadata.gz: 472ca9f6c928aa3353b8f928cce63030329e62a7c26655700aaaef6c835e777f58d0771c8b58d8bfd50ee59a7c2c1724063246884ab529556b7cd92ee2065dfd
+  data.tar.gz: 2add95c0f3492db0c80f1770c40576d7bbac019a31674a9b0124a47706b065e1b02e67735519dddc2cf4f832216d453ddb3126906a4c89f4d4eac1f59c70fd6d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    folio_client (0.8.0)
+    folio_client (0.9.0)
       activesupport (>= 4.2, < 8)
       dry-monads
       faraday
@@ -11,7 +11,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.2)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -67,21 +67,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.44.1)
+    rubocop (1.48.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.27.0)
       parser (>= 3.2.1.0)
     rubocop-capybara (2.17.1)
       rubocop (~> 1.41)
-    rubocop-performance (1.15.2)
+    rubocop-performance (1.16.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rspec (2.19.0)
@@ -96,10 +96,10 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.24.3)
+    standard (1.25.2)
       language_server-protocol (~> 3.17.0.2)
-      rubocop (= 1.44.1)
-      rubocop-performance (= 1.15.2)
+      rubocop (= 1.48.1)
+      rubocop-performance (= 1.16.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)

data/README.md

@@ -65,13 +65,13 @@ client.fetch_hrid(barcode: "12345")
  => "a7927874"
 
 # Request a MARC record given an instance hrid
-# returns a hash if found; raises FolioClient::UnexpectedResponse::ResourceNotFound if instance_hrid not found
+# returns a hash if found; raises FolioClient::ResourceNotFound if instance_hrid not found
 client.fetch_marc_hash(instance_hrid: "a7927874")
  => {"fields"=>
   [{"003"=>"FOLIO"}....]
   }
 
-# Import a MARC record
+# Import a MARC record into FOLIO
 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

data/lib/folio_client/holdings.rb

@@ -6,12 +6,13 @@ class FolioClient
     attr_accessor :client, :instance_id
 
     # @param client [FolioClient] the configured client
-    # @param instance_id [String] the UUID of the instance to which the holdings records belongs
+    # @param instance_id [String] the UUID of the instance to which the holdings record belongs
     def initialize(client, instance_id:)
       @client = client
       @instance_id = instance_id
     end
 
+    # create a holdings record for the instance
     # @param permanent_location_id [String] the UUID of the permanent location
     # @param holdings_type_id [String] the UUID of the holdings type
     def create(holdings_type_id:, permanent_location_id:)

data/lib/folio_client/inventory.rb

@@ -10,8 +10,9 @@ class FolioClient
       @client = client
     end
 
-    # @param barcode [String] barcode to search by to fetch the HRID
-    # @return [String,nil] HRID if present, otherwise nil.
+    # 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}"})
@@ -24,8 +25,9 @@ class FolioClient
       result.dig("hrid")
     end
 
-    # @param hrid [String] HRID to search by to fetch the external ID
-    # @return [String,nil] external ID if present, otherwise nil.
+    # get instance external ID from HRID
+    # @param hrid [String] instance HRID
+    # @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}"})
@@ -36,11 +38,11 @@ class FolioClient
       instance_response.dig("instances", 0, "id")
     end
 
-    # Retrieve basic information about a record.  Example usage: get the external ID and _version for update using
+    # Retrieve basic information about a instance record.  Example usage: get the external ID and _version for update using
     #  optimistic locking when the HRID is available: `fetch_instance_info(hrid: 'a1234').slice('id', '_version')`
     #  (or vice versa if the external ID is available).
-    # @param external_id [String] an external ID for looking up info about the record
-    # @param hrid [String] an HRID for looking up info about the record
+    # @param external_id [String] an external ID for the desired instance record
+    # @param hrid [String] an instance HRID for the desired instance record
     # @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)
@@ -51,9 +53,10 @@ class FolioClient
       client.get("/inventory/instances/#{external_id}")
     end
 
-    # @param hrid [String] folio instance HRID
+    # @param hrid [String] instance HRID
     # @param status_id [String] uuid for an instance status code
-    # @raise [ResourceNotFound] if search by hrid returns 0 results
+    # @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:)
       # get the instance record and its statusId
       instance = client.get("/inventory/instances", {query: "hrid==#{hrid}"})

data/lib/folio_client/job_status.rb

@@ -87,7 +87,7 @@ class FolioClient
     def check_not_found(result, index)
       return unless result.failure? && result.failure == :not_found && index > 2
 
-      raise ResourceNotFound, "Job not found"
+      raise ResourceNotFound, "Job #{job_execution_id} not found after #{index} retries"
     end
   end
 end

data/lib/folio_client/source_storage.rb

@@ -10,6 +10,7 @@ class FolioClient
       @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)
     # @raises NotFound, MultipleRecordsForIdentifier

data/lib/folio_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: folio_client
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Peter Mangiafico
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2023-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -206,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
@@ -222,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Interface for interacting with the Folio ILS API.
 test_files: []