curation_concerns-models 0.1.0 → 0.2.0

data/curation_concerns-models.gemspec

@@ -20,14 +20,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'active_attr'
-  spec.add_dependency 'nest', '~> 1.1'
-  spec.add_dependency 'hydra-collections', '~> 6.0.0.alpha'
-  spec.add_dependency 'hydra-head', '~> 9.2.2'
-  spec.add_dependency 'hydra-works', '~> 0.1'
-  spec.add_dependency 'active-fedora', '~> 9.3.0'
-  spec.add_dependency 'active_fedora-noid', '~> 1.0.2'
+  spec.add_dependency 'hydra-collections', '~> 6.0.0.rc1'
+  spec.add_dependency 'hydra-head', '~> 9.3'
+  spec.add_dependency 'hydra-works', '~> 0.3'
+  spec.add_dependency 'active_fedora-noid', '~> 1.0'
   spec.add_dependency 'resque', '~> 1.23'
   spec.add_dependency 'resque-pool', '~> 0.3'
+  spec.add_dependency 'qa', '~> 0.5'
+  spec.add_dependency 'redlock', '~> 0.1.2'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'

data/lib/curation_concerns/configuration.rb

@@ -0,0 +1,154 @@
+require 'curation_concerns/callbacks'
+
+module CurationConcerns
+  extend Deprecation
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Configuration.new
+    yield(config)
+  end
+
+  # Keep this deprecated class here so that anyone that references it in their config gets a deprecation rather than uninitialized constant.
+  # Remove when Configuration#queue= is removed
+  module Resque
+    class Queue
+    end
+  end
+
+  class Configuration
+    include Callbacks
+
+    # An anonymous function that receives a path to a file
+    # and returns AntiVirusScanner::NO_VIRUS_FOUND_RETURN_VALUE if no
+    # virus is found; Any other returned value means a virus was found
+    attr_writer :default_antivirus_instance
+    def default_antivirus_instance
+      @default_antivirus_instance ||= lambda do|_file_path|
+        AntiVirusScanner::NO_VIRUS_FOUND_RETURN_VALUE
+      end
+    end
+
+    # Path on the local file system where derivatives will be stored
+    attr_writer :derivatives_path
+    def derivatives_path
+      @derivatives_path ||= File.join(Rails.root, 'tmp', 'derivatives')
+    end
+
+    # Path on the local file system where originals will be staged before being ingested into Fedora.
+    attr_writer :working_path
+    def working_path
+      @working_path ||= File.join(Rails.root, 'tmp', 'uploads')
+    end
+
+    attr_writer :enable_ffmpeg
+    def enable_ffmpeg
+      return @enable_ffmpeg unless @enable_ffmpeg.nil?
+      @enable_ffmpeg = false
+    end
+
+    attr_writer :ffmpeg_path
+    def ffmpeg_path
+      @ffmpeg_path ||= 'ffmpeg'
+    end
+
+    attr_writer :fits_message_length
+    def fits_message_length
+      @fits_message_length ||= 5
+    end
+
+    attr_accessor :temp_file_base, :enable_local_ingest, :analytic_start_date,
+                  :fits_to_desc_mapping, :max_days_between_audits,
+                  :resource_types, :resource_types_to_schema,
+                  :permission_levels, :owner_permission_levels, :analytics
+
+    attr_writer :enable_noids
+    def enable_noids
+      return @enable_noids unless @enable_noids.nil?
+      @enable_noids = true
+    end
+
+    attr_writer :noid_template
+    def noid_template
+      @noid_template ||= '.reeddeeddk'
+    end
+
+    attr_writer :minter_statefile
+    def minter_statefile
+      @minter_statefile ||= '/tmp/minter-state'
+    end
+
+    attr_writer :redis_namespace
+    def redis_namespace
+      @redis_namespace ||= 'curation_concerns'
+    end
+
+    attr_writer :queue
+    deprecation_deprecate :queue=
+
+    attr_writer :fits_path
+    def fits_path
+      @fits_path ||= 'fits.sh'
+    end
+
+    # Override characterization runner
+    attr_accessor :characterization_runner
+
+    # Attributes for the lock manager which ensures a single process/thread is mutating a ore:Aggregation at once.
+    # @!attribute [w] lock_retry_count
+    #   How many times to retry to acquire the lock before raising UnableToAcquireLockError
+    attr_writer :lock_retry_count
+    def lock_retry_count
+      @lock_retry_count ||= 600 # Up to 2 minutes of trying at intervals up to 200ms
+    end
+
+    # @!attribute [w] lock_time_to_live
+    #   How long to hold the lock in milliseconds
+    attr_writer :lock_time_to_live
+    def lock_time_to_live
+      @lock_time_to_live ||= 60_000 # milliseconds
+    end
+
+    # @!attribute [w] lock_retry_delay
+    #   Maximum wait time in milliseconds before retrying. Wait time is a random value between 0 and retry_delay.
+    attr_writer :lock_retry_delay
+    def lock_retry_delay
+      @lock_retry_delay ||= 200 # milliseconds
+    end
+
+    callback.enable :after_create_content, :after_update_content,
+                    :after_revert_content, :after_update_metadata,
+                    :after_import_local_file_success,
+                    :after_import_local_file_failure, :after_audit_failure,
+                    :after_destroy, :after_import_url_success, :after_import_url_failure
+
+    def register_curation_concern(*curation_concern_types)
+      Array(curation_concern_types).flatten.compact.each do |cc_type|
+        class_name = normalize_concern_name(cc_type)
+        unless registered_curation_concern_types.include?(class_name)
+          registered_curation_concern_types << class_name
+        end
+      end
+    end
+
+    # Returns the class names (strings) of the registered curation concerns
+    def registered_curation_concern_types
+      @registered_curation_concern_types ||= []
+    end
+
+    # Returns the classes of the registered curation concerns
+    def curation_concerns
+      registered_curation_concern_types.map(&:constantize)
+    end
+
+    private
+
+      def normalize_concern_name(c)
+        c.to_s.camelize
+      end
+  end
+
+  configure {}
+end

data/lib/curation_concerns/messages.rb

@@ -8,59 +8,59 @@ module CurationConcerns
     include ActionView::Helpers::UrlHelper
 
     def success_subject
-      I18n.t("curation_concerns.messages.success.subject")
+      I18n.t('curation_concerns.messages.success.subject')
     end
 
     def failure_subject
-      I18n.t("curation_concerns.messages.failure.subject")
+      I18n.t('curation_concerns.messages.failure.subject')
     end
 
-    def single_success id, file
-      content_tag :span, id: "ss-"+id do
-        [link_to_file(file), I18n.t("curation_concerns.messages.success.single")].join(" ").html_safe
+    def single_success(id, file)
+      content_tag :span, id: 'ss-' + id do
+        [link_to_file(file), I18n.t('curation_concerns.messages.success.single')].join(' ').html_safe
       end
     end
 
-    def multiple_success id, files
-      content_tag :span, id: "ss-"+id do
-        [success_link(files), I18n.t("curation_concerns.messages.success.multiple.tag")].join(" ").html_safe
+    def multiple_success(id, files)
+      content_tag :span, id: 'ss-' + id do
+        [success_link(files), I18n.t('curation_concerns.messages.success.multiple.tag')].join(' ').html_safe
       end
     end
 
-    def single_failure id, file
-      content_tag :span, id: "ss-"+id do
-        [link_to_file(file), I18n.t("curation_concerns.messages.failure.single")].join(" ").html_safe
+    def single_failure(id, file)
+      content_tag :span, id: 'ss-' + id do
+        [link_to_file(file), I18n.t('curation_concerns.messages.failure.single')].join(' ').html_safe
       end
     end
 
-    def multiple_failure id, files
-      content_tag :span, id: "ss-"+id do
-        [failure_link(files), I18n.t("curation_concerns.messages.failure.multiple.tag")].join(" ").html_safe
+    def multiple_failure(id, files)
+      content_tag :span, id: 'ss-' + id do
+        [failure_link(files), I18n.t('curation_concerns.messages.failure.multiple.tag')].join(' ').html_safe
       end
     end
 
     # Double-quotes are replaced with single ones so this list can be included in a data block. Ex:
     #   <a href="#" data-content="<a href='#'>embedded link</a>" rel="popover">Click me</a>
-    def file_list files
-      files.map { |gf| link_to_file(gf) }.join(', ').gsub(/"/, "'")
+    def file_list(files)
+      files.map { |gf| link_to_file(gf) }.join(', ').tr("\"", "'")
     end
 
-    def link_to_file file
-      link_to(file.to_s, Rails.application.class.routes.url_helpers.curation_concerns_generic_file_path(file))
+    def link_to_file(file)
+      link_to(file.to_s, Rails.application.class.routes.url_helpers.curation_concerns_file_set_path(file))
     end
 
     private
 
-      def success_link files
-        link_to I18n.t("curation_concerns.messages.success.multiple.link"), "#",
-          rel: "popover",
-          data: { content: file_list(files).html_safe, title: I18n.t("curation_concerns.messages.success.title") }
+      def success_link(files)
+        link_to I18n.t('curation_concerns.messages.success.multiple.link'), '#',
+                rel: 'popover',
+                data: { content: file_list(files).html_safe, title: I18n.t('curation_concerns.messages.success.title') }
       end
 
-      def failure_link files
-        link_to I18n.t("curation_concerns.messages.failure.multiple.link"), "#",
-          rel: "popover",
-          data: { content: file_list(files).html_safe, title: I18n.t("curation_concerns.messages.failure.title") }
+      def failure_link(files)
+        link_to I18n.t('curation_concerns.messages.failure.multiple.link'), '#',
+                rel: 'popover',
+                data: { content: file_list(files).html_safe, title: I18n.t('curation_concerns.messages.failure.title') }
       end
   end
 end

data/lib/curation_concerns/models.rb

@@ -1,11 +1,7 @@
-require "curation_concerns/models/version"
-require "curation_concerns/models/engine"
+require 'curation_concerns/models/version'
+require 'curation_concerns/models/engine'
 
 require 'hydra/head'
-require 'nest'
-# require "active_resource" # used by GenericFile to catch errors & by GeoNamesResource
-require 'resque/server'
-
 module CurationConcerns
   extend ActiveSupport::Autoload
 
@@ -15,18 +11,13 @@ module CurationConcerns
   autoload :Utils, 'curation_concerns/models/utils'
   autoload :Permissions
   autoload :Messages
+  eager_autoload do
+    autoload :Configuration
+  end
 
   attr_writer :queue
 
   def self.queue
     @queue ||= config.queue.new('curation_concerns')
   end
-
-  def self.config(&block)
-    @@config ||= CurationConcerns::Models::Engine::Configuration.new
-
-    yield @@config if block
-
-    return @@config
-  end
 end

data/lib/curation_concerns/models/engine.rb

@@ -1,34 +1,6 @@
 module CurationConcerns
   module Models
-
-    def self.config(&block)
-      @@config ||= Engine::Configuration.new
-      yield @@config if block
-      return @@config
-    end
-
-
     class Engine < ::Rails::Engine
-
-      require 'curation_concerns/models/resque'
-
-      # Set some configuration defaults
-      config.persistent_hostpath = "http://localhost/files/"
-      config.enable_ffmpeg = false
-      config.ffmpeg_path = 'ffmpeg'
-      config.fits_message_length = 5
-      config.temp_file_base = nil
-      config.enable_noids = true
-      config.noid_template = '.reeddeeddk'
-      config.minter_statefile = '/tmp/minter-state'
-      config.redis_namespace = "curation_concerns"
-      config.fits_path = "fits.sh"
-      config.enable_local_ingest = nil
-      config.queue = CurationConcerns::Resque::Queue
-
-      # Defaulting analytic start date to whenever the file was uploaded by leaving it blank
-      config.analytic_start_date = nil
-
       config.autoload_paths += %W(
         #{config.root}/app/actors/concerns
         #{config.root}/lib/curation_concerns
@@ -54,8 +26,6 @@ module CurationConcerns
           ActiveFedora::Noid.config.statefile = c.minter_statefile
         end
       end
-
     end
-
   end
 end

data/lib/curation_concerns/models/utils.rb

@@ -8,14 +8,14 @@ module CurationConcerns
 
     module ClassMethods
       def retry_unless(number_of_tries, condition, &block)
-        raise ArgumentError, "First argument must be an enumerator" unless number_of_tries.is_a? Enumerator
-        raise ArgumentError, "Second argument must be a lambda" unless condition.respond_to? :call
-        raise ArgumentError, "Must pass a block of code to retry" unless block_given?
+        fail ArgumentError, 'First argument must be an enumerator' unless number_of_tries.is_a? Enumerator
+        fail ArgumentError, 'Second argument must be a lambda' unless condition.respond_to? :call
+        fail ArgumentError, 'Must pass a block of code to retry' unless block_given?
         number_of_tries.each do
           result = block.call
           return result unless condition.call
         end
-        raise RuntimeError, "retry_unless could not complete successfully. Try upping the # of tries?"
+        fail 'retry_unless could not complete successfully. Try upping the # of tries?'
       end
     end
   end

data/lib/curation_concerns/models/version.rb

@@ -1,5 +1,5 @@
 module CurationConcerns
   module Models
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

data/lib/generators/curation_concerns/models/abstract_migration_generator.rb

@@ -11,10 +11,11 @@ class CurationConcerns::Models::AbstractMigrationGenerator < Rails::Generators::
     if @prev_migration_nr
       @prev_migration_nr += 1
     else
-      if last_migration = Dir[File.join(path, '*.rb')].sort.last
+      last_migration = Dir[File.join(path, '*.rb')].sort.last
+      if last_migration
         @prev_migration_nr = last_migration.sub(File.join(path, '/'), '').to_i + 1
       else
-        @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        @prev_migration_nr = Time.now.utc.strftime('%Y%m%d%H%M%S').to_i
       end
     end
     @prev_migration_nr.to_s
@@ -22,9 +23,9 @@ class CurationConcerns::Models::AbstractMigrationGenerator < Rails::Generators::
 
   protected
 
-  def better_migration_template(file)
-    migration_template "migrations/#{file}", "db/migrate/#{file}"
-  rescue Rails::Generators::Error => e
-    say_status("warning", e.message, :yellow)
-  end
+    def better_migration_template(file)
+      migration_template "migrations/#{file}", "db/migrate/#{file}"
+    rescue Rails::Generators::Error => e
+      say_status('warning', e.message, :yellow)
+    end
 end

data/lib/generators/curation_concerns/models/clamav_generator.rb

@@ -4,13 +4,13 @@ require 'rails/generators'
 class CurationConcerns::Models::ClamavGenerator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
 
-  desc """
+  desc ''"
 This generator makes the following changes to your application:
  1. Generates clamav initializer
-       """
+       "''
 
   def banner
-    say_status("info", "Generating clamav initializers", :blue)
+    say_status('info', 'Generating clamav initializers', :blue)
   end
 
   def create_initializer_file

data/lib/generators/curation_concerns/models/install_generator.rb

@@ -2,23 +2,24 @@ require_relative 'abstract_migration_generator'
 
 class CurationConcerns::Models::InstallGenerator < CurationConcerns::Models::AbstractMigrationGenerator
   source_root File.expand_path('../templates', __FILE__)
-  argument     :model_name, type: :string , default: "user"
-  desc """
+  argument :model_name, type: :string, default: 'user'
+  desc ''"
 This generator makes the following changes to your application:
  1. Creates several database migrations if they do not exist in /db/migrate
  2. Creates the curation_concerns.rb configuration file and several others
- 3. Creates the generic_file.rb, generic_work.rb and collection.rb models
+ 3. Creates the file_set.rb, generic_work.rb and collection.rb models
  4. Runs full-text generator
-       """
+       "''
   def banner
-    say_status("warning", "GENERATING CURATION_CONCERNS MODELS", :yellow)
+    say_status('warning', 'GENERATING CURATION_CONCERNS MODELS', :yellow)
   end
 
   # Setup the database migrations
   def copy_migrations
     [
-      "create_version_committers.rb",
-      "create_checksum_audit_logs.rb"#,
+      'create_version_committers.rb',
+      'create_checksum_audit_logs.rb',
+      'create_single_use_links.rb' # ,
     ].each do |file|
       better_migration_template file
     end
@@ -27,9 +28,9 @@ This generator makes the following changes to your application:
   # Add behaviors to the user model
   def inject_curation_concerns_user_behavior
     file_path = "app/models/#{model_name.underscore}.rb"
-    if File.exists?(file_path)
+    if File.exist?(file_path)
       inject_into_file file_path, after: /include Hydra\:\:User.*$/ do
-        "\n  # Connects this user object to Curation Concerns behaviors." +
+        "\n  # Connects this user object to Curation Concerns behaviors." \
         "\n  include CurationConcerns::User\n"
       end
     else
@@ -39,12 +40,11 @@ This generator makes the following changes to your application:
 
   def create_configuration_files
     append_file 'config/initializers/mime_types.rb',
-                     "\nMime::Type.register 'application/x-endnote-refer', :endnote", {verbose: false }
+                "\nMime::Type.register 'application/x-endnote-refer', :endnote", verbose: false
     copy_file 'config/curation_concerns.rb', 'config/initializers/curation_concerns.rb'
     copy_file 'config/redis.yml', 'config/redis.yml'
     copy_file 'config/resque-pool.yml', 'config/resque-pool.yml'
     copy_file 'config/redis_config.rb', 'config/initializers/redis_config.rb'
-    copy_file 'config/resque_admin.rb', 'config/initializers/resque_admin.rb'
     copy_file 'config/resque_config.rb', 'config/initializers/resque_config.rb'
   end
 
@@ -52,19 +52,12 @@ This generator makes the following changes to your application:
     copy_file 'app/models/collection.rb', 'app/models/collection.rb'
   end
 
-  def create_generic_file
-    copy_file 'app/models/generic_file.rb', 'app/models/generic_file.rb'
-  end
-
-  # Sets up full-text indexing (Solr config + jars)
-  def full_text_indexing
-    generate "curation_concerns:models:fulltext"
+  def create_file_set
+    copy_file 'app/models/file_set.rb', 'app/models/file_set.rb'
   end
 
   # Adds clamav initializtion
   def clamav
     generate 'curation_concerns:models:clamav'
   end
-
-
 end