qa 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15f2c24ef66af417831964088303e576bc6a41b2
-  data.tar.gz: d1f95c9f7f81a25052efb3fad0a9e9aec4dd94d8
+  metadata.gz: 975793a758ca32fe1b35d6f8301a7c418e57f0a4
+  data.tar.gz: 6559c2e07eac3ecb9e0312d703108cf4ac2e6d73
 SHA512:
-  metadata.gz: 4c37c298ea575d83360d160e4d5463077da86375cdb0596bf0ca0914e3f137febe7de56cf1eb014a8b740b380b4168018e6f356219b2d0ced6cb77c0a0c6616a
-  data.tar.gz: 0ab1fa42c0d0722fb8e455c3cca0de392561763f5535ce04afeaf9095941e91b271d882162f1d2edbdab15f1234a9b45dbe00a1c249a9b28765b0684a0bdd8bc
+  metadata.gz: '08a4dfabf5896a359ededc1266bf3e3231b892816608638127c3b1be0b5287f85581fcdbdf67020c7092865c02c5a83ec70195c2264dbef39509c0d9a11a8b76'
+  data.tar.gz: 85e3c2a1be10878ab183f0561fb20ebb37e1b3e09754e313dcdab458cb274db6dfcd58a448d4f7fdd599ad15283eea0e640720557cff2f470b3400c886f26685

data/README.md

@@ -385,6 +385,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).

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

@@ -1,6 +1,7 @@
 require 'qa/authorities/linked_data/config/term_config'.freeze
 require 'qa/authorities/linked_data/config/search_config'.freeze
 require 'json'
+require 'erb'
 
 # Provide attr_reader methods for linked data authority configurations.  Some default configurations are provided for several
 # linked data authorities and can be found at /config/authorities/linked_data.  You can add configurations for new authorities by
@@ -17,6 +18,10 @@ require 'json'
 module Qa::Authorities
   module LinkedData
     class Config
+      class << self
+        include ERB::Util
+      end
+
       attr_reader :authority_name
       attr_reader :authority_config
 
@@ -56,7 +61,8 @@ module Qa::Authorities
         pred_uri
       end
 
-      def self.replace_pattern(url, pattern, value)
+      def self.replace_pattern(url, pattern, value, encode = false)
+        value = url_encode(value).gsub(".", "%2E") if encode
         url.gsub("{?#{pattern}}", value)
       end
 
@@ -71,7 +77,7 @@ module Qa::Authorities
         config.each do |param_key, rep_pattern|
           s_param_key = param_key.to_s
           value = replacements[param_key] || replacements[s_param_key] || rep_pattern[:default]
-          url = replace_pattern(url, param_key, value)
+          url = replace_pattern(url, param_key, value, rep_pattern[:encode])
         end
         url
       end

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

@@ -95,12 +95,26 @@ module Qa::Authorities
         search_config.fetch(:qa_replacement_patterns)
       end
 
+      # Should the replacement pattern be encoded?
+      # @return [Boolean] true, if the pattern should be encoded; otherwise, false
+      def qa_replacement_encoded?(pattern_key)
+        map_key = qa_replacement_patterns[pattern_key].to_sym
+        replacement_encoded? map_key
+      end
+
       # Are there replacement parameters configured for search query?
       # @return [True|False] true if there are replacement parameters configured for search query; otherwise, false
       def replacements?
         replacement_count.positive?
       end
 
+      # Should the replacement parameter be encoded?
+      # @return [True|False] true if the replacement parameter should be encoded; otherwise, false
+      def replacement_encoded?(map_key)
+        return false unless url_mappings[map_key].key? :encode
+        url_mappings[map_key][:encode]
+      end
+
       # Return the number of possible replacement values to make in the search URL
       # @return [Integer] the configured number of possible replacements in the search url
       def replacement_count
@@ -159,8 +173,8 @@ module Qa::Authorities
       # @return [String] the search encoded url
       def url_with_replacements(query, sub_auth = nil, search_replacements = {})
         return nil unless supports_search?
-        sub_auth = sub_auth.to_sym if sub_auth.is_a? String
-        url = Config.replace_pattern(url_template, qa_replacement_patterns[:query], query)
+        sub_auth = sub_auth.to_sym if sub_auth.present?
+        url = Config.replace_pattern(url_template, qa_replacement_patterns[:query], query, qa_replacement_encoded?(:query))
         url = Config.process_subauthority(url, subauthority_replacement_pattern, subauthorities, sub_auth) if subauthorities?
         url = Config.apply_replacements(url, replacements, search_replacements) if replacements?
         url

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

@@ -112,12 +112,26 @@ module Qa::Authorities
         Config.config_value(term_config, :qa_replacement_patterns)
       end
 
+      # Should the replacement pattern be encoded?
+      # @return [Boolean] true, if the pattern should be encoded; otherwise, false
+      def term_qa_replacement_encoded?(pattern_key)
+        map_key = term_qa_replacement_patterns[pattern_key].to_sym
+        term_replacement_encoded? map_key
+      end
+
       # Are there replacement parameters configured for term fetch?
-      # @return [True|False] true if there are replacement parameters configured for term fetch; otherwise, false
+      # @return [Boolean] true if there are replacement parameters configured for term fetch; otherwise, false
       def term_replacements?
         term_replacement_count.positive?
       end
 
+      # Should the replacement parameter be encoded?
+      # @return [Boolean] true if the replacement parameter should be encoded; otherwise, false
+      def term_replacement_encoded?(map_key)
+        return false unless term_url_mappings[map_key].key? :encode
+        term_url_mappings[map_key][:encode]
+      end
+
       # Return the number of possible replacement values to make in the term URL
       # @return [Integer] the configured number of possible replacements in the term url
       def term_replacement_count
@@ -129,7 +143,7 @@ module Qa::Authorities
       def term_replacements
         return @term_replacements unless @term_replacements.nil?
         @term_replacements = {}
-        @term_replacements = term_url_mappings.select { |k, _v| !term_qa_replacement_patterns.include?(k) } unless term_config.nil? || term_url_mappings.nil?
+        @term_replacements = term_url_mappings.select { |k, _v| !term_qa_replacement_patterns.value?(k.to_s) } unless term_config.nil? || term_url_mappings.nil?
         @term_replacements
       end
 
@@ -176,7 +190,7 @@ module Qa::Authorities
       def term_url_with_replacements(id, sub_auth = nil, replacements = {})
         return nil unless supports_term?
         sub_auth = sub_auth.to_sym if sub_auth.is_a? String
-        url = Config.replace_pattern(term_url_template, term_qa_replacement_patterns[:term_id], id)
+        url = Config.replace_pattern(term_url_template, term_qa_replacement_patterns[:term_id], id, term_qa_replacement_encoded?(:term_id))
         url = Config.process_subauthority(url, term_subauthority_replacement_pattern, term_subauthorities, sub_auth) if term_subauthorities?
         url = Config.apply_replacements(url, term_replacements, replacements) if term_replacements?
         url

data/lib/qa/version.rb

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

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

@@ -0,0 +1,91 @@
+{
+  "term": {
+    "url": {
+      "@context": "http://www.w3.org/ns/hydra/context.jsonld",
+      "@type":    "IriTemplate",
+      "template": "http://localhost/test_default/term?uri={?term_uri}&{?encode_true}&{?encode_false}&{?encode_not_specified}",
+      "variableRepresentation": "BasicRepresentation",
+      "mapping": [
+        {
+          "@type":    "IriTemplateMapping",
+          "variable": "term_uri",
+          "property": "hydra:freetextQuery",
+          "required": true,
+          "encode":   true
+        },
+        {
+          "@type":    "IriTemplateMapping",
+          "variable": "encode_true",
+          "property": "hydra:freetextQuery",
+          "required": true,
+          "encode":   true
+        },
+        {
+          "@type":    "IriTemplateMapping",
+          "variable": "encode_false",
+          "property": "hydra:freetextQuery",
+          "required": true,
+          "encode":   false
+        },
+        {
+          "@type":    "IriTemplateMapping",
+          "variable": "encode_not_specified",
+          "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": {
+    "url": {
+      "@context": "http://www.w3.org/ns/hydra/context.jsonld",
+      "@type":    "IriTemplate",
+      "template": "http://localhost/test_default/search?query={?query}&{?encode_true}&{?encode_false}&{?encode_not_specified}",
+      "variableRepresentation": "BasicRepresentation",
+      "mapping": [
+        {
+          "@type":    "IriTemplateMapping",
+          "variable": "query",
+          "property": "hydra:freetextQuery",
+          "required": true,
+          "encode":   true
+        },
+        {
+          "@type":    "IriTemplateMapping",
+          "variable": "encode_true",
+          "property": "hydra:freetextQuery",
+          "required": true,
+          "encode":   true
+        },
+        {
+          "@type":    "IriTemplateMapping",
+          "variable": "encode_false",
+          "property": "hydra:freetextQuery",
+          "required": true,
+          "encode":   false
+        },
+        {
+          "@type":    "IriTemplateMapping",
+          "variable": "encode_not_specified",
+          "property": "hydra:freetextQuery",
+          "required": true
+        }
+      ]
+    },
+    "qa_replacement_patterns": {
+      "query": "query"
+    },
+    "results": {
+      "id_predicate":       "http://purl.org/dc/terms/identifier",
+      "label_predicate":    "http://www.w3.org/2004/02/skos/core#prefLabel"
+    }
+  }
+}

data/spec/fixtures/authorities/linked_data/lod_term_id_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/{?term_id}",
+      "variableRepresentation": "BasicRepresentation",
+      "mapping": [
+        {
+          "@type":    "IriTemplateMapping",
+          "variable": "term_id",
+          "property": "hydra:freetextQuery",
+          "required": true
+        }
+      ]
+    },
+    "qa_replacement_patterns": {
+      "term_id": "term_id"
+    },
+    "term_id": "ID",
+    "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/linked_data/search_config_spec.rb

@@ -4,6 +4,7 @@ RSpec.describe Qa::Authorities::LinkedData::SearchConfig do
   let(:full_config) { Qa::Authorities::LinkedData::Config.new(:LOD_FULL_CONFIG).search }
   let(:min_config) { Qa::Authorities::LinkedData::Config.new(:LOD_MIN_CONFIG).search }
   let(:term_only_config) { Qa::Authorities::LinkedData::Config.new(:LOD_TERM_ONLY_CONFIG).search }
+  let(:encoding_config) { Qa::Authorities::LinkedData::Config.new(:LOD_ENCODING_CONFIG).search }
 
   describe '#search_config' do
     let(:full_search_config) do
@@ -381,5 +382,14 @@ RSpec.describe Qa::Authorities::LinkedData::SearchConfig do
         expect(min_config.url_with_replacements('Smith', nil, fake_replacement_key: 'fake_value')).to eq expected_url
       end
     end
+
+    context 'with encoding specified in config' do
+      it 'returns the uri as the url' do
+        expected_url = 'http://localhost/test_default/search?query=encoded%20because%3Aencode%3Dtrue&yes%3Aencoded%20here&no:encoding here&defaults:to not encoded'
+        query = 'encoded because:encode=true'
+        replacements = { encode_true: 'yes:encoded here', encode_false: 'no:encoding here', encode_not_specified: 'defaults:to not encoded' }
+        expect(encoding_config.url_with_replacements(query, nil, replacements)).to eq expected_url
+      end
+    end
   end
 end

data/spec/lib/authorities/linked_data/term_config_spec.rb

@@ -4,6 +4,7 @@ describe Qa::Authorities::LinkedData::TermConfig do
   let(:full_config) { Qa::Authorities::LinkedData::Config.new(:LOD_FULL_CONFIG).term }
   let(:min_config) { Qa::Authorities::LinkedData::Config.new(:LOD_MIN_CONFIG).term }
   let(:search_only_config) { Qa::Authorities::LinkedData::Config.new(:LOD_SEARCH_ONLY_CONFIG).term }
+  let(:encoding_config) { Qa::Authorities::LinkedData::Config.new(:LOD_ENCODING_CONFIG).term }
 
   describe '#term_config' do
     let(:full_term_config) do
@@ -415,5 +416,14 @@ describe Qa::Authorities::LinkedData::TermConfig do
         expect(min_config.term_url_with_replacements('C123', nil, fake_replacement_key: 'fake_value')).to eq expected_url
       end
     end
+
+    context 'with encoding specified in config' do
+      it 'returns the uri as the url' do
+        expected_url = 'http://localhost/test_default/term?uri=http%3A%2F%2Fencoded%2Ebecause%3Fencode%3Dtrue&yes%3Aencoded%20here&no:encoding here&defaults:to not encoded'
+        term_uri = 'http://encoded.because?encode=true'
+        replacements = { encode_true: 'yes:encoded here', encode_false: 'no:encoding here', encode_not_specified: 'defaults:to not encoded' }
+        expect(encoding_config.term_url_with_replacements(term_uri, nil, replacements)).to eq expected_url
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qa
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Stephen Anderson
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-05 00:00:00.000000000 Z
+date: 2018-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -354,6 +354,7 @@ files:
 - spec/fixtures/authorities/authority_B.yml
 - spec/fixtures/authorities/authority_C.yml
 - spec/fixtures/authorities/authority_D.yml
+- spec/fixtures/authorities/linked_data/lod_encoding_config.json
 - spec/fixtures/authorities/linked_data/lod_full_config.json
 - spec/fixtures/authorities/linked_data/lod_lang_defaults.json
 - spec/fixtures/authorities/linked_data/lod_lang_multi_defaults.json
@@ -362,6 +363,7 @@ files:
 - spec/fixtures/authorities/linked_data/lod_min_config.json
 - spec/fixtures/authorities/linked_data/lod_search_only_config.json
 - spec/fixtures/authorities/linked_data/lod_sort.json
+- spec/fixtures/authorities/linked_data/lod_term_id_param_config.json
 - spec/fixtures/authorities/linked_data/lod_term_only_config.json
 - spec/fixtures/funders-find-response.json
 - spec/fixtures/funders-noquery.json
@@ -458,7 +460,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: You should question your authorities.
@@ -474,6 +476,7 @@ test_files:
 - spec/fixtures/authorities/authority_B.yml
 - spec/fixtures/authorities/authority_C.yml
 - spec/fixtures/authorities/authority_D.yml
+- spec/fixtures/authorities/linked_data/lod_encoding_config.json
 - spec/fixtures/authorities/linked_data/lod_full_config.json
 - spec/fixtures/authorities/linked_data/lod_lang_defaults.json
 - spec/fixtures/authorities/linked_data/lod_lang_multi_defaults.json
@@ -482,6 +485,7 @@ test_files:
 - spec/fixtures/authorities/linked_data/lod_min_config.json
 - spec/fixtures/authorities/linked_data/lod_search_only_config.json
 - spec/fixtures/authorities/linked_data/lod_sort.json
+- spec/fixtures/authorities/linked_data/lod_term_id_param_config.json
 - spec/fixtures/authorities/linked_data/lod_term_only_config.json
 - spec/fixtures/funders-find-response.json
 - spec/fixtures/funders-noquery.json