Skip to content
A Ruby client for the RESTful HTTP APIs provided by the Digital Object Registry (DOR) API
Ruby Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib/dor/services
spec
.gitignore
.rspec
.rubocop.yml
.rubocop_todo.yml
.travis.yml
Gemfile
LICENSE
README.md
Rakefile
dor-services-client.gemspec

README.md

Gem Version Build Status Code Climate Code Climate Test Coverage

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,
                                              token: Settings.dor_services.token)
end

Note that the client may not be used without first having been configured, and the url keyword is required. The token argument is optional (though when using the client with staging and production servers, you will always need to supply it in practice). For more about dor-services-app's token-based authentication, see its README.

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 details see the API docs

# For performing operations on one or more objects
objects_client = Dor::Services::Client.objects

# For registering a non-existent object
objects_client.register(params: {})

# For interacting with virtual objects
virtual_objects_client = Dor::Services::Client.virtual_objects

# Create a batch of virtual objects
virtual_objects_client.create(virtual_objects: [{ parent_id: '', child_ids: [''] }])

# For getting background job results
background_jobs_client = Dor::Services::Client.background_job_results

# Show results of background job
background_jobs_client.show(job_id: 123)

# For performing operations on a known, registered object
object_client = Dor::Services::Client.object(object_identifier)

# Publish an object
object_client.publish

# Update the MARC record
object_client.update_marc_record

# Copy metadata from Symphony into descMetadata
object_client.refresh_metadata

# Send a notification to goobi
object_client.notify_goobi

# Manage versions
object_client.version.current
object_client.version.openable?(**params)
object_client.version.open(**params)
object_client.version.close(**params)

# Get the Dublin Core XML representation
object_client.metadata.dublin_core

# Get the public descriptive XML representation
object_client.metadata.descriptive

# Return the Cocina metadata
object_client.find

# Query for an objects collections
object_client.collections

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

# Create and remove workspaces
object_client.workspace.create(source: object_path_string)
object_client.workspace.cleanup

# Update embargo
object_client.embargo.update(embargo_date: date_string, requesting_user: username_string)

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

Bug reports and pull requests are welcome on GitHub at https://github.com/sul-dlss/dor-services-client

Copyright

Copyright (c) 2018 Stanford Libraries. See LICENSE for details.

You can’t perform that action at this time.