lyber-core 5.5.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 111851f92d3a3e5eea02835d7344f396109b4ee1d1d3d9ef876572d5e4635ff3
-  data.tar.gz: e02aac8fd5daef98edf95f7c428ba17030ecc11ba5ddafa699c25e34ed4d1743
+  metadata.gz: '0786ae4b4aa512ea86d9a147d4002d141fc2658e8f52b533056c658dee6d727e'
+  data.tar.gz: fd8b91265cbf0f5aa5c456d2f7edd88c4d7fd8c4fad019bd99df403021e7dd39
 SHA512:
-  metadata.gz: 408a6bd0a29d3bd855401c920bae9be51d6ecfeb7ff04f8f90a758b813c2cafe45cc27794a16401ac3384c10dfcc43cde33ed2558d08c43ab471bb4f12d9af11
-  data.tar.gz: 5381aa2ba9b906e2bcdc25b2fba7bce54b9a0cc9125008ca901f1bb28c61f250e9b5f092c33e0c96d5c65a0a3fb34f4e8fbf4a28eb6b8050f973176ea8dfdbb4
+  metadata.gz: 2c250695948c1c111c181886b8d03ffe23475a8c5ce020da62f67782710a682ac0f9cbbe1952e1efe36eb9d20363c63049477a01b47763770862ba7e200e1da2
+  data.tar.gz: 665ab707ba5e5603440dc1c9ee3b8f1b0ac67dc7bc213f441baeb1525070f8e3f1b2eaee317ad3d283216ba3d304574b898b2bd92c11d42182545c906be3d7cf

data/README.md

@@ -53,13 +53,13 @@ module Robots
           obj = Dor::Item.find(druid)
           if some_logic_here_to_determine_if_shelving_occurs
             obj.shelve
-            return LyberCore::Robot::ReturnState.COMPLETED # set the final state to completed
-#           return LyberCore::Robot::ReturnState.new(state: 'completed', note: 'some custom note to pass back to workflow') # set the final state to completed with a custom note
+            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
 
           else
             # just return skipped if we did nothing
-            return LyberCore::Robot::ReturnState.SKIPPED # set the final state to skipped
-#           return LyberCore::Robot::ReturnState.new(state: 'skipped', note: 'some custom note to pass back to workflow') # set the final state to skipped with a custom note
+            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
           end
         end
 

data/lib/lyber_core.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dor-services'
 require 'lyber_core/log'
+require 'lyber_core/workflow'
 require 'lyber_core/robot'
 require 'lyber_core/return_state'

data/lib/lyber_core/return_state.rb

@@ -11,18 +11,6 @@ module LyberCore
       ALLOWED_RETURN_STATES = %w[completed skipped waiting].freeze
       DEFAULT_RETURN_STATE  = 'completed'
 
-      def self.SKIPPED
-        new(status: 'skipped')
-      end
-
-      def self.COMPLETED
-        new(status: 'completed')
-      end
-
-      def self.WAITING
-        new(status: 'waiting')
-      end
-
       def initialize(params = {})
         self.status = params[:status] || DEFAULT_RETURN_STATE
         self.note = params[:note] || ''

data/lib/lyber_core/robot.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
 require 'benchmark'
-require 'active_support'
-require 'active_support/core_ext'
-require 'active_support/core_ext/string/inflections' # camelcase
 
 module LyberCore
   module Robot
@@ -21,56 +18,36 @@ module LyberCore
       end
     end
 
-    # Converts a given step to the Robot class name
-    # Examples:
-    #
-    # - `dor:assemblyWF:jp2-create` into `Robots::DorRepo::Assembly::Jp2Create`
-    # - `dor:gisAssemblyWF:start-assembly-workflow` into `Robots::DorRepo::GisAssembly::StartAssemblyWorkflow`
-    # - `dor:etdSubmitWF:binder-transfer` into `Robots:DorRepo::EtdSubmit::BinderTransfer`
-    #
-    # @param [String] step. fully qualified step name, e.g., `dor:accessionWF:descriptive-metadata`
-    # @param [Hash] opts
-    # @option :repo_suffix defaults to `Repo`
-    # @return [String] The class name for the robot, e.g., `Robots::DorRepo::Accession:DescriptiveMetadata`
-    def self.step_to_classname(step, opts = {})
-      # generate the robot job class name
-      opts[:repo_suffix] ||= 'Repo'
-      r, w, s = step.split(/:/, 3)
-      [
-        'Robots',
-        r.camelcase + opts[:repo_suffix], # 'Dor' conflicts with dor-services
-        w.sub('WF', '').camelcase,
-        s.tr('-', '_').camelcase
-      ].join('::')
-    end
-
     attr_accessor :check_queued_status
-    attr_reader :workflow_service
+    attr_reader :workflow_name, :process
 
-    def initialize(repo, workflow_name, step_name, opts = {})
+    def initialize(workflow_name, process, check_queued_status: true)
       Signal.trap('QUIT') { puts "#{Process.pid} ignoring SIGQUIT" } # SIGQUIT ignored to let the robot finish
-      @repo = repo
       @workflow_name = workflow_name
-      @step_name = step_name
-      @check_queued_status = opts.fetch(:check_queued_status, true)
-      @workflow_service = opts.fetch(:workflow_service) { Dor::Config.workflow.client }
+      @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'
     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
     def work(druid)
-      Honeybadger.context(druid: druid, step_name: @step_name, workflow_name: @workflow_name) if defined? Honeybadger
-
+      Honeybadger.context(druid: druid, process: process, workflow_name: workflow_name) if defined? Honeybadger
+      workflow = workflow(druid)
       LyberCore::Log.set_logfile($stdout) # let process manager(bluepill) handle logging
       LyberCore::Log.info "#{druid} processing"
-      return if @check_queued_status && !item_queued?(druid)
+      return if check_queued_status && !item_queued?(druid)
 
-      # 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 object to return a status
+      # 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
+      # object to return a status
       note = Socket.gethostname
 
       # update the workflow status to indicate that started
-      puts('setting to start')
-      workflow_service.update_status(druid: druid, workflow: @workflow_name, process: @step_name, status: 'started', elapsed: 1.0, note: note)
+      workflow.start(note)
 
       result = nil
       elapsed = Benchmark.realtime do
@@ -87,25 +64,36 @@ module LyberCore
         workflow_state = 'completed'
       end
       # update the workflow status from its current state to the state returned by perform (or 'completed' as the default)
-      workflow_service.update_status(druid: druid, workflow: @workflow_name, process: @step_name, status: workflow_state, elapsed: elapsed, note: note)
+      workflow.complete(workflow_state, elapsed, note)
+
       LyberCore::Log.info "Finished #{druid} in #{sprintf('%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_service.update_error_status(druid: druid, workflow: @workflow_name, process: @step_name, error_msg: e.message, error_text: Socket.gethostname)
+        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")
+        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
     end
 
   private
 
+    def workflow(druid)
+      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: @step_name)
+      status = workflow_service.workflow_status(druid: druid,
+                                                workflow: workflow_name,
+                                                process: process)
       return true if status =~ /queued/i
-      msg = "Item #{druid} is not queued for #{@step_name} (#{@workflow_name}), but has status of '#{status}'. Will skip processing"
+
+      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
       false

data/lib/lyber_core/workflow.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module LyberCore
+  # This encapsulates the workflow operations that lyber-core does
+  class Workflow
+    def initialize(workflow_service:, druid:, workflow_name:, process:)
+      @workflow_service = workflow_service
+      @druid = druid
+      @workflow_name = workflow_name
+      @process = process
+    end
+
+    def start(note)
+      workflow_service.update_status(druid: druid,
+                                     workflow: workflow_name,
+                                     process: process,
+                                     status: 'started',
+                                     elapsed: 1.0,
+                                     note: note)
+    end
+
+    def complete(status, elapsed, note)
+      workflow_service.update_status(druid: druid,
+                                     workflow: workflow_name,
+                                     process: process,
+                                     status: status,
+                                     elapsed: elapsed,
+                                     note: note)
+    end
+
+    def error(error_msg, error_text)
+      workflow_service.update_error_status(druid: druid,
+                                           workflow: workflow_name,
+                                           process: process,
+                                           error_msg: error_msg,
+                                           error_text: error_text)
+    end
+
+  private
+
+    attr_reader :workflow_service, :druid, :workflow_name, :process
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lyber-core
 version: !ruby/object:Gem::Version
-  version: 5.5.1
+  version: 6.0.0
 platform: ruby
 authors:
 - Alpana Pande
@@ -16,56 +16,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2020-02-06 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  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: dor-services
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 7.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 7.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '9'
-- !ruby/object:Gem::Dependency
-  name: dor-workflow-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.11'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -180,6 +132,7 @@ files:
 - lib/lyber_core/log.rb
 - lib/lyber_core/return_state.rb
 - lib/lyber_core/robot.rb
+- lib/lyber_core/workflow.rb
 - lib/tasks/rdoc.rake
 homepage: http://github.com/sul-dlss/lyber-core
 licenses:
@@ -200,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Core services used by the SUL Digital Library