sufia 6.2.0 → 6.3.0

data/app/controllers/api/items_controller.rb

@@ -4,9 +4,9 @@ module API
   # Zotero parlance is mapped to a GenericFile in Sufia.
   class ItemsController < ApplicationController
     skip_before_action :verify_authenticity_token
-    before_filter :validate_item, only: [:create, :update]
-    before_filter :authorize_token
-    before_filter :my_load_and_authorize_resource, only: [:update, :destroy, :show]
+    before_action :validate_item, only: [:create, :update]
+    before_action :authorize_token
+    before_action :my_load_and_authorize_resource, only: [:update, :destroy, :show]
 
     attr_reader :item
 
@@ -66,9 +66,7 @@ module API
       end
 
       def authorize_token
-        unless valid_token?
-          return render plain: "invalid user token: #{token}", status: :unauthorized
-        end
+        render plain: "invalid user token: #{token}", status: :unauthorized unless valid_token?
       end
 
       def valid_token?

data/app/controllers/api/zotero_controller.rb

@@ -3,22 +3,22 @@ require 'oauth'
 module API
   # Adds the ability to authenticate against Zotero's OAuth endpoint
   class ZoteroController < ApplicationController
-    before_filter :authenticate_user!
-    before_filter :authorize_user!
-    before_filter :validate_params, only: :callback
+    before_action :authenticate_user!
+    before_action :authorize_user!
+    before_action :validate_params, only: :callback
 
     def initiate
       request_token = client.get_request_token(oauth_callback: callback_url)
       session[:request_token] = request_token
       current_user.zotero_token = request_token
       current_user.save
-      redirect_to request_token.authorize_url({ identity: '1', oauth_callback: callback_url })
+      redirect_to request_token.authorize_url(identity: '1', oauth_callback: callback_url)
     rescue OAuth::Unauthorized
       redirect_to root_url, alert: 'Invalid Zotero client key pair'
     end
 
     def callback
-      access_token = current_token.get_access_token({ oauth_verifier: params['oauth_verifier'] })
+      access_token = current_token.get_access_token(oauth_verifier: params['oauth_verifier'])
       # parse userID and API key out of token and store in user instance
       current_user.zotero_userid = access_token.params[:userID]
       current_user.save

data/app/controllers/authorities_controller.rb

@@ -8,7 +8,11 @@ class AuthoritiesController < ApplicationController
       if params[:term] == "location"
         GeoNamesResource.find_location(s)
       else
-        LocalAuthority.entries_by_term(params[:model], params[:term], s) rescue []
+        begin
+          LocalAuthority.entries_by_term(params[:model], params[:term], s)
+        rescue
+          []
+        end
       end
     render json: hits
   end

data/app/controllers/batch_edits_controller.rb

@@ -1,5 +1,5 @@
 class BatchEditsController < ApplicationController
-   include Hydra::BatchEditBehavior
-   include GenericFileHelper
-   include Sufia::BatchEditsControllerBehavior
+  include Hydra::BatchEditBehavior
+  include GenericFileHelper
+  include Sufia::BatchEditsControllerBehavior
 end

data/app/controllers/concerns/sufia/admin/depositor_stats.rb

@@ -0,0 +1,41 @@
+#  Module to gather information about the deposits in the system
+#
+module Sufia::Admin::DepositorStats
+  extend ActiveSupport::Concern
+
+  # we are using blacklight facet queries for some of our searches so we have to include them when we are included
+  included do
+    include Blacklight::Base
+    copy_blacklight_config_from(CatalogController)
+  end
+
+  # Gather information about the depositors in the system
+  #
+  # @param [Hash] deposit_stats
+  # @option deposit_stats [String] :start_date optional string to specify the start date to gather the stats from
+  # @option deposit_stats [String] :end_date optional string to specify the end date to gather the stats from
+  #
+  def depositors(deposit_stats)
+    start_datetime = DateTime.parse(deposit_stats[:start_date]) unless deposit_stats[:start_date].blank?
+    end_datetime = DateTime.parse(deposit_stats[:end_date]).end_of_day unless deposit_stats[:end_date].blank?
+
+    query = GenericFile.build_date_query(start_datetime, end_datetime) unless start_datetime.blank?
+    sb = DepositSearchBuilder.new([:include_depositor_facet], self)
+    facet_results = repository.search(sb.merge(q: query).query)
+    facets = facet_results["facet_counts"]["facet_fields"]["depositor_ssim"]
+    depositors = []
+
+    # facet results come back in an array where the first item is the user and the second item is the count
+    # [ abc123, 55, ccczzz, 205 ]
+    # in the loop we are stepping through the array by twos to get the entire pair
+    # The item at i is the key and the item at i+1 is the number of files
+    (0...facets.length).step(2).each do |i|
+      depositor = {}
+      depositor[:key] = facets[i]
+      depositor[:deposits] = facets[i + 1]
+      depositor[:user] = User.find_by_user_key(depositor[:key])
+      depositors << depositor
+    end
+    depositors
+  end
+end

data/app/controllers/concerns/sufia/admin/stats_behavior.rb

@@ -0,0 +1,94 @@
+module Sufia
+  module Admin
+    module StatsBehavior
+      extend ActiveSupport::Concern
+
+      included do
+        include Sufia::Admin::DepositorStats
+      end
+
+      def index
+        # total user count
+        @users_count = ::User.count
+
+        # The most recent users to join
+        @users_stats = params.fetch(:users_stats, {})
+        @recent_users = recent_users
+
+        # Query Solr for top depositors
+        @active_users = top_depositors
+
+        # Count of documents by permissions
+        @files_count = document_by_permission
+
+        # Query Solr for top file formats
+        @top_formats = top_formats
+
+        @deposit_stats = params.fetch(:deposit_stats, {})
+        @depositors = depositors(@deposit_stats)
+        render 'index'
+      end
+
+      private
+
+        def top_depositors_count
+          count = params[:dep_count].to_i
+          count.in?(5..20) ? count : 5
+        end
+
+        def document_by_permission
+          return document_by_date_by_permission if @users_stats[:file_start_date]
+
+          files_count = {}
+          files_count[:total] = ::GenericFile.count
+          files_count[:public] = ::GenericFile.where_public.count
+          files_count[:registered] = ::GenericFile.where_registered.count
+          files_count[:private] = files_count[:total] - (files_count[:registered] + files_count[:public])
+          files_count
+        end
+
+        def document_by_date_by_permission
+          start_date = DateTime.parse(@users_stats[:file_start_date])
+          end_date = DateTime.parse(@users_stats[:file_end_date]).end_of_day unless @users_stats[:file_end_date].blank?
+          files_count = {}
+          files_count[:total] = ::GenericFile.find_by_date_created(start_date, end_date).count
+          files_count[:public] = ::GenericFile.find_by_date_created(start_date, end_date).merge(::GenericFile.where_public).count
+          files_count[:registered] = ::GenericFile.find_by_date_created(start_date, end_date).merge(::GenericFile.where_registered).count
+          files_count[:private] = files_count[:total] - (files_count[:registered] + files_count[:public])
+          files_count
+        end
+
+        def top_depositors
+          depositor_key = Solrizer.solr_name('depositor', :stored_searchable, type: :string)
+          top_data(depositor_key, top_depositors_count)
+        end
+
+        def top_formats
+          format_key = Solrizer.solr_name('file_format', Solrizer::Descriptor.new(:string, :indexed, :multivalued))
+          top_data(format_key, 5)
+        end
+
+        def top_data(key, limit)
+          query_url = "#{ActiveFedora.solr_config[:url]}/terms?terms.fl=#{key}&terms.sort=count&terms.limit=#{limit}&wt=json&omitHeader=true"
+          # Parse JSON response (looks like {"terms":{"depositor_tesim":["mjg36",3]}} for depositor)
+          json = open(query_url).read
+          begin
+            tuples = JSON.parse(json)['terms'][key]
+          rescue
+            []
+          end
+          # Change to hash where keys = logins and values = counts
+          Hash[*tuples]
+        end
+
+        def recent_users
+          # no dates return the top 5
+          return ::User.order('created_at DESC').limit(5) if @users_stats[:start_date].blank?
+
+          start_date = DateTime.parse @users_stats[:start_date]
+          end_date = DateTime.parse(@users_stats[:end_date]).end_of_day unless @users_stats[:end_date].blank?
+          ::User.recent_users start_date, end_date
+        end
+    end
+  end
+end

data/app/controllers/concerns/sufia/batch_controller_behavior.rb

@@ -3,13 +3,13 @@ module Sufia
     extend ActiveSupport::Concern
     include Hydra::Controller::ControllerBehavior
 
-    included do 
+    included do
       layout "sufia-one-column"
 
-      before_filter :has_access?
+      before_action :has_access?
       ActiveSupport::Deprecation.deprecate_methods(BatchController, :initialize_fields)
       class_attribute :edit_form_class
-      self.edit_form_class = Sufia::Forms::BatchEditForm 
+      self.edit_form_class = Sufia::Forms::BatchEditForm
     end
 
     def edit
@@ -34,22 +34,20 @@ module Sufia
 
     protected
 
-    def edit_form
-      generic_file = ::GenericFile.new(creator: [current_user.name], title: @batch.generic_files.map(&:label))
-      edit_form_class.new(generic_file)
-    end
-
-    # override this method if you need to initialize more complex RDF assertions (b-nodes)
-    def initialize_fields(file)
-      file.initialize_fields
-    end
+      def edit_form
+        generic_file = ::GenericFile.new(creator: [current_user.name], title: @batch.generic_files.map(&:label))
+        edit_form_class.new(generic_file)
+      end
 
-    def uploading_on_behalf_of? batch
-      file = batch.generic_files.first
-      return false if file.nil? || file.on_behalf_of.blank?
-      current_user.user_key != file.on_behalf_of
-    end
+      # override this method if you need to initialize more complex RDF assertions (b-nodes)
+      def initialize_fields(file)
+        file.initialize_fields
+      end
 
+      def uploading_on_behalf_of?(batch)
+        file = batch.generic_files.first
+        return false if file.nil? || file.on_behalf_of.blank?
+        current_user.user_key != file.on_behalf_of
+      end
   end
 end
-

data/app/controllers/concerns/sufia/batch_edits_controller_behavior.rb

@@ -5,37 +5,36 @@ module Sufia
 
     included do
       layout "sufia-one-column"
-      before_filter :build_breadcrumbs, only: :edit
+      before_action :build_breadcrumbs, only: :edit
     end
 
     def edit
-       super
-       @generic_file = ::GenericFile.new
-       @generic_file.depositor = current_user.user_key
-       @terms = terms - [:title, :format, :resource_type]
-
-       h  = {}
-       @names = []
-       permissions = []
-
-       # For each of the files in the batch, set the attributes to be the concatination of all the attributes
-       batch.each do |doc_id|
-          gf = ::GenericFile.load_instance_from_solr(doc_id)
-          terms.each do |key|
-            h[key] ||= []
-            h[key] = (h[key] + gf.send(key)).uniq
-          end
-          @names << gf.to_s
-          permissions = (permissions + gf.permissions).uniq
-       end
-
-       initialize_fields(h, @generic_file)
-
-       @generic_file.permissions_attributes = [{type: 'group', name: 'public', access: 'read'}]
+      super
+      @generic_file = ::GenericFile.new
+      @generic_file.depositor = current_user.user_key
+      @terms = terms - [:title, :format, :resource_type]
+
+      h = {}
+      @names = []
+      permissions = []
+
+      # For each of the files in the batch, set the attributes to be the concatination of all the attributes
+      batch.each do |doc_id|
+        gf = ::GenericFile.load_instance_from_solr(doc_id)
+        terms.each do |key|
+          h[key] ||= []
+          h[key] = (h[key] + gf.send(key)).uniq
+        end
+        @names << gf.to_s
+        permissions = (permissions + gf.permissions).uniq
+      end
+
+      initialize_fields(h, @generic_file)
+
+      @generic_file.permissions_attributes = [{ type: 'group', name: 'public', access: 'read' }]
     end
 
     def after_update
-
       respond_to do |format|
         format.json { head :no_content }
         format.html { redirect_to_return_controller }
@@ -54,47 +53,46 @@ module Sufia
 
     def update
       case params["update_type"]
-        when "update"
-          super
-        when "delete_all"
-          destroy_batch
+      when "update"
+        super
+      when "delete_all"
+        destroy_batch
       end
     end
 
     protected
 
-    def destroy_batch
-      batch.each do |doc_id|
-        gf = ::GenericFile.find(doc_id)
-        gf.destroy
+      def destroy_batch
+        batch.each do |doc_id|
+          gf = ::GenericFile.find(doc_id)
+          gf.destroy
+        end
+        after_update
       end
-      after_update
-    end
 
-    # override this method if you need to initialize more complex RDF assertions (b-nodes)
-    def initialize_fields(attributes, file)
-       terms.each do |key|
-         # if value is empty, we create an one element array to loop over for output
-         file[key] = attributes[key].empty? ? [''] : attributes[key]
-       end
-    end
-
-    def terms
-      Forms::BatchEditForm.terms
-    end
+      # override this method if you need to initialize more complex RDF assertions (b-nodes)
+      def initialize_fields(attributes, file)
+        terms.each do |key|
+          # if value is empty, we create an one element array to loop over for output
+          file[key] = attributes[key].empty? ? [''] : attributes[key]
+        end
+      end
 
-    def generic_file_params
-      file_params = params[:generic_file] || ActionController::Parameters.new()
-      Forms::BatchEditForm.model_attributes(file_params)
-    end
+      def terms
+        Forms::BatchEditForm.terms
+      end
 
-    def redirect_to_return_controller
-      if params[:return_controller]
-        redirect_to sufia.url_for(controller: params[:return_controller], only_path: true)
-      else
-        redirect_to sufia.dashboard_index_path
+      def generic_file_params
+        file_params = params[:generic_file] || ActionController::Parameters.new
+        Forms::BatchEditForm.model_attributes(file_params)
       end
-    end
 
+      def redirect_to_return_controller
+        if params[:return_controller]
+          redirect_to sufia.url_for(controller: params[:return_controller], only_path: true)
+        else
+          redirect_to sufia.dashboard_index_path
+        end
+      end
   end
 end

data/app/controllers/concerns/sufia/breadcrumbs.rb

@@ -11,9 +11,7 @@ module Sufia
     end
 
     def default_trail
-      if user_signed_in?
-        add_breadcrumb I18n.t('sufia.dashboard.title'), sufia.dashboard_index_path
-      end
+      add_breadcrumb I18n.t('sufia.dashboard.title'), sufia.dashboard_index_path if user_signed_in?
     end
 
     def trail_from_referer
@@ -37,9 +35,8 @@ module Sufia
     end
 
     def add_breadcrumb_for_action
-      if /edit|stats/ =~ action_name && controller_name == "generic_files"
-        add_breadcrumb I18n.t("sufia.generic_file.browse_view"), sufia.generic_file_path(params["id"])
-      end
+      return unless /edit|stats/ =~ action_name && controller_name == "generic_files"
+      add_breadcrumb I18n.t("sufia.generic_file.browse_view"), sufia.generic_file_path(params["id"])
     end
   end
 end

data/app/controllers/concerns/sufia/collections_controller_behavior.rb

@@ -6,9 +6,9 @@ module Sufia
     included do
       include Sufia::Breadcrumbs
 
-      before_filter :filter_docs_with_read_access!, except: :show
-      before_filter :has_access?, except: :show
-      before_filter :build_breadcrumbs, only: [:edit, :show]
+      before_action :filter_docs_with_read_access!, except: :show
+      before_action :has_access?, except: :show
+      before_action :build_breadcrumbs, only: [:edit, :show]
 
       self.search_params_logic += [:add_access_controls_to_solr_params, :add_advanced_parse_q_to_solr]
 
@@ -32,50 +32,50 @@ module Sufia
 
     protected
 
-    def presenter
-      @presenter ||= presenter_class.new(@collection)
-    end
+      def presenter
+        @presenter ||= presenter_class.new(@collection)
+      end
 
-    def presenter_class
-      Sufia::CollectionPresenter
-    end
+      def presenter_class
+        Sufia::CollectionPresenter
+      end
 
-    def collection_member_search_builder_class
-      ::SearchBuilder
-    end
+      def collection_member_search_builder_class
+        ::SearchBuilder
+      end
 
-    def collection_params
-      form_class.model_attributes(
-        params.require(:collection).permit(:title, :description, :members, part_of: [],
-          contributor: [], creator: [], publisher: [], date_created: [], subject: [],
-          language: [], rights: [], resource_type: [], identifier: [], based_near: [],
-          tag: [], related_url: [])
-      )
-    end
+      def collection_params
+        form_class.model_attributes(
+          params.require(:collection).permit(:title, :description, :members, part_of: [],
+                                                                             contributor: [], creator: [], publisher: [], date_created: [], subject: [],
+                                                                             language: [], rights: [], resource_type: [], identifier: [], based_near: [],
+                                                                             tag: [], related_url: [])
+        )
+      end
 
-    def query_collection_members
-      flash[:notice]=nil if flash[:notice] == "Select something first"
-      params[:q] = params[:cq]
-      super
-    end
+      def query_collection_members
+        flash[:notice] = nil if flash[:notice] == "Select something first"
+        params[:q] = params[:cq]
+        super
+      end
 
-    def after_destroy(id)
-      respond_to do |format|
-        format.html { redirect_to sufia.dashboard_collections_path, notice: 'Collection was successfully deleted.' }
-        format.json { render json: {id: id}, status: :destroyed, location: @collection }
+      def after_destroy(id)
+        respond_to do |format|
+          format.html { redirect_to sufia.dashboard_collections_path, notice: 'Collection was successfully deleted.' }
+          format.json { render json: { id: id }, status: :destroyed, location: @collection }
+        end
       end
-    end
 
-    def form
-      @form ||= form_class.new(@collection)
-    end
+      def form
+        @form ||= form_class.new(@collection)
+      end
 
-    def form_class
-      Sufia::Forms::CollectionEditForm
-    end
+      def form_class
+        Sufia::Forms::CollectionEditForm
+      end
 
-    def _prefixes
-      @_prefixes ||= super + ['catalog']
-    end
+      def _prefixes
+        @_prefixes ||= super + ['catalog']
+      end
   end
 end