sufia 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a23f866c05484770f7f3caaec082f6cb36b7258
-  data.tar.gz: 47c0e1f3d27a544258f7d4d520d23152aad13773
+  metadata.gz: 94bdabbd0da949b6909f8a09f6c6db08910fa0d8
+  data.tar.gz: 363c5ec11e4dc93850a79dbf7cdd8a9a9a231870
 SHA512:
-  metadata.gz: d48523de8c674ffa5dd496b3595943ab4db13b9b42b26eb730b25bdb4db467a34863cb920d03b6d3c09c5a8e77ee4c3fed091ffa2316d3435bf3ab52c872c322
-  data.tar.gz: 2ab7bef74ddb9365f6f10695b2ade76c0149504dfebd349455ffc52cbbd58a8749410c581285c040b0abc4f790495597daf6797e27af46f2ad940e38f43c76e8
+  metadata.gz: 38714b26c3d16dfcb2ff8da8e03515ecff0bbd9171fb75c568f828aa327e64bbb7b2d0ffea855fbf9286ed64a77098f5e4c114682a6c2b470353ca4b35893006
+  data.tar.gz: 2c48c93673ec0fc8d540f801a945cf0ac10f0cbc487406ad3ddb91afad2e2a8e2d4e9567627135060cc32fadcb1618d3e06c0f583a15f61c1616322d5f2f9631

data/.gitignore

@@ -48,6 +48,8 @@ spec/dummy/log/*.log
 spec/dummy/tmp/
 
 
+spec/mock_upload_directory
+
 ## PROJECT::GENERAL
 coverage
 rdoc

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 # Please see sufia.gemspec for dependency information.
 gemspec

data/History.md

@@ -1,5 +1,82 @@
 # History of Sufia releases
 
+## 3.1.0
+* Make fits instructions more verbose [Carolyn Cole]
+
+* Adding one location to define/ override where the upload redirects to after a
+sucessfull upload [Carolyn Cole]
+
+* Added license to the gemspec [Justin Coyne]
+
+* fixed typo in require statement [Matt Zumwalt]
+
+* requires active_resource more cleanly [Matt Zumwalt]
+
+* updating facet views so that the blacklight helper_method will get called
+[Carolyn Cole]
+
+* Adds a spec for the ImportUrlJob [Michael J. Giarlo]
+
+* Fixed expecations for travis tests for #169 [Justin Coyne]
+
+* ModelMethods#apply_depositor_metadata should accept a user or a string like the
+method it overrides in HydraHead.  See:
+https://github.com/projecthydra/hydra-head/blob/9a5b2728be2046125d09376a6d78ad06d26548c3/hydra-core/lib/hydra/model_methods.rb#L12
+[Justin Coyne]
+
+* Remove expand_path jazz from remaining specs [Michael J. Giarlo]
+
+* Codifying a pid based job [Jeremy Friesen]
+
+* Removing characterization save unless new_object? [Jeremy Friesen]
+
+* Adding $LOAD_PATH variable to dev rake task [Jeremy Friesen]
+
+* Bump dependency on hydra-derivatives [Justin Coyne]
+
+* Use add_file() rather than add_file_datastream() to ensure object label is set
+[Michael J. Giarlo]
+
+* Audio and video transcoding with hydra-derivatives [Justin Coyne]
+
+* Use hydra-derivatives for generating thumbnails [Justin Coyne]
+
+* ingest_local_file should ingest the file, not the filename [Justin Coyne]
+
+* Including deposit agreement on local import page [Matt Zumwalt]
+
+* UI for local ingest only appears in local ingest tab on upload page [Matt
+Zumwalt]
+
+* Putting test coverage for virus check into the right place [Matt Zumwalt]
+
+* local file ingest runs virus check [Matt Zumwalt]
+
+* testing outputs without relying on consistent array ordering [Matt Zumwalt]
+
+* UI text changes for local ingest [Matt Zumwalt]
+
+* removing unused fixtures [Matt Zumwalt]
+
+* cleanup of tests and method names around local ingest [Matt Zumwalt]
+
+* Display local ingest tab in Upload page when local import enabled [Matt
+Zumwalt]
+
+* Local ingest renders graceful error message if User does not define a directory
+path [Matt Zumwalt]
+
+* fixing scope of describe blocks in this test [Matt Zumwalt]
+
+* LocalFileIngestBehavior for FilesController [Matt Zumwalt]
+
+* The generator should create config/initializers/resque_config.rb [Justin Coyne]
+
+* Reindex everything scopes to sufia's namespace [Jeremy Friesen]
+
+* Remove css that doesn't appear to be used [Justin Coyne]
+
+
 ## 3.0.0
 * Update README.md paths for Sufia assets application.css and application.js [Jim
 Coble]

data/README.md

@@ -25,14 +25,13 @@ Sufia has the following features:
 * Background jobs
 * Single-use links
 
-Sufia needs the following software to work:
-* Solr
-* Fedora Commons
-* A SQL RDBMS (MySQL, SQLite)
-* Redis
-* Ruby
-
-
+## Sufia needs the following software to work:
+1. Solr
+1. Fedora Commons
+1. A SQL RDBMS (MySQL, SQLite)
+1. [Redis](http://redis.io/) key-value store
+1. Ruby
+## !! Ensure that you have all of the above components installed before you continue. !!
 
 ## Creating an application
 ### Generate base Rails install
@@ -92,13 +91,29 @@ Add this line:
 ```
 
 ### Install Fits.sh
-http://code.google.com/p/fits/downloads/list
-Download a copy of fits & unpack it somewhere on your PATH.
+1. Go to http://code.google.com/p/fits/downloads/list and download a copy of fits & unpack it somewhere on your Machine.
+1. Give your system access to fits
+    1. By adding the path to fits.sh to your excutable PATH. (ex. in your .bashrc)
+        * OR
+    1. By adding/changing config/initializers/sufia.rb to point to your fits location:   `config.fits_path = "/<your full path>/fits.sh"`
+1. You may additionally need to chmod the fits.sh (chmod a+x fits.sh)
+1. You may need to restart your shell to pick up the changes to you path
+1. You should be able to run "fits.sh" from the command line and see a help message
 
 ### Start background workers
+**Note:** Resque relies on the [redis](http://redis.io/) key-value store.  You must install [redis](http://redis.io/) on your system and *have redis running* in order for this command to work.
+To start redis, you usually want to call the `redis-server` command.
+
+```
+QUEUE=* rake environment resque:work
 ```
-COUNT=4 QUEUE=* rake environment resque:work
+
+For production you may want to set up a config/resque-pool.yml and run resque pool in daemon mode
+
 ```
+resque-pool --daemon --environment development start
+```
+
 See https://github.com/defunkt/resque for more options
 
 ### If you want to enable transcoding of video, instal ffmpeg version 1.0+

data/SUFIA_VERSION

@@ -1 +1 @@
-3.0.0
+3.1.0

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -56,16 +56,17 @@ module Blacklight::RenderConstraintsHelperBehavior
   end 
 
   def render_filter_element(facet, values, localized_params)
+    facet_configuration_for_field(facet)
     values.map do |val|
-      if params[:controller] == 'dashboard'       
+      if params[:controller] == 'dashboard'
         render_constraint_element( facet_field_labels[facet],
-                  val, 
+                                   facet_display_value(facet, val),
                   :remove => dashboard_index_path(remove_facet_params(facet, val, localized_params)),
                   :classes => ["filter", "filter-" + facet.parameterize] 
                 ) + "\n"    
       else
         render_constraint_element( facet_field_labels[facet],
-                  val, 
+                                   facet_display_value(facet, val),
                   :remove => catalog_index_path(remove_facet_params(facet, val, localized_params)),
                   :classes => ["filter", "filter-" + facet.parameterize] 
                 ) + "\n"    

data/app/helpers/sufia_helper.rb

@@ -92,17 +92,19 @@ module SufiaHelper
 
   # Override to remove the label class (easier integration with bootstrap)
   # and handles arrays
-  def render_facet_value(facet_solr_field, item, options ={})    
+  def render_facet_value(facet_solr_field, item, options ={})
+    logger.warn "display value #{ facet_display_value(facet_solr_field, item)}"
     if item.is_a? Array
       render_array_facet_value(facet_solr_field, item, options)
     end
     if params[:controller] == "dashboard"
-      path = sufia.url_for(add_facet_params_and_redirect(facet_solr_field, item.value).merge(:only_path=>true))
-    (link_to_unless(options[:suppress_link], item.value, path, :class=>"facet_select") + " " + render_facet_count(item.hits)).html_safe
-    else 
+      path = sufia.url_for(add_facet_params_and_redirect(facet_solr_field,item.value ).merge(:only_path=>true))
+      path = sufia.url_for(add_facet_params_and_redirect(facet_solr_field,item.value ).merge(:only_path=>true))
+      (link_to_unless(options[:suppress_link], facet_display_value(facet_solr_field, item), path, :class=>"facet_select") + " " + render_facet_count(item.hits)).html_safe
+    else
       # This is for controllers that use this helper method that are defined outside Sufia
       path = url_for(add_facet_params_and_redirect(facet_solr_field, item.value).merge(:only_path=>true))
-    (link_to_unless(options[:suppress_link], item.value, path, :class=>"facet_select") + " " + render_facet_count(item.hits)).html_safe
+      (link_to_unless(options[:suppress_link], facet_display_value(facet_solr_field, item), path, :class=>"facet_select") + " " + render_facet_count(item.hits)).html_safe
     end
   end
 

data/app/jobs/ingest_local_file_job.rb

@@ -0,0 +1,34 @@
+class IngestLocalFileJob
+  def queue_name
+    :ingest
+  end
+
+  attr_accessor :directory, :filename, :user_key, :generic_file_id
+
+  def initialize(generic_file_id, directory, filename, user_key)
+    self.generic_file_id = generic_file_id
+    self.directory = directory
+    self.filename = filename 
+    self.user_key = user_key
+  end
+
+  def run
+    filedata = File.new( File.join(directory, filename) )
+    generic_file = GenericFile.find(generic_file_id)
+    user = User.find_by_user_key(user_key)
+    raise "Unable to find user for #{user_key}" unless user
+    
+    # virus check
+    virus_stat = Sufia::GenericFile::Actions.virus_check(filedata)
+    raise "Virus checking did not pass for #{File.basename(filedata.path)} status = #{virus_stat}" unless virus_stat == 0
+    
+    generic_file.label = File.basename(filename)
+    generic_file.add_file(File.open(File.join(directory, filename)), 'content', generic_file.label)
+    generic_file.record_version_committer(user)
+    generic_file.save!
+
+    #Sufia.queue.push(UnzipJob.new(generic_file.pid)) if generic_file.content.mimeType == 'application/zip'
+    Sufia.queue.push(ContentDepositEventJob.new(generic_file.pid, user_key))
+    FileUtils.rm([File.join(directory, filename)])
+  end
+end

data/app/views/catalog/_facet_selected.html.erb

@@ -5,7 +5,7 @@
       <% link_options = remove_facet_params(k, selected_facet, params).merge!Hash["controller" => "catalog", :action=> "index"] %>
       <div class="alert alert-warning">
         <%= link_to 'X', url_for(link_options), {:class=>'close', :'data-dismiss' => "alert" } %>
-        <i class="icon-ok icon-large"></i> <strong><%= selected_facet %></strong>
+        <i class="icon-ok icon-large"></i> <strong><%=  facet_display_value(k, selected_facet) %></strong>
       </div>
     <% end %>
   <% end %>

data/app/views/generic_files/_local_file_import.html.erb

@@ -0,0 +1,3 @@
+<%= render partial: 'generic_files/upload/agreement' %>
+<%= render partial: 'generic_files/upload/alerts' %>
+<%= render partial: 'generic_files/upload/local_file_import_chooser' %>

data/app/views/generic_files/new.html.erb

@@ -21,6 +21,9 @@ limitations under the License.
   <% if Sufia.config.dropbox_api_key %>
     <li><a href="#dropbox" data-toggle="tab"><i class="icon-inbox"></i> Dropbox</a></li>
   <% end %>
+  <% if Sufia.config.enable_local_ingest %>
+    <li><a href="#ingest" data-toggle="tab"><i class="icon-hdd"></i> Network/Server Location</a></li>
+  <% end %>
 </ul>
 
 <div class="tab-content">
@@ -33,4 +36,11 @@ limitations under the License.
       <%= render partial: 'dropbox_import' %>
     </div>
   <% end %>
+  
+  <% if Sufia.config.enable_local_ingest %>
+    <div class="tab-pane" id="ingest">
+      <%= render partial: 'generic_files/local_file_import' %>
+    </div>
+  <% end %>
+  
 </div>

data/app/views/generic_files/upload/_alerts.html.erb

@@ -2,7 +2,7 @@
 <div class="alert alert-info hide" id="success">
   You have successfully uploaded some of your files.  Either continue to upload or edit use the links below to abandon the rest of your added files.
   <p>
-  <%= link_to 'Add Descriptions', sufia.batch_edit_path(@batch_noid), :class=>'btn' %>
+  <%= link_to 'Add Descriptions', GenericFilesController.upload_complete_path(@batch_noid), :class=>'btn' %>
   </p>
 </div>
 
@@ -12,7 +12,7 @@
 
 <div class="alert hide" id="partial_fail">
   One or more files did not upload successfully. To continue using the files uploaded use one of the links below.<br />
-  <%= link_to 'Add Descriptions', sufia.batch_edit_path(@batch_noid), :class=>'btn' %>
+  <%= link_to 'Add Descriptions', GenericFilesController.upload_complete_path(@batch_noid), :class=>'btn' %>
 </div>
 
 <div class="alert hide" id="errmsg"> </div>

data/app/views/generic_files/upload/_local_file_import_chooser.html.erb

@@ -0,0 +1,27 @@
+<% if current_user.directory.present? %>
+  <div class="well">
+    <%= render partial: 'generic_files/upload/tos_checkbox' %>
+    <%= form_for @generic_file, :url => sufia.generic_files_path, :html => { :class => 'form-horizontal well'} do |f| %>
+      <table class="table table-striped">
+        <caption>Select files to deposit from your user directory on the server.</caption>
+        <thead>
+          <tr><th>File</th></tr>
+        </thead>
+        <tbody>
+        <%current_user.files.each do |f| %>
+          <tr>
+            <td>
+              <label><%= check_box_tag 'local_file[]', f[:name] %> <%= f[:directory] ? '<i class="icon-folder-close"></i>'.html_safe : '<i class="icon-file"></i>'.html_safe %> <%= f[:name] %></label>
+            </td>
+          </tr>
+        <%end%>
+        </tbody>
+      </table>
+      <%= hidden_field_tag(:batch_id, @batch_noid) %>
+      <button type="submit" class="activate-submit btn btn-primary start" id="main_upload_start">
+        <i class="icon-upload icon-white"></i>
+        <span>Deposit Selected Files</span>
+      </button>
+    <% end %>
+  </div>
+<% end %>

data/app/views/generic_files/upload/_script_templates.html.erb

@@ -1,6 +1,6 @@
 <div class="alert alert-info hide" id="redirect-loc" type="text/x-jquery-tmpl">
   <%-# Script redirects here once the uploads are complete %>
-  <%=sufia.batch_edit_path(@batch_noid)%>
+  <%=GenericFilesController.upload_complete_path(@batch_noid)%>
 </div>
 
 <!-- The template to display files available for upload -->

data/lib/generators/sufia/sufia_generator.rb

@@ -73,6 +73,7 @@ add_groups_to_users.rb		create_local_authorities.rb	create_trophies.rb}.each do
     copy_file "config/redis.yml", "config/redis.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
 
   def catalog_controller

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

@@ -1,22 +1,5 @@
-# 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.
-
-rails_root = ENV['RAILS_ROOT'] || "#{File.dirname(__FILE__)}/../.."
-rails_env = ENV['RAILS_ENV'] || 'development'
-
-config = YAML::load(ERB.new(IO.read(File.join(Rails.root, 'config', 'redis.yml'))).result)['resque'].with_indifferent_access
+config = YAML::load(ERB.new(IO.read(File.join(Rails.root, 'config', 'redis.yml'))).result)[Rails.env].with_indifferent_access
 Resque.redis = Redis.new(host: config[:host], port: config[:port], thread_safe: true)
 
-Resque.inline = rails_env == 'test'
-Resque.redis.namespace = "#{Sufia::Engine.config.id_namespace}:#{rails_env}"
+Resque.inline = Rails.env.test?
+Resque.redis.namespace = "#{Sufia::Engine.config.id_namespace}:#{Rails.env}"

data/lib/sufia/files_controller/local_ingest_behavior.rb

@@ -0,0 +1,54 @@
+module Sufia
+  module FilesController::LocalIngestBehavior
+  
+    private
+    
+    def perform_local_ingest
+      if Sufia.config.enable_local_ingest && current_user.respond_to?(:directory)
+        if ingest_local_file
+          redirect_to GenericFilesController.upload_complete_path( params[:batch_id])
+        else
+          flash[:alert] = "Error importing files from user directory."
+          render :new
+        end
+      else
+        flash[:alert] = "Your account is not configured for importing files from a user-directory on the server."
+        render :new
+      end
+    end
+
+    def ingest_local_file
+      # Ingest files already on disk
+      has_directories = false
+      files = []
+      params[:local_file].each do |filename|
+        if File.directory?(File.join(current_user.directory, filename))
+          has_directories = true
+          Dir[File.join(current_user.directory, filename, '**', '*')].each do |single|
+            next if File.directory? single
+            logger.info("Ingesting file: #{single}")
+            files << single.sub(current_user.directory + '/', '')
+            logger.info("after removing the user directory #{current_user.directory} we have: #{files.last}")
+          end
+        else
+          files << filename
+        end
+      end
+      files.each do |filename|
+        ingest_one(filename, has_directories)
+      end
+      true
+    end
+
+    def ingest_one(filename, unarranged)
+      # do not remove :: 
+      @generic_file = ::GenericFile.new
+      basename = File.basename(filename)
+      @generic_file.label = basename
+      @generic_file.relative_path = filename if filename != basename
+      create_metadata(@generic_file)
+      Sufia.queue.push(IngestLocalFileJob.new(@generic_file.id, current_user.directory, filename, current_user.user_key))
+    end
+    
+  end # /FilesController::LocalIngestBehavior
+end # /Sufia

data/lib/sufia/files_controller/upload_complete_behavior.rb

@@ -0,0 +1,7 @@
+module Sufia
+  module FilesController::UploadCompleteBehavior
+    def upload_complete_path(batch_id)
+      Sufia::Engine.routes.url_helpers.batch_edit_path(batch_id)
+    end
+  end # /FilesController::UploadCompleteBehavior
+end # /Sufia

data/lib/sufia/files_controller_behavior.rb

@@ -14,13 +14,21 @@
 # limitations under the License.
 
 module Sufia
+  module FilesController
+    autoload :LocalIngestBehavior, 'sufia/files_controller/local_ingest_behavior'
+    autoload :UploadCompleteBehavior, 'sufia/files_controller/upload_complete_behavior'
+  end
   module FilesControllerBehavior
     extend ActiveSupport::Concern
+    extend Sufia::FilesController::UploadCompleteBehavior
 
     included do
       include Hydra::Controller::ControllerBehavior
       include Blacklight::Configurable # comply with BL 3.7
-      include Sufia::Noid # for normalize_identifier method
+      include Sufia::Noid # for normalize_identifier method    
+      include Sufia::FilesController::LocalIngestBehavior
+      extend Sufia::FilesController::UploadCompleteBehavior
+
       layout "sufia-one-column"
       
       # This is needed as of BL 3.7
@@ -44,6 +52,7 @@ module Sufia
       prepend_before_filter :normalize_identifier, :except => [:index, :create, :new]
       load_resource :only=>[:audit]
       load_and_authorize_resource :except=>[:index, :audit]
+
     end
 
     # routed to /files/new
@@ -68,14 +77,20 @@ module Sufia
 
     # routed to /files (POST)
     def create
-      case params['file_coming_from']
-      when 'dropbox'
-        create_from_url(params)
+      if params[:local_file].present?
+        perform_local_ingest
       else
-        create_from_local(params)
+        case params['file_coming_from']
+        when 'dropbox'
+          create_from_url(params)
+        else
+          create_from_upload(params)
+        end
       end
     end
 
+
+
     def create_from_url(params)
       params[:dropbox_urls].each do |db_file|
         next if db_file.blank?
@@ -83,13 +98,13 @@ module Sufia
         @generic_file = ::GenericFile.new
         @generic_file.import_url = db_file
         @generic_file.label = File.basename(db_file)
-        Sufia::GenericFile::Actions.create_metadata(@generic_file, current_user, params[:batch_id])
+        create_metadata(@generic_file)
         Sufia.queue.push(ImportUrlJob.new(@generic_file.pid)) 
       end
-      redirect_to sufia.batch_edit_path(params[:batch_id])
+      redirect_to self.class.upload_complete_path( params[:batch_id])
     end
 
-    def create_from_local(params)
+    def create_from_upload(params)
       begin
         # check error condition No files
         return json_error("Error! No file to save") if !params.has_key?(:files)
@@ -138,7 +153,7 @@ module Sufia
 
       if params.has_key?(:revision) and params[:revision] !=  @generic_file.content.latest_version.versionID
         revision = @generic_file.content.get_version(params[:revision])
-        @generic_file.add_file_datastream(revision.content, :dsid => 'content', :mimeType => revision.mimeType)
+        @generic_file.add_file(revision.content, datastream_id, revision.label)
         version_event = true
         Sufia.queue.push(ContentRestoredVersionEventJob.new(@generic_file.pid, current_user.user_key, params[:revision]))
       end
@@ -181,7 +196,7 @@ module Sufia
       if virus_check(file) == 0 
         @generic_file = ::GenericFile.new
         update_metadata_from_upload_screen
-        Sufia::GenericFile::Actions.create_metadata(@generic_file, current_user, params[:batch_id])
+        create_metadata(@generic_file)
         Sufia::GenericFile::Actions.create_content(@generic_file, file, file.original_filename, datastream_id, current_user)
         respond_to do |format|
           format.html {
@@ -235,7 +250,12 @@ module Sufia
       stat = Sufia::GenericFile::Actions.virus_check(file)
       flash[:error] = "Virus checking did not pass for #{File.basename(file.path)} status = #{stat}" unless stat == 0
       stat
-    end 
+    end
+
+
+    def create_metadata(file)
+      Sufia::GenericFile::Actions.create_metadata(file, current_user, params[:batch_id])
+    end
 
   end
 end