What is it?
This gem provides Ruby client connectivity to Datacite's Metadata store (MDS). The MDS is a service for data publishers to mint DOIs and register associated metadata. It is aimed mainly at scientific and research data publishers. This gem allows for simple and seamless interaction with the MDS service.
Installation
Add this line to your application's Gemfile:
gem 'datacite_mds'
And then execute:
$ bundle
Or install it yourself as:
$ gem install datacite_mds
Usage
create an Mds object (explicit authorization)
mds = Datacite::Mds.new authorize: {usr: "joe bloggs", pwd: "password"}
create an Mds object (implicit authorization via DATACITE_USR, DATACITE_PWD environment variables)
mds = Datacite::Mds.new
create an Mds object for testing (implicit authorization)
mds = Datacite::Mds.new testing: true
resolve a DOI
res = mds.resolve '10.5072/existing-doi'
p res # => <Net::HTTPOK 200 OK readbody=true
upload metadata
res = mds. File.read('metadata.xml')
p res # => <Net::HTTPCreated 201 Created readbody=true>
mint a DOI
res = mds.mint '10.5072/non-existing-doi', 'http://ora.ox.ac.uk/objects/uuid:<an-existing-uuid>'
p res # => <Net::HTTPCreated 201 Created readbody=true>
update dataset for existing DOI
res = mds.mint '10.5072/existing-doi', 'http://ora.ox.ac.uk/objects/uuid:<new-uuid>'
p res # => <Net::HTTPCreated 201 Created readbody=true>
Tests
Minitest is used for testing. To run all tests, you must set the DATACITE_USR, DATACITE_PWD environment variables and then:
$ rake test
Note: Some of the tests use DOIs and URLs issued to the Bodleian Libraries and can be accessed only by using the Bodleian datacentre authorisation credentials. It is recommended that you substitute these constant variables' values in the test file, with your own datacentre's DOIs and URLs.
License
The gem is available as open source under the terms of the MIT License, c/o The Chancellor Masters and Scholars of the University of Oxford.
Contributing
- Fork the repository
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request