folio_client 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba0a7a402a239866f9e2e3aaeae1a7a3fa4f113a97aa5fac4b5f8a54037fb734
-  data.tar.gz: 4184b99c342fe2d9d01ab7763f2fc8407f93f70a8370e44552e1a639ac1753fb
+  metadata.gz: db6b3bd02eac883e93ca7a24725f1c3d4f1ef48b34a3aa6e9326070e1903f600
+  data.tar.gz: e2592286592f8fe064b326373dc3f8ca3123a7fa775fedcb23f00da97dc58638
 SHA512:
-  metadata.gz: 9a1a19fbfe4e6dfe76e30ba00fe22873cfcd96f7df5241db8118d5ed8d7b16812e03bed56653418bf6883acf1447dd8fc93364d3adf5703fac31468fcbc83055
-  data.tar.gz: f1b8d6af99291e0d4a2c12a2fb7831cef7ba7587c6f979c5ae764b77c665860b6115fee27cd0f18cbabfc3a553385d64728297c07ce3999478f094fa143d9035
+  metadata.gz: 7ee03f5f2ae933bab57d6a3c6b2be09d7933b98f51ea66c07ffb09e821c4a5c9a08564125c01cd0858a4347465f8e588314b25bc26296851e61e593f8e1c42bd
+  data.tar.gz: '0170689c2a3d9bd2547b976cd43b7258cc3dd6c51a5a8caba9ba62774d3425e62f624024c155d3b728a7dea8df30bce23ee7f111f628c5c1649c8327891e1cc9'

data/.rubocop/custom.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.0
   DisplayCopNames: true
   SuggestExtensions: false
   Exclude:

data/Gemfile.lock

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

data/README.md

@@ -5,7 +5,7 @@
 
 # FolioClient
 
-FolioClient is a Ruby gem that acts as a client to the RESTful HTTP APIs provided by the Folio ILS API.
+FolioClient is a Ruby gem that acts as a client to the RESTful HTTP APIs provided by the Folio ILS API.  It requires ruby 3.0 or better.
 
 ## Installation
 
@@ -19,6 +19,8 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
+The gem should be configured first, and then you can either call API endpoints directly using GET or POST, or more commonly, use the helper methods provided, as described in the section below.
+
 ```ruby
 require 'folio_client'
 
@@ -29,7 +31,9 @@ client = FolioClient.configure(
     okapi_headers: { 'X-Okapi-Tenant': 'sul', 'User-Agent': 'FolioApiClient' }
 )
 
-response = client.get('/organizations/organizations')
+response = client.get('/organizations/organizations', {query_string_param: 'abcdef'})
+
+response = client.post('/some/post/endpoint', params_hash.to_json)
 ```
 
 Note that the settings will live in the consumer of this gem and would typically be used like this:
@@ -44,6 +48,30 @@ client = FolioClient.configure(
 )
 ```
 
+The client is smart enough to automatically request a new token if it detects the one it is using has expired.  If for some reason, you want to immediately request a new token, you can do this:
+
+```ruby
+client.config.token = FolioClient::Authenticator.token(client.config.login_params, client.connection)
+```
+
+## API Coverage
+
+FolioClient provides a number of methods to simplify connecting to the RESTful HTTP API of the Folio API. In this section we list all of the available methods, reflecting how much of the API the client covers.  Note that this assumes the client has already been configured, as described above.  See dor-services-app for an example of configuration and usage.
+
+```ruby
+# Lookup an instance hrid given a barcode
+# returns a string if found, nil if nothing found
+client.fetch_hrid(barcode: "12345")
+ => "a7927874"
+
+# Request a MARC record given an instance hrid
+# returns a hash if found; raises FolioClient::UnexpectedResponse::ResourceNotFound if instance_hrid not found
+client.fetch_marc_hash(instance_hrid: "a7927874")
+ => {"fields"=>
+  [{"003"=>"FOLIO"}....]
+  }
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/folio_client/token_wrapper.rb

@@ -4,7 +4,7 @@ class FolioClient
   # Wraps API operations to request new access token if expired
   class TokenWrapper
     def self.refresh(config, connection)
-      yield
+      yield.tap { |response| UnexpectedResponse.call(response) unless response.success? }
     rescue UnauthorizedError
       config.token = Authenticator.token(config.login_params, connection)
       yield

data/lib/folio_client/version.rb

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

data/lib/folio_client.rb

@@ -41,7 +41,7 @@ class FolioClient
     # @param login_params [Hash] the folio client login params (username:, password:)
     # @param okapi_headers [Hash] the okapi specific headers to add (X-Okapi-Tenant:, User-Agent:)
     def configure(url:, login_params:, okapi_headers:)
-      instance.config = OpenStruct.new(url:, login_params:, okapi_headers:, token: nil)
+      instance.config = OpenStruct.new(url: url, login_params: login_params, okapi_headers: okapi_headers, token: nil)
 
       instance.config.token = Authenticator.token(login_params, connection)
 
@@ -58,7 +58,9 @@ class FolioClient
   # @param path [String] the path to the Folio API request
   # @param request [Hash] params to get to the API
   def get(path, params = {})
-    response = connection.get(path, params, {"x-okapi-token": config.token})
+    response = TokenWrapper.refresh(config, connection) do
+      connection.get(path, params, {"x-okapi-token": config.token})
+    end
 
     UnexpectedResponse.call(response) unless response.success?
 
@@ -69,7 +71,9 @@ class FolioClient
   # @param path [String] the path to the Folio API request
   # @param request [json] request body to post to the API
   def post(path, request = nil)
-    response = connection.post(path, request, {"x-okapi-token": config.token})
+    response = TokenWrapper.refresh(config, connection) do
+      connection.post(path, request, {"x-okapi-token": config.token})
+    end
 
     UnexpectedResponse.call(response) unless response.success?
 
@@ -85,25 +89,18 @@ 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(...)
-    TokenWrapper.refresh(config, connection) do
-      inventory = Inventory.new(self)
-      inventory.fetch_hrid(...)
-    end
+    inventory = Inventory.new(self)
+    inventory.fetch_hrid(...)
   end
 
   def fetch_marc_hash(...)
-    TokenWrapper.refresh(config, connection) do
-      source_storage = SourceStorage.new(self)
-      source_storage.fetch_marc_hash(...)
-    end
+    source_storage = SourceStorage.new(self)
+    source_storage.fetch_marc_hash(...)
   end
 
   def has_instance_status?(...)
-    TokenWrapper.refresh(config, connection) do
-      inventory = Inventory.new(self)
-      inventory.has_instance_status?(...)
-    end
+    inventory = Inventory.new(self)
+    inventory.has_instance_status?(...)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: folio_client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Peter Mangiafico
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-27 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport