qa 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eb0e94ad762c71e5dd0bf2a7b99e03ee71b348e8
-  data.tar.gz: c8d21f4c0379b3035439e39a6b085faa314bf602
+SHA256:
+  metadata.gz: 7e4ee1da3b72cee5194380a24b44e96793395d110cbe2234da55541da3f962c9
+  data.tar.gz: 27dffc56d77c9e583000c99823a31fe8c90f3591ea3de04935c4e476bda9d289
 SHA512:
-  metadata.gz: c1b33787d92489239f1530cc05b4ea3e912e7ae913ed0197a0fb1e58e13e3bf75a701e3ec5d93a15c49288a3cca0f06647ec11380bb48d3eefb0917d3f594390
-  data.tar.gz: 2a6613d06be5b77c2709bc95d0dfe3d78814c3271e3399578726fe1e9bb2ecd533ae9533cf92e30c02345ff09624c705a8f3895f08986f104dd2baf0124e56b1
+  metadata.gz: ad1a1bc75bcde5877679a355e7afec3f992e869686f3c3c706d5e1ffee6ecdcc66c4be4a8572c9ca1c27b6b177b12b211debc8a579268037aff006872d3e9b5a
+  data.tar.gz: 789919e7a524d155d69ae2ca0203900cc0509f613d94d3b2b14ed697e2c80134b9d13dd56fb013c9db052069296955f4b948b43ff95ae10f93e4dd2ccbd643d6

data/app/controllers/qa/linked_data_terms_controller.rb

@@ -7,9 +7,15 @@ class Qa::LinkedDataTermsController < ::ApplicationController
   before_action :check_show_subauthority, :check_id_param, only: :show
   before_action :check_uri_param, only: :fetch
   before_action :validate_auth_reload_token, only: :reload
+  before_action :create_request_header_service, only: [:search, :show, :fetch]
 
   delegate :cors_allow_origin_header, to: Qa::ApplicationController
 
+  class_attribute :request_header_service_class
+  self.request_header_service_class = Qa::LinkedData::RequestHeaderService
+
+  attr_reader :request_header_service
+
   # Provide a warning if there is a request for all terms.
   def index
     logger.warn 'Linked data authorities do not support retrieving all terms.'
@@ -35,8 +41,8 @@ class Qa::LinkedDataTermsController < ::ApplicationController
   # Return a list of terms based on a query
   # get "/search/linked_data/:vocab(/:subauthority)"
   # @see Qa::Authorities::LinkedData::SearchQuery#search
-  def search # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-    terms = @authority.search(query, subauth: subauthority, language: language, replacements: replacement_params, context: context?, performance_data: performance_data?)
+  def search # rubocop:disable Metrics/MethodLength
+    terms = @authority.search(query, request_header: request_header_service.search_header)
     cors_allow_origin_header(response)
     render json: terms
   rescue Qa::ServiceUnavailable
@@ -59,10 +65,9 @@ class Qa::LinkedDataTermsController < ::ApplicationController
   # get "/show/linked_data/:vocab/:subauthority/:id
   # @see Qa::Authorities::LinkedData::FindTerm#find
   def show # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-    term = @authority.find(id, subauth: subauthority, language: language, replacements: replacement_params, jsonld: jsonld?, performance_data: performance_data?)
+    term = @authority.find(id, request_header: request_header_service.fetch_header)
     cors_allow_origin_header(response)
-    content_type = jsonld? ? 'application/ld+json' : 'application/json'
-    render json: term, content_type: content_type
+    render json: term, content_type: request_header_service.content_type_for_format
   rescue Qa::TermNotFound
     msg = "Term Not Found - Fetch term #{id} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
     logger.warn msg
@@ -90,10 +95,9 @@ class Qa::LinkedDataTermsController < ::ApplicationController
   # get "/fetch/linked_data/:vocab"
   # @see Qa::Authorities::LinkedData::FindTerm#find
   def fetch # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-    term = @authority.find(uri, subauth: subauthority, language: language, replacements: replacement_params, jsonld: jsonld?, performance_data: performance_data?)
+    term = @authority.find(uri, request_header: request_header_service.fetch_header)
     cors_allow_origin_header(response)
-    content_type = jsonld? ? 'application/ld+json' : 'application/json'
-    render json: term, content_type: content_type
+    render json: term, content_type: request_header_service.content_type_for_format
   rescue Qa::TermNotFound
     msg = "Term Not Found - Fetch term #{uri} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
     logger.warn msg
@@ -149,6 +153,10 @@ class Qa::LinkedDataTermsController < ::ApplicationController
       end
     end
 
+    def create_request_header_service
+      @request_header_service = request_header_service_class.new(request, params)
+    end
+
     def init_authority
       @authority = Qa::Authorities::LinkedData::GenericAuthority.new(vocab_param)
     rescue Qa::InvalidLinkedDataAuthority => e
@@ -192,47 +200,17 @@ class Qa::LinkedDataTermsController < ::ApplicationController
       params[:id]
     end
 
-    def language
-      request_language = request.env['HTTP_ACCEPT_LANGUAGE']
-      request_language = request_language.scan(/^[a-z]{2}/).first if request_language.present?
-      params[:lang] || request_language
-    end
-
     def subauthority
       params[:subauthority]
     end
 
-    def replacement_params
-      params.reject { |k, _v| ['q', 'vocab', 'controller', 'action', 'subauthority', 'lang', 'id'].include?(k) }
-    end
-
     def subauth_warn_msg
       subauthority.blank? ? "" : " sub-authority #{subauthority} in"
     end
 
-    def format
-      return 'json' unless params.key?(:format)
-      return 'json' if params[:format].blank?
-      params[:format]
-    end
-
-    def jsonld?
-      format.casecmp('jsonld').zero?
-    end
-
-    def context?
-      context = params.fetch(:context, 'false')
-      context.casecmp('true').zero?
-    end
-
     def details?
       details = params.fetch(:details, 'false')
-      details.casecmp('true').zero?
-    end
-
-    def performance_data?
-      performance_data = params.fetch(:performance_data, 'false')
-      performance_data.casecmp('true').zero?
+      details.casecmp?('true')
     end
 
     def validate_auth_reload_token

data/app/controllers/qa/terms_controller.rb

@@ -30,8 +30,7 @@ class Qa::TermsController < ::ApplicationController
   def show
     term = @authority.method(:find).arity == 2 ? @authority.find(params[:id], self) : @authority.find(params[:id])
     cors_allow_origin_header(response)
-    content_type = params["format"] == "jsonld" ? 'application/ld+json' : 'application/json'
-    render json: term, content_type: content_type
+    render json: term, content_type: content_type_for_format
   end
 
   def check_vocab_param
@@ -81,4 +80,29 @@ class Qa::TermsController < ::ApplicationController
     def url_search
       params[:q].gsub("*", "%2A")
     end
+
+    def format
+      return 'json' unless params.key?(:format)
+      return 'json' if params[:format].blank?
+      params[:format]
+    end
+
+    def jsonld?
+      format.casecmp?('jsonld')
+    end
+
+    def n3?
+      format.casecmp?('n3')
+    end
+
+    def ntriples?
+      format.casecmp?('ntriples')
+    end
+
+    def content_type_for_format
+      return 'application/ld+json' if jsonld?
+      return 'text/n3' if n3?
+      return 'application/n-triples' if ntriples?
+      'application/json'
+    end
 end

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

@@ -7,14 +7,17 @@ module Qa
         # @param action_config [Qa::Authorities::LinkedData::SearchConfig | Qa::Authorities::LinkedData::TermConfig] action configuration for the authority
         # @param action [Symbol] action with valid values :search or :term
         # @param action_request [String] the request the user is making of the authority (e.g. query text or term id/uri)
-        # @param substitutions [Hash] variable-value pairs to substitute into the URL template (optional)
-        # @param subauthority [String] name of a subauthority (optional)
-        # @param language [Array<Symbol>] languages for filtering returned literals (optional)
+        # @param request_header [Hash] optional attributes that can be appended to the generated URL
+        # @option replacements [Hash] variable-value pairs to substitute into the URL template
+        # @option subauthority [String] name of a subauthority
+        # @option language [Array<Symbol>] languages for filtering returned literals
         # @return a valid URL that submits the action request to the external authority
-        def build_url(action_config:, action:, action_request:, substitutions: {}, subauthority: nil, language: nil) # rubocop:disable Metrics/ParameterLists
+        # @note All parameters after request_header are deprecated and will be removed in the next major release.
+        def build_url(action_config:, action:, action_request:, request_header: {}, substitutions: {}, subauthority: nil, language: nil) # rubocop:disable Metrics/ParameterLists
+          request_header = build_request_header(substitutions, subauthority, language) if request_header.empty?
           action_validation(action)
           url_config = action_config.url_config
-          selected_substitutions = url_config.extract_substitutions(combined_substitutions(action_config, action, action_request, substitutions, subauthority, language))
+          selected_substitutions = url_config.extract_substitutions(combined_substitutions(action_config, action, action_request, request_header))
           Qa::IriTemplateService.build_url(url_config: url_config, substitutions: selected_substitutions)
         end
 
@@ -25,10 +28,12 @@ module Qa
             raise Qa::UnsupportedAction, "#{action} Not Supported - Action must be one of the supported actions (e.g. :term, :search)"
           end
 
-          def combined_substitutions(action_config, action, action_request, substitutions, subauthority, language) # rubocop:disable Metrics/ParameterLists
+          def combined_substitutions(action_config, action, action_request, request_header)
+            substitutions = request_header.fetch(:replacements, {})
             substitutions[action_request_variable(action_config, action)] = action_request
-            substitutions[action_subauth_variable(action_config)] = action_subauth_variable_value(action_config, subauthority) if supports_subauthorities?(action_config) && subauthority.present?
-            substitutions[action_language_variable(action_config)] = language_value(language) if supports_language_parameter?(action_config) && language.present?
+            substitutions[action_subauth_variable(action_config)] = action_subauth_variable_value(action_config, request_header)
+            substitutions[action_language_variable(action_config)] = language_value(action_config, request_header)
+            substitutions.reject { |_k, v| v.nil? }
             substitutions
           end
 
@@ -37,29 +42,38 @@ module Qa
             action_config.qa_replacement_patterns[key]
           end
 
-          def supports_subauthorities?(action_config)
-            action_config.supports_subauthorities?
-          end
-
           def action_subauth_variable(action_config)
             action_config.qa_replacement_patterns[:subauth]
           end
 
-          def action_subauth_variable_value(action_config, subauthority)
-            action_config.subauthorities[subauthority.to_sym]
-          end
-
-          def supports_language_parameter?(action_config)
-            action_config.supports_language_parameter?
+          def action_subauth_variable_value(action_config, request_header)
+            subauth = request_header.fetch(:subauthority, nil)
+            return nil unless subauth && action_config.supports_subauthorities?
+            action_config.subauthorities[subauth.to_sym]
           end
 
           def action_language_variable(action_config)
             action_config.qa_replacement_patterns[:lang]
           end
 
-          def language_value(language)
-            return nil if language.blank?
-            language.first
+          def language_value(action_config, request_header)
+            return nil unless action_config.supports_language_parameter?
+            request_header.fetch(:language, []).first
+          end
+
+          # This is providing support for calling build_url with individual parameters instead of the request_header.
+          # This is deprecated and will be removed in the next major release.
+          def build_request_header(substitutions, subauthority, language) # rubocop:disable Metrics/CyclomaticComplexity
+            return {} if substitutions.blank? && subauthority.blank? && language.blank?
+            Qa.deprecation_warning(
+              in_msg: 'Qa::LinkedData::AuthorityUrlService',
+              msg: "individual attributes for options (e.g. substitutions, subauthority, language) are deprecated; use request_header instead"
+            )
+            request_header = {}
+            request_header[:replacements] = substitutions unless substititions.blank?
+            request_header[:subauthority] = subauthority unless subauthority.blank?
+            request_header[:language] = language unless language.blank?
+            request_header
           end
       end
     end

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

@@ -106,12 +106,10 @@ module Qa
             end
           end
 
+          # process ioerror_code from RDF::Graph.load whether the code is in parentheses (i.e. "... (404)"), or not (i.e. "... 404")
           def ioerror_code(e)
             msg = e.message
-            return 'format' if msg.start_with? "Unknown RDF format"
-            a = msg.size - 4
-            z = msg.size - 2
-            msg[a..z]
+            msg[/(\(?)(\d\d\d)(\)?)$/, 2]
           end
       end
     end

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

@@ -0,0 +1,97 @@
+# Service to construct a request header that includes optional attributes for search and fetch requests.
+module Qa
+  module LinkedData
+    class RequestHeaderService
+      attr_reader :request, :params
+
+      # @param request [HttpRequest] request from controller
+      # @param params [Hash] attribute-value pairs holding the request parameters
+      # @option subauthority [String] the subauthority to query
+      # @option lang [Symbol] language used to select literals when multi-language is supported (e.g. :en, :fr, etc.)
+      # @option performance_data [Boolean] true if include_performance_data should be returned with the results; otherwise, false (default: false)
+      # @option context [Boolean] true if context should be returned with the results; otherwise, false (default: false) (search only)
+      # @option format [String] return data in this format (fetch only)
+      # @note params may have additional attribute-value pairs that are passed through via replacements (only configured replacements are used)
+      def initialize(request, params)
+        @request = request
+        @params = params
+      end
+
+      # Construct request parameters to pass to search_query (linked data module).
+      # @returns [Hash] parsed out attribute-value pairs that are required for the search query
+      # @see Qa::Authorities::LinkedData::SearchQuery
+      def search_header
+        header = {}
+        header[:subauthority] = params.fetch(:subauthority, nil)
+        header[:user_language] = user_language
+        header[:performance_data] = performance_data?
+        header[:context] = context?
+        header[:replacements] = replacements
+        header
+      end
+
+      # Construct request parameters to pass to fetching a term (linked data module).
+      # @returns [Hash] parsed out attribute-value pairs that are required for the term fetch.
+      # @see Qa::Authorities::LinkedData::FindTerm
+      def fetch_header
+        header = {}
+        header[:subauthority] = params.fetch(:subauthority, nil)
+        header[:user_language] = user_language
+        header[:performance_data] = performance_data?
+        header[:format] = format
+        header[:replacements] = replacements
+        header
+      end
+
+      # @returns [String] the response header content type based on requested format
+      def content_type_for_format
+        case format
+        when 'jsonld'
+          'application/ld+json'
+        when 'n3'
+          'text/n3'
+        when 'ntriples'
+          'application/n-triples'
+        else
+          'application/json'
+        end
+      end
+
+      private
+
+        # filter literals in results to this language
+        def user_language
+          request_language = request.env['HTTP_ACCEPT_LANGUAGE']
+          request_language = request_language.scan(/^[a-z]{2}/).first if request_language.present?
+          lang = params[:lang] || request_language
+          lang.present? ? Array(lang) : nil
+        end
+
+        # include extended context in the results if true (applies to search only)
+        def context?
+          context = params.fetch(:context, 'false')
+          context.casecmp?('true')
+        end
+
+        # include performance data in the results if true
+        def performance_data?
+          performance_data = params.fetch(:performance_data, 'false')
+          performance_data.casecmp?('true')
+        end
+
+        # any params not specifically handled are passed through via replacements
+        def replacements
+          params.reject do |k, _v|
+            ['q', 'vocab', 'controller', 'action', 'subauthority', 'lang', 'id',
+             'context', 'performance_data', 'response_header', 'format'].include?(k)
+          end
+        end
+
+        # results are returned in the format (applies to fetch only)
+        def format
+          f = params.fetch(:format, 'json').downcase
+          ['jsonld', 'n3', 'ntriples'].include?(f) ? f : 'json'
+        end
+    end
+  end
+end

data/lib/qa/authorities/discogs/discogs_instance_builder.rb

@@ -44,11 +44,12 @@ module Qa::Authorities
         count = 1
         return stmts unless response["identifiers"].present?
         response["identifiers"].each do |activity|
-          stmts << contruct_stmt_uri_object("Instance1", "http://id.loc.gov/ontologies/bibframe/identifiedBy", "Identifier#{count}")
-          stmts << contruct_stmt_uri_object("Identifier#{count}", rdf_type_predicate, "http://id.loc.gov/ontologies/bibframe/Identifier")
-          stmts << contruct_stmt_literal_object("Identifier#{count}", rdfs_label_predicate, activity["value"])
+          stmts << contruct_stmt_uri_object(instance_uri, "http://id.loc.gov/ontologies/bibframe/identifiedBy", "iidn#{count}")
+          stmts << contruct_stmt_uri_object("iidn#{count}", rdf_type_predicate, "http://id.loc.gov/ontologies/bibframe/Identifier")
+          stmts << contruct_stmt_literal_object("iidn#{count}", rdfs_label_predicate, activity["value"])
           count += 1
         end
+        stmts.concat(build_year_statements(response)) if response["released"].present?
         stmts # w/out this line, building the graph throws an undefined method `graph_name=' error
       end
 
@@ -64,7 +65,7 @@ module Qa::Authorities
           if df.present?
             stmts += build_format_characteristics(df, count)
           else
-            stmts << contruct_stmt_literal_object("Instance1", "http://id.loc.gov/ontologies/bibframe/editionStatement", desc)
+            stmts << contruct_stmt_literal_object(instance_uri, "http://id.loc.gov/ontologies/bibframe/editionStatement", desc)
           end
         end
         stmts
@@ -77,15 +78,13 @@ module Qa::Authorities
         stmts = []
         case df["type"]
         when "playbackChannel"
-          stmts << contruct_stmt_uri_object("Instance1", "http://id.loc.gov/ontologies/bibframe/soundCharacteristic", df["uri"])
+          stmts << contruct_stmt_uri_object(instance_uri, "http://id.loc.gov/ontologies/bibframe/soundCharacteristic", df["uri"])
           stmts << contruct_stmt_uri_object(df["uri"], rdf_type_predicate, "http://id.loc.gov/ontologies/bibframe/PlaybackChannel")
           stmts << contruct_stmt_literal_object(df["uri"], rdfs_label_predicate, df["label"])
         when "dimension"
-          stmts << contruct_stmt_uri_object("Instance1", "http://id.loc.gov/ontologies/bibframe/dimensions", df["label"])
+          stmts << contruct_stmt_literal_object(instance_uri, "http://id.loc.gov/ontologies/bibframe/dimensions", df["label"])
         when "playingSpeed"
-          stmts << contruct_stmt_uri_object("Instance1", "http://id.loc.gov/ontologies/bibframe/soundCharacteristic", "PlayingSpeed#{count}")
-          stmts << contruct_stmt_uri_object("PlayingSpeed#{count}", rdf_type_predicate, "http://id.loc.gov/ontologies/bibframe/PlayingSpeed")
-          stmts << contruct_stmt_literal_object("PlayingSpeed#{count}", rdfs_label_predicate, df["label"])
+          stmts.concat(build_playing_speed_stmts(df["label"], count))
         end
         stmts # w/out this line, building the graph throws an undefined method `graph_name=' error
       end
@@ -98,13 +97,13 @@ module Qa::Authorities
         return stmts unless name.present?
         dc = discogs_formats[name.gsub(/\s+/, "")]
         if dc.present?
-          stmts << contruct_stmt_uri_object("Instance1", "http://id.loc.gov/ontologies/bibframe/carrier", dc["uri"])
+          stmts << contruct_stmt_uri_object(instance_uri, "http://id.loc.gov/ontologies/bibframe/carrier", dc["uri"])
           stmts << contruct_stmt_uri_object(dc["uri"], rdf_type_predicate, "http://id.loc.gov/ontologies/bibframe/Carrier")
           stmts << contruct_stmt_literal_object(dc["uri"], rdfs_label_predicate, dc["label"])
           stmts.concat(build_base_materials(name))
         else
           # if it's not a carrier, it's an edition statement
-          stmts << contruct_stmt_literal_object("Instance1", "http://id.loc.gov/ontologies/bibframe/editionStatement", name)
+          stmts << contruct_stmt_literal_object(instance_uri, "http://id.loc.gov/ontologies/bibframe/editionStatement", name)
         end
         stmts # w/out this line, building the graph throws an undefined method `graph_name=' error
       end
@@ -116,7 +115,7 @@ module Qa::Authorities
         return stmts unless name == "Vinyl" || name == "Shellac"
         id = name == "Vinyl" ? "300014502" : "300014918"
 
-        stmts << contruct_stmt_uri_object("Instance1", "http://id.loc.gov/ontologies/bibframe/baseMaterial", "http://vocab.getty.edu/aat/" + id)
+        stmts << contruct_stmt_uri_object(instance_uri, "http://id.loc.gov/ontologies/bibframe/baseMaterial", "http://vocab.getty.edu/aat/" + id)
         stmts << contruct_stmt_uri_object("http://vocab.getty.edu/aat/" + id, rdf_type_predicate, "http://id.loc.gov/ontologies/bibframe/BaseMaterial")
         stmts << contruct_stmt_literal_object("http://vocab.getty.edu/aat/" + id, rdfs_label_predicate, name)
         stmts # w/out this line, building the graph throws an undefined method `graph_name=' error
@@ -129,13 +128,12 @@ module Qa::Authorities
         # need to distinguish among different provision activities and roles
         count = 1
         activities.each do |activity|
-          stmts << contruct_stmt_uri_object("Instance1", "http://id.loc.gov/ontologies/bibframe/provisionActivity", "ProvisionActivity#{count}")
-          stmts << contruct_stmt_uri_object("ProvisionActivity#{count}", rdf_type_predicate, "http://id.loc.gov/ontologies/bibframe/ProvisionActivity")
-          stmts << contruct_stmt_uri_object("ProvisionActivity#{count}", bf_agent_predicate, activity["name"])
-          stmts << contruct_stmt_uri_object(activity["name"], rdf_type_predicate, bf_agent_type_object)
-          stmts << contruct_stmt_uri_object(activity["name"], bf_role_predicate, "PA_Role#{count}")
-          stmts << contruct_stmt_uri_object("PA_Role#{count}", rdf_type_predicate, bf_role_type_object)
-          stmts << contruct_stmt_literal_object("PA_Role#{count}", rdfs_label_predicate, activity["entity_type_name"])
+          stmts << contruct_stmt_uri_object(instance_uri, "http://id.loc.gov/ontologies/bibframe/provisionActivity", "proact#{count}")
+          stmts << contruct_stmt_uri_object("proact#{count}", rdf_type_predicate, "http://id.loc.gov/ontologies/bibframe/ProvisionActivity")
+          stmts << contruct_stmt_uri_object("proact#{count}", bf_agent_predicate, "agentn3#{count}")
+          stmts << contruct_stmt_uri_object("agentn3#{count}", rdf_type_predicate, bf_agent_type_object)
+          stmts << contruct_stmt_literal_object("agentn3#{count}", rdfs_label_predicate, activity["name"])
+          stmts += build_role_stmts("agentn3#{count}", "role3#{count}", activity["entity_type_name"])
           count += 1
         end
         stmts # w/out this line, building the graph throws an undefined method `graph_name=' error