qa 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69b198054c52dafc00d9cf83f2f61b5fdc3e55cb
-  data.tar.gz: 00aa3d111681efe0a1c068846190e41531155e21
+  metadata.gz: a0d1a1143d74f69697643e818b748496f81e96cd
+  data.tar.gz: e1145e427c1f343a44b4d144181697efb89a70e4
 SHA512:
-  metadata.gz: c75338fdecba820602eb3c669065679a87387e80bf65e350fdc42d6224dc5eb152439198257b6da3eb38812a9e44e6764472fa3a8fff3f554e782b13da0e4c38
-  data.tar.gz: bcf795d36f8fc600dbc672d9884b4b37efd084ad9e12a7e53583b491cf122b1247f8335fdcfe216cfda6b2c3c326628ac27f2b6a375aa44feb783daf8ce0f2b5
+  metadata.gz: 8abeeb72e16fca93102783671e7b8da5362461422e9b3d6d53ed35a0ee7dc7e169980b5ea1eeb53bf1a00edf7fd4d85f41f6336af0b61acc50b56bf7161d5978
+  data.tar.gz: ab5983ff28640f912a06ac673b376d1542d4cdd0a182b1cfedf72ea6b186c4ada32ad17c4d9c7190e7e30c18bb81e8377e0603ff984b268ffa9168c59d10aead

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

@@ -91,6 +91,7 @@ module Qa
           end
 
           def process_error(e, url)
+            Rails.logger.warn("******** RDF::Graph#load failure: exception=#{e.inspect}, url=#{url}")
             uri = URI(url)
             raise RDF::FormatError, "Unknown RDF format of results returned by #{uri}. (RDF::FormatError)  You may need to include gem 'linkeddata'." if e.is_a? RDF::FormatError
             response_code = ioerror_code(e)

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

@@ -1,8 +1,9 @@
 # Service to construct a request header that includes optional attributes for search and fetch requests.
+require 'geocoder'
 module Qa
   module LinkedData
     class RequestHeaderService
-      attr_reader :request, :params
+      attr_reader :request, :params, :request_id
 
       # @param request [HttpRequest] request from controller
       # @param params [Hash] attribute-value pairs holding the request parameters
@@ -16,6 +17,8 @@ module Qa
       def initialize(request:, params:)
         @request = request
         @params = params
+        @request_id = request.request_id
+        log_request
       end
 
       # Construct request parameters to pass to search_query (linked data module).
@@ -23,6 +26,8 @@ module Qa
       # @see Qa::Authorities::LinkedData::SearchQuery
       def search_header
         header = {}
+        header[:request] = request
+        header[:request_id] = request_id
         header[:subauthority] = params.fetch(:subauthority, nil)
         header[:user_language] = user_language
         header[:performance_data] = performance_data?
@@ -37,6 +42,8 @@ module Qa
       # @see Qa::Authorities::LinkedData::FindTerm
       def fetch_header
         header = {}
+        header[:request] = request
+        header[:request_id] = request_id
         header[:subauthority] = params.fetch(:subauthority, nil)
         header[:user_language] = user_language
         header[:performance_data] = performance_data?
@@ -62,6 +69,13 @@ module Qa
 
       private
 
+        def log_request
+          gc = request.location
+          msg = "******** #{request.path_parameters[:action].upcase}"
+          msg += " from IP #{request.ip} in {city: #{gc.city}, state: #{gc.state}, country: #{gc.country}}" unless Qa.config.suppress_ip_data_from_log
+          Rails.logger.info(msg)
+        end
+
         # filter literals in results to this language
         def user_language
           request_language = request.env['HTTP_ACCEPT_LANGUAGE']

data/lib/generators/qa/install/templates/config/initializers/qa.rb

@@ -23,4 +23,9 @@ Qa.config do |config|
   # When false, properties that do not override default optional behavior will be shown whether or not the property has a value in the graph.
   # When true, properties that do not override default optional behavior will not be shown whn the property does not have a value in the graph.
   # config.property_map_default_for_optional = false
+
+  # IP data including IP address, city, state, and country will be logged with each request.
+  # When false, IP data is logged
+  # When true, IP data will not be logged (default for backward compatibility)
+  # config.suppress_ip_data_from_log = true
 end

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

@@ -15,8 +15,8 @@ module Qa::Authorities
         @term_config = term_config
       end
 
-      attr_reader :term_config, :full_graph, :filtered_graph, :language, :id, :uri, :access_time_s, :normalize_time_s, :subauthority, :request_header
-      private :full_graph, :filtered_graph, :language, :id, :uri, :access_time_s, :normalize_time_s, :subauthority, :request_header
+      attr_reader :term_config, :full_graph, :filtered_graph, :language, :id, :uri, :access_time_s, :normalize_time_s, :subauthority, :request_header, :request_id, :request
+      private :full_graph, :filtered_graph, :language, :id, :uri, :access_time_s, :normalize_time_s, :subauthority, :request_header, :request_id, :request
 
       delegate :term_subauthority?, :prefixes, :authority_name, to: :term_config
 
@@ -92,6 +92,8 @@ module Qa::Authorities
 
         def unpack_request_header(request_header)
           @request_header = request_header
+          @request = request_header.fetch(:request, nil)
+          @request_id = request_header.fetch(:request_id, 'UNASSIGNED')
           @subauthority = request_header.fetch(:subauthority, nil)
           @format = request_header.fetch(:format, 'json')
           @performance_data = request_header.fetch(:performance_data, false)

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

@@ -15,8 +15,8 @@ module Qa::Authorities
         @search_config = search_config
       end
 
-      attr_reader :search_config, :full_graph, :filtered_graph, :language, :access_time_s, :normalize_time_s, :subauthority, :request_header
-      private :full_graph, :filtered_graph, :language, :access_time_s, :normalize_time_s, :subauthority, :request_header
+      attr_reader :search_config, :full_graph, :filtered_graph, :language, :access_time_s, :normalize_time_s, :subauthority, :request_header, :request_id, :request
+      private :full_graph, :filtered_graph, :language, :access_time_s, :normalize_time_s, :subauthority, :request_header, :request_id, :request
 
       delegate :subauthority?, :supports_sort?, :prefixes, :authority_name, to: :search_config
 
@@ -91,6 +91,8 @@ module Qa::Authorities
 
         def unpack_request_header(request_header)
           @request_header = request_header
+          @request = request_header.fetch(:request, nil)
+          @request_id = request_header.fetch(:request_id, 'UNASSIGNED')
           @subauthority = request_header.fetch(:subauthority, nil)
           @context = request_header.fetch(:context, false)
           @performance_data = request_header.fetch(:performance_data, false)

data/lib/qa/configuration.rb

@@ -54,5 +54,14 @@ module Qa
       @property_map_default_for_optional = false if @property_map_default_for_optional.nil?
       @property_map_default_for_optional
     end
+
+    # IP data including IP address, city, state, and country will be logged with each request.
+    # When false, IP data is logged
+    # When true, IP data will not be logged (default for backward compatibility)
+    attr_writer :suppress_ip_data_from_log
+    def suppress_ip_data_from_log
+      @suppress_ip_data_from_log = true if @suppress_ip_data_from_log.nil?
+      @suppress_ip_data_from_log
+    end
   end
 end

data/lib/qa/version.rb

@@ -1,3 +1,3 @@
 module Qa
-  VERSION = "5.2.0".freeze
+  VERSION = "5.3.0".freeze
 end

data/spec/controllers/linked_data_terms_controller_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 require 'json'
 
 describe Qa::LinkedDataTermsController, type: :controller do
+  let(:graph_load_failure) { /^\*\*\*\*\*\*\*\* RDF\:\:Graph\#load failure/ }
   before do
     @routes = Qa::Engine.routes
   end
@@ -140,6 +141,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
             .to_return(status: 500)
         end
         it 'returns 500' do
+          expect(Rails.logger).to receive(:warn).with(graph_load_failure)
           expect(Rails.logger).to receive(:warn).with("Internal Server Error - Search query my_query unsuccessful for authority OCLC_FAST")
           get :search, params: { q: 'my_query', vocab: 'OCLC_FAST', maximumRecords: '3' }
           expect(response.code).to eq('500')
@@ -154,6 +156,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
         end
         it 'returns 500' do
           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(graph_load_failure)
           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')
@@ -166,6 +169,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
             .to_return(status: 501)
         end
         it 'returns 500' do
+          expect(Rails.logger).to receive(:warn).with(graph_load_failure)
           expect(Rails.logger).to receive(:warn).with("Internal Server Error - Search query my_query unsuccessful for authority OCLC_FAST")
           get :search, params: { q: 'my_query', vocab: 'OCLC_FAST', maximumRecords: '3' }
           expect(response.code).to eq('500')
@@ -179,6 +183,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
           .to_return(status: 503)
       end
       it 'returns 503' do
+        expect(Rails.logger).to receive(:warn).with(graph_load_failure)
         expect(Rails.logger).to receive(:warn).with("Service Unavailable - Search query my_query unsuccessful for authority OCLC_FAST")
         get :search, params: { q: 'my_query', vocab: 'OCLC_FAST', maximumRecords: '3' }
         expect(response.code).to eq('503')
@@ -355,6 +360,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
           stub_request(:get, 'http://id.worldcat.org/fast/530369').to_return(status: 500)
         end
         it 'returns 500' do
+          expect(Rails.logger).to receive(:warn).with(graph_load_failure)
           expect(Rails.logger).to receive(:warn).with("Internal Server Error - Fetch term 530369 unsuccessful for authority OCLC_FAST")
           get :show, params: { id: '530369', vocab: 'OCLC_FAST' }
           expect(response.code).to eq('500')
@@ -380,6 +386,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
         end
         it 'returns 500' do
           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(graph_load_failure)
           expect(Rails.logger).to receive(:warn).with(msg)
           get :show, params: { id: '530369', vocab: 'OCLC_FAST' }
           expect(response.code).to eq('500')
@@ -391,6 +398,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
           stub_request(:get, 'http://id.worldcat.org/fast/530369').to_return(status: 501)
         end
         it 'returns 500' do
+          expect(Rails.logger).to receive(:warn).with(graph_load_failure)
           expect(Rails.logger).to receive(:warn).with("Internal Server Error - Fetch term 530369 unsuccessful for authority OCLC_FAST")
           get :show, params: { id: '530369', vocab: 'OCLC_FAST' }
           expect(response.code).to eq('500')
@@ -403,6 +411,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
         stub_request(:get, 'http://id.worldcat.org/fast/530369').to_return(status: 503)
       end
       it 'returns 503' do
+        expect(Rails.logger).to receive(:warn).with(graph_load_failure)
         expect(Rails.logger).to receive(:warn).with("Service Unavailable - Fetch term 530369 unsuccessful for authority OCLC_FAST")
         get :show, params: { id: '530369', vocab: 'OCLC_FAST' }
         expect(response.code).to eq('503')
@@ -414,6 +423,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
         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(graph_load_failure)
         expect(Rails.logger).to receive(:warn).with('Term Not Found - Fetch term FAKE_ID unsuccessful for authority OCLC_FAST')
         get :show, params: { id: 'FAKE_ID', vocab: 'OCLC_FAST' }
         expect(response.code).to eq('404')
@@ -566,6 +576,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
           stub_request(:get, 'http://localhost/test_default/term?uri=http://id.worldcat.org/fast/530369').to_return(status: 500)
         end
         it 'returns 500' do
+          expect(Rails.logger).to receive(:warn).with(graph_load_failure)
           expect(Rails.logger).to receive(:warn).with("Internal Server Error - Fetch term http://id.worldcat.org/fast/530369 unsuccessful for authority LOD_TERM_URI_PARAM_CONFIG")
           get :fetch, params: { vocab: 'LOD_TERM_URI_PARAM_CONFIG', uri: 'http://id.worldcat.org/fast/530369' }
           expect(response.code).to eq('500')
@@ -580,6 +591,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
         it 'returns 500' do
           msg = "RDF Format Error - Results from fetch term http://id.worldcat.org/fast/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(graph_load_failure)
           expect(Rails.logger).to receive(:warn).with(msg)
           get :fetch, params: { uri: 'http://id.worldcat.org/fast/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG' }
           expect(response.code).to eq('500')
@@ -591,6 +603,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
           stub_request(:get, 'http://localhost/test_default/term?uri=http://id.worldcat.org/fast/530369').to_return(status: 501)
         end
         it 'returns 500' do
+          expect(Rails.logger).to receive(:warn).with(graph_load_failure)
           expect(Rails.logger).to receive(:warn).with("Internal Server Error - Fetch term http://id.worldcat.org/fast/530369 unsuccessful for authority LOD_TERM_URI_PARAM_CONFIG")
           get :fetch, params: { uri: 'http://id.worldcat.org/fast/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG' }
           expect(response.code).to eq('500')
@@ -603,6 +616,7 @@ describe Qa::LinkedDataTermsController, type: :controller do
         stub_request(:get, 'http://localhost/test_default/term?uri=http://id.worldcat.org/fast/530369').to_return(status: 503)
       end
       it 'returns 503' do
+        expect(Rails.logger).to receive(:warn).with(graph_load_failure)
         expect(Rails.logger).to receive(:warn).with("Service Unavailable - Fetch term http://id.worldcat.org/fast/530369 unsuccessful for authority LOD_TERM_URI_PARAM_CONFIG")
         get :fetch, params: { uri: 'http://id.worldcat.org/fast/530369', vocab: 'LOD_TERM_URI_PARAM_CONFIG' }
         expect(response.code).to eq('503')
@@ -614,6 +628,7 @@ describe Qa::LinkedDataTermsController, type: :controller 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(graph_load_failure)
         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')

data/spec/services/linked_data/request_header_service_spec.rb

@@ -2,8 +2,44 @@ require 'spec_helper'
 
 RSpec.describe Qa::LinkedData::RequestHeaderService do
   let(:request) { double }
+  let(:request_id) { 'anID' }
+  let(:some_params) { double }
+  let(:location) { double }
+  let(:fake_ip) { '111.22.33.4444' }
+  let(:city) { 'Ithaca' }
+  let(:state) { 'New York' }
+  let(:country) { 'US' }
+  before do
+    allow(request).to receive(:request_id).and_return(request_id)
+    allow(request).to receive_message_chain(:path_parameters, :[]).with(:action).and_return('search') # rubocop:disable RSpec/MessageChain
+    allow(request).to receive(:location).and_return(location)
+    allow(request).to receive(:ip).and_return(fake_ip)
+    allow(location).to receive(:city).and_return(city)
+    allow(location).to receive(:state).and_return(state)
+    allow(location).to receive(:country).and_return(country)
+  end
+
+  describe '#initialize' do
+    context 'when Qa.config.suppress_ip_data_from_log is true' do
+      before { allow(Qa).to receive_message_chain(:config, :suppress_ip_data_from_log).and_return(true) } # rubocop:disable RSpec/MessageChain
+      it 'does not include IP info in log message' do
+        expect(Rails.logger).to receive(:info).with("******** SEARCH")
+        described_class.new(request: request, params: some_params)
+      end
+    end
+
+    context 'when Qa.config.suppress_ip_data_from_log is false' do
+      before { allow(Qa).to receive_message_chain(:config, :suppress_ip_data_from_log).and_return(false) } # rubocop:disable RSpec/MessageChain
+      it 'does include IP info in log message' do
+        expect(Rails.logger).to receive(:info).with("******** SEARCH from IP #{fake_ip} in {city: #{city}, state: #{state}, country: #{country}}")
+        described_class.new(request: request, params: some_params)
+      end
+    end
+  end
 
   describe '#search_header' do
+    let(:request_id) { 's1' }
+
     context 'when optional params are defined' do
       let(:search_params) do
         {
@@ -20,6 +56,8 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
       it 'uses passed in params' do
         expected_results =
           {
+            request: request,
+            request_id: request_id,
             context: true,
             performance_data: true,
             replacements: { 'maxRecords' => '4' },
@@ -37,6 +75,8 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
         it 'returns defaults' do
           expected_results =
             {
+              request: request,
+              request_id: request_id,
               context: false,
               performance_data: false,
               replacements: {},
@@ -53,6 +93,8 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
         it 'returns defaults with language set to request language' do
           expected_results =
             {
+              request: request,
+              request_id: request_id,
               context: false,
               performance_data: false,
               replacements: {},
@@ -67,6 +109,7 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
   end
 
   describe '#fetch_header' do
+    let(:request_id) { 'f1' }
     context 'when optional params are defined' do
       let(:fetch_params) do
         {
@@ -84,6 +127,8 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
       it 'uses passed in params' do
         expected_results =
           {
+            request: request,
+            request_id: request_id,
             format: 'n3',
             performance_data: true,
             replacements: { 'extra' => 'data', 'even' => 'more data' },
@@ -101,6 +146,8 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
         it 'returns defaults' do
           expected_results =
             {
+              request: request,
+              request_id: request_id,
               format: 'json',
               performance_data: false,
               replacements: {},
@@ -117,6 +164,8 @@ RSpec.describe Qa::LinkedData::RequestHeaderService do
         it 'returns defaults with language set to request language' do
           expected_results =
             {
+              request: request,
+              request_id: request_id,
               format: 'json',
               performance_data: false,
               replacements: {},

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qa
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Stephen Anderson
@@ -16,7 +16,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-03 00:00:00.000000000 Z
+date: 2019-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord-import
@@ -60,6 +60,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: geocoder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ldpath
   requirement: !ruby/object:Gem::Requirement