ddr-models 2.3.2 → 2.4.0.rc1

data/lib/ddr/managers/derivatives_manager.rb

@@ -51,23 +51,27 @@ module Ddr
       end
 
       def generate_derivative!(derivative)
-        tempdir = FileUtils.mkdir(File.join(Dir.tmpdir, Dir::Tmpname.make_tmpname('',nil))).first
-        generator_source = create_source_file(tempdir)
-        generator_output = File.new(File.join(tempdir, "output.out"), 'wb')
-        results = derivative.generator.new(generator_source.path, generator_output.path, derivative.options).generate
-        generator_source.close unless generator_source.closed?
-        if results.status.success?
-          generator_output = File.open(generator_output, 'rb')
-          object.reload if object.persisted?
-          object.add_file generator_output, derivative.datastream, mime_type: derivative.generator.output_mime_type
-          object.save!
-        else
-          Rails.logger.error results.stderr
-          raise Ddr::Models::DerivativeGenerationFailure,
-                  "Failure generating #{derivative.name} for #{object.pid}: #{results.stderr}"
+        tempdir_path = File.join(Dir.tmpdir, Dir::Tmpname.make_tmpname('',nil))
+        begin
+          tempdir = FileUtils.mkdir(tempdir_path).first
+          generator_source = create_source_file(tempdir)
+          generator_output = File.new(File.join(tempdir, "output.out"), 'wb')
+          results = derivative.generator.new(generator_source.path, generator_output.path, derivative.options).generate
+          generator_source.close unless generator_source.closed?
+          if results.status.success?
+            generator_output = File.open(generator_output, 'rb')
+            object.reload if object.persisted?
+            object.add_file generator_output, derivative.datastream, mime_type: derivative.generator.output_mime_type
+            object.save!
+          else
+            Rails.logger.error results.stderr
+            raise Ddr::Models::DerivativeGenerationFailure,
+                    "Failure generating #{derivative.name} for #{object.pid}: #{results.stderr}"
+          end
+          generator_output.close unless generator_output.closed?
+        ensure
+          FileUtils.remove_dir(tempdir_path) if File.exist?(tempdir_path)
         end
-        generator_output.close unless generator_output.closed?
-        FileUtils.remove_dir(tempdir)
       end
 
       def delete_derivative(derivative)
@@ -110,7 +114,7 @@ module Ddr
         when :multires_image
           object.content_type == "image/tiff"
         when :thumbnail
-          object.image? || object.pdf?
+          object.image?
         else
           false
         end

data/lib/ddr/models.rb

@@ -11,15 +11,14 @@ require 'hydra/validations'
 
 module Ddr
   extend ActiveSupport::Autoload
+  extend Deprecation
 
   autoload :Actions
   autoload :Auth
-  autoload :Contacts
   autoload :Datastreams
   autoload :Derivatives
   autoload :Events
   autoload :Index
-  autoload :IndexFields
   autoload :Jobs
   autoload :Managers
   autoload :Metadata
@@ -27,6 +26,16 @@ module Ddr
   autoload :Utils
   autoload :Vocab
 
+  def self.const_missing(name)
+    if name == :IndexFields
+      Deprecation.warn(Ddr::Models, "`Ddr::IndexFields` is deprecated and will be removed in ddr-models 3.0." \
+                                    " Use `Ddr::Index::Fields` instead.")
+      Index::Fields
+    else
+      super
+    end
+  end
+
   module Models
     extend ActiveSupport::Autoload
 
@@ -34,11 +43,13 @@ module Ddr
     autoload :AdminSet
     autoload :Base
     autoload :ChecksumInvalid, 'ddr/models/error'
+    autoload :Contact
     autoload :ContentModelError, 'ddr/models/error'
     autoload :DerivativeGenerationFailure, 'ddr/models/error'
     autoload :Describable
     autoload :Error
     autoload :EventLoggable
+    autoload :FileCharacterization
     autoload :FileManagement
     autoload :FindingAid
     autoload :FixityCheckable
@@ -54,6 +65,7 @@ module Ddr
     autoload :SolrDocument
     autoload :StructDiv
     autoload :Structure
+    autoload :WithContentFile
     autoload :YearFacet
 
     autoload_under "licenses" do

data/lib/ddr/models/access_controllable.rb

@@ -2,26 +2,23 @@ module Ddr
   module Models
     module AccessControllable
       extend ActiveSupport::Concern
+      extend Deprecation
 
       included do
         include Hydra::AccessControls::Permissions
       end
 
       def set_initial_permissions(user_creator = nil)
-        warn "[DEPRECATION] `set_initial_permissions` is deprecated" \
-             " and should not be used with role-based access control" \
-             " (#{caller.first})."
         if user_creator
           self.permissions_attributes = [{type: "user", access: "edit", name: user_creator.to_s}]
         end
       end
+      deprecation_deprecate :set_initial_permissions
 
       def copy_permissions_from(other)
-        warn "[DEPRECATION] `copy_permissions_from` is deprecated" \
-             " and should not be used with role-based access control" \
-             " (#{caller.first})."
         self.permissions_attributes = other.permissions.collect { |p| p.to_hash }
       end
+      deprecation_deprecate :copy_permissions_from
     end
   end
 end

data/lib/ddr/models/admin_set.rb

@@ -1,11 +1,13 @@
-require "ddr_aux/client"
+require "active_resource"
 
 module Ddr::Models
-  class AdminSet < DdrAux::Client::AdminSet
+  class AdminSet < ActiveResource::Base
+
+    self.site = ENV["DDR_AUX_API_URL"]
 
     def self.call(obj)
       if obj.admin_set
-        find(code: obj.admin_set)
+        get(:find, code: obj.admin_set)
       end
     end
 

data/lib/ddr/models/base.rb

@@ -22,9 +22,8 @@ module Ddr
       end
 
       def copy_admin_policy_or_permissions_from(other)
-        warn "[DEPRECATION] `copy_admin_policy_or_permissions_from` is deprecated." \
-             " Use `copy_admin_policy_or_roles_from` instead." \
-             " (#{caller.first})."
+        Deprecation.warn(self.class, "`copy_admin_policy_or_permissions_from` is deprecated." \
+                                     " Use `copy_admin_policy_or_roles_from` instead.")
         copy_admin_policy_or_roles_from(other)
       end
 

data/lib/ddr/models/contact.rb

@@ -0,0 +1,17 @@
+require "active_resource"
+
+module Ddr::Models
+  class Contact < ActiveResource::Base
+
+    self.site = ENV["DDR_AUX_API_URL"]
+
+    def self.call(slug)
+      get(:find, slug: slug)
+    end
+
+    def to_s
+      name
+    end
+
+  end
+end

data/lib/ddr/models/file_characterization.rb

@@ -0,0 +1,37 @@
+require "delegate"
+require "shellwords"
+
+module Ddr::Models
+  class FileCharacterization < SimpleDelegator
+
+    class FITSError < Error; end
+
+    def self.call(obj)
+      new(obj).call
+    end
+
+    def call
+      with_content_file do |path|
+        fits_output = run_fits(path)
+        reload
+        fits.content = fits_output
+        save!
+      end
+    end
+
+    private
+
+    def run_fits(path)
+      output = `#{fits_command} -i #{Shellwords.escape(path)}`
+      unless $?.success?
+        raise FITSError, output
+      end
+      output
+    end
+
+    def fits_command
+      File.join(Ddr::Models.fits_home, 'fits.sh')
+    end
+
+  end
+end

data/lib/ddr/models/has_admin_metadata.rb

@@ -20,6 +20,7 @@ module Ddr::Models
                      :research_help_contact,
                      :workflow_state,
                      :ead_id,
+                     :aspace_id,
                      datastream: "adminMetadata",
                      multiple: false
 
@@ -64,7 +65,7 @@ module Ddr::Models
     end
 
     def research_help
-      Ddr::Contacts.get(research_help_contact) if research_help_contact
+      Ddr::Models::Contact.call(research_help_contact) if research_help_contact
     end
 
     def effective_license

data/lib/ddr/models/has_content.rb

@@ -1,5 +1,3 @@
-require 'openssl'
-
 module Ddr
   module Models
     module HasContent
@@ -128,6 +126,10 @@ module Ddr
         extractedText.has_content?
       end
 
+      def with_content_file(&block)
+        WithContentFile.new(self, &block)
+      end
+
       protected
 
       def update_derivatives

data/lib/ddr/models/indexing.rb

@@ -4,6 +4,10 @@ module Ddr
 
       include Ddr::Index::Fields
 
+      def self.const_missing(name)
+        Ddr::Index::Fields.const_missing(name)
+      end
+
       def to_solr(solr_doc=Hash.new, opts={})
         solr_doc = super(solr_doc, opts)
         solr_doc.merge index_fields
@@ -13,6 +17,7 @@ module Ddr
         fields = {
           ACCESS_ROLE           => roles.to_json,
           ADMIN_SET             => admin_set,
+          ASPACE_ID             => aspace_id,
           BOX_NUMBER_FACET      => desc_metadata_values('box_number'),
           CREATOR_FACET         => creator,
           DATE_FACET            => date,

data/lib/ddr/models/licenses/license.rb

@@ -1,13 +1,15 @@
-require "ddr_aux/client"
+require "active_resource"
 
 module Ddr::Models
-  class License < DdrAux::Client::License
+  class License < ActiveResource::Base
+
+    self.site = ENV["DDR_AUX_API_URL"]
 
     attr_accessor :pid
 
     def self.call(obj)
       if obj.license
-        license = find(url: obj.license)
+        license = get(:find, url: obj.license)
         license.pid = obj.pid
         license
       end

data/lib/ddr/models/solr_document.rb

@@ -189,7 +189,7 @@ module Ddr::Models
 
     def research_help
       research_help_contact = self[Ddr::Index::Fields::RESEARCH_HELP_CONTACT] || inherited_research_help_contact
-      Ddr::Contacts.get(research_help_contact) if research_help_contact
+      Ddr::Models::Contact.call(research_help_contact) if research_help_contact
     end
 
     def parent_uri

data/lib/ddr/models/version.rb

@@ -1,5 +1,5 @@
 module Ddr
   module Models
-    VERSION = "2.3.2"
+    VERSION = "2.4.0.rc1"
   end
 end

data/lib/ddr/models/with_content_file.rb

@@ -0,0 +1,37 @@
+require "tempfile"
+require "delegate"
+
+module Ddr::Models
+  class WithContentFile < SimpleDelegator
+
+    def initialize(obj, &block)
+      super(obj)
+      with_temp_file &block
+    end
+
+    # Yields path of tempfile containing content to block
+    # @yield [String] the path to the tempfile containing content
+    def with_temp_file
+      filename = original_filename || content.default_file_name
+      basename = [ File.basename(filename, ".*"), File.extname(filename) ]
+      infile = Tempfile.open(basename, Ddr::Models.tempdir, encoding: 'ascii-8bit')
+      begin
+        infile.write(content.content)
+        infile.close
+        verify_checksum!(infile)
+        yield infile.path
+      ensure
+        infile.close unless infile.closed?
+        File.unlink(infile)
+      end
+    end
+
+    def verify_checksum!(file)
+      digest = Ddr::Utils.digest(File.read(file), content.checksumType)
+      if digest != content.checksum
+        raise ChecksumInvalid, "The checksum of the downloaded file does not match the stored checksum of the content."
+      end
+    end
+
+  end
+end

data/lib/ddr/vocab/asset.rb

@@ -18,6 +18,9 @@
       property "eadId",
         label: "EAD ID"
 
+      property "archivesSpaceId",
+        label: "ArchivesSpace Identifier"
+
     end
   end
 end

data/spec/derivatives/png_generator_spec.rb

@@ -17,6 +17,13 @@ module Ddr
             expect(File.size(output_file.path)).to be > 0
           end
         end
+        context "animated gif source" do
+          let(:source) { File.join(Ddr::Models::Engine.root, "spec", "fixtures", "arrow1rightred_e0.gif") }
+          it "should generate a non-empty file" do
+            generator.generate
+            expect(File.size(output_file.path)).to be > 0
+          end
+        end
       end
 
     end

data/spec/factories/test_model_factories.rb

@@ -34,7 +34,7 @@ FactoryGirl.define do
     sequence(:identifier) { |n| [ "testparent%05d" % n ] }
 
     factory :test_parent_has_children do
-      ignore do
+      transient do
         child_count 3
       end
       after(:create) do |parent, evaluator|

data/spec/index/query_value_spec.rb

@@ -0,0 +1,33 @@
+module Ddr::Index
+  RSpec.describe QueryValue do
+
+    describe ".or_values" do
+      describe "when argument is nil" do
+        it "raises an exception" do
+          expect { described_class.or_values(nil) }.to raise_error(ArgumentError)
+        end
+      end
+      describe "when argument is empty" do
+        it "raises an exception" do
+          expect { described_class.or_values([]) }.to raise_error(ArgumentError)
+        end
+      end
+      describe "when argument is not enumerable" do
+        it "raises an exception" do
+          expect { described_class.or_values("foo") }.to raise_error(ArgumentError)
+        end
+      end
+      describe "when argument size == 1" do
+        it "returns the first value, escaped" do
+          expect(described_class.or_values(["foo:bar"])).to eq("(foo\\:bar)")
+        end
+      end
+      describe "when argument size > 1" do
+        it "return the escaped values OR'd together in parentheses" do
+          expect(described_class.or_values(["foo:bar", "spam:eggs"])).to eq("(foo\\:bar OR spam\\:eggs)")
+        end
+      end
+    end
+
+  end
+end

data/spec/jobs/fits_file_characterization_spec.rb

@@ -3,50 +3,14 @@ require 'spec_helper'
 module Ddr::Jobs
   RSpec.describe FitsFileCharacterization, jobs: true, file_characterization: true do
 
-    shared_examples "has a fits update event" do
-      let(:event) { object.update_events.last }
-      it "should have the correct event attributes" do
-        expect(event.outcome).to eq(expected_outcome)
-        expect(event.detail).to eq(expected_detail)
-        expect(event.software).to eq("fits #{fits_version}")
-      end
-    end
+    let(:obj) { double }
 
-    context "content-bearing object" do
-      let(:object) { TestContent.create }
-      let(:stdout_msg) { '<fits />' }
-      let(:stderr_msg) { 'stderr msg' }
-      let(:fits_version) { '0.9.9 '}
-      before { allow(Ddr::Jobs::FitsFileCharacterization).to receive(:fits_version) { fits_version } }
-      context "fits command is successful" do
-        let(:expected_outcome) { Ddr::Events::Event::SUCCESS }
-        let(:expected_detail) { nil }
-        before do
-          allow(Open3).to receive(:capture3) { [ stdout_msg, stderr_msg,  $? ] }
-          allow_any_instance_of(Process::Status).to receive(:success?) { true }
-          Ddr::Jobs::FitsFileCharacterization.perform(object.pid)
-          object.reload
-        end
-        it "should populate the fits datastream" do
-          expect(object.fits.content).to be_present
-        end
-        it_behaves_like "has a fits update event"
-      end
-      context "fits command is not successful" do
-        let(:expected_outcome) { Ddr::Events::Event::FAILURE }
-        let(:expected_detail) { stderr_msg }
-        before do
-          allow(Open3).to receive(:capture3) { [ stdout_msg, stderr_msg,  $? ] }
-          allow_any_instance_of(Process::Status).to receive(:success?) { false }
-          Ddr::Jobs::FitsFileCharacterization.perform(object.pid)
-          object.reload
-        end
-        it "should not populate the fits datastream" do
-          expect(object.fits.content).to_not be_present
-        end
-        it_behaves_like "has a fits update event"
-      end
-    end
+    before { allow(ActiveFedora::Base).to receive(:find).with("test:1") { obj } }
+
+    specify {
+      expect(Ddr::Models::FileCharacterization).to receive(:call).with(obj) { nil }
+      described_class.perform("test:1")
+    }
 
   end
-end
+end