test_hyrax 0.0.1.alpha

data/app/search_builders/hyrax/single_use_link_search_builder.rb

@@ -0,0 +1,6 @@
+module Hyrax
+  class SingleUseLinkSearchBuilder < ::SearchBuilder
+    include Hyrax::SingleResult
+    self.default_processor_chain = [:find_one]
+  end
+end

data/app/search_builders/hyrax/work_relation.rb

@@ -0,0 +1,7 @@
+module Hyrax
+  class WorkRelation < AbstractTypeRelation
+    def allowable_types
+      Hyrax.config.curation_concerns
+    end
+  end
+end

data/app/search_builders/hyrax/work_search_builder.rb

@@ -0,0 +1,10 @@
+module Hyrax
+  # Finds a single work result. It returns no result if you don't have
+  # access to the requested work.  If the work is suppressed (due to being in a
+  # workflow), then it checks to see if the current_user has any workflow role
+  # on the given work.
+  class WorkSearchBuilder < ::SearchBuilder
+    include SingleResult
+    include FilterSuppressedWithRoles
+  end
+end

data/app/search_builders/parent_collection_search_builder.rb

@@ -0,0 +1,10 @@
+# Given the id of a work, find the collections it is a member of
+class ParentCollectionSearchBuilder < Hyrax::CollectionSearchBuilder
+  delegate :item, to: :scope
+
+  # include filters into the query to only include the collection memebers
+  def include_item_ids(solr_parameters)
+    solr_parameters[:fq] ||= []
+    solr_parameters[:fq] << "child_object_ids_ssim:#{item.id}"
+  end
+end

data/app/services/hyrax/actor_factory.rb

@@ -0,0 +1,30 @@
+module Hyrax
+  class ActorFactory
+    def self.stack_actors(curation_concern)
+      [CreateWithRemoteFilesActor,
+       CreateWithFilesActor,
+       Hyrax::Actors::AddAsMemberOfCollectionsActor,
+       Hyrax::Actors::AddToWorkActor,
+       Hyrax::Actors::AssignRepresentativeActor,
+       Hyrax::Actors::AttachFilesActor,
+       Hyrax::Actors::ApplyOrderActor,
+       Hyrax::Actors::InterpretVisibilityActor,
+       DefaultAdminSetActor,
+       ApplyPermissionTemplateActor,
+       model_actor(curation_concern),
+       # Initialize workflow after model is saved
+       Hyrax::Actors::InitializeWorkflowActor]
+    end
+
+    def self.build(curation_concern, current_user)
+      Actors::ActorStack.new(curation_concern,
+                             current_user,
+                             stack_actors(curation_concern))
+    end
+
+    def self.model_actor(curation_concern)
+      actor_identifier = curation_concern.class.to_s.split('::').last
+      "Hyrax::Actors::#{actor_identifier}Actor".constantize
+    end
+  end
+end

data/app/services/hyrax/admin_set_create_service.rb

@@ -0,0 +1,41 @@
+module Hyrax
+  # Creates AdminSets
+  class AdminSetCreateService
+    # Creates an admin set, setting the creator and the default access controls.
+    # @param admin_set [AdminSet] the admin set to operate on
+    # @param creating_user [User] the user who created the admin set.
+    # @return [TrueClass, FalseClass] true if it was successful
+    def self.call(admin_set, creating_user)
+      new(admin_set, creating_user).create
+    end
+
+    # @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.tap do |result|
+        create_permission_template if result
+      end
+    end
+
+    private
+
+      def create_permission_template
+        PermissionTemplate.create!(admin_set_id: admin_set.id,
+                                   access_grants_attributes: [{ agent_type: 'user',
+                                                                agent_id: creating_user.user_key,
+                                                                access: 'manage' }])
+      end
+  end
+end

data/app/services/hyrax/admin_set_service.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+module Hyrax
+  # Returns AdminSets that the current user has permission to use.
+  class AdminSetService
+    attr_reader :context, :search_builder
+    class_attribute :default_search_builder
+    self.default_search_builder = Hyrax::AdminSetSearchBuilder
+
+    # @param [#repository,#blacklight_config,#current_ability] context
+    def initialize(context, search_builder = default_search_builder)
+      @context = context
+      @search_builder = search_builder
+    end
+
+    # @param [Symbol] access :read or :edit
+    def search_results(access)
+      response = context.repository.search(builder(access))
+      response.documents
+    end
+
+    # This performs a two pass query, first getting the AdminSets and then getting the work counts
+    # @param [Symbol] access :read or :edit
+    # @return [Array<Array>] a list with document, then work count
+    def search_results_with_work_count(access)
+      documents = search_results(access)
+      ids = documents.map(&:id).join(',')
+      join_field = "isPartOf_ssim"
+      query = "{!terms f=#{join_field}}#{ids}"
+      results = ActiveFedora::SolrService.instance.conn.get(
+        ActiveFedora::SolrService.select_path,
+        params: { fq: query,
+                  'facet.field' => join_field }
+      )
+      counts = results['facet_counts']['facet_fields'][join_field].each_slice(2).to_h
+      documents.map do |doc|
+        [doc, counts[doc.id].to_i]
+      end
+    end
+
+    # Return AdminSet selectbox options based on access type
+    # @param [Symbol] access :read or :edit
+    def select_options(access = :read)
+      search_results(access).map do |admin_set|
+        [admin_set.to_s, admin_set.id, data_attributes(admin_set)]
+      end
+    end
+
+    private
+
+      # @param [Symbol] access :read or :edit
+      def builder(access)
+        search_builder.new(context, access)
+      end
+
+      # Create a hash of HTML5 'data' attributes. These attributes are added to select_options and
+      # later utilized by Javascript to limit new Work options based on AdminSet selected
+      def data_attributes(admin_set)
+        attrs = {}
+
+        permission_template = PermissionTemplate.find_by!(admin_set_id: admin_set.id)
+        # Leverage all PermissionTemplate release & visibility data attributes (if not blank or false)
+        attrs['data-release-date'] = permission_template.release_date unless permission_template.release_date.blank?
+        attrs['data-release-before-date'] = true if permission_template.release_before_date?
+        attrs['data-visibility'] = permission_template.visibility unless permission_template.visibility.blank?
+        attrs
+      end
+  end
+end

data/app/services/hyrax/analytics.rb

@@ -0,0 +1,90 @@
+require 'oauth2'
+require 'signet/oauth_2/client'
+
+module Hyrax
+  module Analytics
+    # Loads configuration options from config/analytics.yml. Expected structure:
+    # `analytics:`
+    # `  app_name: GOOGLE_OAUTH_APP_NAME`
+    # `  app_version: GOOGLE_OAUTH_APP_VERSION`
+    # `  privkey_path: GOOGLE_OAUTH_PRIVATE_KEY_PATH`
+    # `  privkey_secret: GOOGLE_OAUTH_PRIVATE_KEY_SECRET`
+    # `  client_email: GOOGLE_OAUTH_CLIENT_EMAIL`
+    # @return [Config]
+    def self.config
+      @config ||= Config.load_from_yaml
+    end
+    private_class_method :config
+
+    class Config
+      def self.load_from_yaml
+        filename = Rails.root.join('config', 'analytics.yml')
+        yaml = YAML.safe_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
+    end
+
+    # 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')
+      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
+    # @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
+    def self.profile
+      return unless config.valid?
+      user.profiles.detect do |profile|
+        profile.web_property_id == Hyrax.config.google_analytics_id
+      end
+    end
+  end
+end

data/app/services/hyrax/audit_failure_service.rb

@@ -0,0 +1,20 @@
+module Hyrax
+  class AuditFailureService < MessageUserService
+    attr_reader :log_date
+
+    def initialize(file_set, user, log_date)
+      @log_date = log_date
+      super(file_set, user)
+    end
+
+    def message
+      uri = file_set.original_file.uri.to_s
+      file_title = file_set.title.first
+      "The audit run at #{log_date} for #{file_title} (#{uri}) failed."
+    end
+
+    def subject
+      'Failing Audit Run'
+    end
+  end
+end

data/app/services/hyrax/batch_create_failure_service.rb

@@ -0,0 +1,16 @@
+module Hyrax
+  class BatchCreateFailureService < MessageUserService
+    attr_reader :user
+    def initialize(user)
+      @user = user
+    end
+
+    def message
+      "The batch create for #{user} failed"
+    end
+
+    def subject
+      'Failing batch create'
+    end
+  end
+end

data/app/services/hyrax/batch_create_success_service.rb

@@ -0,0 +1,17 @@
+module Hyrax
+  class BatchCreateSuccessService < MessageUserService
+    attr_reader :user
+
+    def initialize(user)
+      @user = user
+    end
+
+    def message
+      "The batch create for #{user} passed."
+    end
+
+    def subject
+      'Passing batch create'
+    end
+  end
+end

data/app/services/hyrax/change_content_depositor_service.rb

@@ -0,0 +1,18 @@
+module Hyrax
+  class ChangeContentDepositorService
+    # @param [ActiveFedora::Base] work
+    # @param [User] user
+    # @param [TrueClass, FalseClass] reset
+    def self.call(work, user, reset)
+      work.proxy_depositor = work.depositor
+      work.permissions = [] if reset
+      work.apply_depositor_metadata(user)
+      work.file_sets.each do |f|
+        f.apply_depositor_metadata(user)
+        f.save!
+      end
+      work.save!
+      work
+    end
+  end
+end

data/app/services/hyrax/collection_member_service.rb

@@ -0,0 +1,30 @@
+# returns a list of solr documents for collections the item is a part of
+module Hyrax
+  class CollectionMemberService
+    include Blacklight::Configurable
+    include Blacklight::SearchHelper
+
+    attr_reader :item
+
+    copy_blacklight_config_from(CatalogController)
+
+    # @param [SolrDocument] item represents a work
+    def self.run(item)
+      new(item).list_collections
+    end
+
+    def initialize(item)
+      @item = item
+    end
+
+    def list_collections
+      query = collection_search_builder.rows(1000)
+      resp = repository.search(query)
+      resp.documents
+    end
+
+    def collection_search_builder
+      @collection_search_builder ||= ParentCollectionSearchBuilder.new([:include_item_ids, :add_paging_to_solr], self)
+    end
+  end
+end

data/app/services/hyrax/collection_size_service.rb

@@ -0,0 +1,40 @@
+# returns a list of solr documents for collections the item is a part of
+module Hyrax
+  class CollectionSizeService
+    include Blacklight::Configurable
+    include Blacklight::SearchHelper
+
+    attr_reader :collection
+
+    copy_blacklight_config_from(CatalogController)
+
+    def self.run(collection)
+      new(collection).collection_size
+    end
+
+    def initialize(collection)
+      @collection = collection
+    end
+
+    def collection_size
+      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|
+        total + (doc[field_name].blank? ? 0 : doc[field_name][0].to_f)
+      end
+    end
+
+    def collection_search_builder
+      @collection_search_builder ||= MemberWithFilesSearchBuilder.new([:include_contained_files, :add_paging_to_solr], self)
+    end
+
+    def size_field
+      Solrizer.solr_name(:file_size, :symbol)
+    end
+
+    def max_collection_size
+      1000
+    end
+  end
+end

data/app/services/hyrax/collection_thumbnail_path_service.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module Hyrax
+  class CollectionThumbnailPathService < Hyrax::ThumbnailPathService
+    class << self
+      def default_image
+        ActionController::Base.helpers.image_path 'collection.png'
+      end
+    end
+  end
+end

data/app/services/hyrax/collections_service.rb

@@ -0,0 +1,28 @@
+module Hyrax
+  class CollectionsService
+    attr_reader :context
+
+    class_attribute :list_search_builder_class
+    self.list_search_builder_class = Hyrax::CollectionSearchBuilder
+
+    # @param [#repository,#blacklight_config,#current_ability] context
+    def initialize(context)
+      @context = context
+    end
+
+    # @param [Symbol] access :read or :edit
+    def search_results(access)
+      builder = list_search_builder(access)
+      response = context.repository.search(builder)
+      response.documents
+    end
+
+    private
+
+      def list_search_builder(access)
+        list_search_builder_class.new(context).tap do |builder|
+          builder.discovery_perms = [access]
+        end
+      end
+  end
+end