qa 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc29035b13c98a73e85662eaeb115eabd0d12372
-  data.tar.gz: c509732acf8103e7587fcec0f1fd61824b6490ff
+  metadata.gz: 8158fccc9df38a91d74c1dbda277ce9308cf08c3
+  data.tar.gz: 28be737c24fc1cdd77fed1fc5da6216c68b675fd
 SHA512:
-  metadata.gz: 4dbb5d3904901814ad948f8d2f80bda6a1709ba4b84d65cde4746ffae13354255c4617825d88c58322bdb6d6345913ff034b25d658734ef56740d737c75d40b1
-  data.tar.gz: f4d641ec0744de995d7358c304220a39a4d0a37de684a66c1d9e2cdd3561ba5b5bf8d411f92148f09bfb1d756cf1d06f7478dda1ab86c39fc9f88201c480c939
+  metadata.gz: d8e1fdedaa020bf6ffcac6bf1248729439d758be0966bb397aeaf05c54c681fd0f4f5e5c061e9b5ece5f8b8c9dc0494c6d1c9091c2f691e185256cb1cc42ec18
+  data.tar.gz: 49e4402ab1422fee3e78cc7fdf485175144642b26fc6697a64873877fbbdc6095ad011881e8c42a35c9fb21c5704a056443f0ce6bc7e26c14494c958007d6434

data/app/services/qa/linked_data/performance_data_service.rb

@@ -10,7 +10,9 @@ module Qa
       # @returns [Hash] performance data
       # @see Qa::Authorities::LinkedData::SearchQuery
       # @see Qa::Authorities::LinkedData::FindTerm
-      def self.performance_data(access_time_s:, normalize_time_s:, fetched_size:, normalized_size:)
+      def self.performance_data(access_time_s:, normalize_time_s:, fetched_data_graph:, normalized_data:)
+        normalized_size = normalized_data.to_s.size
+        fetched_size = fetched_data_graph.triples.to_s.size
         {
           fetch_time_s: access_time_s,
           normalization_time_s: normalize_time_s,

data/app/services/qa/linked_data/request_header_service.rb

@@ -10,6 +10,7 @@ module Qa
       # @option lang [Symbol] language used to select literals when multi-language is supported (e.g. :en, :fr, etc.)
       # @option performance_data [Boolean] true if include_performance_data should be returned with the results; otherwise, false (default: false)
       # @option context [Boolean] true if context should be returned with the results; otherwise, false (default: false) (search only)
+      # @option response_header [Boolean] true if a summary response header should be returned with the results; otherwise, false (default: false) (search only)
       # @option format [String] return data in this format (fetch only)
       # @note params may have additional attribute-value pairs that are passed through via replacements (only configured replacements are used)
       def initialize(request:, params:)
@@ -26,6 +27,7 @@ module Qa
         header[:user_language] = user_language
         header[:performance_data] = performance_data?
         header[:context] = context?
+        header[:response_header] = response_header?
         header[:replacements] = replacements
         header
       end
@@ -39,6 +41,7 @@ module Qa
         header[:user_language] = user_language
         header[:performance_data] = performance_data?
         header[:format] = format
+        header[:response_header] = response_header?
         header[:replacements] = replacements
         header
       end
@@ -79,6 +82,12 @@ module Qa
           performance_data.casecmp?('true')
         end
 
+        # include summary response header in the results if true
+        def response_header?
+          response_header = params.fetch(:response_header, 'false')
+          response_header.casecmp?('true')
+        end
+
         # any params not specifically handled are passed through via replacements
         def replacements
           params.reject do |k, _v|

data/app/services/qa/linked_data/response_header_service.rb

@@ -0,0 +1,78 @@
+# Service to construct a request header that includes optional attributes for search and fetch requests.
+module Qa
+  module LinkedData
+    class ResponseHeaderService
+      class_attribute :ldpath_service
+      self.ldpath_service = Qa::LinkedData::LdpathService
+
+      attr_reader :request_header, :results, :config, :graph
+
+      # @param request_header [Hash] request attributes constructed by Qa::LinkedData::RequestHeaderService
+      # @param results [String, JSON] results generated by executing a request
+      # @param config [String] authority configuration identifying where in the results or request_header data can be found
+      # @param graph [RDF::Graph] graph holding results
+      def initialize(request_header:, results:, config:, graph:)
+        @request_header = request_header
+        @results = results
+        @config = config
+        @graph = graph
+      end
+
+      # Construct response header to pass back with search results (linked data module).
+      # @returns [Hash] response data
+      # @see Qa::Authorities::LinkedData::SearchQuery
+      def search_header
+        header = {}
+        header[:start_record] = start_record
+        header[:requested_records] = requested_records
+        header[:retrieved_records] = retrieved_records
+        header[:total_records] = total_record_count
+        header
+      end
+
+      # Construct response header to pass back with fetch results (linked data module).
+      # @returns [Hash] response data
+      # @see Qa::Authorities::LinkedData::FetchTerm
+      def fetch_header
+        header = {}
+        header[:predicate_count] = pred_count
+        header
+      end
+
+      private
+
+        # determine the position of the first record in the returned results relative to all search results
+        def start_record
+          request_header.fetch(:replacements, {}).fetch(config.start_record_parameter, 1).to_i
+        end
+
+        # determine the number of requested records
+        def requested_records
+          num = request_header.fetch(:replacements, {}).fetch(config.requested_records_parameter, nil)
+          num.present? ? num.to_i : I18n.t("qa.linked_data.search.default_requested_records")
+        end
+
+        # determine the number of records actually returned
+        def retrieved_records
+          results.count
+        end
+
+        # determine the full number of records matching the search query
+        def total_record_count
+          ldpath = config.total_count_ldpath
+          service_uri = RDF::URI.new(config.service_uri)
+          return I18n.t("qa.linked_data.search.total_not_reported") unless ldpath && service_uri
+          prefixes = config.prefixes
+          ldpath_program = ldpath_service.ldpath_program(ldpath: ldpath, prefixes: prefixes)
+          values = ldpath_service.ldpath_evaluate(program: ldpath_program, graph: graph, subject_uri: service_uri)
+          values.map!(&:to_i)
+          values.first || I18n.t("qa.linked_data.search.total_not_reported")
+        end
+
+        # determine how many predicates are directly used with the requested term
+        def pred_count
+          results['predicates'].present? ? results['predicates'].size : 0
+        end
+    end
+  end
+end

data/config/locales/qa.en.yml

@@ -7,3 +7,6 @@ en:
         evaluate_logger_error: LDPath failed to evaluate the graph with the provided ldpath.
         parse_error: LDPATH PARSE ERROR (See log for more information)
         parse_logger_error: LDPath failed to parse during ldpath program creation.
+      search:
+        total_not_reported: NOT REPORTED
+        default_requested_records: DEFAULT

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

@@ -95,6 +95,7 @@ module Qa::Authorities
           @subauthority = request_header.fetch(:subauthority, nil)
           @format = request_header.fetch(:format, 'json')
           @performance_data = request_header.fetch(:performance_data, false)
+          @response_header = request_header.fetch(:response_header, false)
           @language = language_service.preferred_language(user_language: request_header.fetch(:user_language, nil),
                                                           authority_language: term_config.term_language)
           request_header[:language] = Array(@language)
@@ -213,6 +214,10 @@ module Qa::Authorities
           @performance_data == true && !jsonld?
         end
 
+        def response_header?
+          @response_header == true
+        end
+
         def preds_for_term
           label_pred_uri = term_config.term_results_label_predicate(suppress_deprecation_warning: true)
           return {} if label_pred_uri.blank?
@@ -282,19 +287,21 @@ module Qa::Authorities
         end
 
         def append_data_outside_results(results)
-          return results unless performance_data?
+          return results unless performance_data? || response_header?
           full_results = {}
           full_results[:results] = results
-          full_results[:performance] = performance(results)
+          full_results[:performance] = performance(results) if performance_data?
+          full_results[:response_header] = response_header(results) if response_header?
           full_results
         end
 
         def performance(results)
-          normalized_size = results.to_s.size
-          fetched_size = full_graph.triples.to_s.size
-          perf_data = Qa::LinkedData::PerformanceDataService.performance_data(access_time_s: access_time_s, normalize_time_s: normalize_time_s,
-                                                                              fetched_size: fetched_size, normalized_size: normalized_size)
-          perf_data
+          Qa::LinkedData::PerformanceDataService.performance_data(access_time_s: access_time_s, normalize_time_s: normalize_time_s,
+                                                                  fetched_data_graph: full_graph, normalized_data: results)
+        end
+
+        def response_header(results)
+          Qa::LinkedData::ResponseHeaderService.new(results: results, request_header: request_header, config: term_config, graph: full_graph).fetch_header
         end
 
         # This is providing support for calling build_url with individual parameters instead of the request_header.

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

@@ -94,6 +94,7 @@ module Qa::Authorities
           @subauthority = request_header.fetch(:subauthority, nil)
           @context = request_header.fetch(:context, false)
           @performance_data = request_header.fetch(:performance_data, false)
+          @response_header = request_header.fetch(:response_header, false)
           @language = language_service.preferred_language(user_language: request_header.fetch(:user_language, nil),
                                                           authority_language: search_config.language)
           request_header[:language] = Array(@language)
@@ -111,6 +112,10 @@ module Qa::Authorities
           @performance_data == true
         end
 
+        def response_header?
+          @response_header == true
+        end
+
         def ldpaths_for_search
           label_ldpath = search_config.results_label_ldpath
           return {} if label_ldpath.blank?
@@ -179,18 +184,21 @@ module Qa::Authorities
         end
 
         def append_data_outside_results(results)
-          return results unless performance_data?
+          return results unless performance_data? || response_header?
           full_results = {}
           full_results[:results] = results
-          full_results[:performance] = performance(results)
+          full_results[:performance] = performance(results) if performance_data?
+          full_results[:response_header] = response_header(results) if response_header?
           full_results
         end
 
         def performance(results)
-          normalized_size = results.to_s.size
-          fetched_size = full_graph.triples.to_s.size
           Qa::LinkedData::PerformanceDataService.performance_data(access_time_s: access_time_s, normalize_time_s: normalize_time_s,
-                                                                  fetched_size: fetched_size, normalized_size: normalized_size)
+                                                                  fetched_data_graph: full_graph, normalized_data: results)
+        end
+
+        def response_header(results)
+          Qa::LinkedData::ResponseHeaderService.new(results: results, request_header: request_header, config: search_config, graph: full_graph).search_header
         end
 
         # This is providing support for calling build_url with individual parameters instead of the request_header.

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

@@ -21,7 +21,7 @@ module Qa
 
         def self.index_name_exists?
           conn = ActiveRecord::Base.connection
-          if ActiveRecord::VERSION::MAJOR >= 5 && ActiveRecord::VERSION::MINOR >= 1
+          if (ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR >= 1) || ActiveRecord::VERSION::MAJOR >= 6
             conn.index_name_exists?(table_name, table_index).blank?
           else
             conn.index_name_exists?(table_name, table_index, :default).blank?

data/lib/qa/version.rb

@@ -1,3 +1,3 @@
 module Qa
-  VERSION = "5.0.0".freeze
+  VERSION = "5.1.0".freeze
 end

data/spec/controllers/linked_data_terms_controller_spec.rb

@@ -320,6 +320,32 @@ describe Qa::LinkedDataTermsController, type: :controller do
         expect(results).to be_kind_of Array
       end
     end
+
+    context 'when requesting response header' do
+      before do
+        Qa.config.disable_cors_headers
+        stub_request(:get, 'http://experimental.worldcat.org/fast/search?maximumRecords=3&query=cql.any%20all%20%22cornell%22&sortKeys=usage')
+          .to_return(status: 200, body: webmock_fixture('lod_oclc_all_query_3_results.rdf.xml'), headers: { 'Content-Type' => 'application/rdf+xml' })
+      end
+      it "returns basic data + response header when response_header='true'" do
+        get :search, params: { q: 'cornell', vocab: 'OCLC_FAST', maximumRecords: '3', response_header: 'true' }
+        expect(response).to be_successful
+        results = JSON.parse(response.body)
+        expect(results).to be_kind_of Hash
+        expect(results.keys).to match_array ['response_header', 'results']
+        expect(results['response_header'].keys).to match_array ['start_record', 'requested_records', 'retrieved_records', 'total_records']
+        expect(results['response_header']['retrieved_records']).to eq 3
+        expect(results['results'].count).to eq 3
+      end
+
+      it "returns basic data only when response_header='false'" do
+        get :search, params: { q: 'cornell', vocab: 'OCLC_FAST', maximumRecords: '3', response_header: 'false' }
+        expect(response).to be_successful
+        results = JSON.parse(response.body)
+        expect(results).to be_kind_of Array
+        expect(results.size).to eq 3
+      end
+    end
   end
 
   describe '#show' do
@@ -403,14 +429,14 @@ describe Qa::LinkedDataTermsController, type: :controller 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'
+          expect(response.media_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'
+            expect(response.media_type).to eq 'application/json'
           end
         end
 
@@ -418,7 +444,7 @@ describe Qa::LinkedDataTermsController, type: :controller 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(response.media_type).to eq 'application/ld+json'
             expect(JSON.parse(response.body).keys).to match_array ["@context", "@graph"]
           end
         end
@@ -427,7 +453,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
           it 'succeeds and returns term data as n3 content type' do
             get :show, params: { id: '530369', vocab: 'OCLC_FAST', format: 'n3' }
             expect(response).to be_successful
-            expect(response.content_type).to eq 'text/n3'
+            expect(response.media_type).to eq 'text/n3'
             expect(response.body).to start_with "@prefix"
           end
         end
@@ -436,7 +462,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
           it 'succeeds and returns term data as ntriples content type' do
             get :show, params: { id: '530369', vocab: 'OCLC_FAST', format: 'ntriples' }
             expect(response).to be_successful
-            expect(response.content_type).to eq 'application/n-triples'
+            expect(response.media_type).to eq 'application/n-triples'
             expect(response.body).to include('<http://id.worldcat.org/fast/530369> <http://www.w3.org/2004/02/skos/core#prefLabel> "Cornell University"')
           end
         end
@@ -476,7 +502,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
         it 'succeeds and defaults to json content type' do
           get :show, params: { id: 'sh 85118553', vocab: 'LOC', subauthority: 'subjects' }
           expect(response).to be_successful
-          expect(response.content_type).to eq 'application/json'
+          expect(response.media_type).to eq 'application/json'
         end
       end
     end
@@ -505,6 +531,32 @@ describe Qa::LinkedDataTermsController, type: :controller do
         expect(results.keys).not_to include('performance')
       end
     end
+
+    context 'when requesting response header' 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' })
+      end
+      it "returns basic data + response header when response_header='true'" do
+        get :show, params: { id: 'sh 85118553', vocab: 'LOC', subauthority: 'subjects', response_header: 'true' }
+        expect(response).to be_successful
+        results = JSON.parse(response.body)
+        expect(results).to be_kind_of Hash
+        expect(results.keys).to match_array ['response_header', 'results']
+        expect(results['response_header'].keys).to match_array ['predicate_count']
+        expect(results['response_header']['predicate_count']).to eq 15
+        expect(results['results']['predicates'].count).to eq 15
+      end
+
+      it "returns basic data only when response_header='false'" do
+        get :show, params: { id: 'sh 85118553', vocab: 'LOC', subauthority: 'subjects', response_header: 'false' }
+        expect(response).to be_successful
+        results = JSON.parse(response.body)
+        expect(results).to be_kind_of Hash
+        expect(results.keys).not_to include('response_header')
+        expect(results['predicates'].size).to eq 15
+      end
+    end
   end
 
   describe '#fetch' do
@@ -578,14 +630,14 @@ describe Qa::LinkedDataTermsController, type: :controller do
         it 'succeeds and defaults to json content type' do
           get :fetch, params: { uri: 'http://id.worldcat.org/fast/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG' }
           expect(response).to be_successful
-          expect(response.content_type).to eq 'application/json'
+          expect(response.media_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://id.worldcat.org/fast/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG', format: 'json' }
             expect(response).to be_successful
-            expect(response.content_type).to eq 'application/json'
+            expect(response.media_type).to eq 'application/json'
           end
         end
 
@@ -593,7 +645,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
           it 'succeeds and returns term data as jsonld content type' do
             get :fetch, params: { uri: 'http://id.worldcat.org/fast/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG', format: 'jsonld' }
             expect(response).to be_successful
-            expect(response.content_type).to eq 'application/ld+json'
+            expect(response.media_type).to eq 'application/ld+json'
             expect(JSON.parse(response.body).keys).to match_array ["@context", "@graph"]
           end
         end
@@ -602,7 +654,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
           it 'succeeds and returns term data as n3 content type' do
             get :fetch, params: { uri: 'http://id.worldcat.org/fast/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG', format: 'n3' }
             expect(response).to be_successful
-            expect(response.content_type).to eq 'text/n3'
+            expect(response.media_type).to eq 'text/n3'
             expect(response.body).to start_with "@prefix"
           end
         end
@@ -611,7 +663,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
           it 'succeeds and returns term data as ntriples content type' do
             get :fetch, params: { uri: 'http://id.worldcat.org/fast/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG', format: 'ntriples' }
             expect(response).to be_successful
-            expect(response.content_type).to eq 'application/n-triples'
+            expect(response.media_type).to eq 'application/n-triples'
             expect(response.body).to include('<http://id.worldcat.org/fast/530369> <http://www.w3.org/2004/02/skos/core#prefLabel> "Cornell University"')
           end
         end
@@ -678,6 +730,32 @@ describe Qa::LinkedDataTermsController, type: :controller do
         expect(results.keys).not_to include('performance')
       end
     end
+
+    context 'when requesting response header' do
+      before do
+        stub_request(:get, 'http://localhost/test_default/term?uri=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 "returns basic data + response header when response_header='true'" do
+        get :fetch, params: { uri: 'http://id.worldcat.org/fast/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG', response_header: 'true' }
+        expect(response).to be_successful
+        results = JSON.parse(response.body)
+        expect(results).to be_kind_of Hash
+        expect(results.keys).to match_array ['response_header', 'results']
+        expect(results['response_header'].keys).to match_array ['predicate_count']
+        expect(results['response_header']['predicate_count']).to eq 7
+        expect(results['results']['predicates'].count).to eq 7
+      end
+
+      it "returns basic data only when response_header='false'" do
+        get :fetch, params: { uri: 'http://id.worldcat.org/fast/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG', response_header: 'false' }
+        expect(response).to be_successful
+        results = JSON.parse(response.body)
+        expect(results).to be_kind_of Hash
+        expect(results.keys).not_to include('response_header')
+        expect(results['predicates'].size).to eq 7
+      end
+    end
   end
 
   describe '#reload' do

data/spec/controllers/terms_controller_spec.rb

@@ -236,7 +236,7 @@ describe Qa::TermsController, type: :controller do
       it 'Access-Control-Allow-Origin is not present' do
         get :show, params: { vocab: "discogs", subauthority: "release", id: "3380671", format: 'n3' }
         expect(response).to be_successful
-        expect(response.content_type).to eq 'text/n3'
+        expect(response.media_type).to eq 'text/n3'
         expect(response.body).to start_with "@prefix"
       end
     end
@@ -248,7 +248,7 @@ describe Qa::TermsController, type: :controller do
       it 'Access-Control-Allow-Origin is not present' do
         get :show, params: { vocab: "discogs", subauthority: "release", id: "3380671", format: 'ntriples' }
         expect(response).to be_successful
-        expect(response.content_type).to eq 'application/n-triples'
+        expect(response.media_type).to eq 'application/n-triples'
         expect(response.body).to include('_:agentn1 <http://www.w3.org/2000/01/rdf-schema#label> "Dexter Gordon"')
       end
     end

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

@@ -53,6 +53,41 @@ RSpec.describe Qa::Authorities::LinkedData::FindTerm do
       end
     end
 
+    context 'response header' do
+      before 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
+      context 'when set to true' do
+        let :results do
+          lod_oclc.find('530369', request_header: { response_header: true })
+        end
+        it 'includes response header in return hash' do
+          expect(results.keys).to match_array [:response_header, :results]
+          expect(results[:response_header].keys).to match_array [:predicate_count]
+          expect(results[:response_header][:predicate_count]).to eq 7
+        end
+      end
+
+      context 'when set to false' do
+        let :results do
+          lod_oclc.find('530369', request_header: { response_header: false })
+        end
+        it 'does NOT include response header in return hash' do
+          expect(results.keys).not_to include(:response_header)
+        end
+      end
+
+      context 'when using default setting' do
+        let :results do
+          lod_oclc.find('530369')
+        end
+        it 'does NOT include response header in return hash' do
+          expect(results.keys).not_to include(:response_header)
+        end
+      end
+    end
+
     context 'in OCLC_FAST authority' do
       context 'term found' do
         let :results do

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

@@ -43,6 +43,43 @@ RSpec.describe Qa::Authorities::LinkedData::SearchQuery do
       end
     end
 
+    context 'response header' do
+      before do
+        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
+      context 'when set to true' do
+        let :results do
+          lod_oclc.search('cornell', request_header: { subauthority: 'personal_name', replacements: { 'maximumRecords' => '3' }, response_header: true })
+        end
+        it 'includes response header in return hash' do
+          expect(results).to be_kind_of Hash
+          expect(results.keys).to match_array [:response_header, :results]
+          expect(results[:response_header].keys).to match_array [:start_record, :requested_records, :retrieved_records, :total_records]
+          expect(results[:response_header][:retrieved_records]).to eq 3
+          expect(results[:results].count).to eq 3
+        end
+      end
+
+      context 'when set to false' do
+        let :results do
+          lod_oclc.search('cornell', request_header: { subauthority: 'personal_name', replacements: { 'maximumRecords' => '3' }, response_header: false })
+        end
+        it 'does NOT include response header in return hash' do
+          expect(results).to be_kind_of Array
+        end
+      end
+
+      context 'when using default setting' do
+        let :results do
+          lod_oclc.search('cornell', request_header: { subauthority: 'personal_name', replacements: { 'maximumRecords' => '3' } })
+        end
+        it 'does NOT include response header in return hash' do
+          expect(results).to be_kind_of Array
+        end
+      end
+    end
+
     context 'in OCLC_FAST authority' do
       context '0 search results' do
         let :results do

data/spec/services/linked_data/performance_data_service_spec.rb

@@ -7,8 +7,18 @@ RSpec.describe Qa::LinkedData::PerformanceDataService do
     context 'when all data passed in' do
       let(:access_time_s) { 0.5 }
       let(:normalize_time_s) { 0.3 }
-      let(:fetched_size) { 11 }
-      let(:normalized_size) { 8 }
+      let(:graph) { instance_double(RDF::Graph) }
+      let(:results) { instance_double(Hash) }
+
+      let(:fetched_size) { 1086 }
+      let(:normalized_size) { 1024 }
+
+      before do
+        # rubocop:disable RSpec/MessageChain
+        allow(results).to receive_message_chain(:to_s, :size).and_return(normalized_size)
+        allow(graph).to receive_message_chain(:triples, :to_s, :size).and_return(fetched_size)
+        # rubocop:enable RSpec/MessageChain
+      end
       it 'uses passed in params' do
         expected_results =
           {
@@ -20,7 +30,7 @@ RSpec.describe Qa::LinkedData::PerformanceDataService do
             normalization_bytes_per_s: (normalized_size / normalize_time_s),
             total_time_s: (access_time_s + normalize_time_s)
           }
-        expect(described_class.performance_data(access_time_s: access_time_s, normalize_time_s: normalize_time_s, fetched_size: fetched_size, normalized_size: normalized_size)).to eq expected_results
+        expect(described_class.performance_data(access_time_s: access_time_s, normalize_time_s: normalize_time_s, fetched_data_graph: graph, normalized_data: results)).to eq expected_results
       end
     end
   end

data/spec/services/linked_data/request_header_service_spec.rb

@@ -11,7 +11,8 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
           'lang' => 'sp',
           'maxRecords' => '4',
           'context' => 'true',
-          'performance_data' => 'true'
+          'performance_data' => 'true',
+          'response_header' => 'true'
         }.with_indifferent_access
       end
       before { allow(request).to receive(:env).and_return('HTTP_ACCEPT_LANGUAGE' => 'de') }
@@ -22,6 +23,7 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
             context: true,
             performance_data: true,
             replacements: { 'maxRecords' => '4' },
+            response_header: true,
             subauthority: 'person',
             user_language: ['sp']
           }
@@ -38,6 +40,7 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
               context: false,
               performance_data: false,
               replacements: {},
+              response_header: false,
               subauthority: nil,
               user_language: nil
             }
@@ -53,6 +56,7 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
               context: false,
               performance_data: false,
               replacements: {},
+              response_header: false,
               subauthority: nil,
               user_language: ['de']
             }
@@ -71,7 +75,8 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
           'extra' => 'data',
           'even' => 'more data',
           'format' => 'n3',
-          'performance_data' => 'true'
+          'performance_data' => 'true',
+          'response_header' => 'true'
         }.with_indifferent_access
       end
       before { allow(request).to receive(:env).and_return('HTTP_ACCEPT_LANGUAGE' => 'de') }
@@ -82,6 +87,7 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
             format: 'n3',
             performance_data: true,
             replacements: { 'extra' => 'data', 'even' => 'more data' },
+            response_header: true,
             subauthority: 'person',
             user_language: ['sp']
           }
@@ -98,6 +104,7 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
               format: 'json',
               performance_data: false,
               replacements: {},
+              response_header: false,
               subauthority: nil,
               user_language: nil
             }
@@ -113,6 +120,7 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
               format: 'json',
               performance_data: false,
               replacements: {},
+              response_header: false,
               subauthority: nil,
               user_language: ['de']
             }

data/spec/services/linked_data/response_header_service_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+RSpec.describe Qa::LinkedData::ResponseHeaderService do
+  let(:request) { double }
+
+  describe '#search_header' do
+    let(:request_header) do
+      {
+        replacements:
+        {
+          'startRecord' => '2',
+          'maxRecords' => '10'
+        }
+      }.with_indifferent_access
+    end
+    let(:search_config) { double }
+    let(:graph) { instance_double(RDF::Graph) }
+    let(:results) { instance_double(Array) }
+    let(:ldpath_program) { instance_double(Ldpath::Program) }
+    let(:service_uri) { instance_double(String) }
+    let(:ldpath) { search_config.total_count_ldpath }
+    let(:prefixes) do
+      { "vivo" => "http://vivoweb.org/ontology/core#" }
+    end
+
+    context 'when config defines pagination params' do
+      before do
+        allow(search_config).to receive(:start_record_parameter).and_return('startRecord')
+        allow(search_config).to receive(:requested_records_parameter).and_return('maxRecords')
+        allow(search_config).to receive(:total_count_ldpath).and_return('vivo::count')
+        allow(search_config).to receive(:prefixes).and_return(prefixes)
+        allow(search_config).to receive(:service_uri).and_return(service_uri)
+        allow(results).to receive(:count).and_return(10)
+        allow(Qa::LinkedData::LdpathService).to receive(:ldpath_program)
+          .with(ldpath: ldpath, prefixes: search_config.prefixes).and_return(ldpath_program)
+        allow(Qa::LinkedData::LdpathService).to receive(:ldpath_evaluate)
+          .with(program: ldpath_program, graph: graph, subject_uri: anything).and_return(['134'])
+      end
+
+      it 'gets pagination data from request header' do
+        expected_results =
+          {
+            start_record: 2,
+            requested_records: 10,
+            retrieved_records: 10,
+            total_records: 134
+          }
+        expect(described_class.new(request_header: request_header, results: results, config: search_config, graph: graph).search_header).to eq expected_results
+      end
+    end
+
+    context 'when config does not define pagination params' do
+      before do
+        allow(search_config).to receive(:start_record_parameter).and_return(nil)
+        allow(search_config).to receive(:requested_records_parameter).and_return(nil)
+        allow(search_config).to receive(:total_count_ldpath).and_return(nil)
+        allow(search_config).to receive(:prefixes).and_return(nil)
+        allow(search_config).to receive(:service_uri).and_return(nil)
+        allow(results).to receive(:count).and_return(10)
+      end
+
+      it 'returns defaults' do
+        expected_results =
+          {
+            start_record: 1,
+            requested_records: "DEFAULT",
+            retrieved_records: 10,
+            total_records: "NOT REPORTED"
+          }
+        expect(described_class.new(request_header: request_header, results: results, config: search_config, graph: graph).search_header).to eq expected_results
+      end
+    end
+  end
+
+  describe '#fetch_header' do
+    let(:request_header) do
+      {
+      }.with_indifferent_access
+    end
+    let(:term_config) { double }
+    let(:graph) { instance_double(RDF::Graph) }
+    let(:results) { instance_double(Hash) }
+
+    context 'when config defines pagination params' do
+      before do
+        allow(results).to receive(:[]).with('predicates').and_return('pred1' => 'val1', 'pred2' => 'val2')
+      end
+
+      it 'gets pagination data from request header' do
+        expected_results =
+          {
+            predicate_count: 2
+          }
+        expect(described_class.new(request_header: request_header, results: results, config: term_config, graph: graph).fetch_header).to eq expected_results
+      end
+    end
+
+    context 'when config does not define pagination params' do
+      before do
+        allow(results).to receive(:[]).with('predicates').and_return(nil)
+      end
+
+      it 'returns defaults' do
+        expected_results =
+          {
+            predicate_count: 0
+          }
+        expect(described_class.new(request_header: request_header, results: results, config: term_config, graph: graph).fetch_header).to eq expected_results
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qa
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Stephen Anderson
@@ -16,7 +16,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-18 00:00:00.000000000 Z
+date: 2019-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord-import
@@ -324,6 +324,7 @@ files:
 - app/services/qa/linked_data/mapper/term_results_mapper_service.rb
 - app/services/qa/linked_data/performance_data_service.rb
 - app/services/qa/linked_data/request_header_service.rb
+- app/services/qa/linked_data/response_header_service.rb
 - app/views/layouts/qa/application.html.erb
 - config/authorities.yml
 - config/authorities/linked_data/loc.json
@@ -559,6 +560,7 @@ files:
 - spec/services/linked_data/mapper/term_results_mapper_service_spec.rb
 - spec/services/linked_data/performance_data_service_spec.rb
 - spec/services/linked_data/request_header_service_spec.rb
+- spec/services/linked_data/response_header_service_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers/include_hash.rb
 - spec/test_app_templates/Gemfile.extra
@@ -730,4 +732,5 @@ test_files:
 - spec/services/linked_data/performance_data_service_spec.rb
 - spec/services/linked_data/language_service_spec.rb
 - spec/services/linked_data/authority_url_service_spec.rb
+- spec/services/linked_data/response_header_service_spec.rb
 - spec/services/iri_template_service_spec.rb