qa 2.1.1 → 3.1.0

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

@@ -44,7 +44,7 @@ module Qa::Authorities
       # Return the full configuration for an authority
       # @return [String] the authority configuration
       def auth_config
-        @authority_config ||= LINKED_DATA_AUTHORITIES_CONFIG[@authority_name]
+        @authority_config ||= Qa::Authorities::LinkedData::AuthorityService.authority_config(@authority_name)
         raise Qa::InvalidLinkedDataAuthority, "Unable to initialize linked data authority '#{@authority_name}'" if @authority_config.nil?
         @authority_config
       end

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

@@ -33,13 +33,14 @@ module Qa::Authorities
       #     "http://schema.org/name":["Cornell University","Ithaca (N.Y.). Cornell University"],
       #     "http://www.w3.org/2004/02/skos/core#altLabel":["Ithaca (N.Y.). Cornell University"],
       #     "http://schema.org/sameAs":["http://id.loc.gov/authorities/names/n79021621","https://viaf.org/viaf/126293486"] } }
-      def find(id, language: nil, replacements: {}, subauth: nil)
+      def find(id, language: nil, replacements: {}, subauth: nil, jsonld: false)
         raise Qa::InvalidLinkedDataAuthority, "Unable to initialize linked data term sub-authority #{subauth}" unless subauth.nil? || term_subauthority?(subauth)
         language ||= term_config.term_language
         url = term_config.term_url_with_replacements(id, subauth, replacements)
         Rails.logger.info "QA Linked Data term url: #{url}"
         graph = get_linked_data(url)
         return "{}" unless graph.size.positive?
+        return graph.dump(:jsonld, standard_prefixes: true) if jsonld
         parse_term_authority_response(id, graph, language)
       end
 

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

@@ -22,7 +22,13 @@ module Qa::Authorities
         @auth_config = Qa::Authorities::LinkedData::Config.new(auth_name)
       end
 
-      include WebServiceBase
+      def reload_authorities
+        @authorities_service.load_authorities
+      end
+
+      def authorities_service
+        @authorities_service ||= Qa::Authorities::LinkedData::AuthorityService
+      end
 
       def search_service
         @search_service ||= Qa::Authorities::LinkedData::SearchQuery.new(search_config)
@@ -34,6 +40,7 @@ module Qa::Authorities
 
       delegate :search, to: :search_service
       delegate :find, to: :item_service
+      delegate :load_authorities, :authority_names, to: :authorities_service
 
       private
 

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

@@ -26,7 +26,7 @@ module Qa::Authorities
     def build_query_url(q)
       escaped_query = URI.escape(q)
       authority_fragment = Loc.get_url_for_authority(subauthority) + URI.escape(subauthority)
-      "http://id.loc.gov/search/?q=#{escaped_query}&q=#{authority_fragment}&format=json"
+      "https://id.loc.gov/search/?q=#{escaped_query}&q=#{authority_fragment}&format=json"
     end
 
     def find(id)
@@ -34,7 +34,7 @@ module Qa::Authorities
     end
 
     def find_url(id)
-      "http://id.loc.gov/authorities/#{@subauthority}/#{id}.json"
+      "https://id.loc.gov/authorities/#{@subauthority}/#{id}.json"
     end
 
     private

data/lib/qa/configuration.rb

@@ -12,5 +12,23 @@ module Qa
     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.1.1".freeze
+  VERSION = "3.1.0".freeze
 end

data/spec/controllers/linked_data_terms_controller_spec.rb

@@ -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
@@ -195,30 +215,6 @@ describe Qa::LinkedDataTermsController, type: :controller do
         end
       end
     end
-
-    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*')
-            .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_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*')
-            .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_successful
-        end
-      end
-    end
   end
 
   describe '#show' do
@@ -287,9 +283,27 @@ describe Qa::LinkedDataTermsController, type: :controller do
           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 'succeeds' do
+        it 'succeeds and defaults to json content type' do
           get :show, params: { id: '530369', vocab: 'OCLC_FAST' }
           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: '530369', vocab: 'OCLC_FAST', 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: '530369', vocab: 'OCLC_FAST', 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
 
@@ -318,30 +332,156 @@ describe Qa::LinkedDataTermsController, type: :controller do
       end
     end
 
-    context 'in AGROVOC authority' do
+    context 'in LOC authority' do
       context 'term found' do
         before 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' })
+          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
-          get :show, params: { id: 'c_9513', vocab: 'AGROVOC' }
+        it 'succeeds and defaults to json content type' do
+          get :show, params: { id: 'sh85118553', vocab: 'LOC', subauthority: 'subjects' }
           expect(response).to be_successful
+          expect(response.content_type).to eq 'application/json'
         end
       end
     end
+  end
 
-    context 'in LOC authority' do
+  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://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' })
+          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' do
-          get :show, params: { id: 'sh85118553', vocab: 'LOC', subauthority: 'subjects' }
+
+        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

data/spec/controllers/terms_controller_spec.rb

@@ -78,7 +78,7 @@ describe Qa::TermsController, type: :controller do
 
     context "loc" do
       before do
-        stub_request(:get, "http://id.loc.gov/search/?format=json&q=Berry&q=cs:http://id.loc.gov/authorities/names")
+        stub_request(:get, "https://id.loc.gov/search/?format=json&q=Berry&q=cs:http://id.loc.gov/authorities/names")
           .with(headers: { 'Accept' => 'application/json' })
           .to_return(body: webmock_fixture("loc-names-response.txt"), status: 200)
       end
@@ -184,7 +184,7 @@ describe Qa::TermsController, type: :controller do
   describe "#show" do
     context "with supported authorities" do
       before do
-        stub_request(:get, "http://id.loc.gov/authorities/subjects/sh85077565.json")
+        stub_request(:get, "https://id.loc.gov/authorities/subjects/sh85077565.json")
           .with(headers: { 'Accept' => 'application/json' })
           .to_return(status: 200, body: webmock_fixture("loc-names-response.txt"), headers: {})
       end

data/spec/fixtures/authorities/linked_data/lod_term_uri_param_config.json

@@ -0,0 +1,27 @@
+{
+  "term": {
+    "url": {
+      "@context": "http://www.w3.org/ns/hydra/context.jsonld",
+      "@type":    "IriTemplate",
+      "template": "http://localhost/test_default/term?uri={?term_uri}",
+      "variableRepresentation": "BasicRepresentation",
+      "mapping": [
+        {
+          "@type":    "IriTemplateMapping",
+          "variable": "term_uri",
+          "property": "hydra:freetextQuery",
+          "required": true
+        }
+      ]
+    },
+    "qa_replacement_patterns": {
+      "term_id": "term_uri"
+    },
+    "term_id": "URI",
+    "results": {
+      "id_predicate":       "http://id.loc.gov/vocabulary/identifiers/lccn",
+      "label_predicate":    "http://www.w3.org/2004/02/skos/core#prefLabel"
+    }
+  },
+  "search": {}
+}

data/spec/lib/authorities/getty/aat_spec.rb

@@ -65,15 +65,20 @@ describe Qa::Authorities::Getty::AAT do
     subject { authority.request_options }
     it { is_expected.to eq(accept: "application/sparql-results+json") }
   end
-
+  # rubocop:disable Metrics/LineLength
   describe "#sparql" do
-    subject { authority.sparql('search_term') }
-    it {
-      is_expected.to eq 'SELECT ?s ?name {
-              ?s a skos:Concept; luc:term "search_term";
-                 skos:inScheme <http://vocab.getty.edu/aat/> ;
-                 gvp:prefLabelGVP [skosxl:literalForm ?name].
-              FILTER regex(?name, "search_term", "i") .
-            } ORDER BY ?name' }
+    context "using a single subject term" do
+      subject { authority.sparql('search_term') }
+      it {
+        is_expected.to eq %(SELECT ?s ?name { ?s a skos:Concept; luc:term "search_term"; skos:inScheme <http://vocab.getty.edu/aat/> ; gvp:prefLabelGVP [skosxl:literalForm ?name]. FILTER regex(?name, "search_term", "i") . } ORDER BY ?name)
+      }
+    end
+    context "using a two subject terms" do
+      subject { authority.sparql('search term') }
+      it {
+        is_expected.to eq %(SELECT ?s ?name { ?s a skos:Concept; luc:term "search term"; skos:inScheme <http://vocab.getty.edu/aat/> ; gvp:prefLabelGVP [skosxl:literalForm ?name]. FILTER ((regex(?name, "search", "i")) && (regex(?name, "term", "i"))) . } ORDER BY ?name)
+      }
+    end
   end
+  # rubocop:enable Metrics/LineLength
 end

data/spec/lib/authorities/getty/tgn_spec.rb

@@ -65,31 +65,20 @@ describe Qa::Authorities::Getty::TGN do
     subject { authority.request_options }
     it { is_expected.to eq(accept: "application/sparql-results+json") }
   end
-
+  # rubocop:disable Metrics/LineLength
   describe "#sparql" do
     context "using a single subject term" do
       subject { authority.sparql('search_term') }
       it {
-        is_expected.to eq 'SELECT DISTINCT ?s ?name ?par {
-              ?s a skos:Concept; luc:term "search_term";
-                 skos:inScheme <http://vocab.getty.edu/tgn/> ;
-                 gvp:prefLabelGVP [skosxl:literalForm ?name] ;
-                  gvp:parentString ?par .
-              FILTER regex(?name, "search_term", "i") .
-            } ORDER BY ?name ASC(?par)' }
+        is_expected.to eq %(SELECT DISTINCT ?s ?name ?par { ?s a skos:Concept; luc:term "search_term"; skos:inScheme <http://vocab.getty.edu/ulan/> ; gvp:prefLabelGVP [skosxl:literalForm ?name] ; gvp:parentString ?par . FILTER regex(?name, "search_term", "i") . } ORDER BY ?name ASC(?par))
+      }
     end
     context "using a two subject terms" do
       subject { authority.sparql('search term') }
-      # rubocop:disable Metrics/LineLength
       it {
-        is_expected.to eq "SELECT DISTINCT ?s ?name ?par {
-              ?s a skos:Concept; luc:term \"search term\";
-                 skos:inScheme <http://vocab.getty.edu/tgn/> ;
-                 gvp:prefLabelGVP [skosxl:literalForm ?name] ;
-                  gvp:parentString ?par .
-              FILTER ((regex(CONCAT(?name, ', ', REPLACE(str(?par), \",[^,]+,[^,]+$\", \"\")), \"search\",\"i\" ) && regex(CONCAT(?name, ', ', REPLACE(str(?par), \",[^,]+,[^,]+$\", \"\")), \"term\",\"i\" ) ) && (regex(?name, \"search\",\"i\" ) || regex(?name, \"term\",\"i\" ) ) ) .
-            } ORDER BY ?name ASC(?par)" }
-      # rubocop:enable Metrics/LineLength
+        is_expected.to eq %(SELECT DISTINCT ?s ?name ?par { ?s a skos:Concept; luc:term "search term"; skos:inScheme <http://vocab.getty.edu/ulan/> ; gvp:prefLabelGVP [skosxl:literalForm ?name] ; gvp:parentString ?par . FILTER ((regex(?name, "search", "i") || regex(?alt, "search", "i")) && (regex(?name, "term", "i") || regex(?alt, "term", "i"))) . } ORDER BY ?name ASC(?par))
+      }
     end
   end
+  # rubocop:enable Metrics/LineLength
 end