dor-workflow-service 1.3.3 → 1.4.0

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 
 if RUBY_VERSION < '1.9'
   gem 'activesupport', "< 4.0"
+  gem 'nokogiri', "< 1.6"
 end
 
 group :development do

data/lib/dor/services/workflow_service.rb

@@ -91,17 +91,28 @@ module Dor
       # 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"]
+      # @param [String] pid of druid
+      # @return [Array<String>] list of worklows
+      # @example 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
 
+      # Get active 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] 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')
+      #   => ["accessionWF", "assemblyWF", "disseminationWF"]
+      def get_active_workflows(repo, pid)
+        doc = Nokogiri::XML(get_workflow_xml(repo,pid,''))
+        doc.xpath( %(//workflow[not(process/@archived)]/@id ) ).map {|n| n.value}
+      end
+
       # Updates the status of one step in a workflow to error.
       # Returns true on success.  Caller must handle any exceptions
       #
@@ -248,6 +259,13 @@ module Dor
         return Nokogiri::XML(lifecycle_xml)
       end
 
+      def archive_active_workflow(repo, druid)
+        workflows = get_active_workflows(repo, druid)
+        workflows.each do |wf|
+          archive_workflow(repo, druid, wf,)
+        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?)
 

data/lib/dor/workflow_version.rb

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

data/spec/workflow_service_spec.rb

@@ -242,4 +242,23 @@ describe Dor::WorkflowService do
     end
   end
 
+  describe ".get_active_workflows" do
+    it "it returns an array of active workflows only" do
+      xml = <<-XML
+      <workflows objectId="druid:mw971zk1113">
+        <workflow repository="dor" objectId="druid:mw971zk1113" id="accessionWF">
+          <process priority="0" lifecycle="submitted" elapsed="0.0" attempts="1" datetime="2013-02-18T15:08:10-0800" status="completed" name="start-accession"/>
+        </workflow>
+        <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
+          <process version="1" priority="0" elapsed="0.0" archived="true" attempts="1" datetime="2013-02-18T14:40:25-0800" status="completed" name="start-assembly"/>
+          <process version="1" priority="0" elapsed="0.509" archived="true" attempts="1" datetime="2013-02-18T14:42:24-0800" status="completed" name="jp2-create"/>
+        </workflow>
+      </workflows>
+      XML
+
+      Dor::WorkflowService.stub(:get_workflow_xml) { xml }
+      expect(Dor::WorkflowService.get_active_workflows('dor', 'druid:mw971zk1113')).to eq(['accessionWF'])
+    end
+  end
+
 end

metadata

@@ -1,139 +1,158 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-service
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
+  prerelease: 
 platform: ruby
 authors:
 - Willy Mene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2013-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: confstruct
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Enables Ruby manipulation of the DOR Workflow Service via its REST API
@@ -159,26 +178,27 @@ files:
 - 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
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Provides convenience methods to work with the DOR Workflow Service
 test_files:
 - spec/spec_helper.rb

checksums.yaml

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