folio_api_client 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 954b7e6b1e48039f364a809e5106625b64d86befca6cfb581b044395b793cc4b
-  data.tar.gz: afa3897ee6b420e72e38cced7c3206d9bdefed076214a3bea7216b6abf5bb2e1
+  metadata.gz: cd0f25ee382d9468806b7ae7c39a0d7801f43d5e45c7f7bd248565673fe9da23
+  data.tar.gz: e05cb433eb2134c574d2de93a3e9de4cdad6a4c9bd9c6ae3f67483179f64e855
 SHA512:
-  metadata.gz: a3ed8ef0912573e43adc2263ab65e5096f06bdd6118946fa5e2b9276bdd17e2ea9e88fe98027c1d0d2040a30036afff7ff009d70ee8bf87c11e2be87912e7ce4
-  data.tar.gz: 8ff84094f0a2be25a608e313bd29369d3f72a295be31903aa97b261c041fcd4361c4690c2fb609766670b9ed3dd74473aa19dc3c27142eccaa188c2f9bcddcbb
+  metadata.gz: f68f5dab0e5080f62b307c8f72bf2fb75e5d4033f7fb70fdfdd99f749edf821ae2c9d1c697e31f70f8af4e1be60aa55c930c9c9bd494348fbff9fe1e7337e563
+  data.tar.gz: 6cdc0f1d8a571a11599ae906f985f0e2901dedcbc07b8f26f71f316337507693dd22ea0f8a841bbd6083ce6436c5b7dbebe252f4f54d685bb1366c66ec29ebdf

data/README.md

@@ -4,9 +4,15 @@ A Ruby interface for making requests to the FOLIO ILS API (https://folio.org), i
 
 ## Installation
 
-At this time, this gem is only available on GitHub and has not been published to RubyGems yet.  You can include it in your Gemfile using this syntax:
+```bash
+bundle add folio_api_client
+```
+
+If bundler is not being used to manage dependencies, you can install the gem by running:
 
-`gem 'folio_api_client', github: 'cul/folio_api_client', branch: 'main'`
+```bash
+gem install folio_api_client
+```
 
 ## Usage
 
@@ -36,6 +42,14 @@ client.get(path, params)
 client.post(path, body, content_type: 'application/json'))
 client.put(path, body, content_type: 'application/json'))
 client.delete(path, body, content_type: 'application/json'))
+
+# Other convenience methods:
+
+client.find_item_record(barcode: 'some-barcode')
+client.find_location_record(location_id: 'some-location-id')
+client.find_holdings_record(holdings_record_id: 'some-holdings-record-id')
+client.find_instance_record(instance_record_id: 'some-instance-record-id')
+client.find_marc_record(instance_record_id: 'some-instance-record-id') # returns a MARC::Record
 ```
 
 See [https://dev.folio.org/reference/api/](https://dev.folio.org/reference/api/) for the full list of available FOLIO API endpoints.

data/lib/folio_api_client/exceptions.rb

@@ -3,5 +3,7 @@
 class FolioApiClient
   module Exceptions
     class Error < StandardError; end
+    class UnexpectedMultipleRecordsFoundError < Error; end
+    class MissingQueryFieldError < Error; end
   end
 end

data/lib/folio_api_client/finders.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+class FolioApiClient
+  module Finders
+    def find_item_record(barcode:)
+      item_search_results = self.get('/item-storage/items', { query: "barcode==#{barcode}", limit: 2 })['items']
+      return nil if item_search_results.empty?
+
+      if item_search_results.length > 1
+        raise FolioApiClient::Exceptions::UnexpectedMultipleRecordsFoundError,
+              'Only expected one item with this barcode, but found more than one.'
+      end
+
+      item_record_id = item_search_results.first['id']
+      self.get("/item-storage/items/#{item_record_id}")
+    end
+
+    def find_location_record(location_id:)
+      self.get("/locations/#{location_id}")
+    end
+
+    def find_holdings_record(holdings_record_id:)
+      self.get("/holdings-storage/holdings/#{holdings_record_id}")
+    end
+
+    def find_instance_record(instance_record_id:)
+      self.get("/instance-storage/instances/#{instance_record_id}")
+    end
+
+    # Find a MARC::Record by its instance record id or instance record hrid
+    def find_marc_record(instance_record_id: nil, instance_record_hrid: nil)
+      source_record_search_results = self.get(
+        '/source-storage/source-records',
+        marc_record_query(instance_record_id: instance_record_id, instance_record_hrid: instance_record_hrid)
+      )
+      return nil if source_record_search_results['totalRecords'].zero?
+
+      bib_record_marc_hash = source_record_search_results['sourceRecords'].first['parsedRecord']['content']
+      MARC::Record.new_from_hash(bib_record_marc_hash)
+    end
+
+    def marc_record_query(instance_record_id: nil, instance_record_hrid: nil)
+      return { instanceId: instance_record_id } if instance_record_id
+      return { instanceHrid: instance_record_hrid } if instance_record_hrid
+
+      raise FolioApiClient::Exceptions::MissingQueryFieldError,
+            'Missing query field.  Must supply either an instance_record_id or instance_record_hrid.'
+    end
+  end
+end

data/lib/folio_api_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class FolioApiClient
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

data/lib/folio_api_client.rb

@@ -5,9 +5,12 @@ loader = Zeitwerk::Loader.for_gem
 loader.setup # ready!
 
 require 'faraday'
+require 'marc'
 
 # A client used for making http requests (get/post/etc.) to the FOLIO ILS REST API.
 class FolioApiClient
+  include Finders
+
   attr_reader :config
 
   def initialize(config)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: folio_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Eric O'Hanlon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-29 00:00:00.000000000 Z
+date: 2025-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -68,6 +68,7 @@ files:
 - lib/folio_api_client.rb
 - lib/folio_api_client/configuration.rb
 - lib/folio_api_client/exceptions.rb
+- lib/folio_api_client/finders.rb
 - lib/folio_api_client/version.rb
 homepage: https://www.github.com/cul/folio_api_client
 licenses: []