dor-workflow-client 3.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f6d5ba580a5c98372eed49a683d9db35e1e83fbbf91350e401ab7dccbd93c38
+  data.tar.gz: 7899acc1174d4b43e56ae9e4a1823e9302c2219f0623b159014f4c1d9e130214
+SHA512:
+  metadata.gz: b5c2081451447bf2732c7450562e20cad324d50f5c88f5733579a7c200ad646aa11eb89ae24d1c8535f761c81049b82394dcce4b7003d1d31880bc307474dcb0
+  data.tar.gz: a92d0a03be85f00934f03d5f3e68e5796c9c4779c4db8f8c368faf541fdb93a336d0c40deebc879b7e424ac667f5896ee6d656f840a669ffe6490ffbbb6dc5d9

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/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 300
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb

data/.rubocop_todo.yml

@@ -0,0 +1,21 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-04-06 08:08:20 -0500 using RuboCop version 0.63.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 23
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 13
+
+# Offense count: 2
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+notifications:
+  email: false
+
+rvm:
+  - 2.5.3
+
+env:
+  - "RAILS_VERSION=4.2.11.1"
+  - "RAILS_VERSION=5.2.3"

data/.yardopts

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

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dor-workflow-service.gemspec
+gemspec
+
+gem 'activesupport', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
+
+group :development, :test do
+  gem 'byebug'
+  gem 'simplecov'
+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,35 @@
+[![Build Status](https://travis-ci.org/sul-dlss/dor-workflow-service.svg?branch=master)](https://travis-ci.org/sul-dlss/dor-workflow-service)
+
+# dor-workflow-client gem
+
+A Ruby client 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
+
+You should initialize a `Dor::Workflow::Client` object in your application configuration, i.e. in a bootup or startup method like:
+
+```ruby
+wfs = Dor::Workflow::Client.new(url: 'https://test-server.edu/workflow/')
+```
+
+Consumers of recent versions of the [dor-services](https://github.com/sul-dlss/dor-services) gem can access the configured `Dor::Workflow::Client` object via `Dor::Config`.
+
+## Underlying Clients
+
+This gem currently uses the [Faraday](https://github.com/lostisland/faraday) HTTP client to access the back-end service.  The clients be accessed directly from your `Dor::Workflow::Client` object:
+
+```ruby
+wfs.connection # the Faraday object
+```
+
+Or for advanced configurations, ONE of them (not both) can be passed to the constructor instead of the raw URL string:
+
+```ruby
+conn = Faraday.new(:url => 'http://sushi.com') do |faraday|
+  faraday.request  :url_encoded             # form-encode POST params
+  faraday.response :logger                  # log requests to STDOUT
+  faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+end
+wfs = Dor::Workflow::Client.new(connection: conn)
+```

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run linter and tests'
+task default: %i[rubocop spec]
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/bin/console

@@ -0,0 +1,14 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+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-client.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dor/workflow/client/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'dor-workflow-client'
+  gem.version       = Dor::Workflow::Client::VERSION
+  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'
+  gem.homepage      = 'https://consul.stanford.edu/display/DOR/DOR+services#DORservices-initializeworkflow'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'activesupport', '>= 3.2.1', '< 6'
+  gem.add_dependency 'confstruct', '>= 0.2.7', '< 2'
+  gem.add_dependency 'faraday', '~> 0.9', '>= 0.9.2'
+  gem.add_dependency 'faraday_middleware'
+  gem.add_dependency 'net-http-persistent', '>= 2.9.4', '< 4.a'
+  gem.add_dependency 'nokogiri', '~> 1.6'
+
+  gem.add_development_dependency 'equivalent-xml', '~> 0.5', '>= 0.5.1'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'redcarpet'
+  gem.add_development_dependency 'rspec', '~> 3.3'
+  gem.add_development_dependency 'rubocop', '~> 0.63.1'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'yard'
+end

data/lib/dor/models/response/process.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Dor
+  module Workflow
+    module Response
+      # Represents the status of an object doing a workflow process
+      class Process
+        # @params [Workflow] parent
+        # @params [Hash] attributes
+        def initialize(parent:, **attributes)
+          @parent = parent
+          @attributes = attributes
+        end
+
+        def name
+          @attributes[:name].presence
+        end
+
+        def status
+          @attributes[:status].presence
+        end
+
+        def datetime
+          @attributes[:datetime].presence
+        end
+
+        def elapsed
+          @attributes[:elapsed].presence
+        end
+
+        def attempts
+          @attributes[:attempts].presence
+        end
+
+        def lifecycle
+          @attributes[:lifecycle].presence
+        end
+
+        def note
+          @attributes[:note].presence
+        end
+
+        def error_message
+          @attributes[:errorMessage].presence
+        end
+
+        delegate :pid, :workflow_name, to: :parent
+
+        private
+
+        attr_reader :parent
+      end
+    end
+  end
+end

data/lib/dor/models/response/update.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'dor/models/response/process'
+
+module Dor
+  module Workflow
+    module Response
+      # The response from telling the server to update a workflow step.
+      class Update
+        def initialize(json:)
+          @json = JSON.parse(json)
+        end
+
+        def next_steps
+          @json[:next_steps]
+        end
+      end
+    end
+  end
+end

data/lib/dor/models/response/workflow.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'dor/models/response/process'
+
+module Dor
+  module Workflow
+    module Response
+      # The response form asking the server about a workflow for an item
+      class Workflow
+        def initialize(xml:)
+          @xml = xml
+        end
+
+        def pid
+          ng_xml.at_xpath('/workflow/@objectId').text
+        end
+
+        def workflow_name
+          ng_xml.at_xpath('/workflow/@id').text
+        end
+
+        # @param [Integer] version the version we are checking for.
+        def active_for?(version:)
+          result = ng_xml.at_xpath("/workflow/process[@version=#{version}]")
+          result ? true : false
+        end
+
+        # Returns the process, for the most recent version that matches the given name:
+        def process_for_recent_version(name:)
+          nodes = process_nodes_for(name: name)
+          node = nodes.max { |a, b| a.attr('version').to_i <=> b.attr('version').to_i }
+          attributes = node ? Hash[node.attributes.collect { |k, v| [k.to_sym, v.value] }] : {}
+          Process.new(parent: self, **attributes)
+        end
+
+        def empty?
+          ng_xml.xpath('/workflow/process').empty?
+        end
+
+        attr_reader :xml
+
+        private
+
+        def process_nodes_for(name:)
+          ng_xml.xpath("/workflow/process[@name = '#{name}']")
+        end
+
+        def ng_xml
+          @ng_xml ||= Nokogiri::XML(@xml)
+        end
+      end
+    end
+  end
+end

data/lib/dor/workflow/client/connection_factory.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+module Dor
+  module Workflow
+    class Client
+      # Builds Faraday connections that follow redirects
+      class ConnectionFactory
+        def self.build_connection(url, timeout:, logger:)
+          new(url, timeout: timeout, logger: logger).build_connection
+        end
+
+        def initialize(url, timeout:, logger:)
+          @url = url
+          @timeout = timeout
+          @logger = logger
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def build_connection
+          Faraday.new(url: url) do |faraday|
+            faraday.use Faraday::Response::RaiseError # raise exceptions on 40x, 50x responses
+            faraday.use FaradayMiddleware::FollowRedirects, limit: 3
+            faraday.options.params_encoder = Faraday::FlatParamsEncoder
+            if timeout
+              faraday.options.timeout = timeout
+              faraday.options.open_timeout = timeout
+            end
+            faraday.headers[:user_agent] = user_agent
+            faraday.request :retry,
+                            max: 2,
+                            interval: 5.0,
+                            interval_randomness: 0.01,
+                            backoff_factor: 2.0,
+                            methods: retriable_methods,
+                            exceptions: retriable_exceptions,
+                            retry_block: retry_block,
+                            retry_statuses: retry_statuses
+            faraday.adapter Faraday.default_adapter # Last middleware must be the adapter
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        def user_agent
+          "dor-workflow-service #{VERSION}"
+        end
+
+        private
+
+        attr_reader :logger, :timeout, :url
+
+        def retriable_methods
+          Faraday::Request::Retry::IDEMPOTENT_METHODS + [:post]
+        end
+
+        def retriable_exceptions
+          Faraday::Request::Retry::DEFAULT_EXCEPTIONS + [Faraday::ConnectionFailed]
+        end
+
+        def retry_block
+          lambda do |env, _opts, retries, exception|
+            logger.warn "retrying connection (#{retries} remaining) to #{env.url}: (#{exception.class}) " \
+              "#{exception.message} #{env.status}"
+          end
+        end
+
+        def retry_statuses
+          [429, 500, 502, 503, 504, 599]
+        end
+      end
+    end
+  end
+end

data/lib/dor/workflow/client/lifecycle_routes.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Dor
+  module Workflow
+    class Client
+      # Makes requests relating to a lifecycle
+      class LifecycleRoutes
+        def initialize(requestor:)
+          @requestor = requestor
+        end
+
+        # Returns the Date for a requested milestone from workflow lifecycle
+        # @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
+        # @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 lifecycle(repo, druid, milestone)
+          doc = query_lifecycle(repo, druid)
+          milestone = doc.at_xpath("//lifecycle/milestone[text() = '#{milestone}']")
+          return Time.parse(milestone['date']) if milestone
+
+          nil
+        end
+
+        # Returns the Date for a requested milestone ONLY FROM THE ACTIVE workflow table
+        # @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
+        # @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 active_lifecycle(repo, druid, milestone)
+          doc = query_lifecycle(repo, druid, true)
+          milestone = doc.at_xpath("//lifecycle/milestone[text() = '#{milestone}']")
+          return Time.parse(milestone['date']) if milestone
+
+          nil
+        end
+
+        # @return [Hash]
+        def milestones(repo, druid)
+          doc = query_lifecycle(repo, druid)
+          doc.xpath('//lifecycle/milestone').collect do |node|
+            { milestone: node.text, at: Time.parse(node['date']), version: node['version'] }
+          end
+        end
+
+        private
+
+        # @return [Nokogiri::XML::Document]
+        def query_lifecycle(repo, druid, active_only = false)
+          req = "#{repo}/objects/#{druid}/lifecycle"
+          req += '?active-only=true' if active_only
+          Nokogiri::XML(requestor.request(req))
+        end
+
+        attr_reader :requestor
+      end
+    end
+  end
+end