qa 3.1.0 → 4.0.0.rc1

data/app/services/qa/linked_data/language_service.rb

@@ -0,0 +1,30 @@
+# Service to determine which language to use for sorting and filtering.
+module Qa
+  module LinkedData
+    class LanguageService
+      class << self
+        def preferred_language(user_language: nil, authority_language: nil)
+          return normalize_language(user_language) if user_language.present?
+          return normalize_language(authority_language) if authority_language.present?
+          normalize_language(Qa.config.default_language)
+        end
+
+        def literal_has_language_marker?(literal)
+          return false unless literal.respond_to?(:language)
+          literal.language.present?
+        end
+
+        private
+
+          # Normalize language
+          # @param [String | Symbol | Array] language for filtering graph (e.g. "en" OR :en OR ["en", "fr"] OR [:en, :fr])
+          # @return [Array<Symbol>] an array of languages encoded as symbols (e.g. [:en] OR [:en, :fr])
+          def normalize_language(language)
+            return language if language.blank?
+            language = [language] unless language.is_a? Array
+            language.map(&:to_sym)
+          end
+      end
+    end
+  end
+end

data/app/services/qa/linked_data/language_sort_service.rb

@@ -0,0 +1,81 @@
+# Service to sort an array of literals by language and within language.
+module Qa
+  module LinkedData
+    class LanguageSortService
+      LANGUAGE_LOCALE_KEY_FOR_NO_LANGUAGE = :NO_LANGUAGE
+
+      attr_reader :literals, :preferred_language
+      attr_reader :languages, :bins
+      private :literals, :preferred_language, :languages, :bins
+      # private :literals, :preferred_language, :languages, :languages=, :bins, :bins=
+
+      # @param [Array<RDF::Literals>] string literals to sort
+      # @param [Symbol] preferred language to appear first in the list; defaults to no preference
+      # @return instance of this class
+      def initialize(literals, preferred_language = nil)
+        @literals = literals
+        @preferred_language = preferred_language
+        @languages = []
+        @bins = {}
+      end
+
+      # Sort the literals stored in this instance of the service
+      # @return sorted version of literals
+      def sort
+        return literals unless literals.present?
+        return @sorted_literals if @sorted_literals.present?
+        parse_into_language_bins
+        sort_languages
+        sort_language_bins
+        @sorted_literals = construct_sorted_literals
+      end
+
+      private
+
+        def construct_sorted_literals
+          sorted_literals = []
+          0.upto(languages.size - 1) { |idx| sorted_literals.concat(bins[languages[idx]]) }
+          sorted_literals
+        end
+
+        def language(literal)
+          return LANGUAGE_LOCALE_KEY_FOR_NO_LANGUAGE unless Qa::LinkedData::LanguageService.literal_has_language_marker? literal
+          literal.language
+        end
+
+        def move_no_language_to_end
+          return unless languages.include?(LANGUAGE_LOCALE_KEY_FOR_NO_LANGUAGE)
+          languages.delete(LANGUAGE_LOCALE_KEY_FOR_NO_LANGUAGE)
+          languages << LANGUAGE_LOCALE_KEY_FOR_NO_LANGUAGE
+        end
+
+        def move_preferred_language_to_front
+          return unless preferred_language.present? && languages.include?(preferred_language)
+          languages.delete(preferred_language)
+          languages.insert(0, preferred_language)
+        end
+
+        def parse_into_language_bins
+          0.upto(literals.size - 1) do |idx|
+            lang = language(literals[idx])
+            languages << lang
+            bin = bins.fetch(lang, [])
+            bin << literals[idx]
+            bins[lang] = bin
+          end
+          @language = languages
+          @bins = bins
+        end
+
+        def sort_languages
+          languages.sort!.uniq!
+          move_preferred_language_to_front
+          move_no_language_to_end
+        end
+
+        def sort_language_bins
+          bins.each_value { |bin| bin.sort_by! { |literal| literal.to_s.downcase } }
+        end
+    end
+  end
+end

data/app/services/qa/linked_data/mapper/context_mapper_service.rb

@@ -0,0 +1,59 @@
+# Provide service for mapping predicates to object values.
+module Qa
+  module LinkedData
+    module Mapper
+      class ContextMapperService
+        class_attribute :graph_service
+        self.graph_service = Qa::LinkedData::GraphService
+
+        class << self
+          # Extract predicates specified in the predicate_map from the graph and return as a value map for a single subject URI.
+          # @param graph [RDF::Graph] the graph from which to extract result values
+          # @param context_map [Qa::LinkedData::Config::ContextMap] defines properties to extract from the graph to provide additional context
+          # @param subject_uri [RDF::URI] the subject within the graph for which the values are being extracted
+          # @return [<Hash<Symbol><Array<Object>>] mapped context values and information with hash of map key = array of object values for predicates identified in predicate_map.
+          # @example returned context map with one property defined
+          #   [{"group" => "group label,
+          #     "property" => "property label",
+          #     "values" => ["value 1","value 2"],
+          #     "selectable" => true,
+          #     "drillable" => false}]
+          def map_context(graph:, context_map:, subject_uri:)
+            context = []
+            context_map.properties.each do |property_map|
+              populated_property_map = populate_property_map(context_map, property_map, graph, subject_uri)
+              next if populated_property_map.blank?
+              context << populated_property_map
+            end
+            context
+          end
+
+          private
+
+            def populate_property_map(context_map, property_map, graph, subject_uri)
+              begin
+                values = property_values(property_map, graph, subject_uri)
+              rescue => e
+                values = Qa::LinkedData::Config::ContextPropertyMap::VALUE_ON_ERROR
+                error = e.message
+              end
+
+              property_info = {}
+              property_info["group"] = context_map.group_label(property_map.group_id) if property_map.group?
+              property_info["property"] = property_map.label
+              property_info["values"] = values
+              property_info["selectable"] = property_map.selectable?
+              property_info["drillable"] = property_map.drillable?
+              property_info["error"] = error if error.present?
+              property_info
+            end
+
+            def property_values(property_map, graph, subject_uri)
+              return property_map.expanded_values(graph, subject_uri) if property_map.expand_uri?
+              property_map.values(graph, subject_uri)
+            end
+        end
+      end
+    end
+  end
+end

data/app/services/qa/linked_data/mapper/graph_mapper_service.rb

@@ -0,0 +1,40 @@
+# Provide service for mapping predicates to object values.
+module Qa
+  module LinkedData
+    module Mapper
+      class GraphMapperService
+        class_attribute :graph_service
+        self.graph_service = Qa::LinkedData::GraphService
+
+        # Extract predicates specified in the predicate_map from the graph and return as a value map for a single subject URI.
+        # @param graph [RDF::Graph] the graph from which to extract result values
+        # @param predicate_map [Hash<Symbol><String||Symbol>] value either maps to a predicate in the graph or is :subject_uri indicating to use the subject uri as the value
+        # @example predicate_map
+        #   {
+        #     uri: :subject_uri,
+        #     id: [#<RDF::URI URI:http://id.loc.gov/vocabulary/identifiers/lccn>],
+        #     label: [#<RDF::URI URI:http://www.w3.org/2004/02/skos/core#prefLabel>],
+        #     altlabel: [#<RDF::URI URI:http://www.w3.org/2004/02/skos/core#altLabel>],
+        #     sort: [#<RDF::URI URI:http://vivoweb.org/ontology/core#rank>]'
+        #   }
+        # @param subject_uri [RDF::URI] the subject within the graph for which the values are being extracted
+        # @return [<Hash<Symbol><Array<Object>>] mapped result values with hash of map key = array of object values for predicates identified in predicate_map.
+        # @example value map for a single result
+        #   {:uri=>[#<RDF::URI:0x3fcff54a829c URI:http://id.loc.gov/authorities/names/n2010043281>],
+        #    :id=>[#<RDF::Literal:0x3fcff4a367b4("n2010043281")>],
+        #    :label=>[#<RDF::Literal:0x3fcff54a9a98("Valli, Sabrina"@en)>],
+        #    :altlabel=>[],
+        #    :sort=>[#<RDF::Literal:0x3fcff54b4c18("2")>]}
+        def self.map_values(graph:, predicate_map:, subject_uri:)
+          value_map = {}
+          predicate_map.each do |key, predicate|
+            values = predicate == :subject_uri ? [subject_uri] : graph_service.object_values(graph: graph, subject: subject_uri, predicate: predicate)
+            value_map[key] = values
+          end
+          value_map = yield value_map if block_given?
+          value_map
+        end
+      end
+    end
+  end
+end

data/app/services/qa/linked_data/mapper/search_results_mapper_service.rb

@@ -0,0 +1,70 @@
+# Provide service for mapping graph to json limited to configured fields and context.
+module Qa
+  module LinkedData
+    module Mapper
+      class SearchResultsMapperService
+        class_attribute :graph_mapper_service, :deep_sort_service, :context_mapper_service
+        self.graph_mapper_service = Qa::LinkedData::Mapper::GraphMapperService
+        self.deep_sort_service = Qa::LinkedData::DeepSortService
+        self.context_mapper_service = Qa::LinkedData::Mapper::ContextMapperService
+
+        class << self
+          # Extract predicates specified in the predicate_map from the graph and return as an array of value maps for each search result subject URI.
+          # If a sort key is present, a subject will only be included in the results if it has a statement with the sort predicate.
+          # @param graph [RDF::Graph] the graph from which to extract result values
+          # @param predicate_map [Hash<Symbol><String||Symbol>] value either maps to a predicate in the graph or is :subject_uri indicating to use the subject uri as the value
+          # @example predicate map
+          #   {
+          #     uri: :subject_uri,
+          #     id: 'http://id.loc.gov/vocabulary/identifiers/lccn',
+          #     label: 'http://www.w3.org/2004/02/skos/core#prefLabel',
+          #     altlabel: 'http://www.w3.org/2004/02/skos/core#altLabel',
+          #     sort: 'http://vivoweb.org/ontology/core#rank'
+          #   }
+          # @param sort_key [Symbol] the key in the predicate map for the value on which to sort
+          # @param context_map [Qa::LinkedData::Config::ContextMap] map of additional context to include in the results
+          # @return [Array<Hash<Symbol><Array<Object>>>] mapped result values with each result as an element in the array
+          #    with hash of map key = array of object values for predicates identified in map parameter.
+          # @example value map for a single result
+          #   [
+          #     {:uri=>[#<RDF::URI:0x3fcff54a829c URI:http://id.loc.gov/authorities/names/n2010043281>],
+          #      :id=>[#<RDF::Literal:0x3fcff4a367b4("n 2010043281")>],
+          #      :label=>[#<RDF::Literal:0x3fcff54a9a98("Valli, Sabrina"@en)>],
+          #      :altlabel=>[],
+          #      :sort=>[#<RDF::Literal:0x3fcff54b4c18("2")>]}
+          #   ]
+          def map_values(graph:, predicate_map:, sort_key:, preferred_language: nil, context_map: nil)
+            search_matches = []
+            graph.subjects.each do |subject|
+              next if subject.anonymous? # skip blank nodes
+              values = graph_mapper_service.map_values(graph: graph, predicate_map: predicate_map, subject_uri: subject) do |value_map|
+                map_context(graph, sort_key, context_map, value_map, subject)
+              end
+              search_matches << values if result_subject? values, sort_key
+            end
+            search_matches = deep_sort_service.new(search_matches, sort_key, preferred_language).sort
+            search_matches
+          end
+
+          private
+
+            # The graph mapper creates the basic value_map for all subject URIs, but we only want the ones that represent search results.
+            def result_subject?(value_map, sort_key)
+              return true unless sort_key.present?        # if sort_key is not defined, then all subjects are considered matches
+              return false unless value_map.key? sort_key # otherwise, sort_key must be in the basic value_map
+              value_map[sort_key].present?                # AND have a value for this to be a search result
+            end
+
+            def map_context(graph, sort_key, context_map, value_map, subject)
+              return value_map if context_map.blank?
+              return value_map unless result_subject? value_map, sort_key
+              context = {}
+              context = context_mapper_service.map_context(graph: graph, context_map: context_map, subject_uri: subject) if context_map.present?
+              value_map[:context] = context
+              value_map
+            end
+        end
+      end
+    end
+  end
+end

data/config/authorities/linked_data/loc.json

@@ -1,9 +1,10 @@
 {
+  "QA_CONFIG_VERSION": "2.0",
   "term": {
     "url": {
       "@context": "http://www.w3.org/ns/hydra/context.jsonld",
       "@type": "IriTemplate",
-      "template": "http://id.loc.gov/authorities/{?subauth}/{?term_id}",
+      "template": "http://id.loc.gov/authorities/{subauth}/{term_id}",
       "variableRepresentation": "BasicRepresentation",
       "mapping": [
         {
@@ -31,7 +32,9 @@
       "id_predicate": "http://id.loc.gov/vocabulary/identifiers/lccn",
       "label_predicate": "http://www.w3.org/2004/02/skos/core#prefLabel",
       "altlabel_predicate": "http://www.w3.org/2004/02/skos/core#altLabel",
-      "sameas_predicate": "http://www.w3.org/2004/02/skos/core#exactMatch"
+      "sameas_predicate": "http://www.w3.org/2004/02/skos/core#exactMatch",
+      "narrower_predicate": "http://www.loc.gov/mads/rdf/v1#hasNarrowerAuthority",
+      "broader_predicate": "http://www.loc.gov/mads/rdf/v1#hasBroaderAuthority"
     },
     "subauthorities": {
       "subjects": "subjects",

data/config/authorities/linked_data/oclc_fast.json

@@ -1,9 +1,10 @@
 {
+  "QA_CONFIG_VERSION": "2.0",
   "term": {
     "url": {
       "@context": "http://www.w3.org/ns/hydra/context.jsonld",
       "@type":    "IriTemplate",
-      "template": "http://id.worldcat.org/fast/{?term_id}",
+      "template": "http://id.worldcat.org/fast/{term_id}",
       "variableRepresentation": "BasicRepresentation",
       "mapping": [
         {
@@ -29,7 +30,7 @@
     "url": {
       "@context": "http://www.w3.org/ns/hydra/context.jsonld",
       "@type": "IriTemplate",
-      "template": "http://experimental.worldcat.org/fast/search?query={?subauth}+all+%22{?query}%22&sortKeys=usage&maximumRecords={?maximumRecords}",
+      "template": "http://experimental.worldcat.org/fast/search?query={subauth}+all+%22{query}%22&sortKeys=usage&{?maximumRecords}",
       "variableRepresentation": "BasicRepresentation",
       "mapping": [
         {

data/config/initializers/linked_data_authorities.rb

@@ -1 +1 @@
-Qa::Authorities::LinkedData::AuthorityService.load_authorities
+Qa::LinkedData::AuthorityService.load_authorities

data/config/locales/qa.en.yml

@@ -0,0 +1,9 @@
+---
+en:
+  qa:
+    linked_data:
+      ldpath:
+        evaluate_error: LDPATH EVALUATION ERROR (See log for more information)
+        evaluate_logger_error: LDPath failed to evaluate the graph with the provided ldpath.
+        parse_error: LDPATH PARSE ERROR (See log for more information)
+        parse_logger_error: LDPath failed to parse during ldpath program creation.

data/lib/generators/qa/install/templates/config/initializers/qa.rb

@@ -10,4 +10,8 @@ Qa.config do |config|
   # requiring a restart of rails. By default, reloading through the browser is not allowed
   # when the token is nil or blank.  Change to any string to control who has access to reload.
   # config.authorized_reload_token = 'YOUR_AUTH_TOKEN_DEFINED_HERE'
+
+  # For linked data access, specify default language for sorting and selection.  The default is only used if a language is not
+  # specified in the authority's configuration file and not passed in as a parameter.  (e.g. :en, [:en], or [:en, :fr])
+  # config.default_language = :en
 end

data/lib/qa.rb

@@ -42,6 +42,9 @@ module Qa
   # Raised when a configuration parameter is incorrect or is required and missing
   class InvalidConfiguration < ArgumentError; end
 
+  # Raised when a request is made for an unsupported action (e.g. :search, :term are supported)
+  class UnsupportedAction < ArgumentError; end
+
   # Raised when a linked data request to a server returns a 503 error
   class ServiceUnavailable < ArgumentError; end
 
@@ -50,4 +53,9 @@ module Qa
 
   # Raised when the server returns 404 for a find term request
   class TermNotFound < ArgumentError; end
+
+  # Raised when a required mapping parameter is missing while building an IRI Template
+  module IriTemplate
+    class MissingParameter < StandardError; end
+  end
 end

data/lib/qa/authorities/assign_fast/generic_authority.rb

@@ -53,7 +53,7 @@ module Qa::Authorities
       #   See oclc sample code at
       #   http://experimental.worldcat.org/fast/assignfast/js/assignFASTComplete.js
       def clean_query_string(q)
-        URI.escape(q.gsub(/-|\(|\)|:/, ""))
+        ERB::Util.url_encode(q.gsub(/-|\(|\)|:/, ""))
       end
 
       def parse_authority_response(raw_response)

data/lib/qa/authorities/base.rb

@@ -1,13 +1,9 @@
-require 'deprecation'
-
 module Qa::Authorities
   ##
   # @abstract The base class for all authorites. Implementing subclasses must
   #   provide {#all} and #{find} methods.
   # @todo What about {#search}?
   class Base
-    extend Deprecation
-
     ##
     # @abstract By default, #all is not implemented. A subclass authority must
     #   implement this method to conform to the generic interface.
@@ -33,12 +29,5 @@ module Qa::Authorities
     def find(_id)
       raise NotImplementedError, "#{self.class}#find is unimplemented."
     end
-
-    ##
-    # @deprecated use {#find} instead
-    def full_record(id, _subauthority = nil)
-      Deprecation.warn('#full_record is deprecated. Use #find instead')
-      find(id)
-    end
   end
 end

data/lib/qa/authorities/crossref/generic_authority.rb

@@ -23,7 +23,7 @@ module Qa::Authorities
     end
 
     def build_query_url(q)
-      query = URI.escape(untaint(q))
+      query = ERB::Util.url_encode(untaint(q))
       "http://api.crossref.org/#{subauthority}?query=#{query}"
     end
 

data/lib/qa/authorities/geonames.rb

@@ -17,7 +17,7 @@ module Qa::Authorities
     end
 
     def build_query_url(q)
-      query = URI.escape(untaint(q))
+      query = ERB::Util.url_encode(untaint(q))
       "http://api.geonames.org/searchJSON?q=#{query}&username=#{username}&maxRows=10"
     end
 

data/lib/qa/authorities/getty/aat.rb

@@ -7,7 +7,7 @@ module Qa::Authorities
     end
 
     def build_query_url(q)
-      "http://vocab.getty.edu/sparql.json?query=#{URI.escape(sparql(q))}&_implicit=false&implicit=true&_equivalent=false&_form=%2Fsparql"
+      "http://vocab.getty.edu/sparql.json?query=#{ERB::Util.url_encode(sparql(q))}&_implicit=false&implicit=true&_equivalent=false&_form=%2Fsparql"
     end
 
     def sparql(q) # rubocop:disable Metrics/MethodLength
@@ -38,7 +38,7 @@ module Qa::Authorities
     end
 
     def find_url(id)
-      "http://vocab.getty.edu/aat/#{id}.json"
+      "http://vocab.getty.edu/download/json?uri=http://vocab.getty.edu/aat/#{id}.json"
     end
 
     def request_options
@@ -52,6 +52,11 @@ module Qa::Authorities
         response['results']['bindings'].map do |result|
           { 'id' => result['s']['value'], 'label' => result['name']['value'] }
         end
+      rescue StandardError => e
+        cause = response.fetch('error', {}).fetch('cause', 'UNKNOWN')
+        cause = cause.present? ? cause : 'UNKNOWN'
+        Rails.logger.warn "  ERROR fetching Getty response: #{e.message}; cause: #{cause}"
+        {}
       end
   end
 end