CONTENTdm API for Ruby
Ruby bindings for the CONTENTdm API.
Installation
Add this line to your application's Gemfile:
gem 'contentdm_api'
And then execute:
$ bundle
Or install it yourself as:
$ gem install contentdm_api
Include the library in your code:
require 'contentdm_api'
Quick Start
Retrieve Item Metadata Along With Its Compound Object Info (If it Exists)
CONTENTdmAPI::Item.new(base_url: 'https://server16022.contentdm.oclc.org/dmwebservices/index.php', collection: 'p16022coll39', id: 446).
Item has been added as a convenience. It is a wrapper around the CONTENTdmAPI::RequestBatch
feature (see below). Set with_compound: false
to avoid attempting the dmGetCompoundObjectInfo lookup call.
Call a CONTENTdm API function directoy
The following shows the default keyword arguments for the Service class. Please refer to the CONTENTdm API for details on each API function and corresponding parameters. Parameters must be passed as an array in the order specified in the CONTENTdm API instructions.
service = CONTENTdmAPI::Service.new(function: 'wsAPIDescribe', params: [], format: 'json')
response = CONTENTdmAPI::Request.new(base_url: 'https://server16022.contentdm.oclc.org/dmwebservices/index.php', service: service).fetch
Request multiple CONTENTdm functions/endpoints at once
service_configs = [{function: 'dmGetItemInfo', params: ['p16022coll39', 446]},
{function: 'dmGetCompoundObjectInfo', params: ['p16022coll39', 446]}]
responses = CONTENTdmAPI::RequestBatch.new(base_url: 'https://server16022.contentdm.oclc.org/dmwebservices/index.php', service_configs: service_configs).fetch
You may also use the Response class to parse and handle API inconsistencies (e.g. calls for non-existent collections result in non-JSON HTML responses):
responses.map { |resp| CONTENTdmAPI::Response.new(raw_data: resp[:value]).parsed }
API Documentation
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake test
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/UMNLibraries/contentdm_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
MIT