dor-workflow-service 1.5.1 → 1.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDZjYmEwY2M5NzNiNjE0MjFlNjk4NmFlOTM3NDZjMmZmOTNkN2M2ZQ==
+    Mzg4NWZmMjc0OWU3NGRjNWJlZTRlNTYyNzA4NTU4ZDJjNGQzMDE4NA==
   data.tar.gz: !binary |-
-    MjcyNmQxNjU1ZjU2ZmQ3NDA4M2U0NjNkOTU4NjVmOTUzNDU5YjhmOA==
+    OWQ2ZWQ3NThiODc1MWU2ODY4ZWY0MDY5ZmI3MTI4YmU0YjE5Mjg3MA==
 SHA512:
   metadata.gz: !binary |-
-    MjBhYmM4NzBjZDQwMmY5NzFhYWU2NzdjNzI0YmU5N2U3YWRlZGEwYzQyMzc2
-    ZjE0Mjk1ZWU2NzZmNGQ0MmRhM2ExZGUxYzJjNzk1MGE0ZWNjY2Q3YjllYmI2
-    ZTRmODI3Yjg4YjUzZjAxYjk3ODA0MWUwMjQyNDYwY2VlZmMyMTk=
+    Mzg0MzkzMmI3OWVmMzZhOGI4ZjFjN2QxMTE1ZmQxMDRlMGU5ZTVlODQwMjU0
+    NTYzYWY0YmU0MTc4ZDQzZmM0NDIyYTc3OWFmNjZmNTc2NjQ4NWJhMTEzMGU3
+    ZDZjOGUyYzZkY2U5MmFkNDg4NzYxMTg5M2MxOGY5OGY5NGE3YTE=
   data.tar.gz: !binary |-
-    NzYzZjM1NzFlZmI1MjkyNWI5MzkzZmZmNGNhODZkMDY4NDM4YzFhYTUwMDUw
-    MzJlMWFjODIwZDJjNmNjOGEyMjU0MTQzN2JjNGMyZTU4NDY2NGZjOGQ2YmU4
-    OTVmMzViMWQ0MDk5MmZkM2ZjYTNhYTE1N2Q0YzZiNGY1MmJmMDQ=
+    ZGRjZTE2NzUxMDc3NTM4NzY1NjVhNDc5ZGIyY2M3Zjc1NDdjYTFkMjEzMmM0
+    OTA5YjlmNmJhNzI5MGYxYzA4YWNkNDNiMzBkZGQxZjkyYTQyZWRmOGQwMTI2
+    N2E4YmJlM2ExY2M0NGQxN2M3YzU1NmEwMDllYWVhNjU2OTUzNWU=

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/README.md

@@ -1,11 +1,13 @@
+
 # dor-workflow-service gem
 
-Provides Ruby convenience methods to work with the DOR Workflow REST Service.  The REST API is defined here:
+Provides Ruby convenience methods to work with the DOR Workflow REST Service. The REST API is defined here:
 https://consul.stanford.edu/display/DOR/DOR+services#DORservices-initializeworkflow
 
 ## Usage
 
-To initialize usage of the service, you need to call Dor::WorkflowService.configure, like in a bootup or startup method, e.g.:
+To initialize usage of the service, you need to call `Dor::WorkflowService.configure`, like in a bootup or startup method,
+e.g.:
 
     Dor::WorkflowService.configure('https://test-server.edu/workflow/')
 
@@ -13,4 +15,5 @@ If you plan to archive workflows, then you need to set the URL to the Dor REST s
 
     Dor::WorkflowService.configure('https://test-server.edu/workflow/', :dor_services_url => 'https://sul-lyberservices-dev.stanford.edu/dor')
 
-There's no need to call Dor::WorkflowService.configure if using the dor-services gem and using the Dor::Config object.  The latest versions of dor-services will configure the workflow service for you.
+There's no need to call `Dor::WorkflowService.configure` if using the `dor-services` gem and using the `Dor::Config`
+ object.  The latest versions of `dor-services` will configure the workflow service for you.

data/dor-workflow-service.gemspec

@@ -6,7 +6,7 @@ require 'dor/workflow_version'
 Gem::Specification.new do |gem|
   gem.name          = "dor-workflow-service"
   gem.version       = Dor::Workflow::Service::VERSION
-  gem.authors       = ["Willy Mene"]
+  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"
@@ -17,14 +17,14 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "activesupport"
-  gem.add_dependency "nokogiri"
-  gem.add_dependency "rest-client"
-  gem.add_dependency "confstruct"
+  gem.add_dependency "activesupport", '~> 4.0.4'
+  gem.add_dependency "nokogiri", '~> 1.6.0'
+  gem.add_dependency "rest-client", '~> 1.6.7'
+  gem.add_dependency "confstruct", '~> 0.2.7'
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "yard"
   gem.add_development_dependency "redcarpet"
-  gem.add_development_dependency "equivalent-xml"
+  gem.add_development_dependency "equivalent-xml", '~> 0.3.0'
 end

data/lib/dor/services/workflow_service.rb

@@ -11,11 +11,13 @@ module Dor
       @@resource = nil
       @@dor_services_url = nil
 
+      # From Workflow Service's admin/Process.java
+      VALID_STATUS = %w{waiting completed error queued skipped hold}
+
       # Creates a workflow for a given object in the repository.  If this particular workflow for this objects exists,
       # it will replace the old workflow with wf_xml passed to this method.  You have the option of creating a datastream or not.
       # Returns true on success.  Caller must handle any exceptions
       #
-      # == Parameters
       # @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
       # @param [String] workflow_name The name of the workflow you want to create
@@ -24,6 +26,7 @@ module Dor
       # @option opts [Boolean] :create_ds if true, a workflow datastream will be created in Fedora.  Set to false if you do not want a datastream to be created
       #   If you do not pass in an <b>opts</b> Hash, then :create_ds is set to true by default
       # @option opts [Integer] :priority adds priority to all process elements in the wf_xml workflow xml
+      # @return [Boolean] always true
       #
       def create_workflow(repo, druid, workflow_name, wf_xml, opts = {:create_ds => true})
         xml = wf_xml
@@ -51,29 +54,42 @@ module Dor
       # @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
       # @param [String] workflow The name of the workflow
-      # @param [String] status The status that you want to set.  Typical statuses are 'waiting', 'completed', 'error', but could be any string
+      # @param [String] process The name of the process step
+      # @param [String] status The status that you want to set -- using one of the values in VALID_STATUS
       # @param [Hash] opts optional values for the workflow step
       # @option opts [Float] :elapsed The number of seconds it took to complete this step. Can have a decimal.  Is set to 0 if not passed in.
       # @option opts [String] :lifecycle Bookeeping label for this particular workflow step.  Examples are: 'registered', 'shelved'
       # @option opts [String] :note Any kind of string annotation that you want to attach to the workflow
-      # @option opts [Integer] :priority Processing priority, 0-100, 100 being the highest priority. Workflow queues are returned in order of highest to lowest priority.  Stored in the system as 0 by default
-      # == Http Call
-      # The method does an HTTP PUT to the URL defined in Dor::WF_URI.  As an example:
-      #   PUT "/dor/objects/pid:123/workflows/GoogleScannedWF/convert"
-      #   <process name=\"convert\" status=\"completed\" />"
+      # @option opts [Integer] :priority Processing priority. Recommended range is -100..100, 100 being the highest priority, and -100 being the lowest priority. Workflow queues are returned in order of highest to lowest priority value. Default is 0.
+      # @option opts [String] :current_status Setting this string tells the workflow service to compare the current status to this value.  If the current value does not match this value, the update is not performed
+      # @return [Boolean] always true
+      # Http Call
+      # ==
+      # The method does an HTTP PUT to the URL defined in `Dor::WF_URI`.  As an example:
+      #
+      #     PUT "/dor/objects/pid:123/workflows/GoogleScannedWF/convert"
+      #     <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] = opts[:elapsed].to_s
-        xml = create_process_xml({:name => process, :status => status}.merge!(opts))
-        workflow_resource["#{repo}/objects/#{druid}/workflows/#{workflow}/#{process}"].put(xml, :content_type => 'application/xml')
+        current_status = opts.delete(:current_status)
+        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
       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] druid The id of the object
+      # @param [String] workflow The name of the workflow
+      # @param [String] process The name of the process step
+      # @return [String] status for repo-workflow-process-druid
       def get_workflow_status(repo, druid, workflow, process)
-        workflow_md = workflow_resource["#{repo}/objects/#{druid}/workflows/#{workflow}"].get
+        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?)
 
@@ -84,6 +100,12 @@ module Dor
         return 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] 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
       end
@@ -93,7 +115,8 @@ module Dor
       #
       # @param [String] pid of druid
       # @return [Array<String>] list of worklows
-      # @example Dor::WorkflowService.get_workflows('druid:sr100hp0609')
+      # @example
+      #   Dor::WorkflowService.get_workflows('druid:sr100hp0609')
       #   => ["accessionWF", "assemblyWF", "disseminationWF"]
       def get_workflows(pid)
         xml_doc=Nokogiri::XML(get_workflow_xml('dor',pid,''))
@@ -106,7 +129,8 @@ module Dor
       # @param [String] repo repository of the object
       # @param [String] pid id of object
       # @return [Array<String>] list of active worklows.  Returns an empty Array if none are found
-      # @example Dor::WorkflowService.get_workflows('dor', 'druid:sr100hp0609')
+      # @example
+      #   Dor::WorkflowService.get_workflows('dor', 'druid:sr100hp0609')
       #   => ["accessionWF", "assemblyWF", "disseminationWF"]
       def get_active_workflows(repo, pid)
         doc = Nokogiri::XML(get_workflow_xml(repo,pid,''))
@@ -122,11 +146,14 @@ module Dor
       # @param [String] error_msg The error message.  Ideally, this is a brief message describing the error
       # @param [Hash] opts optional values for the workflow step
       # @option opts [String] :error_txt A slot to hold more information about the error, like a full stacktrace
+      # @return [Boolean] always true
       #
-      # == Http Call
-      # The method does an HTTP PUT to the URL defined in Dor::WF_URI.  As an example:
-      #   PUT "/dor/objects/pid:123/workflows/GoogleScannedWF/convert"
-      #   <process name=\"convert\" status=\"error\" />"
+      # Http Call
+      # ==
+      # The method does an HTTP PUT to the URL defined in `Dor::WF_URI`.
+      #
+      #     PUT "/dor/objects/pid:123/workflows/GoogleScannedWF/convert"
+      #     <process name=\"convert\" status=\"error\" />"
       def update_workflow_error_status(repo, druid, workflow, process, error_msg, opts = {})
         opts = {:error_txt => nil}.merge!(opts)
         xml = create_process_xml({:name => process, :status => 'error', :errorMessage => error_msg}.merge!(opts))
@@ -138,13 +165,14 @@ module Dor
       # @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
       # @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
       end
 
       # Returns the Date for a requested milestone from workflow lifecycle
-      # @param [String] repo epository name
+      # @param [String] repo repository name
       # @param [String] druid object id
       # @param [String] milestone name of the milestone being queried for
       # @return [Time] when the milestone was achieved.  Returns nil if the milestone does not exist
@@ -185,6 +213,7 @@ module Dor
         nil
       end
 
+      # @return [Hash]
       def get_milestones(repo, druid)
         doc = self.query_lifecycle(repo, druid)
         doc.xpath("//lifecycle/milestone").collect do |node|
@@ -192,6 +221,16 @@ module Dor
         end
       end
 
+      # 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
+      # @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
@@ -199,41 +238,77 @@ module Dor
         current.join(':')
       end
 
-
       # Returns a list of druids from the WorkflowService that meet the criteria of the passed in completed and waiting params
       #
-      # @param [Array<String>, String] completed An array or single String of the completed steps, should use the qualified format:
-      #   repository:workflow:step-name
+      # @param [Array<String>, String] completed An array or single String of the completed steps, should use the qualified format: `repository:workflow:step-name`
       # @param [String] waiting name of the waiting step
       # @param [String] repository default repository to use if it isn't passed in the qualified-step-name
       # @param [String] workflow default workflow to use if it isn't passed in the qualified-step-name
-      def get_objects_for_workstep completed, waiting, repository=nil, workflow=nil
+      # @param [Hash] options
+      # @option options [Boolean] :with_priority include the priority with each druid
+      # @option options [Integer] :limit maximum number of druids to return (nil for no limit)
+      # @return [Array<String>, Hash] if with_priority, hash with druids as keys with their Integer priority as value; else Array of druids
+      #
+      # @example
+      #     get_objects_for_workstep(...)
+      #     => [
+      #        "druid:py156ps0477",
+      #        "druid:tt628cb6479",
+      #        "druid:ct021wp7863"
+      #      ]
+      #
+      # @example
+      #     get_objects_for_workstep(..., with_priority: true)
+      #     => {
+      #      "druid:py156ps0477" => 100,
+      #      "druid:tt628cb6479" => 0,
+      #      "druid:ct021wp7863" => -100
+      #     }
+      #
+      def get_objects_for_workstep completed, waiting, repository=nil, workflow=nil, options = {}
         result = nil
+        uri_string = "workflow_queue?waiting=#{qualify_step(repository,workflow,waiting)}"
         if(completed)
-          uri_string = "workflow_queue?waiting=#{qualify_step(repository,workflow,waiting)}"
           Array(completed).each do |step|
             uri_string << "&completed=#{qualify_step(repository,workflow,step)}"
           end
-        else
-          uri_string = "workflow_queue?waiting=#{qualify_step(repository,workflow,waiting)}"
         end
+
+        if options[:limit] and options[:limit].to_i > 0
+          uri_string << "&limit=#{options[:limit].to_i}"
+        end
+
         workflow_resource.options[:timeout] = 5 * 60 unless(workflow_resource.options.include?(:timeout))
         resp = workflow_resource[uri_string].get
-        result = Nokogiri::XML(resp).xpath('//object[@id]').collect { |node| node['id'] }
+        #
+        # response looks like:
+        #    <objects count="2">
+        #      <object id="druid:ab123de4567" priority="2"/>
+        #      <object id="druid:ab123de9012" priority="1"/>        #
+        #    </objects>
+        #
+        # convert into:
+        #    { 'druid:ab123de4567' => 2, 'druid:ab123de9012' => 1}
+        #
+        result = Nokogiri::XML(resp).xpath('//object[@id]').inject({}) do |h, node|
+          h[node['id']] = node['priority'] ? node['priority'].to_i : 0
+          h
+        end
 
-        result || []
+        options[:with_priority] ? result : result.keys
       end
 
       # Get a list of druids that have errored out in a particular workflow and step
       #
-      # @param [string] workflow name
-      # @param [string] step name
-      # @param [string] repository -- optional, default=dor
+      # @param [String] workflow name
+      # @param [String] step name
+      # @param [String] repository -- optional, default=dor
       #
-      # @return [hash] hash of results, with key has a druid, and value as the error message
-      # e.g.
-      # 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>"}
+      # @return [Hash] hash of results, with key has a druid, and value as the error message
+      # @example
+      #     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'
         result = {}
         uri_string = "workflow_queue?repository=#{repository}&workflow=#{workflow}&error=#{step}"
@@ -244,6 +319,34 @@ module Dor
         result
       end
 
+      # Gets all of the workflow steps that have a status of 'queued' that have a last-updated timestamp older than the number of hours passed in
+      #   This will enable re-queueing of jobs that have been lost by the job manager
+      # @param [String] repository name of the repository you want to query, like 'dor' or 'sdr'
+      # @param [Hash] opts optional values for query
+      # @option opts [Integer] :hours_ago steps older than this value will be returned by the query.  If not passed in, the service defaults to 24 hours
+      # @option opts [Integer] :limit sets the maximum number of workflow steps that can be returned.  Defaults to no limit
+      # @return [Array[Hash]] each Hash represents a workflow step.  It will have the following keys:
+      #  :workflow, :step, :druid, :priority
+      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
+      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
+      # @param [String] repository name of the repository you want to query, like 'dor' or 'sdr'
+      # @param [Hash] opts optional values for query
+      # @option opts [Integer] :hours_ago steps older than this value will be returned by the query.  If not passed in, the service defaults to 24 hours
+      # @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
+      end
+
+      # @return [String]
       def create_process_xml(params)
         builder = Nokogiri::XML::Builder.new do |xml|
           attrs = params.reject { |k,v| v.nil? }
@@ -252,6 +355,7 @@ module Dor
         return 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
@@ -276,8 +380,10 @@ module Dor
       end
 
       # Calls the versionClose endpoint of the WorkflowService:
-      #   - completes the versioningWF:submit-version and versioningWF:start-accession steps
-      #   - initiates accesssionWF
+      #
+      # - completes the versioningWF:submit-version and versioningWF:start-accession steps
+      # - initiates accesssionWF
+      #
       # @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
       # @param [Boolean] create_accession_wf Option to create accessionWF when closing a version.  Defaults to true
@@ -288,17 +394,22 @@ module Dor
         return true
       end
 
+      # @return [RestClient::Resource] the REST client resource
       def workflow_resource
         raise "Please call Dor::WorkflowService.configure(url) once before calling any WorkflowService methods" if(@@resource.nil?)
         @@resource
       end
 
+      # Configure the workflow service
+      #
       # @param [String] url points to the workflow service
       # @param [Hash] opts optional params
-      # @option opts [String] :client_cert_file path to an SSL client certificate
-      # @option opts [String] :client_key_file path to an SSL key file
-      # @option opts [String] :client_key_pass password for the key file
       # @option opts [String] :dor_services_uri 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={})
         params = {}
         params[:timeout] = opts[:timeout] if opts[:timeout]
@@ -308,6 +419,29 @@ module Dor
         @@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
+    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[:priority] = wf_node['priority'].to_i
+        res << wf
+      end
+      res
+    end
+
     end
   end
 end

data/lib/dor/workflow_version.rb

@@ -1,7 +1,7 @@
 module Dor
   module Workflow
     module Service
-      VERSION = "1.5.1"
+      VERSION = "1.6.0"
     end
   end
 end

data/spec/workflow_service_spec.rb

@@ -85,6 +85,12 @@ describe Dor::WorkflowService do
       @mock_resource.should_receive(:put).with(@xml_re, { :content_type => 'application/xml' }).and_raise(ex)
       lambda{ Dor::WorkflowService.update_workflow_status(@repo, @druid, "etdSubmitWF", "reader-approval", "completed") }.should raise_error(Exception, "exception thrown")
     end
+
+    it "performs a conditional update when current-status is passed as a parameter" do
+       @mock_resource.should_receive(:[]).with("dor/objects/druid:123/workflows/etdSubmitWF/reader-approval?current-status=queued")
+      @mock_resource.should_receive(:put).with(@xml_re, { :content_type => 'application/xml' }).and_return('')
+      Dor::WorkflowService.update_workflow_status(@repo, @druid, "etdSubmitWF", "reader-approval", "completed", :version => 2, :note => 'annotation', :priority => 34, :current_status => 'queued').should be_true
+    end
   end
 
   describe "#update_workflow_error_status" do
@@ -188,10 +194,24 @@ describe Dor::WorkflowService do
         qualified_completed2 = "#{repo2}:#{workflow2}:#{completed2}"
         qualified_completed3 = "#{repo2}:#{workflow2}:#{completed3}"
         @mock_resource.should_receive(:[]).with("workflow_queue?waiting=#{qualified_waiting}&completed=#{qualified_completed}&completed=#{qualified_completed2}&completed=#{qualified_completed3}")
-        @mock_resource.should_receive(:get).and_return(%{<objects count="2"><object id="druid:ab123de4567" priority="0"/><object id="druid:ab123de9012" priority="0"/></objects>})
+        @mock_resource.should_receive(:get).and_return(%{<objects count="2"><object id="druid:ab123de4567" priority="1"/><object id="druid:ab123de9012" priority="0"/></objects>})
         Dor::WorkflowService.get_objects_for_workstep([qualified_completed, qualified_completed2, qualified_completed3], qualified_waiting).should == ['druid:ab123de4567', 'druid:ab123de9012']
       end
 
+      it "same but with priority" do
+        qualified_waiting = "#{@repository}:#{@workflow}:#{@waiting}"
+        qualified_completed = "#{@repository}:#{@workflow}:#{@completed}"
+        repo2 = "sdr"
+        workflow2 = "sdrIngestWF"
+        completed2="complete-deposit"
+        completed3="ingest-transfer"
+        qualified_completed2 = "#{repo2}:#{workflow2}:#{completed2}"
+        qualified_completed3 = "#{repo2}:#{workflow2}:#{completed3}"
+        @mock_resource.should_receive(:[]).with("workflow_queue?waiting=#{qualified_waiting}&completed=#{qualified_completed}&completed=#{qualified_completed2}&completed=#{qualified_completed3}")
+        @mock_resource.should_receive(:get).and_return(%{<objects count="2"><object id="druid:ab123de4567" priority="2"/><object id="druid:ab123de9012" priority="1"/></objects>})
+        Dor::WorkflowService.get_objects_for_workstep([qualified_completed, qualified_completed2, qualified_completed3], qualified_waiting, nil, nil, with_priority: true).should == { 'druid:ab123de4567' => 2, 'druid:ab123de9012' => 1}
+      end
+
       it "creates the URI string with only one completed step passed in as a String" do
         qualified_waiting = "#{@repository}:#{@workflow}:#{@waiting}"
         qualified_completed = "#{@repository}:#{@workflow}:#{@completed}"
@@ -209,6 +229,14 @@ describe Dor::WorkflowService do
         @mock_resource.should_receive(:get).and_return(%{<objects count="1"><object id="druid:ab123de4567"/></objects>})
         Dor::WorkflowService.get_objects_for_workstep(nil, qualified_waiting).should == ['druid:ab123de4567']
       end
+
+      it "same but with priority" do
+        qualified_waiting = "#{@repository}:#{@workflow}:#{@waiting}"
+
+        @mock_resource.should_receive(:[]).with("workflow_queue?waiting=#{qualified_waiting}")
+        @mock_resource.should_receive(:get).and_return(%{<objects count="1"><object id="druid:ab123de4567" priority="33"/></objects>})
+        Dor::WorkflowService.get_objects_for_workstep(nil, qualified_waiting, nil, nil, with_priority: true).should == { 'druid:ab123de4567' => 33 }
+      end
     end
   end
 
@@ -275,4 +303,29 @@ describe Dor::WorkflowService do
     end
   end
 
+  describe ".parse_queued_workflows_response" do
+    it "returns an Array of Hashes containing each workflow step" do
+      xml = <<-XML
+        <workflows>
+            <workflow priority="30" note="annotation" lifecycle="in-process" errorText="stacktrace" errorMessage="NullPointerException" elapsed="1.173" repository="dor" attempts="0" datetime="2008-11-15T13:30:00-0800" status="waiting" process="content-metadata" name="accessionWF" druid="dr:123"/>
+            <workflow priority="30" note="annotation" lifecycle="in-process" errorText="stacktrace" errorMessage="NullPointerException" elapsed="1.173" repository="dor" attempts="0" datetime="2008-11-15T13:30:00-0800" status="waiting" process="jp2-create" name="assemblyWF" druid="dr:456"/>
+        </workflows>
+      XML
+      expected = [ { :workflow => 'accessionWF', :step => 'content-metadata', :druid => 'dr:123', :priority => 30},
+                   { :workflow => 'assemblyWF', :step => 'jp2-create', :druid => 'dr:456', :priority => 30} ]
+
+      ah = Dor::WorkflowService.parse_queued_workflows_response(xml)
+      ah.should eql(expected)
+    end
+  end
+
+  describe ".count_stale_queued_workflows" do
+    it "returns the number of queued workflow steps" do
+      @mock_resource.should_receive(:[]).with("workflow_queue/all_queued?repository=dor&hours-ago=48&count-only=true")
+      @mock_resource.should_receive(:get).and_return(%{<objects count="10"/>})
+
+      Dor::WorkflowService.count_stale_queued_workflows('dor', :hours_ago => 48).should == 10
+    end
+  end
+
 end

metadata

@@ -1,71 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-service
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Willy Mene
+- Darren Hardy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-13 00:00:00.000000000 Z
+date: 2014-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.4
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.7
 - !ruby/object:Gem::Dependency
   name: confstruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.7
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +127,16 @@ dependencies:
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
 description: Enables Ruby manipulation of the DOR Workflow Service via its REST API
 email:
 - wmene@stanford.edu
@@ -146,6 +147,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -183,3 +185,4 @@ summary: Provides convenience methods to work with the DOR Workflow Service
 test_files:
 - spec/spec_helper.rb
 - spec/workflow_service_spec.rb
+has_rdoc: