folio_api_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 954b7e6b1e48039f364a809e5106625b64d86befca6cfb581b044395b793cc4b
+  data.tar.gz: afa3897ee6b420e72e38cced7c3206d9bdefed076214a3bea7216b6abf5bb2e1
+SHA512:
+  metadata.gz: a3ed8ef0912573e43adc2263ab65e5096f06bdd6118946fa5e2b9276bdd17e2ea9e88fe98027c1d0d2040a30036afff7ff009d70ee8bf87c11e2be87912e7ce4
+  data.tar.gz: 8ff84094f0a2be25a608e313bd29369d3f72a295be31903aa97b261c041fcd4361c4690c2fb609766670b9ed3dd74473aa19dc3c27142eccaa188c2f9bcddcbb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_gem:
+  rubocul: rubocul_default.yml
+
+AllCops:
+  TargetRubyVersion: 3.2  # Update to your version of ruby
+
+Rails/Output:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/README.md

@@ -0,0 +1,51 @@
+# FolioApiClient
+
+A Ruby interface for making requests to the FOLIO ILS API (https://folio.org), including some convenience methods that have been useful for the Columbia University Libraries.
+
+## 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:
+
+`gem 'folio_api_client', github: 'cul/folio_api_client', branch: 'main'`
+
+## Usage
+
+```
+# Create a client
+client = FolioApiClient.new(FolioApiClient::Configuration.new(
+  url: 'https://development.example.com',
+  username: 'username',
+  password: 'password',
+  tenant: 'abc123',
+  timeout: 10
+))
+
+# Make some requests
+
+instance_record_id = '65e07045-4d68-4a07-835e-33f0c80482ab'
+instance_record_response = client.get("/instance-storage/instances/#{instance_record_id}")
+puts JSON.parse(instance_record_response.body)
+
+holdings_record_id = 'b2e9946b-82fe-4cfb-ad4c-b3c452379dae'
+holdings_record_response = client.get("/holdings-storage/holdings/#{holdings_record_id}")
+puts JSON.parse(holdings_record_response.body)
+
+# Generic request syntax for any FOLIO REST endpoint:
+
+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'))
+```
+
+See [https://dev.folio.org/reference/api/](https://dev.folio.org/reference/api/) for the full list of available FOLIO API endpoints.
+
+## 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.
+
+To release a new version of this gem, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at: https://github.com/cul/folio_api_client

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/folio_api_client/configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class FolioApiClient
+  # Data structure that stores FolioApiClient configuration options.
+  class Configuration
+    DEFAULT_TIMEOUT = 60
+    DEFAULT_USER_AGENT = 'FolioApiClient'
+
+    attr_reader :url, :username, :password, :tenant, :timeout, :user_agent
+    attr_accessor :token
+
+    def initialize(url:, username:, password:, tenant:, timeout: DEFAULT_TIMEOUT, user_agent: DEFAULT_USER_AGENT)
+      @url = url
+      @username = username
+      @password = password
+      @tenant = tenant
+      @timeout = timeout
+      @user_agent = user_agent
+    end
+  end
+end

data/lib/folio_api_client/exceptions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class FolioApiClient
+  module Exceptions
+    class Error < StandardError; end
+  end
+end

data/lib/folio_api_client/version.rb

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

data/lib/folio_api_client.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+loader.setup # ready!
+
+require 'faraday'
+
+# A client used for making http requests (get/post/etc.) to the FOLIO ILS REST API.
+class FolioApiClient
+  attr_reader :config
+
+  def initialize(config)
+    @config = config
+  end
+
+  def headers_for_connection
+    {
+      'Accept': 'application/json, text/plain',
+      'Content-Type': 'application/json',
+      'X-Okapi-Tenant': config.tenant,
+      'User-Agent': config.user_agent
+    }
+  end
+
+  def connection
+    @connection ||= Faraday.new(
+      headers: headers_for_connection,
+      url: config.url,
+      request: { timeout: config.timeout }
+    ) do |faraday|
+      faraday.adapter Faraday.default_adapter
+      faraday.use Faraday::Response::RaiseError
+    end
+  end
+
+  def retrieve_new_auth_token
+    response = connection.post('/authn/login', { username: config.username, password: config.password }.to_json)
+    response_data = JSON.parse(response.body)
+    response_data['okapiToken']
+  end
+
+  def refresh_auth_token!
+    config.token = retrieve_new_auth_token
+  end
+
+  def with_token_refresh_attempt_when_unauthorized
+    refresh_auth_token! if config.token.nil?
+    yield
+  rescue Faraday::UnauthorizedError, Faraday::ForbiddenError
+    # Tokens are sometimes invalidated by FOLIO data refreshes, so we'll attempt to refresh our token
+    # one time in responde to a 401 or 403.
+    refresh_auth_token!
+
+    # Re-run block
+    yield
+  end
+
+  def get(path, params = {})
+    response = with_token_refresh_attempt_when_unauthorized do
+      connection.get(path, params, { 'x-okapi-token': config.token })
+    end
+
+    JSON.parse(response.body)
+  end
+
+  def exec_request_with_body(method, path, body = nil, content_type: 'application/json')
+    body = body.to_json if content_type == 'application/json' && !body.is_a?(String)
+    response = with_token_refresh_attempt_when_unauthorized do
+      connection.send(method, path, body, { 'x-okapi-token': config.token, 'content-type': content_type })
+    end
+
+    response.body.nil? ? nil : JSON.parse(response.body)
+  end
+
+  def post(path, body = nil, content_type: 'application/json')
+    exec_request_with_body(:post, path, body, content_type: content_type)
+  end
+
+  def put(path, body = nil, content_type: 'application/json')
+    exec_request_with_body(:put, path, body, content_type: content_type)
+  end
+
+  def delete(path, body = nil, content_type: 'application/json')
+    exec_request_with_body(:delete, path, body, content_type: content_type)
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: folio_api_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric O'Hanlon
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: marc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: This gem provides an interface for making requests to the FOLIO ILS API,
+  and makes session management easier.
+email:
+- elo2112@columbia.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- README.md
+- Rakefile
+- lib/folio_api_client.rb
+- lib/folio_api_client/configuration.rb
+- lib/folio_api_client/exceptions.rb
+- lib/folio_api_client/version.rb
+homepage: https://www.github.com/cul/folio_api_client
+licenses: []
+metadata:
+  homepage_uri: https://www.github.com/cul/folio_api_client
+  source_code_uri: https://www.github.com/cul/folio_api_client
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A Ruby interface for making requests to the FOLIO ILS API.
+test_files: []