ddr-models 2.6.2 → 2.7.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c395bff66fbd04838113521f876c94f2c50f0d5
-  data.tar.gz: 2fcd6d04f47a3214354dfbded298988490c55ebb
+  metadata.gz: 6bcaaa83b0e74afeba6108c87f4d93f7a6055140
+  data.tar.gz: 274113e1be0b560d0a71bc6f991cb5bae6020161
 SHA512:
-  metadata.gz: 3688a4d98852efab16a625f3d96b2000e97bfba7d0a43dc5f440e62ba4ee7e3ca5e1a68cf9c152e99fdde5960a54374bb56c95f0c4d1c7c1d0cd550f5bd7f49b
-  data.tar.gz: a544cb5f06cad8ee3510052c37d6d60c3a9d5e88e1c49853701644a6d6f7fb5a6986a594dfa2dcfa6adcb88e0617ef9886cc9117480008d5987d5ec7758a09ac
+  metadata.gz: e17be5ca7d910555abeb9946f55776a3b84e8d9fe6c46f34c1498719887d725eefd65fb97014792fdb34fe48cedf45fcd6618a67691edd784747add6d3906921
+  data.tar.gz: 12ad20c8c046d291cea2d022672f5bffcb8bf599c2c31898ee7417fdcc50e622627c945f6478d0b51496768136d409d0e3f4b3907cf7f241b2823931261271b6

data/.ruby-version

@@ -1 +1 @@
-2.1.5
+2.3.1

data/.travis.yml

@@ -5,7 +5,7 @@ before_install:
   - gem install bundler
 bundler_args: --without production
 rvm:
-  - 2.1.5
+  - 2.3.1
 script: "bundle exec rake ci"
 env:
   - DDR_AUX_API_URL=http://localhost:3000/api

data/Gemfile

@@ -1,9 +1,8 @@
 source 'https://rubygems.org'
-ruby '2.1.5'
+ruby '2.3.1'
 
 gemspec
 
 gem "devise"
-gem "rails", "4.1.16"
+gem "rails", "4.2.7"
 gem "blacklight", "5.19.2"
-gem "rubydora", "~> 1.8"

data/app/models/collection.rb

@@ -3,10 +3,9 @@
 #
 class Collection < Ddr::Models::Base
 
-  include Hydra::AdminPolicyBehavior
-
   include Ddr::Models::HasChildren
   include Ddr::Models::HasAttachments
+  include Ddr::Models::HasStructMetadata
 
   has_many :children, property: :is_member_of_collection, class_name: 'Item'
   has_many :targets, property: :is_external_target_for, class_name: 'Target'
@@ -45,7 +44,6 @@ class Collection < Ddr::Models::Base
   end
 
   def grant_roles_to_creator(creator)
-    roles.grant type: Ddr::Auth::Roles::CURATOR, agent: creator.agent, scope: Ddr::Auth::Roles::RESOURCE_SCOPE
     roles.grant type: Ddr::Auth::Roles::CURATOR, agent: creator.agent, scope: Ddr::Auth::Roles::POLICY_SCOPE
   end
 
@@ -55,6 +53,16 @@ class Collection < Ddr::Models::Base
 
   private
 
+  def default_roles
+    super.tap do |roles|
+      if Ddr::Auth.metadata_managers_group
+        roles << { type: Ddr::Auth::Roles::METADATA_EDITOR,
+                   agent: Ddr::Auth.metadata_managers_group,
+                   scope: Ddr::Auth::Roles::POLICY_SCOPE }
+      end
+    end
+  end
+
   def set_admin_policy
     reload
     self.admin_policy = self

data/app/models/component.rb

@@ -6,14 +6,13 @@
 class Component < Ddr::Models::Base
 
   include Ddr::Models::HasContent
+  include Ddr::Models::HasIntermediateFile
   include Ddr::Models::HasMultiresImage
   include Ddr::Models::HasStructMetadata
 
   belongs_to :parent, :property => :is_part_of, :class_name => 'Item'
   belongs_to :target, :property => :has_external_target, :class_name => 'Target'
 
-  after_save :index_parent, if: :has_extracted_text?, unless: "parent.nil?"
-
   alias_method :item, :parent
   alias_method :item=, :parent=
 
@@ -29,8 +28,59 @@ class Component < Ddr::Models::Base
     parent.present? && parent.published?
   end
 
-  def index_parent
-    Resque.enqueue(Ddr::Jobs::UpdateIndex, parent_id)
+  def default_structure
+    build_default_structure if has_content?
+  end
+
+  private
+
+  def build_default_structure
+    document = Ddr::Models::Structure.xml_template
+    structure = Ddr::Models::Structure.new(document)
+    metshdr = structure.add_metshdr
+    structure.add_agent(parent: metshdr, role: Ddr::Models::Structures::Agent::ROLE_CREATOR,
+                        name: Ddr::Models::Structures::Agent::NAME_REPOSITORY_DEFAULT)
+    filesec = structure.add_filesec
+    structmap = structure.add_structmap(type: Ddr::Models::Structure::TYPE_DEFAULT)
+    div = structure.add_div(parent: structmap)
+    filegrp = structure.add_filegrp(parent: filesec)
+    add_original_file(structure, filegrp, div)
+    add_preservation_master_file(structure, filegrp, div)
+    add_intermediate_file(structure, filegrp, div) if has_intermediate_file?
+    add_service_file(structure, filegrp, div)
+    add_thumbnail_image(structure, filegrp, div) if has_thumbnail?
+    structure
+  end
+
+  def add_original_file(structure, filegrp, div)
+    file = structure.add_file(parent: filegrp, use: Ddr::Models::Structure::USE_ORIGINAL_FILE)
+    structure.add_flocat(parent: file, loctype: 'OTHER', otherloctype: 'AttachedFile', href: Ddr::Datastreams::CONTENT)
+    structure.add_fptr(parent: div, fileid: file['ID'])
+  end
+
+  def add_preservation_master_file(structure, filegrp, div)
+    file = structure.add_file(parent: filegrp, use: Ddr::Models::Structure::USE_PRESERVATION_MASTER_FILE)
+    structure.add_flocat(parent: file, loctype: 'OTHER', otherloctype: 'AttachedFile', href: Ddr::Datastreams::CONTENT)
+    structure.add_fptr(parent: div, fileid: file['ID'])
+  end
+
+  def add_intermediate_file(structure, filegrp, div)
+    file = structure.add_file(parent: filegrp, use: Ddr::Models::Structure::USE_INTERMEDIATE_FILE)
+    structure.add_flocat(parent: file, loctype: 'OTHER', otherloctype: 'AttachedFile', href: Ddr::Datastreams::INTERMEDIATE_FILE)
+    structure.add_fptr(parent: div, fileid: file['ID'])
+  end
+
+  def add_service_file(structure, filegrp, div)
+    file = structure.add_file(parent: filegrp, use: Ddr::Models::Structure::USE_SERVICE_FILE)
+    service_file = has_multires_image? ? Ddr::Datastreams::MULTIRES_IMAGE : Ddr::Datastreams::CONTENT
+    structure.add_flocat(parent: file, loctype: 'OTHER', otherloctype: 'AttachedFile', href: service_file)
+    structure.add_fptr(parent: div, fileid: file['ID'])
+  end
+
+  def add_thumbnail_image(structure, filegrp, div)
+    file = structure.add_file(parent: filegrp, use: Ddr::Models::Structure::USE_THUMBNAIL_IMAGE)
+    structure.add_flocat(parent: file, loctype: 'OTHER', otherloctype: 'AttachedFile', href: Ddr::Datastreams::THUMBNAIL)
+    structure.add_fptr(parent: div, fileid: file['ID'])
   end
 
 end

data/app/models/item.rb

@@ -26,8 +26,7 @@ class Item < Ddr::Models::Base
   end
 
   def children_having_extracted_text
-    item = self
-    Ddr::Index::Query.new do
+    Ddr::Index::Query.build(self) do |item|
       is_part_of item
       where attached_files_having_content: "extractedText"
       fields :id, :extracted_text

data/config/initializers/active_fedora_base.rb

@@ -37,11 +37,6 @@ module ActiveFedora
       governable? && admin_policy.present?
     end
 
-    def has_rights_metadata?
-      ds = self.datastreams[Ddr::Datastreams::RIGHTS_METADATA]
-      ds && ds.size && ds.size > 0
-    end
-
     def can_have_struct_metadata?
       datastreams.include? Ddr::Datastreams::STRUCT_METADATA
     end
@@ -50,6 +45,14 @@ module ActiveFedora
       can_have_struct_metadata? && structMetadata.has_content?
     end
 
+    def can_have_intermediate_file?
+      datastreams.include? Ddr::Datastreams::INTERMEDIATE_FILE
+    end
+
+    def has_intermediate_file?
+      can_have_intermediate_file? && datastreams[Ddr::Datastreams::INTERMEDIATE_FILE].has_content?
+    end
+
     def can_have_multires_image?
       datastreams.include? Ddr::Datastreams::MULTIRES_IMAGE
     end

data/config/initializers/rubydora_monkey_patch.rb

@@ -0,0 +1,11 @@
+module Rubydora
+  class Datastream
+    def entity_size(response)
+      if content_length = response["content-length"]
+        content_length.to_i
+      else
+        response.body.length
+      end
+    end
+  end
+end

data/config/initializers/subscriptions.rb

@@ -8,21 +8,28 @@ ActiveSupport::Notifications.subscribe(Ddr::Notifications::FIXITY_CHECK, Ddr::Ev
 # Virus Checks
 ActiveSupport::Notifications.subscribe(Ddr::Notifications::VIRUS_CHECK, Ddr::Events::VirusCheckEvent)
 
-# Creation
+# Ingestion/Creation
 ActiveSupport::Notifications.subscribe(Ddr::Notifications::CREATION, Ddr::Events::CreationEvent)
+ActiveSupport::Notifications.subscribe(Ddr::Models::Base::INGEST, Ddr::Events::IngestionEvent)
+ActiveSupport::Notifications.subscribe(Ddr::Models::Base::INGEST, Ddr::Derivatives::UpdateDerivatives)
 
 # Update
 ActiveSupport::Notifications.subscribe(Ddr::Notifications::UPDATE, Ddr::Events::UpdateEvent)
-ActiveSupport::Notifications.subscribe("assign.permanent_id", Ddr::Events::UpdateEvent)
+ActiveSupport::Notifications.subscribe(Ddr::Models::Base::UPDATE, Ddr::Events::UpdateEvent)
+ActiveSupport::Notifications.subscribe(Ddr::Models::Base::UPDATE, Ddr::Models::PermanentId)
+ActiveSupport::Notifications.subscribe(Ddr::Models::Base::UPDATE, Ddr::Derivatives::UpdateDerivatives)
 
-# Deletion
+# Delete
 ActiveSupport::Notifications.subscribe(Ddr::Notifications::DELETION, Ddr::Events::DeletionEvent)
-ActiveSupport::Notifications.subscribe(/destroy\.\w+/, Ddr::Events::DeletionEvent)
-ActiveSupport::Notifications.subscribe(/destroy\.\w+/, Ddr::Models::PermanentId)
+ActiveSupport::Notifications.subscribe(Ddr::Models::Base::DELETE, Ddr::Models::PermanentId)
+ActiveSupport::Notifications.subscribe(Ddr::Models::Base::DELETE, Ddr::Events::DeletionEvent)
+ActiveSupport::Notifications.subscribe(Ddr::Models::Base::DELETE, Ddr::Datastreams::DeleteExternalFiles)
 
 # Deaccession
-ActiveSupport::Notifications.subscribe(/deaccession\.\w+/, Ddr::Events::DeaccessionEvent)
-ActiveSupport::Notifications.subscribe(/deaccession\.\w+/, Ddr::Models::PermanentId)
+ActiveSupport::Notifications.subscribe(Ddr::Models::Base::DEACCESSION, Ddr::Models::PermanentId)
+ActiveSupport::Notifications.subscribe(Ddr::Models::Base::DEACCESSION, Ddr::Events::DeaccessionEvent)
+ActiveSupport::Notifications.subscribe(Ddr::Models::Base::DEACCESSION, Ddr::Datastreams::DeleteExternalFiles)
 
-# Workflow
-ActiveSupport::Notifications.subscribe(/workflow/, Ddr::Models::PermanentId)
+# Files
+ActiveSupport::Notifications.subscribe(Ddr::Datastreams::DELETE, Ddr::Derivatives::UpdateDerivatives)
+ActiveSupport::Notifications.subscribe(Ddr::Datastreams::DELETE, Ddr::Datastreams::DeleteExternalFiles)

data/config/locales/ddr-models.en.yml

@@ -56,6 +56,9 @@ en:
         techmd_image_width:
           label: "Image Width"
           heading: image_width
+        techmd_md5:
+          label: MD5
+          heading: md5
         techmd_media_type:
           label: "Media Type"
           heading: media_type

data/ddr-models.gemspec

@@ -18,9 +18,10 @@ Gem::Specification.new do |s|
 
   s.require_paths = ["lib", "app/models"]
 
-  s.add_dependency "rails", "~> 4.1"
+  s.add_dependency "rails", ">= 4.2.7", "< 5" # Hydra 7.x not compatible/tested with Rails 5
   s.add_dependency "activeresource"
-  s.add_dependency "active-fedora", "~> 7.0"
+  s.add_dependency "active-fedora", ">= 7.3.1", "< 8"
+  s.add_dependency "rubydora", "~> 2.0"
   s.add_dependency "hydra-core", "~> 7.2"
   s.add_dependency "hydra-validations", "~> 0.5"
   s.add_dependency "devise", "~> 3.4"

data/lib/ddr/actions/virus_check.rb

@@ -1,26 +1,20 @@
-require "ostruct"
-require "shellwords"
-
 module Ddr::Actions
   class VirusCheck
 
     # @return [Hash] result data
     # @raises [Ddr::Antivirus::VirusFoundError]
     def self.call(file_path)
-      unless File.exist?(file_path)
-        raise Error, "File not found: #{file_path}"
-      end
-      result = {}
-      begin
-        scan_result = Ddr::Antivirus.scan(file_path)
-      rescue Ddr::Antivirus::ScannerError => e
-        result[:exception] = [e.class.name, e.to_s]
-        scan_result = e.result
+      Hash.new.tap do |result|
+        begin
+          scan_result = Ddr::Antivirus.scan(file_path)
+        rescue Ddr::Antivirus::ScannerError => e
+          result[:exception] = [e.class.name, e.to_s]
+          scan_result = e.result
+        end
+        result[:event_date_time] = scan_result.scanned_at
+        result[:software]        = scan_result.version
+        result[:detail]          = scan_result.output
       end
-      result[:event_date_time] = scan_result.scanned_at
-      result[:software]        = scan_result.version
-      result[:detail]          = scan_result.output
-      result
     end
 
   end

data/lib/ddr/auth.rb

@@ -46,14 +46,6 @@ module Ddr
       autoload :SuperuserAbilityDefinitions
     end
 
-    autoload_under 'legacy' do
-      autoload :AbstractLegacyPermissions
-      autoload :LegacyAuthorization
-      autoload :LegacyDefaultPermissions
-      autoload :LegacyPermissions
-      autoload :LegacyRoles
-    end
-
     # Name of group whose members are authorized to act as superuser
     mattr_accessor :superuser_group
 

data/lib/ddr/datastreams.rb

@@ -7,16 +7,18 @@ module Ddr
     ADMIN_METADATA = "adminMetadata"
     CONTENT = "content"
     DC = "DC"
-    DEFAULT_RIGHTS = "defaultRights"
     DESC_METADATA = "descMetadata"
     EXTRACTED_TEXT = "extractedText"
     FITS = "fits".freeze
+    INTERMEDIATE_FILE = "intermediateFile".freeze
     MULTIRES_IMAGE = "multiresImage"
     RELS_EXT = "RELS-EXT"
-    RIGHTS_METADATA = "rightsMetadata"
     STRUCT_METADATA = "structMetadata"
     THUMBNAIL = "thumbnail"
 
+    SAVE = "save.repo_file"
+    DELETE = "delete.repo_file"
+
     CHECKSUM_TYPE_MD5 = "MD5"
     CHECKSUM_TYPE_SHA1 = "SHA-1"
     CHECKSUM_TYPE_SHA256 = "SHA-256"
@@ -26,12 +28,21 @@ module Ddr
     CHECKSUM_TYPES = [ CHECKSUM_TYPE_MD5, CHECKSUM_TYPE_SHA1, CHECKSUM_TYPE_SHA256, CHECKSUM_TYPE_SHA384, CHECKSUM_TYPE_SHA512 ]
 
     autoload :AdministrativeMetadataDatastream
+    autoload :ContentDatastream
     autoload :DatastreamBehavior
+    autoload :DeleteExternalFiles
     autoload :DescriptiveMetadataDatastream
+    autoload :ExternalFileDatastream
     autoload :FitsDatastream
+    autoload :IntermediateFileDatastream
     autoload :MetadataDatastream
+    autoload :MultiresImageDatastream
     autoload :PlainTextDatastream
     autoload :StructuralMetadataDatastream
 
+    mattr_accessor :update_derivatives_on_changed do
+      [ CONTENT, INTERMEDIATE_FILE ]
+    end
+
   end
 end

data/lib/ddr/datastreams/administrative_metadata_datastream.rb

@@ -52,6 +52,15 @@ module Ddr
       property :is_locked,
                predicate: Ddr::Vocab::Asset.isLocked
 
+      property :ingested_by,
+               predicate: Ddr::Vocab::Asset.ingestedBy
+
+      property :ingestion_date,
+               predicate: Ddr::Vocab::Asset.ingestionDate
+
+      property :rights_note,
+               predicate: Ddr::Vocab::Asset.rightsNote
+
     end
   end
 end

data/lib/ddr/datastreams/content_datastream.rb

@@ -0,0 +1,5 @@
+module Ddr::Datastreams
+  class ContentDatastream < ExternalFileDatastream
+
+  end
+end

data/lib/ddr/datastreams/datastream_behavior.rb

@@ -1,17 +1,23 @@
 module Ddr
   module Datastreams
     module DatastreamBehavior
+      extend ActiveSupport::Concern
 
       DEFAULT_FILE_EXTENSION = "bin"
 
       STRFTIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%LZ"
 
+      included do
+        around_save :notify_save
+        around_destroy :notify_delete
+      end
+
       def validate_checksum! checksum, checksum_type=nil
         raise Ddr::Models::Error, "Checksum cannot be validated on new datastream." if new?
         raise Ddr::Models::Error, "Checksum cannot be validated on unpersisted content." if content_changed?
         raise Ddr::Models::ChecksumInvalid, "The repository internal checksum validation failed." unless dsChecksumValid
         algorithm = checksum_type || self.checksumType
-        ds_checksum = if algorithm == self.checksumType
+        ds_checksum = if !external? && algorithm == self.checksumType
                         self.checksum
                       else
                         content_digest(algorithm)
@@ -23,6 +29,10 @@ module Ddr
         end
       end
 
+      def version_history
+        versions.map(&:profile)
+      end
+
       def version_uri
         # E.g., info:fedora/duke:1/content/content.0
         ["info:fedora", pid, dsid, dsVersionID].join("/") unless new?
@@ -41,31 +51,35 @@ module Ddr
         Ddr::Utils.digest(self.content, algorithm)
       end
 
-      # Returns a list of the external file paths for all versions of the datastream.
       def file_paths
-        raise "The `file_paths' method is valid only for external datastreams." unless external?
-        return Array(file_path) if new?
-        versions.map(&:file_path).compact
+        if new?
+          return Array(file_path)
+        else
+          versions.map(&:file_path).compact
+        end
       end
 
-      # Returns the external file path for the datastream.
-      # Returns nil if dsLocation is not a file URI.
       def file_path
-        raise "The `file_path' method is valid only for external datastreams." unless external?
-        Ddr::Utils.path_from_uri(dsLocation) if Ddr::Utils.file_uri?(dsLocation)
+        if external? && dsLocation.present? && dsLocation.start_with?("file:")
+          Ddr::Utils.path_from_uri(dsLocation)
+        end
       end
 
-      # Returns the file name of the external file for the datastream.
-      # See #external_datastream_file_path(ds)
       def file_name
-        raise "The `file_name' method is valid only for external datastreams." unless external?
-        File.basename(file_path) rescue nil
+        if path = file_path
+          File.basename(path)
+        end
       end
 
       # Returns the size of the external file for the datastream.
       def file_size
-        raise "The `file_size' method is valid only for external datastreams." unless external?
-        File.size(file_path) rescue nil
+        if external?
+          if path = file_path
+            File.size(path)
+          end
+        else
+          dsSize
+        end
       end
 
       # Return default file extension for datastream based on MIME type
@@ -103,6 +117,37 @@ module Ddr
         end
       end
 
+      private
+
+      def default_notification_payload
+        { pid: pid, file_id: dsid, control_group: controlGroup }
+      end
+
+      def delete_notification_payload
+        default_notification_payload.merge(
+          profile: profile.dup,
+          version_history: version_history
+        )
+      end
+
+      def notify_save
+        ActiveSupport::Notifications.instrument(
+          Ddr::Datastreams::SAVE,
+          default_notification_payload.merge(attributes_changed: changes)
+        ) do |payload|
+          yield
+          payload[:profile] = profile.dup
+        end
+      end
+
+      def notify_delete
+        ActiveSupport::Notifications.instrument(
+          Ddr::Datastreams::DELETE, delete_notification_payload
+        ) do |payload|
+          yield
+        end
+      end
+
     end
   end
 end