qa_server 2.1.0 → 2.2.0

data/app/presenters/qa_server/navmenu_presenter.rb

@@ -29,6 +29,7 @@ module QaServer
       @leftmenu_items << { label: I18n.t("qa_server.menu.authorities"), url: authority_list_index_path }
       @leftmenu_items << { label: I18n.t("qa_server.menu.check_status"), url: check_status_index_path }
       @leftmenu_items << { label: I18n.t("qa_server.menu.monitor_status"), url: monitor_status_index_path }
+      @leftmenu_items << { label: I18n.t("qa_server.menu.fetch_term"), url: fetch_index_path }
 
       @rightmenu_items = []
       @rightmenu_items << { label: "LD4L Gateway", url: "http://ld4l.org/" }

data/app/services/qa_server/authority_loader_service.rb

@@ -2,38 +2,44 @@
 # This class loads an authority.
 module QaServer
   class AuthorityLoaderService
-    # Load a QA authority
-    # @param authority_name [String] name of the authority to load (e.g. "agrovoc_direct")
-    # @param status_log [ScenarioLogger] logger to hold failure information if the authority cannot be loaded
-    # @return [Qa::Authorities::LinkedData::GenericAuthority] the instance of the authority that can receive QA requests OR nil if fails to load
-    def self.load(authority_name:, status_log:)
-      begin
-        authority = load_authority(authority_name, status_log)
-        return nil if authority.blank?
-      rescue Exception => e
-        status_log.add(authority_name: authority_name,
-                       status: QaServer::ScenarioValidator::FAIL,
-                       error_message: "Unable to load authority '#{authority_name}'; cause: #{e.message}")
-        return nil
+    class << self
+      # Load a QA authority
+      # @param authority_name [String] name of the authority to load (e.g. "agrovoc_direct")
+      # @param status_log [ScenarioLogger] logger to hold failure information if the authority cannot be loaded
+      # @return [Qa::Authorities::LinkedData::GenericAuthority] the instance of the authority that can receive QA requests OR nil if fails to load
+      def load(authority_name:, status_log: nil)
+        begin
+          authority = load_authority(authority_name, status_log)
+          return nil if authority.blank?
+        rescue Exception => e
+          if status_log.present?
+            status_log.add(authority_name: authority_name,
+                           status: QaServer::ScenarioValidator::FAIL,
+                           error_message: "Unable to load authority '#{authority_name}'; cause: #{e.message}")
+          end
+          return nil
+        end
+        authority
       end
-      authority
-    end
 
-    def self.authority_key(authority_name)
-      authority_name.upcase.to_sym
-    end
-    private_class_method :authority_key
+      private
 
-    def self.load_authority(authority_name, status_log)
-      authority = Qa::Authorities::LinkedData::GenericAuthority.new(authority_key(authority_name))
-      if authority.blank?
-        status_log.add(authority_name: authority_name,
-                       status: QaServer::ScenarioValidator::FAIL,
-                       error_message: "Unable to load authority '#{authority_name}'; cause: UNKNOWN")
-        return nil
-      end
-      authority
+        def authority_key(authority_name)
+          authority_name.upcase.to_sym
+        end
+
+        def load_authority(authority_name, status_log)
+          authority = Qa::Authorities::LinkedData::GenericAuthority.new(authority_key(authority_name))
+          if authority.blank?
+            if status_log.present?
+              status_log.add(authority_name: authority_name,
+                             status: QaServer::ScenarioValidator::FAIL,
+                             error_message: "Unable to load authority '#{authority_name}'; cause: UNKNOWN")
+            end
+            return nil
+          end
+          authority
+        end
     end
-    private_class_method :load_authority
   end
 end

data/app/views/layouts/qa_server.html.erb

@@ -47,7 +47,9 @@
 
 <div id="content-wrapper" class="container" role="main">
   <a name="skip_to_content"></a>
-  <%# = render '/flash_msg' %>
+  <% flash.each do |key, value| %>
+      <div class="alert alert-<%= key %>"><%= value %></div>
+  <% end %>
   <% if content_for?(:page_header) %>
       <div class="row">
         <div class="col-xs-12 main-header">

data/app/views/qa_server/fetch/index.html.erb

@@ -0,0 +1,62 @@
+<script>
+  function validate_authority(form) {
+    form.submit();
+    document.getElementById('status-loading-message').style.display = 'block';
+  }
+</script>
+
+<div class="page-description">
+
+  <h2><%= t('qa_server.fetch.title') %></h2>
+
+  <%= form_tag({ action: 'index' }, { method: :get }) do %>
+    <p>
+      <%= label_tag('uri', t('qa_server.fetch.uri_field_label'), class: 'horizontal-list') %>
+      <%= text_field_tag('uri', @presenter.uri, placeholder: 'Enter URI for term...', size: 75, maxlength: 75) %>
+    </p>
+    <p>
+      <%= label_tag('authority', t('qa_server.fetch.authority_field_label'), class: 'horizontal-list') %>
+      <% if @presenter.term_results? %>
+      <%= select_tag('authority', options_for_select(@presenter.authorities_list, @presenter.authority)) %>
+      <% else %>
+      <%= select_tag('authority', options_for_select(@presenter.authorities_list), include_blank: t('qa_server.fetch.select_authority')) %>
+      <% end %>
+    </p>
+    <p>
+      <%= label_tag('results_format', t('qa_server.fetch.format_field_label'), class: 'horizontal-list') %>
+      <%= select_tag('results_format', options_for_select(@presenter.formats_list, @presenter.format)) %>
+    </p>
+    <p>
+      <%= submit_tag t('qa_server.fetch.submit_button'), class: 'submit_button' %>
+    </p>
+  <% end %>
+
+  <div id="status-loading-message" class="wait-message"><%= t('qa_server.fetch.wait_message') %></div>
+
+  <% if @presenter.term_results? %>
+      <div id="term-results-section" class="results-section">
+    <h3><%= t('qa_server.fetch.term_results') %></h3>
+    <table class="status">
+      <tr>
+        <th><%= t('qa_server.fetch.uri_field_label') %></th>
+        <td><%= @presenter.uri %></td>
+      </tr>
+      <tr>
+        <th><%= t('qa_server.fetch.authority_field_label') %></th>
+        <td><%= @presenter.authority %></td>
+      </tr>
+      <tr>
+        <th><%= t('qa_server.fetch.format_field_label') %></th>
+        <td><%= @presenter.format %></td>
+      </tr>
+    </table>
+
+    <div id="term-results" class="results-panel">
+      <pre><%= @presenter.term_results %></pre>
+    </div>
+
+  </div>
+
+  <% end %>
+
+</div>

data/app/views/qa_server/monitor_status/index.html.erb

@@ -26,7 +26,7 @@
   <p class="status-update-dtstamp"><%= t('qa_server.monitor_status.summary.last_updated', date: @presenter.last_updated) %></p>
 
   <% if @presenter.failures? %>
-    <div id="status-section" class="status-section">
+    <div id="failures" class="status-section">
       <h4><%= t('qa_server.monitor_status.failures.title') %></h4>
 
       <table class="status">
@@ -60,7 +60,7 @@
   <% end %>
 
   <% if @presenter.history? && @presenter.display_history_details?%>
-      <div id="status-section" class="status-section">
+      <div id="availability-history" class="status-section">
         <h3><%= t('qa_server.monitor_status.history.title') %></h3>
         <p class="status-update-dtstamp"><%= t('qa_server.monitor_status.history.since', date: @presenter.first_updated) %></p>
         <%#= column_chart @presenter.historical_summary, stacked: true, colors: ["green", "red"], xtitle: 'Authority', ytitle: 'Pass-Fail', legend: 'bottom' %>
@@ -90,4 +90,64 @@
         <% end %>
       </div>
   <% end %>
+
+  <% if @presenter.performance_data? %>
+    <div id="performance-data" class="status-section">
+      <h3><%= t('qa_server.monitor_status.performance.title') %></h3>
+
+      <script>
+        function switch_performance_view(id) {
+            document.getElementById('performance-by-the-hour').style.display = 'none';
+            document.getElementById('performance-by-the-day').style.display = 'none';
+            document.getElementById('performance-by-the-month').style.display = 'none';
+            document.getElementById(id).style.display = 'block';
+        }
+      </script>
+
+      <div id="performance-by-the-hour" class="performance-data-section">
+        <div id="right-menu-section">
+          <ul class="right-menu">
+            <li class="selected"><%= t('qa_server.monitor_status.performance.menu_day') %></li>
+            <li class="clickable" onClick="switch_performance_view('performance-by-the-day')"><%= t('qa_server.monitor_status.performance.menu_month') %></li>
+            <li class="clickable" onClick="switch_performance_view('performance-by-the-month')"><%= t('qa_server.monitor_status.performance.menu_year') %></li>
+          </ul>
+        </div>
+
+        <div id="performance-chart-by-the-hour" class="performance-chart">
+          <p>Data for the last 24 hours</p>
+          <%= image_tag(@presenter.performance_for_day_graph, alt: 'Performance data for the last 24 hours.') %>
+        </div>
+      </div>
+
+      <div id="performance-by-the-day" class="performance-data-section">
+        <div id="right-menu-section">
+          <ul class="right-menu">
+            <li class="clickable" onClick="switch_performance_view('performance-by-the-hour')"><%= t('qa_server.monitor_status.performance.menu_day') %></li>
+            <li class="selected"><%= t('qa_server.monitor_status.performance.menu_month') %></li>
+            <li class="clickable" onClick="switch_performance_view('performance-by-the-month')"><%= t('qa_server.monitor_status.performance.menu_year') %></li>
+          </ul>
+        </div>
+
+        <div id="performance-chart-by-the-day" class="performance-chart">
+          <p>Data for the last 30 days</p>
+          <%= image_tag(@presenter.performance_for_month_graph, alt: 'Performance data for the last 30 days.') %>
+        </div>
+      </div>
+
+      <div id="performance-by-the-month" class="performance-data-section">
+        <div id="right-menu-section">
+          <ul class="right-menu">
+            <li class="clickable" onClick="switch_performance_view('performance-by-the-hour')"><%= t('qa_server.monitor_status.performance.menu_day') %></li>
+            <li class="clickable" onClick="switch_performance_view('performance-by-the-day')"><%= t('qa_server.monitor_status.performance.menu_month') %></li>
+            <li class="selected"><%= t('qa_server.monitor_status.performance.menu_year') %></li>
+          </ul>
+        </div>
+
+        <div id="performance-chart-by-the-month" class="performance-chart">
+          <p>Data for the last 12 months</p>
+          <%= image_tag(@presenter.performance_for_year_graph, alt: 'Performance data for the last 12 months.') %>
+        </div>
+      </div>
+    </div>
+  <% end %>
 </div>

data/config/locales/qa_server.en.yml

@@ -7,6 +7,7 @@ en:
       authorities:       Authorities
       check_status:      Check Status
       monitor_status:    Monitor Status
+      fetch_term:        Fetch Term
     authority_list:
       title:             Authority List
       see_check_status_html: 'See <a href="%{href}">Check Status</a> to test whether an authority is online.'
@@ -36,6 +37,15 @@ en:
         subauthority:    Subauthority
         subject_uri:     Expected Subject
         url:             Sample URL
+    fetch:
+      title:             Fetch a Term
+      authority_field_label: Authority
+      select_authority:      Select authority...
+      format_field_label:    Format
+      uri_field_label:       URI
+      submit_button:     Fetch Term
+      wait_message:      Fetching term...
+      term_results:      Results
     monitor_status:
       title:             Monitor Status
       summary:
@@ -64,5 +74,19 @@ en:
         days_passing:    Days Passing
         days_tested:     Days Tested
         percent_failing: Percent Failing
+      performance:
+        title:           Performance Metrics
+        menu_day:        Day
+        menu_month:      Month
+        menu_year:       Year
+        load_time_ms:          Load Time (ms)
+        normalization_time_ms: Normalization Time (ms)
+        combined_time_ms:      Full Request Time (ms)
+        x_axis_hour:     Hour
+        x_axis_day:      Day
+        x_axis_month:    Month
+        y_axis_ms:       Milliseconds (ms)
+        now:             NOW
+        today:           TODAY
     usage:
       title:             Usage

data/config/routes.rb

@@ -10,4 +10,5 @@ QaServer::Engine.routes.draw do
   resources :check_status, only: 'index'
   resources :monitor_status, only: 'index'
   resources :authority_list, only: 'index'
+  resources :fetch, only: 'index'
 end

data/lib/generators/qa_server/config_generator.rb

@@ -34,4 +34,13 @@ class QaServer::ConfigGenerator < Rails::Generators::Base
   def create_initializer_config_file
     copy_file 'config/initializers/qa_server.rb'
   end
+
+  def append_prepends
+    inject_into_file 'config/application.rb', after: /Rails::Application/ do
+      "\n      config.to_prepare do"\
+      "\n        Qa::Authorities::LinkedData::FindTerm.prepend PrependedLinkedData::FindTerm"\
+      "\n        Qa::Authorities::LinkedData::SearchQuery.prepend PrependedLinkedData::SearchQuery"\
+      "\n      end\n"
+    end
+  end
 end

data/lib/generators/qa_server/templates/config/authorities/linked_data/DISABLED/scenarios/mesh_bioportal_ld4l_cache_validation.yml

@@ -4,6 +4,8 @@ authority:
 search:
   -
     query: malignant
+    maxRecords: '4'
+    result_size: 1800
 term:
   -
     identifier: 'http://purl.bioontology.org/ontology/MESH/C535700'

data/lib/generators/qa_server/templates/config/authorities/linked_data/getty_aat_ld4l_cache.json

@@ -24,7 +24,7 @@
     },
     "term_id": "URI",
     "results": {
-      "id_ldpath":    "dc:identifier ::xsd:string",
+      "id_ldpath":       "dc:identifier ::xsd:string",
       "label_ldpath":    "skos:prefLabel ::xsd:string",
       "altlabel_ldpath": "skos:altLabel ::xsd:string",
       "broader_ldpath":  "skos:broader ::xsd:anyURI",

data/lib/generators/qa_server/templates/config/authorities/linked_data/getty_tgn_ld4l_cache.json

@@ -25,7 +25,7 @@
     },
     "term_id": "URI",
     "results": {
-      "id_ldpath":    "dc:identifier ::xsd:string",
+      "id_ldpath":       "dc:identifier ::xsd:string",
       "label_ldpath":    "skos:prefLabel ::xsd:string",
       "altlabel_ldpath": "skos:altLabel ::xsd:string",
       "broader_ldpath":  "skos:broader ::xsd:anyURI",

data/lib/generators/qa_server/templates/config/authorities/linked_data/getty_ulan_ld4l_cache.json

@@ -24,7 +24,7 @@
     },
     "term_id": "URI",
     "results": {
-      "id_ldpath":    "dc:identifier ::xsd:string",
+      "id_ldpath":       "dc:identifier ::xsd:string",
       "label_ldpath":    "skos:prefLabel ::xsd:string",
       "altlabel_ldpath": "skos:altLabel ::xsd:string",
       "broader_ldpath":  "skos:broader ::xsd:anyURI",

data/lib/generators/qa_server/templates/config/authorities/linked_data/locdemographics_ld4l_cache.json

@@ -27,7 +27,7 @@
     "results": {
       "id_ldpath":       "loc:lccn ::xsd:string",
       "label_ldpath":    "skos:prefLabel ::xsd:string",
-      "altlabel_ldpath": "skos:altLabel ::xsd:string",
+      "altlabel_ldpath": "madsrdf:hasVariant/madsrdf:variantLabel ::xsd:string",
       "sameas_ldpath":   "skos:exactMatch ::xsd:anyURI"
     }
   },
@@ -35,7 +35,7 @@
     "url": {
       "@context": "http://www.w3.org/ns/hydra/context.jsonld",
       "@type": "IriTemplate",
-      "template": "http://services.ld4l.org/ld4l_services/loc_demographics_batch.jsp?{?query}&{?maxRecords}&{?lang}",
+      "template": "http://services.ld4l.org/ld4l_services/loc_demographics_batch.jsp?{?query}&{?maxRecords}&{?startRecord}&{?lang}",
       "variableRepresentation": "BasicRepresentation",
       "mapping": [
         {
@@ -52,6 +52,13 @@
           "required": false,
           "default": "20"
         },
+        {
+          "@type": "IriTemplateMapping",
+          "variable": "startRecord",
+          "property": "hydra:freetextQuery",
+          "required": false,
+          "default": "1"
+        },
         {
           "@type": "IriTemplateMapping",
           "variable": "lang",
@@ -65,8 +72,108 @@
       "query":   "query"
     },
     "results": {
-      "label_ldpath":    "madsrdf:authoritativeLabel ::xsd:string",
+      "label_ldpath":    "skos:prefLabel ::xsd:string",
       "sort_ldpath":     "vivo:rank ::xsd:string"
+    },
+    "context": {
+      "groups": {
+        "hierarchy": {
+          "group_label_i18n": "qa.linked_data.authority.locdemographics_ld4l_cache.hierarchy",
+          "group_label_default": "Hierarchy"
+        }
+      },
+      "properties": [
+        {
+          "property_label_i18n": "qa.linked_data.authority.locdemographics_ld4l_cache.preferred_label",
+          "property_label_default": "Preferred label",
+          "ldpath": "skos:prefLabel :: xsd:string",
+          "selectable": true,
+          "drillable": false
+        },
+        {
+          "group_id": "hierarchy",
+          "property_label_i18n": "qa.linked_data.authority.locdemographics_ld4l_cache.broader",
+          "property_label_default": "Broader",
+          "ldpath": "skos:broader :: xsd:string",
+          "selectable": true,
+          "drillable": true,
+          "expansion_label_ldpath": "skos:prefLabel ::xsd:string",
+          "expansion_id_ldpath": "loc:lccn ::xsd:string"
+        },
+        {
+          "group_id": "hierarchy",
+          "property_label_i18n": "qa.linked_data.authority.locdemographics_ld4l_cache.narrower",
+          "property_label_default": "Narrower",
+          "ldpath": "skos:narrower :: xsd:string",
+          "selectable": true,
+          "drillable": true,
+          "expansion_label_ldpath": "skos:prefLabel ::xsd:string",
+          "expansion_id_ldpath": "loc:lccn ::xsd:string"
+        },
+        {
+          "property_label_i18n": "qa.linked_data.authority.locdemographics_ld4l_cache.variant_label",
+          "property_label_default": "Variant",
+          "ldpath": "madsrdf:hasVariant/madsrdf:variantLabel :: xsd:string",
+          "selectable": false,
+          "drillable": false
+        },
+        {
+          "property_label_i18n": "qa.linked_data.authority.locdemographics_ld4l_cache.earlier_form",
+          "property_label_default": "Earlier form",
+          "ldpath": "madsrdf:hasEarlierEstablishedForm/madsrdf:variantLabel :: xsd:string",
+          "selectable": false,
+          "drillable": false
+        },
+        {
+          "property_label_i18n": "qa.linked_data.authority.locdemographics_ld4l_cache.related",
+          "property_label_default": "Related",
+          "ldpath": "skos:related/skos:prefLabel :: xsd:string",
+          "selectable": false,
+          "drillable": false
+        },
+        {
+          "property_label_i18n": "qa.linked_data.authority.locdemographics_ld4l_cache.note",
+          "property_label_default": "Note",
+          "ldpath": "skos:note :: xsd:string",
+          "selectable": false,
+          "drillable": false
+        },
+        {
+          "property_label_i18n": "qa.linked_data.authority.locdemographics_ld4l_cache.example",
+          "property_label_default": "Example",
+          "ldpath": "skos:example :: xsd:string",
+          "selectable": false,
+          "drillable": false
+        },
+        {
+          "property_label_i18n": "qa.linked_data.authority.locdemographics_ld4l_cache.citation_note",
+          "property_label_default": "Citation note",
+          "ldpath": "madsrdf:hasSource/madsrdf:citation-note :: xsd:string",
+          "selectable": false,
+          "drillable": false
+        },
+        {
+          "property_label_i18n": "qa.linked_data.authority.locdemographics_ld4l_cache.citation_source",
+          "property_label_default": "Citation source",
+          "ldpath": "madsrdf:hasSource/madsrdf:citation-source :: xsd:string",
+          "selectable": false,
+          "drillable": false
+        },
+        {
+          "property_label_i18n": "qa.linked_data.authority.locdemographics_ld4l_cache.citation_status",
+          "property_label_default": "Citation status",
+          "ldpath": "madsrdf:hasSource/madsrdf:citation-status :: xsd:string",
+          "selectable": false,
+          "drillable": false
+        },
+        {
+          "property_label_i18n": "qa.linked_data.authority.locdemographics_ld4l_cache.scheme",
+          "property_label_default": "Scheme",
+          "ldpath": "madsrdf:isMemberOfMADSScheme/rdfs:label :: xsd:string",
+          "selectable": false,
+          "drillable": false
+        }
+      ]
     }
   }
 }