sufia 3.0.0 → 3.1.0

data/spec/models/local_authority_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 # Don't run the tests if activerecord-import isn't installed.
 # The 0.3.1 version doesn't work with rails 4, so suppress these tests

data/spec/models/properties_datastream_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe PropertiesDatastream do
 

data/spec/models/single_use_link_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe SingleUseLink do
   before (:all) do

data/spec/models/solr_document_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe SolrDocument do
   describe "when mime-type is 'application/mxf'" do

data/spec/models/transcode_audio_job_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe TranscodeAudioJob, :if => Sufia.config.enable_ffmpeg do
   before do
@@ -7,18 +7,18 @@ describe TranscodeAudioJob, :if => Sufia.config.enable_ffmpeg do
     @generic_file.stub(:characterize_if_changed).and_yield
   end
 
-  after do
-    @generic_file.delete
-  end
-
-  subject { TranscodeAudioJob.new(@generic_file.id, 'content')}
+  subject { TranscodeAudioJob.new(@generic_file.id)}
 
 
   describe "with a wav file" do
     before do
-      @generic_file.add_file_datastream(File.new(fixture_path + '/piano_note.wav'), :dsid=>'content')
+      @generic_file.add_file(File.open(fixture_path + '/piano_note.wav'), 'content', 'piano_note.wav')
       @generic_file.save!
     end
+    after do
+      @generic_file.delete
+    end
+
 
     it "should transcode to mp3 and ogg" do
       subject.run
@@ -26,7 +26,7 @@ describe TranscodeAudioJob, :if => Sufia.config.enable_ffmpeg do
       derivative = reloaded.datastreams['mp3']
       derivative.should_not be_nil
       derivative.content.should_not be_nil
-      derivative.mimeType.should == 'audio/mp3'
+      derivative.mimeType.should == 'audio/mpeg'
 
       derivative2 = reloaded.datastreams['ogg']
       derivative2.should_not be_nil
@@ -36,13 +36,15 @@ describe TranscodeAudioJob, :if => Sufia.config.enable_ffmpeg do
   end
 
   describe "with an mp3 file" do
-    before do
-      @generic_file.add_file_datastream(File.new(fixture_path + '/sufia/sufia_test5.mp3'), :dsid=>'content')
-      @generic_file.characterize # so that the mime_type is set
-      @generic_file.save!
-    end
+    # Uncomment when this is nolonger pending
+    # before do
+    #   @generic_file.add_file(File.open(fixture_path + '/sufia/sufia_test5.mp3'), 'content', 'sufia_test5.mp3')
+    #   @generic_file.characterize # so that the mime_type is set
+    #   @generic_file.save!
+    # end
 
     it "should copy the content to the mp3 datastream and transcode to ogg" do
+      pending "Need a way to do this in hydra-derivatives"
       subject.run
       reloaded = GenericFile.find(@generic_file.pid)
       derivative = reloaded.datastreams['mp3']
@@ -57,13 +59,15 @@ describe TranscodeAudioJob, :if => Sufia.config.enable_ffmpeg do
     end
   end
   describe "with an ogg file" do
-    before do
-      @generic_file.add_file_datastream(File.new(fixture_path + '/Example.ogg'), :dsid=>'content')
-      @generic_file.characterize # so that the mime_type is set
-      @generic_file.save!
-    end
+    # Uncomment when this is nolonger pending
+    # before do
+    #   @generic_file.add_file(File.open(fixture_path + '/Example.ogg'), 'content', 'Example.ogg')
+    #   @generic_file.characterize # so that the mime_type is set
+    #   @generic_file.save!
+    # end
 
     it "should copy the content to the ogg datastream and transcode to mp3" do
+      pending "Need a way to do this in hydra-derivatives"
       subject.run
       reloaded = GenericFile.find(@generic_file.pid)
       derivative = reloaded.datastreams['mp3']

data/spec/models/transcode_video_job_spec.rb

@@ -1,11 +1,12 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe TranscodeVideoJob, :if => Sufia.config.enable_ffmpeg do
   before do
     @generic_file = GenericFile.new
     @generic_file.apply_depositor_metadata('jcoyne@example.com')
-    @generic_file.add_file_datastream(File.new(fixture_path + '/countdown.avi'), :dsid=>'content')
+    @generic_file.add_file(File.open(fixture_path + '/countdown.avi'), 'content', 'countdown.avi')
     @generic_file.stub(:characterize_if_changed).and_yield
+    @generic_file.mime_type = 'video/avi'
     @generic_file.save!
   end
 
@@ -13,7 +14,7 @@ describe TranscodeVideoJob, :if => Sufia.config.enable_ffmpeg do
     @generic_file.delete
   end
 
-  subject { TranscodeVideoJob.new(@generic_file.id, 'content')}
+  subject { TranscodeVideoJob.new(@generic_file.id)}
   it "should put content in datastream_out" do
     subject.run
     reloaded = GenericFile.find(@generic_file.pid)

data/spec/models/trophy_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe Trophy do
    before(:all) do

data/spec/models/unzip_job_spec.rb

@@ -1,10 +1,10 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe UnzipJob do
   before do
     @batch = Batch.create
     @generic_file = GenericFile.new(:batch=>@batch)
-    @generic_file.add_file_datastream(File.new(fixture_path + '/icons.zip'), :dsid=>'content')
+    @generic_file.add_file(File.open(fixture_path + '/icons.zip'), 'content', 'icons.zip')
     @generic_file.apply_depositor_metadata('mjg36')
     @generic_file.stub(:characterize_if_changed).and_yield #don't run characterization
     @generic_file.save

data/spec/models/user_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe User do
   before(:all) do

data/spec/rake/sufia_fixtures_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 # Used to test the sufia-fixtures rake task
 require "rake"

data/spec/routing/route_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe 'Routes' do
   before(:each) do

data/spec/spec_helper.rb

@@ -19,8 +19,8 @@ $in_travis = !ENV['TRAVIS'].nil? && ENV['TRAVIS'] == 'true'
 
 if $in_travis
   # Monkey-patches the FITS runner to return the PDF FITS fixture
-  module Sufia
-    module FileContent
+  module Hydra 
+    module Derivatives
       module ExtractMetadata
         def run_fits!(path)
           File.open(File.join(File.expand_path('../fixtures', __FILE__), 'pdf_fits.xml')).read

data/spec/views/batch_edits/check_all_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+require 'spec_helper'
 
 describe 'Check All' do
   before (:all) do

data/sufia-models/app/models/datastreams/file_content_datastream.rb

@@ -1,18 +1,4 @@
-# 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 FileContentDatastream < ActiveFedora::Datastream
-  include Sufia::FileContent::ExtractMetadata
+  include Hydra::Derivatives::ExtractMetadata
   include Sufia::FileContent::Versions
 end

data/sufia-models/app/models/geo_names_resource.rb

@@ -1,5 +1,3 @@
-require 'active_resource'
-
 class GeoNamesResource < ActiveResource::Base
   self.site = "http://api.geonames.org/"
   self.element_name = "searchJSON"

data/sufia-models/lib/sufia/models.rb

@@ -5,7 +5,7 @@ require 'nest'
 require 'mailboxer'
 require 'acts_as_follower'
 require 'paperclip'
-require 'RMagick'
+require "active_resource" # used by GenericFile to catch errors & by GeoNamesResource
 begin
   # activerecord-import 0.3.1 does not support rails 4, so we don't require it.
   require 'activerecord-import'

data/sufia-models/lib/sufia/models/engine.rb

@@ -22,6 +22,7 @@ module Sufia
       config.fits_path = "fits.sh"
       config.enable_contact_form_delivery = false
       config.dropbox_api_key = nil
+      config.enable_local_ingest = nil      
       config.queue = Sufia::Resque::Queue
 
       config.autoload_paths += %W(
@@ -40,22 +41,32 @@ module Sufia
       end
 
       initializer 'requires' do
+        require 'hydra/derivatives'
         require 'sufia/models/model_methods'
         require 'sufia/models/noid'
         require 'sufia/models/file_content'
-        require 'sufia/models/file_content/extract_metadata'
         require 'sufia/models/file_content/versions'
         require 'sufia/models/generic_file/actions'
         require 'sufia/models/generic_file/audit'
         require 'sufia/models/generic_file/characterization'
+        require 'sufia/models/generic_file/derivatives'
         require 'sufia/models/generic_file/export'
+        require 'sufia/models/generic_file/mime_types'
         require 'sufia/models/generic_file/permissions'
         require 'sufia/models/generic_file/thumbnail'
         require 'sufia/models/generic_file'
         require 'sufia/models/user'
+        require 'sufia/models/user_local_directory_behavior'
         require 'sufia/models/id_service'
         require 'sufia/models/solr_document_behavior'
       end
+
+      initializer 'configure' do
+        Hydra::Derivatives.ffmpeg_path    = Sufia.config.ffmpeg_path
+        Hydra::Derivatives.temp_file_base = Sufia.config.temp_file_base
+        Hydra::Derivatives.fits_path      = Sufia.config.fits_path
+        Hydra::Derivatives.enable_ffmpeg  = Sufia.config.enable_ffmpeg
+      end
     end
   end
 end

data/sufia-models/lib/sufia/models/file_content.rb

@@ -1,9 +1,6 @@
 module Sufia
   module FileContent
     extend ActiveSupport::Autoload
-
-    autoload :ExtractMetadata, 'sufia/models/file_content/extract_metadata'
     autoload :Versions, 'sufia/models/file_content/versions'
-
   end
 end

data/sufia-models/lib/sufia/models/generic_file.rb

@@ -2,22 +2,20 @@ module Sufia
   module GenericFile
     extend ActiveSupport::Concern
     extend ActiveSupport::Autoload
-    autoload :Export
-    autoload :Thumbnail
-    autoload :Characterization
-    autoload :Audit
     autoload :Actions
     autoload :Permissions
     autoload :WebForm, 'sufia/models/generic_file/web_form'
     autoload :AccessibleAttributes, 'sufia/models/generic_file/accessible_attributes'
     include Sufia::ModelMethods
     include Sufia::Noid
+    include Sufia::GenericFile::MimeTypes
     include Sufia::GenericFile::Thumbnail
     include Sufia::GenericFile::Export
     include Sufia::GenericFile::Characterization
     include Sufia::GenericFile::Audit
     include Sufia::GenericFile::Permissions
     include Sufia::GenericFile::WebForm
+    include Sufia::GenericFile::Derivatives
 
     included do
       has_metadata :name => "descMetadata", :type => GenericFileRdfDatastream
@@ -52,21 +50,19 @@ module Sufia
     end
 
     def pdf?
-      ['application/pdf'].include? self.mime_type
+      self.class.pdf_mime_types.include? self.mime_type
     end
 
     def image?
-      ['image/png','image/jpeg', 'image/jpg', 'image/jp2', 'image/bmp', 'image/gif'].include? self.mime_type
+      self.class.image_mime_types.include? self.mime_type
     end
 
     def video?
-      ['video/mpeg', 'video/mp4', 'video/webm', 'video/x-msvideo', 'video/avi', 'video/quicktime', 'application/mxf'].include? self.mime_type
+      self.class.video_mime_types.include? self.mime_type
     end
 
     def audio?
-      # audio/x-wave is the mime type that fits 0.6.0 returns for a wav file.
-      # audio/mpeg is the mime type that fits 0.6.0 returns for an mp3 file.
-      ['audio/mp3', 'audio/mpeg', 'audio/x-wave', 'audio/x-wav', 'audio/ogg'].include? self.mime_type
+      self.class.audio_mime_types.include? self.mime_type
     end
 
     def persistent_url

data/sufia-models/lib/sufia/models/generic_file/actions.rb

@@ -3,7 +3,7 @@ module Sufia::GenericFile
   module Actions
     def self.create_metadata(generic_file, user, batch_id)
 
-      generic_file.apply_depositor_metadata(user.user_key)
+      generic_file.apply_depositor_metadata(user)
       generic_file.date_uploaded = Date.today
       generic_file.date_modified = Date.today
       generic_file.creator = user.name

data/sufia-models/lib/sufia/models/generic_file/characterization.rb

@@ -36,7 +36,7 @@ module Sufia
         self.characterization.ng_xml = self.content.extract_metadata
         self.append_metadata
         self.filename = self.label
-        save unless self.new_object?
+        save
       end
 
       # Populate descMetadata with fields from FITS (e.g. Author from pdfs)

data/sufia-models/lib/sufia/models/generic_file/derivatives.rb

@@ -0,0 +1,31 @@
+module Sufia
+  module GenericFile
+    module Derivatives
+      extend ActiveSupport::Concern
+
+      included do
+        include Hydra::Derivatives
+
+        makes_derivatives do |obj| 
+          case obj.mime_type
+          when *pdf_mime_types
+            obj.transform_datastream :content, 
+              { :thumbnail => {size: "338x493", datastream: 'thumbnail'} }
+          when *audio_mime_types
+            obj.transform_datastream :content,
+              { :mp3 => {format: 'mp3', datastream: 'mp3'},
+                :ogg => {format: 'ogg', datastream: 'ogg'} }, processor: :audio
+          when *video_mime_types
+            obj.transform_datastream :content,
+              { :webm => {format: "webm", datastream: 'webm'}, 
+                :mp4 => {format: "mp4", datastream: 'mp4'} }, processor: :video
+          when *image_mime_types
+            obj.transform_datastream :content, { :thumbnail => {size: "200x150>", datastream: 'thumbnail'} }
+          end
+        end
+      end
+
+    end
+  end
+end
+

data/sufia-models/lib/sufia/models/generic_file/mime_types.rb

@@ -0,0 +1,27 @@
+module Sufia
+  module GenericFile
+    module MimeTypes
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def image_mime_types
+          ['image/png','image/jpeg', 'image/jpg', 'image/jp2', 'image/bmp', 'image/gif']
+        end
+
+        def pdf_mime_types
+          ['application/pdf']
+        end
+
+        def video_mime_types
+          ['video/mpeg', 'video/mp4', 'video/webm', 'video/x-msvideo', 'video/avi', 'video/quicktime', 'application/mxf']
+        end
+
+        def audio_mime_types
+          # audio/x-wave is the mime type that fits 0.6.0 returns for a wav file.
+          # audio/mpeg is the mime type that fits 0.6.0 returns for an mp3 file.
+          ['audio/mp3', 'audio/mpeg', 'audio/wav', 'audio/x-wave', 'audio/x-wav', 'audio/ogg']
+        end
+      end
+    end
+  end
+end

data/sufia-models/lib/sufia/models/generic_file/thumbnail.rb

@@ -1,17 +1,18 @@
 module Sufia
   module GenericFile
     module Thumbnail
+      extend ActiveSupport::Concern
       # Create thumbnail requires that the characterization has already been run (so mime_type, width and height is available)
       # and that the object is already has a pid set
       def create_thumbnail
         return unless self.content.has_content?
-        if pdf?
-          create_pdf_thumbnail
-        elsif image?
-          create_image_thumbnail
-        elsif video?
+
+        if video?
           create_video_thumbnail
+        else
+          create_derivatives
         end
+        self.save
       end
 
       protected
@@ -29,61 +30,6 @@ module Sufia
 
         self.thumbnail.content = File.open(output_file, 'rb').read
         self.thumbnail.mimeType = 'image/png'
-        self.save
-      end
-
-      def create_pdf_thumbnail
-        retryCnt = 0
-        stat = false;
-        for retryCnt in 1..3
-          begin
-            pdf = load_image_transformer
-            first = pdf.to_a[0]
-            first.format = "PNG"
-            thumb = first.scale(338, 493)
-            self.thumbnail.content = thumb.to_blob { self.format = "PNG" }
-            self.thumbnail.mimeType = 'image/png'
-            self.save
-            break
-          rescue => e
-            logger.warn "Rescued an error #{e.inspect} retry count = #{retryCnt}"
-            sleep 1
-          end
-        end
-        return stat
-      end
-
-      def create_image_thumbnail
-        self.thumbnail.content = scale_image.to_blob { self.format = "PNG" }
-        self.thumbnail.mimeType = 'image/png'
-        #logger.debug "Has the content before saving? #{self.content.changed?}"
-        self.save
-      end
-
-      def scale_image
-        img = load_image_transformer
-        height = Float(self.height.first.to_i)
-        width = Float(self.width.first.to_i)
-        if width > height && width > 150 && height > 105
-          # horizontal img
-          scale  = 150 / width
-          img.scale(150, height * scale)
-        elsif height >= width && width > 150 && height > 200
-          # vertical or square
-          scale  = 200 / height
-          img.scale(width*scale, 200)
-        else
-          # Too small to worry about resizing
-          img
-        end
-      end
-
-      # Override this method if you want a different transformer, or need to load the 
-      # raw image from a different source (e.g.  external datastream)
-      def load_image_transformer
-        xformer = Magick::ImageList.new
-        xformer.from_blob(content.content)
-        xformer
       end
 
     end