curate 0.0.1 → 0.1.0

data/app/models/object_access.rb

@@ -0,0 +1,17 @@
+class ObjectAccess < ActiveRecord::Base
+  self.establish_connection("#{Rails.env}_remote_purl_database".to_sym)
+  self.table_name = "object_access"
+
+  attr_accessible :date_accessed
+
+  def self.create_from_purl(purl)
+    if purl.nil?
+      return
+    end
+    create do |object_access|
+      object_access.date_accessed= purl.date_created
+      object_access.repo_object_id= purl.repo_object_id
+      object_access.purl_id= purl.purl_id
+    end
+  end
+end

data/app/models/purl.rb

@@ -0,0 +1,18 @@
+class Purl < ActiveRecord::Base
+  self.establish_connection("#{Rails.env}_remote_purl_database".to_sym)
+  self.table_name = "purl"
+
+  attr_accessible :date_created
+
+  def self.create_from_repo_object(repo_object)
+    if repo_object.nil?
+      return
+    end
+    create do |purl|
+      purl.repo_object_id= repo_object.repo_object_id
+      purl.access_count= 0
+      purl.date_created= repo_object.date_added
+    end
+  end
+
+end

data/app/models/purl_config.rb

@@ -0,0 +1,10 @@
+class PurlConfig
+  @@config_info = nil
+  def self.configure
+    @@config_info ||= YAML.load(File.open(File.join(Rails.root, "config/purl.yml")))
+  end
+
+  def self.url
+    configure[Rails.env]['url']
+  end
+end

data/app/models/repo_object.rb

@@ -0,0 +1,24 @@
+require 'method_decorators/precondition'
+
+class RepoObject < ActiveRecord::Base
+  extend MethodDecorators
+  self.establish_connection("#{Rails.env}_remote_purl_database".to_sym)
+  self.table_name = "repo_object"
+  # this is the id for the record, NOT for the repository object (which is :pid)
+  attr_accessible :add_source_ip
+  alias_attribute :pid, :filename
+
+  class << self
+    +MethodDecorators::Precondition.new {|fedora_object| fedora_object.present? }
+    def create_from_fedora_object(fedora_object)
+      create do |repo_object|
+        repo_object.url = File.join(Rails.configuration.application_url, "show", fedora_object.to_param)
+        repo_object.pid = fedora_object.to_param
+        repo_object.date_added= fedora_object.create_date
+        repo_object.date_modified= fedora_object.modified_date
+        repo_object.information= "CurateND - #{fedora_object.to_param}"
+      end
+    end
+  end
+
+end

data/app/models/solr_document.rb

@@ -0,0 +1,35 @@
+# -*- encoding : utf-8 -*-
+class SolrDocument
+  # Adds Sufia behaviors to the SolrDocument.
+  include Sufia::SolrDocumentBehavior
+
+  include Blacklight::Solr::Document
+
+  # self.unique_key = 'id'
+
+  # The following shows how to setup this blacklight document to display marc documents
+  extension_parameters[:marc_source_field] = :marc_display
+  extension_parameters[:marc_format_type] = :marcxml
+  use_extension( Blacklight::Solr::Document::Marc) do |document|
+    document.key?( :marc_display  )
+  end
+
+  # Email uses the semantic field mappings below to generate the body of an email.
+  SolrDocument.use_extension( Blacklight::Solr::Document::Email )
+
+  # SMS uses the semantic field mappings below to generate the body of an SMS email.
+  SolrDocument.use_extension( Blacklight::Solr::Document::Sms )
+
+  # DublinCore uses the semantic field mappings below to assemble an OAI-compliant Dublin Core document
+  # Semantic mappings of solr stored fields. Fields may be multi or
+  # single valued. See Blacklight::Solr::Document::ExtendableClassMethods#field_semantics
+  # and Blacklight::Solr::Document#to_semantic_values
+  # Recommendation: Use field names from Dublin Core
+  use_extension( Blacklight::Solr::Document::DublinCore)
+  field_semantics.merge!(
+                         :title => "title_display",
+                         :author => "author_display",
+                         :language => "language_facet",
+                         :format => "format"
+                         )
+end

data/app/repository_datastreams/file_content_datastream.rb

@@ -0,0 +1,36 @@
+require Sufia::Engine.root.join('app/models/datastreams/file_content_datastream')
+# I really don't want to touch much of Sufia's underworkings. In doing this
+# I'm able to mimic the #super behavior.
+#
+# More on this method at:
+# http://blog.jayfields.com/2006/12/ruby-alias-method-alternative.html
+class FileContentDatastream
+
+  # Yes, I could be using super, however that assumes a working knowledge
+  # of how the FileContentDatastream is actually crafted (namely via
+  # ActiveSupport::Concern)
+  sufia_run_fits = self.instance_method(:run_fits!)
+
+  # This is where I chose to insert the anti-virus. My reason being that the
+  # caller of this method is getting the Fedora datastream and writing it to
+  # a temp file for characterization; So to ease the load, I'm piggy backing
+  # on that behavior and first running an Anti-Virus scanner
+  def run_fits!(file_path)
+    anti_virus_scanner.call(file_path)
+    characterization_runner.call(file_path)
+  end
+
+  protected
+  def anti_virus_scanner
+    AntiVirusScanner.new(self)
+  end
+
+  define_method :characterization_runner do
+    if Rails.configuration.respond_to?(:default_characterization_runner)
+      Rails.configuration.default_characterization_runner
+    else
+      sufia_run_fits.bind(self)
+    end
+  end
+
+end

data/app/repository_models/curation_concern/embargoable.rb

@@ -0,0 +1,43 @@
+require File.expand_path('../../../validators/future_date_validator', __FILE__)
+module CurationConcern
+  module Embargoable
+    extend ActiveSupport::Concern
+
+    included do
+      validates :embargo_release_date, future_date: true
+      before_save :write_embargo_release_date, prepend: true
+    end
+
+    def write_embargo_release_date
+      if defined?(@embargo_release_date)
+        embargoable_persistence_container.embargo_release_date = embargo_release_date
+      end
+      true
+    end
+    protected :write_embargo_release_date
+
+    def embargo_release_date=(value)
+      @embargo_release_date = begin
+        value.to_date
+      rescue NoMethodError
+        value
+      end
+    end
+
+    def embargo_release_date
+      @embargo_release_date || embargoable_persistence_container.embargo_release_date
+    end
+
+    if ! included_modules.include?('Morphine')
+      require 'morphine'
+      include Morphine
+    end
+    register :embargoable_persistence_container do
+      if ! self.class.included_modules.include?('Sufia::GenericFile::Permissions')
+        self.class.send(:include, Sufia::GenericFile::Permissions)
+      end
+      self.datastreams["rightsMetadata"]
+    end
+
+  end
+end

data/app/repository_models/curation_concern/with_access_right.rb

@@ -0,0 +1,31 @@
+module CurationConcern
+  module WithAccessRight
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :visibility
+    end
+
+    def under_embargo?
+      @under_embargo ||= rightsMetadata.under_embargo?
+    end
+
+    def open_access?
+      access_rights.open_access?
+    end
+
+    def authenticated_only_access?
+      access_rights.authenticated_only?
+    end
+
+    def private_access?
+      access_rights.private?
+    end
+
+    def access_rights
+      @access_rights ||= AccessRight.new(self)
+    end
+    protected :access_rights
+
+  end
+end

data/app/repository_models/generic_file.rb

@@ -0,0 +1,36 @@
+require Sufia::Engine.root.join('app/models/generic_file')
+require File.expand_path("../curation_concern/with_access_right", __FILE__)
+require File.expand_path("../curation_concern/embargoable", __FILE__)
+require File.expand_path("../../repository_datastreams/file_content_datastream", __FILE__)
+
+class GenericFile
+  include CurationConcern::WithAccessRight
+  include CurationConcern::Embargoable
+
+  belongs_to :batch, property: :is_part_of, class_name: 'ActiveFedora::Base'
+
+  validates :batch, presence: true
+  validates :file, presence: true, on: :create
+
+  attr_accessor :file, :version
+
+  def filename
+    content.label
+  end
+
+  def to_s
+    title || label || "No Title"
+  end
+
+  def versions
+    content.versions
+  end
+
+  def current_version_id
+    content.latest_version.versionID
+  end
+
+  def human_readable_type
+    self.class.to_s.demodulize.titleize
+  end
+end

data/app/services/anti_virus_scanner.rb

@@ -0,0 +1,28 @@
+# This is a simple wrapper for an underlying scanner; Without it, we'll
+# always going to be running actual anti-virus
+class AntiVirusScanner
+  NO_VIRUS_FOUND_RETURN_VALUE = 0 unless defined?(NO_VIRUS_FOUND_RETURN_VALUE)
+
+  class VirusDetected < RuntimeError
+    def initialize(pid, file_path)
+      super("A virus was found for PID=#{pid.inspect} (#{file_path.inspect})")
+    end
+  end
+  attr_reader :object
+  def initialize(object_with_pid)
+    @object = object_with_pid
+  end
+
+  def call(file_path)
+    if scanner_instance.call(file_path) == NO_VIRUS_FOUND_RETURN_VALUE
+      return true
+    else
+      raise VirusDetected.new(object.pid, file_path)
+    end
+  end
+
+  include Morphine
+  register :scanner_instance do
+    Rails.configuration.default_antivirus_instance
+  end
+end

data/app/services/curation_concern.rb

@@ -0,0 +1,22 @@
+module CurationConcern
+  module_function
+  def mint_a_pid
+    Sufia::Noid.namespaceize(Sufia::Noid.noidify(Sufia::IdService.mint))
+  end
+
+  def actor(curation_concern, *args)
+    actor_identifier = curation_concern.class.to_s
+    klass = const_get("#{actor_identifier}Actor")
+    klass.new(curation_concern, *args)
+  end
+
+  def attach_file(generic_file, user, file_to_attach)
+    Sufia::GenericFile::Actions.create_content(
+      generic_file,
+      file_to_attach,
+      file_to_attach.original_filename,
+      'content',
+      user
+    )
+  end
+end

data/app/services/curation_concern/base_actor.rb

@@ -0,0 +1,48 @@
+module CurationConcern
+  # The CurationConcern base actor should respond to three primary actions:
+  # * #create
+  # * #update
+  # * #delete
+  class BaseActor
+    attr_reader :curation_concern, :user, :attributes
+    def initialize(curation_concern, user, input_attributes)
+      @curation_concern = curation_concern
+      @user = user
+      @attributes = input_attributes.dup
+      @visibility = attributes[:visibility]
+    end
+
+    def create!
+      curation_concern.apply_depositor_metadata(user.user_key)
+      curation_concern.creator = user.name
+      curation_concern.date_uploaded = Date.today
+      save
+    end
+
+    def update!
+      save
+    end
+
+    def save
+      curation_concern.attributes = attributes
+      curation_concern.date_modified = Date.today
+      curation_concern.set_visibility(visibility)
+      curation_concern.save!
+    end
+    protected :save
+
+    attr_reader :visibility
+    protected :visibility
+
+    def visibility_may_have_changed?
+      !!@visibility
+    end
+    protected :visibility_may_have_changed?
+
+    def attach_file(generic_file, file_to_attach)
+      ActiveSupport::Deprecation.warn("removing #{self.class}#attach_file, use CurationConcern.attach_file instead")
+      CurationConcern.attach_file(generic_file, user, file_to_attach)
+    end
+    protected :attach_file
+  end
+end

data/app/services/curation_concern/generic_file_actor.rb

@@ -0,0 +1,38 @@
+module CurationConcern
+  class GenericFileActor < CurationConcern::BaseActor
+    def create!
+      super
+      update_file
+    end
+
+    def update!
+      super
+      update_file
+      update_version
+    end
+
+    protected
+    def update_file
+      file = attributes.delete(:file)
+      title = attributes[:title]
+      title ||= file.original_filename if file
+      curation_concern.label = title
+      if file
+        CurationConcern.attach_file(curation_concern, user, file)
+      end
+    end
+
+    def update_version
+      version_to_revert = attributes.delete(:version)
+      return true if version_to_revert.blank?
+      return true if version_to_revert.to_s ==  curation_concern.current_version_id
+
+      revision = curation_concern.content.get_version(version_to_revert)
+      mime_type = revision.mimeType.empty? ? "application/octet-stream" : revision.mimeType
+      options = { label: revision.label, mimeType: mime_type, dsid: 'content' }
+      curation_concern.add_file_datastream(revision.content, options)
+      curation_concern.record_version_committer(user)
+      curation_concern.save!
+    end
+  end
+end

data/app/validators/future_date_validator.rb

@@ -0,0 +1,19 @@
+class FutureDateValidator < ActiveModel::EachValidator
+
+  def validate_each(record, attribute, value)
+    if value.present?
+      begin
+        if date = value.to_date
+          if date <= Date.today
+            record.errors[:embargo_release_date] << "Must be a future date"
+          end
+        else
+          record.errors[:embargo_release_date] << "Invalid Date Format"
+        end
+      rescue NoMethodError
+        record.errors[:embargo_release_date] << "Invalid Date Format"
+      end
+    end
+  end
+
+end

data/app/views/_footer.html.erb

@@ -0,0 +1,19 @@
+
+<footer id="footer" class="container">
+  <div class="row">
+    <div class="span12">
+      <p>
+        CurateND is a service of the <a href="http://www.library.nd.edu">Hesburgh Libraries of Notre Dame</a>.
+      </p>
+      <p>
+        <a href="http://www.nd.edu/copyright/">Copyright</a> &copy; <%= Time.now.year %> <a href="http://www.nd.edu">University of Notre Dame</a>
+      </p>
+      <p>
+        Powered by <a href="https://github.com/curationexperts/sufia">Sufia</a>, a <a href="http://projecthydra.org">Hydra</a> project.
+      </p>
+      <p>
+        Build: <%= Rails.configuration.build_identifier %>
+      </p>
+    </div>
+  </div>
+</footer>