folio_client 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2421b3de04e4754677703bb1012074d586cbce87bd90fe8b3341212ebeffae7
-  data.tar.gz: 54b49208c11498964a494c5c57c0c97ca3a47d71fddef9766ccf1ef4e0c404a2
+  metadata.gz: ba0a7a402a239866f9e2e3aaeae1a7a3fa4f113a97aa5fac4b5f8a54037fb734
+  data.tar.gz: 4184b99c342fe2d9d01ab7763f2fc8407f93f70a8370e44552e1a639ac1753fb
 SHA512:
-  metadata.gz: 6fa88a92dcf548e03d69978c3600cadb33324106871ec1fcd86652e83af86aa14ed2bb3d60725cc74e6fd7291a8e4056b090d71061c04c24425d25a86310e158
-  data.tar.gz: 2094388e4e9c87abf1f09bdee68a05341358365940db25cde91e411e1f929ff1059a481089bde26c5b44398be824eb2300f1480d55ca431a07004fcbef26e0b6
+  metadata.gz: 9a1a19fbfe4e6dfe76e30ba00fe22873cfcd96f7df5241db8118d5ed8d7b16812e03bed56653418bf6883acf1447dd8fc93364d3adf5703fac31468fcbc83055
+  data.tar.gz: f1b8d6af99291e0d4a2c12a2fb7831cef7ba7587c6f979c5ae764b77c665860b6115fee27cd0f18cbabfc3a553385d64728297c07ce3999478f094fa143d9035

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    folio_client (0.4.0)
+    folio_client (0.5.0)
       activesupport (>= 4.2, < 8)
       faraday
       zeitwerk

data/lib/folio_client/inventory.rb

@@ -26,11 +26,11 @@ class FolioClient
 
     # @param hrid [String] folio instance HRID
     # @param status_id [String] uuid for an instance status code
-    # @raise [FolioClient::UnexpectedResponse::ResourceNotFound] if search by hrid returns 0 results
+    # @raise [ResourceNotFound] if search by 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}"})
-      raise FolioClient::UnexpectedResponse::ResourceNotFound, "No matching instance found for #{hrid}" if instance["totalRecords"] == 0
+      raise ResourceNotFound, "No matching instance found for #{hrid}" if instance["totalRecords"] == 0
 
       instance_status_id = instance.dig("instances", 0, "statusId")
 

data/lib/folio_client/source_storage.rb

@@ -17,8 +17,8 @@ class FolioClient
       response_hash = client.get("/source-storage/source-records", {instanceHrid: instance_hrid})
 
       record_count = response_hash["totalRecords"]
-      raise FolioClient::UnexpectedResponse::ResourceNotFound, "No records found for #{instance_hrid}" if record_count.zero?
-      raise FolioClient::UnexpectedResponse::MultipleResourcesFound, "Expected 1 record for #{instance_hrid}, but found #{record_count}" if record_count > 1
+      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"]
     end

data/lib/folio_client/token_wrapper.rb

@@ -5,7 +5,7 @@ class FolioClient
   class TokenWrapper
     def self.refresh(config, connection)
       yield
-    rescue UnexpectedResponse::UnauthorizedError
+    rescue UnauthorizedError
       config.token = Authenticator.token(config.login_params, connection)
       yield
     end

data/lib/folio_client/unexpected_response.rb

@@ -3,24 +3,6 @@
 class FolioClient
   # Handles unexpected responses when communicating with Folio
   class UnexpectedResponse
-    # Base class for all FolioClient errors
-    class FolioClientError < StandardError; end
-
-    # Error raised by the Folio Auth API returns a 422 Unauthorized
-    class UnauthorizedError < FolioClientError; end
-
-    # Error raised when the Folio API returns a 404 NotFound, or returns 0 results when one was expected
-    class ResourceNotFound < FolioClientError; end
-
-    # Error raised when e.g. exactly one result was expected, but more than one was returned
-    class MultipleResourcesFound < FolioClientError; end
-
-    # Error raised when the Folio API returns a 403 Forbidden
-    class ForbiddenError < FolioClientError; end
-
-    # Error raised when the Folio API returns a 500
-    class ServiceUnavailable < FolioClientError; end
-
     # @param [Faraday::Response] response
     def self.call(response)
       case response.status

data/lib/folio_client/version.rb

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

data/lib/folio_client.rb

@@ -13,6 +13,24 @@ Zeitwerk::Loader.for_gem.setup
 class FolioClient
   include Singleton
 
+  # Base class for all FolioClient errors
+  class Error < StandardError; end
+
+  # Error raised by the Folio Auth API returns a 422 Unauthorized
+  class UnauthorizedError < Error; end
+
+  # Error raised when the Folio API returns a 404 NotFound, or returns 0 results when one was expected
+  class ResourceNotFound < Error; end
+
+  # Error raised when e.g. exactly one result was expected, but more than one was returned
+  class MultipleResourcesFound < Error; end
+
+  # Error raised when the Folio API returns a 403 Forbidden
+  class ForbiddenError < Error; end
+
+  # Error raised when the Folio API returns a 500
+  class ServiceUnavailable < Error; end
+
   DEFAULT_HEADERS = {
     accept: "application/json, text/plain",
     content_type: "application/json"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: folio_client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Peter Mangiafico
@@ -189,7 +189,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.