hydra-works 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6c159583f12e0a02124bcf92dce3d86fc33736a
-  data.tar.gz: 182817aa5b0783ec5f25ff9491c31c1cb69816f1
+  metadata.gz: b09c8a80126527ae1e46668a611225e85ed64b85
+  data.tar.gz: 863f6a4b6315edbc5825e65d560a24fcb8372910
 SHA512:
-  metadata.gz: f644d698b6e0d8a4260b4b42b45abf73ac69b8bdd85b837570edde1ff2d4e00c9520c0e9f3fc2b631b465a74f1643aeca55224ddf444cf74d3dce77de78e10d8
-  data.tar.gz: 1db7afa2cfdc7635f96f86f2d64664cfac6123ec0dd73714bb6540783af845ecf4ed9484a0fff632d3afa9bb75151e8fc4a6885ddfa4f34cff89ef0ac19ca964
+  metadata.gz: 79734196b519492daf40942ba488aedf9f303483dc3527b9f92ee400d04ef51467d69e65b4c0f4fb6ce23a74a836f3188177faeb5a073fc24ec3b6671de89905
+  data.tar.gz: 2266310f4f914ca326b95f8f57eb294ef2d75f7170c56620e00dbe5eacc3c629be077d785ef114e711e439221a57506a2105a3209dbc9d23e3dd7b1d2534772e

data/.gitignore

@@ -14,4 +14,6 @@ spec/internal
 *.a
 mkmf.log
 jetty
-.DS_Store
+.DS_Store
+.ruby-gemset
+.ruby-version

data/.travis.yml

@@ -6,9 +6,6 @@ env:
   global:
     - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
 rvm:
-  - 2.1
   - 2.2
-  - jruby-19mode
-matrix:
-  allow_failures:
-      - rvm: jruby-19mode
+before_script:
+  - jdk_switcher use oraclejdk8

data/Gemfile

@@ -3,12 +3,10 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in hydra-works.gemspec
 gemspec
 
-gem 'activefedora-aggregation', github: 'projecthydra-labs/activefedora-aggregation'
-gem 'active-fedora', github: 'projecthydra/active_fedora', branch: 'master'
 gem 'slop', '~> 3.6' # For byebug
 
 unless ENV['CI']
   gem 'pry'
   gem 'pry-byebug'
   gem 'byebug'
-end
+end

data/README.md

@@ -36,29 +36,44 @@ class Collection < ActiveFedora::Base
   include Hydra::Works::CollectionBehavior
 end
 
-class BookWork < ActiveFedora::Base
+class Book < ActiveFedora::Base
   include Hydra::Works::GenericWorkBehavior
 end
 
-class BookFiles < ActiveFedora::Base
+class Page < ActiveFedora::Base
   include Hydra::Works::GenericFileBehavior
 end
 
-c1 = Collection.create
-bw1 = BookWork.create
-bf1 = BookFiles.create
+collection = Collection.create
+book = BookWork.create
+page = Page.create
+
+collection.child_generic_works << book
+collection.save
+book.generic_files << page
+book.save
+
+file = page.files.build
+file.content = "The quick brown fox jumped over the lazy dog."
+page.save
+```
+
+## Virus Detection
+
+To turn on virus detection, install clamav on your system and add the `clamav` gem to your Gemfile
 
-Hydra::Works::AddGenericWorkToCollection(c1,bw1)
-Hydra::Works::AddGenericFileToGenericWork(bw1,bf1)
-c1.save
-bw1.save
-bf1.save
+    gem 'clamav'
 
-f1 = bf1.files.build
-f1.content = "The quick brown fox jumped over the lazy dog."
-bf1.save
+Then include the `VirusCheck` module in your `GenericFile` class:
+
+```ruby
+class BookFiles < ActiveFedora::Base
+  include Hydra::Works::GenericFileBehavior
+  include Hydra::Works::GenericFile::VirusCheck
+end
 ```
 
+
 ## Access controls
 
 We are using [Web ACL](http://www.w3.org/wiki/WebAccessControl) as implemented by [hydra-access-controls](https://github.com/projecthydra/hydra-head/tree/master/hydra-access-controls).

data/hydra-works.gemspec

@@ -18,9 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "hydra-pcdm", "~> 0.0.1"
-  spec.add_dependency "hydra-derivatives", "~> 1.1.0"
-  spec.add_dependency "activefedora-aggregation", "~> 0.2.0"
+  spec.add_dependency "hydra-pcdm", "~> 0.1"
+  spec.add_dependency "hydra-derivatives", "~> 2.0"
+  spec.add_dependency "activefedora-aggregation", "~> 0.4"
+  spec.add_dependency "active-fedora", "~> 9.2"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/hydra/works.rb

@@ -2,10 +2,10 @@ require 'hydra/works/version'
 require 'active_fedora/aggregation'
 require 'hydra/pcdm'
 require 'hydra/derivatives'
-require 'hydra/works/processor'
 
 module Hydra
   module Works
+    extend ActiveSupport::Autoload
 
     # vocabularies
     autoload :WorksVocabularies,      'hydra/works/vocab/works_terms'
@@ -14,68 +14,18 @@ module Hydra
     autoload :Collection,             'hydra/works/models/collection'
     autoload :GenericWork,            'hydra/works/models/generic_work'
     autoload :GenericFile,            'hydra/works/models/generic_file'
-    
+
     #behaviors
     autoload :CollectionBehavior,     'hydra/works/models/concerns/collection_behavior'
     autoload :GenericWorkBehavior,    'hydra/works/models/concerns/generic_work_behavior'
     autoload :GenericFileBehavior,    'hydra/works/models/concerns/generic_file_behavior'
-    autoload :AggregatesGenericFiles, 'hydra/works/models/concerns/aggregates_generic_files'
-    autoload :AggregatesGenericWorks, 'hydra/works/models/concerns/aggregates_generic_works'
-    autoload :AggregatesCollections,  'hydra/works/models/concerns/aggregates_collections'
     autoload :GenericFile,            'hydra/works/models/generic_file'
-
-    # collection services
-    autoload :AddCollectionToCollection,           'hydra/works/services/collection/add_collection'
-    autoload :AddGenericWorkToCollection,          'hydra/works/services/collection/add_generic_work'
-    autoload :AddRelatedObjectToCollection,        'hydra/works/services/collection/add_related_object'
-    autoload :GetCollectionsFromCollection,        'hydra/works/services/collection/get_collections'
-    autoload :GetGenericWorksFromCollection,       'hydra/works/services/collection/get_generic_works'
-    autoload :GetRelatedObjectsFromCollection,     'hydra/works/services/collection/get_related_objects'
-    autoload :RemoveCollectionFromCollection,      'hydra/works/services/collection/remove_collection'
-    autoload :RemoveGenericWorkFromCollection,     'hydra/works/services/collection/remove_generic_work'
-    autoload :RemoveRelatedObjectFromCollection,   'hydra/works/services/collection/remove_related_object'
-
-    # generic_work services
-    autoload :AddGenericWorkToGenericWork,         'hydra/works/services/generic_work/add_generic_work'
-    autoload :AddGenericFileToGenericWork,         'hydra/works/services/generic_work/add_generic_file'
-    autoload :AddRelatedObjectToGenericWork,       'hydra/works/services/generic_work/add_related_object'
-    autoload :GetGenericWorksFromGenericWork,      'hydra/works/services/generic_work/get_generic_works'
-    autoload :GetGenericFilesFromGenericWork,      'hydra/works/services/generic_work/get_generic_files'
-    autoload :GetRelatedObjectsFromGenericWork,    'hydra/works/services/generic_work/get_related_objects'
-    autoload :MoveGenericFileToGenericWork,        'hydra/works/services/generic_work/move_generic_file'
-    autoload :RemoveGenericWorkFromGenericWork,    'hydra/works/services/generic_work/remove_generic_work'
-    autoload :RemoveGenericFileFromGenericWork,    'hydra/works/services/generic_work/remove_generic_file'
-    autoload :RemoveRelatedObjectFromGenericWork,  'hydra/works/services/generic_work/remove_related_object'
+    autoload :BlockChildObjects,      'hydra/works/models/concerns/block_child_objects'
 
     # generic_file services
-    autoload :AddGenericFileToGenericFile,         'hydra/works/services/generic_file/add_generic_file'
-    autoload :AddFileToGenericFile,                'hydra/works/services/generic_file/add_file'
-    autoload :AddRelatedObjectToGenericFile,       'hydra/works/services/generic_file/add_related_object'
-    autoload :GetGenericWorksFromGenericFile,      'hydra/works/services/generic_file/get_generic_works'
-    autoload :GetGenericFilesFromGenericFile,      'hydra/works/services/generic_file/get_generic_files'
-    autoload :GetRelatedObjectsFromGenericFile,    'hydra/works/services/generic_file/get_related_objects'
-    autoload :RemoveGenericFileFromGenericFile,    'hydra/works/services/generic_file/remove_generic_file'
-    autoload :RemoveRelatedObjectFromGenericFile,  'hydra/works/services/generic_file/remove_related_object'
-    autoload :UploadFileToGenericFile,             'hydra/works/services/generic_file/upload_file'
-    autoload :AddOriginalFile,                     'hydra/works/services/generic_file/add_original_file'
-    autoload :AddVersionedOriginalFile,            'hydra/works/services/generic_file/add_versioned_original_file'
-    autoload :GenerateThumbnail,                   'hydra/works/services/generic_file/generate/thumbnail'
-
-    # model validations
-    def self.collection? collection
-      return false unless collection.respond_to? :type
-      collection.type.include? WorksVocabularies::WorksTerms.Collection
-    end
-
-    def self.generic_work? generic_work
-      return false unless generic_work.respond_to? :type
-      generic_work.type.include? WorksVocabularies::WorksTerms.GenericWork
-    end
-
-    def self.generic_file? generic_file
-      return false unless generic_file.respond_to? :type
-      generic_file.type.include? WorksVocabularies::WorksTerms.GenericFile
-    end
-
+    autoload :AddFileToGenericFile,    'hydra/works/services/generic_file/add_file_to_generic_file'
+    autoload :GenerateThumbnail,       'hydra/works/services/generic_file/generate/thumbnail'
+    autoload :UploadFileToGenericFile, 'hydra/works/services/generic_file/upload_file'
+    autoload :PersistDerivative,       'hydra/works/services/generic_file/persist_derivative'
   end
 end

data/lib/hydra/works/models/concerns/block_child_objects.rb

@@ -0,0 +1,16 @@
+module Hydra::Works
+  # Do not allow aggregation of child objects
+  module BlockChildObjects
+
+    def child_objects= objects
+      raise StandardError, "method `child_objects=' not allowed for #{self}"
+    end
+
+    def child_objects
+      raise StandardError, "method `child_objects' not allowed for #{self}"
+    end
+
+  end
+end
+
+

data/lib/hydra/works/models/concerns/collection_behavior.rb

@@ -20,8 +20,33 @@ module Hydra::Works
 
     included do
       type [RDFVocabularies::PCDMTerms.Collection,WorksVocabularies::WorksTerms.Collection]
-      include Hydra::Works::AggregatesGenericWorks
-      include Hydra::Works::AggregatesCollections
+      include Hydra::Works::BlockChildObjects
+
+      filters_association :members, as: :child_collections, condition: :works_collection?
+      filters_association :members, as: :child_generic_works, condition: :works_generic_work?
+    end
+
+    # @return [Boolean] whether this instance is a Hydra::Works Collection.
+    def works_collection?
+      true
+    end
+
+    # @return [Boolean] whether this instance is a Hydra::Works Generic Work.
+    def works_generic_work?
+      false
+    end
+
+    # @return [Boolean] whether this instance is a Hydra::Works Generic File.
+    def works_generic_file?
+      false
+    end
+
+    def parents
+      aggregated_by
+    end
+
+    def parent_collections
+      aggregated_by.select { |parent| parent.class.included_modules.include?(Hydra::Works::CollectionBehavior) }
     end
 
   end

data/lib/hydra/works/models/concerns/generic_file/contained_files.rb

@@ -2,21 +2,13 @@ module Hydra::Works::GenericFile::ContainedFiles
   extend ActiveSupport::Concern
 
   # HydraWorks supports only one each of original_file, thumbnail, and extracted_text. However
-  # you are free to add an unlimited number of addtition types such as different resolutions
+  # you are free to add an unlimited number of additional types such as different resolutions
   # of images, different derivatives, etc, and use any established vocabulary you choose.
 
   # TODO: se PCDM vocab class when projecthydra-labs/hydra-pcdm#80 is merged
-  
-  def original_file
-    file_of_type(::RDF::URI("http://pcdm.org/OriginalFile"))
+  included do
+    directly_contains_one :original_file, through: :files, type: ::RDF::URI("http://pcdm.org/use#OriginalFile"), class_name: "Hydra::PCDM::File"
+    directly_contains_one :thumbnail, through: :files, type: ::RDF::URI("http://pcdm.org/use#ThumbnailImage"), class_name: "Hydra::PCDM::File"
+    directly_contains_one :extracted_text, through: :files, type: ::RDF::URI("http://pcdm.org/use#ExtractedText"), class_name: "Hydra::PCDM::File"
   end
-
-  def thumbnail
-    file_of_type(::RDF::URI("http://pcdm.org/ThumbnailImage"))
-  end
-
-  def extracted_text
-    file_of_type(::RDF::URI("http://pcdm.org/ExtractedText"))
-  end
-
 end

data/lib/hydra/works/models/concerns/generic_file/derivatives.rb

@@ -5,28 +5,24 @@ module Hydra::Works::GenericFile
     included do
       include Hydra::Derivatives
 
+      # Sets output_file_service to PersistDerivative instead of default Hydra::Derivatives::PersistBasicContainedOutputFileService
+      Hydra::Derivatives.output_file_service = Hydra::Works::PersistDerivative
+
       # This was taken directly from Sufia's GenericFile::Derivatives and modified to exclude any processing that modified the original file
       makes_derivatives do |obj|
-        case obj.mime_type
+        case obj.original_file.mime_type
         when *pdf_mime_types
-          obj.transform_file :original_file, { thumbnail: { format: 'jpg', size: '338x493', datastream: 'thumbnail' } }, processor: :work
+          obj.transform_file :original_file, thumbnail: { format: 'jpg', size: '338x493' }
         when *office_document_mime_types
-          obj.transform_file :original_file, { thumbnail: { format: 'jpg', size: '200x150>', datastream: 'thumbnail' } }, processor: :document
+          obj.transform_file :original_file, { thumbnail: { format: 'jpg', size: '200x150>' } }, processor: :document
         when *video_mime_types
-          obj.transform_file :original_file, { thumbnail: { format: 'jpg', datastream: 'thumbnail' } }, processor: :video
+          obj.transform_file :original_file, { thumbnail: { format: 'jpg' } }, processor: :video
         when *image_mime_types
-          obj.transform_file :original_file, { thumbnail: { format: 'jpg', size: '200x150>', datastream: 'thumbnail' } }, processor: :work
+          obj.transform_file :original_file, thumbnail: { format: 'jpg', size: '200x150>' }
         end
       end
 
     end
 
-    # This bit was not in Sufia, but needs to be here for derivatives to work
-    # TODO: delegate mime type somewhere else?
-    def mime_type
-      return nil unless self.original_file
-      self.original_file.mime_type
-    end
-
   end
-end
+end

data/lib/hydra/works/models/concerns/generic_file/mime_types.rb

@@ -4,23 +4,23 @@ module Hydra::Works::GenericFile
     extend ActiveSupport::Concern
 
     def pdf?
-      self.class.pdf_mime_types.include? self.mime_type
+      self.class.pdf_mime_types.include? mime_type
     end
 
     def image?
-      self.class.image_mime_types.include? self.mime_type
+      self.class.image_mime_types.include? mime_type
     end
 
     def video?
-      self.class.video_mime_types.include? self.mime_type
+      self.class.video_mime_types.include? mime_type
     end
 
     def audio?
-      self.class.audio_mime_types.include? self.mime_type
+      self.class.audio_mime_types.include? mime_type
     end
 
     def office_document?
-      self.class.office_document_mime_types.include? self.mime_type
+      self.class.office_document_mime_types.include? mime_type
     end
 
     # TODO: remove?
@@ -29,10 +29,15 @@ module Hydra::Works::GenericFile
     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
+      if mime_type.present? && format_label.present?
+        "#{mime_type.split('/').last} (#{format_label.join(", ")})"
+      elsif mime_type.present?
+        mime_type.split('/').last
+      elsif format_label.present?
+        format_label
+      else
+        nil
+      end
     end
 
     module ClassMethods

data/lib/hydra/works/models/concerns/generic_file/versioned_content.rb

@@ -0,0 +1,18 @@
+module Hydra::Works::GenericFile
+  # Allows a GenericFile to treat the version history of the original_file as the GenericFile's version history
+  module VersionedContent
+
+    def content_versions
+      self.original_file.versions.all
+    end
+
+    def latest_content_version
+      self.original_file.versions.last
+    end
+
+    def current_content_version_uri
+      self.original_file.versions.last.uri
+    end
+
+  end
+end

data/lib/hydra/works/models/concerns/generic_file/virus_check.rb

@@ -0,0 +1,48 @@
+module Hydra::Works::GenericFile
+  module VirusCheck
+    extend ActiveSupport::Concern
+    
+    included do
+      validate :detect_viruses
+    end
+
+    # Default behavior is to raise a validation error and halt the save if a virus is found
+    def detect_viruses
+      return unless original_file && original_file.new_record?
+
+      path = original_file.is_a?(String) ? original_file : local_path_for_file(original_file)
+      unless defined?(ClamAV)
+        warn "Virus checking disabled, #{path} not checked"
+        return
+      end
+
+      scan_result = ClamAV.instance.scanfile(path)
+      if scan_result == 0
+        true
+      else
+        virus_message = "A virus was found in #{path}: #{scan_result}"
+        warn(virus_message)
+        errors.add(:base, virus_message)
+        false
+      end
+    end
+
+    private
+
+    # Returns a path for reading the content of +file+
+    # @param [File] file object to retrieve a path for
+    def local_path_for_file(file)
+      if file.respond_to?(:path)
+        file.path
+      else
+        Tempfile.open('') do |t|
+          t.binmode
+          t.write(file)
+          t.close
+          t.path
+        end
+      end
+    end
+
+  end
+end

data/lib/hydra/works/models/concerns/generic_file_behavior.rb

@@ -15,11 +15,34 @@ module Hydra::Works
     included do
       type [RDFVocabularies::PCDMTerms.Object,WorksVocabularies::WorksTerms.GenericFile]
 
-      include Hydra::Works::AggregatesGenericFiles
       include Hydra::Works::GenericFile::ContainedFiles
       include Hydra::Works::GenericFile::Derivatives
       include Hydra::Works::GenericFile::MimeTypes
+      include Hydra::Works::GenericFile::VersionedContent
+      include Hydra::Works::BlockChildObjects
     end
 
+    # @return [Boolean] whether this instance is a Hydra::Works Collection.
+    def works_collection?
+      false
+    end
+
+    # @return [Boolean] whether this instance is a Hydra::Works Generic Work.
+    def works_generic_work?
+      false
+    end
+
+    # @return [Boolean] whether this instance is a Hydra::Works Generic File.
+    def works_generic_file?
+      true
+    end
+
+    def parents
+      aggregated_by
+    end
+
+    def generic_works
+      aggregated_by.select { |parent| parent.class.included_modules.include?(Hydra::Works::GenericWorkBehavior) }
+    end
   end
 end