Merge pull request #1184 from ElixirTeSS/orcid-integration

ORCID authentication

Author: fbacall

app/assets/images/ORCID-iD_icon_unauth_vector.svg

@@ -48,7 +48,7 @@ def handle_error(status_code = 500, message = nil)
     status_code = status_code.to_i
     @message = message
     respond_to do |format|
-      format.html  { render 'static/error', status: status_code }
+      format.html { render 'static/error', status: status_code }
       format.json { render json: { error: { message: message, code: status_code } }, status: status_code }
       format.json_api { render json: { error: { message: message, code: status_code } }, status: status_code }
       format.any { head status_code }

app/assets/images/ORCID-iD_icon_vector.svg

@@ -0,0 +1,46 @@
+class OrcidController < ApplicationController
+  before_action :authenticate_user!
+  before_action :set_oauth_client, only: [:authenticate, :callback]
+
+  # Faraday::ParsingError occurs in rack-oauth2 if the response does not contain JSON
+  rescue_from(Rack::OAuth2::Client::Error, Faraday::ParsingError) do
+    handle_error(:unprocessable_entity, t('orcid.error'))
+  end
+
+  def authenticate
+    redirect_to @oauth2_client.authorization_uri(scope: '/authenticate'), allow_other_host: true
+  end
+
+  def callback
+    @oauth2_client.authorization_code = params[:code]
+    token = Rack::OAuth2::AccessToken::Bearer.new(access_token: @oauth2_client.access_token!)
+    orcid = token.access_token&.raw_attributes['orcid']
+    respond_to do |format|
+      profile = current_user.profile
+      if orcid.present?
+        if profile.authenticate_orcid(orcid)
+          flash[:notice] = t('orcid.authentication_success')
+        else
+          flash[:error] = profile.errors.full_messages.join(', ')
+        end
+      else
+        flash[:error] = t('orcid.authentication_failure')
+      end
+      format.html { redirect_to current_user }
+    end
+  end
+
+  private
+
+  def set_oauth_client
+    config = Rails.application.config.secrets.orcid
+    @oauth2_client ||= Rack::OAuth2::Client.new(
+      identifier: config[:client_id],
+      secret: config[:secret],
+      redirect_uri: config[:redirect_uri].presence || orcid_callback_url,
+      authorization_endpoint: '/oauth/authorize',
+      token_endpoint: '/oauth/token',
+      host: config[:host].presence || (Rails.env.production? ? 'orcid.org' : 'sandbox.orcid.org')
+    )
+  end
+end

app/controllers/application_controller.rb

@@ -5,4 +5,19 @@ def self.user_profile_resource_limit
     30
   end
 
+  def orcid_link(profile, **opts)
+    content_tag(:span) do
+      if profile.orcid_authenticated?
+        concat image_tag('ORCID-iD_icon_vector.svg', size: 16)
+        concat ' '
+        concat external_link(profile.orcid, profile.orcid_url, **opts)
+      elsif profile.orcid.present?
+        concat image_tag('ORCID-iD_icon_unauth_vector.svg', size: 16)
+        concat ' '
+        concat external_link(profile.orcid, profile.orcid_url, **opts)
+        concat ' (Unauthenticated)'
+      end
+    end
+  end
+
 end

app/controllers/orcid_controller.rb

@@ -25,6 +25,11 @@ def full_name
     "#{firstname} #{surname}".strip
   end
 
+  def orcid_url
+    return nil if orcid.blank?
+    "#{OrcidValidator::ORCID_PREFIX}#{orcid}"
+  end
+
   def merge(*others)
     Profile.transaction do
       attrs = attributes
@@ -43,16 +48,27 @@ def merge(*others)
     end
   end
 
+  def authenticate_orcid(orcid)
+    existing = Profile.where(orcid: orcid, orcid_authenticated: true)
+    self.orcid = orcid
+    self.orcid_authenticated = true
+    out = self.save
+
+    if out
+      existing.each do |profile|
+        next if profile == self
+        profile.update_column(:orcid_authenticated, false)
+      end
+    end
+
+    out
+  end
+
   private
 
   def normalize_orcid
     return if orcid.blank?
-    self.orcid = orcid.strip
-    if orcid =~ OrcidValidator::ORCID_ID_REGEX
-      self.orcid = "#{OrcidValidator::ORCID_PREFIX}#{orcid}"
-    elsif orcid.start_with?(OrcidValidator::ORCID_DOMAIN_REGEX)
-      self.orcid = orcid.sub(OrcidValidator::ORCID_DOMAIN_REGEX, OrcidValidator::ORCID_PREFIX)
-    end
+    self.orcid = orcid.strip.sub(OrcidValidator::ORCID_DOMAIN_REGEX, '')
   end
 
   def check_public

app/helpers/users_helper.rb

@@ -13,7 +13,7 @@
     <%= content_tag 'span', langs, { itemprop: 'knowsLanguage', content: langs, class: 'schemaorg-element' } %>
   <% end %>
   <%= content_tag :span, trainer.website, { itemprop: 'url', content: trainer.website, class: 'schemaorg-element' } %>
-  <%= content_tag :span, trainer.orcid, { itemprop: 'identifier', content: trainer.orcid, class: 'schemaorg-element' } %>
+  <%= content_tag :span, trainer.orcid_url, { itemprop: 'identifier', content: trainer.orcid_url, class: 'schemaorg-element' } %>
   <% if trainer.image_url and not trainer.image_url.empty? %>
     <%= content_tag :span, trainer.image_url, { itemprop: 'image', content: trainer.image_url, class: 'shemaorg-element' } %>
   <% end %>

app/models/profile.rb

@@ -21,7 +21,7 @@
     <!-- Field: orcid -->
     <% if @trainer.orcid.present? %>
       <div class="url-wrap">
-        <%= external_link @trainer.orcid, @trainer.orcid, class: 'h5', target: '_blank', rel: 'noopener', track: true %>
+        <%= orcid_link(@trainer, class: 'h5', track: true) %>
       </div>
     <% end %>
 

app/views/trainers/partials/_trainer_schemaorg.html.erb

@@ -50,7 +50,10 @@
         <% if @user.profile.orcid.blank? %>
           <span class="empty">None specified</span>
         <% else %>
-          <%= link_to @user.profile.orcid, @user.profile.orcid, rel: 'nofollow', target: '_blank' %>
+          <%= orcid_link(@user.profile) %>
+          <% if current_user == @user && !@user.profile.orcid_authenticated? %>
+            <%= button_to t('orcid.authenticate'), authenticate_orcid_path, class: 'btn btn-default' %>
+          <% end %>
         <% end %>
       </p>
 

app/views/trainers/show.html.erb

@@ -839,6 +839,8 @@ en:
     422: "The request you sent was well-formed but the change you wanted was rejected (422 Unprocessable Entity)."
     404: "The requested page could not be found - you may have mistyped the address or the page may have moved (404 Not Found)."
     406: "The requested format is not available (406 Not Acceptable)."
+    messages:
+      orcid_taken: 'has already been linked to another profile.'
   warnings:
     link_broken: >
       %{site_name} has been unable to access this %{resource_type}'s URL since %{fail_date} - the page may have been moved.
@@ -1114,3 +1116,8 @@ en:
       title: What are spaces?
       description: |
         Spaces are customizable, community-managed sub-portals within %{site_name}, each with their own catalogue of training content.
+  orcid:
+    error: 'An error occurred whilst trying to authenticate your ORCID.'
+    authenticate: 'Authenticate your ORCID'
+    authentication_success: 'You have successfully authenticated your ORCID.'
+    authentication_failure: 'Failed to authenticate your ORCID.'