curate 0.0.1 → 0.1.0

data/app/helpers/blacklight_helper.rb

@@ -0,0 +1,19 @@
+require Blacklight::Engine.root.join('app/helpers/blacklight/hash_as_hidden_fields_helper_behavior')
+require Blacklight::Engine.root.join('app/helpers/blacklight/render_constraints_helper_behavior')
+require Blacklight::Engine.root.join('app/helpers/blacklight/html_head_helper_behavior')
+require Blacklight::Engine.root.join('app/helpers/blacklight/facets_helper_behavior')
+
+require Blacklight::Engine.root.join('app/helpers/hash_as_hidden_fields_helper')
+require Blacklight::Engine.root.join('app/helpers/render_constraints_helper')
+require Blacklight::Engine.root.join('app/helpers/html_head_helper')
+require Blacklight::Engine.root.join('app/helpers/facets_helper')
+
+require Blacklight::Engine.root.join('app/helpers/blacklight/blacklight_helper_behavior')
+
+module BlacklightHelper
+  include Blacklight::BlacklightHelperBehavior
+
+  def application_name
+    "CurateND"
+  end
+end

data/app/helpers/common_objects_helper.rb

@@ -0,0 +1,5 @@
+module CommonObjectsHelper
+  def common_object_partial_for(object)
+    object.to_partial_path.sub(/\A.*\/([^\/]*)\Z/,'common_objects/\1')
+  end
+end

data/app/inputs/multi_value_input.rb

@@ -0,0 +1,71 @@
+require 'simple_form'
+class MultiValueInput < SimpleForm::Inputs::CollectionInput
+  def input
+    input_html_classes.unshift("string")
+    input_html_options[:type] ||= 'text'
+    input_html_options[:name] ||= "#{object_name}[#{attribute_name}][]"
+    markup = <<-HTML
+
+
+        <ul class="listing">
+    HTML
+
+    collection.each do |value|
+      unless value.to_s.strip.blank?
+        markup << <<-HTML
+          <li class="field-wrapper">
+            #{build_text_field(value)}
+          </li>
+        HTML
+      end
+    end
+
+    markup << <<-HTML
+          <li class="field-wrapper">
+            #{build_text_field('')}
+          </li>
+        </ul>
+
+    HTML
+  end
+
+  # NOTE: There is a one to many relationship between the label and the input
+  # elements. Because of this we can't use the "for" attribute on the label
+  # point to the "id" of the input. Instead we use the "aria-labelledby"
+  # attribute on the input to point to the "id" on the label.
+  #
+  # It would be _better_ to use @builder construct the element but the proper
+  # syntax escapes me.
+  def label
+    <<-HTML
+
+    <label id="#{label_id}" class="string #{label_classes}">#{attribute_name.to_s.titleize}</label>
+    HTML
+  end
+
+  private
+
+  def label_id
+    "#{object_name}_#{attribute_name}_label"
+  end
+
+  def label_classes
+    label_html_options[:class].map{|c| c.to_s}.join(' ')
+  end
+
+  def build_text_field(value)
+    input_html_options[:value] = value
+    input_html_options[:id] = nil
+    input_html_options[:class] = "#{object_name}_#{attribute_name}"
+    input_html_options[:'aria-labelledby'] = label_id
+    @builder.text_field(attribute_name, input_html_options)
+  end
+
+  protected
+  def collection
+    @collection ||= begin
+      object.send(attribute_name)
+    end
+  end
+  def multiple?; true; end
+end

data/app/models/access_right.rb

@@ -0,0 +1,53 @@
+require 'method_decorators/precondition'
+
+class AccessRight
+  PERMISSION_TEXT_VALUE_PUBLIC = 'public'.freeze
+  PERMISSION_TEXT_VALUE_AUTHENTICATED = 'registered'.freeze
+  VISIBILITY_TEXT_VALUE_PUBLIC = 'open'.freeze
+  VISIBILITY_TEXT_VALUE_AUTHENTICATED = 'psu'.freeze
+  VISIBILITY_TEXT_VALUE_PRIVATE = 'restricted'.freeze
+
+  extend MethodDecorators
+  +MethodDecorators::Precondition.new { |permissionable|
+    permissionable.respond_to?(:visibility) &&
+    permissionable.respond_to?(:persisted?) &&
+    permissionable.respond_to?(:permissions) &&
+    permissionable.permissions.respond_to?(:map)
+  }
+  def initialize(permissionable)
+    @permissionable = permissionable
+  end
+
+  extend Forwardable
+  def_delegators :permissionable, :persisted?, :permissions, :visibility
+  protected :persisted?, :permissions, :visibility
+
+  attr_reader :permissionable
+
+  def open_access?
+    return true if has_visibility_text_for?(VISIBILITY_TEXT_VALUE_PUBLIC)
+    if persisted?
+      has_permission_text_for?(PERMISSION_TEXT_VALUE_PUBLIC)
+    else
+      visibility.to_s == ''
+    end
+  end
+
+  def authenticated_only?
+    return false if open_access?
+    has_permission_text_for?(PERMISSION_TEXT_VALUE_AUTHENTICATED) ||
+      has_visibility_text_for?(VISIBILITY_TEXT_VALUE_AUTHENTICATED)
+  end
+
+  def private?
+    !open_access? && !authenticated_only?
+  end
+
+  private
+  def has_visibility_text_for?(text)
+    visibility == text
+  end
+  def has_permission_text_for?(text)
+    !!permissions.detect { |perm| perm[:name] == text }
+  end
+end

data/app/models/classify_concern.rb

@@ -0,0 +1,30 @@
+require 'active_attr'
+class ClassifyConcern
+  # @TODO - This should be part of the application configuration
+  # or detected on load
+  VALID_CURATION_CONCERNS = {
+    'Mock Curation Concern' => 'MockCurationConcern'
+  }
+  include ActiveAttr::Model
+  attribute :curation_concern_type
+
+  validates(
+    :curation_concern_type,
+    presence: true,
+    inclusion: { in: lambda { |record| VALID_CURATION_CONCERNS.values } }
+  )
+
+  def possible_curation_concern_types
+    VALID_CURATION_CONCERNS
+  end
+
+  def curation_concern_class
+    if possible_curation_concern_types.detect{|name, class_name|
+        class_name == curation_concern_type
+      }
+      curation_concern_type.constantize
+    else
+      raise RuntimeError, "Invalid :curation_concern_type"
+    end
+  end
+end

data/app/models/contributor_agreement.rb

@@ -0,0 +1,58 @@
+class ContributorAgreement
+  attr_reader :curation_concern, :user
+  def initialize(curation_concern, user, params)
+    @curation_concern = curation_concern
+    @user = user
+    @param_value = params[param_key.to_sym] || params[param_key.to_s]
+  end
+
+  def legally_binding_text
+    <<-HTML
+    <p>
+      I am submitting my work for inclusion in the CurateND repository maintained by the University Libraries of the University of Notre Dame.
+      I acknowledge that publication of the work may implicate my legal rights with respect to the work and its contents, including my ability to publish the work in other venues.
+      I UNDERSTAND AND AGREE THAT BY SUBMITTING MY CONTENT FOR INCLUSION IN THE CURATEND REPOSITORY, I AGREE TO THE FOLLOWING TERMS:
+    </p>
+
+    <p>
+      I hereby grant the University of Notre Dame permission to reproduce, edit, publish, disseminate, publicly display, or publicly perform, in whole or in part, the work in any medium at the University&rsquo;s discretion (including but not limited to public websites).
+      I agree that the University can keep more than one copy of the submission for the purpose of preservation and security.
+      I agree that the University can preserve the submission by migrating or translating it to a new format or medium as needed in the future.
+      I also agree that the metadata attached to the item can be reviewed and altered by the University to aid in preservation and discovery.
+      I understand that I may be allowed the opportunity to select the intended audience for the materials that I submit, and I agree that I am fully responsible for any claims and all responsibility for materials submitted.
+      The CurateND service is offered as-is with no warranties, express or implied.
+      The University may suspend or terminate CurateND, or remove any content within the system, at any time for any reason in the University&rsquo;s sole discretion.
+    </p>
+
+    <p>
+      I warrant that the submitted material is original to me and that I have power to make this agreement.
+      I also warrant that the submission does not, to the best of my knowledge, infringe upon anyone&rsquo;s copyright.
+      I also warrant that if the work has been previously published elsewhere in whole or in part, that I have obtained the permission of the copyright owner to grant CurateND the rights required by this license.
+      I also guarantee that I do not have any other publication agreements that involve this material or substantial parts of it that conflict with my submission of materials for dissemination in CurateND.
+    </p>
+
+    <p>
+      I represent that any materials that are used in this submission that I do not hold copyright for, I have obtained permission to use and display the materials according to the rights required by this license, and that third-party owned materials are clearly identified and credited within the content of the submission.
+      If it is determined that permissions of use have not properly been obtained, I acknowledge that the University may remove or restrict access to items as necessary.
+    </p>
+
+    <p>
+      I understand that I may request the University to remove my submitted materials from the CurateND repository; however, I acknowledge that the University cannot control or retract works that may have been accessed by third parties prior to my request for removal.
+      If the submission is removed I agree that the item can be replaced by a page with a statement declaring that the item was removed by my request.
+    </p>
+    HTML
+  end
+
+  def acceptance_value
+    'accept'
+  end
+
+  def param_key
+    :accept_contributor_agreement
+  end
+  attr_reader :param_value
+
+  def is_being_accepted?
+    param_value == acceptance_value
+  end
+end

data/app/models/digital_object_identifier.rb

@@ -0,0 +1,83 @@
+class DigitalObjectIdentifier
+
+  attr_accessor :target, :creator, :title, :publisher, :publicationyear
+  attr_accessor :description, :rights, :version, :format, :data_size, :contributor, :subject, :name_id, :subtitle, :created_date, :accepted_date, :resource_type, :lang
+
+  # Mandatory fields for creating DOI.
+  def data
+    "_target: #{target}\ndatacite.creator: #{creator}\ndatacite.title: #{title}\ndatacite.publisher: #{publisher}\ndatacite.publicationyear: #{publicationyear}\n"
+  end
+
+  # Step - 1: Create DOI by passing 5 metadata - target, creator, title, publisher, publicationyear
+  def create_doi
+    response = RestClient.post DoiConfig.url_for_creating_doi, data, :content_type => 'text/plain'
+    return response
+  end
+
+  # Create DOI or return if already created.
+  def doi
+    @doi ||= create_doi
+    if @doi.include?("success")
+      @doi = @doi.split("|")[0].sub("success:", "").strip
+    end
+    @doi
+  end
+
+  # Step - 2: Update the DOI metadata with more attributes. The extra metadata will need to be in the xml format.
+  def update_doi
+    response = RestClient.post "#{DoiConfig.url_for_updating_doi}#{doi}", sanitize_data, :content_type => 'text/plain; charset=UTF-8', :content_length => sanitize_data.size, :accept => 'text/plain'
+    return response
+  end
+
+  # This method replaces special characters like %, :, \n and \r in the XML data and appends to the basic metadata which was used while creating DOI in Step - 1.
+  def sanitize_data
+    data + "datacite: #{create_xml.to_xml.gsub("%", "%25").gsub(":", "%3A").gsub("\n", "%0D%0A").gsub("\r", "")}\n"
+  end
+
+  # This method creates XML data which is used for extra metadata other than the 5 metadata which was used in Step - 1.
+  def create_xml
+    builder = Nokogiri::XML::Builder.new do |xml|
+      xml.resource("xmlns" => "http://datacite.org/schema/kernel-2.2", "xmlns:xsi" =>"http://www.w3.org/2001/XMLSchema-instance", "xsi:schemaLocation" => "http://datacite.org/schema/kernel-2.2 http://schema.datacite.org/meta/kernel-2.2/metadata.xsd") {
+        xml.identifier(:identifierType => "DOI"){ xml.text doi.sub("doi:", "") }
+        xml.creators{
+          xml.creator{
+            xml.creatorName creator
+            xml.nameIdentifier(:nameIdentifierScheme => "ISNI") { xml.text name_id }
+          }
+        }
+        xml.titles{
+          xml.title title
+          xml.title(:titleType => "Subtitle") { xml.text subtitle}
+        }
+        xml.publisher publisher
+        xml.publicationYear publicationyear
+        xml.subjects{
+          xml.subject subject
+        }
+        xml.contributors{
+          xml.contributor(:contributorType => "DataManager"){
+            xml.contributorName contributor
+          }
+        }
+        xml.dates{
+          xml.date(:dateType => "Valid"){ xml.text created_date }
+          xml.date(:dateType => "Accepted"){ xml.text accepted_date }
+        }
+        xml.language lang
+        xml.resourceType(:resourceTypeGeneral => "Image"){ xml.text resource_type }
+        xml.sizes{
+          xml.size data_size
+        }
+        xml.formats{
+          xml.format format
+        }
+        xml.version version
+        xml.rights rights
+        xml.descriptions{
+          xml.description(:descriptionType => "Other") { xml.text description }
+        }
+      }
+    end
+  end
+end
+

data/app/models/doi_config.rb

@@ -0,0 +1,26 @@
+class DoiConfig
+  @@config_info, @@url = nil
+  def self.configure
+    @@config_info ||= YAML.load(File.open(File.join(Rails.root, "config/doi.yml")))
+  end
+
+  def self.username
+    configure[Rails.env]['username']
+  end
+
+  def self.password
+    configure[Rails.env]['password']
+  end
+
+  def self.shoulder
+    configure[Rails.env]['shoulder']
+  end
+
+  def self.url_for_creating_doi
+    @@url_for_creating_doi ||= "#{configure[Rails.env]['url'].sub("://", "://#{username}:#{password}@")}shoulder/#{shoulder}"
+  end
+
+  def self.url_for_updating_doi
+    @@url_for_updating_doi ||= "#{configure[Rails.env]['url'].sub("://", "://#{username}:#{password}@")}id/"
+  end
+end

data/app/models/help_request.rb

@@ -0,0 +1,34 @@
+require 'browser'
+class HelpRequest < ActiveRecord::Base
+
+  attr_accessible(
+    :current_url,
+    :flash_version,
+    :how_can_we_help_you,
+    :javascript_enabled,
+    :resolution,
+    :user_agent,
+    :view_port
+  )
+
+  belongs_to :user
+  validates_presence_of :how_can_we_help_you,
+    :message => "Please tell us about the problem or issue you are having with CurateND."
+
+
+  def browser_name
+    parse_user_agent
+    @browser.name
+  end
+
+  def platform
+    parse_user_agent
+    @browser.platform
+  end
+
+  private
+
+  def parse_user_agent
+    @browser ||= Browser.new(:ua => user_agent)
+  end
+end

data/app/models/mint_doi.rb

@@ -0,0 +1,51 @@
+class MintDoi
+
+  attr_reader :fedora_object
+
+  class MissingDataError < RuntimeError
+    def initialize(error_message)
+      super(error_message)
+    end
+  end
+
+  def initialize(obj_id)
+    @fedora_object = retreive_fedora_object(obj_id)
+  end
+
+  # Return DOI if already stored in fedora object. If not create a new DOI and store it in the fedora object.
+  def create_or_retrieve_doi
+    if (doi = fedora_object.identifier).present?
+      return doi
+    end
+
+    fedora_object.identifier = digital_object_identifier.doi
+    fedora_object.save!
+    return fedora_object.identifier
+  end
+
+  private
+
+  def digital_object_identifier
+    @digital_object_identifier ||= DigitalObjectIdentifier.new
+
+    @digital_object_identifier.target = create_or_retreive_purl
+    @digital_object_identifier.title = fedora_object.title
+    @digital_object_identifier.creator = fedora_object.creator
+    @digital_object_identifier.publisher = "Hesburgh Library - University of Notre Dame"
+    @digital_object_identifier.publicationyear = Time.now.year.to_s
+
+    @digital_object_identifier
+  end
+
+  # Obtain the actual content-model type and load the object.
+  def retreive_fedora_object(obj_id)
+    ActiveFedora::Base.find(obj_id, cast: true)
+  end
+
+  # Create or retrieve purl link for the given fedora ID.
+  def create_or_retreive_purl
+    raise MissingDataError.new("Title and Creator fields cannot be empty.") if fedora_object.title.blank? || fedora_object.creator.blank?
+    mint_purl = MintPurl.new(fedora_object)
+    mint_purl.create_or_retreive_purl
+  end
+end

data/app/models/mint_purl.rb

@@ -0,0 +1,40 @@
+require 'method_decorators/precondition'
+class MintPurl
+  extend MethodDecorators
+
+  class PurlError < RuntimeError
+    def initialize(error_message)
+      super(error_message)
+    end
+  end
+
+  attr_reader :fedora_object
+
+  +MethodDecorators::Precondition.new {|fedora_object| fedora_object.present? }
+  def initialize(fedora_object)
+    @fedora_object = fedora_object
+  end
+
+  def create_or_retreive_purl
+    repo_object = RepoObject.where(:filename => fedora_object.to_param).first
+    if repo_object
+      purl = Purl.where(:repo_object_id => repo_object.repo_object_id).first
+      return purl_url(purl.purl_id)
+    end
+
+    Purl.transaction do
+      @repo_object = RepoObject.create_from_fedora_object(fedora_object)
+      @purl = Purl.create_from_repo_object(@repo_object)
+    end
+    return purl_url(@purl.purl_id) if @purl
+  rescue => e
+    raise PurlError.new("Could not create Purl for the following reasons: #{e.backtrace.inspect}")
+  end
+
+  private
+
+  def purl_url(purl_id)
+    File.join(PurlConfig.url, purl_id.to_s, fedora_object.to_param)
+  end
+
+end