sufia 7.1.0 → 7.2.0

data/app/jobs/content_depositor_change_event_job.rb

@@ -43,11 +43,4 @@ class ContentDepositorChangeEventJob < ContentEventJob
   def proxy_depositor
     @proxy_depositor ||= ::User.find_by_user_key(work.proxy_depositor)
   end
-
-  # override to check file permissions before logging to followers
-  def log_to_followers(depositor)
-    depositor.followers.select { |user| user.can?(:read, work) }.each do |follower|
-      follower.log_event(event)
-    end
-  end
 end

data/app/jobs/content_event_job.rb

@@ -15,13 +15,6 @@ class ContentEventJob < EventJob
     repo_object.log_event(event)
   end
 
-  # override to check file permissions before logging to followers
-  def log_to_followers(depositor)
-    depositor.followers.select { |user| user.can?(:read, repo_object) }.each do |follower|
-      follower.log_event(event)
-    end
-  end
-
   # log the event to the users profile stream
   def log_user_event(depositor)
     depositor.log_profile_event(event)

data/app/jobs/event_job.rb

@@ -1,4 +1,4 @@
-# A generic job for sending events to a user and their followers.
+# A generic job for sending events to a user.
 #
 # This class does not implement a usable action, so it must be implemented in a child class
 #
@@ -17,9 +17,6 @@ class EventJob < ActiveJob::Base
     @depositor = depositor
     # Log the event to the depositor's profile stream
     log_user_event(depositor)
-
-    # Fan out the event to all followers who have access
-    log_to_followers(depositor)
   end
 
   # override to provide your specific action for the event you are logging
@@ -37,11 +34,4 @@ class EventJob < ActiveJob::Base
   def log_user_event(depositor)
     depositor.log_event(event)
   end
-
-  # log the event to the users followers
-  def log_to_followers(depositor)
-    depositor.followers.each do |follower|
-      follower.log_event(event)
-    end
-  end
 end

data/app/jobs/inherit_permissions_job.rb

@@ -0,0 +1,24 @@
+# A job to apply work permissions to all contained files set
+#
+class InheritPermissionsJob < ActiveJob::Base
+  # Perform the copy from the work to the contained filesets
+  #
+  # @param work containing access level and filesets
+  def perform(work)
+    work.file_sets.each do |file|
+      attribute_map = work.permissions.map(&:to_hash)
+
+      # copy and removed access to the new access with the delete flag
+      file.permissions.map(&:to_hash).each do |perm|
+        unless attribute_map.include?(perm)
+          perm[:_destroy] = true
+          attribute_map << perm
+        end
+      end
+
+      # apply the new and deleted attributes
+      file.permissions_attributes = attribute_map
+      file.save!
+    end
+  end
+end

data/app/mailers/sufia/contact_mailer.rb

@@ -0,0 +1,11 @@
+module Sufia
+  # Mailer for contacting the administrator
+  class ContactMailer < ActionMailer::Base
+    def contact(contact_form)
+      @contact_form = contact_form
+      # Check for spam
+      return if @contact_form.spam?
+      mail(@contact_form.headers)
+    end
+  end
+end

data/app/models/concerns/sufia/ability.rb

@@ -9,7 +9,9 @@ module Sufia
                              :stats_abilities,
                              :citation_abilities,
                              :proxy_deposit_abilities,
-                             :uploaded_file_abilities]
+                             :uploaded_file_abilities,
+                             :feature_abilities,
+                             :admin_set_abilities]
     end
 
     def uploaded_file_abilities
@@ -41,6 +43,7 @@ module Sufia
       can :read, ContentBlock
       return unless admin?
 
+      can :read, :admin_dashboard
       can :create, TinymceAsset
       can [:create, :update], ContentBlock
       can :edit, ::SolrDocument
@@ -55,6 +58,14 @@ module Sufia
       alias_action :citation, to: :read
     end
 
+    def feature_abilities
+      can :manage, Sufia::Feature if admin?
+    end
+
+    def admin_set_abilities
+      can :manage, AdminSet if admin?
+    end
+
     private
 
       def user_is_depositor?(document_id)

data/app/models/concerns/sufia/content_block_behavior.rb

@@ -0,0 +1,47 @@
+module Sufia
+  module ContentBlockBehavior
+    extend ActiveSupport::Concern
+
+    MARKETING  = 'marketing_text'.freeze
+    RESEARCHER = 'featured_researcher'.freeze
+    ANNOUNCEMENT = 'announcement_text'.freeze
+
+    def external_key_name
+      self.class.external_keys.fetch(name) { 'External Key' }
+    end
+
+    class_methods do
+      def marketing_text
+        find_or_create_by(name: MARKETING)
+      end
+
+      def marketing_text=(value)
+        marketing_text.update(value: value)
+      end
+
+      def announcement_text
+        find_or_create_by(name: ANNOUNCEMENT)
+      end
+
+      def announcement_text=(value)
+        announcement_text.update(value: value)
+      end
+
+      def recent_researchers
+        where(name: RESEARCHER).order('created_at DESC')
+      end
+
+      def featured_researcher
+        recent_researchers.first_or_create(name: RESEARCHER)
+      end
+
+      def featured_researcher=(value)
+        create(name: RESEARCHER, value: value)
+      end
+
+      def external_keys
+        { RESEARCHER => 'User' }
+      end
+    end
+  end
+end

data/app/models/concerns/sufia/solr_document/export.rb

@@ -20,6 +20,12 @@ module Sufia
         text.join("\n")
       end
 
+      # Name of the downloaded endnote file
+      # Override this if you want to use a different name
+      def endnote_filename
+        "#{id}.endnote"
+      end
+
       def persistent_url
         "#{Sufia.config.persistent_hostpath}#{id}"
       end

data/app/models/concerns/sufia/solr_document_behavior.rb

@@ -57,6 +57,10 @@ module Sufia
       Array.wrap(self['collection_ids_tesim'])
     end
 
+    def admin_set
+      fetch(Solrizer.solr_name('admin_set'), [])
+    end
+
     # Find the solr documents for the collections this object belongs to
     def collections
       return @collections if @collections

data/app/models/concerns/sufia/user.rb

@@ -17,11 +17,6 @@ module Sufia::User
     # set this up as a messageable object
     acts_as_messageable
 
-    # Users should be able to follow things
-    acts_as_follower
-    # Users should be followable
-    acts_as_followable
-
     # Set up proxy-related relationships
     has_many :proxy_deposit_requests, foreign_key: 'receiving_user_id'
     has_many :deposit_rights_given, foreign_key: 'grantor_id', class_name: 'ProxyDepositRights', dependent: :destroy
@@ -106,7 +101,7 @@ module Sufia::User
 
   # Redefine this for more intuitive keys in Redis
   def to_param
-    # HACK: because rails doesn't like periods in urls.
+    # Rails doesn't like periods in urls
     user_key.gsub(/\./, '-dot-')
   end
 
@@ -128,7 +123,7 @@ module Sufia::User
   module ClassMethods
     # Override this method if you aren't using email/password
     def audit_user
-      User.find_by_user_key(audit_user_key) || User.create!(Devise.authentication_keys.first => audit_user_key, password: Devise.friendly_token[0, 20])
+      find_or_create_system_user(audit_user_key)
     end
 
     alias audituser audit_user
@@ -140,7 +135,7 @@ module Sufia::User
 
     # Override this method if you aren't using email/password
     def batch_user
-      User.find_by_user_key(batch_user_key) || User.create!(Devise.authentication_keys.first => batch_user_key, password: Devise.friendly_token[0, 20])
+      find_or_create_system_user(batch_user_key)
     end
 
     alias batchuser batch_user
@@ -150,6 +145,10 @@ module Sufia::User
       Sufia.config.batch_user_key
     end
 
+    def find_or_create_system_user(user_key)
+      User.find_by_user_key(user_key) || User.create!(Devise.authentication_keys.first => user_key, password: Devise.friendly_token[0, 20])
+    end
+
     def from_url_component(component)
       User.find_by_user_key(component.gsub(/-dot-/, '.'))
     end

data/app/models/concerns/sufia/with_events.rb

@@ -1,7 +1,11 @@
 module Sufia
   module WithEvents
     def stream
-      Nest.new(self.class.name)[to_param]
+      Nest.new(event_class)[to_param]
+    end
+
+    def event_class
+      self.class.name
     end
 
     def event_store

data/app/models/concerns/sufia/works/featured.rb

@@ -7,7 +7,7 @@ module Sufia::Works
     end
 
     def cleanup_featured_works
-      FeaturedWork.destroy_all(work_id: id)
+      FeaturedWork.where(work_id: id).destroy_all
     end
 
     def check_featureability

data/app/models/concerns/sufia/works/trophies.rb

@@ -6,7 +6,7 @@ module Sufia::Works
     end
 
     def cleanup_trophies
-      Trophy.destroy_all(work_id: id)
+      Trophy.where(work_id: id).destroy_all
     end
   end
 end

data/app/models/content_block.rb

@@ -1,41 +1,3 @@
 class ContentBlock < ActiveRecord::Base
-  MARKETING  = 'marketing_text'.freeze
-  RESEARCHER = 'featured_researcher'.freeze
-  ANNOUNCEMENT = 'announcement_text'.freeze
-
-  def self.marketing_text
-    find_or_create_by(name: MARKETING)
-  end
-
-  def self.marketing_text=(value)
-    marketing_text.update(value: value)
-  end
-
-  def self.announcement_text
-    find_or_create_by(name: ANNOUNCEMENT)
-  end
-
-  def self.announcement_text=(value)
-    announcement_text.update(value: value)
-  end
-
-  def self.recent_researchers
-    where(name: RESEARCHER).order('created_at DESC')
-  end
-
-  def self.featured_researcher
-    recent_researchers.first_or_create(name: RESEARCHER)
-  end
-
-  def self.featured_researcher=(value)
-    create(name: RESEARCHER, value: value)
-  end
-
-  def self.external_keys
-    { RESEARCHER => 'User' }
-  end
-
-  def external_key_name
-    self.class.external_keys.fetch(name) { 'External Key' }
-  end
+  include Sufia::ContentBlockBehavior
 end

data/app/models/featured_work_list.rb

@@ -4,7 +4,6 @@ class FeaturedWorkList
   def featured_works_attributes=(attributes_collection)
     attributes_collection = attributes_collection.sort_by { |i, _| i.to_i }.map { |_, attributes| attributes } if attributes_collection.is_a? Hash
     attributes_collection.each do |attributes|
-      attributes = attributes.with_indifferent_access
       raise "Missing id" if attributes['id'].blank?
       existing_record = FeaturedWork.find(attributes['id'])
       existing_record.update(attributes.except('id'))

data/app/models/file_download_stat.rb

@@ -2,13 +2,24 @@ class FileDownloadStat < Sufia::Statistic
   self.cache_column = :downloads
   self.event_type = :totalEvents
 
-  # Sufia::Download is sent to Sufia::Analytics.profile as #sufia__download
-  # see Legato::ProfileMethods.method_name_from_klass
-  def self.ga_statistics(start_date, file)
-    Sufia::Analytics.profile.sufia__download(sort: 'date', start_date: start_date, end_date: Date.yesterday).for_file(file.id)
-  end
+  class << self
+    # Sufia::Download is sent to Sufia::Analytics.profile as #sufia__download
+    # see Legato::ProfileMethods.method_name_from_klass
+    def ga_statistics(start_date, file)
+      profile = Sufia::Analytics.profile
+      unless profile
+        Rails.logger.error("Google Analytics profile has not been established. Unable to fetch statistics.")
+        return []
+      end
+      profile.sufia__download(sort: 'date',
+                              start_date: start_date,
+                              end_date: Date.yesterday)
+             .for_file(file.id)
+    end
 
-  def self.filter(file)
-    { file_id: file.id }
+    # this is called by the parent class
+    def filter(file)
+      { file_id: file.id }
+    end
   end
 end

data/app/models/file_view_stat.rb

@@ -2,7 +2,10 @@ class FileViewStat < Sufia::Statistic
   self.cache_column = :views
   self.event_type = :pageviews
 
-  def self.filter(file)
-    { file_id: file.id }
+  class << self
+    # this is called by the parent class
+    def filter(file)
+      { file_id: file.id }
+    end
   end
 end

data/app/models/sufia/contact_form.rb

@@ -0,0 +1,33 @@
+module Sufia
+  class ContactForm
+    include ActiveModel::Model
+    ISSUE_TYPES = [
+      ["Depositing content", "Depositing content"],
+      ["Making changes to my content", "Making changes to my content"],
+      ["Browsing and searching", "Browsing and searching"],
+      ["Reporting a problem", "Reporting a problem"],
+      ["General inquiry or request", "General inquiry or request"]
+    ].freeze
+
+    attr_accessor :contact_method, :category, :name, :email, :subject, :message
+    validates :email, :category, :name, :subject, :message, presence: true
+    validates :email, format: /\A([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})\z/i, allow_blank: true
+
+    # - can't use this without ActiveRecord::Base validates_inclusion_of :category, in: ISSUE_TYPES
+
+    # They should not have filled out the `contact_method' field. That's there to prevent spam.
+    def spam?
+      contact_method.present?
+    end
+
+    # Declare the e-mail headers. It accepts anything the mail method
+    # in ActionMailer accepts.
+    def headers
+      {
+        subject: "#{Sufia.config.subject_prefix} #{subject}",
+        to: Sufia.config.contact_email,
+        from: email
+      }
+    end
+  end
+end

data/app/models/sufia/feature.rb

@@ -0,0 +1,5 @@
+module Sufia
+  class Feature < ActiveRecord::Base
+    self.table_name = 'sufia_features'
+  end
+end

data/app/models/sufia/statistic.rb

@@ -16,10 +16,6 @@ module Sufia
         new attrs.merge(filter(object))
       end
 
-      def to_flots(stats)
-        stats.map(&:to_flot)
-      end
-
       def convert_date(date_time)
         date_time.to_datetime.to_i * 1000
       end
@@ -32,7 +28,12 @@ module Sufia
       # see Legato::ProfileMethods.method_name_from_klass
       def ga_statistics(start_date, object)
         path = polymorphic_path(object)
-        Sufia::Analytics.profile.sufia__pageview(sort: 'date', start_date: start_date).for_path(path)
+        profile = Sufia::Analytics.profile
+        unless profile
+          Rails.logger.error("Google Analytics profile has not been established. Unable to fetch statistics.")
+          return []
+        end
+        profile.sufia__pageview(sort: 'date', start_date: start_date).for_path(path)
       end
 
       private