blacklight-spotlight 0.2.0 → 0.3.0

data/db/migrate/20150127173245_add_featured_image_to_exhibit.rb

@@ -0,0 +1,5 @@
+class AddFeaturedImageToExhibit < ActiveRecord::Migration
+  def change
+    add_column :spotlight_exhibits, :featured_image, :string
+  end
+end

data/db/migrate/20150217111511_add_polymorphic_document_to_sidecars.rb

@@ -0,0 +1,26 @@
+class AddPolymorphicDocumentToSidecars < ActiveRecord::Migration
+  def change
+    add_column :spotlight_solr_document_sidecars, :document_id, :string
+    add_column :spotlight_solr_document_sidecars, :document_type, :string
+
+    reversible do |dir|
+      dir.up do
+        Spotlight::SolrDocumentSidecar.find_each do |e|
+          e.document = SolrDocument.new(id: e.solr_document_id)
+          e.save!
+        end
+      end
+
+      dir.down do
+        Spotlight::SolrDocumentSidecar.find_each do |e|
+          e.solr_document_id = e.document_id
+          e.save!
+        end
+      end
+    end
+
+    remove_column :spotlight_solr_document_sidecars, :solr_document_id
+
+    add_index :bookmarks, [:document_type, :document_id]
+  end
+end

data/db/migrate/20150224071743_add_spotlight_mastheads.rb

@@ -0,0 +1,17 @@
+class AddSpotlightMastheads < ActiveRecord::Migration
+  def change
+    create_table :spotlight_mastheads do |t|
+      t.boolean :display
+      t.string :image
+      t.string :source
+      t.string :document_global_id
+      t.integer :image_crop_x, :integer
+      t.integer :image_crop_y, :integer
+      t.integer :image_crop_w, :integer
+      t.integer :image_crop_h, :integer
+      t.references :exhibit
+      t.timestamps
+    end
+    add_index :spotlight_mastheads, :exhibit_id
+  end
+end

data/lib/generators/spotlight/install_generator.rb

@@ -21,6 +21,10 @@ module Spotlight
       generate "friendly_id"
     end
 
+    def paper_trail
+      generate 'paper_trail:install'
+    end
+
     def assets
       copy_file "spotlight.scss", "app/assets/stylesheets/spotlight.scss"
       copy_file "spotlight.js", "app/assets/javascripts/spotlight.js"
@@ -42,22 +46,32 @@ module Spotlight
     end
 
     def add_model_mixin
-      inject_into_file 'app/models/solr_document.rb', after: "include Blacklight::Solr::Document" do
-       "\n  include Spotlight::SolrDocument\n"
+      if File.exists? 'app/models/solr_document.rb'
+        inject_into_file 'app/models/solr_document.rb', after: "include Blacklight::Solr::Document" do
+         "\n  include Spotlight::SolrDocument\n"
+        end
+      else
+        say "Unable to find SolrDocument class; add `include Spotlight::SolrDocument` to the class manually"
       end
     end
 
     def add_solr_indexing_mixin
-      inject_into_file 'app/models/solr_document.rb', after: "include Spotlight::SolrDocument\n" do
-       "\n  include #{options[:solr_update_class]}\n"
+      if File.exists? 'app/models/solr_document.rb'
+        inject_into_file 'app/models/solr_document.rb', after: "include Spotlight::SolrDocument\n" do
+         "\n  include #{options[:solr_update_class]}\n"
+        end
+      else
+        say "Unable to find SolrDocument class; add `include #{options[:solr_update_class]}` to the class manually"
       end
     end
 
     def add_osd_viewer
+      gem 'blacklight-gallery'
       generate 'blacklight_gallery:install'
     end
 
     def add_oembed
+      gem 'blacklight-oembed'
       generate 'blacklight_oembed:install'
     end
 

data/lib/spotlight.rb

@@ -1,3 +1,4 @@
+require "spotlight/version"
 require "spotlight/engine"
 
 module Spotlight
@@ -5,5 +6,4 @@ module Spotlight
   require 'spotlight/base'
   require 'spotlight/controller'
   require 'spotlight/catalog'
-  require 'spotlight/document_presenter'
 end

data/lib/spotlight/base.rb

@@ -14,12 +14,14 @@ module Spotlight
       document_list.map do |doc|
         {
           id: doc.id,
-          title: view_context.presenter(doc).raw_document_heading,
+          title: CGI.unescapeHTML(view_context.presenter(doc).document_heading.to_str),
           thumbnail: doc.first(blacklight_config.index.thumbnail_field),
-          thumbnails: doc[blacklight_config.index.thumbnail_field],
+          thumbnails: doc.spotlight_image_versions.try(:thumb) || doc[blacklight_config.index.thumbnail_field],
+          full_images: doc.spotlight_image_versions.try(:full),
           description: doc.id,
           url: exhibit_catalog_path(current_exhibit, doc),
-          private: doc.private?(current_exhibit)
+          private: doc.private?(current_exhibit),
+          global_id: doc.to_global_id.to_s
         }
       end
     end

data/lib/spotlight/catalog.rb

@@ -16,7 +16,7 @@ module Spotlight
                   query: {
                     private: { 
                       label: I18n.t(:'spotlight.catalog.facets.exhibit_visibility.private'), 
-                      fq: "#{SolrDocument.visibility_field(current_exhibit)}:false" }
+                      fq: "#{Spotlight::SolrDocument.visibility_field(current_exhibit)}:false" }
                   }
         end
       end

data/lib/spotlight/catalog/access_controls_enforcement.rb

@@ -2,13 +2,20 @@ module Spotlight::Catalog::AccessControlsEnforcement
   extend ActiveSupport::Concern
 
   included do
-    self.solr_search_params_logic << :apply_permissive_visibility_filter
+    self.solr_search_params_logic += [:apply_permissive_visibility_filter]
   end
 
   protected
 
   def apply_permissive_visibility_filter solr_params, user_params
-    return if respond_to? :can? and can? :curate, current_exhibit
-    solr_params.append_filter_query "-#{Spotlight::SolrDocument.visibility_field(current_exhibit)}:false"
+    return unless current_exhibit
+
+    unless respond_to? :can? and can? :curate, current_exhibit
+      solr_params.append_filter_query "-#{Spotlight::SolrDocument.visibility_field(current_exhibit)}:false"
+    end
+
+    if Spotlight::Engine.config.filter_resources_by_exhibit
+      add_facet_fq_to_solr solr_params, f: current_exhibit.solr_data
+    end
   end
 end

data/lib/spotlight/engine.rb

@@ -3,10 +3,10 @@ require 'blacklight'
 require 'blacklight/oembed'
 require 'autoprefixer-rails'
 require 'spotlight/rails/routes'
-require 'spotlight/utils'
 require 'friendly_id'
 require 'devise'
-require 'active_model_serializers'
+require 'tophat'
+require 'paper_trail'
 
 module Spotlight
   class Engine < ::Rails::Engine
@@ -36,9 +36,22 @@ module Spotlight
       OEmbed::Providers.register_all
     end
 
+    def self.catalog_controller
+      @catalog_controller ||= Spotlight::Engine.config.catalog_controller_class.constantize
+    end
+
+    def self.blacklight_config
+      Spotlight::Engine.config.default_blacklight_config || catalog_controller.blacklight_config
+    end
+
+    Spotlight::Engine.config.catalog_controller_class = "::CatalogController"
+    Spotlight::Engine.config.default_blacklight_config = nil
+
+    Spotlight::Engine.config.exhibit_main_navigation = [:curated_features, :browse, :about]
+
     Spotlight::Engine.config.resource_providers = []
     Spotlight::Engine.config.new_resource_partials = [] # e.g. "spotlight/resources/bookmarklet"
-
+    Spotlight::Engine.config.filter_resources_by_exhibit = false
     # The allowed file extensions for uploading non-repository items.
     Spotlight::Engine.config.allowed_upload_extensions = %w(jpg jpeg png)
     
@@ -51,16 +64,45 @@ module Spotlight
 
     # The solr field that original (largest) images will be stored.
     Spotlight::Engine.config.full_image_field = :full_image_url_ssm
+    Spotlight::Engine.config.thumbnail_field = :thumbnail_url_ssm
+    Spotlight::Engine.config.square_image_field = :thumbnail_square_url_ssm
 
     Spotlight::Engine.config.uploaded_description_field = :spotlight_upload_description_tesim
     Spotlight::Engine.config.uploaded_attribution_field = :spotlight_upload_attribution_tesim
     Spotlight::Engine.config.uploaded_date_field = :spotlight_upload_date_tesim
 
-    Spotlight::Engine.config.upload_fields = {
-      description: OpenStruct.new(solr_field: Spotlight::Engine.config.uploaded_description_field, form_field_type: :text_area),
-      attribution: OpenStruct.new(solr_field: Spotlight::Engine.config.uploaded_attribution_field),
-      date:        OpenStruct.new(solr_field: Spotlight::Engine.config.uploaded_date_field)
-    }
+    # Defaults to the blacklight_config.index.title_field:
+    Spotlight::Engine.config.upload_title_field = nil # OpenStruct.new(...)
+
+    Spotlight::Engine.config.upload_fields = [
+      OpenStruct.new(field_name: Spotlight::Engine.config.uploaded_description_field, form_field_type: :text_area),
+      OpenStruct.new(field_name: Spotlight::Engine.config.uploaded_attribution_field),
+      OpenStruct.new(field_name: Spotlight::Engine.config.uploaded_date_field)
+    ]
+
+    # To present curators with analytics reports on the exhibit dashboard, you need to configure
+    # an Analytics provider. Google Analytics support is provided out-of-the-box.
+    Spotlight::Engine.config.analytics_provider = nil
+
+    initializer "analytics.initialize" do
+      Spotlight::Engine.config.analytics_provider = Spotlight::Analytics::Ga
+    end
+
+    # If you use Google Analytics, you need to wire your site to report to a Google Analytics property.
+    # Adding Google Analytics to your site is left as an excersize for the implementor (you could
+    # consider overriding the layout to inject GA code..)
+    #
+    # After getting your site to report to 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:
+    Spotlight::Engine.config.ga_pkcs12_key_path = nil
+    Spotlight::Engine.config.ga_web_property_id = nil
+    Spotlight::Engine.config.ga_email = nil
+    Spotlight::Engine.config.ga_analytics_options = { }
+    Spotlight::Engine.config.ga_page_analytics_options = Spotlight::Engine.config.ga_analytics_options.merge(limit: 5)
 
     Blacklight::Engine.config.inject_blacklight_helpers = false
     

data/lib/spotlight/version.rb

@@ -1,3 +1,3 @@
 module Spotlight
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/tasks/spotlight_tasks.rake

@@ -93,6 +93,19 @@ namespace :spotlight do
 
       exit 1 if errors > 0
     end
-end
+  end
+
+  task :reindex, [:exhibit_slug] => :environment do |_, args|
+    exhibits = if args[:exhibit_slug]
+      Spotlight::Exhibit.where(slug: args[:exhibit_slug])
+    else
+      Spotlight::Exhibit.all
+    end
+
+    exhibits.find_each do |e|
+      puts " == Reindexing #{e.title} =="
+      e.reindex_later
+    end
+  end
 
 end

data/spec/controllers/spotlight/about_pages_controller_spec.rb

@@ -95,6 +95,7 @@ describe Spotlight::AboutPagesController, :type => :controller do
         put :update, id: page, exhibit_id: page.exhibit.id, about_page: valid_attributes
         page.reload
         expect(response).to redirect_to(exhibit_about_page_path(page.exhibit, page))
+        expect(flash[:notice]).to have_link "Undo changes"
       end
     end
     describe "POST update_all" do

data/spec/controllers/spotlight/appearances_controller_spec.rb

@@ -44,22 +44,12 @@ describe Spotlight::AppearancesController, :type => :controller do
         patch :update, exhibit_id: exhibit, appearance: { 
           document_index_view_types: {"list"=>"1", "gallery"=>"1", "map"=>"0"},
           default_per_page: "50",
-          sort_fields: {"relevance"=>{"enabled" => "1", "label" => "Relevance"}, "title"=>{"enabled" => "1", "label" => "Title"}, "type"=>{"enabled" => "1", "label" => "Type"}, "date"=>{"enabled" => "0", "label" => "Date"}, "source"=>{"enabled" => "0", "label" => "Source"}, "identifier"=>{"enabled" => "0", "label" => "Identifier"}}
         }
         expect(flash[:notice]).to eq "The appearance was successfully updated."
         expect(response).to redirect_to edit_exhibit_appearance_path(exhibit)
         assigns[:exhibit].tap do |saved|
           expect(saved.blacklight_configuration.document_index_view_types).to eq ['list', 'gallery']
           expect(saved.blacklight_configuration.default_per_page).to eq 50
-          expect(saved.blacklight_configuration.sort_fields).to eq(
-            {"relevance" => {"label"=>"Relevance", "enabled"=>true},
-             "title" => {"label" => "Title", "enabled"=>true},
-             "type" => {"label" => "Type", "enabled"=>true},
-             "date" => {"label" => "Date", "enabled"=>false},
-             "source" => {"label" => "Source", "enabled"=>false},
-             "identifier" => {"label" => "Identifier", "enabled"=>false}
-            }
-          )
         end
       end
     end

data/spec/controllers/spotlight/blacklight_configurations_controller_spec.rb

@@ -75,6 +75,16 @@ describe Spotlight::BlacklightConfigurationsController, :type => :controller do
       end
     end
 
+    describe "#edit_sort_fields" do
+      it "should be successful" do
+        expect(controller).to receive(:add_breadcrumb).with("Home", exhibit)
+        expect(controller).to receive(:add_breadcrumb).with("Curation", exhibit_dashboard_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with("Sort fields", exhibit_edit_sort_fields_path(exhibit))
+        get :edit_sort_fields, exhibit_id: exhibit
+        expect(response).to be_successful
+      end
+    end
+
     describe "#metadata_fields" do
       it "should be successful" do
         get :metadata_fields, exhibit_id: exhibit, format: 'json'
@@ -83,11 +93,12 @@ describe Spotlight::BlacklightConfigurationsController, :type => :controller do
       end
     end
 
-    describe "#available_configurations" do
+    describe "#available_search_views" do
       it "should be successful" do
-        get :available_configurations, exhibit_id: exhibit, format: 'json'
+        get :available_search_views, exhibit_id: exhibit, format: 'json'
         expect(response).to be_successful
-        expect(JSON.parse(response.body).keys).to match_array exhibit.blacklight_config.keys.map(&:to_s)
+        available = JSON.parse(response.body)
+        expect(available).to match_array ['list', 'gallery', 'slideshow']
       end
     end
 
@@ -132,6 +143,25 @@ describe Spotlight::BlacklightConfigurationsController, :type => :controller do
           expect(saved.blacklight_configuration.facet_fields.keys).to eq ['genre_ssim']
         end
       end
+
+      it "should update sort fields" do
+        patch :update, exhibit_id: exhibit, blacklight_configuration: { 
+          sort_fields: {"relevance"=>{"enabled" => "1", "label" => "Relevance"}, "title"=>{"enabled" => "1", "label" => "Title"}, "type"=>{"enabled" => "1", "label" => "Type"}, "date"=>{"enabled" => "0", "label" => "Date"}, "source"=>{"enabled" => "0", "label" => "Source"}, "identifier"=>{"enabled" => "0", "label" => "Identifier"}}
+        }
+        expect(flash[:notice]).to eq "The exhibit was successfully updated."
+        expect(response).to redirect_to exhibit_edit_sort_fields_path(exhibit)
+        assigns[:exhibit].tap do |saved|
+          expect(saved.blacklight_configuration.sort_fields).to eq(
+            {"relevance" => {"label"=>"Relevance", "enabled"=>true},
+             "title" => {"label" => "Title", "enabled"=>true},
+             "type" => {"label" => "Type", "enabled"=>true},
+             "date" => {"label" => "Date", "enabled"=>false},
+             "source" => {"label" => "Source", "enabled"=>false},
+             "identifier" => {"label" => "Identifier", "enabled"=>false}
+            }
+          )
+        end
+      end
     end
   end
 end

data/spec/controllers/spotlight/catalog_controller_spec.rb

@@ -190,8 +190,9 @@ describe Spotlight::CatalogController, :type => :controller do
     end
     describe "PATCH update" do
       it "should be successful" do
-        patch :update, exhibit_id: exhibit, id: 'dq287tq6352', solr_document: {tag_list: 'one, two'}
-        expect(response).to be_redirect
+        expect {
+          patch :update, exhibit_id: exhibit, id: 'dq287tq6352', solr_document: {exhibit_tag_list: 'one, two'}
+        }.to change { exhibit.owned_taggings.count }.by(2)
       end
     end
 

data/spec/controllers/spotlight/feature_pages_controller_spec.rb

@@ -124,6 +124,7 @@ describe Spotlight::FeaturePagesController, :type => :controller do
           put :update, id: page, exhibit_id: page.exhibit.id, feature_page: valid_attributes
           page.reload
           expect(response).to redirect_to(exhibit_feature_page_path(page.exhibit, page))
+          expect(flash[:notice]).to have_link "Undo changes"
         end
       end
 

data/spec/controllers/spotlight/home_pages_controller_spec.rb

@@ -42,6 +42,7 @@ describe Spotlight::HomePagesController, :type => :controller do
         put :update, id: page, exhibit_id: page.exhibit.id, home_page: valid_attributes
         page.reload
         expect(response).to redirect_to(exhibit_home_page_path(page.exhibit, page))
+        expect(flash[:notice]).to have_link "Undo changes"
       end
     end
   end
@@ -60,6 +61,14 @@ describe Spotlight::HomePagesController, :type => :controller do
       get :show, exhibit_id: exhibit
       expect(response).to be_successful
     end
+    it "should not do the search when the sidebar is hidden" do
+      page.display_sidebar = false
+      page.save
+      allow(controller).to receive_messages(get_search_results: [double, double])
+      get :show, exhibit_id: exhibit
+      expect(assigns).not_to have_key :response
+      expect(assigns).not_to have_key :document_list
+    end
   end
 
   describe "when the exhibit is not published" do

data/spec/controllers/spotlight/resources/upload_controller_spec.rb

@@ -19,12 +19,43 @@ describe Spotlight::Resources::UploadController, :type => :controller do
     let(:user) { FactoryGirl.create(:exhibit_curator, exhibit: exhibit) }
     before {sign_in user }
 
+    describe 'POST csv_upload' do
+      let(:csv) { fixture_file_upload(File.expand_path(File.join('..', 'fixtures', 'csv-upload-fixture.csv'), Rails.root), 'text/csv') }
+      let(:serialized_csv) {[
+        {"url"=>"http://lorempixel.com/800/500/", "full_title_tesim"=>"A random image", "spotlight_upload_description_tesim"=>"A random 800 by 500 image from lorempixel", "spotlight_upload_attribution_tesim"=>"lorempixel.com", "spotlight_upload_date_tesim"=>"2015"},
+        {"url"=>"http://lorempixel.com/900/600/", "full_title_tesim"=>"Another random image", "spotlight_upload_description_tesim"=>"A random 900 by 600 image from lorempixel", "spotlight_upload_attribution_tesim"=>"lorempixel.com", "spotlight_upload_date_tesim"=>"2014"}
+      ]}
+      before do
+        request.env["HTTP_REFERER"] = 'http://test.host/'
+      end
+      it 'should start an AddUploadsFromCSV job with the serialized CSV' do
+        expect(Spotlight::AddUploadsFromCSV).to receive(:perform_later).with(serialized_csv, exhibit, user).and_return(nil)
+        post :csv_upload, exhibit_id: exhibit, resources_csv_upload: { url: csv }
+      end
+      it 'should set the flash message' do
+        expect(Spotlight::AddUploadsFromCSV).to receive(:perform_later).and_return(nil)
+        post :csv_upload, exhibit_id: exhibit, resources_csv_upload: { url: csv }
+        expect(flash[:notice]).to eq "'csv-upload-fixture.csv' has been uploaded.  An email will be sent to you once indexing is complete."
+      end
+      it 'should redirect back' do
+        expect(Spotlight::AddUploadsFromCSV).to receive(:perform_later).and_return(nil)
+        post :csv_upload, exhibit_id: exhibit, resources_csv_upload: { url: csv }
+        expect(response).to redirect_to :back
+      end
+
+    end
+
     describe "POST create" do
 
+      let(:blacklight_solr) { double }
+
       before do
+        allow(blacklight_solr).to receive(:commit)
         allow_any_instance_of(Spotlight::Resource).to receive(:reindex)
+        allow_any_instance_of(Spotlight::Resource).to receive(:blacklight_solr).and_return blacklight_solr
       end
       it "create a Spotlight::Resources::Upload resource" do
+        expect(blacklight_solr).to receive(:commit)
         post :create, exhibit_id: exhibit, resources_upload: { url: "url-data" }
         expect(assigns[:resource]).to be_persisted
         expect(assigns[:resource]).to be_a(Spotlight::Resources::Upload)
@@ -32,7 +63,7 @@ describe Spotlight::Resources::UploadController, :type => :controller do
       it 'should redirect to the item admin page' do
         post :create, exhibit_id: exhibit, resources_upload: { url: "url-data" }
         expect(flash[:notice]).to eq 'Object uploaded successfully.'
-        expect(response).to redirect_to admin_exhibit_catalog_index_path(exhibit)
+        expect(response).to redirect_to admin_exhibit_catalog_index_path(exhibit, sort: :timestamp)
       end
       it 'should redirect to the upload form when the add-and-continue parameter is present' do
         post :create, exhibit_id: exhibit, "add-and-continue" => "true", resources_upload: { url: "url-data" }