sufia 7.1.0 → 7.2.0

data/app/presenters/sufia/admin_dashboard_presenter.rb

@@ -0,0 +1,8 @@
+module Sufia
+  class AdminDashboardPresenter
+    # @return [Fixnum] the number of currently registered users
+    def user_count
+      ::User.count
+    end
+  end
+end

data/app/presenters/sufia/admin_set_presenter.rb

@@ -0,0 +1,7 @@
+module Sufia
+  class AdminSetPresenter < CollectionPresenter
+    def total_items
+      ActiveFedora::SolrService.count("{!field f=isPartOf_ssim}#{id}", fl: id)
+    end
+  end
+end

data/app/presenters/sufia/admin_stats_presenter.rb

@@ -35,10 +35,6 @@ module Sufia
       @works_count ||= Sufia::Statistics::Works::Count.new(start_date, end_date).by_permission
     end
 
-    def users_count
-      @users_count ||= stats.users_count
-    end
-
     def date_filter_string
       if start_date.blank?
         "unfiltered"

data/app/presenters/sufia/collection_presenter.rb

@@ -2,11 +2,12 @@ module Sufia
   class CollectionPresenter < CurationConcerns::CollectionPresenter
     delegate :resource_type, :based_near, :related_url, :identifier, to: :solr_document
 
-    # Terms is the list of fields displayed by app/views/collections/_show_descriptions.html.erb
+    # Terms is the list of fields displayed by
+    # app/views/collections/_show_descriptions.html.erb
     def self.terms
-      [:title, :total_items, :size, :resource_type, :description, :creator,
-       :contributor, :keyword, :rights, :publisher, :date_created, :subject,
-       :language, :identifier, :based_near, :related_url]
+      [:total_items, :size, :resource_type, :creator, :contributor, :keyword,
+       :rights, :publisher, :date_created, :subject, :language, :identifier,
+       :based_near, :related_url]
     end
 
     def terms_with_values

data/app/presenters/sufia/file_set_presenter.rb

@@ -1,10 +1,18 @@
 module Sufia
   class FileSetPresenter < ::CurationConcerns::FileSetPresenter
-    include Sufia::CharacterizationBehavior
+    include WithEvents
 
     delegate :depositor, :keyword, :date_created, :date_modified, :itemtype,
              to: :solr_document
 
+    def page_title
+      title.first
+    end
+
+    def link_name
+      current_ability.can?(:read, id) ? page_title : 'File'
+    end
+
     def editor?
       current_ability.can?(:edit, solr_document)
     end
@@ -27,8 +35,13 @@ module Sufia
       Sufia::Engine.routes.url_helpers.stats_file_path(self)
     end
 
-    def events
-      @events ||= solr_document.to_model.events(100)
+    def events(size = 100)
+      super(size)
+    end
+
+    # This overrides the method in WithEvents
+    def event_class
+      solr_document.to_model.model_name.name
     end
 
     def audit_status

data/app/presenters/sufia/file_usage.rb

@@ -0,0 +1,37 @@
+# Called by the stats controller, it finds cached file pageview data,
+# and prepares it for visualization in /app/views/stats/file.html.erb
+module Sufia
+  class FileUsage < StatsUsagePresenter
+    def initialize(id)
+      self.model = ::FileSet.find(id)
+    end
+
+    alias file model
+
+    def total_downloads
+      downloads.reduce(0) { |total, result| total + result[1].to_i }
+    end
+
+    def total_pageviews
+      pageviews.reduce(0) { |total, result| total + result[1].to_i }
+    end
+
+    # Package data for visualization using JQuery Flot
+    def to_flot
+      [
+        { label: "Pageviews",  data: pageviews },
+        { label: "Downloads",  data: downloads }
+      ]
+    end
+
+    private
+
+      def downloads
+        to_flots(FileDownloadStat.statistics(model, created, user_id))
+      end
+
+      def pageviews
+        to_flots(FileViewStat.statistics(model, created, user_id))
+      end
+  end
+end

data/app/presenters/sufia/stats_usage_presenter.rb

@@ -0,0 +1,43 @@
+module Sufia
+  # Methods used by both WorkUsage and FileUsage
+  class StatsUsagePresenter
+    attr_accessor :id, :model
+
+    def created
+      @created ||= date_for_analytics
+    end
+
+    private
+
+      def user_id
+        @user_id ||= begin
+                       user = Hydra::Ability.user_class.find_by_user_key(model.depositor)
+                       user ? user.id : nil
+                     end
+      end
+
+      # TODO: make this a lazy enumerator
+      def to_flots(stats)
+        stats.map(&:to_flot)
+      end
+
+      # model.date_uploaded reflects the date the object was uploaded by the user
+      # and therefore (if available) the date that we want to use for the stats
+      # model.create_date reflects the date the file was added to Fedora. On data
+      # migrated from one repository to another the created_date can be later
+      # than the date the file was uploaded.
+      def date_for_analytics
+        earliest = Sufia.config.analytic_start_date
+        date_uploaded = string_to_date(model.date_uploaded)
+        date_analytics = date_uploaded ? date_uploaded : model.create_date
+        return date_analytics if earliest.blank?
+        earliest > date_analytics ? earliest : date_analytics
+      end
+
+      def string_to_date(date_str)
+        Time.zone.parse(date_str)
+      rescue ArgumentError, TypeError
+        nil
+      end
+  end
+end

data/app/presenters/sufia/trophy_presenter.rb

@@ -14,6 +14,8 @@ module Sufia
       query = ActiveFedora::SolrQueryBuilder.construct_query_for_ids(work_ids)
       results = CurationConcerns::WorkRelation.new.search_with_conditions(query)
       results.map { |result| TrophyPresenter.new(document_model.new(result)) }
+    rescue RSolr::Error::ConnectionRefused
+      []
     end
 
     def thumbnail_path

data/app/presenters/sufia/work_show_presenter.rb

@@ -2,7 +2,9 @@ module Sufia
   class WorkShowPresenter < ::CurationConcerns::WorkShowPresenter
     # delegate fields from Sufia::Works::Metadata to solr_document
     delegate :based_near, :related_url, :depositor, :identifier, :resource_type,
-             :keyword, :itemtype, to: :solr_document
+             :keyword, :itemtype, :admin_set, to: :solr_document
+
+    self.file_presenter_class = Sufia::FileSetPresenter
 
     def editor?
       current_ability.can?(:edit, solr_document)

data/app/presenters/sufia/work_usage.rb

@@ -0,0 +1,30 @@
+# class WorkUsage follows the model established by FileUsage
+# Called by the stats controller, it finds cached work pageview data,
+# and prepares it for visualization in /app/views/stats/work.html.erb
+module Sufia
+  class WorkUsage < StatsUsagePresenter
+    def initialize(id)
+      self.model = CurationConcerns::WorkRelation.new.find(id)
+    end
+
+    alias work model
+    delegate :to_s, to: :model
+
+    def total_pageviews
+      pageviews.reduce(0) { |total, result| total + result[1].to_i }
+    end
+
+    # Package data for visualization using JQuery Flot
+    def to_flot
+      [
+        { label: "Pageviews", data: pageviews }
+      ]
+    end
+
+    private
+
+      def pageviews
+        to_flots WorkViewStat.statistics(model, created, user_id)
+      end
+  end
+end

data/app/search_builders/collection_search_builder.rb

@@ -8,6 +8,6 @@ class CollectionSearchBuilder < CurationConcerns::MemberSearchBuilder
   # This is like include_collection_ids, but it also joins the files.
   def include_contained_files(solr_parameters)
     solr_parameters[:fq] ||= []
-    solr_parameters[:fq] << "{!join from=file_set_ids_ssim to=id}{!join from=child_object_ids_ssim to=id}id:#{collection.id}"
+    solr_parameters[:fq] << "{!join from=file_set_ids_ssim to=id}{!join from=child_object_ids_ssim to=id}id:#{collection_id}"
   end
 end

data/app/search_builders/sufia/admin_set_member_search_builder.rb

@@ -0,0 +1,12 @@
+module Sufia
+  # Builds a query to find the members of an admin set.
+  class AdminSetMemberSearchBuilder < ::SearchBuilder
+    self.default_processor_chain += [:in_admin_set]
+
+    # include filters into the query to only include the collection memebers
+    def in_admin_set(solr_parameters)
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << "{!term f=isPartOf_ssim}#{blacklight_params.fetch('id')}"
+    end
+  end
+end

data/app/search_builders/sufia/single_admin_set_search_builder.rb

@@ -0,0 +1,9 @@
+module Sufia
+  class SingleAdminSetSearchBuilder < CurationConcerns::AdminSetSearchBuilder
+    include CurationConcerns::SingleResult
+
+    def initialize(context)
+      super(context, :read)
+    end
+  end
+end

data/app/services/sufia/admin_set_service.rb

@@ -0,0 +1,22 @@
+module Sufia
+  # Creates AdminSets
+  class AdminSetService
+    # @param admin_set [AdminSet] the admin set to operate on
+    # @param creating_user [User] the user who created the admin set.
+    def initialize(admin_set, creating_user)
+      @admin_set = admin_set
+      @creating_user = creating_user
+    end
+
+    attr_reader :creating_user, :admin_set
+
+    # Creates an admin set, setting the creator and the default access controls.
+    # @return [TrueClass, FalseClass] true if it was successful
+    def create
+      admin_set.read_groups = ['public']
+      admin_set.edit_groups = ['admin']
+      admin_set.creator = [creating_user.user_key]
+      admin_set.save
+    end
+  end
+end

data/app/services/sufia/analytics.rb

@@ -1,5 +1,5 @@
-require 'google/api_client'
 require 'oauth2'
+require 'signet/oauth_2/client'
 require 'legato'
 
 module Sufia
@@ -11,41 +11,65 @@ module Sufia
     # `  privkey_path: GOOGLE_OAUTH_PRIVATE_KEY_PATH`
     # `  privkey_secret: GOOGLE_OAUTH_PRIVATE_KEY_SECRET`
     # `  client_email: GOOGLE_OAUTH_CLIENT_EMAIL`
-    # @return [Hash] A hash containing five keys: 'app_name', 'app_version', 'client_email', 'privkey_path', 'privkey_secret'
+    # @return [Config]
     def self.config
-      @config ||= load_config
+      @config ||= Config.load_from_yaml
     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
+    class Config
+      def self.load_from_yaml
+        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 new({})
+        end
+        new yaml.fetch('analytics')
+      end
+
+      REQUIRED_KEYS = %w(app_name app_version privkey_path privkey_secret client_email).freeze
+
+      def initialize(config)
+        @config = config
+      end
+
+      # @return [Boolean] are all the required values present?
+      def valid?
+        config_keys = @config.keys
+        REQUIRED_KEYS.all? { |required| config_keys.include?(required) }
+      end
+
+      REQUIRED_KEYS.each do |key|
+        class_eval %{ def #{key};  @config.fetch('#{key}'); end }
       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.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')
-      OAuth2::AccessToken.new(oauth_client, client.authorization.access_token)
+    def self.token(scope = 'https://www.googleapis.com/auth/analytics.readonly')
+      access_token = auth_client(scope).fetch_access_token!
+      OAuth2::AccessToken.new(oauth_client, access_token['access_token'], expires_in: access_token['expires_in'])
     end
+
+    def self.oauth_client
+      OAuth2::Client.new('', '', authorize_url: 'https://accounts.google.com/o/oauth2/auth',
+                                 token_url: 'https://accounts.google.com/o/oauth2/token')
+    end
+
+    def self.auth_client(scope)
+      unless File.exist?(config.privkey_path)
+        raise "Private key file for Google analytics was expected at '#{config.privkey_path}', but no file was found."
+      end
+      private_key = File.read(config.privkey_path)
+      Signet::OAuth2::Client.new token_credential_uri: 'https://accounts.google.com/o/oauth2/token',
+                                 audience: 'https://accounts.google.com/o/oauth2/token',
+                                 scope: scope,
+                                 issuer: config.client_email,
+                                 signing_key: OpenSSL::PKCS12.new(private_key, config.privkey_secret).key,
+                                 sub: config.client_email
+    end
+
     private_class_method :token
 
     # Return a user object linked to a Google Analytics account
@@ -58,6 +82,7 @@ module Sufia
     # Return a Google Analytics profile matching specified ID
     # @ return [Legato::Management::Profile] A user profile associated with GA
     def self.profile
+      return unless config.valid?
       user.profiles.detect do |profile|
         profile.web_property_id == Sufia.config.google_analytics_id
       end

data/app/services/sufia/collection_size_service.rb

@@ -17,7 +17,7 @@ module Sufia
     end
 
     def collection_size
-      query = collection_search_builder.rows(max_collection_size).merge(fl: [size_field])
+      query = collection_search_builder.with('id' => collection.id).rows(max_collection_size).merge(fl: [size_field])
       resp = repository.search(query)
       field_name = size_field
       resp.documents.reduce(0) do |total, doc|

data/app/services/sufia/file_set_csv_service.rb

@@ -25,7 +25,7 @@ module Sufia
       ::CSV.generate do |csv|
         csv << terms.map do |term|
           values = file_set.send(term)
-          values = Array.wrap(values) # make sure we have an array
+          values = values.respond_to?(:to_a) ? values.to_a : [values] # make sure we have an array
           values.join(multi_value_separator)
         end
       end

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

@@ -39,12 +39,6 @@ module Sufia
         ::User.recent_users start_date, end_date
       end
 
-      # returns [Number] the number of currently registered users
-      #
-      def users_count
-        ::User.count
-      end
-
       private
 
         def validate_limit(count)

data/app/views/_controls.html.erb

@@ -2,10 +2,14 @@
   <div class="container-fluid">
     <div class="row">
       <ul class="nav navbar-nav col-sm-5 col-md-6">
-        <li <%= 'class=active' if current_page?(sufia.root_path) %>><%= link_to 'Home', sufia.root_path, :'data-no-turbolink'=>"true" %></li>
-        <li <%= 'class=active' if current_page?(sufia.about_path) %>><%= link_to 'About', sufia.about_path, :'data-no-turbolink'=>"true" %></li>
-        <li <%= 'class=active' if action_name == "help" %>><a href="<%= sufia.static_path('help') %>">Help</a></li>
-        <li <%= 'class=active' if current_page?(sufia.contact_path) %>><a href="<%= sufia.contact_path %>">Contact</a></li>
+        <li <%= 'class=active' if current_page?(sufia.root_path) %>>
+          <%= link_to t(:'sufia.controls.home'), sufia.root_path, :'data-no-turbolink'=>"true" %></li>
+        <li <%= 'class=active' if current_page?(sufia.about_path) %>>
+          <%= link_to t(:'sufia.controls.about'), sufia.about_path, :'data-no-turbolink'=>"true" %></li>
+        <li <%= 'class=active' if action_name == "help" %>>
+          <%= link_to t(:'sufia.controls.help'), sufia.help_path %></li>
+        <li <%= 'class=active' if current_page?(sufia.contact_path) %>>
+          <%= link_to t(:'sufia.controls.contact'), sufia.contact_path %></li>
       </ul><!-- /.nav -->
       <div class="searchbar-right navbar-right col-sm-7 col-md-6">
         <%= render partial: 'catalog/search_form' %>

data/app/views/_logo.html.erb

@@ -1,4 +1,4 @@
 <a id="logo" class="navbar-brand" href="<%= sufia.root_path %>" data-no-turbolink="true">
   <span class="glyphicon glyphicon-globe"></span>
-  <span class="institution_name"><%=application_name %></span>
+  <span class="institution_name"><%= application_name %></span>
 </a>