blacklight-spotlight 0.2.0 → 0.3.0

data/app/helpers/spotlight/pages_helper.rb

@@ -49,8 +49,7 @@ module Spotlight
     end
     def get_search_widget_search_results block
       begin
-        search = Spotlight::Search.find(block.send(:'searches-options'))
-        get_search_results(search.query_params.with_indifferent_access.merge(params))
+        get_search_results(block.query_params.with_indifferent_access.merge(params))
       rescue ActiveRecord::RecordNotFound
         []
       end

data/app/jobs/spotlight/add_uploads_from_csv.rb

@@ -0,0 +1,23 @@
+module Spotlight
+  class AddUploadsFromCSV < ActiveJob::Base
+    queue_as :default
+
+    after_perform do |job|
+      csv_data, exhibit, user = job.arguments
+      Spotlight::IndexingCompleteMailer.documents_indexed(csv_data, exhibit, user).deliver_now
+    end
+
+    def perform(csv_data, exhibit, user)
+      csv_data.each do |row|
+        if (url = row.delete("url")).present?
+          Spotlight::Resources::Upload.create(
+            remote_url_url: url,
+            data: row,
+            exhibit: exhibit
+          )
+        end
+      end
+
+    end
+  end
+end

data/app/jobs/spotlight/reindex_job.rb

@@ -0,0 +1,19 @@
+module Spotlight
+  class ReindexJob < ActiveJob::Base
+    queue_as :default
+
+    def perform(exhibit_or_resources)
+      resources = if exhibit_or_resources.is_a? Spotlight::Exhibit
+        exhibit_or_resources.resources.find_each
+      elsif exhibit_or_resources.is_a? Enumerable
+        exhibit_or_resources
+      else
+        Array(exhibit_or_resources)
+      end
+
+      resources.each do |r|
+        r.reindex
+      end
+    end
+  end
+end

data/app/mailers/spotlight/indexing_complete_mailer.rb

@@ -0,0 +1,10 @@
+module Spotlight
+  class IndexingCompleteMailer < ActionMailer::Base
+
+    def documents_indexed(csv_data, exhibit, user)
+      @number = csv_data.length
+      @exhibit = exhibit
+      mail(to: user.email, subject: "Document indexing complete")
+    end
+  end
+end

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

@@ -18,7 +18,7 @@ module Spotlight::BlacklightConfigurationDefaults
 
       # can't use default_blacklight_config until after the BlacklightConfiguration
       # is created or we run into a circular dependency.
-      default_fields = ::CatalogController.blacklight_config.sort_fields
+      default_fields = Spotlight::Engine.blacklight_config.sort_fields
       self.sort_fields = default_fields.each_with_object({}) do |(k, v), obj|
         obj[k] = { show: true }
       end
@@ -29,13 +29,13 @@ module Spotlight::BlacklightConfigurationDefaults
 
       # can't use default_blacklight_config until after the BlacklightConfiguration
       # is created or we run into a circular dependency.
-      self.document_index_view_types = ::CatalogController.blacklight_config.view.keys.map(&:to_s)
+      self.document_index_view_types = Spotlight::Engine.blacklight_config.view.keys.map(&:to_s)
     end
 
     def set_default_per_page
       # can't use default_blacklight_config until after the BlacklightConfiguration
       # is created or we run into a circular dependency.
-      self.default_per_page ||= ::CatalogController.blacklight_config.per_page.first
+      self.default_per_page ||= Spotlight::Engine.blacklight_config.per_page.first
     end
 
 end

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

@@ -0,0 +1,59 @@
+###
+ # Include Spotlight::ImageDerivatives in a class or module to get
+ # the derivative configurations in #spotlight_image_derivatives.
+ # A new derivative could theoretically be added by putting the
+ # following in an initializer.
+ # Spotlight::ImageDerivatives.spotlight_image_derivatives << {
+ #   version: :my_version,
+ #   field: :my_field,
+ #   lambda: lambda {|_|
+ #     version :my_version do
+ #       process :resize_to_fill => [30,30]
+ #     end
+ #   }
+ # }
+ #
+ # This will then create that new CarrierWave version in any class that extends this module
+ # and calls the apply_spotlight_image_derivative_versions class method described below.
+###
+module Spotlight
+  module ImageDerivatives
+    mattr_accessor :spotlight_image_derivatives
+
+    # Extend Spotlight::ImageDerivatives in a CarrierWave uploader
+    # then you can call this as a class method and all of the
+    # configured versions will be available
+    def apply_spotlight_image_derivative_versions
+      spotlight_image_derivatives.each do |version_config|
+        if(c = version_config[:lambda]).present?
+          class_eval(&c)
+        end
+      end
+    end
+
+    # Set default derivative configurations
+    self.spotlight_image_derivatives ||= [
+      {
+        field: Spotlight::Engine.config.try(:full_image_field)
+      },
+      {
+        version: :thumb,
+        field: Spotlight::Engine.config.try(:thumbnail_field),
+        lambda: lambda {|_|
+          version :thumb do
+            process :resize_to_fit => [400,400]
+          end
+        }
+      },
+      {
+        version: :square,
+        field: Spotlight::Engine.config.try(:square_image_field),
+        lambda: lambda {|_|
+          version :square do
+            process :resize_to_fill => [100,100]
+          end
+        }
+      }
+    ].reject{|v| v[:field].blank? }
+  end
+end

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

@@ -5,18 +5,20 @@ module Spotlight
     include Blacklight::SolrHelper
     include Spotlight::SolrDocument::ActiveModelConcern
     include Spotlight::SolrDocument::Finder
-    
+    include Spotlight::SolrDocument::SpotlightImages
+    include GlobalID::Identification
+
     included do
       extend ActsAsTaggableOn::Compatibility
       extend ActsAsTaggableOn::Taggable
 
       acts_as_taggable
-      has_many :sidecars, class_name: 'Spotlight::SolrDocumentSidecar'
+      has_many :sidecars, class_name: 'Spotlight::SolrDocumentSidecar', as: :document
       
       before_save :save_owned_tags
       after_save :reindex
 
-      ::SolrDocument.use_extension(Spotlight::SolrDocument::UploadedResource) do |document|
+      use_extension(Spotlight::SolrDocument::UploadedResource) do |document|
         document.uploaded_resource?
       end
     end
@@ -51,7 +53,7 @@ module Spotlight
     end
 
     def to_solr
-      { id: id }.reverse_merge(sidecars.inject({}) { |result, sidecar| result.merge(sidecar.to_solr) }).merge(tags_to_solr)
+      { self.class.unique_key.to_sym => id }.reverse_merge(sidecars.inject({}) { |result, sidecar| result.merge(sidecar.to_solr) }).merge(tags_to_solr)
     end
 
     def self.solr_field_for_tagger tagger
@@ -61,6 +63,10 @@ module Spotlight
     def self.visibility_field exhibit
       ("#{Spotlight::Engine.config.solr_fields.prefix}#{exhibit.class.model_name.param_key}_#{exhibit.id}_public" + Spotlight::Engine.config.solr_fields.boolean_suffix).to_sym
     end
+    
+    def self.resource_type_field
+      :"#{Spotlight::Engine.config.solr_fields.prefix}spotlight_resource_type#{Spotlight::Engine.config.solr_fields.string_suffix}"
+    end
 
     def make_public! exhibit
       sidecar(exhibit).public!
@@ -80,8 +86,8 @@ module Spotlight
 
     def uploaded_resource?
       self[Spotlight::Engine.config.full_image_field].present? &&
-      self[:spotlight_resource_type_ssm].present? &&
-      self[:spotlight_resource_type_ssm].include?("spotlight/resources/uploads")
+      self[Spotlight::SolrDocument.resource_type_field].present? &&
+      self[Spotlight::SolrDocument.resource_type_field].include?("spotlight/resources/uploads")
     end
 
     def attribute_present? *args
@@ -110,5 +116,7 @@ module Spotlight
 end
 
 ActsAsTaggableOn::Tagging.after_destroy do |obj|
-  ::SolrDocument.reindex(obj.taggable_id)
+  if obj.tagger.is_a? Spotlight::Exhibit
+    obj.tagger.blacklight_config.solr_document_model.reindex(obj.taggable_id)
+  end
 end

data/app/models/concerns/spotlight/solr_document/active_model_concern.rb

@@ -9,10 +9,6 @@ module Spotlight::SolrDocument::ActiveModelConcern
   
   module ClassMethods
 
-    def primary_key
-      :id
-    end
-    
     # needed for Rails 4.1 + act_as_taggable
     def dangerous_attribute_method? *args
       false

data/app/models/concerns/spotlight/solr_document/atomic_updates.rb

@@ -1,19 +1,18 @@
 module Spotlight::SolrDocument::AtomicUpdates
 
   def reindex
-    data = hash_for_solr_update
+    data = hash_for_solr_update(to_solr)
 
     blacklight_solr.update params: { commitWithin: 500 }, data: data.to_json, headers: { 'Content-Type' => 'application/json'} unless data.empty?
   end
 
   private
-  def hash_for_solr_update
-    data = to_solr
+  def hash_for_solr_update data
     data = [data] unless data.is_a? Array
 
     data.map do |doc|
       Hash[doc.map do |k,v|
-        val = if k.to_sym == unique_key_field.to_sym
+        val = if k.to_sym == self.class.unique_key.to_sym
           v
         else
           { set: v }
@@ -23,12 +22,4 @@ module Spotlight::SolrDocument::AtomicUpdates
       end]
     end.reject { |x| x.length <= 1 }
   end
-
-  def unique_key_field
-    if respond_to?(:blacklight_config)
-      blacklight_config.solr_document_model.unique_key
-    else
-      'id'
-    end
-  end
 end

data/app/models/concerns/spotlight/solr_document/finder.rb

@@ -26,7 +26,7 @@ module Spotlight::SolrDocument
       end
 
       def blacklight_config
-        @conf ||= CatalogController.blacklight_config
+        @conf ||= Spotlight::Engine.blacklight_config
       end
 
       def blacklight_solr_config

data/app/models/concerns/spotlight/solr_document/spotlight_images.rb

@@ -0,0 +1,40 @@
+###
+ # Simple concern mixed into SolrDocument to create
+ # a mapping of configured Spotlight::ImageDerivatives
+ # to their configured fields in the SolrDocument.
+ # Any derivatives configured (descibed in Spotlight::ImageDerivatives)
+ # will be available under #spotlight_image_versions and an array of available versions
+ # (regardless of their is related data in the document) in the #spotlight_image_versions#versions array.
+###
+module Spotlight::SolrDocument::SpotlightImages
+
+  def spotlight_image_versions
+    @spotlight_image_versions ||= Versions.new(self)
+  end
+
+  class Versions
+    include Spotlight::ImageDerivatives
+    attr_reader :versions
+
+    def initialize(document)
+      @versions = spotlight_image_derivatives.map do |derivative|
+        version = version_name(derivative)
+        self.class.send(:define_method, version) do
+          document[derivative[:field]]
+        end
+        version
+      end
+    end
+
+    private
+
+    def version_name(derivative)
+      derivative[:version] || default_version_name
+    end
+
+    def default_version_name
+      :full
+    end
+  end
+
+end

data/app/models/sir_trevor_rails/blocks/featured_browse_categories_block.rb

@@ -0,0 +1,65 @@
+module SirTrevorRails::Blocks
+  class FeaturedBrowseCategoriesBlock < SirTrevorRails::Block
+    attr_reader :solr_helper
+
+    def with_solr_helper solr_helper
+      @solr_helper = solr_helper
+    end
+
+    def display_item_counts?
+      as_json[:data][:"display-item-counts"]
+    end
+
+    def block_objects
+      @block_objects ||= sorted_browse_categories.map do |category|
+        OpenStruct.new(
+          browse_category: category,
+          count: item_counts_for_category(category)
+        )
+      end
+    end
+
+    private
+
+    def sorted_browse_categories
+      browse_categories.sort do |a,b|
+        order_data.index(a.slug) <=> order_data.index(b.slug)
+      end
+    end
+
+    def order_data
+      data.select do |k,_|
+        k =~ /^weight-\S+/
+      end.compact.sort_by{|_,v| v}.map do |k,_|
+        k[/^weight-(\S+)/]; $1
+      end
+    end
+
+    def browse_categories
+      @browse_categories ||= parent.exhibit.searches.select do |search|
+        category_slugs.include?(search.slug)
+      end
+    end
+
+    def item_counts_for_category(category)
+      solr_helper.get_search_results(category.query_params).first["response"]["numFound"]
+    end
+
+    def data
+      as_json[:data].stringify_keys
+    end
+
+    def slug_data
+      data.except(:"display-item-counts").except do |k,_|
+        k =~ /^weight/
+      end
+    end
+
+    def category_slugs
+      @category_ids ||= slug_data.map do |slug, enabled|
+        slug if enabled
+      end.compact
+    end
+
+  end
+end

data/app/models/sir_trevor_rails/blocks/item_grid_block.rb

@@ -0,0 +1,9 @@
+module SirTrevorRails::Blocks
+  class ItemGridBlock < SirTrevorRails::Block
+    include SolrDocumentBlock
+    
+    def text_align
+      as_json[:data].find { |k,v| k =~ /text-align/ }.try(:last)
+    end
+  end
+end

data/app/models/sir_trevor_rails/blocks/search_results_block.rb

@@ -0,0 +1,15 @@
+module SirTrevorRails::Blocks
+  class SearchResultsBlock < SirTrevorRails::Block
+    def query_params
+      search.query_params
+    end
+
+    def search
+      @search ||= if slug
+        parent.exhibit.searches.find_by!(slug: slug)
+      elsif search_id = send(:'searches-options')
+        parent.exhibit.searches.find(search_id)
+      end
+    end
+  end
+end

data/app/models/spotlight/ability.rb

@@ -5,17 +5,21 @@ module Spotlight::Ability
     user ||= ::User.new
 
     alias_action :process_import, to: :import
-    alias_action :edit_metadata_fields, :edit_facet_fields, :metadata_fields, :available_configurations, to: :update
+    alias_action :edit_metadata_fields, :edit_facet_fields, :edit_sort_fields, :metadata_fields, :available_search_views, to: :update
 
     if user.superadmin?
       can :manage, :all
     end
 
     # exhibit admin 
-    can [:update, :import, :destroy], Spotlight::Exhibit, id: user.admin_roles.pluck(:exhibit_id)
+    can [:update, :import, :export, :destroy], Spotlight::Exhibit, id: user.admin_roles.pluck(:exhibit_id)
     can :manage, Spotlight::Role, exhibit_id: user.admin_roles.pluck(:exhibit_id)
     can :update, Spotlight::Appearance, exhibit_id: user.admin_roles.pluck(:exhibit_id)
 
+    if user.roles.any?
+      can :manage, PaperTrail::Version
+    end
+
     # exhibit curator
     can :manage, [
       Spotlight::Attachment,
@@ -29,7 +33,6 @@ module Spotlight::Ability
 
     can :update, Spotlight::BlacklightConfiguration, exhibit_id: user.roles.pluck(:exhibit_id)
 
-    can [:curate, :tag], Spotlight::Exhibit, id: user.roles.pluck(:exhibit_id)
     can [:read, :curate, :tag], Spotlight::Exhibit, id: user.roles.pluck(:exhibit_id)
 
     # public

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

@@ -0,0 +1,72 @@
+module Spotlight
+  module Analytics
+    class Ga
+      require 'legato'
+
+      extend Legato::Model
+
+      cattr_writer :user, :site
+
+      metrics :sessions, :users, :pageviews
+
+      def self.enabled?
+        user && site
+      end
+
+      def self.for_exhibit exhibit
+        path(Spotlight::Engine.routes.url_helpers.exhibit_path(exhibit))
+      end
+
+      filter :path, &lambda { |path| contains(:pagePath, "^#{path}") }
+          
+      def self.user(scope="https://www.googleapis.com/auth/analytics.readonly")
+        @user ||= begin
+          require 'oauth2'
+          require 'google/api_client'
+
+          client = Google::APIClient.new(
+            application_name: "spotlight",
+            application_version: Spotlight::VERSION
+          )
+          key = Google::APIClient::PKCS12.load_key(Spotlight::Engine.config.ga_pkcs12_key_path, "notasecret")
+          service_account = Google::APIClient::JWTAsserter.new(Spotlight::Engine.config.ga_email, scope, key)
+          client.authorization = service_account.authorize
+          oauth_client = OAuth2::Client.new("", "", {
+            authorize_url: 'https://accounts.google.com/o/oauth2/auth',
+            token_url: 'https://accounts.google.com/o/oauth2/token'
+          })
+          token = OAuth2::AccessToken.new(oauth_client, client.authorization.access_token, expires_in: 1.hour)
+          Legato::User.new(token)
+        rescue => e
+          Rails.logger.info(e)
+          nil
+        end
+      end
+
+      def self.site
+        @site ||= user.accounts.first.profiles.first { |x| x.web_property_id = Spotlight::Engine.config.ga_web_property_id }
+      end
+
+      def self.exhibit_data exhibit, options
+        context(exhibit).results(site, Spotlight::Engine.config.ga_analytics_options.merge(options)).to_a.first || OpenStruct.new(pageviews: 0, users: 0, sessions: 0)
+      end
+
+      def self.page_data exhibit, options
+        options[:sort] ||= '-pageviews'
+        query = context(exhibit).results(site, Spotlight::Engine.config.ga_page_analytics_options.merge(options))
+        query.dimensions << :page_path
+        query.dimensions << :page_title
+
+        query.to_a
+      end
+
+      def self.context exhibit
+        if exhibit.is_a? Spotlight::Exhibit
+          self.for_exhibit(exhibit)
+        else
+          self.path(exhibit)
+        end
+      end
+    end
+  end
+end