dor-workflow-service 1.7.8 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d5306f7d3d1f1953e514107f396d0825e0854a3
-  data.tar.gz: 84b6a3c973490b1cdb5aad357a0688e47050229f
+  metadata.gz: abb7f9fafd6a57bbe2ce009a7f3d8bca21680383
+  data.tar.gz: 4c7ca111d9dbf464495a22eeb7a40bad80f8a805
 SHA512:
-  metadata.gz: e804cc302c961ad241514d095152c0dff6554a55db0d59ede0772943558a00cbe13cd1a00b41c7cd49fc31f42b19b67f4274cd9ebd8e2cb998552860c581adf1
-  data.tar.gz: e1f09e4836852064692aded4c5b337da4f374e68ed419fe4990d10b8d33e93183e0ee94f90a7a531484319086a7412627071530c19d65a37de899459fcc2cb49
+  metadata.gz: 008f69b8e8cf014a2d2490417b0812d34ef88bd731b5b9cbad822fec2938c6d4e5a9f7ef3bb3f78942a909b64ff625b8594f6f5f39a5edb689a7c603badc366e
+  data.tar.gz: 24ad2b473ff2507560897f0704c4c8813adb1b1092dccafea7eb49c565c3382ba936bf54991d4f226d19b59f42c49f2c1d018b732a6bd421877aa9c72da81103

data/.travis.yml

@@ -4,9 +4,9 @@ notifications:
   email: false
 
 rvm:
+  - 1.9.3
+  - 2.0.0
   - 2.1.2
-  - 2.2.7
-  - 2.3.4
 
 gemfile:
   - gemfiles/rails3.gemfile

data/dor-workflow-service.gemspec

@@ -18,10 +18,12 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'activesupport', '>= 3.2.1', '< 5'
-  gem.add_dependency 'nokogiri', '~> 1.6'
+  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_dependency 'faraday', '~> 0.9.2'
+  gem.add_dependency 'net-http-persistent', '~> 2.9.4'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 3.3'

data/lib/dor/services/workflow_service.rb

@@ -3,6 +3,8 @@ require 'active_support'
 require 'active_support/core_ext'
 require 'nokogiri'
 require 'retries'
+require 'faraday'
+require 'net/http/persistent'
 
 module Dor
 
@@ -22,6 +24,7 @@ module Dor
       @@logger   = nil
       @@resource = nil
       @@dor_services_url = nil
+      @@http_conn = nil
 
       # From Workflow Service's admin/Process.java
       VALID_STATUS = %w{waiting completed error queued skipped hold}
@@ -467,6 +470,10 @@ module Dor
           @@logger.warn "[Attempt #{attempt_number}] #{exception.class}: #{exception.message}; #{total_delay} seconds elapsed."
         end
         @@resource = RestClient::Resource.new(url, params)
+        @@http_conn = Faraday.new(url: url) do |faraday|
+          faraday.response :logger if opts[:debug] # logs to STDOUT
+          faraday.adapter  :net_http_persistent    # use Keep-Alive connections
+        end
       end
 
 
@@ -519,7 +526,11 @@ module Dor
       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)
+          if meth == 'get'
+            fail NotImplementedError, "GET does not support extra headers: #{opts}" unless opts.length == 0
+            @@logger.debug "Persistent HTTP GET #{uri_string} (#{@@http_conn.inspect})"
+            @@http_conn.get(uri_string).body
+          elsif meth == 'delete'
             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)

data/lib/dor/workflow_version.rb

@@ -1,7 +1,7 @@
 module Dor
   module Workflow
     module Service
-      VERSION = '1.7.8'
+      VERSION = '1.8.0'
     end
   end
 end

data/spec/workflow_service_spec.rb

@@ -28,14 +28,21 @@ describe Dor::WorkflowService do
     @repo  = 'dor'
     @druid = 'druid:123'
     @mock_resource = double('mock_rest_client_resource')
-    @mock_logger   = double('Logger')
+    @mock_http_connection = double('mock_http_connection')
+    @mock_logger = double('Logger')
+
+    allow(@mock_logger).to receive(:info)  # silence log output
+    allow(@mock_logger).to receive(:debug) # silence log output
+    allow(Dor::WorkflowService).to receive(:default_logger).and_return(@mock_logger)
+
     allow(@mock_resource).to receive(:[]).and_return(@mock_resource)
     allow(@mock_resource).to receive(:options).and_return( {} )
-    allow(@mock_resource).to receive(:url).and_return( 'https://dortest.stanford.edu/workflow' )
-    allow(@mock_logger).to receive(:info)
+    allow(@mock_resource).to receive(:url).and_return( 'https://localhost/workflow' )
+
+    allow(Faraday).to receive(:new).and_return(@mock_http_connection)
+
     allow(RestClient::Resource).to receive(:new).and_return(@mock_resource)
-    allow(Dor::WorkflowService).to receive(:default_logger).and_return(@mock_logger)
-    Dor::WorkflowService.configure 'https://dortest.stanford.edu/workflow'
+    Dor::WorkflowService.configure @mock_resource.url
   end
 
   describe '#create_workflow' do
@@ -121,20 +128,21 @@ describe Dor::WorkflowService do
 
   describe '#get_workflow_status' do
     it 'parses workflow xml and returns status as a string' do
-      expect(@mock_resource).to receive(:get).and_return('<process name="registrar-approval" status="completed" />')
+      xml = '<process name="registrar-approval" status="completed" />'
+      allow(@mock_http_connection).to receive(:get).and_return(double Faraday::Response, :body => xml)
       expect(Dor::WorkflowService.get_workflow_status('dor', 'druid:123', 'etdSubmitWF', 'registrar-approval')).to eq('completed')
     end
     it 'should throw an exception if it fails for any reason' do
       ex = Exception.new('exception thrown')
-      expect(@mock_resource).to receive(:get).and_raise(ex)
+      allow(@mock_http_connection).to receive(:get).and_raise(ex)
       expect{ Dor::WorkflowService.get_workflow_status('dor', 'druid:123', 'etdSubmitWF', 'registrar-approval') }.to raise_error(Exception, 'exception thrown')
     end
     it 'should throw an exception if it cannot parse the response' do
-      expect(@mock_resource).to receive(:get).and_return('something not xml')
+      allow(@mock_http_connection).to receive(:get).and_return(double Faraday::Response, :body => 'something not xml')
       expect{ Dor::WorkflowService.get_workflow_status('dor', 'druid:123', 'etdSubmitWF', 'registrar-approval') }.to raise_error(Exception, "Unable to parse response:\nsomething not xml")
     end
     it 'should return nil if the workflow/process combination doesnt exist' do
-      expect(@mock_resource).to receive(:get).and_return('<process name="registrar-approval" status="completed" />')
+      allow(@mock_http_connection).to receive(:get).and_return(double Faraday::Response, :body => '<process name="registrar-approval" status="completed" />')
       expect(Dor::WorkflowService.get_workflow_status('dor', 'druid:123', 'accessionWF', 'publish')).to be_nil
     end
   end
@@ -142,7 +150,7 @@ describe Dor::WorkflowService do
   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>'
-      expect(@mock_resource).to receive(:get).and_return(xml)
+      allow(@mock_http_connection).to receive(:get).and_return(double Faraday::Response, :body => xml)
       expect(Dor::WorkflowService.get_workflow_xml('dor', 'druid:123', 'etdSubmitWF')).to eq(xml)
     end
   end
@@ -156,17 +164,18 @@ describe Dor::WorkflowService do
             <milestone date="2010-06-15T16:08:58-0700">released</milestone>
         </lifecycle>
       EOXML
-      expect(@mock_resource).to receive(:get).and_return(xml)
+      allow(@mock_http_connection).to receive(:get).and_return(double Faraday::Response, :body => xml)
       expect(Dor::WorkflowService.get_lifecycle('dor', 'druid:123', 'released').beginning_of_day).to eq(Time.parse('2010-06-15T16:08:58-0700').beginning_of_day)
     end
 
     it "returns nil if the milestone hasn't been reached yet" do
-      expect(@mock_resource).to receive(:get).and_return('<lifecycle/>')
+      xml = '<lifecycle/>'
+      allow(@mock_http_connection).to receive(:get).and_return(double Faraday::Response, :body => xml)
       expect(Dor::WorkflowService.get_lifecycle('dor', 'druid:abc', 'inprocess')).to be_nil
     end
   end
 
-  describe '#get_objects_for_workstep' do
+  context '#get_objects_for_workstep' do
     before :each do
       @repository = 'dor'
       @workflow   = 'googleScannedBookWF'
@@ -174,19 +183,19 @@ describe Dor::WorkflowService do
       @waiting    = 'process-content'
     end
 
-    context 'a query with one step completed and one waiting' do
+    describe 'a query with one step completed and one waiting' do
       it 'creates the URI string with only the one completed step' do
-        expect(@mock_resource).to receive(:[]).with("workflow_queue?waiting=#{@repository}:#{@workflow}:#{@waiting}&completed=#{@repository}:#{@workflow}:#{@completed}&lane-id=default")
-        expect(@mock_resource).to receive(:get).and_return(%{<objects count="1"><object id="druid:ab123de4567"/><object id="druid:ab123de9012"/></objects>})
+        xml = %{<objects count="1"><object id="druid:ab123de4567"/><object id="druid:ab123de9012"/></objects>}
+        allow(@mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@repository}:#{@workflow}:#{@waiting}&completed=#{@repository}:#{@workflow}:#{@completed}&lane-id=default").and_return(double Faraday::Response, :body => xml)
         expect(Dor::WorkflowService.get_objects_for_workstep(@completed, @waiting, 'default', :default_repository => @repository, :default_workflow => @workflow)).to eq(['druid:ab123de4567', 'druid:ab123de9012'])
       end
     end
 
-    context 'a query with TWO steps completed and one waiting' do
+    describe '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'
-        expect(@mock_resource).to receive(:[]).with("workflow_queue?waiting=#{@repository}:#{@workflow}:#{@waiting}&completed=#{@repository}:#{@workflow}:#{@completed}&completed=#{@repository}:#{@workflow}:#{second_completed}&lane-id=default")
-        expect(@mock_resource).to receive(:get).and_return(%{<objects count="1"><object id="druid:ab123de4567"/><object id="druid:ab123de9012"/></objects>})
+        xml = %{<objects count="1"><object id="druid:ab123de4567"/><object id="druid:ab123de9012"/></objects>}
+        allow(@mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@repository}:#{@workflow}:#{@waiting}&completed=#{@repository}:#{@workflow}:#{@completed}&completed=#{@repository}:#{@workflow}:#{second_completed}&lane-id=default").and_return(double Faraday::Response, :body => xml)
         expect(Dor::WorkflowService.get_objects_for_workstep([@completed, second_completed], @waiting, 'default', :default_repository => @repository, :default_workflow => @workflow)).to eq(['druid:ab123de4567', 'druid:ab123de9012'])
       end
     end
@@ -201,8 +210,8 @@ describe Dor::WorkflowService do
         it 'creates the URI string with the two completed steps across repositories correctly' do
           qualified_completed2 = "sdr:sdrIngestWF:complete-deposit"
           qualified_completed3 = "sdr:sdrIngestWF:ingest-transfer"
-          expect(@mock_resource).to receive(:[]).with("workflow_queue?waiting=#{@qualified_waiting}&completed=#{@qualified_completed}&completed=#{qualified_completed2}&completed=#{qualified_completed3}&lane-id=#{laneid}")
-          expect(@mock_resource).to receive(:get).and_return(%{<objects count="2"><object id="druid:ab123de4567"/><object id="druid:ab123de9012"/></objects>})
+          xml = %{<objects count="2"><object id="druid:ab123de4567"/><object id="druid:ab123de9012"/></objects>}
+          allow(@mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@qualified_waiting}&completed=#{@qualified_completed}&completed=#{qualified_completed2}&completed=#{qualified_completed3}&lane-id=#{laneid}").and_return(double Faraday::Response, :body => xml)
           args = [[@qualified_completed, qualified_completed2, qualified_completed3], @qualified_waiting]
           args << laneid if laneid != 'default'
           expect(Dor::WorkflowService.get_objects_for_workstep(*args)).to eq(['druid:ab123de4567', 'druid:ab123de9012'])
@@ -220,20 +229,20 @@ describe Dor::WorkflowService do
         end
       end
 
-      describe 'URI string creation' do
+      context 'URI string creation' do
         before :each do
-          expect(@mock_resource).to receive(:get).and_return(%{<objects count="1"><object id="druid:ab123de4567"/></objects>})
+          @xml = %{<objects count="1"><object id="druid:ab123de4567"/></objects>}
         end
         it 'with only one completed step passed in as a String' do
-          expect(@mock_resource).to receive(:[]).with("workflow_queue?waiting=#{@qualified_waiting}&completed=#{@qualified_completed}&lane-id=default")
+          allow(@mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@qualified_waiting}&completed=#{@qualified_completed}&lane-id=default").and_return(double Faraday::Response, :body => @xml)
           expect(Dor::WorkflowService.get_objects_for_workstep(@qualified_completed, @qualified_waiting)).to eq(['druid:ab123de4567'])
         end
         it 'without any completed steps, only waiting' do
-          expect(@mock_resource).to receive(:[]).with("workflow_queue?waiting=#{@qualified_waiting}&lane-id=default")
+          allow(@mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@qualified_waiting}&lane-id=default").and_return(double Faraday::Response, :body => @xml)
           expect(Dor::WorkflowService.get_objects_for_workstep(nil, @qualified_waiting)).to eq(['druid:ab123de4567'])
         end
         it 'same but with lane_id' do
-          expect(@mock_resource).to receive(:[]).with("workflow_queue?waiting=#{@qualified_waiting}&lane-id=lane1")
+          allow(@mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@qualified_waiting}&lane-id=lane1").and_return(double Faraday::Response, :body => @xml)
           expect(Dor::WorkflowService.get_objects_for_workstep(nil, @qualified_waiting, 'lane1')).to eq([ 'druid:ab123de4567' ])
         end
       end
@@ -246,8 +255,8 @@ describe Dor::WorkflowService do
       workflow   = 'googleScannedBookWF'
       completed  = 'google-download'
       waiting    = 'process-content'
-      expect(@mock_resource).to receive(:[]).with("workflow_queue?waiting=#{repository}:#{workflow}:#{waiting}&completed=#{repository}:#{workflow}:#{completed}&lane-id=default")
-      expect(@mock_resource).to receive(:get).and_return(%{<objects count="0"/>})
+      xml = %{<objects count="0"/>}
+      allow(@mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{repository}:#{workflow}:#{waiting}&completed=#{repository}:#{workflow}:#{completed}&lane-id=default").and_return(double Faraday::Response, :body => xml)
       expect(Dor::WorkflowService.get_objects_for_workstep(completed, waiting, 'default', :default_repository => repository, :default_workflow => workflow)).to eq([])
     end
   end
@@ -310,8 +319,7 @@ describe Dor::WorkflowService do
             <workflow laneId="lane2" 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
-      expect(@mock_resource).to receive(:[]).with('workflow_queue/all_queued?repository=dor&hours-ago=24&limit=100')
-      expect(@mock_resource).to receive(:get).and_return(xml)
+      allow(@mock_http_connection).to receive(:get).with('workflow_queue/all_queued?repository=dor&hours-ago=24&limit=100').and_return(double Faraday::Response, :body => xml)
       ah = Dor::WorkflowService.get_stale_queued_workflows 'dor', :hours_ago => 24, :limit => 100
       expected = [
         { :workflow => 'accessionWF', :step => 'content-metadata', :druid => 'dr:123', :lane_id => 'lane1' },
@@ -323,8 +331,8 @@ describe Dor::WorkflowService do
 
   describe '.count_stale_queued_workflows' do
     it 'returns the number of queued workflow steps' do
-      expect(@mock_resource).to receive(:[]).with('workflow_queue/all_queued?repository=dor&hours-ago=48&count-only=true')
-      expect(@mock_resource).to receive(:get).and_return(%{<objects count="10"/>})
+      xml = %{<objects count="10"/>}
+      allow(@mock_http_connection).to receive(:get).with('workflow_queue/all_queued?repository=dor&hours-ago=48&count-only=true').and_return(double Faraday::Response, :body => xml)
       expect(Dor::WorkflowService.count_stale_queued_workflows('dor', :hours_ago => 48)).to eq(10)
     end
   end
@@ -337,8 +345,7 @@ describe Dor::WorkflowService do
         <lane id="lane2"/>
       </lanes>
       XML
-      expect(@mock_resource).to receive(:[]).with('workflow_queue/lane_ids?step=dor:accessionWF:shelve')
-      expect(@mock_resource).to receive(:get).and_return(xml)
+      allow(@mock_http_connection).to receive(:get).with('workflow_queue/lane_ids?step=dor:accessionWF:shelve').and_return(double Faraday::Response, :body => xml)
       expect(Dor::WorkflowService.get_lane_ids('dor', 'accessionWF', 'shelve')).to eq(%w(lane1 lane2))
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-service
 version: !ruby/object:Gem::Version
-  version: 1.7.8
+  version: 1.8.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-18 00:00:00.000000000 Z
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +93,34 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -210,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Provides convenience methods to work with the DOR Workflow Service