curation_concerns-models 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f40b99078f83355f035554d22016e711b0b0f379
-  data.tar.gz: 79c5dd9cafdd3fa8da3f3407ccd3e9a1ea672a03
+  metadata.gz: 5660b6eec6ec27f6e8c00a1a9a001a0147a66fe6
+  data.tar.gz: e45350c36fd8061b4ef31871620eeeea5f450447
 SHA512:
-  metadata.gz: f807e2358bf89d3af2ffb667fbd5740e389f202b4ff7d85e908065871f66072870b6d82c006407ad564e3b491b9b197f471c4434ed9e3d96b185bc398403110f
-  data.tar.gz: 7cf972fb99dd8b58fb79ca6b4ccc12bcc8d60637aa0e50a5ace6178762644a7a110407ec8616b2344fab135ee90dfa9dca8a7c12f4e5f207aa095c62b8291b04
+  metadata.gz: 2c1ef86aa53fe09e26c1e800780c673b3499a50c01b528257683d3ee91baa2f8719e9dab83cd2e07a621b8f8b0ba90e7c407bf7188b434b4cbaf8144e2f0b950
+  data.tar.gz: c82db879f98a32b61da80ead6d519b3259cc4ca1ad696b2c313adb70d10854d79f1db9d9efe9643417c1a16fbe821b99392b8b7e7f3e074259dc7d8ec0f55d25

data/README.md

@@ -16,6 +16,10 @@ To install FITS:
      * Adding the full fits.sh path to your PATH (e.g., in your .bash_profile), OR
      * Changing config/initializers/sufia.rb to point to your FITS location: config.fits_path = "/<your full path>/fits.sh"
 
+### Redis 2.6
+
+The redlock gem requires Redis >= 2.6.
+
 
 
 ## Installation

data/app/actors/curation_concerns/file_actor.rb

@@ -0,0 +1,83 @@
+module CurationConcerns
+  # actions for a file identified by file_set_id and relation (maps to use predicate)
+  class FileActor
+    attr_reader :file_set, :relation, :user
+
+    # @param [FileSet] file_set the parent FileSet
+    # @param [String] relation the type/use for the file.
+    # @param [User] user the user to record as the Agent acting upon the file
+    def initialize(file_set, relation, user)
+      @file_set = file_set
+      @relation = relation
+      @user = user
+    end
+
+    # Puts the uploaded content into a staging directory. Then kicks off a
+    # job to characterize and create derivatives with this on disk variant.
+    # Simultaneously moving a preservation copy to the repostiory.
+    # TODO: create a job to monitor this directory and prune old files that
+    # have made it to the repo
+    # @param [File, ActionDigest::HTTP::UploadedFile, Tempfile] file the file to save in the repository
+    def ingest_file(file)
+      working_file = copy_file_to_working_directory(file, file_set_id)
+      mime_type = file.respond_to?(:content_type) ? file.content_type : nil
+      IngestFileJob.perform_later(file_set_id, working_file, mime_type, user.user_key, relation)
+      make_derivative(file_set.id, working_file)
+      true
+    end
+
+    def revert_to(revision_id)
+      repository_file = file_set.send(relation.to_sym)
+      repository_file.restore_version(revision_id)
+
+      return false unless file_set.save
+
+      CurationConcerns::VersioningService.create(repository_file, user)
+
+      # Retrieve a copy of the orginal file from the repository
+      working_file = copy_repository_resource_to_working_directory(repository_file)
+      make_derivative(file_set_id, working_file)
+      true
+    end
+
+    private
+
+      def file_set_id
+        file_set.id
+      end
+
+      def make_derivative(file_set_id, working_file)
+        CharacterizeJob.perform_later(file_set_id, working_file)
+      end
+
+      # @param [File, ActionDispatch::Http::UploadedFile] file
+      # @param [String] id the identifer of the FileSet
+      # @return [String] path of the working file
+      def copy_file_to_working_directory(file, id)
+        file_name = file.respond_to?(:original_filename) ? file.original_filename : ::File.basename(file)
+        copy_stream_to_working_directory(id, file_name, file)
+      end
+
+      # @param [ActiveFedora::File] file the resource in the repo
+      # @return [String] path of the working file
+      def copy_repository_resource_to_working_directory(file)
+        copy_stream_to_working_directory(file_set_id, file.original_name, StringIO.new(file.content))
+      end
+
+      # @param [String] id the identifer
+      # @param [String] name the file name
+      # @param [#read] stream the stream to copy to the working directory
+      # @return [String] path of the working file
+      def copy_stream_to_working_directory(id, name, stream)
+        working_path = full_filename(id, name)
+        FileUtils.mkdir_p(File.dirname(working_path))
+        IO.copy_stream(stream, working_path)
+        working_path
+      end
+
+      def full_filename(id, original_name)
+        pair = id.scan(/..?/).first(4)
+        File.join(CurationConcerns.config.working_path, *pair, original_name)
+      end
+  end
+end

data/app/actors/curation_concerns/file_set_actor.rb

@@ -35,46 +35,36 @@ module CurationConcerns
       yield(file_set) if block_given?
     end
 
-    # Puts the uploaded content into a staging directory. Then kicks off a
-    # job to characterize and create derivatives with this on disk variant.
-    # Simultaneously moving a preservation copy to the repostiory.
-    # TODO: create a job to monitor this directory and prune old files that
-    # have made it to the repo
     # @param [File, ActionDigest::HTTP::UploadedFile, Tempfile] file the file uploaded by the user.
-    def create_content(file)
-      # Assign label and title of File Set is necessary.
+    # @param [String] relation ('original_file')
+    def create_content(file, relation = 'original_file')
+      # If the file set doesn't have a title or label assigned, set a default.
       file_set.label ||= file.respond_to?(:original_filename) ? file.original_filename : ::File.basename(file)
       file_set.title = [file_set.label] if file_set.title.blank?
 
       # Need to save the file_set in order to get an id
       return false unless file_set.save
 
-      working_file = copy_file_to_working_directory(file, file_set.id)
-      mime_type = file.respond_to?(:content_type) ? file.content_type : nil
-      IngestFileJob.perform_later(file_set.id, working_file, mime_type, user.user_key)
-      make_derivative(file_set.id, working_file)
+      FileActor.new(file_set, relation, user).ingest_file(file)
       true
     end
 
-    def revert_content(revision_id)
-      file_set.original_file.restore_version(revision_id)
-
-      return false unless file_set.save
-
-      CurationConcerns::VersioningService.create(file_set.original_file, user)
-
-      # Retrieve a copy of the orginal file from the repository
-      working_file = copy_repository_resource_to_working_directory(file_set)
-      make_derivative(file_set.id, working_file)
-
-      CurationConcerns.config.callback.run(:after_revert_content, file_set, user, revision_id)
-      true
+    # @param [String] revision_id the revision to revert to
+    # @param [String] relation ('original_file')
+    def revert_content(revision_id, relation = 'original_file')
+      file_actor = FileActor.new(file_set, relation, user)
+      if file_actor.revert_to(revision_id)
+        CurationConcerns.config.callback.run(:after_revert_content, file_set, user, revision_id)
+        true
+      else
+        false
+      end
     end
 
-    def update_content(file)
-      working_file = copy_file_to_working_directory(file, file_set.id)
-      IngestFileJob.perform_later(file_set.id, working_file, file.content_type, user.user_key)
-      make_derivative(file_set.id, working_file)
+    # @param [File, ActionDigest::HTTP::UploadedFile, Tempfile] file the file uploaded by the user.
+    # @param [String] relation ('original_file')
+    def update_content(file, relation = 'original_file')
+      FileActor.new(file_set, relation, user).ingest_file(file)
       CurationConcerns.config.callback.run(:after_update_content, file_set, user)
       true
     end
@@ -96,42 +86,6 @@ module CurationConcerns
 
     private
 
-      def make_derivative(file_set_id, working_file)
-        CharacterizeJob.perform_later(file_set_id, working_file)
-      end
-
-      # @param [File, ActionDispatch::Http::UploadedFile] file
-      # @param [String] id the identifer
-      # @return [String] path of the working file
-      def copy_file_to_working_directory(file, id)
-        # file_set.label not gaurunteed to be set at this point (e.g. if called from update_content)
-        file_set.label ||= file.respond_to?(:original_filename) ? file.original_filename : ::File.basename(file)
-        copy_stream_to_working_directory(id, file_set.label, file)
-      end
-
-      # @param [FileSet] file_set the resource
-      # @return [String] path of the working file
-      def copy_repository_resource_to_working_directory(file_set)
-        file = file_set.original_file
-        copy_stream_to_working_directory(file_set.id, file.original_name, StringIO.new(file.content))
-      end
-
-      # @param [String] id the identifer
-      # @param [String] name the file name
-      # @param [#read] stream the stream to copy to the working directory
-      # @return [String] path of the working file
-      def copy_stream_to_working_directory(id, name, stream)
-        working_path = full_filename(id, name)
-        FileUtils.mkdir_p(File.dirname(working_path))
-        IO.copy_stream(stream, working_path)
-        working_path
-      end
-
-      def full_filename(id, original_name)
-        pair = id.scan(/..?/).first(4)
-        File.join(CurationConcerns.config.working_path, *pair, original_name)
-      end
-
       # Takes an optional block and executes the block if the save was successful.
       # returns false if the save was unsuccessful
       def save

data/app/jobs/ingest_file_job.rb

@@ -1,7 +1,12 @@
 class IngestFileJob < ActiveJob::Base
   queue_as :ingest
 
-  def perform(file_set_id, filename, mime_type, user_key)
+  # @param [String] file_set_id
+  # @param [String] filename
+  # @param [String,NilClass] mime_type
+  # @param [String] user_key
+  # @param [String] relation ('original_file')
+  def perform(file_set_id, filename, mime_type, user_key, relation = 'original_file')
     file_set = FileSet.find(file_set_id)
 
     file = File.open(filename, "rb")
@@ -14,14 +19,14 @@ class IngestFileJob < ActiveJob::Base
     end
 
     # Tell AddFileToFileSet service to skip versioning because versions will be minted by VersionCommitter (called by save_characterize_and_record_committer) when necessary
-    Hydra::Works::AddFileToFileSet.call(file_set, file, :original_file, versioning: false)
+    Hydra::Works::AddFileToFileSet.call(file_set, file, relation.to_sym, versioning: false)
 
     # Persist changes to the file_set
     file_set.save!
 
     # Do post file ingest actions
     user = User.find_by_user_key(user_key)
-    CurationConcerns::VersioningService.create(file_set.original_file, user)
+    CurationConcerns::VersioningService.create(file_set.send(relation.to_sym), user)
     CurationConcerns.config.callback.run(:after_create_content, file_set, user)
   end
 end

data/app/models/concerns/curation_concerns/basic_metadata.rb

@@ -38,20 +38,6 @@ module CurationConcerns
         index.as :stored_searchable
       end
 
-      # We reserve date_uploaded for the original creation date of the record.
-      # For example, when migrating data from a fedora3 repo to fedora4,
-      # fedora's system created date will reflect the date when the record
-      # was created in fedora4, but the date_uploaded will preserve the
-      # original creation date from the old repository.
-      property :date_uploaded, predicate: ::RDF::Vocab::DC.dateSubmitted, multiple: false do |index|
-        index.type :date
-        index.as :stored_sortable
-      end
-
-      property :date_modified, predicate: ::RDF::Vocab::DC.modified, multiple: false do |index|
-        index.type :date
-        index.as :stored_sortable
-      end
       property :subject, predicate: ::RDF::Vocab::DC.subject do |index|
         index.as :stored_searchable, :facetable
       end

data/app/models/concerns/curation_concerns/collection_behavior.rb

@@ -10,7 +10,7 @@ module CurationConcerns
     include CurationConcerns::Permissions
 
     included do
-      validates :title, presence: true
+      validates_with HasOneTitleValidator
     end
 
     def to_s

data/app/models/concerns/curation_concerns/required_metadata.rb

@@ -6,9 +6,25 @@ module CurationConcerns
       property :depositor, predicate: ::RDF::URI.new('http://id.loc.gov/vocabulary/relators/dpt'), multiple: false do |index|
         index.as :symbol, :stored_searchable
       end
+
       property :title, predicate: ::RDF::Vocab::DC.title do |index|
         index.as :stored_searchable, :facetable
       end
+
+      # We reserve date_uploaded for the original creation date of the record.
+      # For example, when migrating data from a fedora3 repo to fedora4,
+      # fedora's system created date will reflect the date when the record
+      # was created in fedora4, but the date_uploaded will preserve the
+      # original creation date from the old repository.
+      property :date_uploaded, predicate: ::RDF::Vocab::DC.dateSubmitted, multiple: false do |index|
+        index.type :date
+        index.as :stored_sortable
+      end
+
+      property :date_modified, predicate: ::RDF::Vocab::DC.modified, multiple: false do |index|
+        index.type :date
+        index.as :stored_sortable
+      end
     end
   end
 end

data/app/validators/has_one_title_validator.rb

@@ -0,0 +1,8 @@
+# validates that the title has at least one title
+class HasOneTitleValidator < ActiveModel::Validator
+  def validate(record)
+    if record.title.reject(&:empty?).empty?
+      record.errors[:title] << "You must provide a title"
+    end
+  end
+end

data/curation_concerns-models.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'active_attr'
-  spec.add_dependency 'hydra-collections', '~> 7.0'
+  spec.add_dependency 'hydra-collections', '~> 8.0'
   spec.add_dependency 'hydra-head', '~> 9.3'
   spec.add_dependency 'hydra-works', '~> 0.7'
   spec.add_dependency 'active_fedora-noid', '~> 1.0'

data/lib/curation_concerns/configuration.rb

@@ -56,11 +56,24 @@ module CurationConcerns
       @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,
-                  :display_microdata, :microdata_default_type
+    attr_accessor :temp_file_base, :enable_local_ingest,
+                  :analytics, :analytic_start_date
+
+    attr_writer :display_microdata
+    def display_microdata
+      return @display_microdata unless @display_microdata.nil?
+      @display_microdata = true
+    end
+
+    attr_writer :microdata_default_type
+    def microdata_default_type
+      @microdata_default_type ||= 'http://schema.org/CreativeWork'
+    end
+
+    attr_writer :max_days_between_audits
+    def max_days_between_audits
+      @max_days_between_audits ||= 7
+    end
 
     attr_writer :enable_noids
     def enable_noids

data/lib/curation_concerns/models/engine.rb

@@ -4,7 +4,6 @@ module CurationConcerns
       config.autoload_paths += %W(
         #{config.root}/app/actors/concerns
         #{config.root}/lib/curation_concerns
-        #{config.root}/app/models/datastreams
       )
 
       initializer 'requires' do

data/lib/curation_concerns/models/version.rb

@@ -1,5 +1,5 @@
 module CurationConcerns
   module Models
-    VERSION = "0.8.0".freeze
+    VERSION = "0.9.0".freeze
   end
 end

data/lib/generators/curation_concerns/models/templates/config/curation_concerns.rb

@@ -1,55 +1,18 @@
 CurationConcerns.configure do |config|
-  config.fits_to_desc_mapping = {
-    file_title: :title,
-    file_author: :creator
-  }
-
-  config.max_days_between_audits = 7
-
-  config.resource_types = {
-    'Article' => 'Article',
-    'Audio' => 'Audio',
-    'Book' => 'Book',
-    'Capstone Project' => 'Capstone Project',
-    'Conference Proceeding' => 'Conference Proceeding',
-    'Dataset' => 'Dataset',
-    'Dissertation' => 'Dissertation',
-    'Image' => 'Image',
-    'Journal' => 'Journal',
-    'Map or Cartographic Material' => 'Map or Cartographic Material',
-    'Masters Thesis' => 'Masters Thesis',
-    'Part of Book' => 'Part of Book',
-    'Poster' => 'Poster',
-    'Presentation' => 'Presentation',
-    'Project' => 'Project',
-    'Report' => 'Report',
-    'Research Paper' => 'Research Paper',
-    'Software or Program Code' => 'Software or Program Code',
-    'Video' => 'Video',
-    'Other' => 'Other'
-  }
-
-  config.display_microdata = true
-  config.microdata_default_type = 'http://schema.org/CreativeWork'
-
-  config.resource_types_to_schema = config.resource_types.map do |k, v|
-    [k, I18n.t("curation_concerns.schema_org.resource_type.#{v}", default: config.microdata_default_type)]
-  end.to_h
-
-  config.permission_levels = {
-    'Choose Access' => 'none',
-    'View/Download' => 'read',
-    'Edit' => 'edit'
-  }
-
-  config.owner_permission_levels = {
-    'Edit' => 'edit'
-  }
+  # Should schema.org microdata be displayed?
+  # config.display_microdata = true
+
+  # What default microdata type should be used if a more appropriate
+  # type can not be found in the locale file?
+  # config.microdata_default_type = 'http://schema.org/CreativeWork'
+
+  # How frequently should a file be audited.
+  # Note: In CurationConcerns you must trigger the FileSetAuditService manually.
+  # config.max_days_between_audits = 7
 
   # Enable displaying usage statistics in the UI
-  # Defaults to FALSE
   # Requires a Google Analytics id and OAuth2 keyfile.  See README for more info
-  config.analytics = false
+  # config.analytics = false
 
   # Specify a Google Analytics tracking ID to gather usage statistics
   # config.google_analytics_id = 'UA-99999999-1'
@@ -60,12 +23,15 @@ CurationConcerns.configure do |config|
   # Where to store tempfiles, leave blank for the system temp directory (e.g. /tmp)
   # config.temp_file_base = '/home/developer1'
 
-  # Specify the form of hostpath to be used in Endnote exports
-  # config.persistent_hostpath = 'http://localhost/files/'
-
   # Location on local file system where derivatives will be stored.
+  # If you use a multi-server architecture, this MUST be a shared volume.
   # config.derivatives_path = File.join(Rails.root, 'tmp', 'derivatives')
 
+  # Location on local file system where uploaded files will be staged
+  # prior to being ingested into the repository or having derivatives generated.
+  # If you use a multi-server architecture, this MUST be a shared volume.
+  # config.working_path = File.join(Rails.root, 'tmp', 'uploads')
+
   # If you have ffmpeg installed and want to transcode audio and video uncomment this line
   # config.enable_ffmpeg = true
 
@@ -77,6 +43,7 @@ CurationConcerns.configure do |config|
   # config.noid_template = ".reeddeeddk"
 
   # Store identifier minter's state in a file for later replayability
+  # If you use a multi-server architecture, this MUST be on a shared volume.
   # config.minter_statefile = '/tmp/minter-state'
 
   # Specify the prefix for Redis keys:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curation_concerns-models
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_attr
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: hydra-head
   requirement: !ruby/object:Gem::Requirement
@@ -180,6 +180,7 @@ files:
 - app/actors/concerns/curation_concerns/manages_embargoes_actor.rb
 - app/actors/curation_concerns/base_actor.rb
 - app/actors/curation_concerns/embargo_actor.rb
+- app/actors/curation_concerns/file_actor.rb
 - app/actors/curation_concerns/file_set_actor.rb
 - app/actors/curation_concerns/lease_actor.rb
 - app/actors/curation_concerns/work_actor_behavior.rb
@@ -203,7 +204,6 @@ files:
 - app/models/concerns/curation_concerns/file_set/full_text_indexing.rb
 - app/models/concerns/curation_concerns/file_set/indexing.rb
 - app/models/concerns/curation_concerns/file_set/querying.rb
-- app/models/concerns/curation_concerns/file_set/versions.rb
 - app/models/concerns/curation_concerns/file_set_behavior.rb
 - app/models/concerns/curation_concerns/has_representative.rb
 - app/models/concerns/curation_concerns/human_readable_type.rb
@@ -234,6 +234,7 @@ files:
 - app/services/curation_concerns/thumbnail_path_service.rb
 - app/services/curation_concerns/time_service.rb
 - app/services/curation_concerns/versioning_service.rb
+- app/validators/has_one_title_validator.rb
 - config/locales/curation_concerns.en.yml
 - curation_concerns-models.gemspec
 - lib/curation_concerns/configuration.rb
@@ -282,7 +283,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Simple institutional repository models for Hydra

data/app/models/concerns/curation_concerns/file_set/versions.rb

@@ -1,15 +0,0 @@
-module CurationConcerns
-  module FileSet
-    module Versions
-      @@count = 0
-      def record_version_committer(user)
-        version = latest_version
-        # content datastream not (yet?) present
-        return if version.nil?
-        @@count += 1
-        # raise "Recording #{@@count} #{version.uri} for #{user.user_key}" if @@count == 3
-        VersionCommitter.create(version_id: version.uri, committer_login: user.user_key)
-      end
-    end
-  end
-end