evergreen-ils 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4a950c35117be9bb820cc29a6c51a7b6d617182cea54d5fc83449dd02654e13
+  data.tar.gz: 44124d0b23d86d2da8d60a5e169ead1d23ab98238cffd16e1be5dbb149350971
+SHA512:
+  metadata.gz: 6085835b66450141c9a330cc7b98f8e8e9b61e6d31779bcb4f0e974864a0a8942c78c5dc493c42216f8b827ad6559ac35bf286b3cdfd0fab5568fe9b04a5a402
+  data.tar.gz: 5ce0821e80d4ce4dd4d08c39685311a98edbe98edca5859724e4d5d589f8f3cbcf27ba1f51fdee503426eb42c8d33abfd705c23ffd87220a73e06583a95d47e3

data/.reek.yml

@@ -0,0 +1,23 @@
+# Auto generated by Reeks --todo flag
+---
+detectors:
+  Attribute:
+    exclude:
+    - Evergreen::Configuration#default_password
+    - Evergreen::Configuration#default_username
+    - Evergreen::Configuration#host
+    - Evergreen::Configuration#read_only
+  FeatureEnvy:
+    exclude:
+    - Evergreen::Configuration#field_is_empty
+  LongParameterList:
+    exclude:
+    - Evergreen::IDL::IDLSaxHandler#start_element
+  NilCheck:
+    exclude:
+    - Evergreen::Configuration#field_is_empty
+  UtilityFunction:
+    exclude:
+    - Evergreen#initialize
+exclude_paths:
+  - spec

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,12 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - 'sig/**/*'
+    - 'vendor/**/*'
+  SuggestExtensions: false
+RSpec/ExampleLength:
+  Max: 10

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.1

data/Gemfile

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in evergreen-ils.gemspec
+gemspec
+
+gem 'rake'
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+end
+
+group :check do
+  gem 'flay'
+  gem 'flog'
+  gem 'rbs'
+  gem 'reek'
+  gem 'rubocop', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rspec', require: false
+  gem 'steep'
+end
+
+group :development do
+  gem 'debug'
+end

data/Gemfile.lock

@@ -0,0 +1,180 @@
+PATH
+  remote: .
+  specs:
+    evergreen-ils (0.2.0)
+      marc (>= 1.0.0, < 2.0)
+      rexml (>= 3.0.0, < 4.0)
+      zeitwerk (>= 2.0.0, < 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    csv (3.2.7)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    ffi (1.15.5)
+    ffi (1.15.5-java)
+    fileutils (1.7.1)
+    flay (2.13.1)
+      erubi (~> 1.10)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.7.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
+    hashdiff (1.0.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    io-console (0.6.0-java)
+    irb (1.7.4)
+      reline (>= 0.3.6)
+    json (2.6.3)
+    json (2.6.3-java)
+    kwalify (0.7.2)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.5.3)
+    marc (1.2.0)
+      rexml
+      scrub_rb (>= 1.0.1, < 2)
+      unf
+    minitest (5.19.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    path_expander (1.1.1)
+    public_suffix (5.0.3)
+    racc (1.7.1)
+    racc (1.7.1-java)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (3.1.3)
+    reek (6.1.4)
+      kwalify (~> 0.7.0)
+      parser (~> 3.2.0)
+      rainbow (>= 2.0, < 4.0)
+    regexp_parser (2.8.1)
+    reline (0.3.7)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.55.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.23.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    ruby_parser (3.20.3)
+      sexp_processor (~> 4.16)
+    scrub_rb (1.0.1)
+    securerandom (0.2.2)
+    sexp_processor (4.17.0)
+    steep (1.5.2)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.1.10)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 3.1.0)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 4)
+    strscan (3.0.6)
+    strscan (3.0.6-java)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf (0.1.4-java)
+    unf_ext (0.0.8.2)
+    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.11)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+  universal-java-11
+  x86_64-linux
+
+DEPENDENCIES
+  debug
+  evergreen-ils!
+  flay
+  flog
+  rake
+  rbs
+  reek
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  steep
+  webmock
+
+BUNDLED WITH
+   2.4.6

data/README.md

@@ -0,0 +1,68 @@
+# Evergreen
+
+A gem for interacting with [Evergreen ILS](https://evergreen-ils.org)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add evergreen-ils
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install evergreen-ils
+
+## Usage
+
+### Configuration
+
+Configure your `Evergreen` object with a hostname, and any other relevant
+options.  If using Rails, you might create an Evergreen service:
+
+```
+class EvergreenService
+  attr_reader :evergreen
+  def initialize
+    @evergreen ||= Evergreen.new do |config|
+      config.host = 'my.evergreen.server'
+      config.default_username = 'user1'
+      config.default_username = ENV['my_pass']
+      config.read_only = false
+    end
+  end
+end
+```
+
+You can then access those configurations in your app at
+`service.evergreen.configuration.host`.
+
+### Retrieving objects
+
+Once you have an object:
+
+```
+Evergreen.new(host: 'my.evergreen.server') do |evergreen|
+  bib = evergreen.get_bib_record(123)
+  bib.to_marc
+  evergreen.get_item(345)
+  evergreen.get_call_number(2345)
+end
+```
+
+
+## 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).
+
+## Goals
+
+The priorities here are:
+* Thread safety
+* Good documentation
+* Good tests
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sandbergja/evergreen-rb.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/Steepfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# D = Steep::Diagnostic
+#
+target :lib do
+  signature 'sig'
+
+  check 'lib'
+
+  library 'json', 'net-http', 'uri'
+
+  ignore 'lib/evergreen.rb'
+  ignore 'lib/evergreen/bib_record.rb'
+  ignore 'lib/evergreen/connection.rb'
+  ignore 'lib/evergreen/idl.rb'
+  ignore 'lib/evergreen/mixins'
+  ignore 'lib/opensrf/http_translator_request.rb'
+end

data/evergreen-ils.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/evergreen/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'evergreen-ils'
+  spec.version = Evergreen::VERSION
+  spec.authors = ['Jane Sandberg']
+  spec.email = ['sandbergja@gmail.com']
+
+  spec.summary = 'Evergreen ILS'
+  spec.description = 'A gem for interacting with the Evergreen Integrated Library System'
+  spec.homepage = 'https://github.com/sandbergja/evergreen-rb'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/sandbergja/evergreen-rb'
+
+  # 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|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'marc', '>= 1.0.0', '< 2.0'
+  spec.add_dependency 'rexml', '>= 3.0.0', '< 4.0'
+  spec.add_dependency 'zeitwerk', '>= 2.0.0', '< 3.0'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/evergreen/bib_record.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'marc'
+require 'stringio'
+
+class Evergreen
+  # A bibliographic record (title)
+  class BibRecord < IDLObject
+    include Mixins::AnonymousPcrud
+    def initialize(id:, configuration:, idl:)
+      @id = id
+      @configuration = configuration
+      super(idl)
+    end
+
+    # rubocop:disable Naming/MemoizedInstanceVariableName
+    def to_marc
+      @marc ||= MARC::XMLReader.new(StringIO.new(get('marc'))).first
+    end
+    # rubocop:enable Naming/MemoizedInstanceVariableName
+
+    def holdings
+      payload = OpenSRF::ClassAndData.new(klass: 'osrfMessage', data: {
+                                            'method' => 'open-ils.cat.asset.copy_tree.global.retrieve',
+                                            'params' => ['', @id.to_s]
+                                          }).to_h
+      OpenSRF::HTTPTranslatorRequest.new(payload: payload, configuration: @configuration,
+                                         service: 'open-ils.cat').response
+    end
+
+    def tcn
+      get 'tcn_value'
+    end
+
+    private
+
+    def idl_class
+      'bre'
+    end
+  end
+end

data/lib/evergreen/configuration.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class Evergreen
+  # Configuration for an instance of Evergreen
+  class Configuration
+    attr_reader :host, :default_username, :default_password, :read_only
+
+    def initialize(config_hash)
+      @read_only = true
+      config_hash.each_pair do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+      configuration_complete
+    end
+
+    private
+
+    def configuration_complete
+      check_required_fields
+      freeze
+    end
+
+    def check_required_fields
+      raise ArgumentError, 'you must supply a host' if field_is_empty :host
+      return unless !@read_only && (field_is_empty(:default_username) || field_is_empty(:default_password))
+
+      raise ArgumentError, 'you must supply default credentials unless you are in read-only mode'
+    end
+
+    def field_is_empty(field_name)
+      field_value = instance_variable_get("@#{field_name}")
+      field_value.nil? || field_value.empty?
+    end
+  end
+end

data/lib/evergreen/connection.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class Evergreen
+  # This class provides an interface for making
+  # requests to the Evergreen server
+  class Connection
+    include Mixins::RetrievalMethods
+    attr_reader :configuration
+
+    def initialize(configuration:)
+      @configuration = configuration
+    end
+
+    def close; end
+
+    def idl
+      @idl ||= IDL.new(@configuration)
+    end
+  end
+end

data/lib/evergreen/idl.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'rexml/parsers/sax2parser'
+require 'rexml/sax2listener'
+
+class Evergreen
+  # Evergreen's fieldmapper IDL
+  class IDL
+    attr_reader :fields
+
+    def initialize(configuration)
+      @configuration = configuration
+      @handler = IDLSaxHandler.new
+      fetch
+      freeze
+    end
+
+    def [](key)
+      fields[key]
+    end
+
+    private
+
+    def fetch
+      URI.open("https://#{@configuration.host}/reports/fm_IDL.xml") do |file|
+        @fields = IDLSaxParser.new(file).parse
+      end
+    rescue Errno::ECONNREFUSED, OpenURI::HTTPError
+      raise Evergreen::ConnectionError
+    end
+
+    # A wrapper around the SAX parser
+    class IDLSaxParser
+      def initialize(file)
+        @parser = REXML::Parsers::SAX2Parser.new(file)
+        @handler = IDLSaxHandler.new
+      end
+
+      def parse
+        @parser.listen(@handler)
+        @parser.parse
+        @handler.idl_fields
+      end
+    end
+
+    # A SAX parsing handler
+    class IDLSaxHandler
+      include REXML::SAX2Listener
+      attr_reader :idl_fields
+
+      def initialize
+        @idl_fields = {}
+        @current_class = nil
+        super
+      end
+
+      # Callback for when we hit an XML attribute
+      def start_element(_uri, _localname, _qname, attributes)
+        if attributes.key? 'id'
+          # We found a class ID!
+          @current_class = attributes['id']
+          @idl_fields[@current_class] = []
+        elsif attributes.key? 'name'
+          # We found the name of a field!
+          @idl_fields[@current_class].push(attributes['name'])
+        end
+      end
+    end
+  end
+end

data/lib/evergreen/idl_object.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Evergreen
+  # A base class for any object represented in
+  # Evergreen's IDL
+  class IDLObject
+    def initialize(idl)
+      @idl = idl
+    end
+
+    def idl_fields
+      @idl[idl_class]
+    end
+
+    def get(field_name)
+      data[idl_fields.index(field_name)]
+    end
+
+    private
+
+    # This should be overriden by subclasses
+    def idl_class
+      'acp'
+    end
+
+    def data; end
+  end
+end

data/lib/evergreen/mixins/anonymous_pcrud.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Evergreen
+  module Mixins
+    # This read-only API is available
+    # without any credentials
+    module AnonymousPcrud
+      def data
+        return @data if @data
+        return unless @id && @configuration && idl_class && idl_fields
+
+        payload = OpenSRF::ClassAndData.new(klass: 'osrfMessage', data: {
+                                              'method' => "open-ils.pcrud.retrieve.#{idl_class}",
+                                              'params' => ['ANONYMOUS', @id.to_s]
+                                            }).to_h
+        response = OpenSRF::HTTPTranslatorRequest.new(payload: payload, configuration: @configuration,
+                                                      service: 'open-ils.pcrud').response
+        @data = OpenSRF::ClassAndData.parse(response['content']).data
+      end
+    end
+  end
+end

data/lib/evergreen/mixins/retrieval_methods.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Evergreen
+  module Mixins
+    # Convenience methods to search for data
+    # and initialize objects based on the results
+    module RetrievalMethods
+      def get_bib_record(id)
+        Evergreen::BibRecord.new(id: id, configuration: configuration, idl: idl)
+      end
+    end
+  end
+end

data/lib/evergreen/version.rb

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

data/lib/evergreen.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  'http_translator_request' => 'HTTPTranslatorRequest',
+  'idl' => 'IDL',
+  'idl_object' => 'IDLObject',
+  'opensrf' => 'OpenSRF',
+  'json' => 'JSON'
+)
+loader.setup
+
+# The main class provided by this gem
+class Evergreen
+  def initialize(config_hash)
+    connection = Connection.new(configuration: Configuration.new(config_hash))
+    yield connection
+    connection.close
+  end
+
+  # An error when we can't connect to the Evergreen server
+  class ConnectionError < StandardError; end
+end

data/lib/opensrf/class_and_data.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OpenSRF
+  # OpenSRF requests and responses often
+  # take the following form
+  # {"__c": "clasname", "__p": ["all", "the", "data"]}
+  class ClassAndData
+    attr_reader :klass, :data
+
+    def initialize(klass:, data:)
+      @klass = klass
+      @data = data
+    end
+
+    def self.parse(hash, path = [])
+      small_json = new(klass: hash['__c'], data: hash['__p'])
+      return small_json if path.empty?
+
+      key = path.shift
+      parse(small_json.data[key], path)
+    end
+
+    def to_h
+      { '__c' => @klass,
+        '__p' => @data }
+    end
+  end
+end

data/lib/opensrf/http_translator_request.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'uri'
+
+module OpenSRF
+  # A stateful endpoint, described in
+  # this documentation:
+  # https://docs.evergreen-ils.org/eg/docs/latest/integrations/web_services.html#_http_translator
+  class HTTPTranslatorRequest
+    def initialize(configuration:, service:, payload:)
+      @configuration = configuration
+      @service = service
+      @payload = payload
+    end
+
+    def response
+      raw = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+      OpenSRF::ClassAndData.parse(::JSON.parse(raw.body).first, ['payload']).data
+    end
+
+    private
+
+    def request
+      request = Net::HTTP::Post.new(uri)
+      request['X-Opensrf-Service'] = @service
+      request.body = "osrf-msg=#{osrf_message.to_json}"
+      request
+    end
+
+    def osrf_message
+      [
+        OpenSRF::ClassAndData.new(klass: 'osrfMessage', data: {
+                                    'threadTrace' => 0,
+                                    'locale' => 'en-CA',
+                                    'type' => 'REQUEST',
+                                    'payload' => @payload
+                                  }).to_h
+      ]
+    end
+
+    def req_options
+      { use_ssl: true }
+    end
+
+    def uri
+      URI.parse("https://#{@configuration.host}/osrf-http-translator")
+    end
+  end
+end

data/sig/evergreen/configuration.rbs

@@ -0,0 +1,22 @@
+class Evergreen
+  # Configuration for an instance of Evergreen
+  class Configuration
+    attr_accessor host: untyped
+
+    attr_accessor default_username: untyped
+
+    attr_accessor default_password: untyped
+
+    attr_accessor read_only: untyped
+
+    def initialize: (Hash[Symbol, (String | bool)]) -> void
+
+    def configuration_complete: () -> untyped
+
+    private
+
+    def check_required_fields: () -> (nil | untyped)
+
+    def field_is_empty: (untyped field_name) -> untyped
+  end
+end

data/sig/evergreen/connection.rbs

@@ -0,0 +1,13 @@
+class Evergreen
+  # This class provides an interface for making
+  # requests to the Evergreen server
+  class Connection
+    attr_reader configuration: Evergreen::Configuration
+
+    def initialize: (configuration: untyped) -> void
+
+    def close: () -> nil
+
+    def idl: () -> Evergreen::IDL
+  end
+end

data/sig/evergreen/idl.rbs

@@ -0,0 +1,31 @@
+class Evergreen
+  # Evergreen's fieldmapper IDL
+  class IDL
+    attr_reader fields: untyped
+
+    def initialize: (untyped configuration) -> void
+
+    def []: (untyped key) -> untyped
+
+    private
+
+    def fetch: () -> untyped
+
+    # A wrapper around the SAX parser
+    class IDLSaxParser
+      def initialize: (untyped file) -> void
+
+      def parse: () -> untyped
+    end
+
+    # A SAX parsing handler
+    class IDLSaxHandler
+      attr_reader idl_fields: untyped
+
+      def initialize: () -> void
+
+      # Callback for when we hit an XML attribute
+      def start_element: (untyped _uri, untyped _localname, untyped _qname, untyped attributes) -> (untyped | untyped | nil)
+    end
+  end
+end

data/sig/evergreen/idl_object.rbs

@@ -0,0 +1,10 @@
+class Evergreen::IDLObject
+    @idl: untyped
+
+    def initialize: (untyped idl) -> void
+    def idl_fields: -> untyped
+
+    private
+    def idl_class: -> String
+    def data: -> untyped
+end

data/sig/evergreen/mixins/retrieval_methods.rb

@@ -0,0 +1,9 @@
+class Evergreen
+  module Mixins
+    # Convenience methods to search for data
+    # and initialize objects based on the results
+    module RetrievalMethods
+      def get_bib_record: (untyped id) -> untyped
+    end
+  end
+end

data/sig/evergreen/version.rbs

@@ -0,0 +1,6 @@
+# TypeProf 0.21.2
+
+# Classes
+class Evergreen
+  VERSION: String
+end

data/sig/opensrf/class_and_data.rbs

@@ -0,0 +1,12 @@
+# TypeProf 0.21.2
+
+# Classes
+module OpenSRF
+  class ClassAndData
+    attr_reader klass: untyped
+    attr_reader data: untyped
+    def initialize: (klass: untyped, data: untyped) -> void
+    def self.parse: (untyped hash, ?Array[untyped] path) -> ClassAndData
+    def to_h: -> Hash[String, untyped]
+  end
+end

data/sig/opensrf/http_translator_request.rbs

@@ -0,0 +1,20 @@
+module OpenSRF
+  # A stateful endpoint, described in
+  # this documentation:
+  # https://docs.evergreen-ils.org/eg/docs/latest/integrations/web_services.html#_http_translator
+  class HTTPTranslatorRequest
+    def initialize: (configuration: untyped, service: untyped, payload: untyped) -> void
+
+    def response: () -> untyped
+
+    private
+
+    def request: () -> untyped
+
+    def osrf_message: () -> ::Array[untyped]
+
+    def req_options: () -> { use_ssl: true }
+
+    def uri: () -> untyped
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: evergreen-ils
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Jane Sandberg
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: marc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A gem for interacting with the Evergreen Integrated Library System
+email:
+- sandbergja@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- Steepfile
+- evergreen-ils.gemspec
+- lib/evergreen.rb
+- lib/evergreen/bib_record.rb
+- lib/evergreen/configuration.rb
+- lib/evergreen/connection.rb
+- lib/evergreen/idl.rb
+- lib/evergreen/idl_object.rb
+- lib/evergreen/mixins/anonymous_pcrud.rb
+- lib/evergreen/mixins/retrieval_methods.rb
+- lib/evergreen/version.rb
+- lib/opensrf/class_and_data.rb
+- lib/opensrf/http_translator_request.rb
+- sig/evergreen/configuration.rbs
+- sig/evergreen/connection.rbs
+- sig/evergreen/idl.rbs
+- sig/evergreen/idl_object.rbs
+- sig/evergreen/mixins/retrieval_methods.rb
+- sig/evergreen/version.rbs
+- sig/opensrf/class_and_data.rbs
+- sig/opensrf/http_translator_request.rbs
+homepage: https://github.com/sandbergja/evergreen-rb
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sandbergja/evergreen-rb
+  source_code_uri: https://github.com/sandbergja/evergreen-rb
+  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: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Evergreen ILS
+test_files: []