sufia 7.0.0.beta1 → 7.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 117c39bea3f165e71777729d3f4118473b8a876c
-  data.tar.gz: 8b5a85e970c5ca8dd32733fbb8723548e80d8930
+  metadata.gz: 8878efdf23b664d1ccc522e05f997d099dcd43f9
+  data.tar.gz: 8062a829e1bc496ef751aca11363c10bc5fc143c
 SHA512:
-  metadata.gz: 8d03ab38475146b43bf223c5c9b6a9a9a20c00f82d49887acd922164d0423daee93d561101d116b36a8ffc328be5233c9bb7f84d4784a1a688df1c4d52c1c6c5
-  data.tar.gz: e4b9d252e988795eb3888cdd4c01849f427857d2ac2db4210627b2745df4a9955528ca742492dc34009b2b60bc28f848a5b2537b9b24c1a3beb344a9bb9559ce
+  metadata.gz: e1457e174fcfdf5ceb54dc2c9090a37bb03af3c47882f04a046550f19b1687112cfd073ac9b75199ad4db8615ab13790b5ed47ee39772a582b3299dc3070fa82
+  data.tar.gz: afdcc985bc2f96201032af0c9ef78ceb2eb7387499ad0621c775fcfbd0d6a24e315b619fba59cfa2503432d626dcc209cffc754a6498f548091cac415338c9b1

data/app/assets/javascripts/sufia.js

@@ -21,10 +21,9 @@
 //= require select2
 //= require fixedsticky
 
-//= require flot/excanvas
-//= require flot/jquery.flot
-//= require flot/jquery.flot.time
-//= require flot/jquery.flot.selection
+//= require jquery.flot
+//= require jquery.flot.time
+//= require jquery.flot.selection
 
 //= require batch_edit
 //

data/app/assets/stylesheets/sufia/_styles.scss

@@ -33,9 +33,10 @@
   padding-bottom: $padding-large-vertical;
 }
 
-#footer {
+footer.navbar {
   padding-bottom: 0;
   margin-bottom: 0;
+  border-radius: 0;
 }
 
 label.required, span.required {

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

@@ -3,6 +3,7 @@ module Sufia
     extend ActiveSupport::Concern
 
     included do
+      before_action :authenticate_user!
       before_action :load_proxy_deposit_request, only: :create
       load_and_authorize_resource :proxy_deposit_request, parent: false, except: :index
       before_action :authorize_depositor_by_id, only: [:new, :create]

data/app/controllers/errors_controller.rb

@@ -7,6 +7,6 @@ class ErrorsController < ApplicationController
 
     def render_routing_error(exception)
       logger.error("Rendering 404 page due to exception: #{exception.inspect} - #{exception.backtrace if exception.respond_to? :backtrace}")
-      render template: '/error/404', layout: "error", formats: [:html], status: 404
+      render '404', layout: "error", status: 404
     end
 end

data/app/indexers/sufia/work_indexer.rb

@@ -7,6 +7,7 @@ module Sufia
         # the search query.  While at the same time allowing us not to return Collections
         # when a work in the collection matches the query.
         solr_doc[Solrizer.solr_name('file_set_ids', :symbol)] = solr_doc[Solrizer.solr_name('member_ids', :symbol)]
+        solr_doc[Solrizer.solr_name('resource_type', :facetable)] = object.resource_type
       end
     end
   end

data/app/presenters/sufia/admin_stats_presenter.rb

@@ -1,16 +1,22 @@
 module Sufia
   class AdminStatsPresenter
-    attr_reader :limit, :start_date, :end_date, :stats_filters
+    attr_reader :limit, :stats_filters
 
     def initialize(stats_filters, limit)
       @stats_filters = stats_filters
-      @start_date = stats_filters[:start_date]
-      @end_date = stats_filters[:end_date]
       @limit = limit
     end
 
+    def start_date
+      @start_date ||= Time.zone.parse(stats_filters[:start_date]).beginning_of_day if stats_filters[:start_date].present?
+    end
+
+    def end_date
+      @end_date ||= Time.zone.parse(stats_filters[:end_date]).end_of_day if stats_filters[:end_date].present?
+    end
+
     def depositors
-      @depositors ||= Sufia::Admin::DepositorStats.new(start_date, end_date).depositors
+      @depositors ||= Sufia::Statistics::Depositors::Summary.new(start_date, end_date).depositors
     end
 
     def recent_users
@@ -18,15 +24,15 @@ module Sufia
     end
 
     def active_users
-      @active_users ||= stats.top_depositors
+      @active_users ||= Sufia::Statistics::Works::ByDepositor.new(limit).query
     end
 
     def top_formats
-      @top_formats ||= stats.top_formats
+      @top_formats ||= Sufia::Statistics::FileSets::ByFormat.new(limit).query
     end
 
-    def files_count
-      @files_count ||= stats.document_by_permission
+    def works_count
+      @works_count ||= Sufia::Statistics::Works::Count.new(start_date, end_date).by_permission
     end
 
     def users_count
@@ -37,16 +43,16 @@ module Sufia
       if start_date.blank?
         "unfiltered"
       elsif end_date.blank?
-        "#{start_date} to #{Date.current}"
+        "#{start_date.to_date.to_formatted_s(:standard)} to #{Date.current.to_formatted_s(:standard)}"
       else
-        "#{start_date} to #{end_date}"
+        "#{start_date.to_date.to_formatted_s(:standard)} to #{end_date.to_date.to_formatted_s(:standard)}"
       end
     end
 
     private
 
       def stats
-        @stats ||= SystemStats.new(limit, start_date, end_date)
+        @stats ||= Sufia::Statistics::SystemStats.new(limit, start_date, end_date)
       end
   end
 end

data/app/search_builders/sufia/catalog_search_builder.rb

@@ -4,4 +4,33 @@ class Sufia::CatalogSearchBuilder < Sufia::SearchBuilder
     :add_advanced_parse_q_to_solr,
     :show_works_or_works_that_contain_files
   ]
+
+  # show both works that match the query and works that contain files that match the query
+  def show_works_or_works_that_contain_files(solr_parameters)
+    return if solr_parameters[:q].blank?
+    solr_parameters[:user_query] = solr_parameters[:q]
+    solr_parameters[:q] = new_query
+  end
+
+  private
+
+    # the {!lucene} gives us the OR syntax
+    def new_query
+      "{!lucene}#{interal_query(dismax_query)} #{interal_query(join_for_works_from_files)}"
+    end
+
+    # the _query_ allows for another parser (aka dismax)
+    def interal_query(query_value)
+      "_query_:\"#{query_value}\""
+    end
+
+    # the {!dismax} causes the query to go against the query fields
+    def dismax_query
+      "{!dismax v=$user_query}"
+    end
+
+    # join from file id to work relationship solrized file_set_ids_ssim
+    def join_for_works_from_files
+      "{!join from=#{ActiveFedora.id_field} to=file_set_ids_ssim}#{dismax_query}"
+    end
 end

data/app/search_builders/sufia/my_collections_search_builder.rb

@@ -6,4 +6,11 @@ class Sufia::MyCollectionsSearchBuilder < Sufia::SearchBuilder
     :show_only_resources_deposited_by_current_user,
     :show_only_collections
   ]
+
+  def show_only_collections(solr_parameters)
+    solr_parameters[:fq] ||= []
+    solr_parameters[:fq] += [
+      ActiveFedora::SolrQueryBuilder.construct_query_for_rel(has_model: Collection.to_class_uri)
+    ]
+  end
 end

data/app/search_builders/sufia/my_highlights_search_builder.rb

@@ -2,7 +2,13 @@
 class Sufia::MyHighlightsSearchBuilder < Sufia::SearchBuilder
   include Sufia::MySearchBuilderBehavior
 
-  self.default_processor_chain += [
-    :show_only_highlighted_works
-  ]
+  self.default_processor_chain += [:show_only_highlighted_works]
+
+  def show_only_highlighted_works(solr_parameters)
+    ids = scope.current_user.trophies.pluck(:work_id)
+    solr_parameters[:fq] ||= []
+    solr_parameters[:fq] += [
+      ActiveFedora::SolrQueryBuilder.construct_query_for_ids(ids)
+    ]
+  end
 end

data/app/search_builders/sufia/my_shares_search_builder.rb

@@ -2,5 +2,12 @@
 class Sufia::MySharesSearchBuilder < Sufia::SearchBuilder
   include Sufia::MySearchBuilderBehavior
 
-  self.default_processor_chain = default_processor_chain - [:filter_models] + [:show_only_shared_files]
+  self.default_processor_chain += [:show_only_shared_files]
+
+  def show_only_shared_files(solr_parameters)
+    solr_parameters[:fq] ||= []
+    solr_parameters[:fq] += [
+      "-" + ActiveFedora::SolrQueryBuilder.construct_query_for_rel(depositor: scope.current_user.user_key)
+    ]
+  end
 end

data/app/search_builders/sufia/search_builder.rb

@@ -4,13 +4,6 @@ class Sufia::SearchBuilder < Blacklight::SearchBuilder
   include Hydra::AccessControlsEnforcement
   include CurationConcerns::SearchFilters
 
-  def show_only_collections(solr_parameters)
-    solr_parameters[:fq] ||= []
-    solr_parameters[:fq] += [
-      ActiveFedora::SolrQueryBuilder.construct_query_for_rel(has_model: Collection.to_class_uri)
-    ]
-  end
-
   def show_only_resources_deposited_by_current_user(solr_parameters)
     solr_parameters[:fq] ||= []
     solr_parameters[:fq] += [
@@ -24,56 +17,4 @@ class Sufia::SearchBuilder < Blacklight::SearchBuilder
       ActiveFedora::SolrQueryBuilder.construct_query_for_rel(has_model: ::GenericWork.to_class_uri)
     ]
   end
-
-  def show_only_shared_files(solr_parameters)
-    solr_parameters[:fq] ||= []
-    solr_parameters[:fq] += [
-      "-" + ActiveFedora::SolrQueryBuilder.construct_query_for_rel(depositor: scope.current_user.user_key)
-    ]
-  end
-
-  def show_only_highlighted_works(solr_parameters)
-    ids = scope.current_user.trophies.pluck(:work_id)
-    solr_parameters[:fq] ||= []
-    solr_parameters[:fq] += [
-      ActiveFedora::SolrQueryBuilder.construct_query_for_ids(ids)
-    ]
-  end
-
-  # Limits search results just to GenericWorks and collections
-  # @param solr_parameters the current solr parameters
-  # @param user_parameters the current user-submitted parameters
-  def only_works_and_collections(solr_parameters)
-    solr_parameters[:fq] ||= []
-    solr_parameters[:fq] << "#{Solrizer.solr_name('has_model', :symbol)}:(\"GenericWork\" \"Collection\")"
-  end
-
-  # show both works that match the query and works that contain files that match the query
-  def show_works_or_works_that_contain_files(solr_parameters)
-    return if solr_parameters[:q].blank?
-    solr_parameters[:user_query] = solr_parameters[:q]
-    solr_parameters[:q] = new_query
-  end
-
-  protected
-
-    # the {!lucene} gives us the OR syntax
-    def new_query
-      "{!lucene}#{interal_query(dismax_query)} #{interal_query(join_for_works_from_files)}"
-    end
-
-    # the _query_ allows for another parser (aka dismax)
-    def interal_query(query_value)
-      "_query_:\"#{query_value}\""
-    end
-
-    # the {!dismax} causes the query to go against the query fields
-    def dismax_query
-      "{!dismax v=$user_query}"
-    end
-
-    # join from file id to work relationship solrized file_set_ids_ssim
-    def join_for_works_from_files
-      "{!join from=#{ActiveFedora.id_field} to=file_set_ids_ssim}#{dismax_query}"
-    end
 end

data/app/services/sufia/analytics.rb

@@ -13,30 +13,47 @@ module Sufia
     # `  client_email: GOOGLE_OAUTH_CLIENT_EMAIL`
     # @return [Hash] A hash containing five keys: 'app_name', 'app_version', 'client_email', 'privkey_path', 'privkey_secret'
     def self.config
-      @config ||= YAML.load(File.read(File.join(Rails.root, 'config', 'analytics.yml')))['analytics']
+      @config ||= load_config
     end
+    private_class_method :config
+
+    def self.load_config
+      filename = File.join(Rails.root, 'config', 'analytics.yml')
+      yaml = YAML.load(File.read(filename))
+      unless yaml
+        Rails.logger.error("Unable to fetch any keys from #{filename}.")
+        return
+      end
+      yaml.fetch('analytics')
+    end
+    private_class_method :load_config
 
     # Generate an OAuth2 token for Google Analytics
     # @return [OAuth2::AccessToken] An OAuth2 access token for GA
     def self.token
       scope = 'https://www.googleapis.com/auth/analytics.readonly'
-      client = Google::APIClient.new(application_name: config['app_name'],
-                                     application_version: config['app_version'])
-      key = Google::APIClient::PKCS12.load_key(config['privkey_path'],
-                                               config['privkey_secret'])
-      service_account = Google::APIClient::JWTAsserter.new(config['client_email'], scope,
+      client = Google::APIClient.new(application_name: config.fetch('app_name'),
+                                     application_version: config.fetch('app_version'))
+      key = Google::APIClient::PKCS12.load_key(config.fetch('privkey_path'),
+                                               config.fetch('privkey_secret'))
+      service_account = Google::APIClient::JWTAsserter.new(config.fetch('client_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')
+      oauth_client = OAuth2::Client.new('',
+                                        '',
+                                        authorize_url: 'https://accounts.google.com/o/oauth2/auth',
+                                        token_url: 'https://accounts.google.com/o/oauth2/token')
       OAuth2::AccessToken.new(oauth_client, client.authorization.access_token)
     end
+    private_class_method :token
 
     # Return a user object linked to a Google Analytics account
     # @return [Legato::User] A user account wit GA access
     def self.user
       Legato::User.new(token)
     end
+    private_class_method :user
 
     # Return a Google Analytics profile matching specified ID
     # @ return [Legato::Management::Profile] A user profile associated with GA

data/app/services/sufia/query_service.rb

@@ -1,6 +1,6 @@
 module Sufia
   class QueryService
-    # query to find generic files created during the time range
+    # query to find works created during the time range
     # @param [DateTime] start_datetime starting date time for range query
     # @param [DateTime] end_datetime ending date time for range query
     def find_by_date_created(start_datetime, end_datetime = nil)

data/app/services/sufia/statistics/collections/over_time.rb

@@ -0,0 +1,13 @@
+module Sufia
+  module Statistics
+    module Collections
+      class OverTime < Statistics::OverTime
+        private
+
+          def relation
+            Collection
+          end
+      end
+    end
+  end
+end

data/app/services/sufia/statistics/depositors/summary.rb

@@ -0,0 +1,54 @@
+# Gather information about the depositors who have contributed to the repository
+module Sufia
+  module Statistics
+    module Depositors
+      class Summary
+        include Blacklight::SearchHelper
+
+        # @param [Time] start_date optionally specify the start date to gather the stats from
+        # @param [Time] end_date optionally specify the end date to gather the stats from
+        def initialize(start_date, end_date)
+          @start_dt = start_date
+          @end_dt = end_date
+        end
+
+        attr_accessor :start_dt, :end_dt
+
+        def depositors
+          # step through the array by twos to get each pair
+          results.map do |key, deposits|
+            user = ::User.find_by_user_key(key)
+            { key: key, deposits: deposits, user: user }
+          end
+        end
+
+        private
+
+          delegate :blacklight_config, to: CatalogController
+          delegate :depositor_field, to: DepositSearchBuilder
+
+          # results come from Solr in an array where the first item is the user and
+          # the second item is the count
+          # [ abc123, 55, ccczzz, 205 ]
+          # @return [#each] an enumerable object of tuples (user and count)
+          def results
+            facet_results = repository.search(query)
+            facet_results.facet_fields[depositor_field].each_slice(2)
+          end
+
+          def search_builder
+            DepositSearchBuilder.new([:include_depositor_facet], self)
+          end
+
+          # TODO: This can probably be pushed into the DepositSearchBuilder
+          def query
+            search_builder.merge(q: date_query).query
+          end
+
+          def date_query
+            Sufia::QueryService.new.build_date_query(start_dt, end_dt) unless start_dt.blank?
+          end
+      end
+    end
+  end
+end

data/app/services/sufia/statistics/file_sets/by_format.rb

@@ -0,0 +1,14 @@
+module Sufia
+  module Statistics
+    module FileSets
+      class ByFormat < Statistics::TermQuery
+        private
+
+          # Returns 'file_format_sim'
+          def index_key
+            Solrizer.solr_name('file_format', :facetable)
+          end
+      end
+    end
+  end
+end

data/app/services/sufia/statistics/over_time.rb

@@ -1,7 +1,7 @@
 module Sufia
   module Statistics
     # An abstract class for generating cumulative graphs
-    # you must provide a `point` method in the concrete class
+    # you must provide a `relation` method in the concrete class
     class OverTime
       # @param [Fixnum] delta_x change in x (in days)
       # @param [Time] x_min minimum date
@@ -24,12 +24,20 @@ module Sufia
 
       private
 
+        def point(min, max)
+          relation.where(query(min, max)).count
+        end
+
+        def query(min, max)
+          QueryService.new.build_date_query(min, max)
+        end
+
         def size
           ((@x_max - @x_min) / @delta_x.days.to_i).ceil
         end
 
-        def point
-          raise NotImplementedError, "Implement the point method in a base class"
+        def relation
+          raise NotImplementedError, "Implement the relation method in a concrete class"
         end
     end
   end