dor-workflow-service 1.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d6fc3e584fe89a00011d92d20c3808bdbb7a9fe
+  data.tar.gz: 1f9c905de65222b5b1bcf85faa9a0caeb4b03054
+SHA512:
+  metadata.gz: a93219741feb1dfed55872d75a97c6822debb2781b3b7aedf90daeb03bd28155baca5ec823d223fde63f5ce76aa0684505df5c35f90d750b815a0380b682897e
+  data.tar.gz: 2165204dc1a3b3c14dc9fa8c555e7959a6bcbc134d752bdae29023828fdd97c8fce9ce384b1facdc4c0b4716cd6824271151d2a4e2d774f286c415371a13143f

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset
+

data/.travis.yml

@@ -0,0 +1,7 @@
+notifications:
+  email: false
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dor-workflow-service.gemspec
+gemspec
+
+if RUBY_VERSION < '1.9'
+  gem 'activesupport', "< 4.0"
+end
+
+group :development do
+  gem "debugger", :platform => :ruby_19
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Willy Mene
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,16 @@
+# dor-workflow-service gem
+
+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.:
+
+    Dor::WorkflowService.configure('https://test-server.edu/workflow/')
+
+If you plan to archive workflows, then you need to set the URL to the Dor REST service:
+
+    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.

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb', 'test/**/*.rb'
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/bin/console

@@ -0,0 +1,13 @@
+#! /usr/bin/env ruby
+
+require 'rubygems'
+require 'irb'
+
+project_root = File.expand_path(File.dirname(__FILE__) + '/..')
+
+# Load config for current environment.
+$LOAD_PATH.unshift(project_root + '/lib')
+
+require 'dor-workflow-service'
+
+IRB.start

data/dor-workflow-service.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.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.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  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_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "yard"
+  gem.add_development_dependency "redcarpet"
+  gem.add_development_dependency "equivalent-xml"
+end

data/lib/dor-workflow-service.rb

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

data/lib/dor/services/workflow_service.rb

@@ -0,0 +1,281 @@
+require 'rest-client'
+require 'active_support/core_ext'
+require 'nokogiri'
+
+module Dor
+
+  # Methods to create and update workflow
+  module WorkflowService
+    class << self
+
+      @@resource = nil
+      @@dor_services_url = nil
+
+      # 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
+      # @param [String] wf_xml The xml that represents the workflow
+      # @param [Hash] opts optional params
+      # @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
+      #
+      def create_workflow(repo, druid, workflow_name, wf_xml, opts = {:create_ds => true})
+        xml = wf_xml
+        xml = add_priority_to_workflow_xml(opts[:priority], wf_xml) if(opts[:priority])
+        workflow_resource["#{repo}/objects/#{druid}/workflows/#{workflow_name}"].put(xml, :content_type => 'application/xml',
+                                                                                     :params => {'create-ds' => opts[:create_ds] })
+        return true
+      end
+
+      # Adds priority attributes to each process of workflow xml
+      #
+      # @param [Integer] priority value to add to each process element
+      # @param [String] wf_xml the workflow xml
+      # @return [String] wf_xml with priority attributes
+      def add_priority_to_workflow_xml(priority, wf_xml)
+        return wf_xml if(priority.to_i == 0)
+        doc = Nokogiri::XML(wf_xml)
+        doc.xpath('/workflow/process').each { |proc| proc['priority'] = priority }
+        doc.to_xml
+      end
+
+      # Updates the status of one step in a workflow.
+      # Returns true on success.  Caller must handle any exceptions
+      #
+      # @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 [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\" />"
+      def update_workflow_status(repo, druid, workflow, process, status, opts = {})
+        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')
+        return true
+      end
+
+      #
+      # Retrieves the process status of the given workflow for the given object identifier
+      #
+      def get_workflow_status(repo, druid, workflow, process)
+        workflow_md = workflow_resource["#{repo}/objects/#{druid}/workflows/#{workflow}"].get
+        doc = Nokogiri::XML(workflow_md)
+        raise Exception.new("Unable to parse response:\n#{workflow_md}") if(doc.root.nil?)
+
+        status = doc.root.at_xpath("//process[@name='#{process}']/@status")
+        if status
+          status=status.content
+        end
+        return status
+      end
+
+      def get_workflow_xml(repo, druid, workflow)
+        workflow_resource["#{repo}/objects/#{druid}/workflows/#{workflow}"].get
+      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
+      #
+      # @return [array] list of worklows
+      # e.g.
+      # Dor::WorkflowService.get_workflows('druid:sr100hp0609')
+      # => ["accessionWF", "assemblyWF", "disseminationWF"]
+      def get_workflows(pid)
+        xml_doc=Nokogiri::XML(get_workflow_xml('dor',pid,''))
+        return xml_doc.xpath('//workflow').collect {|workflow| workflow['id']}
+      end
+
+      # Updates the status of one step in a workflow to error.
+      # Returns true on success.  Caller must handle any exceptions
+      #
+      # @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] 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
+      #
+      # == 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\" />"
+      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))
+        workflow_resource["#{repo}/objects/#{druid}/workflows/#{workflow}/#{process}"].put(xml, :content_type => 'application/xml')
+        return true
+      end
+
+      # Deletes a workflow from a particular repository and druid
+      # @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
+      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] 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
+      # @example An example lifecycle xml from the workflow service.
+      #   <lifecycle objectId="druid:ct011cv6501">
+      #     <milestone date="2010-04-27T11:34:17-0700">registered</milestone>
+      #     <milestone date="2010-04-29T10:12:51-0700">inprocess</milestone>
+      #     <milestone date="2010-06-15T16:08:58-0700">released</milestone>
+      #   </lifecycle>
+      def get_lifecycle(repo, druid, milestone)
+        doc = self.query_lifecycle(repo, druid)
+        milestone = doc.at_xpath("//lifecycle/milestone[text() = '#{milestone}']")
+        if(milestone)
+          return Time.parse(milestone['date'])
+        end
+
+        nil
+      end
+
+      # Returns the Date for a requested milestone ONLY FROM THE ACTIVE workflow table
+      # @param [String] repo epository 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
+      # @example An example lifecycle xml from the workflow service.
+      #   <lifecycle objectId="druid:ct011cv6501">
+      #     <milestone date="2010-04-27T11:34:17-0700">registered</milestone>
+      #     <milestone date="2010-04-29T10:12:51-0700">inprocess</milestone>
+      #     <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)
+        milestone = doc.at_xpath("//lifecycle/milestone[text() = '#{milestone}']")
+        if(milestone)
+          return Time.parse(milestone['date'])
+        end
+
+        nil
+      end
+
+      def get_milestones(repo, druid)
+        doc = self.query_lifecycle(repo, druid)
+        doc.xpath("//lifecycle/milestone").collect do |node|
+          { :milestone => node.text, :at => Time.parse(node['date']), :version => node['version'] }
+        end
+      end
+
+      def qualify_step(default_repository, default_workflow, step)
+        current = step.split(/:/,3)
+        current.unshift(default_workflow) if current.length < 3
+        current.unshift(default_repository) if current.length < 3
+        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 [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
+        result = nil
+        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
+        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'] }
+
+        result || []
+      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
+      #
+      # @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>"}
+      def get_errored_objects_for_workstep workflow, step, repository='dor'
+        result = {}
+        uri_string = "workflow_queue?repository=#{repository}&workflow=#{workflow}&error=#{step}"
+        resp = workflow_resource[uri_string].get
+        objs = Nokogiri::XML(resp).xpath('//object').collect do |node|
+          result.merge!(node['id'] => node['errorMessage'])
+        end
+        result
+      end
+
+      def create_process_xml(params)
+        builder = Nokogiri::XML::Builder.new do |xml|
+          attrs = params.reject { |k,v| v.nil? }
+          xml.process(attrs)
+        end
+        return builder.to_xml
+      end
+
+      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)
+      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?)
+
+        dor_services = RestClient::Resource.new(@@dor_services_url)
+        url = "/v1/objects/#{druid}/workflows/#{wf_name}/archive"
+        url << "/#{version_num}" if(version_num)
+        dor_services[url].post ''
+      end
+
+      def workflow_resource
+        raise "Please call Dor::WorkflowService.configure(url) once before calling any WorkflowService methods" if(@@resource.nil?)
+        @@resource
+      end
+
+      # @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
+      def configure(url, opts={})
+        params = {}
+        @@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]
+        @@resource = RestClient::Resource.new(url, params)
+      end
+
+    end
+  end
+end

data/lib/dor/workflow_version.rb

@@ -0,0 +1,7 @@
+module Dor
+  module Workflow
+    module Service
+      VERSION = "1.3.3"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Bundler.require(:default, :development)
+
+RSpec.configure do |conf|
+  
+end
+
+Rails = Object.new unless defined? Rails

data/spec/workflow_service_spec.rb

@@ -0,0 +1,245 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'dor-workflow-service'
+require 'equivalent-xml'
+
+describe Dor::WorkflowService do
+
+  let(:wf_xml) { <<-EOXML
+    <workflow id="etdSubmitWF">
+         <process name="register-object" status="completed" attempts="1" />
+         <process name="submit" status="waiting" />
+         <process name="reader-approval" status="waiting" />
+         <process name="registrar-approval" status="waiting" />
+         <process name="start-accession" status="waiting" />
+    </workflow>
+    EOXML
+  }
+
+  before(:each) do
+    @repo = 'dor'
+    @druid = 'druid:123'
+
+    @mock_logger = double('logger').as_null_object
+    Rails.stub(:logger).and_return(@mock_logger)
+
+    @mock_resource = double('mock_rest_client_resource')
+    @mock_resource.stub(:[]).and_return(@mock_resource)
+    @mock_resource.stub(:options).and_return( {} )
+    RestClient::Resource.stub(:new).and_return(@mock_resource)
+    Dor::WorkflowService.configure 'https://dortest.stanford.edu/workflow'
+  end
+
+  describe "#create_workflow" do
+    it "should pass workflow xml to the DOR workflow service and return the URL to the workflow" do
+      @mock_resource.should_receive(:put).with(wf_xml, anything()).and_return('')
+      Dor::WorkflowService.create_workflow(@repo, @druid, 'etdSubmitWF', wf_xml)
+    end
+
+    it "should log an error and return false if the PUT to the DOR workflow service throws an exception" do
+      ex = Exception.new("exception thrown")
+      @mock_resource.should_receive(:put).and_raise(ex)
+      lambda{ Dor::WorkflowService.create_workflow(@repo, @druid, 'etdSubmitWF', wf_xml) }.should raise_error(Exception, "exception thrown")
+    end
+
+    it "sets the create-ds param to the value of the passed in options hash" do
+      @mock_resource.should_receive(:put).with(wf_xml, :content_type => 'application/xml',
+                                                :params => {'create-ds' => false}).and_return('')
+      Dor::WorkflowService.create_workflow(@repo, @druid, 'etdSubmitWF', wf_xml, :create_ds => false)
+    end
+
+    it "adds priority attributes to all steps if passed in as an option" do
+
+    end
+
+  end
+
+  describe "#add_priority_to_workflow_xml" do
+
+    it "adds priority attributes to all process elements" do
+      expected = <<-XML
+        <workflow id="etdSubmitWF">
+             <process name="register-object" status="completed" attempts="1" priority="50"/>
+             <process name="submit" status="waiting" priority="50"/>
+             <process name="reader-approval" status="waiting" priority="50"/>
+             <process name="registrar-approval" status="waiting" priority="50"/>
+             <process name="start-accession" status="waiting" priority="50"/>
+        </workflow>
+      XML
+
+      Dor::WorkflowService.add_priority_to_workflow_xml(50, wf_xml).should be_equivalent_to(expected)
+    end
+  end
+
+  describe "#update_workflow_status" do
+    before(:each) do
+      @xml_re = /name="reader-approval"/
+    end
+
+    it "should update workflow status and return true if successful" do
+      @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).should be_true
+    end
+
+    it "should return false if the PUT to the DOR workflow service throws an exception" do
+      ex = Exception.new("exception thrown")
+      @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
+  end
+
+  describe "#update_workflow_error_status" do
+    it "should update workflow status to error and return true if successful" do
+      @mock_resource.should_receive(:put).with(/status="error"/, { :content_type => 'application/xml' }).and_return('')
+      Dor::WorkflowService.update_workflow_error_status(@repo, @druid, "etdSubmitWF", "reader-approval", "Some exception", :error_txt =>"The optional stacktrace")
+    end
+
+    it "should return false if the PUT to the DOR workflow service throws an exception" do
+      ex = Exception.new("exception thrown")
+      @mock_resource.should_receive(:put).with(/status="completed"/, { :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
+  end
+
+  describe "#get_workflow_status" do
+    it "parses workflow xml and returns status as a string" do
+      @mock_resource.should_receive(:get).and_return('<process name="registrar-approval" status="completed" />')
+      Dor::WorkflowService.get_workflow_status('dor', 'druid:123', 'etdSubmitWF', 'registrar-approval').should == 'completed'
+    end
+
+    it "should throw an exception if it fails for any reason" do
+      ex = Exception.new("exception thrown")
+      @mock_resource.should_receive(:get).and_raise(ex)
+
+      lambda{ Dor::WorkflowService.get_workflow_status('dor', 'druid:123', 'etdSubmitWF', 'registrar-approval') }.should raise_error(Exception, "exception thrown")
+    end
+
+    it "should throw an exception if it cannot parse the response" do
+      @mock_resource.should_receive(:get).and_return('something not xml')
+      lambda{ Dor::WorkflowService.get_workflow_status('dor', 'druid:123', 'etdSubmitWF', 'registrar-approval') }.should raise_error(Exception, "Unable to parse response:\nsomething not xml")
+    end
+    it "should return nil if the workflow/process combination doesnt exist" do
+      @mock_resource.should_receive(:get).and_return('<process name="registrar-approval" status="completed" />')
+      Dor::WorkflowService.get_workflow_status('dor', 'druid:123', 'accessionWF', 'publish').should == nil
+    end
+
+  end
+
+  describe "#get_workflow_xml" do
+    it "returns the xml for a given repository, druid, and workflow" do
+      xml = '<workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>'
+      @mock_resource.should_receive(:get).and_return(xml)
+      Dor::WorkflowService.get_workflow_xml('dor', 'druid:123', 'etdSubmitWF').should == xml
+    end
+  end
+
+  describe "#get_lifecycle" do
+    it "returns a Time object reprenting when the milestone was reached" do
+      xml = <<-EOXML
+        <lifecycle objectId="druid:ct011cv6501">
+            <milestone date="2010-04-27T11:34:17-0700">registered</milestone>
+            <milestone date="2010-04-29T10:12:51-0700">inprocess</milestone>
+            <milestone date="2010-06-15T16:08:58-0700">released</milestone>
+        </lifecycle>
+      EOXML
+      @mock_resource.should_receive(:get).and_return(xml)
+      Dor::WorkflowService.get_lifecycle('dor', 'druid:123', 'released').beginning_of_day.should == Time.parse('2010-06-15T16:08:58-0700').beginning_of_day
+    end
+
+    it "returns nil if the milestone hasn't been reached yet" do
+      @mock_resource.should_receive(:get).and_return('<lifecycle/>')
+      Dor::WorkflowService.get_lifecycle('dor', 'druid:abc', 'inprocess').should be_nil
+    end
+
+  end
+
+  describe "#get_objects_for_workstep" do
+    before :each do
+      @repository = "dor"
+      @workflow = "googleScannedBookWF"
+      @completed = "google-download"
+      @waiting = "process-content"
+    end
+
+    context "a query with one step completed and one waiting" do
+      it "creates the URI string with only the one completed step" do
+        @mock_resource.should_receive(:[]).with("workflow_queue?waiting=#{@repository}:#{@workflow}:#{@waiting}&completed=#{@repository}:#{@workflow}:#{@completed}")
+        @mock_resource.should_receive(:get).and_return(%{<objects count="1"><object id="druid:ab123de4567"/><object id="druid:ab123de9012"/></objects>})
+        Dor::WorkflowService.get_objects_for_workstep(@completed, @waiting, @repository, @workflow).should == ['druid:ab123de4567','druid:ab123de9012']
+      end
+    end
+
+    context "a query with TWO steps completed and one waiting" do
+      it "creates the URI string with the two completed steps correctly" do
+        second_completed="google-convert"
+        @mock_resource.should_receive(:[]).with("workflow_queue?waiting=#{@repository}:#{@workflow}:#{@waiting}&completed=#{@repository}:#{@workflow}:#{@completed}&completed=#{@repository}:#{@workflow}:#{second_completed}")
+        @mock_resource.should_receive(:get).and_return(%{<objects count="1"><object id="druid:ab123de4567"/><object id="druid:ab123de9012"/></objects>})
+        Dor::WorkflowService.get_objects_for_workstep([@completed,second_completed], @waiting, @repository, @workflow).should == ['druid:ab123de4567','druid:ab123de9012']
+      end
+    end
+
+    context "a query using qualified workflow names for completed and waiting" do
+      it "creates the URI string with the two completed steps across repositories correctly" 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="0"/><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 "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}"
+        repo2 = "sdr"
+
+        @mock_resource.should_receive(:[]).with("workflow_queue?waiting=#{qualified_waiting}&completed=#{qualified_completed}")
+        @mock_resource.should_receive(:get).and_return(%{<objects count="1"><object id="druid:ab123de4567"/></objects>})
+        Dor::WorkflowService.get_objects_for_workstep(qualified_completed, qualified_waiting).should == ['druid:ab123de4567']
+      end
+
+      it "creates the URI string without any completed steps, only waiting" 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"/></objects>})
+        Dor::WorkflowService.get_objects_for_workstep(nil, qualified_waiting).should == ['druid:ab123de4567']
+      end
+    end
+  end
+
+  context "get empty workflow queue" do
+    it "returns an empty list if it encounters an empty workflow queue" do
+      repository = "dor"
+      workflow = "googleScannedBookWF"
+      completed = "google-download"
+      waiting = "process-content"
+      @mock_resource.should_receive(:[]).with("workflow_queue?waiting=#{repository}:#{workflow}:#{waiting}&completed=#{repository}:#{workflow}:#{completed}")
+      @mock_resource.should_receive(:get).and_return(%{<objects count="0"/>})
+      Dor::WorkflowService.get_objects_for_workstep(completed, waiting, repository, workflow).should == []
+    end
+  end
+
+  describe "#delete_workflow" do
+    it "sends a delete request to the workflow service" do
+      @mock_resource.should_receive(:[]).with("#{@repo}/objects/#{@druid}/workflows/accessionWF")
+      @mock_resource.should_receive(:delete)
+      Dor::WorkflowService.delete_workflow(@repo, @druid, 'accessionWF')
+    end
+  end
+  describe 'get_milestones' do
+    it 'should include the version in with the milestones' do
+      xml='<?xml version="1.0" encoding="UTF-8"?><lifecycle objectId="druid:gv054hp4128"><milestone date="2012-01-26T21:06:54-0800" version="2">published</milestone></lifecycle>'
+      xml=Nokogiri::XML(xml)
+      Dor::WorkflowService.stub(:query_lifecycle).and_return(xml)
+      milestones=Dor::WorkflowService.get_milestones(@repo, @druid)
+      milestones.first[:milestone].should == "published"
+      milestones.first[:version].should == "2"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: dor-workflow-service
+version: !ruby/object:Gem::Version
+  version: 1.3.3
+platform: ruby
+authors:
+- Willy Mene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-15 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: nokogiri
+  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: rest-client
+  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: confstruct
+  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: rake
+  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: 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: yard
+  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: redcarpet
+  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: equivalent-xml
+  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'
+description: Enables Ruby manipulation of the DOR Workflow Service via its REST API
+email:
+- wmene@stanford.edu
+executables:
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- dor-workflow-service.gemspec
+- lib/dor-workflow-service.rb
+- lib/dor/services/workflow_service.rb
+- lib/dor/workflow_version.rb
+- spec/spec_helper.rb
+- spec/workflow_service_spec.rb
+homepage: https://consul.stanford.edu/display/DOR/DOR+services#DORservices-initializeworkflow
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 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: