qa 2.0.0 → 2.3.0

data/lib/qa/authorities/local/table_based_authority.rb

@@ -9,7 +9,8 @@ module Qa::Authorities
         @checked_for_index ||= begin
           conn = ActiveRecord::Base.connection
           if table_or_view_exists? && !conn.indexes(table_name).find { |i| i.name == table_index }
-            Rails.logger.error "You've installed local authority tables, but you haven't indexed the label.  Rails doesn't support functional indexes in migrations, so you'll have to add this manually:\n" \
+            Rails.logger.error "You've installed local authority tables, but you haven't indexed the label.  " \
+              "Rails doesn't support functional indexes in migrations, so you'll have to add this manually:\n" \
               "CREATE INDEX \"#{table_index}\" ON \"#{table_name}\" (local_authority_id, lower(label))\n" \
               "   OR on Sqlite: \n" \
               "CREATE INDEX \"#{table_index}\" ON \"#{table_name}\" (local_authority_id, label collate nocase)\n" \

data/lib/qa/authorities/mesh_tools/mesh_data_parser.rb

@@ -7,7 +7,7 @@ module Qa::Authorities
         @file = file
       end
 
-      def each_mesh_record
+      def each_mesh_record # rubocop:disable Metrics/MethodLength
         current_data = {}
         in_record = false
         file.each_line do |line|

data/lib/qa/authorities/mesh_tools/mesh_importer.rb

@@ -1,7 +1,7 @@
 module Qa::Authorities
   module MeshTools
     class MeshImporter
-      def import_from_file(f)
+      def import_from_file(f) # rubocop:disable Metrics/MethodLength
         entries = []
         trees = []
         mesh = Qa::Authorities::MeshTools::MeshDataParser.new(f)

data/lib/qa/authorities/oclcts/generic_oclc_authority.rb

@@ -27,9 +27,7 @@ module Qa::Authorities
         a = {}
         zthes_record = raw_response.xpath("sru:searchRetrieveResponse/sru:records/sru:record/sru:recordData/Zthes/term[termId='#{id}']", 'sru' => 'http://www.loc.gov/zing/srw/')
         zthes_record.children.each do |child|
-          if (child.is_a? Nokogiri::XML::Element) && !child.children.nil? && (child.children.size == 1) && (child.children.first.is_a? Nokogiri::XML::Text)
-            a[child.name] = child.children.first.to_s
-          end
+          a[child.name] = child.children.first.to_s if (child.is_a? Nokogiri::XML::Element) && !child.children.nil? && (child.children.size == 1) && (child.children.first.is_a? Nokogiri::XML::Text)
         end
         a
       end

data/lib/qa/configuration.rb

@@ -0,0 +1,34 @@
+module Qa
+  class Configuration
+    def cors_headers?
+      return @cors_headers_enabled unless @cors_headers_enabled.nil?
+      @cors_headers_enabled = false
+    end
+
+    def enable_cors_headers
+      @cors_headers_enabled = true
+    end
+
+    def disable_cors_headers
+      @cors_headers_enabled = false
+    end
+
+    # Provide a token that allows reloading of linked data authorities through the controller
+    # action '/reload/linked_data/authorities?auth_token=YOUR_AUTH_TOKEN_DEFINED_HERE' without
+    # requiring a restart of rails. By default, reloading through the browser is not allowed
+    # when the token is nil or blank.  Change to your approved token string in
+    # config/initializers/qa.rb.
+    attr_writer :authorized_reload_token
+    def authorized_reload_token
+      @authorized_reload_token ||= nil
+    end
+
+    def valid_authority_reload_token?(token)
+      return false if token.blank? || authorized_reload_token.blank?
+      token == authorized_reload_token
+    end
+
+    # Hold linked data authority configs
+    attr_accessor :linked_data_authority_configs
+  end
+end

data/lib/qa/version.rb

@@ -1,3 +1,3 @@
 module Qa
-  VERSION = "2.0.0".freeze
+  VERSION = "2.3.0".freeze
 end

data/lib/tasks/mesh.rake

@@ -2,11 +2,12 @@ require 'benchmark'
 
 namespace :mesh do
   desc "Import MeSH terms from the file $MESH_FILE, it will update any terms which are already in the database"
-  task :import => :environment do
+  # task :import => :environment do
+  task import: :environment do
     fname = ENV['MESH_FILE']
     if fname.nil?
       puts "Need to set $MESH_FILE with path to file to ingest"
-      next  # transfers control out of this block
+      next # transfers control out of this block
     end
     Benchmark.bm(30) do |bm|
       bm.report("Importing #{fname}") do
@@ -22,5 +23,4 @@ namespace :mesh do
   task :clear do
     puts "Not implemented"
   end
-
 end

data/spec/controllers/linked_data_terms_controller_spec.rb

@@ -6,13 +6,13 @@ describe Qa::LinkedDataTermsController, type: :controller do
   end
 
   describe '#check_authority' do
-    it 'returns 400 if the vocabulary is not specified' do
+    it 'for search returns 400 if the vocabulary is not specified' do
       expect(Rails.logger).to receive(:warn).with("Required param 'vocab' is missing or empty")
       get :search, params: { q: 'a query', vocab: '' }
       expect(response.code).to eq('400')
     end
 
-    it 'returns 400 if the vocabulary is not specified' do
+    it 'for show returns 400 if the vocabulary is not specified' do
       expect(Rails.logger).to receive(:warn).with("Required param 'vocab' is missing or empty")
       get :show, params: { id: 'C_1234', vocab: '' }
       expect(response.code).to eq('400')
@@ -61,6 +61,14 @@ describe Qa::LinkedDataTermsController, type: :controller do
     end
   end
 
+  describe '#check_uri_param' do
+    it 'returns 400 if the uri is missing' do
+      expect(Rails.logger).to receive(:warn).with("Required fetch param 'uri' is missing or empty")
+      get :fetch, params: { uri: '', vocab: 'OCLC_FAST' }
+      expect(response.code).to eq('400')
+    end
+  end
+
   describe '#init_authority' do
     context 'when the authority does not exist' do
       it 'returns 400' do
@@ -71,6 +79,18 @@ describe Qa::LinkedDataTermsController, type: :controller do
     end
   end
 
+  describe '#list' do
+    let(:expected_results) { ['Auth1', 'Auth2', 'Auth3'] }
+    before do
+      allow(Qa::Authorities::LinkedData::AuthorityService).to receive(:authority_names).and_return(expected_results)
+    end
+    it 'returns list of authorities' do
+      get :list
+      expect(response).to be_successful
+      expect(response.body).to eq expected_results.to_json
+    end
+  end
+
   describe '#search' do
     context 'producing internal server error' do
       context 'when server returns 500' do
@@ -92,7 +112,8 @@ describe Qa::LinkedDataTermsController, type: :controller do
           allow(RDF::Graph).to receive(:load).and_raise(RDF::FormatError)
         end
         it 'returns 500' do
-          expect(Rails.logger).to receive(:warn).with("RDF Format Error - Results from search query my_query for authority OCLC_FAST was not identified as a valid RDF format.  You may need to include the linkeddata gem.")
+          msg = "RDF Format Error - Results from search query my_query for authority OCLC_FAST was not identified as a valid RDF format.  You may need to include the linkeddata gem."
+          expect(Rails.logger).to receive(:warn).with(msg)
           get :search, params: { q: 'my_query', vocab: 'OCLC_FAST', maximumRecords: '3' }
           expect(response.code).to eq('500')
         end
@@ -122,6 +143,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
         expect(response.code).to eq('503')
       end
     end
+
     context 'in OCLC_FAST authority' do
       context '0 search results' do
         before do
@@ -130,7 +152,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
         end
         it 'succeeds' do
           get :search, params: { q: 'supercalifragilisticexpialidocious', vocab: 'OCLC_FAST', maximumRecords: '3' }
-          expect(response).to be_success
+          expect(response).to be_successful
         end
       end
 
@@ -141,7 +163,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
         end
         it 'succeeds' do
           get :search, params: { q: 'cornell', vocab: 'OCLC_FAST', maximumRecords: '3' }
-          expect(response).to be_success
+          expect(response).to be_successful
         end
       end
     end
@@ -154,7 +176,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
         end
         it 'succeeds' do
           get :search, params: { q: 'supercalifragilisticexpialidocious', vocab: 'OCLC_FAST', subauthority: 'personal_name', maximumRecords: '3' }
-          expect(response).to be_success
+          expect(response).to be_successful
         end
       end
 
@@ -165,7 +187,31 @@ describe Qa::LinkedDataTermsController, type: :controller do
         end
         it 'succeeds' do
           get :search, params: { q: 'cornell', vocab: 'OCLC_FAST', subauthority: 'personal_name', maximumRecords: '3' }
-          expect(response).to be_success
+          expect(response).to be_successful
+        end
+      end
+
+      context 'when cors headers are enabled' do
+        before do
+          Qa.config.enable_cors_headers
+          stub_request(:get, 'http://experimental.worldcat.org/fast/search?maximumRecords=3&query=oclc.personalName%20all%20%22cornell%22&sortKeys=usage')
+            .to_return(status: 200, body: webmock_fixture('lod_oclc_personalName_query_3_results.rdf.xml'), headers: { 'Content-Type' => 'application/rdf+xml' })
+        end
+        it 'Access-Control-Allow-Origin is *' do
+          get :search, params: { q: 'cornell', vocab: 'OCLC_FAST', subauthority: 'personal_name', maximumRecords: '3' }
+          expect(response.headers['Access-Control-Allow-Origin']).to eq '*'
+        end
+      end
+
+      context 'when cors headers are disabled' do
+        before do
+          Qa.config.disable_cors_headers
+          stub_request(:get, 'http://experimental.worldcat.org/fast/search?maximumRecords=3&query=oclc.personalName%20all%20%22cornell%22&sortKeys=usage')
+            .to_return(status: 200, body: webmock_fixture('lod_oclc_personalName_query_3_results.rdf.xml'), headers: { 'Content-Type' => 'application/rdf+xml' })
+        end
+        it 'Access-Control-Allow-Origin is not present' do
+          get :search, params: { q: 'cornell', vocab: 'OCLC_FAST', subauthority: 'personal_name', maximumRecords: '3' }
+          expect(response.headers.key?('Access-Control-Allow-Origin')).to be false
         end
       end
     end
@@ -173,23 +219,23 @@ describe Qa::LinkedDataTermsController, type: :controller do
     context 'in AGROVOC authority' do
       context '0 search results' do
         before do
-          stub_request(:get, 'http://artemide.art.uniroma2.it:8081/agrovoc/rest/v1/search/?lang=en&query=*supercalifragilisticexpialidocious*')
+          stub_request(:get, 'http://artemide.art.uniroma2.it:8081/agrovoc/rest/v1/search/?lang=en&query=*supercalifragilisticexpialidocious*&maxhits=20')
             .to_return(status: 200, body: webmock_fixture('lod_agrovoc_query_no_results.json'), headers: { 'Content-Type' => 'application/json' })
         end
         it 'succeeds' do
           get :search, params: { q: 'supercalifragilisticexpialidocious', vocab: 'AGROVOC' }
-          expect(response).to be_success
+          expect(response).to be_successful
         end
       end
 
       context '3 search results' do
         before do
-          stub_request(:get, 'http://artemide.art.uniroma2.it:8081/agrovoc/rest/v1/search/?lang=en&query=*milk*')
+          stub_request(:get, 'http://artemide.art.uniroma2.it:8081/agrovoc/rest/v1/search/?lang=en&query=*milk*&maxhits=20')
             .to_return(status: 200, body: webmock_fixture('lod_agrovoc_query_many_results.json'), headers: { 'Content-Type' => 'application/json' })
         end
         it 'succeeds' do
           get :search, params: { q: 'milk', vocab: 'AGROVOC' }
-          expect(response).to be_success
+          expect(response).to be_successful
         end
       end
     end
@@ -214,7 +260,8 @@ describe Qa::LinkedDataTermsController, type: :controller do
           allow(RDF::Graph).to receive(:load).and_raise(RDF::FormatError)
         end
         it 'returns 500' do
-          expect(Rails.logger).to receive(:warn).with("RDF Format Error - Results from fetch term 530369 for authority OCLC_FAST was not identified as a valid RDF format.  You may need to include the linkeddata gem.")
+          msg = "RDF Format Error - Results from fetch term 530369 for authority OCLC_FAST was not identified as a valid RDF format.  You may need to include the linkeddata gem."
+          expect(Rails.logger).to receive(:warn).with(msg)
           get :show, params: { id: '530369', vocab: 'OCLC_FAST' }
           expect(response.code).to eq('500')
         end
@@ -245,7 +292,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
 
     context 'when requested term is not found at the server' do
       before do
-        stub_request(:get, 'http://id.worldcat.org/fast/FAKE_ID').to_return(status: 404, body: '', headers:  {})
+        stub_request(:get, 'http://id.worldcat.org/fast/FAKE_ID').to_return(status: 404, body: '', headers: {})
       end
       it 'returns 404' do
         expect(Rails.logger).to receive(:warn).with('Term Not Found - Fetch term FAKE_ID unsuccessful for authority OCLC_FAST')
@@ -262,7 +309,31 @@ describe Qa::LinkedDataTermsController, type: :controller do
         end
         it 'succeeds' do
           get :show, params: { id: '530369', vocab: 'OCLC_FAST' }
-          expect(response).to be_success
+          expect(response).to be_successful
+        end
+      end
+
+      context 'when cors headers are enabled' do
+        before do
+          Qa.config.enable_cors_headers
+          stub_request(:get, 'http://id.worldcat.org/fast/530369')
+            .to_return(status: 200, body: webmock_fixture('lod_oclc_term_found.rdf.xml'), headers: { 'Content-Type' => 'application/rdf+xml' })
+        end
+        it 'Access-Control-Allow-Origin is *' do
+          get :show, params: { id: '530369', vocab: 'OCLC_FAST' }
+          expect(response.headers['Access-Control-Allow-Origin']).to eq '*'
+        end
+      end
+
+      context 'when cors headers are disabled' do
+        before do
+          Qa.config.disable_cors_headers
+          stub_request(:get, 'http://id.worldcat.org/fast/530369')
+            .to_return(status: 200, body: webmock_fixture('lod_oclc_term_found.rdf.xml'), headers: { 'Content-Type' => 'application/rdf+xml' })
+        end
+        it 'Access-Control-Allow-Origin is not present' do
+          get :show, params: { id: '530369', vocab: 'OCLC_FAST' }
+          expect(response.headers.key?('Access-Control-Allow-Origin')).to be false
         end
       end
     end
@@ -273,9 +344,28 @@ describe Qa::LinkedDataTermsController, type: :controller do
           stub_request(:get, 'http://artemide.art.uniroma2.it:8081/agrovoc/rest/v1/data?uri=http://aims.fao.org/aos/agrovoc/c_9513')
             .to_return(status: 200, body: webmock_fixture('lod_agrovoc_term_found.rdf.xml'), headers: { 'Content-Type' => 'application/rdf+xml' })
         end
-        it 'succeeds' do
+
+        it 'succeeds and defaults to json content type' do
           get :show, params: { id: 'c_9513', vocab: 'AGROVOC' }
-          expect(response).to be_success
+          expect(response).to be_successful
+          expect(response.content_type).to eq 'application/json'
+        end
+
+        context 'and it was requested as json' do
+          it 'succeeds and returns term data as json content type' do
+            get :show, params: { id: 'c_9513', vocab: 'AGROVOC', format: 'json' }
+            expect(response).to be_successful
+            expect(response.content_type).to eq 'application/json'
+          end
+        end
+
+        context 'and it was requested as jsonld' do
+          it 'succeeds and returns term data as jsonld content type' do
+            get :show, params: { id: 'c_9513', vocab: 'AGROVOC', format: 'jsonld' }
+            expect(response).to be_successful
+            expect(response.content_type).to eq 'application/ld+json'
+            expect(JSON.parse(response.body).keys).to match_array ["@context", "@graph"]
+          end
         end
       end
     end
@@ -286,11 +376,150 @@ describe Qa::LinkedDataTermsController, type: :controller do
           stub_request(:get, 'http://id.loc.gov/authorities/subjects/sh85118553')
             .to_return(status: 200, body: webmock_fixture('lod_loc_term_found.rdf.xml'), headers: { 'Content-Type' => 'application/rdf+xml' })
         end
-        it 'succeeds' do
+        it 'succeeds and defaults to json content type' do
           get :show, params: { id: 'sh85118553', vocab: 'LOC', subauthority: 'subjects' }
-          expect(response).to be_success
+          expect(response).to be_successful
+          expect(response.content_type).to eq 'application/json'
+        end
+      end
+    end
+  end
+
+  describe '#fetch' do
+    context 'producing internal server error' do
+      context 'when server returns 500' do
+        before do
+          stub_request(:get, 'http://localhost/test_default/term?uri=http://test.org/530369').to_return(status: 500)
+        end
+        it 'returns 500' do
+          expect(Rails.logger).to receive(:warn).with("Internal Server Error - Fetch term http://test.org/530369 unsuccessful for authority LOD_TERM_URI_PARAM_CONFIG")
+          get :fetch, params: { vocab: 'LOD_TERM_URI_PARAM_CONFIG', uri: 'http://test.org/530369' }
+          expect(response.code).to eq('500')
+        end
+      end
+
+      context 'when rdf format error' do
+        before do
+          stub_request(:get, 'http://localhost/test_default/term?uri=http://test.org/530369').to_return(status: 200)
+          allow(RDF::Graph).to receive(:load).and_raise(RDF::FormatError)
+        end
+        it 'returns 500' do
+          msg = "RDF Format Error - Results from fetch term http://test.org/530369 for authority LOD_TERM_URI_PARAM_CONFIG was not identified as a valid RDF format.  " \
+                "You may need to include the linkeddata gem."
+          expect(Rails.logger).to receive(:warn).with(msg)
+          get :fetch, params: { uri: 'http://test.org/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG' }
+          expect(response.code).to eq('500')
+        end
+      end
+
+      context "when error isn't specifically handled" do
+        before do
+          stub_request(:get, 'http://localhost/test_default/term?uri=http://test.org/530369').to_return(status: 501)
+        end
+        it 'returns 500' do
+          expect(Rails.logger).to receive(:warn).with("Internal Server Error - Fetch term http://test.org/530369 unsuccessful for authority LOD_TERM_URI_PARAM_CONFIG")
+          get :fetch, params: { uri: 'http://test.org/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG' }
+          expect(response.code).to eq('500')
         end
       end
     end
+
+    context 'when service unavailable' do
+      before do
+        stub_request(:get, 'http://localhost/test_default/term?uri=http://test.org/530369').to_return(status: 503)
+      end
+      it 'returns 503' do
+        expect(Rails.logger).to receive(:warn).with("Service Unavailable - Fetch term http://test.org/530369 unsuccessful for authority LOD_TERM_URI_PARAM_CONFIG")
+        get :fetch, params: { uri: 'http://test.org/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG' }
+        expect(response.code).to eq('503')
+      end
+    end
+
+    context 'when requested term is not found at the server' do
+      before do
+        stub_request(:get, 'http://localhost/test_default/term?uri=http://test.org/FAKE_ID').to_return(status: 404, body: '', headers: {})
+      end
+      it 'returns 404' do
+        expect(Rails.logger).to receive(:warn).with('Term Not Found - Fetch term http://test.org/FAKE_ID unsuccessful for authority LOD_TERM_URI_PARAM_CONFIG')
+        get :fetch, params: { uri: 'http://test.org/FAKE_ID', vocab: 'LOD_TERM_URI_PARAM_CONFIG' }
+        expect(response.code).to eq('404')
+      end
+    end
+
+    context 'in LOD_TERM_URI_PARAM_CONFIG authority' do
+      context 'term found' do
+        before do
+          stub_request(:get, 'http://localhost/test_default/term?uri=http://test.org/530369')
+            .to_return(status: 200, body: webmock_fixture('lod_oclc_term_found.rdf.xml'), headers: { 'Content-Type' => 'application/rdf+xml' })
+        end
+
+        it 'succeeds and defaults to json content type' do
+          get :fetch, params: { uri: 'http://test.org/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG' }
+          expect(response).to be_successful
+          expect(response.content_type).to eq 'application/json'
+        end
+
+        context 'and it was requested as json' do
+          it 'succeeds and returns term data as json content type' do
+            get :fetch, params: { uri: 'http://test.org/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG', format: 'json' }
+            expect(response).to be_successful
+            expect(response.content_type).to eq 'application/json'
+          end
+        end
+
+        context 'and it was requested as jsonld' do
+          it 'succeeds and returns term data as jsonld content type' do
+            get :fetch, params: { uri: 'http://test.org/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG', format: 'jsonld' }
+            expect(response).to be_successful
+            expect(response.content_type).to eq 'application/ld+json'
+            expect(JSON.parse(response.body).keys).to match_array ["@context", "@graph"]
+          end
+        end
+      end
+
+      context 'when cors headers are enabled' do
+        before do
+          Qa.config.enable_cors_headers
+          stub_request(:get, 'http://localhost/test_default/term?uri=http://test.org/530369')
+            .to_return(status: 200, body: webmock_fixture('lod_oclc_term_found.rdf.xml'), headers: { 'Content-Type' => 'application/rdf+xml' })
+        end
+        it 'Access-Control-Allow-Origin is *' do
+          get :fetch, params: { uri: 'http://test.org/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG' }
+          expect(response.headers['Access-Control-Allow-Origin']).to eq '*'
+        end
+      end
+
+      context 'when cors headers are disabled' do
+        before do
+          Qa.config.disable_cors_headers
+          stub_request(:get, 'http://localhost/test_default/term?uri=http://test.org/530369')
+            .to_return(status: 200, body: webmock_fixture('lod_oclc_term_found.rdf.xml'), headers: { 'Content-Type' => 'application/rdf+xml' })
+        end
+        it 'Access-Control-Allow-Origin is not present' do
+          get :fetch, params: { uri: 'http://test.org/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG' }
+          expect(response.headers.key?('Access-Control-Allow-Origin')).to be false
+        end
+      end
+    end
+  end
+
+  describe '#reload' do
+    before do
+      Qa.config.authorized_reload_token = 'A_TOKEN'
+    end
+
+    context 'when token does not match' do
+      it 'returns 401' do
+        get :reload, params: { auth_token: 'BAD_TOKEN' }
+        expect(response.code).to eq('401')
+      end
+    end
+
+    context 'when token does match' do
+      it 'returns 200' do
+        get :reload, params: { auth_token: 'A_TOKEN' }
+        expect(response.code).to eq('200')
+      end
+    end
   end
 end