blacklight-spotlight 4.0.2 → 4.1.0

data/app/controllers/spotlight/catalog_controller.rb

@@ -37,7 +37,11 @@ module Spotlight
 
     before_action only: :admin do
       blacklight_config.view.select! { |k, _v| k == :admin_table }
-      blacklight_config.view.admin_table(partials: [:index_compact], document_actions: []) unless blacklight_config.view.key? :admin_table
+      unless blacklight_config.view.key? :admin_table
+        blacklight_config.view.admin_table(document_component: Spotlight::DocumentAdminTableComponent,
+                                           partials: [:index_compact],
+                                           document_actions: [])
+      end
       if Blacklight::VERSION > '8'
         blacklight_config.track_search_session.storage = false
       else
@@ -51,7 +55,7 @@ module Spotlight
     end
 
     before_action only: :edit do
-      blacklight_config.view.edit(partials: blacklight_config.view_config(:show).partials.dup.insert(2, :edit)) unless blacklight_config.view.key? :edit
+      blacklight_config.action_mapping.edit.top_level_config = :show
     end
 
     def show

data/app/controllers/spotlight/dashboards_controller.rb

@@ -12,14 +12,15 @@ module Spotlight
 
     before_action only: [:show] do
       blacklight_config.action_mapping&.delete(:show)
-      blacklight_config.view.clear
-      blacklight_config.view.admin_table(partials: ['index_compact'], document_actions: [])
+      blacklight_config.action_mapping.show.top_level_config = :index if blacklight_config.key?(:action_mapping)
+
+      blacklight_config.index.document_component = Spotlight::DocumentAdminTableComponent
+      blacklight_config.index.document_actions = []
       if Blacklight::VERSION > '8'
         blacklight_config.track_search_session.storage = false
       else
         blacklight_config.track_search_session = false
       end
-      blacklight_config.action_mapping.show.top_level_config = :index if blacklight_config.key?(:action_mapping)
     end
 
     def show

data/app/models/concerns/spotlight/exhibit_analytics.rb

@@ -4,18 +4,20 @@ module Spotlight
   ##
   # Exhibit mixin to provide analytics data
   module ExhibitAnalytics
-    def analytics(start_date = 1.month, path = nil)
+    def analytics(dates = { start_date: '365daysAgo', end_date: 'today' }, path = nil)
       return OpenStruct.new unless analytics_provider&.enabled?
 
       @analytics ||= {}
-      @analytics[start_date] ||= analytics_provider.exhibit_data(path || self, start_date: start_date.ago)
+      start_date = dates['start_date'] || 1.month.ago
+      @analytics[start_date] ||= analytics_provider.exhibit_data(path || self, dates)
     end
 
-    def page_analytics(start_date = 1.month, path = nil)
+    def page_analytics(dates = { start_date: '365daysAgo', end_date: 'today' }, path = nil)
       return [] unless analytics_provider&.enabled?
 
       @page_analytics ||= {}
-      @page_analytics[start_date] ||= analytics_provider.page_data(path || self, start_date: start_date.ago)
+      start_date = dates['start_date'] || 1.month.ago
+      @page_analytics[start_date] ||= analytics_provider.page_data(path || self, dates)
     end
 
     def analytics_provider

data/app/models/spotlight/analytics/ga.rb

@@ -1,80 +1,127 @@
 # frozen_string_literal: true
 
 require 'signet/oauth_2/client'
-require 'legato'
+require 'google/analytics/data'
 
 module Spotlight
   module Analytics
     ##
     # Google Analytics data provider for the Exhibit dashboard
     class Ga
-      extend Legato::Model
-
       def enabled?
-        user && site
+        Spotlight::Engine.config.ga_json_key_path && client
+      end
+
+      def client
+        Google::Analytics::Data.analytics_data do |config|
+          config.credentials = Spotlight::Engine.config.ga_json_key_path
+        end
+      rescue StandardError => e
+        Rails.logger.error(e)
+        nil
       end
 
-      delegate :metrics, to: :model
+      def params(path, dates)
+        {
+          date_ranges: [{ start_date: dates['start_date'], end_date: dates['end_date'] }],
+          metric_aggregations: [
+            ::Google::Analytics::Data::V1beta::MetricAggregation::TOTAL
+          ],
+          property: "properties/#{ga_property_id}",
+          dimension_filter: dimension_filter(path)
+        }
+      end
 
-      def exhibit_data(exhibit, options)
-        model.context(exhibit).results(site, Spotlight::Engine.config.ga_analytics_options.merge(options)).to_a.first || exhibit_data_unavailable
+      def dimension_filter(path)
+        Google::Analytics::Data::V1beta::FilterExpression.new(
+          filter: Google::Analytics::Data::V1beta::Filter.new(
+            field_name: 'pagePath',
+            string_filter: Google::Analytics::Data::V1beta::Filter::StringFilter.new(
+              match_type: :BEGINS_WITH,
+              value: path.to_s
+            )
+          )
+        )
       end
 
-      def page_data(exhibit, options)
-        options[:sort] ||= '-pageviews'
-        query = model.context(exhibit).results(site, Spotlight::Engine.config.ga_page_analytics_options.merge(options))
-        query.dimensions << :page_path
-        query.dimensions << :page_title
+      def search_params(path, dates)
+        params(path, dates).merge({ dimensions: [{ name: 'searchTerm' }],
+                                    metrics: [{ name: 'eventCount' }, { name: 'sessions' },
+                                              { name: 'screenPageViewsPerSession' }, { name: 'engagementRate' }],
+                                    order_bys: [{ metric: { metric_name: 'eventCount' },
+                                                  desc: true }] }).merge(Spotlight::Engine.config.ga_search_analytics_options)
+      end
 
-        query.to_a
+      def page_params(path, dates)
+        params(path, dates).merge({
+                                    dimensions: [{ name: 'pagePath' }, { name: 'pageTitle' }],
+                                    order_bys: [{ metric: { metric_name: 'screenPageViews' }, desc: true }],
+                                    metrics: [{ name: 'totalUsers' }, { name: 'activeUsers' },
+                                              { name: 'screenPageViews' }]
+                                  }).merge(Spotlight::Engine.config.ga_page_analytics_options)
       end
 
-      def user(scope = 'https://www.googleapis.com/auth/analytics.readonly')
-        @user ||= begin
-          Legato::User.new(oauth_token(scope))
-        rescue StandardError => e
-          Rails.logger.info(e)
-          nil
-        end
+      def report(params)
+        request = ::Google::Analytics::Data::V1beta::RunReportRequest.new(params)
+        client.run_report request
       end
 
-      def site
-        @site ||= user.accounts.first.profiles.find { |x| x.web_property_id == Spotlight::Engine.config.ga_web_property_id }
+      def page_data(path, dates)
+        metric_parsing(report(page_params(path, dates)))
       end
 
-      private
+      def parse_data(value)
+        if value.to_i.to_s == value
+          value.to_i.to_fs(:delimited)
+        elsif !!(value =~ /\A[-+]?\d*\.?\d+\z/)
+          value.to_f
+        else
+          value
+        end
+      end
 
-      def model
-        Spotlight::Analytics::GaModel
+      def exhibit_data(path, dates)
+        metric_parsing(report(search_params(path, dates)))
       end
 
-      def exhibit_data_unavailable
-        OpenStruct.new(pageviews: 'n/a', users: 'n/a', sessions: 'n/a')
+      def totals
+        OpenStruct.new(@report_data.totals[0].metric_values.each_with_index.with_object({}) do |(mv, index), result|
+          result[metric_headers[index]] = parse_data(mv.value)
+        end)
       end
 
-      def oauth_token(scope)
-        require 'oauth2'
+      # rubocop:disable Metrics/AbcSize
+      def rows
+        @report_data.rows.map do |row|
+          OpenStruct.new(row.dimension_values.each_with_index.with_object({}) do |(dv, index), result|
+            result[dimension_headers[index]] = parse_data(dv.value)
+          end.merge(row.metric_values.each_with_index.with_object({}) do |(mv, index), result|
+            result[metric_headers[index]] = parse_data(mv.value)
+          end))
+        end
+      end
+      # rubocop:enable Metrics/AbcSize
 
-        access_token = auth_client(scope).fetch_access_token!
-        OAuth2::AccessToken.new(oauth_client, access_token['access_token'], expires_in: access_token['expires_in'])
+      def metric_headers
+        @report_data.metric_headers.map(&:name)
       end
 
-      def oauth_client
-        OAuth2::Client.new('', '', authorize_url: 'https://accounts.google.com/o/oauth2/auth',
-                                   token_url: 'https://accounts.google.com/o/oauth2/token')
+      def dimension_headers
+        @report_data.dimension_headers.map(&:name)
       end
 
-      def signing_key
-        @signing_key ||= OpenSSL::PKCS12.new(File.read(Spotlight::Engine.config.ga_pkcs12_key_path), 'notasecret').key
+      def metric_parsing(report_data)
+        return OpenStruct.new({ totals: [], rows: [] }) unless report_data.rows.any?
+
+        @report_data = report_data
+
+        OpenStruct.new({ rows: rows, totals: totals })
       end
 
-      def auth_client(scope)
-        Signet::OAuth2::Client.new token_credential_uri: 'https://accounts.google.com/o/oauth2/token',
-                                   audience: 'https://accounts.google.com/o/oauth2/token',
-                                   scope: scope,
-                                   issuer: Spotlight::Engine.config.ga_email,
-                                   signing_key: signing_key,
-                                   sub: Spotlight::Engine.config.ga_email
+      private
+
+      def ga_property_id
+        Spotlight::Engine.config.ga_property_id
       end
     end
   end

data/app/models/spotlight/blacklight_configuration.rb

@@ -121,8 +121,15 @@ module Spotlight
         config.default_per_page = default_per_page if default_per_page
 
         config.view.embed!
-        config.view.embed.partials ||= ['openseadragon']
+        # This is blacklight-gallery's openseadragon partial
+        unless config.view.embed.document_component
+          config.view.embed.partials ||= ['openseadragon']
+          config.view.embed.document_component = Spotlight::SolrDocumentLegacyEmbedComponent
+        end
         config.view.embed.if = false
+
+        # blacklight-gallery requires tile_source_field
+        config.view.embed.tile_source_field ||= config.show.tile_source_field
         config.view.embed.locals ||= { osd_container_class: '' }
 
         # Add any custom fields

data/app/views/layouts/spotlight/base.html.erb

@@ -26,9 +26,9 @@
     <%= render partial: 'shared/body_preamble' %>
     <div id="skip-link">
       <% if should_render_spotlight_search_bar? %>
-        <%= link_to t('blacklight.skip_links.search_field'), '#search_field', class: 'element-invisible element-focusable rounded-bottom py-2 px-3' %>
+        <%= link_to t('blacklight.skip_links.search_field'), '#search_field', class: 'btn btn-link bg-light sr-only sr-only-focusable visually-hidden-focusable' %>
       <% end %>
-      <%= link_to t('blacklight.skip_links.main_content'), '#main-container', class: 'element-invisible element-focusable rounded-bottom py-2 px-3' %>
+      <%= link_to t('blacklight.skip_links.main_content'), '#main-container', class: 'btn btn-link bg-light sr-only sr-only-focusable visually-hidden-focusable' %>
       <%= content_for(:skip_links) %>
     </div>
 

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

@@ -1,12 +1,6 @@
-<nav class="navbar navbar-expand-md navbar-dark bg-dark topbar" role="navigation" aria-label="<%= t('spotlight.topbar.label') %>">
-  <div class="<%= container_classes %>">
-    <%= link_to application_name, main_app.root_path, class: 'mb-0 navbar-brand navbar-logo' %>
-    <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-bs-toggle="collapse" data-target="#user-util-collapse" data-bs-target="#user-util-collapse" aria-controls="user-util-collapse" aria-expanded="false" aria-label="<%= t :toggle_nav %>">
-      <span class="navbar-toggler-icon"></span>
-    </button>
-
-    <div class="collapse navbar-collapse justify-content-md-end" id="user-util-collapse">
-      <%= render partial: 'shared/user_util_links' %>
-    </div>
-  </div>
-</nav>
+<% if blacklight_config.header_component.present? && blacklight_config.header_component != Blacklight::HeaderComponent %>
+  <%= render blacklight_config.header_component.new(blacklight_config: blacklight_config) %>
+<% else %>
+  <%= render Spotlight::HeaderComponent.new(blacklight_config: blacklight_config) %>
+  <% Spotlight.deprecator.warn("_header_navbar.html.erb will be deprecated in future versions. Please use Blacklight configuration to specify your HeaderComponent.") %>
+<% end %>

data/app/views/spotlight/catalog/_admin_index_header_default.html.erb

@@ -1,4 +1,5 @@
 <%# header bar for doc items in index view -%>
+<%- Spotlight.deprecator.warn 'The partial _spotlight/catalog/admin_index_header_default.html.erb will be removed; customize the admin display using components instead' %>
 <div class="documentHeader row" data-label-toggle="<%= document.id %>">
   <%# main title container for doc partial view
       How many bootstrap columns need to be reserved

data/app/views/spotlight/catalog/_admin_thumbnail_default.html.erb

@@ -1,3 +1,4 @@
+<%- Spotlight.deprecator.warn 'The partial _spotlight/catalog/_admin_thumbnail.html.erb will be removed; customize the admin display using components instead' %>
 <% doc_presenter = document_presenter(document) %>
 <%- if doc_presenter.thumbnail.exists? %>
   <div class="document-thumbnail spotlight-admin-thumbnail">

data/app/views/spotlight/catalog/_document_admin_table.html.erb

@@ -1,4 +1,5 @@
 <% # container for all documents in index view -%>
+<% view_config = local_assigns[:view_config] || blacklight_config&.view_config(default_document_index_view_type) %>
 <table id="documents" class="table">
   <thead>
     <tr>
@@ -8,5 +9,11 @@
       <th scope="col" class="checkbox-toggle"><%= t(:'spotlight.catalog.fields.visibility') %></th>
     </tr>
   </thead>
-  <%= render partial: 'document_row', collection: documents, as: :document %>
+
+  <% if Blacklight.version < '8.0' %>
+    <%= render view_config.document_component.with_collection(documents) %>
+  <% else %>
+    <% document_presenters = documents.map { |doc| document_presenter(doc) } -%>
+    <%= render view_config.document_component.with_collection(document_presenters) %>
+  <% end %>
 </table>

data/app/views/spotlight/catalog/_document_row.html.erb

@@ -1,5 +1,2 @@
-<% # container for a single doc -%>
-<tr class="<%= render_document_class document %> doc-row" data-label-toggle="<%= document.id %>" itemscope itemtype="<%= document.itemtype %>">
-  <%= render_document_partials document, blacklight_config.view_config(document_index_view_type).partials, :document_counter => document_counter %>
-</tr>
-
+<%- Spotlight.deprecator.warn 'The partial _spotlight/catalog/_document_row.html.erb will be removed; customize the admin display using components instead' %>
+<%= render Spotlight::DocumentAdminTableComponent.new(presenter: document_presenter(document)) %>

data/app/views/spotlight/catalog/_index_compact_default.html.erb

@@ -1,3 +1,4 @@
+<%- Spotlight.deprecator.warn 'The partial _spotlight/catalog/_index_compact_default.html.erb will be removed; customize the admin display using components instead' %>
 <% # header bar for doc items in index view -%>
 <td>
   <%= render_document_partial document, 'admin_thumbnail', document_counter: document_counter %>

data/app/views/spotlight/catalog/edit.html.erb

@@ -1,3 +1,16 @@
-<div id="document" class="document <%= render_document_class %>" itemscope  itemtype="<%= @document.itemtype %>">
-  <%= render_document_partials @document, blacklight_config.view_config(:edit).partials %>
+<div class="container">
+  <div class="row">
+    <%- view_config = blacklight_config.view_config(action_name: :edit) %>
+    <%= render (view_config.document_component || Blacklight::DocumentComponent).new(presenter: document_presenter(@document), classes: ['col-md-8'], component: :div, show: true, actions: false, partials: view_config.partials) do |component| %>
+      <% component.with_title(as: 'h1', classes: '', link_to_document: false) %>
+      <% component.with_body do %>
+        <% view_config.partials.each do |view_partial| %>
+          <%= render_document_partial @document, view_partial, component: component, document_counter: 1 %>
+        <% end %>
+      <% end if Blacklight.version < '8.0' && view_config.document_component.blank? %>
+    <% end %>
+    <div class="col-md-4">
+      <%= render 'edit_default', document: @document %>
+    </div>
+  </div>
 </div>

data/app/views/spotlight/dashboards/analytics.html.erb

@@ -5,9 +5,9 @@
 <%= curation_page_title %>
 
 <% if current_exhibit.analytics_provider&.enabled? %>
-  <%= render 'analytics' %>
+  <%= render Spotlight::Analytics::DashboardComponent.new(current_exhibit: current_exhibit) %>
 <% else %>
   <div class="empty-page-block">
-    <p>In order to view exhibit analytics, the site administrator must <a href="https://github.com/projectblacklight/spotlight/wiki/Installation">configure an analytics provider.</a></p>
+    <p>In order to view exhibit analytics, the site administrator must configure an analytics provider.</p>
   </div>
 <% end %>

data/app/views/spotlight/pages/_view_type_group.html.erb

@@ -3,11 +3,8 @@
 <div class="view-type">
   <span class="sr-only visually-hidden"><%= t('blacklight.search.view_title') %></span>
   <div class="view-type-group btn-group">
-    <% views.each do |view, config| %>
-      <%= link_to url_for(search_state.to_h.merge(view: view)), :title => t("blacklight.search.view_title.#{view}", default: t("blacklight.search.view.#{view}", default: blacklight_config.view[view].title)), :class => "btn btn-outline-secondary view-type-#{ view.to_s.parameterize } #{"active" if block_document_index_view_type(block) == view}" do %>
-        <%= blacklight_icon config.icon || view %>
-        <span class="caption"><%= t("blacklight.search.view.#{view}") %></span>
-      <% end %>
+    <% views.each do |key, config| %>
+      <%= render Blacklight::Response::ViewTypeButtonComponent.new(key: key, view: config, selected: block_document_index_view_type(block) == key, search_state: search_state) %>
     <% end %>
   </div>
 </div>

data/app/views/spotlight/sir_trevor/blocks/_browse_group_categories_block.html.erb

@@ -11,10 +11,10 @@
         <% if group.searches.count > 1 %>
           <ul class="browse-group-categories-controls p-0 pt-2 pt-md-0 ml-md-auto ms-md-auto mb-0 d-flex justify-content-center align-items-end">
             <li class="prev px-1 overflow-hidden">
-              <%= blacklight_icon 'arrow-alt-circle-left' %>
+              <%= blacklight_icon 'arrow_alt_circle_left' %>
             </li>
             <li class="next px-1 overflow-hidden">
-              <%= blacklight_icon 'arrow-alt-circle-right' %>
+              <%= blacklight_icon 'arrow_alt_circle_right' %>
             </li>
           </ul>
         <% end %>

data/app/views/spotlight/sir_trevor/blocks/_embedded_document.html.erb

@@ -0,0 +1,8 @@
+<div class="box" data-id="<%= document.id %>">
+  <% view_config = blacklight_config.view_config(:embed) %>
+  <%= render (view_config.document_component || Spotlight::SolrDocumentLegacyEmbedComponent).new((Blacklight.version > '8.0' ? :document : :presenter) => document_presenter(document), counter: nil) do |component| %>
+    <% component.with_partial do %>
+      <%= render_document_partials document, view_config.partials, component: component, document_counter: nil, view_config: view_config, block: local_assigns[:block], **(view_config.locals) %>
+    <% end if view_config&.partials&.any? %>
+  <% end %>
+</div>

data/app/views/spotlight/sir_trevor/blocks/_solr_documents_embed_block.html.erb

@@ -11,10 +11,10 @@
         <% end %>
       <% end %>
       <div class="spotlight-flexbox">
+      <%# Render the openseadragon viewer from blacklight-gallery.
+        # Settings in blacklight_configuration.rb %>
         <% solr_documents_embed_block.each_document do |block_options, document| %>
-          <div class="box" data-id="<%= document.id %>">
-            <%= render_document_partials document, blacklight_config.view.embed.partials, (blacklight_config.view.embed.locals || {}).reverse_merge(block: solr_documents_embed_block) %>
-          </div>
+          <%= render '/spotlight/sir_trevor/blocks/embedded_document', document: document, block: solr_documents_embed_block %>
         <% end %>
       </div>
     </div>

data/app/views/spotlight/sir_trevor/blocks/_solr_documents_features_block.html.erb

@@ -25,7 +25,7 @@
                   <% caption_text = solr_documents_features_block.document_caption(doc_presenter, solr_documents_features_block.primary_caption_field, default: Spotlight::PageConfigurations::DOCUMENT_TITLE_KEY) %>
 
                   <a href="#" title="<%= caption_text %>">
-                    <%= truncate(caption_text, length: 95) %>
+                    <%= truncate(caption_text.to_s, length: 95) %>
                   </a>
                   <% if solr_documents_features_block.secondary_caption? %>
                     <p><%= solr_documents_features_block.document_caption(doc_presenter, solr_documents_features_block.secondary_caption_field) %></p>

data/config/locales/spotlight.en.yml

@@ -481,14 +481,26 @@ en:
         header: Add exhibit-specific field
     dashboards:
       analytics:
+        activeUsers: unique visits
+        engagementRate: engagement rate
         header: Analytics
-        monthly_header: User activity over the past month
+        no_results: There are no analytics for the path "%{pageurl}"
         pages:
           header: Most popular pages
-        pagetitle: page title
-        pageviews: page views
-        sessions: visitors
+        pagetitle: Page title
+        pageviews: Page views
+        reporting_period_heading: User activity over the past year
+        screenPageViews: page views
+        screenPageViewsPerSession: pages per session
+        searches:
+          header: Most used search terms
+          term: Search term
+          views: Searches
+        session_header: Sessions
+        sessions: sessions
+        totalUsers: visitors
         users: unique visits
+        visitor_header: Visitors
       page_activity:
         field:
           last_edited_by: User

data/lib/generators/spotlight/templates/catalog_controller.rb

@@ -13,6 +13,9 @@ class CatalogController < ApplicationController
       fl: '*'
     }
 
+    # Blacklight 8 sets a default value to 'advanced'
+    config.json_solr_path = nil
+    config.header_component = Spotlight::HeaderComponent
     config.document_solr_path = 'get'
     config.document_unique_id_param = 'ids'
 

data/lib/generators/spotlight/templates/config/initializers/spotlight_initializer.rb

@@ -42,21 +42,21 @@
 
 # ==> Uploaded item configuration
 # Spotlight::Engine.config.upload_fields = [
-#   UploadFieldConfig.new(
-#     field_name: config.upload_description_field,
-#     label: -> { I18n.t(:"spotlight.search.fields.#{config.upload_description_field}") },
+#   Spotlight::UploadFieldConfig.new(
+#     field_name: Spotlight::Engine.config.upload_description_field,
+#     label: -> { I18n.t(:"spotlight.search.fields.#{Spotlight::Engine.config.upload_description_field}") },
 #     form_field_type: :text_area
 #   ),
-#   UploadFieldConfig.new(
+#   Spotlight::UploadFieldConfig.new(
 #     field_name: :spotlight_upload_attribution_tesim,
 #     label: -> { I18n.t(:'spotlight.search.fields.spotlight_upload_attribution_tesim') }
 #   ),
-#   UploadFieldConfig.new(
+#   Spotlight::UploadFieldConfig.new(
 #     field_name: :spotlight_upload_date_tesim,
 #     label: -> { I18n.t(:'spotlight.search.fields.spotlight_upload_date_tesim') }
 #   )
 # ]
-# Spotlight::Engine.config.upload_title_field = nil # UploadFieldConfig.new(...)
+# Spotlight::Engine.config.upload_title_field = nil # Spotlight::UploadFieldConfig.new(...)
 # Spotlight::Engine.config.uploader_storage = :file
 # Spotlight::Engine.config.allowed_upload_extensions = %w(jpg jpeg png)
 
@@ -65,17 +65,21 @@
 
 # ==> Google Analytics integration
 # After creating a property for your site on Google Analytics, you need to:
-# a) register an OAuth service account with access to your analytics property:
-#     (https://github.com/tpitale/legato/wiki/OAuth2-and-Google#registering-for-api-access)
-# b) download the pkcs12 key and make it accessible to your application
-# c) set ga_web_property_id below to your site's property id
+# a) Enable Google Analytics API in https://console.cloud.google.com/
+# b) generate and download the JSON key and make it accessible to your application
+# (https://console.cloud.google.com/iam-admin/iam -> Service accounts -> click on service account -> keys)
+# c) set ga_property_id below to your site's property id (located in admin -> Property -> Property details upper right hand corner)
+# d) Set the ga_web_property_id. (located in admin -> Data collection and modification -> Web stream details and begins with G-)
+# ga_property_id is used for fetching analytics data from google's api, ga_web_property_id is used for sending events to GA analtyics
+# ga_web_property_id will probably change in V5 to ga_measurement_id for clarity
 # Rails.application.config.to_prepare do
 #   Spotlight::Engine.config.analytics_provider = Spotlight::Analytics::Ga
-#   Spotlight::Engine.config.ga_pkcs12_key_path = nil
+#   Spotlight::Engine.config.ga_json_key_path = nil
 #   Spotlight::Engine.config.ga_web_property_id = 'G-XXXXXXXXXX'
-#   Spotlight::Engine.config.ga_email = 'test@example.com'
+#   Spotlight::Engine.config.ga_property_id = '12345678'
 #   Spotlight::Engine.config.ga_analytics_options = {}
 #   Spotlight::Engine.config.ga_page_analytics_options = Spotlight::Engine.config.ga_analytics_options.merge(limit: 5)
+#   Spotlight::Engine.config.ga_search_analytics_options = Spotlight::Engine.config.ga_analytics_options.merge(limit: 11)
 #   Spotlight::Engine.config.ga_debug_mode = false
 # end
 

data/lib/spotlight/engine.rb

@@ -196,14 +196,16 @@ module Spotlight
     end
 
     # After creating a property for your site on Google Analytics, you need to:
-    # a) register an OAuth service account with access to your analytics property:
-    #     (https://github.com/tpitale/legato/wiki/OAuth2-and-Google#registering-for-api-access)
-    # b) download the pkcs12 key and make it accessible to your application
-    # c) in e.g. an initializer, set these configuration values as appropriate
-    #    to your OAuth2 service account and analytics property:
-    config.ga_pkcs12_key_path = nil
+    # a) Enable Google Analytics API in https://console.cloud.google.com/
+    # b) generate and download the JSON key and make it accessible to your application
+    # (https://console.cloud.google.com/iam-admin/iam -> Service accounts -> click on service account -> keys)
+    # c) set ga_property_id below to your site's property id (located in admin -> Property -> Property details upper right hand corner)
+    # d) Set the ga_web_property_id. (located in admin -> Data collection and modification -> Web stream details and begins with G-)
+    # ga_property_id is used for fetching analytics data from google's api, ga_web_property_id is used for sending events to GA analtyics
+    # ga_web_property_id will probably change in V5 to ga_measurement_id for clarity
+    config.ga_json_key_path = nil
     config.ga_web_property_id = nil
-    config.ga_email = nil
+    config.ga_property_id = nil
     config.ga_analytics_options = {}
     config.ga_page_analytics_options = config.ga_analytics_options.merge(limit: 5)
     config.ga_debug_mode = false
@@ -271,7 +273,7 @@ module Spotlight
         Blacklight::Configuration.property :browse, default: Blacklight::OpenStructWithHashAccess.new(document_actions: [])
 
         Blacklight::Configuration.default_values[:search_state_fields] ||= []
-        Blacklight::Configuration.default_values[:search_state_fields] += %i[id exhibit_id]
+        Blacklight::Configuration.default_values[:search_state_fields] += %i[id exhibit_id browse_category_id]
       end
     else
       config.to_prepare do
@@ -284,7 +286,7 @@ module Spotlight
         Blacklight::Configuration.default_values[:browse] ||= Blacklight::OpenStructWithHashAccess.new(document_actions: [])
 
         Blacklight::Configuration.default_values[:search_state_fields] ||= []
-        Blacklight::Configuration.default_values[:search_state_fields] += %i[id exhibit_id]
+        Blacklight::Configuration.default_values[:search_state_fields] += %i[id exhibit_id browse_category_id]
       end
     end
 

data/lib/spotlight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spotlight
-  VERSION = '4.0.2'
+  VERSION = '4.1.0'
 end

data/lib/spotlight.rb

@@ -6,4 +6,7 @@ require 'spotlight/engine'
 ##
 # Spotlight
 module Spotlight
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new('5.0', 'blacklight-spotlight')
+  end
 end

data/spec/support/features/test_features_helpers.rb

@@ -54,7 +54,7 @@ module Spotlight
       first('.st-block-replacer').click
     end
 
-    def save_page
+    def save_page_changes
       page.execute_script <<-EOF
         SirTrevor.getInstance().onFormSubmit();
       EOF