blacklight-spotlight 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bff0876109f9e68d8dcadddb01e465330d67d25
-  data.tar.gz: 9f7f3daa3104c882c01e8edc24731d8e5fd9401f
+  metadata.gz: 797e808c409dd777422ae85313b3730de6bd0cd3
+  data.tar.gz: 95908a121831207677ffe422e1b67cb5a451bca1
 SHA512:
-  metadata.gz: f27a7aab2b68144eeecd58b51b98fbaf9d78bafb38a780eecdf5a7efe74c3aefe299e4e05f4da8f5fd0251d2422bf8a45e43b6c83b7379768280e6aa0edb72d5
-  data.tar.gz: 85db41321a6ba7e8baaa8db613bb149d88b6afaf9689bbb27c2c7538dba062e79d66a86902b6b8f9dfe0e2a519c9ad79e67a72ecb4009b454507027b288219c9
+  metadata.gz: 2789c3565185605cb60facf97aa1958825d121d4e412d989bb77ba9df20460211236a269812703457624b3d55d152acab312da275a78e601c061cb70aada9d58
+  data.tar.gz: ee69b30eb9115c7e96f1cd853cce54949d1f42fe8d9b94cce4eea451308532bbaa2c440570d51fea763e4edb777789bd430bd794058510782f1eaef5a48a9b32

data/README.md

@@ -42,16 +42,10 @@ Run the database migrations:
 $ rake db:migrate
 ```
 
-Start solr:
+Start Solr and the Rails development server:
 
 ```
-$ rake jetty:start
-```
-
-Start the rails development server:
-
-```
-$ rails s
+$ rake spotlight:server
 ```
 
 Go to http://localhost:3000 in your browser.
@@ -72,7 +66,7 @@ See the [Spotlight wiki](https://github.com/projectblacklight/spotlight/wiki) fo
 Spotlight:
 
 * is a Rails engine and needs to be used in the context of a Rails application. We use [engine_cart](https://github.com/cbeer/engine_cart) to create an internal test application at .internal_test_app/
-* uses Solr as part of its integration tests. We use [jettywrapper](https://github.com/projecthydra/jettywrapper) to manage the Solr instance used for development and test.
+* uses Solr as part of its integration tests. We use [solr_wrapper](https://github.com/cbeer/solr_wrapper) to manage the Solr instance used for development and test.
 
 Our `$ rake ci` and `$ rake spotlight:server` tasks utilize Solr and the testing rails app automatically.
 

data/app/assets/javascripts/spotlight/blocks/browse_block.js

@@ -12,6 +12,7 @@ SirTrevor.Blocks.Browse = (function(){
 
     item_options: function() { return [
       '<label>',
+        '<input type="hidden" name="display-item-counts" value="false" />',
         '<input type="checkbox" name="display-item-counts" value="true" checked />',
         '<%= i18n.t("blocks:browse:item_counts") %>',
       '</label>'

data/app/assets/stylesheets/spotlight/_bootstrap_overrides.scss

@@ -85,7 +85,7 @@ label.radio {
   legend {
     margin-bottom: $padding-large-vertical;
   }
-  div.radio + div input, div.radio + input[type="file"] {
+  div.radio + input[type="file"] {
     margin-top: $padding-large-vertical;
   }
 }

data/app/assets/stylesheets/spotlight/_multi_up_item_grid.scss

@@ -43,6 +43,7 @@
 
     @media (max-width: $screen-xs-max) {
       min-width: 200px;
+      -webkit-flex: 1 1 200px;
     }
 
     .caption {
@@ -57,5 +58,6 @@
     -webkit-flex: 1;
     -ms-flex: 1;
     flex: 1;
+    -webkit-flex: 1 1 125px;
   }
 }

data/app/assets/stylesheets/spotlight/_pages.scss

@@ -238,12 +238,14 @@
 
     .box {
       min-width: 150px;
+      -webkit-flex: 1 1 150px;
     }
 
     /* two items */
     .box:first-child:nth-last-child(2),
     .box:first-child:nth-last-child(2) ~ .box {
-        min-width: 250px;
+      min-width: 250px;
+      -webkit-flex: 1 1 250px;
     }
 
     /* only images, no text */
@@ -257,6 +259,10 @@
             height: 175px;
           }
         }
+
+        @media (max-width: $screen-sm-max) {
+          -webkit-flex: 1 1 175px;
+        }
       }
     }
   }

data/app/controllers/spotlight/contact_forms_controller.rb

@@ -11,11 +11,7 @@ module Spotlight
 
     def create
       if @contact_form.valid?
-        if @contact_form.respond_to? :deliver_now
-          @contact_form.deliver_now
-        else
-          @contact_form.deliver
-        end
+        ContactMailer.report_problem(@contact_form).deliver_now
 
         redirect_to :back, notice: t(:'helpers.submit.contact_form.created')
       else

data/app/controllers/spotlight/searches_controller.rb

@@ -94,7 +94,13 @@ module Spotlight
     end
 
     def search_params
-      params.require(:search).permit(:title, :long_description, masthead_attributes: featured_image_attributes, thumbnail_attributes: featured_image_attributes)
+      params.require(:search).permit(
+        :title,
+        :long_description,
+        :default_index_view_type,
+        masthead_attributes: featured_image_attributes,
+        thumbnail_attributes: featured_image_attributes
+      )
     end
 
     def featured_image_attributes

data/app/helpers/spotlight/browse_helper.rb

@@ -3,16 +3,31 @@ module Spotlight
   # Helper for browse views
   module BrowseHelper
     include ::BlacklightConfigurationHelper
+    def document_index_view_type
+      if @search && @search.default_index_view_type.present? && params[:view].blank?
+        blacklight_config.view[@search.default_index_view_type].key
+      else
+        super
+      end
+    end
 
     ##
     # Override Blacklight's #default_document_index_view_type helper to
     # use a different default view when presenting browse categories
     def default_document_index_view_type
-      (default_browse_index_view_type if blacklight_config.view.key? default_browse_index_view_type) || super
+      if view_available? default_browse_index_view_type
+        default_browse_index_view_type
+      else
+        super
+      end
     end
 
     private
 
+    def view_available?(view)
+      blacklight_config.view.key?(view) && blacklight_configuration_context.evaluate_if_unless_configuration(blacklight_config.view)
+    end
+
     def default_browse_index_view_type
       Spotlight::Engine.config.default_browse_index_view_type
     end

data/app/helpers/spotlight/searches_helper.rb

@@ -0,0 +1,8 @@
+module Spotlight
+  # Saved search helpers
+  module SearchesHelper
+    def available_document_index_views
+      blacklight_config.view.select { |_k, v| v.if != false }.keys
+    end
+  end
+end

data/app/mailers/spotlight/contact_mailer.rb

@@ -0,0 +1,9 @@
+module Spotlight
+  # Mailer for reporting problems to the application contact and/or exhibit administrator
+  class ContactMailer < ActionMailer::Base
+    def report_problem(contact_form)
+      @contact_form = contact_form
+      mail(@contact_form.headers)
+    end
+  end
+end

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

@@ -1,10 +1,11 @@
+require 'signet/oauth_2/client'
+require 'legato'
+
 module Spotlight
   module Analytics
     ##
     # Google Analytics data provider for the curation dashboard
     class Ga
-      require 'legato'
-
       extend Legato::Model
 
       cattr_writer :user, :site
@@ -62,7 +63,8 @@ module Spotlight
       def self.oauth_token(scope)
         require 'oauth2'
 
-        OAuth2::AccessToken.new(oauth_client, api_client(scope).authorization.access_token, expires_in: 1.hour)
+        access_token = auth_client(scope).fetch_access_token!
+        OAuth2::AccessToken.new(oauth_client, access_token['access_token'], expires_in: access_token['expires_in'])
       end
 
       def self.oauth_client
@@ -70,21 +72,17 @@ module Spotlight
                                    token_url: 'https://accounts.google.com/o/oauth2/token')
       end
 
-      def self.service_account(scope)
-        @service_account ||= begin
-          oauth_key = Google::APIClient::PKCS12.load_key(Spotlight::Engine.config.ga_pkcs12_key_path, 'notasecret')
-          Google::APIClient::JWTAsserter.new(Spotlight::Engine.config.ga_email, scope, oauth_key)
-        end
+      def self.signing_key
+        @signing_key ||= OpenSSL::PKCS12.new(File.read(Spotlight::Engine.config.ga_pkcs12_key_path), 'notasecret').key
       end
 
-      def self.api_client(scope)
-        require 'google/api_client'
-        client = Google::APIClient.new(
-          application_name: 'spotlight',
-          application_version: Spotlight::VERSION
-        )
-        client.authorization = service_account(scope).authorize
-        client
+      def self.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
       end
     end
   end

data/app/models/spotlight/blacklight_configuration.rb

@@ -97,7 +97,7 @@ module Spotlight
             set_index_field_defaults(v)
           end
           v.upstream_if = v.if unless v.if.nil?
-          v.if = :field_enabled?
+          v.if = :field_enabled? unless v.if == false
 
           v.normalize! config
           v.validate!
@@ -115,7 +115,7 @@ module Spotlight
           end
 
           v.upstream_if = v.if unless v.if.nil?
-          v.if = :field_enabled?
+          v.if = :field_enabled? unless v.if == false
 
           v.normalize! config
           v.validate!
@@ -128,7 +128,7 @@ module Spotlight
 
           config.search_fields.each do |k, v|
             v.upstream_if = v.if unless v.if.nil?
-            v.if = :field_enabled?
+            v.if = :field_enabled? unless v.if == false
             next if search_fields[k].blank?
 
             v.merge! search_fields[k].symbolize_keys
@@ -142,7 +142,7 @@ module Spotlight
 
           config.sort_fields.each do |k, v|
             v.upstream_if = v.if unless v.if.nil?
-            v.if = :field_enabled?
+            v.if = :field_enabled? unless v.if == false
             next if sort_fields[k].blank?
 
             v.merge! sort_fields[k].symbolize_keys
@@ -161,7 +161,7 @@ module Spotlight
             v.merge! facet_fields[k].symbolize_keys
             v.upstream_if = v.if unless v.if.nil?
             v.enabled = v.show
-            v.if = :field_enabled?
+            v.if = :field_enabled? unless v.if == false
             v.normalize! config
             v.validate!
           end
@@ -177,7 +177,7 @@ module Spotlight
         config.view.each do |k, v|
           v.key = k
           v.upstream_if = v.if unless v.if.nil?
-          v.if = :enabled_in_spotlight_view_type_configuration?
+          v.if = :enabled_in_spotlight_view_type_configuration? unless v.if == false
         end unless document_index_view_types.blank?
 
         if config.search_fields.blank?

data/app/models/spotlight/contact_form.rb

@@ -1,24 +1,26 @@
-require 'mail_form'
-
 module Spotlight
   ##
   # Exhibit feedback form
-  class ContactForm < MailForm::Base
-    attribute :current_exhibit
-    attribute :name, validate: false
-    attribute :email, validate: /\A([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})\z/i
-    attribute :message
-    attribute :current_url
+  class ContactForm
+    include ActiveModel::Model
+
+    attr_accessor :current_exhibit, :name, :email, :message, :current_url, :request
 
-    append :remote_ip, :user_agent
+    validates :email, format: { with: /\A([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})\z/i }
 
     def headers
       {
+        to: to,
         subject: "#{I18n.t(:'blacklight.application_name')} Contact Form",
-        to: Spotlight::Engine.config.default_contact_email || current_exhibit.contact_emails.first.to_s,
         from: %("#{name}" <#{email}>),
         cc: current_exhibit.contact_emails.join(', ')
       }
     end
+
+    private
+
+    def to
+      Spotlight::Engine.config.default_contact_email || current_exhibit.contact_emails.first.to_s
+    end
   end
 end

data/app/services/spotlight/carrierwave_file_resolver.rb

@@ -0,0 +1,8 @@
+module Spotlight
+  # Used by RIIIF to find files uploaded by carrierwave
+  class CarrierwaveFileResolver < Riiif::AbstractFileSystemResolver
+    def pattern(id)
+      Spotlight::FeaturedImage.find(id).image.file.file
+    end
+  end
+end

data/app/views/spotlight/browse/show.html.erb

@@ -15,6 +15,10 @@
 
 <div class="col-md-12">
   <%= render 'sort_and_per_page' %>
-  <%= render_document_index(@document_list) %>
+  <% if @search.default_index_view_type && params[:view].blank? %>
+    <%= render_document_index_with_view(@search.default_index_view_type, @document_list) %>
+  <% else %>
+    <%= render_document_index(@document_list) %>
+  <% end %>
   <%= render 'results_pagination' %>
 </div>

data/app/views/spotlight/contact_mailer/report_problem.html.erb

@@ -0,0 +1,14 @@
+<p><%= @contact_form.name %></p>
+<p>From: <%= %("#{@contact_form.name}" <#{@contact_form.email}>) %></p>
+
+<p><%= @contact_form.message %></p>
+
+----
+
+<dl>
+  <dt>REMOTE_IP</dt><dd><%= @contact_form.request.remote_ip %></dd>
+  <dt>USER AGENT</dt><dd><%= @contact_form.request.user_agent %></dd>
+  <dt>EXHIBIT</dt><dd><%= @contact_form.current_exhibit.title %></dd>
+  <dt>CURRENT_URL</dt><dd><%= @contact_form.current_url %></dd>
+  <dt>UUID</dt><dd><%= @contact_form.request.uuid %></dd>
+</dl>

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

@@ -7,9 +7,7 @@
     <%= render 'analytics' %>
   <% else %>
     <div class="empty-page-block">
-      <% unless current_user %>
-        <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>
-      <% end %>
+      <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>
     </div>
   <% end %>
 </div>

data/app/views/spotlight/searches/_form.html.erb

@@ -30,6 +30,11 @@
       <div role="tabpanel" class="tab-pane active" id="search-description">
         <%= f.text_field :title, control_col: "col-sm-5" %>
         <%= f.text_area :long_description, rows: 5 %>
+        <%= f.form_group label: { text: t(:".default_index_view_type") } do %>
+          <% available_document_index_views.each do |view| %>
+            <%= f.radio_button :default_index_view_type, view, label: view_label(view) %>
+          <% end %>
+        <% end %>
         <%= f.static_control label: t(:".query_params") do %>
           <div class="well well-sm">
             <%= render_constraints(@search.query_params) %>

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

@@ -5,6 +5,7 @@
 
     <div class="items-col spotlight-flexbox pull-<%= solr_documents_block.content_align %> <%= solr_documents_block.text? ? "col-md-6" : "col-md-12" %> ">
       <% solr_documents_block.each_document do |block_options, document| %>
+        <% doc_presenter = index_presenter(document) %>
         <div class="box" data-id="<%= document.id %>">
           <div class="contents">
             <% if block_thumb = block_options[:thumbnail_image_url] %>
@@ -14,12 +15,12 @@
             <% end %>
             <% if solr_documents_block.primary_caption? %>
               <div class="caption primary-caption">
-                <%= render_index_field_value document, solr_documents_block.primary_caption_field %>
+                <%= doc_presenter.field_value solr_documents_block.primary_caption_field %>
               </div>
             <% end %>
             <% if solr_documents_block.secondary_caption? %>
               <div class="caption secondary-caption">
-                <%= render_index_field_value document, solr_documents_block.secondary_caption_field %>
+                <%= doc_presenter.field_value solr_documents_block.secondary_caption_field %>
               </div>
             <% end %>
           </div>
@@ -36,4 +37,4 @@
       <%= sir_trevor_markdown solr_documents_block.text %>
     </div>
   <% end %>
-</div>
+</div>

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

@@ -6,6 +6,7 @@
   <div id="<%= html_id %>" class="carousel slide" data-ride="carousel"  data-interval="<%= solr_documents_carousel_block.interval %>">
     <div class="carousel-inner">
     <% solr_documents_carousel_block.each_document.each_with_index do |(block_options, document), index| %>
+      <% doc_presenter = index_presenter(document) %>
       <div class="item <%= 'active' if index == 0 %>" data-id="<%= document.id %>">
         <% if block_thumb = block_options[:full_image_url] %>
           <%= link_to_document(document, image_tag(block_thumb), counter: -1) %>
@@ -15,12 +16,12 @@
         <div class="carousel-caption">
           <% if solr_documents_carousel_block.primary_caption? %>
             <h3 class="primary">
-              <%= render_index_field_value document, solr_documents_carousel_block.primary_caption_field %>
+              <%= doc_presenter.field_value solr_documents_carousel_block.primary_caption_field %>
             </h3>
           <% end %>
           <% if solr_documents_carousel_block.secondary_caption? %>
             <div class="secondary">
-              <%= render_index_field_value document, solr_documents_carousel_block.secondary_caption_field %>
+              <%= doc_presenter.field_value solr_documents_carousel_block.secondary_caption_field %>
             </div>
           <% end %>
         </div>