Datacite Ruby Client

This is a Ruby client for interfacing with the DataCite REST API. https://support.datacite.org/docs/api

Installation

Add this line to your application's Gemfile:

gem 'datacite'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install datacite

Usage

Initialize the client

client = Datacite::Client.new(username: "foo",
                              password: "bar",
                              host: "api.test.datacite.org")

Create a Draft DOI

result = client.register_doi(prefix: '10.0001', suffix: 'bc123df4567')

result.either(
  -> response { response },
  -> response { raise("Something went wrong", response.status) }
)

Auto-generated DOI's

result = client.autogenerate_doi(prefix: '10.0001')

result.either(
  -> response { response.doi },
  -> response { raise("Something went wrong", response.status) }
)

Update DOI's

# 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) }
)

Determine if a DOI exists

result = client.exists?(id: '10.0001/bc123df4567')

result.either(
  -> response { response },
  -> response { raise("Something went wrong", response.status) }
)

Get metadata for a DOI

result = client.metadata(id: '10.0001/bc123df4567')

result.either(
  -> response { response },
  -> response { raise("Something went wrong", response.status) }
)

Working with Cocina

Validating

This gem provides a method for mapping a Cocina::Models::DRO object to a DataCite request based on the DataCite API (as of 10/23/2025 ). This will raise Datacite::ValidationErrors if the mapped cocina does not validate. Thus you don't need to call the validator separately when mapping cocina.

attributes = Datacite::Mapping::FromCocina::Attributes.build(cocina_object: cocina_object)

The request can be validated to ensure, before sending it to datacite following the above client description:

Datacite::Validators::AttributesValidator(attributes)

Note: A Datacite request payload can be validated without first translating from Cocina if you build the request manually or use your own metadata mapping library.

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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sul-dlss/datacite-ruby.