qa 2.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 975793a758ca32fe1b35d6f8301a7c418e57f0a4
-  data.tar.gz: 6559c2e07eac3ecb9e0312d703108cf4ac2e6d73
+  metadata.gz: 044adb0de6665c9ba6499467e7f91687ae42d0bf
+  data.tar.gz: 4e214ad816b495b55f3a7a9d2c9d305ac5ceef79
 SHA512:
-  metadata.gz: '08a4dfabf5896a359ededc1266bf3e3231b892816608638127c3b1be0b5287f85581fcdbdf67020c7092865c02c5a83ec70195c2264dbef39509c0d9a11a8b76'
-  data.tar.gz: 85e3c2a1be10878ab183f0561fb20ebb37e1b3e09754e313dcdab458cb274db6dfcd58a448d4f7fdd599ad15283eea0e640720557cff2f470b3400c886f26685
+  metadata.gz: 14c63d1a98211821bd3b2e935237140f4204d71572c8748e97d1fcdef5dd95c38e0fa6d6108839f242704c705fe232095b3a923ccce12d9d49c1a7bc7001eb76
+  data.tar.gz: ebd6d89c1eb12fb9119f9f24323df221bdfe33cbaae070290dd530612869eb83b23d2efa899577a302ad3bbc6223417623a7c3862b59e808cf7fde5f828200c9

data/README.md

@@ -1,8 +1,16 @@
 # Questioning Authority
 
-[![Build Status](https://travis-ci.org/samvera/questioning_authority.png?branch=master)](https://travis-ci.org/samvera/questioning_authority) [![Gem Version](https://badge.fury.io/rb/qa.png)](http://badge.fury.io/rb/qa)
+Code:
+[![Gem Version](https://badge.fury.io/rb/qa.png)](http://badge.fury.io/rb/qa)
+[![Build Status](https://travis-ci.org/samvera/questioning_authority.png?branch=master)](https://travis-ci.org/samvera/questioning_authority)
 [![Coverage Status](https://coveralls.io/repos/github/samvera/questioning_authority/badge.svg?branch=master)](https://coveralls.io/github/samvera/questioning_authority?branch=master)
 
+Docs:
+[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
+[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
+
+Jump In: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samvera.org/)
+
 You should question your authorities.
 
 ----
@@ -29,10 +37,12 @@ You should question your authorities.
       * [Add javascript to support autocomplete](#add-javascript-to-support-autocomplete)
   * [Developer Notes](#developer-notes)
     * [Compatibility](#compatibility)
+    * [Product Owner & Maintenance](#product-owner--maintenance)
+      * [Product Owner](#product-owner)
   * [Help](#help)
+  * [Acknowledgments](#acknowledgments)
 
 ----
-
 ## What does this do?
 
 Provides a set of uniform RESTful routes to query any controlled vocabulary or set of authority terms.
@@ -639,9 +649,26 @@ Commit your features into a new branch and submit a pull request.
 * Ruby 2.4 or the latest 2.3 version is recommended.  Later versions may also work.
 * Rails 5 is required. We recommend the latest Rails 5.0 release.
 
+## Product Owner & Maintenance
+
+Questioning Authority is a Core Component of the Samvera community. The documentation for
+what this means can be found
+[here](http://samvera.github.io/core_components.html#requirements-for-a-core-component).
+
+### Product Owner
+
+[elrayle](https://github.com/elrayle)
+
 # Help
 
-For help with Questioning Authority, contact <samvera-tech@googlegroups.com>.
+The Samvera community is here to help. Please see our [support guide](./SUPPORT.md).
+
+# Acknowledgments
+
+This software has been developed by and is brought to you by the Samvera community.  Learn more at the
+[Samvera website](http://samvera.org/).
+
+![Samvera Logo](https://wiki.duraspace.org/download/thumbnails/87459292/samvera-fall-font2-200w.png?version=1&modificationDate=1498550535816&api=v2)
 
 ### Special thanks to...
 

data/app/controllers/qa/application_controller.rb

@@ -1,4 +1,26 @@
 module Qa
   class ApplicationController < ActionController::Base
+    # Process the OPTIONS method for all routes
+    # @see route definitions in /config/routes.rb
+    # @note Reference: https://fetch.spec.whatwg.org/#http-access-control-allow-headers
+    def options
+      unless Qa.config.cors_headers?
+        head :not_implemented
+        return
+      end
+      response.headers['Access-Control-Allow-Origin'] = '*'
+      response.headers['Access-Control-Allow-Methods'] = 'GET, OPTIONS'
+      head :no_content
+    end
+
+    # Add cors headers to the passed in http response if cors_headers are enabled.  Called by all controller actions
+    # to adjust the response.
+    # @param http response
+    # @see /lib/generators/qa/install/templates/config/initializers/qa.rb
+    # @note The qa.rb initializer is copied to /config/initializers/qa.rb and can be modified to enable/disable cors headers.
+    # @note Reference: https://fetch.spec.whatwg.org/#http-access-control-allow-headers
+    def self.cors_allow_origin_header(response)
+      response.headers['Access-Control-Allow-Origin'] = '*' if Qa.config.cors_headers?
+    end
   end
 end

data/app/controllers/qa/linked_data_terms_controller.rb

@@ -1,11 +1,13 @@
 # This controller is used for all requests to linked data authorities. It will verify params and figure
 # out which linked data authority to query based on the 'vocab' param.
 
-class Qa::LinkedDataTermsController < ApplicationController
+class Qa::LinkedDataTermsController < ::ApplicationController
   before_action :check_authority, :init_authority
   before_action :check_search_subauthority, :check_query_param, only: :search
   before_action :check_show_subauthority, :check_id_param, only: :show
 
+  delegate :cors_allow_origin_header, to: Qa::ApplicationController
+
   # Provide a warning if there is a request for all terms.
   def index
     logger.warn 'Linked data authorities do not support retrieving all terms.'
@@ -14,7 +16,7 @@ class Qa::LinkedDataTermsController < ApplicationController
 
   # Return a list of terms based on a query
   # @see Qa::Authorities::LinkedData::SearchQuery#search
-  def search
+  def search # rubocop:disable Metrics/MethodLength
     begin
       terms = @authority.search(query, subauth: subauthority, language: language, replacements: replacement_params)
     rescue Qa::ServiceUnavailable
@@ -26,16 +28,18 @@ class Qa::LinkedDataTermsController < ApplicationController
       head :internal_server_error
       return
     rescue RDF::FormatError
-      logger.warn "RDF Format Error - Results from search query #{query} for#{subauth_warn_msg} authority #{vocab_param} was not identified as a valid RDF format.  You may need to include the linkeddata gem."
+      logger.warn "RDF Format Error - Results from search query #{query} for#{subauth_warn_msg} authority #{vocab_param} " \
+                  "was not identified as a valid RDF format.  You may need to include the linkeddata gem."
       head :internal_server_error
       return
     end
+    cors_allow_origin_header(response)
     render json: terms
   end
 
   # Return all the information for a given term
   # @see Qa::Authorities::LinkedData::FindTerm#find
-  def show
+  def show # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     begin
       term = @authority.find(id, subauth: subauthority, language: language, replacements: replacement_params)
     rescue Qa::TermNotFound
@@ -51,17 +55,19 @@ class Qa::LinkedDataTermsController < ApplicationController
       head :internal_server_error
       return
     rescue RDF::FormatError
-      logger.warn "RDF Format Error - Results from fetch term #{id} for#{subauth_warn_msg} authority #{vocab_param} was not identified as a valid RDF format.  You may need to include the linkeddata gem."
+      logger.warn "RDF Format Error - Results from fetch term #{id} for#{subauth_warn_msg} authority #{vocab_param} " \
+                  "was not identified as a valid RDF format.  You may need to include the linkeddata gem."
       head :internal_server_error
       return
     end
+    cors_allow_origin_header(response)
     render json: term
   end
 
   private
 
     def check_authority
-      if params[:vocab].nil? || !params[:vocab].size.positive?
+      if params[:vocab].nil? || !params[:vocab].size.positive? # rubocop:disable Style/GuardClause
         logger.warn "Required param 'vocab' is missing or empty"
         head :bad_request
       end
@@ -69,7 +75,7 @@ class Qa::LinkedDataTermsController < ApplicationController
 
     def check_search_subauthority
       return if subauthority.nil?
-      unless @authority.search_subauthority?(subauthority)
+      unless @authority.search_subauthority?(subauthority) # rubocop:disable Style/GuardClause
         logger.warn "Unable to initialize linked data search sub-authority '#{subauthority}' for authority '#{vocab_param}'"
         head :bad_request
       end
@@ -77,7 +83,7 @@ class Qa::LinkedDataTermsController < ApplicationController
 
     def check_show_subauthority
       return if subauthority.nil?
-      unless @authority.term_subauthority?(subauthority)
+      unless @authority.term_subauthority?(subauthority) # rubocop:disable Style/GuardClause
         logger.warn "Unable to initialize linked data term sub-authority '#{subauthority}' for authority '#{vocab_param}'"
         head :bad_request
       end
@@ -95,7 +101,7 @@ class Qa::LinkedDataTermsController < ApplicationController
     end
 
     def check_query_param
-      if params[:q].nil? || !params[:q].size.positive?
+      if params[:q].nil? || !params[:q].size.positive? # rubocop:disable Style/GuardClause
         logger.warn "Required search param 'q' is missing or empty"
         head :bad_request
       end
@@ -107,7 +113,7 @@ class Qa::LinkedDataTermsController < ApplicationController
     end
 
     def check_id_param
-      if params[:id].nil? || !params[:id].size.positive?
+      if params[:id].nil? || !params[:id].size.positive? # rubocop:disable Style/GuardClause
         logger.warn "Required show param 'id' is missing or empty"
         head :bad_request
       end

data/app/controllers/qa/terms_controller.rb

@@ -3,12 +3,15 @@
 # All the authority classes inherit from a super class so they implement the
 # same methods.
 
-class Qa::TermsController < ApplicationController
+class Qa::TermsController < ::ApplicationController
   before_action :check_vocab_param, :init_authority
   before_action :check_query_param, only: :search
 
+  delegate :cors_allow_origin_header, to: Qa::ApplicationController
+
   # If the subauthority supports it, return a list of all terms in the authority
   def index
+    cors_allow_origin_header(response)
     render json: begin
       @authority.all
     rescue NotImplementedError
@@ -19,12 +22,14 @@ class Qa::TermsController < ApplicationController
   # Return a list of terms based on a query
   def search
     terms = @authority.method(:search).arity == 2 ? @authority.search(url_search, self) : @authority.search(url_search)
+    cors_allow_origin_header(response)
     render json: terms
   end
 
   # If the subauthority supports it, return all the information for a given term
   def show
     term = @authority.find(params[:id])
+    cors_allow_origin_header(response)
     render json: term
   end
 
@@ -32,7 +37,7 @@ class Qa::TermsController < ApplicationController
     head :not_found unless params[:vocab].present?
   end
 
-  def init_authority
+  def init_authority # rubocop:disable Metrics/MethodLength
     begin
       mod = authority_class.camelize.constantize
     rescue NameError

data/app/models/qa/mesh_tree.rb

@@ -6,12 +6,8 @@ class Qa::MeshTree < ActiveRecord::Base
   end
 
   def eval_tree_path
-    trees = read_attribute(:eval_tree_path) || write_attribute(:eval_tree_path, "")
-    if trees
-      trees.split("|")
-    else
-      []
-    end
+    trees = self[:eval_tree_path] || (self[:eval_tree_path] = "")
+    trees ? trees.split("|") : []
   end
 
   def classify_tree
@@ -20,10 +16,10 @@ class Qa::MeshTree < ActiveRecord::Base
   end
 
   def classify_tree!
-    unless classify_tree.empty?
+    unless classify_tree.empty? # rubocop:disable Style/GuardClause
       tree_path = classify_tree.join('|')
-      puts "After Join #{tree_path.inspect}"
-      update_attribute(:eval_tree_path, tree_path)
+      Rails.logger.info "After Join #{tree_path.inspect}"
+      update_attribute(:eval_tree_path, tree_path) # rubocop:disable Rails/SkipsModelValidations # TODO: Explore how to avoid use of update_attribute.
     end
   end
 

data/app/models/qa/subject_mesh_term.rb

@@ -10,17 +10,12 @@ class Qa::SubjectMeshTerm < ActiveRecord::Base
   end
 
   def synonyms
-    s = read_attribute(:synonyms)
+    s = self[:synonyms]
     s.nil? ? [] : s.split("|")
   end
 
   def synonyms=(syn_list)
-    write_attribute(:synonyms,
-                    if syn_list.respond_to?(:join)
-                      syn_list.join('|')
-                    else
-                      syn_list
-                    end)
+    self[:synonyms] = syn_list.respond_to?(:join) ? syn_list.join('|') : syn_list
   end
 
   def parents

data/config/initializers/linked_data_authorities.rb

@@ -8,7 +8,7 @@ Dir[File.join(Qa::Engine.root, 'config', 'authorities', 'linked_data', '*.json')
 end
 
 # load app configured linked data authorities and overrides
-Dir[File.join(Rails.root, 'config', 'authorities', 'linked_data', '*.json')].each do |fn|
+Dir[Rails.root.join('config', 'authorities', 'linked_data', '*.json')].each do |fn|
   auth = File.basename(fn, '.json').upcase.to_sym
   json = File.read(File.expand_path(fn, __FILE__))
   cfg = JSON.parse(json).deep_symbolize_keys

data/config/routes.rb

@@ -6,4 +6,12 @@ Qa::Engine.routes.draw do
   get "/search/:vocab(/:subauthority)", controller: :terms, action: :search
   get "/show/:vocab/:id", controller: :terms, action: :show
   get "/show/:vocab/:subauthority/:id", controller: :terms, action: :show
+
+  match "/search/linked_data/:vocab(/:subauthority)", to: 'application#options', via: [:options]
+  match "/show/linked_data/:vocab/:id", to: 'application#options', via: [:options]
+  match "/show/linked_data/:vocab/:subauthority/:id", to: 'application#options', via: [:options]
+  match "/terms/:vocab(/:subauthority)",  to: 'application#options', via: [:options]
+  match "/search/:vocab(/:subauthority)", to: 'application#options', via: [:options]
+  match "/show/:vocab/:id", to: 'application#options', via: [:options]
+  match "/show/:vocab/:subauthority/:id", to: 'application#options', via: [:options]
 end

data/lib/generators/qa/install/install_generator.rb

@@ -7,6 +7,10 @@ class Qa::InstallGenerator < Rails::Generators::Base
     end
   end
 
+  def create_initializer_config_file
+    copy_file 'config/initializers/qa.rb'
+  end
+
   def copy_oclcts_configs
     copy_file "config/oclcts-authorities.yml", "config/oclcts-authorities.yml"
   end

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

@@ -0,0 +1,7 @@
+Qa.config do |config|
+  # When enabled, CORS headers will be added to the responses for search and show.  `OPTIONS` method will also be supported.
+  # Uncomment one of the lines below to enable or disable CORS headers.  This configuration defaults to disabled when not set.
+  # More information on CORS headers at: https://fetch.spec.whatwg.org/#cors-protocol
+  # config.enable_cors_headers
+  # config.disable_cors_headers
+end

data/lib/generators/qa/local/tables/mysql/mysql_generator.rb

@@ -5,7 +5,7 @@ module Qa::Local
       source_root File.expand_path('../templates', __FILE__)
       include ActiveRecord::Generators::Migration
 
-      def migrations
+      def migrations # rubocop:disable Metrics/MethodLength
         unless defined?(ActiveRecord::ConnectionAdapters::Mysql2Adapter) && ActiveRecord::Base.connection.instance_of?(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
           message = "Use the table based generator if you are not using mysql 'rails generate qa:local:tables'"
           say_status("error", message, :red)

data/lib/generators/qa/local/tables/tables_generator.rb

@@ -4,7 +4,7 @@ module Qa::Local
     source_root File.expand_path('../templates', __FILE__)
     include ActiveRecord::Generators::Migration
 
-    def migrations
+    def migrations # rubocop:disable Metrics/MethodLength
       if defined?(ActiveRecord::ConnectionAdapters::Mysql2Adapter) && ActiveRecord::Base.connection.instance_of?(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
         message = "Use the mysql table based generator if you are using mysql 'rails generate qa:local:tables:mysql'"
         say_status("error", message, :red)

data/lib/qa.rb

@@ -6,8 +6,24 @@ module Qa
   extend ActiveSupport::Autoload
 
   autoload :Authorities
+  autoload :Configuration
   autoload :Services
 
+  # @api public
+  #
+  # Exposes the Questioning Authority configuration
+  #
+  # @yield [Qa::Configuration] if a block is passed
+  # @return [Qa::Configuration]
+  # @see Qa::Configuration for configuration options
+  def self.config(&block)
+    @config ||= Qa::Configuration.new
+
+    yield @config if block
+
+    @config
+  end
+
   # Raised when the configuration directory for local authorities doesn't exist
   class ConfigDirectoryNotFound < StandardError; end
 

data/lib/qa/authorities/assign_fast_subauthority.rb

@@ -1,7 +1,7 @@
 # Encapsulate information about assignFAST subauthorities
 module Qa::Authorities::AssignFastSubauthority
   # Hash of subauthority names used in qa routes => 'index' used by API
-  Subauthorities = {
+  SUBAUTHORITIES = {
     'all'        => 'suggestall',
     'personal'   => 'suggest00',
     'corporate'  => 'suggest10',
@@ -16,7 +16,7 @@ module Qa::Authorities::AssignFastSubauthority
   #
   # @return [Array<String>]
   def subauthorities
-    Subauthorities.keys
+    SUBAUTHORITIES.keys
   end
 
   # Get an API index name from an English name
@@ -24,6 +24,6 @@ module Qa::Authorities::AssignFastSubauthority
   # @param [String] English name
   # @return [String] index name
   def index_for_authority(authority)
-    Subauthorities[authority]
+    SUBAUTHORITIES[authority]
   end
 end

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

@@ -16,7 +16,7 @@ module Qa::Authorities
     # Use a regex to exclude the continent and 'world' from the query
     # If only one word is entered only search the name (not the parent string)
     # If more than one word is entered, one word must appear in the name, and all words in either parent or name
-    def sparql(q)
+    def sparql(q) # rubocop:disable Metrics/MethodLength
       search = untaint(q)
       if search.include?(' ')
         ex = "(("

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

@@ -11,7 +11,7 @@ module Qa::Authorities
       "http://vocab.getty.edu/sparql.json?query=#{URI.escape(sparql(q)).gsub('&', '%26')}&_implicit=false&implicit=true&_equivalent=false&_form=%2Fsparql"
     end
 
-    def sparql(q)
+    def sparql(q) # rubocop:disable Metrics/MethodLength
       search = untaint(q)
       # if more than one term is supplied, check both preferred and alt labels
       if search.include?(' ')

data/lib/qa/authorities/linked_data/find_term.rb

@@ -76,7 +76,7 @@ module Qa::Authorities
           preds
         end
 
-        def consolidate_term_results(results)
+        def consolidate_term_results(results) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize # TODO: Explore a way to simplify
           consolidated_results = {}
           results.each do |statement|
             stmt_hash = statement.to_h
@@ -123,7 +123,7 @@ module Qa::Authorities
           json_results.first
         end
 
-        def predicates_with_subject_uri(graph, expected_uri)
+        def predicates_with_subject_uri(graph, expected_uri) # rubocop:disable Metrics/MethodLength
           predicates_hash = {}
           graph.statements.each do |st|
             subj = st.subject.to_s

data/lib/qa/authorities/linked_data/rdf_helper.rb

@@ -57,6 +57,10 @@ module Qa::Authorities
           msg[a..z]
         end
 
+        # Filter a graph to the specified languages
+        # @param [RDF::Graph] the graph to be filtered.
+        # @param [String | Symbol | Array<String|Symbol>] language for filtering graph (e.g. "en" or :en or ["en", "fr"] or [:en, :fr])
+        # @returns [RDF::Graph] graph of linked data filtered on the specified languages
         def filter_language(graph, language)
           language = normalize_language(language)
           return graph if language.nil?
@@ -66,6 +70,17 @@ module Qa::Authorities
           graph
         end
 
+        # Filter a graph to remove any statement with a blanknode for the subject
+        # @param [RDF::Graph] the graph to be filtered.
+        # @returns [RDF::Graph] graph of linked data with blanknodes removed
+        def filter_out_blanknodes(graph)
+          return graph if graph.subjects.blank?
+          graph.each do |st|
+            graph.delete(st) if st.subject.anonymous?
+          end
+          graph
+        end
+
         def normalize_language(language)
           language = [language.to_sym] if language.is_a? String
           language = [language] if language.is_a? Symbol