dor-workflow-service 1.7.6 → 1.7.7

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: cfa9ff38ab7893369b2e7c762f0a3d76725c8c9e
-  data.tar.gz: c0196de5226f2771b595efd265d210f5bdfc8949
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGMyMjcyOTg4YjEzYzAwYjFiMTI1NjMzYzNmYjk1YjlhZDVmNTZhYw==
+  data.tar.gz: !binary |-
+    YzA4M2RjMDc0MWFmOGU2NDBkZjUxZDU3M2M4MTgzOWQ5YmMyY2IxMw==
 SHA512:
-  metadata.gz: 1713dda989aed538147756b8a0b51df5a54adee310302b76e609037e4dc8629aac1602a423dc951a92014eda8cedf59ede51f34916cddaf07c86d35e862ac8b1
-  data.tar.gz: b7d671e2973e6ce7267180caf74a436266f8fb7c9237c7d2191f31e2cf529b8c5a1e0b852ca41646150457d13a90a7e7bb0e6aad4204df2b00833830a6a88008
+  metadata.gz: !binary |-
+    N2Y3Y2JlN2Q0MzYwZWQ5MWE4NDZiNzM1MWY2NzJkYTM3OWMzNzUwMzRjZGFj
+    Y2FmNjA3ZjY3YjFjODliMDhkMTYzNzIzMmUzZjhlMzkzYzcxMWU3MDEzZDVk
+    Y2Q0OGM1OWNmYzIwNmJlODk0OWQ4ZWE2YmY5M2Q5OTNlY2IxMzU=
+  data.tar.gz: !binary |-
+    YTUzYTVkOTQ4Y2NmMTc0MjRjMzM2NzdkOWRkMDM2ZjY2OTkzNTcyYWZmY2I3
+    YTE1NzhjOWUyNzY2ODc4ZmFhNzlmZTZiYjVmN2VmYjgxM2YxOTVjNzVhM2Y2
+    ZmRhYTIzMTgzYWE1MGIzMjlkZTc2YWUzNWYwYTkyZGJkYTg4NzQ=

data/.rubocop_todo.yml

@@ -1,5 +1,5 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-06-26 11:52:46 -0700 using RuboCop version 0.31.0.
+# on 2015-08-28 15:56:06 -0700 using RuboCop version 0.32.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
@@ -60,12 +60,6 @@ Style/ClassVars:
 Style/Documentation:
   Enabled: false
 
-# Offense count: 7
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/EmptyLinesAroundBlockBody:
-  Enabled: false
-
 # Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
@@ -94,20 +88,15 @@ Style/HashSyntax:
 Style/LeadingCommentSpace:
   Enabled: false
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/MethodCallParentheses:
-  Enabled: false
-
 # Offense count: 2
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/MethodDefParentheses:
+Style/MultilineBlockLayout:
   Enabled: false
 
-# Offense count: 2
+# Offense count: 6
 # Cop supports --auto-correct.
-Style/MultilineBlockLayout:
+# Configuration parameters: AllowSafeAssignment.
+Style/ParenthesesAroundCondition:
   Enabled: false
 
 # Offense count: 10
@@ -121,39 +110,12 @@ Style/PercentLiteralDelimiters:
 Style/RaiseArgs:
   Enabled: false
 
-# Offense count: 10
-# Cop supports --auto-correct.
-# Configuration parameters: AllowMultipleReturnValues.
-Style/RedundantReturn:
-  Enabled: false
-
-# Offense count: 3
-# Cop supports --auto-correct.
-Style/RedundantSelf:
-  Enabled: false
-
 # Offense count: 5
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/SignalException:
   Enabled: false
 
-# Offense count: 14
-# Cop supports --auto-correct.
-Style/SpaceAfterComma:
-  Enabled: false
-
-# Offense count: 6
-# Cop supports --auto-correct.
-Style/SpaceAfterControlKeyword:
-  Enabled: false
-
-# Offense count: 7
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/SpaceAroundEqualsInParameterDefault:
-  Enabled: false
-
 # Offense count: 11
 # Cop supports --auto-correct.
 # Configuration parameters: MultiSpaceAllowedForOperators.
@@ -188,17 +150,6 @@ Style/SpaceInsideHashLiteralBraces:
 Style/SpaceInsideParens:
   Enabled: false
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/SpecialGlobalVars:
-  Enabled: false
-
-# Offense count: 128
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/StringLiterals:
-  Enabled: false
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: IgnoredMethods.

data/.travis.yml

@@ -1,3 +1,5 @@
+language: ruby
+sudo: false
 notifications:
   email: false
 

data/Gemfile

@@ -4,5 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem "debugger", :platform => :ruby_19
+  gem 'debugger', :platform => :ruby_19
 end

data/Rakefile

@@ -1,4 +1,4 @@
-require "bundler/setup"
+require 'bundler/setup'
 require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'

data/dor-workflow-service.gemspec

@@ -4,27 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'dor/workflow_version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "dor-workflow-service"
+  gem.name          = 'dor-workflow-service'
   gem.version       = Dor::Workflow::Service::VERSION
-  gem.authors       = ["Willy Mene", "Darren Hardy"]
-  gem.email         = ["wmene@stanford.edu"]
-  gem.description   = "Enables Ruby manipulation of the DOR Workflow Service via its REST API"
-  gem.summary       = "Provides convenience methods to work with the DOR Workflow Service"
-  gem.homepage      = "https://consul.stanford.edu/display/DOR/DOR+services#DORservices-initializeworkflow"
+  gem.authors       = ['Willy Mene', 'Darren Hardy']
+  gem.email         = ['wmene@stanford.edu']
+  gem.description   = 'Enables Ruby manipulation of the DOR Workflow Service via its REST API'
+  gem.summary       = 'Provides convenience methods to work with the DOR Workflow Service'
+  gem.homepage      = 'https://consul.stanford.edu/display/DOR/DOR+services#DORservices-initializeworkflow'
 
-  gem.files         = `git ls-files`.split($/)
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(spec)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
-  gem.add_dependency "activesupport", '>= 3.2.1', '< 5'
-  gem.add_dependency "nokogiri", '~> 1.6.0'
-  gem.add_dependency "rest-client", '~> 1.7'
-  gem.add_dependency "confstruct", '>= 0.2.7', '< 2'
+  gem.add_dependency 'activesupport', '>= 3.2.1', '< 5'
+  gem.add_dependency 'nokogiri', '~> 1.6.0'
+  gem.add_dependency 'rest-client', '~> 1.7'
+  gem.add_dependency 'retries'
+  gem.add_dependency 'confstruct', '>= 0.2.7', '< 2'
 
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "rspec", "~> 3.3"
-  gem.add_development_dependency "yard"
-  gem.add_development_dependency "redcarpet"
-  gem.add_development_dependency "equivalent-xml", '~> 0.5.1'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 3.3'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'redcarpet'
+  gem.add_development_dependency 'equivalent-xml', '~> 0.5.1'
 end

data/lib/dor-workflow-service.rb

@@ -1,2 +1,2 @@
-require "dor/workflow_version"
+require 'dor/workflow_version'
 require 'dor/services/workflow_service'

data/lib/dor/services/workflow_service.rb

@@ -2,13 +2,24 @@ require 'rest-client'
 require 'active_support'
 require 'active_support/core_ext'
 require 'nokogiri'
+require 'retries'
 
 module Dor
 
-  # Methods to create and update workflow
-  module WorkflowService
+  # TODO: major version revision: change pattern of usage to be normal non-singleton class
+  # TODO: convert @@class_vars to regular attributes
+  # TODO: create normal initalize method, deprecate configure
+  # TODO: hardcoded 'true' returns are dumb, instead return the response object where possible
+  # TODO: VALID_STATUS should be just another attribute w/ default
+  # TODO: allow constructor/initalizer to receive RestClient::Resource object(s), not just URLs (solves SSL/proxy config problem)
+  # TODO: allow constructor/initalizer to receive logger
+
+  # Create and update workflows
+  class WorkflowService
     class << self
 
+      @@handler  = nil
+      @@logger   = nil
       @@resource = nil
       @@dor_services_url = nil
 
@@ -32,9 +43,12 @@ module Dor
       def create_workflow(repo, druid, workflow_name, wf_xml, opts = {:create_ds => true})
         lane_id = opts.fetch(:lane_id, 'default')
         xml = add_lane_id_to_workflow_xml(lane_id, wf_xml)
-        workflow_resource["#{repo}/objects/#{druid}/workflows/#{workflow_name}"].put(xml, :content_type => 'application/xml',
-                                                                                     :params => {'create-ds' => opts[:create_ds] })
-        return true
+        workflow_resource_method "#{repo}/objects/#{druid}/workflows/#{workflow_name}", 'put', xml,
+          {
+            :content_type => 'application/xml',
+            :params       => { 'create-ds' => opts[:create_ds] }
+          }
+        true
       end
 
       # Updates the status of one step in a workflow.
@@ -60,19 +74,19 @@ module Dor
       #     <process name=\"convert\" status=\"completed\" />"
       def update_workflow_status(repo, druid, workflow, process, status, opts = {})
         raise ArgumentError, "Unknown status value #{status}" unless VALID_STATUS.include?(status.downcase)
-        opts = {:elapsed => 0, :lifecycle => nil, :note => nil}.merge!(opts)
+        opts = { :elapsed => 0, :lifecycle => nil, :note => nil }.merge!(opts)
         opts[:elapsed] = opts[:elapsed].to_s
         current_status = opts.delete(:current_status)
-        xml = create_process_xml({:name => process, :status => status.downcase}.merge!(opts))
+        xml = create_process_xml({ :name => process, :status => status.downcase }.merge!(opts))
         uri = "#{repo}/objects/#{druid}/workflows/#{workflow}/#{process}"
         uri << "?current-status=#{current_status.downcase}" if current_status
-        workflow_resource[uri].put(xml, :content_type => 'application/xml')
-        return true
+        workflow_resource_method(uri, 'put', xml, { :content_type => 'application/xml' })
+        true
       end
 
       #
       # Retrieves the process status of the given workflow for the given object identifier
-      # @param [String] repo The repository the object resides in.  The service recoginzes "dor" and "sdr" at the moment
+      # @param [String] repo The repository the object resides in.  Currently recoginzes "dor" and "sdr".
       # @param [String] druid The id of the object
       # @param [String] workflow The name of the workflow
       # @param [String] process The name of the process step
@@ -80,35 +94,34 @@ module Dor
       def get_workflow_status(repo, druid, workflow, process)
         workflow_md = get_workflow_xml(repo, druid, workflow)
         doc = Nokogiri::XML(workflow_md)
-        raise Exception.new("Unable to parse response:\n#{workflow_md}") if(doc.root.nil?)
-
+        raise Exception.new("Unable to parse response:\n#{workflow_md}") if doc.root.nil?
         status = doc.root.at_xpath("//process[@name='#{process}']/@status")
-        status=status.content if status
-        return status
+        status = status.content if status
+        status
       end
 
       #
       # Retrieves the raw XML for the given workflow
-      # @param [String] repo The repository the object resides in.  The service recoginzes "dor" and "sdr" at the moment
+      # @param [String] repo The repository the object resides in.  Currently recoginzes "dor" and "sdr".
       # @param [String] druid The id of the object
       # @param [String] workflow The name of the workflow
       # @return [String] XML of the workflow
       def get_workflow_xml(repo, druid, workflow)
-        workflow_resource["#{repo}/objects/#{druid}/workflows/#{workflow}"].get
+        workflow_resource_method "#{repo}/objects/#{druid}/workflows/#{workflow}"
       end
 
       # Get workflow names into an array for given PID
       # This method only works when this gem is used in a project that is configured to connect to DOR
       #
       # @param [String] pid of druid
-      # @param [String] repo repository for the object. Defaults to 'dor'
+      # @param [String] repo repository for the object
       # @return [Array<String>] list of worklows
       # @example
       #   Dor::WorkflowService.get_workflows('druid:sr100hp0609')
       #   => ["accessionWF", "assemblyWF", "disseminationWF"]
-      def get_workflows(pid, repo='dor')
-        xml_doc=Nokogiri::XML(get_workflow_xml(repo,pid,''))
-        return xml_doc.xpath('//workflow').collect {|workflow| workflow['id']}
+      def get_workflows(pid, repo = 'dor')
+        xml_doc = Nokogiri::XML(get_workflow_xml(repo, pid, ''))
+        xml_doc.xpath('//workflow').collect {|workflow| workflow['id']}
       end
 
       # Get active workflow names into an array for given PID
@@ -121,7 +134,7 @@ module Dor
       #   Dor::WorkflowService.get_workflows('dor', 'druid:sr100hp0609')
       #   => ["accessionWF", "assemblyWF", "disseminationWF"]
       def get_active_workflows(repo, pid)
-        doc = Nokogiri::XML(get_workflow_xml(repo,pid,''))
+        doc = Nokogiri::XML(get_workflow_xml(repo, pid, ''))
         doc.xpath( %(//workflow[not(process/@archived)]/@id ) ).map {|n| n.value}
       end
 
@@ -145,8 +158,8 @@ module Dor
       def update_workflow_error_status(repo, druid, workflow, process, error_msg, opts = {})
         opts = {:error_text => nil}.merge!(opts)
         xml = create_process_xml({:name => process, :status => 'error', :errorMessage => error_msg}.merge!(opts))
-        workflow_resource["#{repo}/objects/#{druid}/workflows/#{workflow}/#{process}"].put(xml, :content_type => 'application/xml')
-        return true
+        workflow_resource_method "#{repo}/objects/#{druid}/workflows/#{workflow}/#{process}", 'put', xml, {:content_type => 'application/xml'}
+        true
       end
 
       # Deletes a workflow from a particular repository and druid
@@ -155,8 +168,8 @@ module Dor
       # @param [String] workflow The name of the workflow to be deleted
       # @return [Boolean] always true
       def delete_workflow(repo, druid, workflow)
-        workflow_resource["#{repo}/objects/#{druid}/workflows/#{workflow}"].delete
-        return true
+        workflow_resource_method "#{repo}/objects/#{druid}/workflows/#{workflow}", 'delete'
+        true
       end
 
       # Returns the Date for a requested milestone from workflow lifecycle
@@ -171,10 +184,9 @@ module Dor
       #     <milestone date="2010-06-15T16:08:58-0700">released</milestone>
       #   </lifecycle>
       def get_lifecycle(repo, druid, milestone)
-        doc = self.query_lifecycle(repo, druid)
+        doc = query_lifecycle(repo, druid)
         milestone = doc.at_xpath("//lifecycle/milestone[text() = '#{milestone}']")
         return Time.parse(milestone['date']) if milestone
-
         nil
       end
 
@@ -190,17 +202,16 @@ module Dor
       #     <milestone date="2010-06-15T16:08:58-0700">released</milestone>
       #   </lifecycle>
       def get_active_lifecycle(repo, druid, milestone)
-        doc = self.query_lifecycle(repo, druid, true)
+        doc = query_lifecycle(repo, druid, true)
         milestone = doc.at_xpath("//lifecycle/milestone[text() = '#{milestone}']")
         return Time.parse(milestone['date']) if milestone
-
         nil
       end
 
       # @return [Hash]
       def get_milestones(repo, druid)
-        doc = self.query_lifecycle(repo, druid)
-        doc.xpath("//lifecycle/milestone").collect do |node|
+        doc = query_lifecycle(repo, druid)
+        doc.xpath('//lifecycle/milestone').collect do |node|
           { :milestone => node.text, :at => Time.parse(node['date']), :version => node['version'] }
         end
       end
@@ -208,16 +219,13 @@ module Dor
       # Converts repo-workflow-step into repo:workflow:step
       # @param [String] default_repository
       # @param [String] default_workflow
-      # @param [String] step if contains colon :, then uses
-      #   the value for workflow and/or workflow/repository.
-      #   for example, jp2-create, or assemblyWF:jp2-create,
-      #   or dor:assemblyWF:jp2-create
+      # @param [String] step if contains colon :, then the value for workflow and/or workflow/repository. For example: 'jp2-create', 'assemblyWF:jp2-create' or 'dor:assemblyWF:jp2-create'
       # @return [String] repo:workflow:step
       # @example
       #   dor:assemblyWF:jp2-create
       def qualify_step(default_repository, default_workflow, step)
-        current = step.split(/:/,3)
-        current.unshift(default_workflow) if current.length < 3
+        current = step.split(/:/, 3)
+        current.unshift(default_workflow)   if current.length < 3
         current.unshift(default_repository) if current.length < 3
         current.join(':')
       end
@@ -256,24 +264,21 @@ module Dor
       #      "druid:py156ps0477",
       #     }
       #
-      def get_objects_for_workstep completed, waiting, lane_id='default', options = {}
-        waiting_param = qualify_step(options[:default_repository],options[:default_workflow],waiting)
+      def get_objects_for_workstep(completed, waiting, lane_id = 'default', options = {})
+        waiting_param = qualify_step(options[:default_repository], options[:default_workflow], waiting)
         uri_string = "workflow_queue?waiting=#{waiting_param}"
-        if(completed)
+        if completed
           Array(completed).each do |step|
-            completed_param = qualify_step(options[:default_repository],options[:default_workflow],step)
+            completed_param = qualify_step(options[:default_repository], options[:default_workflow], step)
             uri_string << "&completed=#{completed_param}"
           end
         end
 
-        if options[:limit] && options[:limit].to_i > 0
-          uri_string << "&limit=#{options[:limit].to_i}"
-        end
-
+        uri_string << "&limit=#{options[:limit].to_i}"  if options[:limit] && options[:limit].to_i > 0
         uri_string << "&lane-id=#{lane_id}"
 
-        workflow_resource.options[:timeout] = 5 * 60 unless(workflow_resource.options.include?(:timeout))
-        resp = workflow_resource[uri_string].get
+        workflow_resource.options[:timeout] = 5 * 60 unless workflow_resource.options.include?(:timeout)
+        resp = workflow_resource_method uri_string
         #
         # response looks like:
         #    <objects count="2">
@@ -299,10 +304,9 @@ module Dor
       #     Dor::WorkflowService.get_errored_objects_for_workstep('accessionWF','content-metadata')
       #     => {"druid:qd556jq0580"=>"druid:qd556jq0580 - Item error; caused by
       #        #<Rubydora::FedoraInvalidRequest: Error modifying datastream contentMetadata for druid:qd556jq0580. See logger for details>"}
-      def get_errored_objects_for_workstep workflow, step, repository='dor'
+      def get_errored_objects_for_workstep(workflow, step, repository = 'dor')
+        resp = workflow_resource_method "workflow_queue?repository=#{repository}&workflow=#{workflow}&error=#{step}"
         result = {}
-        uri_string = "workflow_queue?repository=#{repository}&workflow=#{workflow}&error=#{step}"
-        resp = workflow_resource[uri_string].get
         Nokogiri::XML(resp).xpath('//object').collect do |node|
           result.merge!(node['id'] => node['errorMessage'])
         end
@@ -316,7 +320,7 @@ module Dor
       # @param [String] repository -- optional, default=dor
       #
       # @return [Integer] Number of objects with this repository:workflow:step that have a status of 'error'
-      def count_errored_for_workstep(workflow, step, repository='dor')
+      def count_errored_for_workstep(workflow, step, repository = 'dor')
         count_objects_in_step(workflow, step, repository, 'error')
       end
 
@@ -327,7 +331,7 @@ module Dor
       # @param [String] repository -- optional, default=dor
       #
       # @return [Integer] Number of objects with this repository:workflow:step that have a status of 'queued'
-      def count_queued_for_workstep(workflow, step, repository='dor')
+      def count_queued_for_workstep(workflow, step, repository = 'dor')
         count_objects_in_step(workflow, step, repository, 'queued')
       end
 
@@ -342,8 +346,7 @@ module Dor
       #  :workflow, :step, :druid, :lane_id
       def get_stale_queued_workflows(repository, opts = {})
         uri_string = build_queued_uri(repository, opts)
-        xml = workflow_resource[uri_string].get
-        parse_queued_workflows_response xml
+        parse_queued_workflows_response workflow_resource_method(uri_string)
       end
 
       # Returns a count of workflow steps that have a status of 'queued' that have a last-updated timestamp older than the number of hours passed in
@@ -353,31 +356,31 @@ module Dor
       #   meaning you will get all queued workflows
       # @return [Integer] number of stale, queued steps if the :count_only option was set to true
       def count_stale_queued_workflows(repository, opts = {})
-        uri_string = build_queued_uri(repository, opts)
-        uri_string << "&count-only=true"
-        xml = workflow_resource[uri_string].get
-        doc = Nokogiri::XML(xml)
-        return doc.at_xpath('/objects/@count').value.to_i
+        uri_string = build_queued_uri(repository, opts) + '&count-only=true'
+        doc = Nokogiri::XML(workflow_resource_method uri_string)
+        doc.at_xpath('/objects/@count').value.to_i
       end
 
+      # @param [Hash] params
       # @return [String]
       def create_process_xml(params)
         builder = Nokogiri::XML::Builder.new do |xml|
-          attrs = params.reject { |k,v| v.nil? }
-          attrs = Hash[ attrs.map {|k,v| [k.to_s.camelize(:lower), v]}]  # camelize all the keys in the attrs hash
+          attrs = params.reject { |k, v| v.nil? }
+          attrs = Hash[ attrs.map {|k, v| [k.to_s.camelize(:lower), v]}]  # camelize all the keys in the attrs hash
           xml.process(attrs)
         end
-        return builder.to_xml
+        builder.to_xml
       end
 
       # @return [Nokogiri::XML::Document]
       def query_lifecycle(repo, druid, active_only = false)
         req = "#{repo}/objects/#{druid}/lifecycle"
         req << '?active-only=true' if active_only
-        lifecycle_xml = workflow_resource[req].get
-        return Nokogiri::XML(lifecycle_xml)
+        Nokogiri::XML(workflow_resource_method req)
       end
 
+      # @param [String] repo The repository the object resides in.  The service recoginzes "dor" and "sdr" at the moment
+      # @param [String] druid The id of the object to archive the workflows from
       def archive_active_workflow(repo, druid)
         workflows = get_active_workflows(repo, druid)
         workflows.each do |wf|
@@ -385,12 +388,13 @@ module Dor
         end
       end
 
-      def archive_workflow(repo, druid, wf_name, version_num=nil)
-        raise "Please call Dor::WorkflowService.configure(workflow_service_url, :dor_services_url => DOR_SERVIES_URL) once before archiving workflow" if(@@dor_services_url.nil?)
-
+      # @param [String] repo The repository the object resides in.  The service recoginzes "dor" and "sdr" at the moment
+      # @param [String] druid The id of the object to delete the workflow from
+      def archive_workflow(repo, druid, wf_name, version_num = nil)
+        raise 'Please call Dor::WorkflowService.configure(workflow_service_url, :dor_services_url => DOR_SERVIES_URL) once before archiving workflow' if @@dor_services_url.nil?
         dor_services = RestClient::Resource.new(@@dor_services_url)
         url = "/v1/objects/#{druid}/workflows/#{wf_name}/archive"
-        url << "/#{version_num}" if(version_num)
+        url << "/#{version_num}" if version_num
         dor_services[url].post ''
       end
 
@@ -404,9 +408,9 @@ module Dor
       # @param [Boolean] create_accession_wf Option to create accessionWF when closing a version.  Defaults to true
       def close_version(repo, druid, create_accession_wf = true)
         uri = "#{repo}/objects/#{druid}/versionClose"
-        uri << "?create-accession=false" unless create_accession_wf
-        workflow_resource[uri].post ''
-        return true
+        uri << '?create-accession=false' unless create_accession_wf
+        workflow_resource_method(uri, 'post', '')
+        true
       end
 
       # Returns all the distinct laneIds for a given workflow step
@@ -417,57 +421,74 @@ module Dor
       # @return [Array<String>] all of the distinct laneIds.  Array will be empty if no lane ids were found
       def get_lane_ids(repo, workflow, process)
         uri = "workflow_queue/lane_ids?step=#{repo}:#{workflow}:#{process}"
-        doc = Nokogiri::XML(workflow_resource[uri].get)
+        doc = Nokogiri::XML(workflow_resource_method uri)
         nodes = doc.xpath('/lanes/lane')
-        nodes.map {|n| n['id']}
+        nodes.map { |n| n['id'] }
       end
 
-      # @return [RestClient::Resource] the REST client resource
+      ### MIMICKING ATTRIBUTE READER
+      # @return [RestClient::Resource] the REST client resource created during configure()
       def workflow_resource
-        raise "Please call Dor::WorkflowService.configure(url) once before calling any WorkflowService methods" if(@@resource.nil?)
+        raise 'Please call Dor::WorkflowService.configure(url) once before calling any WorkflowService methods' if @@resource.nil?
         @@resource
       end
 
+      # Among other things, a distinct method helps tests mock default logger
+      # @param [String, IO] logdev The log device. This is a filename (String) or IO object (typically STDOUT, STDERR, or an open file).
+      # @param [String, Integer] shift_age Number of old log files to keep, or frequency of rotation (daily, weekly or monthly).
+      # @return [Logger] default logger object
+      def default_logger(logdev = 'workflow_service.log', shift_age = 'weekly')
+        Logger.new(logdev, shift_age)
+      end
+
+      def workflow_service_exceptions_to_catch
+        [RestClient::Exception]
+      end
+
       # Configure the workflow service
-      #
+      # TODO: replace with initialize
       # @param [String] url points to the workflow service
       # @param [Hash] opts optional params
-      # @option opts [String] :dor_services_uri uri to the DOR REST service
+      # @option opts [Logger] :logger defaults writing to workflow_service.log with weekly rotation
+      # @option opts [String] :dor_services_url uri to the DOR REST service
       # @option opts [Integer] :timeout number of seconds for RestClient timeout
       # @option opts [String] :client_cert_file path to an SSL client certificate (deprecated)
       # @option opts [String] :client_key_file path to an SSL key file (deprecated)
       # @option opts [String] :client_key_pass password for the key file (deprecated)
       # @return [RestClient::Resource] the REST client resource
-      def configure(url, opts={})
+      def configure(url, opts = {})
         params = {}
-        params[:timeout] = opts[:timeout] if opts[:timeout]
+        params[:timeout]   = opts[:timeout] if opts[:timeout]
+        @@logger           = opts[:logger] || default_logger
         @@dor_services_url = opts[:dor_services_url] if opts[:dor_services_url]
-        #params[:ssl_client_cert] = OpenSSL::X509::Certificate.new(File.read(opts[:client_cert_file])) if opts[:client_cert_file]
-        #params[:ssl_client_key]  = OpenSSL::PKey::RSA.new(File.read(opts[:client_key_file]), opts[:client_key_pass]) if opts[:client_key_file]
+        # params[:ssl_client_cert] = OpenSSL::X509::Certificate.new(File.read(opts[:client_cert_file])) if opts[:client_cert_file]
+        # params[:ssl_client_key]  = OpenSSL::PKey::RSA.new(File.read(opts[:client_key_file]), opts[:client_key_pass]) if opts[:client_key_file]
+        @@handler = Proc.new do |exception, attempt_number, total_delay|
+          @@logger.warn "[Attempt #{attempt_number}] #{exception.class}: #{exception.message}; #{total_delay} seconds elapsed."
+        end
         @@resource = RestClient::Resource.new(url, params)
       end
 
+
       protected
 
       def build_queued_uri(repository, opts = {})
         uri_string = "workflow_queue/all_queued?repository=#{repository}"
         uri_string << "&hours-ago=#{opts[:hours_ago]}" if opts[:hours_ago]
-        uri_string << "&limit=#{opts[:limit]}" if opts[:limit]
+        uri_string << "&limit=#{opts[:limit]}"         if opts[:limit]
         uri_string
       end
 
       def parse_queued_workflows_response(xml)
-        res = []
         doc = Nokogiri::XML(xml)
-        doc.xpath('/workflows/workflow').each do |wf_node|
-          wf = {}
-          wf[:workflow] = wf_node['name']
-          wf[:step]     = wf_node['process']
-          wf[:druid]    = wf_node['druid']
-          wf[:lane_id] = wf_node['laneId']
-          res << wf
+        doc.xpath('/workflows/workflow').collect do |wf_node|
+          {
+            :workflow => wf_node['name'],
+            :step     => wf_node['process'],
+            :druid    => wf_node['druid'],
+            :lane_id  => wf_node['laneId']
+          }
         end
-        res
       end
 
       # Adds laneId attributes to each process of workflow xml
@@ -482,13 +503,32 @@ module Dor
       end
 
       def count_objects_in_step(workflow, step, type, repo)
-        uri_string = "workflow_queue?repository=#{repo}&workflow=#{workflow}&#{type}=#{step}"
-        resp = @workflow_resource[uri_string].get
+        resp = workflow_resource_method "workflow_queue?repository=#{repo}&workflow=#{workflow}&#{type}=#{step}"
         node = Nokogiri::XML(resp).at_xpath('/objects')
-        raise "Unable to determine count from response" if node.nil?
+        raise 'Unable to determine count from response' if node.nil?
         node['count'].to_i
       end
 
+      # calls workflow_resource[uri_string]."#{meth}" with variable number of optional arguments
+      # The point of this is to wrap ALL remote calls with consistent error handling and logging
+      # @param [String] uri_string resource to request
+      # @param [String] meth REST method to use on resource (get, put, post, delete, etc.)
+      # @param [String] payload body for (e.g. put) request
+      # @param [Hash] opts addtional headers options
+      # @return [Object] response from method
+      def workflow_resource_method(uri_string, meth = 'get', payload = '', opts = {})
+        with_retries(:max_tries => 2, :handler => @@handler, :rescue => workflow_service_exceptions_to_catch) do |attempt|
+          @@logger.info "[Attempt #{attempt}] #{meth} #{workflow_resource.url}/#{uri_string}"
+          if %w[get delete].include?(meth)
+            workflow_resource[uri_string].send(meth, opts)
+          elsif opts.size == 0    # the right number of args allows existing test expect/with statements to continue working
+            workflow_resource[uri_string].send(meth, payload)
+          else
+            workflow_resource[uri_string].send(meth, payload, opts)
+          end
+        end
+      end
+
     end
   end
 end