folio_client 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 821d1cc96a7b33ce8c0c8e86c29864175ebfb775ad7c09f0d876d5e52a4a7515
-  data.tar.gz: ed7139af94e9a0be7aa9393cc6dc5477b05630f81efe1ed693f2778e81286211
+  metadata.gz: 4e53de53a53383306d8d102202f46a3d7812fea93d63ba876e4be9f3d31c122a
+  data.tar.gz: 6a923cb74ab603ecba4fc9e909da87fdcd0a2540cbc58dafc381147012ae1a4f
 SHA512:
-  metadata.gz: 31b71ca76d853865aef2752b688d795e2e8d3370febb99371e52d14e44f04f0e00f39d29ae2c8de006cd6cb49a73c8860a7d46bbe084a0c4b80dc119240e9261
-  data.tar.gz: 658f33fa1639211c7139009800e972b59ae19ebb8558a71cbb1d304b5c0a2537c3a089898dcf41d8a74533ee42ab8758e0f59310f76f617b8e46c64875f86a0a
+  metadata.gz: 1bf690f79b82a5ec7c7a53b88867671a389bcae846832971ecb8a07f55f227b3c77761270e1d584207a6c4b1775e00f49d5ddadaea1d10bb6c9ce4a64bbb69b4
+  data.tar.gz: 98520694ded40e076ee49a456f46ad1b2c460c34d247fff9d519f9e5f5f4ae825e1ea2f3a56f7d8118301b14b8ffb02aa12c44cbe7e6106e9b1451f6fe8344fd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    folio_client (0.2.0)
+    folio_client (0.3.1)
       activesupport (>= 4.2, < 8)
       faraday
       zeitwerk
@@ -97,6 +97,8 @@ GEM
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES

data/lib/folio_client/inventory.rb

@@ -11,6 +11,7 @@ class FolioClient
     end
 
     # @param barcode [String] barcode to search by to fetch the HRID
+    # @return [String,nil] 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}"})

data/lib/folio_client/source_storage.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class FolioClient
+  # Lookup records in Folio Source Storage
+  class SourceStorage
+    attr_accessor :client
+
+    # @param client [FolioClient] the configured client
+    def initialize(client)
+      @client = client
+    end
+
+    # @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
+    def fetch_marc_hash(instance_hrid:)
+      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
+
+      response_hash["sourceRecords"].first["parsedRecord"]["content"]
+    end
+  end
+end

data/lib/folio_client/unexpected_response.rb

@@ -3,17 +3,23 @@
 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 < StandardError; end
+    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 the Folio API returns a 404 NotFound
-    class ResourceNotFound < StandardError; 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 < StandardError; end
+    class ForbiddenError < FolioClientError; end
 
     # Error raised when the Folio API returns a 500
-    class ServiceUnavailable < StandardError; end
+    class ServiceUnavailable < FolioClientError; end
 
     # @param [Faraday::Response] response
     def self.call(response)

data/lib/folio_client/version.rb

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

data/lib/folio_client.rb

@@ -31,7 +31,7 @@ class FolioClient
     end
 
     delegate :config, :connection, :get, :post, to: :instance
-    delegate :fetch_hrid, to: :instance
+    delegate :fetch_hrid, :fetch_marc_hash, to: :instance
   end
 
   attr_accessor :config
@@ -74,4 +74,11 @@ class FolioClient
       inventory.fetch_hrid(...)
     end
   end
+
+  def fetch_marc_hash(...)
+    TokenWrapper.refresh(config, connection) do
+      source_storage = SourceStorage.new(self)
+      source_storage.fetch_marc_hash(...)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: folio_client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Peter Mangiafico
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-22 00:00:00.000000000 Z
+date: 2023-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -163,6 +163,7 @@ files:
 - lib/folio_client.rb
 - lib/folio_client/authenticator.rb
 - lib/folio_client/inventory.rb
+- lib/folio_client/source_storage.rb
 - lib/folio_client/token_wrapper.rb
 - lib/folio_client/unexpected_response.rb
 - lib/folio_client/version.rb
@@ -188,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.5
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Interface for interacting with the Folio ILS API.