A Rails engine for orcid.org integration.
Ruby HTML Other
Clone or download
Latest commit dfad2cf Jul 24, 2017

README.md

Orcid

Version Build Status Code Climate Coverage Status Documentation Status API Docs APACHE 2 License Contributing Guidelines

A Rails Engine for integrating with Orcid. It leverages the Devise MultiAuth plugin for negotiating the interaction with orcid.org.

Note: While this is part of ProjectHydra, this gem is not dependent on any of the Hydra components.

Features

Associate ORCID with your user account for the application by:

  • Creating an ORCID
  • Looking up and associating with an existing ORCID
  • Providing an ORCID to directly associate with your account

Authentication

  • Using OAuth2, you can use orcid.org as one of your authentication mechanisms

Interacting with ORCID Profile Works:

The functionality exists, but it will be a bit bumpy to implement. Plans are to improve the integration with Version 1.0.0 of the Orcid gem.

  • Query for your Orcid Profile's works
  • Append one or more works to your Orcid Profile
  • Replace your Orcid Profile works with one or more works

Getting Started with the Orcid gem

To fully interact with the Orcid remote services, you will need to register your ORCID application profile.

Installation

Add this line to your application's Gemfile:

gem 'orcid'

And then execute:

$ bundle

If bundle fails, you may need to install Qt.

And then install by running the following:

$ rails generate orcid:install

Note: It will prompt you for your Orcid application secrets.

Caveat

You will also need to update your devise configuration in your routes.

From something like this:

devise_for :users

To:

devise_for :users, controllers: { omniauth_callbacks: 'devise/multi_auth/omniauth_callbacks' }

You may find it helpful to review the help text, as there are a few options for the generator.

$ rails generate orcid:install -h

Using the Orcid widget in your application

In order to facilitate integration of this ORCID gem into your application, a widget has been provided to offer these functions:

  1. Enter a known ORCID and connect to the ORCID repository.
  2. Look up the ORCID of the current user of your application.
  3. Create an ORCID to be associated with the current user of your application.

The widget is contained in the partial app/views/orcid/profile_connections/_orcid_connector.html.erb.

An example use of the partial is shown below.

# The `if defined?(Orcid)` could be viewed as a courtesy.
# Don't attempt to render this partial if the Orcid gem is not being used.
if defined?(Orcid)
  <%= render partial: 'orcid/profile_connections/orcid_connector', locals: {default_search_text: current_user.name } %>
end

To customize the labels, review the ./config/locales/orcid.en.yml file.

Registering for an ORCID application profile

Your application which will interface with ORCID must be registered with ORCID. Note that you will want to register your production application separately from the development sandbox.

  1. Go to http://support.orcid.org/knowledgebase/articles/116739-register-a-client-application
  2. Read the information on the entire page, in particular, the 'Filling in the client application form' and 'About Redirect URIs' sections.
  3. Click on 'register a client application', http://orcid.org/organizations/integrators/create-client-application
  4. There you will be given a choice of registering for the Development Sandbox or the Production Registry.
  5. Fill in the other information as appropriate for your organization. If you are doing development, select Development Sandbox.
  6. For the URL of the home page of your application, you must use an https:// URL. If you are going to be doing development work locally on your own machine where your application's server will run, enter https://localhost:3000 for the URL of your home page (or as appropriate to your local development environment). See NOTE: Application home page URL below.
  7. You must enter at least one Redirect URI, which should be https://localhost:3000/users/auth/orcid/callback
  8. Another suggested Redirect URI is https://developers.google.com/oauthplayground

Within a day or so, you will receive an email with an attached xml file containing the client-id and client-secret which must be used in the application.yml file discussed below.

NOTE: Application home page URL

You must enter the same URL for the application home page on the form as you would enter into your browser. For example, if you specify "https://localhost:3000" on the ORCID registration form, then you MUST invoke your application via the browser with "https://localhost:3000" in order for all of the ORCID functionality to work.

For development work in particular, there are multiple ways to specify the local machine: 127.0.0.1, ::1, 192.168.1.1, and localhost. It is strongly recommended that you use 'localhost' in the ORCID form's URL for your application and when invoking your application from the browser rather than using any IP address for your local machine.

Setting up your own ORCIDs in the ORCID Development Sandbox

Read more about the ORCID Sandbox.

  1. Register two ORCID users: https://sandbox-1.orcid.org/register (make sure to use @mailinator.com as your email) Save the email addresses, orcid ids, and passwords for editing the application.yml later.
  2. Go to mailinator (http://mailinator.com/) and claim 1 ORCID by clicking the verify link in the email.
  3. Go to the ORCID sandbox https://sandbox.orcid.org, log in and click on Account Settings (https://sandbox.orcid.org/account). On the Account Settings page, click on Email and select the little icon with the group of heads to make your Primary Email publicly accessible.

Setting up the config/application.yml file

Customize the sample application.yml file by first copying it to config/application.yml and opening it for editing.

$ cp config/application.yml.sample config/application.yml

Running the tests

Run rake to generate the dummy app and run the offline tests.

To run the online tests, you'll need ORCID application credentials:

  1. Register for an ORCID app. See Registering for an ORCID application profile above. (This may take several days to complete.)
  2. Register two ORCID users in the ORCID Development Sandbox. See Setting up your own ORCIDs in the ORCID Development Sandbox above.
  3. Update the application.yml with your information. See Setting up the config/application.yml file above.

Run the online tests with

$ rake spec:online

Running ALL of the Tests

Not all of the tests run. There are a few very long running tests that run.

$ ORCID_APP_ID=<YOUR ORCID APP ID> \
  ORCID_APP_SECRET=<YOUR ORCID APP SECRET> \
  MAILINATOR_API_KEY=<YOUR MAILINATOR KEY> \
  ORCID_CLAIMED_PROFILE_ID=<AN ORCID PROFILE YOUR APP HAS ALREADY CLAIMED> \
  ORCID_CLAIMED_PROFILE_PASSWORD=<THE PASSWORD FOR THE ALREADY CLAIMED ORCID> \
  bundle exec rake spec:jenkins

By setting all of the above environment variables, you will run tests that will:

  • Create an Orcid, then claim it, and authenticate with your application via ORCID

Versioning

Orcid uses Semantic Versioning 2.0.0