feat: let users save and remove their OpenTheso API key from their account page

Author: Imene-Amirat

app/assets/stylesheets/account.scss

@@ -162,6 +162,8 @@
   border: 1px solid var(--primary-color);
   text-decoration: none;
   color: var(--primary-color);
+  background: none;
+  cursor: pointer;
   border-radius: 5px;
   padding: 12px 20px;
   font-size: 14px;

app/controllers/users_controller.rb

@@ -175,18 +175,18 @@ def update_external_tools
     tool_name = params.dig(:user, :tool_name)
     apikey = params.dig(:user, :apikey)
 
-    if tool_name.blank? || apikey.blank?
+    if tool_name.blank?
       flash[:notice] = t('users.external_tools_apikey_required')
     else
       external_tools = Array(@user.externalTools).reject { |tool| tool.toolName.eql?(tool_name) }
                                                  .map { |tool| { toolName: tool.toolName, apikey: tool.apikey } }
-      external_tools << { toolName: tool_name, apikey: apikey }
+      external_tools << { toolName: tool_name, apikey: apikey } if apikey.present?
       error_response = @user.update(values: { externalTools: external_tools })
 
       if response_error?(error_response)
         flash[:notice] = t('users.error_saving_external_tools')
       else
-        flash[:notice] = t('users.external_tools_saved')
+        flash[:notice] = apikey.present? ? t('users.external_tools_saved') : t('users.external_tools_removed')
       end
     end
     redirect_to user_path(@user.username)

app/helpers/users_helper.rb

@@ -1,9 +1,9 @@
 module UsersHelper
   def external_tools_list
     tools = Rails.cache.fetch('external_tools_list', expires_in: 1.hour) do
-      Array(LinkedData::Client::HTTP.get('/external_tools')).map do |tool|
-        { name: tool.name, label: tool.title, url: tool.homepage.to_s }
-      end
+      Array(LinkedData::Client::HTTP.get('/external_tools'))
+        .sort_by { |tool| tool.created.to_s }
+        .map { |tool| { name: tool.name, label: tool.title, url: tool.homepage.to_s } }
     end
     tools || []
   end

app/services/external_tools/opentheso_connector.rb

@@ -0,0 +1,59 @@
+module ExternalTools
+  # Connection recipe for OpenTheso instances:
+  # 1. resolve the portal acronym to the thesaurus id (persistent name)
+  # 2. request a temporary SSO token with the user API key
+  class OpenthesoConnector
+
+    def initialize(tool)
+      @tool = tool
+      @base_url = tool[:url].to_s.chomp('/')
+    end
+
+    def connect(api_key:, acronym:, concept_id: nil)
+      idt = resolve_thesaurus(acronym)
+      if idt.blank?
+        return { error: I18n.t('ontologies.external_tool_resolve_failed', tool: @tool[:label]), status: :not_found }
+      end
+
+      data = request_sso_token(api_key, idt, concept_id)
+      if data && data['redirectUrl']
+        { redirect_url: "#{@base_url}#{data['redirectUrl']}" }
+      else
+        { error: error_message(data), status: :unprocessable_entity }
+      end
+    end
+
+    private
+
+    def error_message(data)
+      case data && data['errorCode']
+      when 'API_KEY_INVALID', 'API_KEY_MISSING'
+        I18n.t('ontologies.external_tool_invalid_apikey', tool: @tool[:label])
+      else
+        I18n.t('ontologies.external_tool_connection_failed', tool: @tool[:label])
+      end
+    end
+
+    def resolve_thesaurus(acronym)
+      uri = URI("#{@base_url}/openapi/v1/thesaurus-resolve/#{acronym.to_s.downcase}")
+      response = Net::HTTP.get_response(uri)
+      return nil unless response.is_a?(Net::HTTPSuccess)
+
+      JSON.parse(response.body)['idTheso']
+    end
+
+    def request_sso_token(api_key, idt, idc)
+      uri = URI("#{@base_url}/api/v2/auth/token")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+
+      request = Net::HTTP::Post.new(uri)
+      request['X-API-Key'] = api_key
+      request['Content-Type'] = 'application/json'
+      request.body = { idc: idc.to_s, idt: idt }.to_json
+
+      response = http.request(request)
+      JSON.parse(response.body)
+    end
+  end
+end

app/views/users/show.html.haml

@@ -58,24 +58,19 @@
               = t('users.show.api_documentation')
               = render partial: "shared/svgs/external_link_icon"
         .account-page-card{'data-controller': 'reveal-component'}
-          .account-page-card-container
-            .account-page-card-sub-container
-              %h4.account-page-card-title= t('users.show.external_tools')
-              %p.account-page-card-desc= t('users.show.external_tools_description')
-              - external_tools_list.each do |tool|
-                - saved_key = user_external_tool_apikey(@user, tool[:name])
-                .account-page-subscription
-                  %a{'data-action': 'click->reveal-component#toggle', 'data-id': "external_tool_form_#{tool[:name]}", style: 'cursor: pointer;'}
-                    = tool[:label]
-                  %div
-                    - if saved_key.present?
-                      = render ChipButtonComponent.new(text: t('users.show.external_tool_connected'), type: 'static')
-                .d-none{id: "external_tool_form_#{tool[:name]}"}
-                  = form_tag user_external_tools_path(url_encode(@user.username)) do
-                    = hidden_field_tag 'user[tool_name]', tool[:name]
-                    = text_field_tag 'user[apikey]', saved_key, class: 'register-input-long', placeholder: t('users.show.external_tool_apikey_placeholder')
-                    .mt-2
-                      = render Buttons::RegularButtonComponent.new(id: "save_#{tool[:name]}_apikey", variant: 'secondary', size: 'slim', type: 'submit', value: t('users.show.external_tool_apikey_save'))
+          %h4.account-page-card-title= t('users.show.external_tools')
+          %p.account-page-card-desc= t('users.show.external_tools_description')
+          - external_tools_list.each do |tool|
+            - saved_key = user_external_tool_apikey(@user, tool[:name])
+            .account-page-subscription
+              %a{'data-action': 'click->reveal-component#toggle', 'data-id': "external_tool_form_#{tool[:name]}", style: 'cursor: pointer;'}
+                = tool[:label]
+            .d-none.mt-3{id: "external_tool_form_#{tool[:name]}"}
+              = form_tag user_external_tools_path(url_encode(@user.username)) do
+                = hidden_field_tag 'user[tool_name]', tool[:name]
+                = render Input::TextInputComponent.new(name: 'user[apikey]', value: saved_key, placeholder: t('users.show.external_tool_apikey_placeholder'))
+                .mt-3
+                  = render Buttons::RegularButtonComponent.new(id: "save_#{tool[:name]}_apikey", variant: 'secondary', size: 'slim', type: 'submit', value: t('users.show.external_tool_apikey_save'))
         .account-page-card{'data-controller': 'reveal-component'}
           %h4.account-page-card-title
             = t('users.show.custom_semantic_resource')

config/locales/en.yml

@@ -956,6 +956,8 @@ en:
     external_tool_no_apikey: Please save your %{tool} API key in your account first.
     external_tool_go_to_account: Go to my account
     external_tool_resolve_failed: No matching %{tool} thesaurus found for this ontology.
+    external_tool_invalid_apikey: Your %{tool} API key seems invalid. Please check it in your account.
+    external_tool_connection_failed: Unable to connect to %{tool}, please try again later.
     confirm_submission_title: Confirm submission
     confirm_submission_message: Are you sure you want to submit this ontology? This action will create a new submission.
     admin_links: Administration links
@@ -1740,6 +1742,7 @@ en:
     error_saving_external_tools: Error saving the API key, please try again
     external_tools_apikey_required: Please enter an API key before saving
     external_tools_saved: API key saved successfully
+    external_tools_removed: API key removed successfully
     error_subscribe: Something went wrong ...
     first_name_required: First name field is required
     index:

config/locales/fr.yml

@@ -988,6 +988,8 @@ fr:
     external_tool_no_apikey: Veuillez d'abord enregistrer votre clé API %{tool} dans votre compte.
     external_tool_go_to_account: Aller à mon compte
     external_tool_resolve_failed: Aucun thésaurus %{tool} ne correspond à cette ontologie.
+    external_tool_invalid_apikey: Votre clé API %{tool} semble invalide. Veuillez la vérifier dans votre compte.
+    external_tool_connection_failed: Impossible de se connecter à %{tool}, veuillez réessayer plus tard.
     confirm_submission_title: Confirmer la soumission
     confirm_submission_message: Êtes-vous sûr de vouloir soumettre cette ontologie ? Cette action créera une nouvelle soumission.
     admin_links: Liens d'administratiion
@@ -1795,6 +1797,7 @@ fr:
     error_subscribe: Quelque chose s'est mal passé ...
     external_tools_apikey_required: Veuillez saisir une clé API avant de sauvegarder
     external_tools_saved: Clé API enregistrée avec succès
+    external_tools_removed: Clé API supprimée avec succès
     first_name_required: Le champ Prénom est requis
     index:
       actions: Actions