Dor::Services::Client

Dor::Services::Client is a Ruby gem that acts as a client to the RESTful HTTP APIs provided by dor-services-app. The gem is intended to be used as a replacement to the dor-services gem

Installation

Add this line to your application's Gemfile:

gem 'dor-services-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install dor-services-client

Usage

To configure and use the client, here's an example:

require 'dor/services/client'

def do_the_thing
  # This API endpoint returns JSON
  response = client.objects.register(params: { druid: 'druid:123' })
  response[:pid] # => 'druid:123'
end

private

def client
  @client ||= Dor::Services::Client.configure(url: Settings.dor_services.url,
                                              username: Settings.dor_services.user,
                                              password: Settings.dor_services.pass)
end

Note that the client may not be used without first having been configured, and the url keyword is required. The username and password arguments are optional. (If you are working in a project where the credentials are embedded in the URL, that ought to work just fine as well.)

API Coverage

Dor::Services:Client provides a number of methods to simplify connecting to the RESTful HTTP API of dor-services-app. In this section we list all of the available methods, reflecting how much of the API the client covers:

# For registering a non-existent object
objects_client = Dor::Services::Client.objects
objects_client.register(params: {})

# For performing operations on a known, registered object
object_client = Dor::Services::Client.object(object_identifier)
object_client.publish
object_client.notify_goobi
object_client.current_version
object_client.open_new_version(**params)
object_client.close_version(**params)
object_client.files.retrieve(filename: filename_string)
object_client.files.preserved_content(filename: filename_string, version: version_string)
object_client.files.list
object_client.release_tags.create(release: release, what: what, to: to, who: who)
object_client.sdr.content_diff(current_content: existing_content)
object_client.sdr.current_version
object_client.sdr.metadata(datastream: dsid)
object_client.sdr.signature_catalog

object_client.workflow.create(wf_name: workflow_name_string)
object_client.workspace.create(source: object_path_string)

# For retrieving a workflow template
workflows_client = Dor::Services::Client.workflows
workflows_client.initial(name: workflow_name)

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.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing