qa 2.0.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 15f2c24ef66af417831964088303e576bc6a41b2
-  data.tar.gz: d1f95c9f7f81a25052efb3fad0a9e9aec4dd94d8
+SHA256:
+  metadata.gz: '00029794cefd74912e6ae326330554bb59e3fa0733c5f0b62eae96aaedc397f1'
+  data.tar.gz: 325f45dd7d9e188f57da3c2667f677725a48a2b6e439b71839a15503d875fd0e
 SHA512:
-  metadata.gz: 4c37c298ea575d83360d160e4d5463077da86375cdb0596bf0ca0914e3f137febe7de56cf1eb014a8b740b380b4168018e6f356219b2d0ced6cb77c0a0c6616a
-  data.tar.gz: 0ab1fa42c0d0722fb8e455c3cca0de392561763f5535ce04afeaf9095941e91b271d882162f1d2edbdab15f1234a9b45dbe00a1c249a9b28765b0684a0bdd8bc
+  metadata.gz: 9784b68a0c26d296de87e9eaa617437fee2daa11789ac70d2212a2c364613073b15fef1f941ba670a56aff1c5400cf45bd0e7e50aad41c736703030b4402a62c
+  data.tar.gz: 7b4016ed6d919e1cd1497a0de4465695954fb552916d6d01c0aa833f7eabde71b7dcaa7391e6b076221c0e80285ed308affb7d1e60c064f0f57951415ddf0125

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.
@@ -303,7 +313,7 @@ This will create two tables/models Qa::LocalAuthority and Qa::LocalAuthorityEntr
                                    label: 'Uighur',
                                    uri: 'http://id.loc.gov/vocabulary/languages/uig')
 
-Unfortunately, Rails doesn't have a mechnism for adding functional indexes to tables, so if you have a lot of rows, you'll want to add an index:
+Unfortunately, Rails doesn't have a mechanism for adding functional indexes to tables, so if you have a lot of rows, you'll want to add an index:
 
     CREATE INDEX "index_qa_local_authority_entries_on_lower_label" ON
       "qa_local_authority_entries" (local_authority_id, lower(label))
@@ -330,7 +340,7 @@ The entire list (up to the first 1000 terms) can also be returned using:
 
 #### Loading RDF data into database tables
 
- You can use the Qa::Services::RDFAuthorityParser to import rdf files into yopur database tables.  See the class file, lib/qa/services/rdf_authority_parser.rb, for examples and more information.
+ You can use the Qa::Services::RDFAuthorityParser to import rdf files into your database tables.  See the class file, lib/qa/services/rdf_authority_parser.rb, for examples and more information.
  To run the class in your local project you must include `gem 'linkeddata'` into your Gemfile and `require 'linkeddata'` into an initializer or your application.rb
 
 ### Medical Subject Headings (MeSH)
@@ -348,7 +358,7 @@ Then, create the tables in your database
 
     rake db:migrate
 
-Now that you've setup your application to use MeSH terms, you'll now need to load the tems into your
+Now that you've setup your application to use MeSH terms, you'll now need to load the terms into your
 database so you can query them locally.
 
 To import the mesh terms into the local database, first download the MeSH descriptor dump in ASCII
@@ -385,6 +395,8 @@ gem 'rdf-rdfxml'
 
 #### Configuring a LOD Authority
 
+There are a number of authority configurations that are available.  See (ld4l-labs/linked_data_authorities)[https://github.com/ld4l-labs/linked_data_authorities] for configurations and instructions on how to use them.  These are updated periodically, so check back from time to time to see what's new.
+
 Access to LOD authorities can be configured.  Currently, a configuration exists in QA for OCLC Fast Linked Data, Library of
 Congress (terms only), and Agrovoc.  Look for configuration files in
 [/config/authorities/linked_data](https://github.com/samvera/questioning_authority/tree/master/config/authorities/linked_data).
@@ -613,7 +625,26 @@ NOTE: All predicates with the URI as the subject will be included under "predica
 
 See [Using with autocomplete in Sufia](https://github.com/samvera/questioning_authority/wiki/Using-with-autocomplete-in-Sufia) in the wiki documentation for QA.
 
+If you are using jQueryUI >= 1.8 you can use the [autocomplete function](http://api.jqueryui.com/autocomplete/), for example:
 
+```
+  $(function(){
+    $('#some_input').autocomplete({
+      source: function (request, response) {
+        $.ajax({
+          url: "/qa/search/loc/subjects?q=" + request.term,
+          type: 'GET',
+          dataType: 'json',
+          complete: function (xhr, status) {
+            var results = $.parseJSON(xhr.responseText);
+            response(results);
+          }
+        });
+      },
+      autoFocus: true
+    });
+  });
+```
 
 # Developer Notes
 
@@ -637,9 +668,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,28 @@
 module Qa
   class ApplicationController < ActionController::Base
+    skip_before_action :verify_authenticity_token, only: :options, raise: false
+
+    # 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,10 +1,14 @@
 # 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
-  before_action :check_authority, :init_authority
+class Qa::LinkedDataTermsController < ::ApplicationController
+  before_action :check_authority, :init_authority, except: [:list, :reload]
   before_action :check_search_subauthority, :check_query_param, only: :search
   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
+
+  delegate :cors_allow_origin_header, to: Qa::ApplicationController
 
   # Provide a warning if there is a request for all terms.
   def index
@@ -12,56 +16,91 @@ class Qa::LinkedDataTermsController < ApplicationController
     head :not_found
   end
 
+  # Return a list of supported authority names
+  # get "/list/linked_data/authorities"
+  # @see Qa::Authorities::LinkedData::AuthorityService#authority_names
+  def list
+    render json: Qa::Authorities::LinkedData::AuthorityService.authority_names.to_json
+  end
+
+  # Reload authority configurations
+  # get "/reload/linked_data/authorities?auth_token=YOUR_AUTH_TOKEN_DEFINED_HERE"
+  # @see Qa::Authorities::LinkedData::AuthorityService#load_authorities
+  def reload
+    Qa::Authorities::LinkedData::AuthorityService.load_authorities
+    list
+  end
+
   # Return a list of terms based on a query
+  # get "/search/linked_data/:vocab(/:subauthority)"
   # @see Qa::Authorities::LinkedData::SearchQuery#search
   def search
-    begin
-      terms = @authority.search(query, subauth: subauthority, language: language, replacements: replacement_params)
-    rescue Qa::ServiceUnavailable
-      logger.warn "Service Unavailable - Search query #{query} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
-      head :service_unavailable
-      return
-    rescue Qa::ServiceError
-      logger.warn "Internal Server Error - Search query #{query} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
-      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."
-      head :internal_server_error
-      return
-    end
+    terms = @authority.search(query, subauth: subauthority, language: language, replacements: replacement_params)
+    cors_allow_origin_header(response)
     render json: terms
+  rescue Qa::ServiceUnavailable
+    logger.warn "Service Unavailable - Search query #{query} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
+    head :service_unavailable
+  rescue Qa::ServiceError
+    logger.warn "Internal Server Error - Search query #{query} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
+    head :internal_server_error
+  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."
+    head :internal_server_error
   end
 
-  # Return all the information for a given term
+  # Return all the information for a given term given an id or URI
+  # get "/show/linked_data/:vocab/:id"
+  # get "/show/linked_data/:vocab/:subauthority/:id
   # @see Qa::Authorities::LinkedData::FindTerm#find
-  def show
-    begin
-      term = @authority.find(id, subauth: subauthority, language: language, replacements: replacement_params)
-    rescue Qa::TermNotFound
-      logger.warn "Term Not Found - Fetch term #{id} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
-      head :not_found
-      return
-    rescue Qa::ServiceUnavailable
-      logger.warn "Service Unavailable - Fetch term #{id} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
-      head :service_unavailable
-      return
-    rescue Qa::ServiceError
-      logger.warn "Internal Server Error - Fetch term #{id} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
-      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."
-      head :internal_server_error
-      return
-    end
-    render json: term
+  def show # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    term = @authority.find(id, subauth: subauthority, language: language, replacements: replacement_params, jsonld: jsonld?)
+    cors_allow_origin_header(response)
+    content_type = jsonld? ? 'application/ld+json' : 'application/json'
+    render json: term, content_type: content_type
+  rescue Qa::TermNotFound
+    logger.warn "Term Not Found - Fetch term #{id} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
+    head :not_found
+  rescue Qa::ServiceUnavailable
+    logger.warn "Service Unavailable - Fetch term #{id} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
+    head :service_unavailable
+  rescue Qa::ServiceError
+    logger.warn "Internal Server Error - Fetch term #{id} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
+    head :internal_server_error
+  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."
+    head :internal_server_error
+  end
+
+  # Return all the information for a given term given a URI
+  # 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?)
+    cors_allow_origin_header(response)
+    content_type = jsonld? ? 'application/ld+json' : 'application/json'
+    render json: term, content_type: content_type
+  rescue Qa::TermNotFound
+    logger.warn "Term Not Found - Fetch term #{uri} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
+    head :not_found
+  rescue Qa::ServiceUnavailable
+    logger.warn "Service Unavailable - Fetch term #{uri} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
+    head :service_unavailable
+  rescue Qa::ServiceError
+    logger.warn "Internal Server Error - Fetch term #{uri} unsuccessful for#{subauth_warn_msg} authority #{vocab_param}"
+    head :internal_server_error
+  rescue RDF::FormatError
+    logger.warn "RDF Format Error - Results from fetch term #{uri} 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
   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 +108,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 +116,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,10 +134,20 @@ class Qa::LinkedDataTermsController < ApplicationController
     end
 
     def check_query_param
-      if params[:q].nil? || !params[:q].size.positive?
-        logger.warn "Required search param 'q' is missing or empty"
-        head :bad_request
-      end
+      missing_required_param('search', 'q') if params[:q].blank?
+    end
+
+    def check_id_param
+      missing_required_param('show', 'id') if id.blank?
+    end
+
+    def check_uri_param
+      missing_required_param('fetch', 'uri') if uri.blank?
+    end
+
+    def missing_required_param(action_name, param_name)
+      logger.warn "Required #{action_name} param '#{param_name}' is missing or empty"
+      head :bad_request
     end
 
     # converts wildcards into URL-encoded characters
@@ -106,11 +155,8 @@ class Qa::LinkedDataTermsController < ApplicationController
       params[:q].gsub("*", "%2A")
     end
 
-    def check_id_param
-      if params[:id].nil? || !params[:id].size.positive?
-        logger.warn "Required show param 'id' is missing or empty"
-        head :bad_request
-      end
+    def uri
+      params[:uri]
     end
 
     def id
@@ -132,4 +178,23 @@ class Qa::LinkedDataTermsController < ApplicationController
     def subauth_warn_msg
       subauthority.nil? ? "" : " 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 == 'jsonld'
+    end
+
+    def validate_auth_reload_token
+      token = params.key?(:auth_token) ? params[:auth_token] : nil
+      valid = Qa.config.valid_authority_reload_token?(token)
+      return true if valid
+      logger.warn "FAIL: unable to reload authorities; error_msg: Invalid token (#{token}) does not match expected token."
+      head :unauthorized
+      false
+    end
 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