folio_api_client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 954b7e6b1e48039f364a809e5106625b64d86befca6cfb581b044395b793cc4b
-  data.tar.gz: afa3897ee6b420e72e38cced7c3206d9bdefed076214a3bea7216b6abf5bb2e1
+  metadata.gz: b1529c6d23ad243ce9503b24965a0afc4db6abd28a6cea7aae1000b42b5a19b0
+  data.tar.gz: 8da619e1c7614fe9bf46951af5ee6c086467ec90869d0f32ba9803584b65487a
 SHA512:
-  metadata.gz: a3ed8ef0912573e43adc2263ab65e5096f06bdd6118946fa5e2b9276bdd17e2ea9e88fe98027c1d0d2040a30036afff7ff009d70ee8bf87c11e2be87912e7ce4
-  data.tar.gz: 8ff84094f0a2be25a608e313bd29369d3f72a295be31903aa97b261c041fcd4361c4690c2fb609766670b9ed3dd74473aa19dc3c27142eccaa188c2f9bcddcbb
+  metadata.gz: c6196344ec464f39dfdd0b44dbd269f3b949a630c7a41d449961a73091f494ad1d49edff1eb39d2f79b4d36ee0b9f6456257cb2ca645a4d8d1a4c8f0b3c50cd0
+  data.tar.gz: 064356b0fe0d418128ae36d101005229d3eb766f89a62456a6b024bedb5a9d748e42335177918985c34a2bef7ed4a0168c54f38b6bea58a5fd2ed3b0508e86f4

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
 

data/lib/folio_api_client/exceptions.rb

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

data/lib/folio_api_client/finders.rb

@@ -0,0 +1,38 @@
+# 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
+
+    def find_marc_record(instance_record_id:)
+      source_record_search_results = self.get('/source-storage/source-records', { instanceId: instance_record_id })
+      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
+  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.2.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.2.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: []