Skip to content

datacite/orcid_client

Repository files navigation

Ruby client for ORCID API

Gem Version Build Ruby Gem Test Coverage Code Climate

Ruby gem for integrating Ruby applications with the ORCID API.

Features

The following functionality is supported:

  • get all works from an ORCID record, including those set to limited access
  • create work in an ORCID record
  • create notification for an ORCID record (needs special permissions)

Requirements

  • ORCID membership, needed to create, update or delete content via the ORCID API
  • valid access tokens for ORCID user accounts, collected and safely stored in your application using for example the omniauth-orcid gem.

Installation

The usual way with Bundler: add the following to your Gemfile to install the current version of the gem:

gem 'orcid_client'

Then run bundle install to install into your environment.

You can also install the gem system-wide in the usual way:

gem install orcid_client

Use

TBD.

License

MIT