dor-services-client 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc6f22107403e5fc4222c05ca9bebfd64bb927946558ec947dc9a267aca259c5
-  data.tar.gz: 8be38410f5ce1372134c2f2a705424453a4fb2fd3e99f21814ee5b052c015dca
+  metadata.gz: 6e698ec62b7dcceba6c335032d1ccf993c02bee7945cf5865c617c41bb00fa9e
+  data.tar.gz: 290957e4e5d96d0b44ffe4e9ccdfcf921947a49e809433139a979f5090176fe6
 SHA512:
-  metadata.gz: e80c475af39123c7e4d6b397a03e2a603878e61800d9b2bc8a4e8c18c4c5f0b941bf2edec35e522378f29ca8f46b738f9196c6e2e476ff4b2fbe6dab68258e08
-  data.tar.gz: 2f050d33ff044fa0bf4f76ea57d75022b96ba44794d2d7384c43ae8485b0d1e47150ae839d271a367832d2cec2d728aa401e60b9832c3061c2d26a5076b4c6f5
+  metadata.gz: cd790382965aa0d8ead2bbcc73a699ddce26bdb7f623932753208ead6bb8484f36668e94bde69474cace9e40e376629ca5f38cd1dfad0d82294de791fcce6cdb
+  data.tar.gz: 3ca07906e522ce83ae5046147b752100d02914b2b1fb8ca511c1bbdb8b100dc11faafa9c6593b21b6128f429167acca1cc96e5f5425acbe3b05561e8bf7411a6

data/README.md

@@ -127,6 +127,25 @@ object_client.workspace.reset
 object_client.embargo.update(embargo_date: date_string, requesting_user: username_string)
 ```
 
+## Asynchonous results
+
+Some operations are asynchronous and they return a `Location` header that displays the
+result of the job.  These jobs can be monitored by using `AsyncResult`.
+
+```
+background_result_url = virtual_objects_client.create(virtual_objects: [{ parent_id: '', child_ids: [''] }])
+result = AsyncResult.new(url: background_result_url)
+
+# Checks the result one time
+result.complete?
+
+# Poll until complete
+result.wait_until_complete
+
+result.errors
+# => [{ 'druid:foo' => ['druid:bar'] }]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/dor/services/client/async_result.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'timeout'
+
+module Dor
+  module Services
+    class Client
+      # A helper for monitoring asynchonous jobs
+      class AsyncResult
+        # @param [String] url the url of the background result
+        def initialize(url:)
+          @url = url
+        end
+
+        # @param [Integer] seconds_between_requests (3) how many seconds between polling requests
+        # @param [Integer] timeout_in_seconds (180) timeout after this many seconds
+        # @return true if successful false if unsuccessful.
+        def wait_until_complete(seconds_between_requests: 3, timeout_in_seconds: 180)
+          poll_until_complete(seconds_between_requests, timeout_in_seconds)
+          errors.nil?
+        end
+
+        # Checks to see if the result is complete.
+        def complete?
+          @results = Dor::Services::Client.background_job_results.show(job_id: job_id_from(url: url))
+          @results[:status] == 'complete'
+        end
+
+        def errors
+          @results[:output][:errors]
+        end
+
+        attr_reader :url, :seconds_between_requests, :timeout_in_seconds
+
+        private
+
+        def poll_until_complete(seconds_between_requests, timeout_in_seconds)
+          Timeout.timeout(timeout_in_seconds) do
+            loop do
+              break if complete?
+
+              sleep(seconds_between_requests)
+            end
+          end
+        rescue Timeout::Error
+          @results = { output: { errors: ["Not complete after #{timeout_in_seconds} seconds"] } }
+        end
+
+        def job_id_from(url:)
+          url.split('/').last
+        end
+      end
+    end
+  end
+end

data/lib/dor/services/client/version.rb

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '3.4.0'
+      VERSION = '3.5.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -221,6 +221,7 @@ files:
 - bin/setup
 - dor-services-client.gemspec
 - lib/dor/services/client.rb
+- lib/dor/services/client/async_result.rb
 - lib/dor/services/client/background_job_results.rb
 - lib/dor/services/client/collections.rb
 - lib/dor/services/client/embargo.rb