This is a Ruby client for interfacing with the DataCite REST API. https://support.datacite.org/docs/api
Add this line to your application's Gemfile:
gem 'datacite'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install datacite
client = Datacite::Client.new(username: "foo",
password: "bar",
host: "api.test.datacite.org")
result = client.register_doi(prefix: '10.0001', suffix: 'bc123df4567')
result.either(
-> response { response },
-> response { raise("Something went wrong", response.status) }
)
result = client.autogenerate_doi(prefix: '10.0001')
result.either(
-> response { response.doi },
-> response { raise("Something went wrong", response.status) }
)
# See https://support.datacite.org/reference/dois-2#put_dois-id for the attributes
attributes = {
relatedIdentifiers: [
{
relatedIdentifier: "https://doi.org/10.xxxx/xxxxx",
relatedIdentifierType: "DOI",
relationType: "References",
resourceTypeGeneral: "Dataset"
}
]
}
result = client.update(id: '10.0001/bc123df4567', attributes: attributes)
result.either(
-> response { response.doi },
-> response { raise("Something went wrong", response.status) }
)
result = client.exists?(id: '10.0001/bc123df4567')
result.either(
-> response { response },
-> response { raise("Something went wrong", response.status) }
)
result = client.metadata(id: '10.0001/bc123df4567')
result.either(
-> response { response },
-> response { raise("Something went wrong", response.status) }
)
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 the created tag, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/sul-dlss/datacite-ruby.