folio_client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb2abde077e892ded8a30319b08e773915d646d5c0193b8080789a49c73014e6
-  data.tar.gz: 9a8de9e86652903db4068919af862d08abfa9a0cd86fea4d78500d206620fa25
+  metadata.gz: 960e3e0d138665bbf21b4f609fb7c789c52110101bf303c42ba2c98b93583b98
+  data.tar.gz: b2690e1193c7391a6e4bd6bae4c4f417f395ed91faa50d6215c43e1fc39aaadd
 SHA512:
-  metadata.gz: b187b89f764fce8d797f3caa2b654f08895868cfa2732b049b3e40c30439ddc4f38aae1ae77f7f8ab0e433844c600ab615daa72d12a7768f261d2f44e232d897
-  data.tar.gz: f7244e622f86eb96c8562baa62781c30cebc9909060945eac932b9ed8bcb3e3e08e6ba8578b1bd7712ac7964c3c7df630b2dffed8ed59708ee59cad1859b247a
+  metadata.gz: 42cbfadefe92754026e08435bd06378e6dee17ae97e539bd9d71d7833e873c02194ad1762690b55087f002f5fca553f63579a981dfe915674ee95fb8e839bbf2
+  data.tar.gz: 4e2067aa01d4cd2534079cc9a5d11834d73432cd05c209fc57553713ec7d07a27dcf458ec52cace086fab3971d0fe3b9048e3e30e0669d3736d2ea37dcd0589b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    folio_client (0.2.0)
+    folio_client (0.3.0)
       activesupport (>= 4.2, < 8)
       faraday
       zeitwerk
@@ -66,7 +66,7 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.26.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.0)
+    rubocop-capybara (2.17.1)
       rubocop (~> 1.41)
     rubocop-performance (1.15.2)
       rubocop (>= 1.7.0, < 2.0)
@@ -97,6 +97,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-darwin-20
   x86_64-linux
 
 DEPENDENCIES

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/token_wrapper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class FolioClient
+  # Wraps API operations to request new access token if expired
+  class TokenWrapper
+    def self.refresh(config, connection)
+      yield
+    rescue UnexpectedResponse::UnauthorizedError
+      config.token = Authenticator.token(config.login_params, connection)
+      yield
+    end
+  end
+end

data/lib/folio_client/unexpected_response.rb

@@ -6,9 +6,12 @@ class FolioClient
     # Error raised by the Folio Auth API returns a 422 Unauthorized
     class UnauthorizedError < StandardError; end
 
-    # Error raised when the Folio API returns a 404 NotFound
+    # Error raised when the Folio API returns a 404 NotFound, or returns 0 results when one was expected
     class ResourceNotFound < StandardError; end
 
+    # Error raised when e.g. exactly one result was expected, but more than one was returned
+    class MultipleResourcesFound < StandardError; end
+
     # Error raised when the Folio API returns a 403 Forbidden
     class ForbiddenError < StandardError; end
 
@@ -18,6 +21,8 @@ class FolioClient
     # @param [Faraday::Response] response
     def self.call(response)
       case response.status
+      when 401
+        raise UnauthorizedError, "There was a problem with the access token: #{response.body}"
       when 403
         raise ForbiddenError, "The operation requires privileges which the client does not have: #{response.body}"
       when 404

data/lib/folio_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class FolioClient
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 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
@@ -66,8 +66,19 @@ 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(...)
-    inventory = Inventory.new(self)
-    inventory.fetch_hrid(...)
+    TokenWrapper.refresh(config, connection) do
+      inventory = Inventory.new(self)
+      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.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Mangiafico
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -163,6 +163,8 @@ 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
 homepage: https://github.com/sul-dlss/folio_client
@@ -187,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.