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:

wfs = Dor::Workflow::Client.new(url: 'https://test-server.edu/workflow/')

Consumers of recent versions of the dor-services gem can access the configured Dor::Workflow::Client object via Dor::Config.

Underlying Clients

This gem currently uses the Faraday HTTP client to access the back-end service. The clients be accessed directly from your Dor::Workflow::Client object:

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:

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)