lyber-core 6.1.1 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72f25a04a8a79879923e52f8a0ba9e8fbb7d7a92deaf195961548cab5898baf2
-  data.tar.gz: 9dd75e18b11858d897a1dcdeabb0841595bc1a5db02fed17fe84bdf78c7a249d
+  metadata.gz: 9fee6187de84b39ea2e21ffb214d2e8d9dcb6be544df35a26366652aabf98d52
+  data.tar.gz: d2e57ab17e7f966491248ca077c17064430d9945585b027b46865d3053a5bac5
 SHA512:
-  metadata.gz: 479c21c2be8a01e3545035009cfda6c2655e5d78f8e191a5e901be7e33eec7ff2f5b3a0623afce4d73edab1b31f79da0c43f3e0afa379dd40914079ee248476f
-  data.tar.gz: edeed4efdf04ee301091f104c1e40047a9f124cfe269be8de88103a0b8ec27632298d9f9a06a1c379b98c0d019131f785721777be41fba924cf92280d6d60b4a
+  metadata.gz: de1f7e5c8bfd12d1d72ad712b409fdcedce82202f34679648bb448d800de7f40f84a6c55e187635cb21f5759af464e44ccebc7baec062789f3719e170f586e65
+  data.tar.gz: d02c0221f2cd4eb19e41d84e59104cc5926b2c53c0d7616cf964b64e99e2893a6e864fad487004096bee515eebaaae7f884bcc26e6ad2c5c1705a3c1f02e6dd1

data/README.md

@@ -1,31 +1,30 @@
-[![Build Status](https://travis-ci.org/sul-dlss/lyber-core.svg?branch=master)](https://travis-ci.org/sul-dlss/lyber-core)
-[![Coverage Status](https://coveralls.io/repos/github/sul-dlss/lyber-core/badge.svg?branch=master)](https://coveralls.io/github/sul-dlss/lyber-core?branch=master)
+[![CircleCI](https://circleci.com/gh/sul-dlss/lyber-core/tree/main.svg?style=svg)](https://circleci.com/gh/sul-dlss/lyber-core/tree/main)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/472f67659e513e3d8ffa/test_coverage)](https://codeclimate.com/github/sul-dlss/lyber-core/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/472f67659e513e3d8ffa/maintainability)](https://codeclimate.com/github/sul-dlss/lyber-core/maintainability)
 [![Gem Version](https://badge.fury.io/rb/lyber-core.svg)](https://badge.fury.io/rb/lyber-core)
 
 # lyber_core
 
 ## Robot Creation
 
-Create a class that mixes in `LyberCore::Robot`
+Create a class that subclasses `LyberCore::Robot`
 
-* In the initializer, call `super` with the repository, workflow name, step name
-* Your class `#perform` method will perform the actual work, with `druid` passed in as the one and only argument
+* In the initializer, call `super` with the workflow name, step name
+* Your class `#perform_work` method will perform the actual work; `druid` is available as an instance variable.
 
 ```ruby
 module Robots
   module DorRepo
     module Accession
 
-      class Shelve
-        include LyberCore::Robot
+      class Shelve < LyberCore::Robot
 
         def initialize
-          super('dor', 'accessionWF', 'shelve')
+          super('accessionWF', 'shelve')
         end
 
-        def perform druid
-          obj = Dor::Item.find(druid)
-          obj.shelve
+        def perform_work
+          cocina_object.shelve
         end
 
       end
@@ -42,24 +41,22 @@ module Robots
   module DorRepo
     module Accession
 
-      class Shelve
-        include LyberCore::Robot
+      class Shelve < LyberCore::Robot
 
         def initialize
-          super('dor', 'accessionWF', 'shelve')
+          super('accessionWF', 'shelve')
         end
 
-        def perform druid
-          obj = Dor::Item.find(druid)
+        def perform
           if some_logic_here_to_determine_if_shelving_occurs
-            obj.shelve
-            return LyberCore::Robot::ReturnState.new(status: 'completed') # set the final state to completed
-#           return LyberCore::Robot::ReturnState.new(status: 'completed', note: 'some custom note to pass back to workflow') # set the final state to completed with a custom note
+            cocina_object.shelve
+            return LyberCore::ReturnState.new(status: 'completed') # set the final state to completed
+#           return LyberCore::ReturnState.new(status: 'completed', note: 'some custom note to pass back to workflow') # set the final state to completed with a custom note
 
           else
             # just return skipped if we did nothing
-            return LyberCore::Robot::ReturnState.new(status: 'skipped') # set the final state to skipped
-#           return LyberCore::Robot::ReturnState.new(status: 'skipped', note: 'some custom note to pass back to workflow') # set the final state to skipped with a custom note
+            return LyberCore::ReturnState.new(status: 'skipped') # set the final state to skipped
+#           return LyberCore::ReturnState.new(status: 'skipped', note: 'some custom note to pass back to workflow') # set the final state to skipped with a custom note
           end
         end
 
@@ -72,50 +69,58 @@ end
 
 ## Robot Environment Setup
 
-* Create a `config/boot.rb` file to load the classpath, classes and configuration that your robot will need in order to run.
-See the [boot.rb file from the Common-Accessioning robot suite](https://github.com/sul-dlss/common-accessioning/blob/master/config/boot.rb) as an example
-
-* Add `require 'resque/tasks'` to your `Rakefile`
+Create a `config/boot.rb` containing:
+```
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default)
 
-* Create an `environment` task within your `Rakefile` that requires your `config/boot.rb` file
+LyberCore::Boot.up(__dir__)
 
-#### Example Rakefile modifications
-```ruby
-require 'robot-controller/tasks'
-...
-task :environment do
-  require_relative 'config/boot'
-end
+# Any additional robot-specific configuratio.
 ```
 
-## Start the Robot
-
-* Use rake to start your robot, specifying the Resque queue as the environment variable `QUEUE`
+The configuration must include:
+```
+redis_url: ~
 
+workflow:
+  url: http://workflow.example.com/workflow
+  logfile: 'log/workflow_service.log'
+  shift_age: 'weekly'
+  timeout: 60
 ```
-$ QUEUE=accessionWF_shelve rake environment workers
+
+And optionally:
 ```
+# For Dor Services Client
+dor_services:
+  url:  'https://dor-services-test.stanford.test'
+  token: secret-token
 
-## Enqueing a Job
+# For Cocina::Models::Mapping::Purl
+purl_url: 'https://purl-example.stanford.edu'
 
-```ruby
-require 'resque'
-Resque.enqueue_to('accessionWF_shelve'.to_sym, Robot::DorRepo::Accession::Shelve, 'druid:aa123bb4567')
+# For DruidTools::Druid
+stacks:
+  local_workspace_root: ~
 ```
 
+The following environment variables can optionally be set:
+* ROBOT_ENVIRONMENT
+* ROBOT_LOG_LEVEL
 
-## Releases
-* **4.0** Remove unused classes and dependencies
-* **3.0** Robot overhaul.  Use `resque` for job management and `bluepill` for process management
-* **2.1.1** Relax dor-services-gem version requirement
-* **2.0** Moved what was left of DorService (namely get_objects_for_workstep()) to dor-services' Dor::WorkflowService. Removed IdentityMetadata and DublinCore XML models. Factored out all remaining global constants. Removed unnecessary dependencies.
-* **1.3** Started to use Dor::Config for workspace configuration
-* **1.0.0** Factored all Dor::* classes and object models out of lyber-core and into a separate dor-services gem. WARNING: MAY BREAK COMPATIBILITY WITH PREVIOUS DOR-ENABLED CODE.
-* **0.9.8** Created branch for legacy work "0.9-legacy".  Robots can now be configured with fully qualified workflows for prerequisites
-  eg <i>dor:googleScannedBookWF:register-object</i>
-* **0.9.2** Workflow bug fixes.  Last version that supports active-fedora 1.0.7
-* We recommend that you **DO NOT USE** any version older than these
+## Robot Testing
+Include the following in `rspec/spec_helper.rb`:
+```
+ENV['ROBOT_ENVIRONMENT'] = 'test'
+require File.expand_path("#{__dir__}/../config/boot")
 
-## Copyright
+include LyberCore::Rspec
+```
 
-Copyright (c) 2014-16 Stanford University Library. See LICENSE for details.
+Robots can be invoked with:
+```
+test_perform(robot, druid)
+```
+to avoid the workflow updates in `perform()`.

data/lib/lyber_core/boot.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+# The following is required in config/boot.rb
+# require 'rubygems'
+# require 'bundler/setup'
+# Bundler.require(:default)
+
+# LyberCore::Boot.up(__dir__)
+
+module LyberCore
+  # Boots up the robot environment, including configuration, logging, clients, and Sidekiq.
+  class Boot
+    def self.up(config_dir)
+      new(config_dir).perform
+    end
+
+    def initialize(config_dir)
+      @config_dir = config_dir
+    end
+
+    def perform
+      boot_config
+      boot_dsa
+      boot_cocina_models
+      boot_sidekiq
+    end
+
+    def environment
+      @environment ||= ENV['ROBOT_ENVIRONMENT'] ||= 'development'
+    end
+
+    def boot_config
+      Config.setup do |config|
+        config.const_name = 'Settings'
+        config.use_env = true
+        config.env_prefix = 'SETTINGS'
+        config.env_separator = '__'
+      end
+      Config.load_and_set_settings(
+        Config.setting_files(File.expand_path(config_dir), environment)
+      )
+    end
+
+    private
+
+    attr_reader :config_dir
+
+    def robot_root
+      @robot_root ||= File.expand_path("#{config_dir}/..")
+    end
+
+    def robot_log
+      Sidekiq::Logger.new(File.join(robot_root, "log/#{environment}.log")).tap do |log|
+        log.level = Logger::SEV_LABEL.index(ENV.fetch('ROBOT_LOG_LEVEL', nil)) || Logger::INFO
+      end
+    end
+
+    def boot_dsa
+      return unless Settings.dor_services&.url
+
+      Dor::Services::Client.configure(url: Settings.dor_services.url,
+                                      token: Settings.dor_services.token,
+                                      enable_get_retries: true)
+    end
+
+    def boot_cocina_models
+      Cocina::Models::Mapping::Purl.base_url = Settings.purl_url if Settings.purl_url
+    end
+
+    def boot_sidekiq
+      return if environment == 'test'
+
+      Sidekiq.configure_server do |config|
+        config.logger = robot_log
+        config.redis = { url: Settings.redis_url }
+        # For Sidekiq Pro
+        config.super_fetch!
+      end
+    end
+  end
+end

data/lib/lyber_core/return_state.rb

@@ -1,27 +1,26 @@
 # frozen_string_literal: true
 
-# this object defines the allowed states robots can optionally return upon completion
-# if the return value of the "perform" step is an object of this type and the status value is set an allowed value,
-#  it will be used to set the final workflow state for that druid
 module LyberCore
-  module Robot
-    class ReturnState
-      attr_reader :status
-      attr_accessor :note
-      ALLOWED_RETURN_STATES = %w[completed skipped waiting noop].freeze
-      DEFAULT_RETURN_STATE  = 'completed'
+  # this object defines the allowed states robots can optionally return upon completion
+  # if the return value of the "perform" step is an object of this type and the status value is set an allowed value,
+  #  it will be used to set the final workflow state for that druid
+  class ReturnState
+    attr_reader :status
+    attr_accessor :note
 
-      def initialize(params = {})
-        self.status = params[:status] || DEFAULT_RETURN_STATE
-        self.note = params[:note] || ''
-      end
+    ALLOWED_RETURN_STATES = %w[completed skipped waiting noop].freeze
+    DEFAULT_RETURN_STATE  = 'completed'
 
-      def status=(value)
-        state = value.to_s.downcase
-        raise 'invalid return state' unless ALLOWED_RETURN_STATES.include? state
+    def initialize(params = {})
+      self.status = params[:status] || DEFAULT_RETURN_STATE
+      self.note = params[:note] || ''
+    end
+
+    def status=(value)
+      state = value.to_s.downcase
+      raise 'invalid return state' unless ALLOWED_RETURN_STATES.include? state
 
-        @status = state
-      end
+      @status = state
     end
   end
 end

data/lib/lyber_core/robot.rb

@@ -1,112 +1,119 @@
 # frozen_string_literal: true
 
-require 'benchmark'
-
 module LyberCore
-  module Robot
-    # Add the ClassMethods to the class this is being mixed into
-    def self.included(base)
-      base.extend ClassMethods
-    end
+  # Base class for all robots.
+  # Subclasses should implement the #perform_work method.
+  class Robot
+    include Sidekiq::Job
+    sidekiq_options retry: 0
 
-    module ClassMethods
-      # Called by job-manager on derived-class
-      # Instantiate the Robot and call #work with the passed in druid
-      def perform(druid, *context)
-        bot = new
-        bot.work druid, context
-      end
-    end
+    attr_reader :workflow_name, :process, :druid
 
-    attr_accessor :check_queued_status
-    attr_reader :workflow_name, :process
+    delegate :lane_id, to: :workflow
 
-    def initialize(workflow_name, process, check_queued_status: true)
-      Signal.trap('QUIT') { puts "#{Process.pid} ignoring SIGQUIT" } # SIGQUIT ignored to let the robot finish
+    def initialize(workflow_name, process)
       @workflow_name = workflow_name
       @process = process
-      @check_queued_status = check_queued_status
     end
 
     def workflow_service
-      raise 'The workflow_service method must be implemented on the class that includes LyberCore::Robot'
+      @workflow_service ||= WorkflowClientFactory.build(logger: logger)
+    end
+
+    def object_client
+      @object_client ||= Dor::Services::Client.object(druid)
+    end
+
+    def cocina_object
+      @cocina_object ||= object_client.find
+    end
+
+    def druid_object
+      @druid_object ||= DruidTools::Druid.new(druid, Settings.stacks.local_workspace_root)
     end
 
     # Sets up logging, timing and error handling of the job
-    # Calls the #perform method, then sets workflow to 'completed' or 'error' depending on success
+    # Calls the #perform_work method, then sets workflow to 'completed' or 'error' depending on success
     # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/PerceivedComplexity
-    def work(druid, context)
-      Honeybadger.context(druid: druid, process: process, workflow_name: workflow_name) if defined? Honeybadger
-      workflow = workflow(druid)
-      LyberCore::Log.set_logfile($stdout) # let process manager handle logging
-      LyberCore::Log.info "#{druid} processing #{process} (#{workflow_name})"
-      return if check_queued_status && !item_queued?(druid)
+    # rubocop:disable Metrics/MethodLength
+    def perform(druid)
+      @druid = druid
+      Honeybadger.context(druid: druid, process: process, workflow_name: workflow_name)
+
+      logger.info "#{druid} processing #{process} (#{workflow_name})"
+      return unless check_item_queued?
 
       # this is the default note to pass back to workflow service,
-      # but it can be overriden by a robot that uses the Lybercore::Robot::ReturnState
+      # but it can be overriden by a robot that uses the Robots::ReturnState
       # object to return a status
       note = Socket.gethostname
 
       # update the workflow status to indicate that started
-      workflow.start(note)
+      workflow.start!(note)
 
       result = nil
       elapsed = Benchmark.realtime do
-        result = if method(:perform).arity == 1
-          perform druid # implemented in the mixed-in robot class
-        else
-          perform druid, context
-        end
+        result = perform_work
       end
 
       # the final workflow state is determined by the return value of the perform step, if it is a ReturnState object,
       # we will use the defined status, otherwise default to completed
       # if a note is passed back, we will also use that instead of the default
-      if result.class == LyberCore::Robot::ReturnState
+      if result.instance_of?(ReturnState)
         workflow_state = result.status
         note = result.note unless result.note.blank?
       else
         workflow_state = 'completed'
       end
-      # update the workflow status from its current state to the state returned by perform (or 'completed' as the default)
+      # update the workflow status from its current state to the state returned by perform
+      # (or 'completed' as the default)
       # noop allows a robot to not set a workflow as complete, e.g., if that is delegated to another service.
-      workflow.complete(workflow_state, elapsed, note) unless workflow_state == 'noop'
+      workflow.complete!(workflow_state, elapsed, note) unless workflow_state == 'noop'
 
-      LyberCore::Log.info "Finished #{druid} in #{sprintf('%0.4f', elapsed)}s"
+      logger.info "Finished #{druid} in #{format('%0.4f', elapsed)}s"
     rescue StandardError => e
-      Honeybadger.notify(e) if defined? Honeybadger
-      begin
-        LyberCore::Log.error e.message + "\n" + e.backtrace.join("\n")
-        workflow.error(e.message, Socket.gethostname)
-      rescue StandardError => e
-        LyberCore::Log.error "Cannot set #{druid} to status='error'\n#{e.message}\n#{e.backtrace.join("\n")}"
-        raise e # send exception to Resque failed queue
-      end
+      handle_error(e)
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+
+    # Work performed by the robot.
+    # This method is to be implemented by robot subclasses.
+    def perform_work
+      raise NotImplementedError
+    end
+
+    def bare_druid
+      @bare_druid = druid.delete_prefix('druid:')
     end
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/CyclomaticComplexity
-  # rubocop:enable Metrics/PerceivedComplexity
 
-  private
+    private
+
+    # rubocop:disable Metrics/AbcSize
+    def handle_error(error)
+      Honeybadger.notify(error)
+      logger.error "#{error.message}\n#{error.backtrace.join("\n")}"
+      workflow.error!(error.message, Socket.gethostname)
+    rescue StandardError => e
+      logger.error "Cannot set #{druid} to status='error'\n#{e.message}\n#{e.backtrace.join("\n")}"
+      raise e # send exception to Sidekiq failed queue
+    end
+    # rubocop:enable Metrics/AbcSize
 
-    def workflow(druid)
-      Workflow.new(workflow_service: workflow_service,
-                   druid: druid,
-                   workflow_name: workflow_name,
-                   process: process)
+    def workflow
+      @workflow ||= Workflow.new(workflow_service: workflow_service,
+                                 druid: druid,
+                                 workflow_name: workflow_name,
+                                 process: process)
     end
 
-    def item_queued?(druid)
-      status = workflow_service.workflow_status(druid: druid,
-                                                workflow: workflow_name,
-                                                process: process)
-      return true if status =~ /queued/i
+    def check_item_queued?
+      return true if /queued/i.match?(workflow.status)
 
-      msg = "Item #{druid} is not queued for #{process} (#{workflow_name}), but has status of '#{status}'. Will skip processing"
-      Honeybadger.notify(msg) if defined? Honeybadger
-      LyberCore::Log.warn msg
+      msg = "Item #{druid} is not queued for #{process} (#{workflow_name}), " \
+            "but has status of '#{workflow.status}'. Will skip processing"
+      Honeybadger.notify(msg)
+      logger.warn(msg)
       false
     end
   end

data/lib/lyber_core/rspec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LyberCore
+  # Methods to support testing robots
+  module Rspec
+    def test_perform(robot, druid)
+      allow(robot).to receive(:druid).and_return(druid)
+      robot.perform_work
+    end
+  end
+end

data/lib/lyber_core/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LyberCore
+  VERSION = '7.1.0'
+end

data/lib/lyber_core/workflow.rb

@@ -10,7 +10,7 @@ module LyberCore
       @process = process
     end
 
-    def start(note)
+    def start!(note)
       workflow_service.update_status(druid: druid,
                                      workflow: workflow_name,
                                      process: process,
@@ -19,7 +19,7 @@ module LyberCore
                                      note: note)
     end
 
-    def complete(status, elapsed, note)
+    def complete!(status, elapsed, note)
       workflow_service.update_status(druid: druid,
                                      workflow: workflow_name,
                                      process: process,
@@ -28,7 +28,7 @@ module LyberCore
                                      note: note)
     end
 
-    def error(error_msg, error_text)
+    def error!(error_msg, error_text)
       workflow_service.update_error_status(druid: druid,
                                            workflow: workflow_name,
                                            process: process,
@@ -36,7 +36,17 @@ module LyberCore
                                            error_text: error_text)
     end
 
-  private
+    def status
+      @status ||= workflow_service.workflow_status(druid: druid,
+                                                   workflow: workflow_name,
+                                                   process: process)
+    end
+
+    def lane_id
+      @lane_id ||= workflow_service.process(pid: druid, workflow_name: workflow_name, process: process).lane_id
+    end
+
+    private
 
     attr_reader :workflow_service, :druid, :workflow_name, :process
   end

data/lib/lyber_core/workflow_client_factory.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module LyberCore
+  # Factory for creating a workflow client
+  class WorkflowClientFactory
+    def self.build(logger:)
+      Dor::Workflow::Client.new(url: Settings.workflow.url, logger: logger, timeout: Settings.workflow.timeout)
+    end
+  end
+end

data/lib/lyber_core.rb

@@ -1,6 +1,21 @@
 # frozen_string_literal: true
 
-require 'lyber_core/log'
-require 'lyber_core/workflow'
-require 'lyber_core/robot'
-require 'lyber_core/return_state'
+require 'benchmark'
+require 'socket'
+require 'active_support'
+require 'active_support/core_ext/object/blank' # String#blank?
+require 'active_support/core_ext/module/delegation'
+require 'sidekiq'
+require 'honeybadger'
+require 'dor/workflow/client'
+require 'dor/services/client'
+require 'druid-tools'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/lyber-core.rb")
+loader.setup
+
+# Elon Musk: "Robots will be able to do everything better than us"
+module LyberCore
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lyber-core
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 7.1.0
 platform: ruby
 authors:
 - Alpana Pande
@@ -13,19 +13,19 @@ authors:
 - Michael Klein
 - Darren Weber
 - Peter Mangiafico
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-29 00:00:00.000000000 Z
+date: 2023-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -33,27 +33,55 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: dor-services-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.10'
+- !ruby/object:Gem::Dependency
+  name: dor-workflow-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: druid-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -61,27 +89,41 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: honeybadger
+  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: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: '7.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -89,7 +131,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !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
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -103,7 +173,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.24'
 - !ruby/object:Gem::Dependency
-  name: yard
+  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:
     - - ">="
@@ -129,16 +213,18 @@ files:
 - README.md
 - lib/lyber-core.rb
 - lib/lyber_core.rb
-- lib/lyber_core/log.rb
+- lib/lyber_core/boot.rb
 - lib/lyber_core/return_state.rb
 - lib/lyber_core/robot.rb
+- lib/lyber_core/rspec.rb
+- lib/lyber_core/version.rb
 - lib/lyber_core/workflow.rb
-- lib/tasks/rdoc.rake
+- lib/lyber_core/workflow_client_factory.rb
 homepage: http://github.com/sul-dlss/lyber-core
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -146,15 +232,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Core services used by the SUL Digital Library
 test_files: []

data/lib/lyber_core/log.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-module LyberCore
-  class LyberCore::Log
-    require 'logger'
-
-    # Default values
-    DEFAULT_LOGFILE = '/tmp/lybercore_log.log' # TODO: change to STDOUT?
-    DEFAULT_LOG_LEVEL = Logger::INFO
-    DEFAULT_FORMATTER = proc do |s, t, p, m|
-      "%5s [%s] (%s) %s :: %s\n" % [s, t.strftime('%Y-%m-%d %H:%M:%S'), $$, p, m]
-    end
-
-    # Initial state
-    @@logfile = DEFAULT_LOGFILE
-    @@log ||= Logger.new(@@logfile)
-    # $stdout.reopen(@@logfile)
-    # $stderr.reopen(@@logfile)
-    @@log.level = DEFAULT_LOG_LEVEL
-    @@log.formatter = DEFAULT_FORMATTER
-
-    # Restore LyberCore::Log to its default state
-    def Log.restore_defaults
-      @@log.level = DEFAULT_LOG_LEVEL
-      Log.set_logfile(DEFAULT_LOGFILE)
-      @@log.formatter = DEFAULT_FORMATTER
-    end
-
-    # The current location of the logfile
-    def Log.logfile
-      @@logfile
-    end
-
-    # Accepts a filename as an argument, and checks to see whether that file can be
-    # opened for writing. If it can be opened, it closes the existing Logger object
-    # and re-opens it with the new logfile location. It raises an exception if it
-    # cannot write to the specified logfile.
-    def Log.set_logfile(new_logfile)
-      current_log_level = @@log.level
-      current_formatter = @@log.formatter
-      @@log = Logger.new(new_logfile)
-      @@logfile = new_logfile
-      @@log.level = current_log_level
-      @@log.formatter = current_formatter
-    rescue Exception => e
-      raise e, "Couldn't initialize logfile #{new_logfile} because\n#{e.message}: #{e.backtrace.join(%(\n))}}"
-    end
-
-    # Set the log level.
-    # See http://ruby-doc.org/core/classes/Logger.html for more info.
-    # Possible values are:
-    #   Logger::FATAL (4):  an unhandleable error that results in a program crash
-    #   Logger::ERROR (3):  a handleable error condition
-    #   Logger::WARN (2): a warning
-    #   Logger::INFO (1): generic (useful) information about system operation
-    #   Logger::DEBUG (0):  low-level information for developers
-    def Log.set_level(loglevel)
-      if [0, 1, 2, 3, 4].include? loglevel
-        @@log.level = loglevel
-        @@log.debug "Setting LyberCore::Log.level to #{loglevel}"
-      else
-        @@log.warn "I received an invalid option for log level. I expected a number between 0 and 4 but I got #{loglevel}"
-        @@log.warn "I'm setting the loglevel to 0 (debug) because you seem to be having trouble."
-        @@log.level = 0
-      end
-    rescue Exception => e
-      raise e, "Couldn't set log level because\n#{e.message}: #{e.backtrace.join(%(\n))}"
-    end
-
-    # Return the current log level
-    def Log.level
-      @@log.level
-    end
-
-    def Log.fatal(msg)
-      @@log.add(Logger::FATAL) { msg }
-    end
-
-    def Log.error(msg)
-      @@log.add(Logger::ERROR) { msg }
-    end
-
-    def Log.warn(msg)
-      @@log.add(Logger::WARN) { msg }
-    end
-
-    def Log.info(msg)
-      @@log.add(Logger::INFO) { msg }
-    end
-
-    def Log.debug(msg)
-      @@log.add(Logger::DEBUG) { msg }
-    end
-
-    def Log.exception(exc)
-      msg = Log.exception_message(exc)
-      Log.error(msg)
-    end
-
-    def Log.exception_message(exc)
-      msg = exc.inspect.split($/).join('; ') + "\n"
-      msg << exc.backtrace.join("\n") if exc.backtrace
-    end
-  end
-end

data/lib/tasks/rdoc.rake

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-desc 'Generate RDoc'
-task doc: ['doc:generate']
-
-namespace :doc do
-  project_root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
-  doc_destination = File.join(project_root, 'rdoc')
-
-  begin
-    require 'yard'
-    require 'yard/rake/yardoc_task'
-
-    YARD::Rake::YardocTask.new(:generate) do |yt|
-      yt.files   =  Dir.glob(File.join(project_root, 'lib', '*.rb')) +
-                    Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) +
-                    [File.join(project_root, 'README.rdoc')] +
-                    [File.join(project_root, 'LICENSE')]
-
-      yt.options = ['--output-dir', doc_destination, '--readme', 'README.rdoc']
-    end
-  rescue LoadError
-    desc 'Generate YARD Documentation'
-    task :generate do
-      abort 'Please install the YARD gem to generate rdoc.'
-    end
-  end
-
-  desc 'Remove generated documenation'
-  task :clean do
-    rm_r doc_destination if File.exist?(doc_destination)
-  end
-end