folio_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10e1bbd3e3daa19c4149d5a44e143a76b4a9f6eee076bf9930b93f8ccb0e6dba
+  data.tar.gz: 65cc43463f69c41fbebfb4b3cdfab5155b6acb1c86fa77c05834fbd3f4ff681c
+SHA512:
+  metadata.gz: 61e6b573661efa4008d7b9171242c0f50a465cccf875dd3c1cb2fd61b9cbf663fe0de8a464d0fe785d4955c09ce0080bb07ad0ce2ca75f74b9252c96367e80cc
+  data.tar.gz: 25ed05f11889b0cd4bb2ad72eb7ce03b6e68948ab45733f370b6af026eae5021be6259503ff359749836a776aeed8ef4a77d9eddc299df642a9d5a66bab96f4e

data/.rspec

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

data/.rubocop/custom.yml

@@ -0,0 +1,42 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  DisplayCopNames: true
+  SuggestExtensions: false
+  Exclude:
+    - bin/**
+    - vendor/bundle/**/*
+
+# Per team developer playbook
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/BeEq: # new in 2.9.0
+  Enabled: true
+RSpec/BeNil: # new in 2.9.0
+  Enabled: true
+RSpec/ChangeByZero: # new in 2.11
+  Enabled: true
+RSpec/ClassCheck: # new in 2.13
+  Enabled: true
+RSpec/ExcessiveDocstringSpacing: # new in 2.5
+  Enabled: true
+RSpec/IdenticalEqualityAssertion: # new in 2.4
+  Enabled: true
+RSpec/NoExpectationExample: # new in 2.13
+  Enabled: true
+RSpec/SortMetadata: # new in 2.14
+  Enabled: true
+RSpec/SubjectDeclaration: # new in 2.5
+  Enabled: true
+RSpec/VerifiedDoubleReference: # new in 2.10.0
+  Enabled: true
+RSpec/FactoryBot/ConsistentParenthesesStyle: # new in 2.14
+  Enabled: true
+RSpec/FactoryBot/SyntaxMethods: # new in 2.7
+  Enabled: true
+RSpec/Rails/AvoidSetupHook: # new in 2.4
+  Enabled: true
+RSpec/Rails/HaveHttpStatus: # new in 2.12
+  Enabled: true
+RSpec/Rails/InferredSpecType: # new in 2.14
+  Enabled: true

data/.rubocop.yml

@@ -0,0 +1,15 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - standard
+
+inherit_gem:
+  standard: config/base.yml
+
+inherit_from:
+  - .rubocop/custom.yml
+  - .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,30 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-02-10 00:58:06 UTC using RuboCop version 1.44.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 20
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'lib/folio_client.rb'
+    - 'spec/folio_client/authenticator_spec.rb'
+    - 'spec/folio_client_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: be, be_nil
+RSpec/BeNil:
+  Exclude:
+    - 'spec/folio_client_spec.rb'
+
+# Offense count: 1
+RSpec/MultipleExpectations:
+  Max: 3

data/.standard.yml

@@ -0,0 +1 @@
+parallel: true

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in folio_client.gemspec
+gemspec
+
+gem "byebug"

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    folio_client (0.1.0)
+      activesupport (>= 4.2, < 8)
+      faraday
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    concurrent-ruby (1.2.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.17.0)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    standard (1.23.0)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.44.1)
+      rubocop-performance (= 1.15.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  folio_client!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop-rspec
+  simplecov
+  standard
+  webmock
+
+BUNDLED WITH
+   2.4.5

data/LICENSE

@@ -0,0 +1,15 @@
+
+Copyright (c) 2023 by The Board of Trustees of the Leland Stanford
+Junior University.  All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you
+may not use this file except in compliance with the License.  You
+may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied.  See the License for the specific language governing
+permissions and limitations under the License.

data/README.md

@@ -0,0 +1,55 @@
+[![Gem Version](https://badge.fury.io/rb/folio_client.svg)](https://badge.fury.io/rb/folio_client)
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/sul-dlss/folio_client/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/sul-dlss/folio_client/tree/main)
+[![Code Climate](https://api.codeclimate.com/v1/badges/34dd73ba47058709c666/maintainability)](https://codeclimate.com/github/sul-dlss/folio_client/maintainability)
+[![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/34dd73ba47058709c666/test_coverage)](https://codeclimate.com/github/sul-dlss/folio_client/test_coverage)
+
+# FolioClient
+
+FolioClient is a Ruby gem that acts as a client to the RESTful HTTP APIs provided by the Folio ILS API.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add folio_client
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install folio_client
+
+## Usage
+
+```ruby
+require 'folio_client'
+
+# this will configure the client and request an access token
+client = FolioClient.configure(
+    url: 'https://okapi-dev.stanford.edu',
+    login_params: { username: 'xxx', password: 'yyy' },
+    okapi_headers: { 'X-Okapi-Tenant': 'sul', 'User-Agent': 'FolioApiClient' }
+)
+
+response = client.get('/organizations/organizations')
+```
+
+Note that the settings will live in the consumer of this gem and would typically be used like this:
+
+```ruby
+require 'folio_client'
+
+client = FolioClient.configure(
+    url: Settings.okapi.url,
+    login_params: Settings.okapi.login_params,
+    okapi_headers: Settings.okapi.headers
+)
+```
+
+## 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 install this gem onto your local machine, run `bundle exec rake install`. To release a new version, 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/sul-dlss/folio_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/folio_client.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "folio_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "folio_client"
+  spec.version = FolioClient::VERSION
+  spec.authors = ["Peter Mangiafico"]
+  spec.email = ["pmangiafico@stanford.edu"]
+
+  spec.summary = "Interface for interacting with the Folio ILS API."
+  spec.description = "This provides API interaction with the Folio ILS API"
+  spec.homepage = "https://github.com/sul-dlss/folio_client"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sul-dlss/folio_client"
+  spec.metadata["changelog_uri"] = "https://github.com/sul-dlss/folio_client/releases"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 4.2", "< 8"
+  spec.add_dependency "faraday"
+  spec.add_dependency "zeitwerk"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "webmock"
+end

data/lib/folio_client/authenticator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class FolioClient
+  # Fetch a token from the Folio API using login_params
+  class Authenticator
+    def self.token(login_params, connection)
+      new(login_params, connection).token
+    end
+
+    def initialize(login_params, connection)
+      @login_params = login_params
+      @connection = connection
+    end
+
+    # Request an access_token
+    def token
+      response = connection.post("/authn/login", login_params.to_json)
+
+      UnexpectedResponse.call(response) unless response.success?
+
+      JSON.parse(response.body)["okapiToken"]
+    end
+
+    attr_reader :login_params, :connection
+  end
+end

data/lib/folio_client/unexpected_response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class FolioClient
+  # Handles unexpected responses when communicating with Folio
+  class UnexpectedResponse
+    # 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
+    class ResourceNotFound < StandardError; end
+
+    # Error raised when the Folio API returns a 403 Forbidden
+    class ForbiddenError < StandardError; end
+
+    # Error raised when the Folio API returns a 500
+    class ServiceUnavailable < StandardError; end
+
+    # @param [Faraday::Response] response
+    def self.call(response)
+      case response.status
+      when 403
+        raise ForbiddenError, "The operation requires privileges which the client does not have: #{response.body}"
+      when 404
+        raise ResourceNotFound, "Endpoint not found or resource does not exist: #{response.body}"
+      when 422
+        raise UnauthorizedError, "There was a problem fetching the access token: #{response.body} "
+      when 500
+        raise ServiceUnavailable, "The remote server returned an internal server error."
+      else
+        raise StandardError, "Unexpected response: #{response.status} #{response.body}"
+      end
+    end
+  end
+end

data/lib/folio_client/version.rb

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

data/lib/folio_client.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/module/delegation"
+require "faraday"
+require "singleton"
+require "ostruct"
+require "zeitwerk"
+
+# Load the gem's internal dependencies: use Zeitwerk instead of needing to manually require classes
+Zeitwerk::Loader.for_gem.setup
+
+# Client for interacting with the Folio API
+class FolioClient
+  include Singleton
+
+  DEFAULT_HEADERS = {
+    accept: "application/json, text/plain",
+    content_type: "application/json"
+  }.freeze
+
+  class << self
+    # @param url [String] the folio API URL
+    # @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.token = Authenticator.token(login_params, connection)
+
+      self
+    end
+
+    delegate :config, :connection, :get, :post, to: :instance
+  end
+
+  attr_accessor :config
+
+  # Send an authenticated get request
+  # @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 })
+
+    UnexpectedResponse.call(response) unless response.success?
+
+    JSON.parse(response.body)
+  end
+
+  # Send an authenticated post request
+  # @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 })
+
+    UnexpectedResponse.call(response) unless response.success?
+
+    JSON.parse(response.body)
+  end
+
+  # the base connection to the Folio API
+  def connection
+    @connection ||= Faraday.new(
+      url: config.url,
+      headers: DEFAULT_HEADERS.merge(config.okapi_headers || {})
+    )
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: folio_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Mangiafico
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This provides API interaction with the Folio ILS API
+email:
+- pmangiafico@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop/custom.yml"
+- ".rubocop_todo.yml"
+- ".standard.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- folio_client.gemspec
+- lib/folio_client.rb
+- lib/folio_client/authenticator.rb
+- lib/folio_client/unexpected_response.rb
+- lib/folio_client/version.rb
+homepage: https://github.com/sul-dlss/folio_client
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sul-dlss/folio_client
+  source_code_uri: https://github.com/sul-dlss/folio_client
+  changelog_uri: https://github.com/sul-dlss/folio_client/releases
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.5
+signing_key:
+specification_version: 4
+summary: Interface for interacting with the Folio ILS API.
+test_files: []