sufia 0.0.1.pre2 → 0.0.1

data/features/step_definitions/user_steps.rb

@@ -25,12 +25,12 @@ Given /^I (?:am )?log(?:ged)? in as "([^\"]*)"$/ do |login|
   user = User.where(:email=>login).first || FactoryGirl.create(:user, :email=>login)
   User.find_by_user_key(login).should_not be_nil
   visit "/"
-  step %{And I click the anchor "Login"} 
+  find("a[href=\"/users/sign_in\"]").click
   fill_in 'Email', with: login
   fill_in 'Password', with: 'password'
   click_button 'Sign in'
   
-  step %{And I click the anchor "#{login}"} 
+  step %{And I click within the anchor "i.icon-user"} 
   step %{I should see a link to "ingest" with label "upload"}
   step %{I should see a link to "dashboard" with label "dashboard"}
   # step %{I should see a link to "logout"} 

data/features/step_definitions/web_steps.rb

@@ -24,7 +24,7 @@ require 'cgi'
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
 
 module WithinHelpers
-  Hydra::LDAP.stubs(:does_user_exist?).returns(true)
+#  Hydra::LDAP.stubs(:does_user_exist?).returns(true)
 
   def with_scope(locator)
     locator ? within(locator) { yield } : yield

data/features/support/env.rb

@@ -3,6 +3,7 @@
 # newer version of cucumber-rails. Consider adding your own code to a new file 
 # instead of editing this one. Cucumber will automatically load all features/**/*.rb
 # files.
+require "rake"
 
 #require 'capybara'
 ENV["RAILS_ENV"] ||= "test"
@@ -62,3 +63,28 @@ end
 # The :transaction strategy is faster, but might give you threading problems.
 # See https://github.com/cucumber/cucumber-rails/blob/master/features/choose_javascript_database_strategy.feature
 Cucumber::Rails::Database.javascript_strategy = :truncation
+
+#load fixtures for cucumber tests
+def loaded_files_excluding_current_rake_file
+  $".reject { |file| file.include? "lib/tasks/fixtures" }
+end
+def activefedora_path
+  Gem.loaded_specs['active-fedora'].full_gem_path
+end
+def load_rake
+  @rake = Rake::Application.new
+  Rake.application = @rake
+    Rake.application.rake_require("tasks/sufia-fixtures", ["."], loaded_files_excluding_current_rake_file)
+    Rake.application.rake_require("lib/tasks/fixtures", ["."], loaded_files_excluding_current_rake_file)
+    Rake.application.rake_require("lib/tasks/active_fedora", [activefedora_path], loaded_files_excluding_current_rake_file)
+  Rake::Task.define_task(:environment)
+end
+  load_rake
+  @rake['sufia:fixtures:refresh'].invoke
+  @rake['sufia:fixtures:fix'].invoke
+
+at_exit do
+  load_rake
+  @rake['sufia:fixtures:delete'].invoke
+end
+

data/features/users.feature

@@ -0,0 +1,18 @@
+Feature: User Profile 
+
+  Scenario: Show my profile 
+    Given I load users
+    Given I am logged in as "curator1@example.com"
+    And I follow "curator1@example.com"
+    Then I should see "Edit Your Profile"
+
+  Scenario: Edit my profile 
+    Given I load users
+    Given I am logged in as "curator1@example.com"
+    And I follow "curator1@example.com"
+    And I follow "Edit Your Profile"
+    And I fill in "user_twitter_handle" with "curatorOfData"
+    And I press "Save Profile"
+    Then I should see "Your profile has been updated"
+    And I should see "curatorOfData"
+

data/lib/active_support/core_ext/marshal.rb

@@ -0,0 +1,22 @@
+### This patch is going into active-support (rails 4). https://github.com/rails/rails/pull/8246
+module Marshal
+  class << self
+    def load_with_autoloading(source)
+      begin
+        load_without_autoloading(source)
+      rescue ArgumentError, NameError => exc
+        if exc.message.match(%r|undefined class/module (.+)|)
+          # try loading the class/module
+          $1.constantize
+          # if it is a IO we need to go back to read the object
+          source.rewind if source.respond_to?(:rewind)
+          retry
+        else
+          raise exc
+        end
+      end
+    end
+
+    alias_method_chain :load, :autoloading
+  end
+end

data/lib/generators/sufia/sufia_generator.rb

@@ -15,7 +15,8 @@ This generator makes the following changes to your application:
  3. Adds controller behavior to the application controller
  4. Creates the sufia.rb configuration file
  5. Copies the catalog controller into the local app
- 6. Generates mailboxer
+ 6. Adds Sufia::SolrDocumentBehavior to app/models/solr_document.rb
+ 7. Generates mailboxer
        """ 
 
   # Implement the required interface for Rails::Generators::Migration.
@@ -32,7 +33,7 @@ This generator makes the following changes to your application:
   # Setup the database migrations
   def copy_migrations
     # Can't get this any more DRY, because we need this order.
-    %w{acts_as_follower_migration.rb	add_social_to_users.rb		create_single_use_links.rb
+    %w{acts_as_follower_migration.rb	add_social_to_users.rb		create_single_use_links.rb	add_ldap_attrs_to_user.rb
 add_avatars_to_users.rb		create_checksum_audit_logs.rb	create_version_committers.rb
 add_groups_to_users.rb		create_local_authorities.rb}.each do |f|
       better_migration_template f
@@ -61,6 +62,7 @@ add_groups_to_users.rb		create_local_authorities.rb}.each do |f|
         "  \n# Adds Sufia behaviors into the application controller \n" +        
         "  include Sufia::Controller\n"
       end
+      gsub_file file_path, "layout 'blacklight'", "layout 'hydra-head'"
     else
       puts "     \e[31mFailure\e[0m  Could not find #{file_path}.  To add Sufia behaviors to your  Controllers, you must include the Sufia::Controller module in the Controller class definition." 
     end
@@ -68,6 +70,7 @@ add_groups_to_users.rb		create_local_authorities.rb}.each do |f|
   
   def create_configuration_files
     copy_file "config/sufia.rb", "config/initializers/sufia.rb"
+    copy_file "config/redis.yml", "config/redis.yml"
     copy_file "config/redis_config.rb", "config/initializers/redis_config.rb"
   end
 
@@ -88,6 +91,19 @@ add_groups_to_users.rb		create_local_authorities.rb}.each do |f|
     
   end
 
+  # Add behaviors to the SolrDocument model
+  def inject_sufia_solr_document_behavior
+    file_path = "app/models/solr_document.rb"
+    if File.exists?(file_path) 
+      inject_into_class file_path, "SolrDocument" do 
+        "  # Adds Sufia behaviors to the SolrDocument.\n" +
+        "  include Sufia::SolrDocumentBehavior\n"        
+      end
+    else
+      puts "     \e[31mFailure\e[0m  Sufia requires a SolrDocument object. This generators assumes that the model is defined in the file #{file_path}, which does not exist." 
+    end    
+  end
+
   def install_mailboxer
     generate "mailboxer:install" 
   end

data/lib/generators/sufia/templates/catalog_controller.rb

@@ -28,12 +28,11 @@ class CatalogController < ApplicationController
   include BlacklightAdvancedSearch::ParseBasicQ
 
   # These before_filters apply the hydra access controls
-  before_filter :enforce_access_controls
-  before_filter :enforce_viewing_context_for_show_requests, :only=>:show
+  before_filter :enforce_show_permissions, :only=>:show
   # This applies appropriate access controls to all solr queries
-  CatalogController.solr_search_params_logic << :add_access_controls_to_solr_params
+  CatalogController.solr_search_params_logic += [:add_access_controls_to_solr_params]
   # This filters out objects that you want to exclude from search results, like FileAssets
-  CatalogController.solr_search_params_logic << :exclude_unwanted_models
+  CatalogController.solr_search_params_logic += [:exclude_unwanted_models]
 
   skip_before_filter :default_html_head
 

data/lib/generators/sufia/templates/config/sufia.rb

@@ -27,6 +27,74 @@ Sufia.config do |config|
   # TODO move these to an HttpAuth initializer
   config.logout_url = "https://webaccess.psu.edu/cgi-bin/logout?#{Sufia::HttpHeaderAuth.get_vhost_by_host(config)[1]}"
   config.login_url = "https://webaccess.psu.edu?cosign-#{Sufia::HttpHeaderAuth.get_vhost_by_host(config)[0]}&#{Sufia::HttpHeaderAuth.get_vhost_by_host(config)[1]}"
+
+      config.cc_licenses = {
+      'Attribution 3.0 United States' => 'http://creativecommons.org/licenses/by/3.0/us/',
+      'Attribution-ShareAlike 3.0 United States' => 'http://creativecommons.org/licenses/by-sa/3.0/us/',
+      'Attribution-NonCommercial 3.0 United States' => 'http://creativecommons.org/licenses/by-nc/3.0/us/',
+      'Attribution-NoDerivs 3.0 United States' => 'http://creativecommons.org/licenses/by-nd/3.0/us/',
+      'Attribution-NonCommercial-NoDerivs 3.0 United States' => 'http://creativecommons.org/licenses/by-nc-nd/3.0/us/',
+      'Attribution-NonCommercial-ShareAlike 3.0 United States' => 'http://creativecommons.org/licenses/by-nc-sa/3.0/us/',
+      'Public Domain Mark 1.0' => 'http://creativecommons.org/publicdomain/mark/1.0/',
+      'CC0 1.0 Universal' => 'http://creativecommons.org/publicdomain/zero/1.0/',
+      'All rights reserved' => 'All rights reserved'
+    }
+
+    config.cc_licenses_reverse = Hash[*config.cc_licenses.to_a.flatten.reverse]
+
+    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",
+    }
+
+    # reflect a field name change (should one happen) in the generic file datastream
+    config.metadata_help = {
+      "generic_file_resource_type" => "Pre-defined categories to describe the type of file content being uploaded, such as \"article\" or \"dataset.\"  More than one type may be selected.",
+      "generic_file_title" => "A name for the file to aid in identifying it. Defaults to the file name, though a more descriptive title is encouraged. <em>This is a required field</em>.",
+      "generic_file_tag" => "Words or phrases you select to describe what the file is about. These are used to search for content. <em>This is a required field</em>.",
+      "generic_file_subject" => "Headings or index terms describing what the file is about; these <em>do</em> need to conform to an existing vocabulary. Currently ScholarSphere supports Library of Congress Subject Headings.",
+      "generic_file_creator" => "The person or group responsible for the file being uploaded. Usually this is the author of the content. Personal names should be entered with the last name first, e.g. \"Smith, John.\" <em>This is a required field</em>.",
+      "generic_file_related_url" => "A link to a website or other specific content (audio, video, PDF document) related to the file. An example is the URL of a research project from which the file was derived.",
+      "generic_file_based_near" => "A place name related to the file, such as its site of publication, or the city, state, or country the file's contents are about. Calls upon the GeoNames web service (<a href=\"http://www.geonames.org\">http://www.geonames.org</a>).",
+      "generic_file_contributor" => "A person or group you want to recognize for playing a role in the creation of the file, but not the primary role. If there is a specific role you would like noted, include it in parentheses, e.g. \"Jones, Mary (advisor).\"",
+      "generic_file_date_created" => "The date on which the file was generated. Dates are accepted in the form YYYY-MM-DD, e.g. 1776-07-04.",
+      "generic_file_description" => "Free-text notes about the file itself. Examples include abstracts of a paper, citation information for a journal article, or a tag indicating a larger collection to which the file belongs.",
+      "generic_file_identifier" => "A unique handle describing the file. An example would be a DOI for a journal article, or an ISBN or OCLC number for a book.",
+      "generic_file_language" => " The language of the file content.",
+      "generic_file_publisher" => "The person or group making the file available. Generally this is Penn State or the Penn State University Libraries.",
+      "generic_file_rights" => "Licensing and distribution information governing access to the file. Select from the provided drop-down list. <em>This is a required field</em>."
+    }
+
+    config.permission_levels = {
+      "Choose Access"=>"none",
+      "View/Download" => "read",
+      "Edit" => "edit"
+    }
+
+    config.owner_permission_levels = {
+      "Edit" => "edit"
+    }
+
+    config.queue = Sufia::Resque::Queue
+
 end
 
 

data/lib/generators/sufia/templates/migrations/add_ldap_attrs_to_user.rb

@@ -0,0 +1,41 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class AddLdapAttrsToUser < ActiveRecord::Migration
+  def self.up
+    add_column :users, :display_name, :string
+    add_column :users, :address, :string
+    add_column :users, :admin_area, :string
+    add_column :users, :department, :string
+    add_column :users, :title, :string
+    add_column :users, :office, :string
+    add_column :users, :chat_id, :string
+    add_column :users, :website, :string
+    add_column :users, :affiliation, :string
+    add_column :users, :telephone, :string
+  end
+
+  def self.down
+    remove_column :users, :display_name
+    remove_column :users, :address
+    remove_column :users, :admin_area
+    remove_column :users, :department
+    remove_column :users, :title
+    remove_column :users, :office
+    remove_column :users, :chat_id
+    remove_column :users, :website
+    remove_column :users, :affiliation
+    remove_column :users, :telephone
+  end
+end

data/lib/kaminari/helpers/tag.rb

@@ -0,0 +1,11 @@
+# Monkey patch so that it uses the engine routes. See https://github.com/amatsuda/kaminari/issues/323
+module Kaminari
+  module Helpers
+    class Tag
+      def page_url_for(page)
+        #@template.url_for @params.merge(@param_name => (page <= 1 ? nil : page)).symbolize_keys
+        Sufia::Engine.routes.url_helpers.url_for @params.merge(@param_name => (page <= 1 ? nil : page), :only_path=>true).symbolize_keys
+      end
+    end
+  end
+end

data/lib/sufia.rb

@@ -12,17 +12,34 @@ require 'will_paginate'
 require 'nest'
 require 'RMagick'
 require 'activerecord-import'
+require 'rails_autolink'
 
 autoload :Zip, 'zipruby'
 module Sufia
+  extend ActiveSupport::Autoload
+
+  autoload :Resque, 'sufia/queue/resque'
+
+  attr_accessor :queue
 
   class Engine < ::Rails::Engine
     engine_name 'sufia'
 
+    config.queue = Sufia::Resque::Queue
+    config.ffmpeg_path = 'ffmpeg'
+    config.fits_message_length = 5
+    
+
+    config.autoload_paths << File.expand_path("../sufia/jobs", __FILE__)
+    
     initializer "Patch active_fedora" do
       require 'sufia/active_fedora/redis'
     end
 
+    initializer "Patch kaminari" do
+      require "kaminari/helpers/tag"
+    end
+
     initializer "Patch active_record" do
       require 'sufia/active_record/redis'
     end
@@ -46,12 +63,18 @@ module Sufia
     return @@config
   end
 
-  autoload :Controller,    'sufia/controller'
-  autoload :Utils,         'sufia/utils'
-  autoload :User,          'sufia/user'
-  autoload :ModelMethods,  'sufia/model_methods'
-  autoload :Noid,          'sufia/noid'
-  autoload :IdService,     'sufia/id_service'
-  autoload :HttpHeaderAuth,'sufia/http_header_auth'
+  def self.queue
+    @queue ||= config.queue.new('sufia')
+  end
+
+  autoload :GenericFile
+  autoload :Controller,           'sufia/controller'
+  autoload :Utils,                'sufia/utils'
+  autoload :User,                 'sufia/user'
+  autoload :ModelMethods,         'sufia/model_methods'
+  autoload :Noid,                 'sufia/noid'
+  autoload :IdService,            'sufia/id_service'
+  autoload :HttpHeaderAuth,       'sufia/http_header_auth'
+  autoload :SolrDocumentBehavior, 'sufia/solr_document_behavior'
 end
 

data/lib/sufia/controller.rb

@@ -23,12 +23,8 @@ module Sufia::Controller
 
   end
 
-  def layout_name
-    'hydra-head'
-  end
-
   def current_ability
-    current_user.ability
+    current_user ? current_user.ability : super
   end
 
   def render_404(exception)

data/lib/sufia/generic_file.rb

@@ -0,0 +1,200 @@
+require 'datastreams/generic_file_rdf_datastream'
+require 'datastreams/properties_datastream'
+require 'datastreams/file_content_datastream'
+
+module Sufia
+  module GenericFile
+    extend ActiveSupport::Concern
+    extend ActiveSupport::Autoload
+    autoload :Export
+    autoload :Thumbnail
+    autoload :Characterization
+    autoload :Audit
+    autoload :Permissions
+    include Sufia::ModelMethods
+    include Sufia::Noid  
+    include Sufia::GenericFile::Thumbnail
+    include Sufia::GenericFile::Export
+    include Sufia::GenericFile::Characterization
+    include Sufia::GenericFile::Audit
+    include Sufia::GenericFile::Permissions
+                                                
+    @@FIELD_LABEL_MAP = {"based_near"=>"Location", 'description'=>"Abstract or Summary", 'tag'=>"Keyword", 'date_created'=>"Date Created", 'related_url'=>"Related URL"}
+
+    included do
+      has_metadata :name => "descMetadata", :type => GenericFileRdfDatastream
+      has_metadata :name => "properties", :type => PropertiesDatastream
+      has_file_datastream :name => "content", :type => FileContentDatastream
+      has_file_datastream :name => "thumbnail", :type => FileContentDatastream
+
+      belongs_to :batch, :property => :is_part_of
+
+      delegate_to :properties, [:relative_path, :depositor], :unique => true
+      delegate_to :descMetadata, [:date_uploaded, :date_modified], :unique => true
+      delegate_to :descMetadata, [:related_url, :based_near, :part_of, :creator,
+                                  :contributor, :title, :tag, :description, :rights,
+                                  :publisher, :date_created, :subject, :format,
+                                  :resource_type, :identifier, :language]
+      around_save :characterize_if_changed, :retry_warming
+
+      #make sure the terms of service is present and set to 1 before saving
+      # note GenericFile.create will no longer save a GenericFile as the terms_of_service will not be set
+      terms_of_service = nil
+      validates_acceptance_of :terms_of_service, :allow_nil => false
+    end
+
+    def pdf?
+      ["application/pdf"].include? self.mime_type
+    end
+
+    def image?
+      ["image/png","image/jpeg", 'image/jpg', 'image/bmp', "image/gif"].include? self.mime_type
+    end
+
+    def video?
+      ["video/mpeg", "video/mp4", "video/x-msvideo", "video/avi", "video/quicktime"].include? self.mime_type
+    end
+
+    def persistent_url
+      "#{Sufia::Engine.config.persistent_hostpath}#{noid}"
+    end
+
+    def retry_warming
+        save_tries = 0
+        conflict_tries = 0
+        begin
+          yield
+        rescue RSolr::Error::Http => error
+          save_tries += 1
+          logger.warn "Retry Solr caught RSOLR error on #{self.pid}: #{error.inspect}"
+          # fail for good if the tries is greater than 3
+          raise if save_tries >=3
+          sleep 0.01
+          retry      
+        rescue  ActiveResource::ResourceConflict => error
+          conflict_tries += 1
+          logger.warn "Retry caught Active Resource Conflict #{self.pid}: #{error.inspect}"
+          raise if conflict_tries >=10
+          sleep 0.01
+          retry
+        rescue =>error
+          if (error.to_s.downcase.include? "conflict")
+            conflict_tries += 1
+            logger.warn "Retry caught Active Resource Conflict #{self.pid}: #{error.inspect}"
+            raise if conflict_tries >=10
+            sleep 0.01
+            retry
+          else
+            raise
+          end          
+        
+        end
+    end
+
+    def related_files
+      relateds = begin
+                   self.batch.generic_files
+                 rescue NoMethodError => e
+                   #batch is nil
+                   batch_id = self.object_relations["isPartOf"].first || self.object_relations[:is_part_of].first
+                   return [] if batch_id.nil?
+                   self.class.find(:is_part_of_s => batch_id)
+                 end
+      relateds.reject { |gf| gf.pid == self.pid }
+    end
+
+
+    def to_solr(solr_doc={}, opts={})
+      super(solr_doc, opts)
+      solr_doc["label_t"] = self.label
+      solr_doc["noid_s"] = noid
+      solr_doc["file_format_t"] = file_format
+      solr_doc["file_format_facet"] = solr_doc["file_format_t"]
+      # remap dates as a valid xml date not to_s
+      solr_doc['generic_file__date_uploaded_dt'] = Time.parse(date_uploaded).utc.to_s.sub(' ','T').sub(' UTC','Z') rescue Time.new(date_uploaded).utc.to_s.sub(' ','T').sub(' UTC','Z') unless date_uploaded.blank?
+      solr_doc['generic_file__date_modified_dt'] = Time.parse(date_modified).utc.to_s.sub(' ','T').sub(' UTC','Z') rescue Time.new(date_modified).utc.to_s.sub(' ','T').sub(' UTC','Z') unless date_modified.blank?
+      return solr_doc
+    end
+
+    def file_format
+      return nil if self.mime_type.blank? and self.format_label.blank?
+      return self.mime_type.split('/')[1]+ " ("+self.format_label.join(", ")+")" unless self.mime_type.blank? or self.format_label.blank?
+      return self.mime_type.split('/')[1] unless self.mime_type.blank?
+      return self.format_label
+    end
+
+    # Redefine this for more intuitive keys in Redis
+    def to_param
+      noid
+    end
+
+    def label=(new_label)
+      @inner_object.label = new_label
+      if self.title.empty?
+        self.title = new_label
+      end
+    end
+
+    def to_jq_upload
+      return {
+        "name" => self.title,
+        "size" => self.file_size,
+        "url" => "/files/#{noid}",
+        "thumbnail_url" => self.pid,
+        "delete_url" => "deleteme", # generic_file_path(:id => id),
+        "delete_type" => "DELETE"
+      }
+    end
+
+    def get_terms
+      terms = []
+      self.descMetadata.class.config[:predicate_mapping].each do |uri, mappings|
+        new_terms = mappings.keys.map(&:to_s).select do |term|
+          term.start_with? "generic_file__" and !['type', 'behaviors'].include? term.split('__').last
+        end
+        terms.concat(new_terms)
+      end
+      terms
+    end
+
+    def get_values
+      terms = get_terms
+      values = {}
+      terms.each do |t|
+          next if t.empty?
+          key = t.to_s.split("generic_file__").last
+          next if ['part_of', 'date_modified', 'date_uploaded', 'format'].include?(key)
+          values[key] = self.send(key) if self.respond_to?(key)
+      end        
+      return values          
+    end
+
+    # Is this file in the middle of being processed by a batch?
+    def processing?
+       return false if self.batch.blank?
+       return false if !self.batch.methods.include? :status
+       return (!self.batch.status.empty?) && (self.batch.status.count == 1) && (self.batch.status[0] == "processing")
+    end
+
+    module ClassMethods
+      def get_label(key)
+         label = @@FIELD_LABEL_MAP[key]
+         label = key.gsub('_',' ').titleize if label.blank?
+         return label
+      end
+
+      # redefine find so that it sets the terms of service
+      def find(args, opts={})
+        gf = super
+        # use the field type to see if the return will be one item or multiple
+        if args.is_a? String
+          gf.terms_of_service = '1'
+        elsif gf.respond_to? :each
+          gf.each {|f| f.terms_of_service = '1'} 
+        end
+        return gf
+      end
+    end
+
+  end
+end