qa_server 0.1.99 → 1.0.0

data/app/views/qa_server/monitor_status/index.html.erb

@@ -1,3 +1,5 @@
+<%= javascript_include_tag "https://www.gstatic.com/charts/loader.js" %>
+
 <div class="page-description">
   <h2><%= t('qa_server.monitor_status.summary.title') %></h2>
 
@@ -36,7 +38,7 @@
         </tr>
         <% @status_data.each do |status| %>
             <tr>
-              <td class="<%= "status-#{status[:status].to_s}" %>"><%= status[:status_label] %></td>
+              <td class="<%= @presenter.status_style_class(status) %>"><%= @presenter.status_label(status) %></td>
               <td><%= status[:authority_name] %></td>
               <td><%= status[:subauthority_name] %></td>
               <td><%= status[:service] %></td>
@@ -52,9 +54,11 @@
   <% if @presenter.history? %>
       <div id="status-section" class="status-section">
         <h2><%= t('qa_server.monitor_status.history.title') %></h2>
+        <p class="status-update-dtstamp"><%= t('qa_server.monitor_status.history.since', date: @presenter.first_updated) %></p>
+        <%#= column_chart @presenter.historical_summary, stacked: true, colors: ["green", "red"], xtitle: 'Authority', ytitle: 'Pass-Fail', legend: 'bottom' %>
+        <%= image_tag(@presenter.historical_graph, alt: 'History Graph Unavailable') %>
 
-        <h3><%= t('qa_server.monitor_status.history.since', date: @presenter.first_updated) %></h3>
-
+<!--
         <table class="status">
           <tr>
             <th><%= t('qa_server.monitor_status.history.days_failing') %></th>
@@ -63,16 +67,17 @@
             <th><%= t('qa_server.monitor_status.history.service') %></th>
             <th><%= t('qa_server.monitor_status.history.action') %></th>
           </tr>
-          <% @presenter.history.each do |entry| %>
+          <%# @presenter.history.each do |entry| %>
               <tr>
-                <td><%= entry[:days_failing] %></td>
-                <td><%= entry[:authority_name] %></td>
-                <td><%= entry[:subauthority_name] %></td>
-                <td><%= entry[:service] %></td>
-                <td><%= entry[:action] %></td>
+                <td><%#= entry[:days_failing] %></td>
+                <td><%#= entry[:authority_name] %></td>
+                <td><%#= entry[:subauthority_name] %></td>
+                <td><%#= entry[:service] %></td>
+                <td><%#= entry[:action] %></td>
               </tr>
-          <% end %>
+          <%# end %>
         </table>
+-->
       </div>
   <% end %>
 </div>

data/app/views/qa_server/usage/index.html.erb

@@ -7,7 +7,7 @@
   optional parameters, but attempts were made to keep optional parameter names consistent between authorities.</p>
 
   <h4>Without subauthority:</h4>
-  <pre>/<%= QaServer::QA_ENGINE_MOUNT %>/search/linked_data/locnames_ld4l_cache?q=mark%20twain&maxRecords=4&lang=en</pre>
+  <pre><%= QaServer::Engine.qa_engine_mount %>/search/linked_data/locnames_ld4l_cache?q=mark%20twain&maxRecords=4&lang=en</pre>
 
   where,
   <ul>
@@ -19,7 +19,7 @@
   </ul>
 
   <h4>With subauthority</h4>
-  <pre>/<%= QaServer::QA_ENGINE_MOUNT %>/search/linked_data/locnames_ld4l_cache/person?q=mark%20twain&maxRecords=4&lang=en</pre>
+  <pre><%= QaServer::Engine.qa_engine_mount %>/search/linked_data/locnames_ld4l_cache/person?q=mark%20twain&maxRecords=4&lang=en</pre>
 
   where,
   <ul>
@@ -59,7 +59,7 @@
   consistent between authorities.</p>
 
   <h4>Fetch by URI</h4>
-  <pre>/<%= QaServer::QA_ENGINE_MOUNT %>/show/linked_data/locnames_ld4l_cache/http%3A%2F%2Fid%2Eloc%2Egov%2Fauthorities%2Fnames%2Fn92016188</pre>
+  <pre><%= QaServer::Engine.qa_engine_mount %>/show/linked_data/locnames_ld4l_cache/http%3A%2F%2Fid%2Eloc%2Egov%2Fauthorities%2Fnames%2Fn92016188</pre>
   <p><b><%= t('qa_server.warning.chrome_unencoding_msg') %></b></p>
 
   where,
@@ -71,7 +71,7 @@
   </ul>
 
   <h4>Fetch by ID</h4>
-  <pre>/<%= QaServer::QA_ENGINE_MOUNT %>/show/linked_data/oclcfast_ld4l_cache/1914919?lang=en</pre>
+  <pre><%= QaServer::Engine.qa_engine_mount %>/show/linked_data/oclcfast_ld4l_cache/1914919?lang=en</pre>
 
   where,
   <ul>

data/app/views/shared/_footer.html.erb

@@ -8,7 +8,7 @@
     <div class="navbar-right">
       <div class="navbar-text text-right">
         <p><%= t('qa_server.footer.copyright_html') %></p>
-        <p><%= t('qa_server.footer.disclaimer_html') %></p>
+        <p><%= t('qa_server.footer.attribution_html') %></p>
       </div>
     </div>
   </div>

data/config/routes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 QaServer::Engine.routes.draw do
   # Downloads controller route
   resources :homepage, only: 'index'

data/lib/generators/qa_server/assets_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators'
 
 class QaServer::AssetsGenerator < Rails::Generators::Base

data/lib/generators/qa_server/config_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators'
 
 class QaServer::ConfigGenerator < Rails::Generators::Base
@@ -8,6 +9,7 @@ class QaServer::ConfigGenerator < Rails::Generators::Base
     * authority configs
     * authority scenarios
     * i18n
+    * add default configuration initializer
        """
 
   def banner
@@ -28,4 +30,8 @@ class QaServer::ConfigGenerator < Rails::Generators::Base
     say_status('info', '  -- adding i18n translations', :blue)
     copy_file 'config/locales/qa_server.en.yml'
   end
+
+  def create_initializer_config_file
+    copy_file 'config/initializers/qa_server.rb'
+  end
 end

data/lib/generators/qa_server/install_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module QaServer
   class Install < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)

data/lib/generators/qa_server/models_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class QaServer::ModelsGenerator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
 

data/lib/generators/qa_server/templates/config/initializers/qa_server.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+QaServer.config do |config|
+  # no configurations at this time
+end

data/lib/generators/qa_server/templates/config/locales/qa_server.en.yml

@@ -6,4 +6,4 @@ en:
     footer:
       copyright_html:  "<strong>Copyright &copy; 2018 Cornell</strong> Licensed under the Apache License, Version 2.0"
       service_html:    A service of <a href="http://www.library.cornell.edu/" class="navbar-link" target="_blank">Cornell University Library</a> and <br /><a href="https://www.slis.uiowa.edu/" class="navbar-link" target="_blank">School of Library and Information Science, University of Iowa</a>.
-      disclaimer_html: This service is supported by work on <a href="http://ld4l.org" class="navbar-link" target="_blank">Linked Data for Libraries - Labs</a> funded by <br><a href="https://mellon.org/" class="navbar-link" target="_blank">Andrew W. Mellon Foundation</a>, and <a href="http://samvera.org" class="navbar-link" target="_blank">Samvera</a>, an open source community.
+      attribution_html: This service is supported by work on <a href="http://ld4l.org" class="navbar-link" target="_blank">Linked Data for Libraries - Labs</a> and <br>  <a href="https://wiki.duraspace.org/x/9xgRBg" class="navbar-link" target="_blank">Linked Data for Production</a> funded by <a href="https://mellon.org/" class="navbar-link" target="_blank">Andrew W. Mellon Foundation</a>, <br>and by work on Questioning Authority in <a href="http://samvera.org" class="navbar-link" target="_blank">Samvera</a>, an open source community.

data/lib/generators/qa_server/templates/db/migrate/20180807045549_create_scenario_run_registry.rb.erb

@@ -0,0 +1,7 @@
+class CreateScenarioRunRegistry < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :scenario_run_registry do |t|
+      t.datetime :dt_stamp
+    end
+  end
+end

data/lib/generators/qa_server/templates/db/migrate/20180807045552_create_scenario_run_history.rb.erb

@@ -0,0 +1,16 @@
+class CreateScenarioRunHistory < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :scenario_run_history do |t|
+      t.belongs_to :scenario_run_registry
+      t.integer :status, default: 2 # :good, :bad, :unknown
+      t.string :authority_name
+      t.string :subauthority_name
+      t.string :service
+      t.string :action
+      t.string :url
+      t.string :err_message
+      t.integer :scenario_type, default: 0 # :connection, :accuracy, :performance
+      t.decimal :run_time, precision: 10, scale: 4
+    end
+  end
+end

data/lib/generators/qa_server/templates/db/migrate/20180807045554_drop_unused_tables.rb.erb

@@ -0,0 +1,6 @@
+class DropUnusedTables < ActiveRecord::Migration<%= migration_version %>
+  def change
+    drop_table :authority_status_failure
+    drop_table :authority_status
+  end
+end

data/lib/generators/qa_server/templates/db/migrate/20180809045552_add_indices_to_scenario_run_history.rb.erb

@@ -0,0 +1,8 @@
+class AddIndicesToScenarioRunHistory < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_index :scenario_run_history, :url
+    add_index :scenario_run_history, :status
+    add_index :scenario_run_history, :authority_name
+    add_index :scenario_run_history, :scenario_type
+  end
+end

data/lib/qa_server/configuration.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module QaServer
+  class Configuration
+    # no configurations at this time
+  end
+end

data/lib/qa_server/engine.rb

@@ -1,12 +1,21 @@
+# frozen_string_literal: true
 module QaServer
   class Engine < ::Rails::Engine
     isolate_namespace QaServer
 
     require 'qa'
 
+    def self.engine_mount
+      QaServer::Engine.routes.find_script_name({})
+    end
+
+    def self.qa_engine_mount
+      Qa::Engine.routes.find_script_name({})
+    end
+
     # Force these models to be added to Legato's registry in development mode
     config.eager_load_paths += %W[
-    #{config.root}/app/models/qa_server/download.rb
+      #{config.root}/app/models/qa_server/download.rb
       #{config.root}/app/models/qa_server/pageview.rb
     ]
 

data/lib/qa_server/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module QaServer
-  VERSION = '0.1.99'
+  VERSION = '1.0.0'
 end

data/lib/qa_server.rb

@@ -1,6 +1,24 @@
+# frozen_string_literal: true
 require 'qa_server/engine'
 require 'qa_server/version'
 
 module QaServer
-  QA_ENGINE_MOUNT = 'authorities'
+  extend ActiveSupport::Autoload
+
+  autoload :Configuration
+
+  # @api public
+  #
+  # Exposes the Questioning Authority configuration
+  #
+  # @yield [Qa::Configuration] if a block is passed
+  # @return [Qa::Configuration]
+  # @see Qa::Configuration for configuration options
+  def self.config(&block)
+    @config ||= QaServer::Configuration.new
+
+    yield @config if block
+
+    @config
+  end
 end

data/lib/tasks/install.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 namespace :qa_server do
   namespace :install do
     desc 'Copy migrations from QaServer to application'

data/lib/tasks/qa_server_tasks.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # desc "Explaining what the task does"
 # task :qa_server do
 #   # Task goes here

data/qa_server.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'qa_server/version'
@@ -18,17 +19,19 @@ Gem::Specification.new do |spec|
   spec.version       = QaServer::VERSION
   spec.license       = 'Apache-2.0'
 
-  # spec.required_ruby_version = '>= 2.3'
-
   # Note: rails does not follow sem-ver conventions, it's
   # minor version releases can include breaking changes; see
   # http://guides.rubyonrails.org/maintenance_policy.html
-  spec.add_dependency 'rails', '5.1.6'
+  spec.add_dependency 'rails', '~> 5.0' # Keep in sync with version supported by Hyrax
 
   # Required gems for QA and linked data access
-  spec.add_dependency 'qa' # loaded specific branch in Gemfile
-  spec.add_dependency 'linkeddata'
+  spec.add_development_dependency 'qa' # loaded specific branch in Gemfile
+  spec.add_development_dependency 'linkeddata'
+
+  # Produces dashboard charts on monitor status page
+  spec.add_dependency 'gruff'
 
+  spec.add_development_dependency 'binding_of_caller', '~> 1.0.0' # rubocop styleguide
   spec.add_development_dependency 'bixby', '~> 1.0.0' # rubocop styleguide
   # spec.add_development_dependency 'capybara', '~> 2.13'
   spec.add_development_dependency 'engine_cart', '~> 2.0'

data/spec/rails_helper.rb

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 # This file is normaly copied to spec/ when you run 'rails generate rspec:install'
 # but this is a dummy file to allow qa_server specs to run.

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ENV["RAILS_ENV"] ||= 'test'
 require "bundler/setup"
 
@@ -183,101 +184,100 @@ end
 #                                                  end
 #   end
 
-  # config.include(ControllerLevelHelpers, type: :view)
-  # config.before(:each, type: :view) { initialize_controller_helpers(view) }
-  #
-  # config.before(:all, type: :feature) do
-  #   # Assets take a long time to compile. This causes two problems:
-  #   # 1) the profile will show the first feature test taking much longer than it
-  #   #    normally would.
-  #   # 2) The first feature test will trigger rack-timeout
-  #   #
-  #   # Precompile the assets to prevent these issues.
-  #   visit "/assets/application.css"
-  #   visit "/assets/application.js"
-  # end
-  #
-  # config.after do
-  #   DatabaseCleaner.clean
-  # end
-  #
-  # # If true, the base class of anonymous controllers will be inferred
-  # # automatically. This will be the default behavior in future versions of
-  # # rspec-rails.
-  # config.infer_base_class_for_anonymous_controllers = false
-  #
-  # config.include Shoulda::Matchers::Independent
-  #
-  # if Devise::VERSION >= '4.2'
-  #   config.include Devise::Test::ControllerHelpers, type: :controller
-  # else
-  #   config.include Devise::TestHelpers, type: :controller
-  # end
-  #
-  # config.include EngineRoutes, type: :controller
-  # config.include Warden::Test::Helpers, type: :request
-  # config.include Warden::Test::Helpers, type: :feature
-  # config.after(:each, type: :feature) do
-  #   Warden.test_reset!
-  #   Capybara.reset_sessions!
-  #   page.driver.reset!
-  # end
-  #
-  # config.include Capybara::RSpecMatchers, type: :input
-  # config.include InputSupport, type: :input
-  # config.include FactoryBot::Syntax::Methods
-  # config.include OptionalExample
-  #
-  # config.infer_spec_type_from_file_location!
-  #
-  # config.expect_with :rspec do |expectations|
-  #   expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  # end
-  #
-  # config.formatter = 'LoggingFormatter'
-  # config.default_formatter = 'doc' if config.files_to_run.one?
-  #
-  # config.order = :random
-  # Kernel.srand config.seed
-  #
-  # config.shared_context_metadata_behavior = :apply_to_host_groups
-  #
-  # config.filter_run_when_matching :focus
-  #
-  # config.example_status_persistence_file_path = 'spec/examples.txt'
-  #
-  # config.profile_examples = 10
-  #
-  # # Use this example metadata when you want to perform jobs inline during testing.
-  # #
-  # #   describe '#my_method`, :perform_enqueued do
-  # #     ...
-  # #   end
-  # #
-  # # If you pass an `Array` of job classes, they will be treated as the filter list.
-  # #
-  # #   describe '#my_method`, perform_enqueued: [MyJobClass] do
-  # #     ...
-  # #   end
-  # #
-  # # Limit to specific job classes with:
-  # #
-  # #   ActiveJob::Base.queue_adapter.filter = [JobClass]
-  # #
-  # config.before(:example, :perform_enqueued) do |example|
-  #   ActiveJob::Base.queue_adapter.filter =
-  #     example.metadata[:perform_enqueued].try(:to_a)
-  #
-  #   ActiveJob::Base.queue_adapter.perform_enqueued_jobs    = true
-  #   ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = true
-  # end
-  #
-  # config.after(:example, :perform_enqueued) do
-  #   ActiveJob::Base.queue_adapter.filter         = nil
-  #   ActiveJob::Base.queue_adapter.enqueued_jobs  = []
-  #   ActiveJob::Base.queue_adapter.performed_jobs = []
-  #
-  #   ActiveJob::Base.queue_adapter.perform_enqueued_jobs    = false
-  #   ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = false
-  # end
-end
+# config.include(ControllerLevelHelpers, type: :view)
+# config.before(:each, type: :view) { initialize_controller_helpers(view) }
+#
+# config.before(:all, type: :feature) do
+#   # Assets take a long time to compile. This causes two problems:
+#   # 1) the profile will show the first feature test taking much longer than it
+#   #    normally would.
+#   # 2) The first feature test will trigger rack-timeout
+#   #
+#   # Precompile the assets to prevent these issues.
+#   visit "/assets/application.css"
+#   visit "/assets/application.js"
+# end
+#
+# config.after do
+#   DatabaseCleaner.clean
+# end
+#
+# # If true, the base class of anonymous controllers will be inferred
+# # automatically. This will be the default behavior in future versions of
+# # rspec-rails.
+# config.infer_base_class_for_anonymous_controllers = false
+#
+# config.include Shoulda::Matchers::Independent
+#
+# if Devise::VERSION >= '4.2'
+#   config.include Devise::Test::ControllerHelpers, type: :controller
+# else
+#   config.include Devise::TestHelpers, type: :controller
+# end
+#
+# config.include EngineRoutes, type: :controller
+# config.include Warden::Test::Helpers, type: :request
+# config.include Warden::Test::Helpers, type: :feature
+# config.after(:each, type: :feature) do
+#   Warden.test_reset!
+#   Capybara.reset_sessions!
+#   page.driver.reset!
+# end
+#
+# config.include Capybara::RSpecMatchers, type: :input
+# config.include InputSupport, type: :input
+# config.include FactoryBot::Syntax::Methods
+# config.include OptionalExample
+#
+# config.infer_spec_type_from_file_location!
+#
+# config.expect_with :rspec do |expectations|
+#   expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+# end
+#
+# config.formatter = 'LoggingFormatter'
+# config.default_formatter = 'doc' if config.files_to_run.one?
+#
+# config.order = :random
+# Kernel.srand config.seed
+#
+# config.shared_context_metadata_behavior = :apply_to_host_groups
+#
+# config.filter_run_when_matching :focus
+#
+# config.example_status_persistence_file_path = 'spec/examples.txt'
+#
+# config.profile_examples = 10
+#
+# # Use this example metadata when you want to perform jobs inline during testing.
+# #
+# #   describe '#my_method`, :perform_enqueued do
+# #     ...
+# #   end
+# #
+# # If you pass an `Array` of job classes, they will be treated as the filter list.
+# #
+# #   describe '#my_method`, perform_enqueued: [MyJobClass] do
+# #     ...
+# #   end
+# #
+# # Limit to specific job classes with:
+# #
+# #   ActiveJob::Base.queue_adapter.filter = [JobClass]
+# #
+# config.before(:example, :perform_enqueued) do |example|
+#   ActiveJob::Base.queue_adapter.filter =
+#     example.metadata[:perform_enqueued].try(:to_a)
+#
+#   ActiveJob::Base.queue_adapter.perform_enqueued_jobs    = true
+#   ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = true
+# end
+#
+# config.after(:example, :perform_enqueued) do
+#   ActiveJob::Base.queue_adapter.filter         = nil
+#   ActiveJob::Base.queue_adapter.enqueued_jobs  = []
+#   ActiveJob::Base.queue_adapter.performed_jobs = []
+#
+#   ActiveJob::Base.queue_adapter.perform_enqueued_jobs    = false
+#   ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = false
+# end

data/spec/test_app_templates/Gemfile.extra

@@ -2,4 +2,5 @@
 
 group :development do
   gem 'better_errors'
-end
+  gem 'binding_of_caller'
+end

data/tasks/qa_server_dev.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rspec/core/rake_task'
 require 'engine_cart/rake_task'
 require 'rubocop/rake_task'