hydra-works 0.0.1 → 0.1.0

data/lib/hydra/works/services/collection/remove_generic_work.rb

@@ -1,20 +0,0 @@
-module Hydra::Works
-  class RemoveGenericWorkFromCollection
-
-    ##
-    # Remove a generic_work from a collection.
-    #
-    # @param [Hydra::Works::Collection] :parent_collection from which to remove generic_work
-    # @param [Hydra::Works::GenericWork::Base] :child_generic_work being removed
-    # @param [Fixnum] :nth_occurrence remove nth occurrence of this generic_work in the list (default=1)
-    #
-    # @return [Hydra::Works::Collection] the updated hydra works collection
-
-    def self.call( parent_collection, child_generic_work, nth_occurrence=1 )
-      raise ArgumentError, 'parent_collection must be a hydra-works collection' unless Hydra::Works.collection? parent_collection
-      raise ArgumentError, 'child_generic_work must be a hydra-works generic work' unless Hydra::Works.generic_work? child_generic_work
-      Hydra::PCDM::RemoveObjectFromCollection.call( parent_collection, child_generic_work, nth_occurrence )
-    end
-
-  end
-end

data/lib/hydra/works/services/collection/remove_related_object.rb

@@ -1,19 +0,0 @@
-module Hydra::Works
-  class RemoveRelatedObjectFromCollection
-
-    ##
-    # Remove a related object from a collection.
-    #
-    # @param [Hydra::Works::Collection] :parent_collection from which to remove the related object
-    # @param [Hydra::PCDM::Object] :child_related_object being removed
-    #
-    # @return [Hydra::Works::Collection] the updated hydra works collection
-
-    def self.call( parent_collection, child_related_object )
-      raise ArgumentError, 'parent_collection must be a hydra-works collection' unless Hydra::Works.collection? parent_collection
-      raise ArgumentError, 'child_related_object must be a pcdm object' unless Hydra::PCDM.object? child_related_object
-      Hydra::PCDM::RemoveRelatedObjectFromCollection.call( parent_collection, child_related_object )
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_file/add_file.rb

@@ -1,55 +0,0 @@
-module Hydra::Works
-  class AddFileToGenericFile
-
-    # Adds the original file to the work
-
-    def self.call(object, path, type, replace=false)
-      raise ArgumentError, "supplied object must be a generic file" unless Hydra::Works.generic_file?(object)
-      raise ArgumentError, "supplied path must be a string" unless path.is_a?(String)
-      raise ArgumentError, "supplied path to file does not exist" unless ::File.exists?(path)
-
-      if replace
-        current_file = object.filter_files_by_type(self.type_to_uri(type)).first
-      else
-        object.files.build
-        current_file = object.files.last
-      end
-
-      current_file.content = ::File.open(path)
-      current_file.original_name = ::File.basename(path)
-      current_file.mime_type = Hydra::PCDM::GetMimeTypeForFile.call(path)
-      Hydra::PCDM::AddTypeToFile.call(current_file, self.type_to_uri(type))
-      current_file.save if replace
-      object.save
-      object
-    end
-
-    private
-
-    # Returns appropriate URI for the requested type
-    #  * Converts supported symbols to corresponding URIs
-    #  * Converts URI strings to RDF::URI
-    #  * Returns RDF::URI objects as-is
-    def self.type_to_uri(type)
-      if type.instance_of?(::RDF::URI)
-        return type
-      elsif type.instance_of?(Symbol)
-        case type
-          when :original_file
-            return ::RDF::URI("http://pcdm.org/OriginalFile")
-          when :thumbnail
-            return ::RDF::URI("http://pcdm.org/ThumbnailImage")
-          when :extracted_text
-            return ::RDF::URI("http://pcdm.org/ExtractedText")
-          else
-            raise ArgumentError, "Invalid file type. The only valid symbols for file types are :original_file, :thumbnail, and :extracted_text.  You submitted #{type}.  To avoid this error, use one of those symbols or submit a URI instead of a symbol."
-        end
-      elsif type.instance_of?(String)
-        return ::RDF::URI(type)
-      else
-        raise ArgumentError, "Invalid file type.  You must submit a URI or a symbol."
-      end
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_file/add_generic_file.rb

@@ -1,19 +0,0 @@
-module Hydra::Works
-  class AddGenericFileToGenericFile
-
-    ##
-    # Add a generic_file to a generic_file.
-    #
-    # @param [Hydra::Works::GenericFile::Base] :parent_generic_file to which to add generic_file
-    # @param [Hydra::Works::GenericFile::Base] :child_generic_file being added
-    #
-    # @return [Hydra::Works::GenericFile::Base] the updated hydra works generic file
-
-    def self.call( parent_generic_file, child_generic_file )
-      raise ArgumentError, 'parent_generic_file must be a hydra-works generic file' unless Hydra::Works.generic_file? parent_generic_file
-      raise ArgumentError, 'child_generic_file must be a hydra-works generic file' unless Hydra::Works.generic_file? child_generic_file
-      Hydra::PCDM::AddObjectToObject.call( parent_generic_file, child_generic_file )
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_file/add_original_file.rb

@@ -1,11 +0,0 @@
-module Hydra::Works
-  class AddOriginalFile
-
-    # Adds the original file to the work
-
-    def self.call(object, path, replace=false)
-      Hydra::Works::AddFileToGenericFile.call(object, path, ::RDF::URI("http://pcdm.org/OriginalFile"), replace)
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_file/add_related_object.rb

@@ -1,19 +0,0 @@
-module Hydra::Works
-  class AddRelatedObjectToGenericFile
-
-    ##
-    # Add a related object to a generic file.
-    #
-    # @param [Hydra::Works::GenericFile::Base] :parent_generic_file to which to add the related object
-    # @param [Hydra::PCDM::Object] :child_related_object being added
-    #
-    # @return [Hydra::Works::GenericFile::Base] the updated hydra works generic file
-
-    def self.call( parent_generic_file, child_related_object )
-      raise ArgumentError, 'parent_generic_file must be a hydra-works generic file' unless Hydra::Works.generic_file? parent_generic_file
-      raise ArgumentError, 'child_related_object must be a pcdm object' unless Hydra::PCDM.object? child_related_object
-      Hydra::PCDM::AddRelatedObjectToObject.call( parent_generic_file, child_related_object )
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_file/add_versioned_original_file.rb

@@ -1,10 +0,0 @@
-module Hydra::Works
-  class AddVersionedOriginalFile
-
-    # TODO: Create a new version of the original file instead of replacing it
-    def self.call(object, file)
-
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_file/get_generic_files.rb

@@ -1,17 +0,0 @@
-module Hydra::Works
-  class GetGenericFilesFromGenericFile
-
-    ##
-    # Get member generic files from a generic file in order.
-    #
-    # @param [Hydra::Works::GenericFile::Base] :parent_generic_file in which the child generic files are members
-    #
-    # @return [Array<Hydra::Works::GenericFile::Base>] all member generic files
-
-    def self.call( parent_generic_file )
-      raise ArgumentError, 'parent_generic_file must be a hydra-works generic file' unless Hydra::Works.generic_file? parent_generic_file
-      parent_generic_file.generic_files
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_file/get_related_objects.rb

@@ -1,17 +0,0 @@
-module Hydra::Works
-  class GetRelatedObjectsFromGenericFile
-
-    ##
-    # Get related objects from a generic_file.
-    #
-    # @param [Hydra::Works::GenericFile::Base] :parent_generic_file to which the child objects are related
-    #
-    # @return [Array<Hydra::Works::GenericFile::Base>] all related objects
-
-    def self.call( parent_generic_file )
-      raise ArgumentError, 'parent_generic_file must be a hydra-works generic file' unless Hydra::Works.generic_file? parent_generic_file
-      Hydra::PCDM::GetRelatedObjectsFromObject.call( parent_generic_file )
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_file/remove_generic_file.rb

@@ -1,20 +0,0 @@
-module Hydra::Works
-  class RemoveGenericFileFromGenericFile
-
-    ##
-    # Remove a generic_file from a generic_file.
-    #
-    # @param [Hydra::Works::GenericFile::Base] :parent_generic_file from which to remove generic_file
-    # @param [Hydra::Works::GenericFile::Base] :child_generic_file being removed
-    # @param [Fixnum] :nth_occurrence remove nth occurrence of this generic_file in the list (default=1)
-    #
-    # @return [Hydra::Works::GenericFile::Base] the updated hydra works generic file
-
-    def self.call( parent_generic_file, child_generic_file, nth_occurrence=1 )
-      raise ArgumentError, 'parent_generic_file must be a hydra-works generic file' unless Hydra::Works.generic_file? parent_generic_file
-      raise ArgumentError, 'child_generic_file must be a hydra-works generic file' unless Hydra::Works.generic_file? child_generic_file
-      Hydra::PCDM::RemoveObjectFromObject.call( parent_generic_file, child_generic_file, nth_occurrence )
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_file/remove_related_object.rb

@@ -1,19 +0,0 @@
-module Hydra::Works
-  class RemoveRelatedObjectFromGenericFile
-
-    ##
-    # Remove an object from a generic file.
-    #
-    # @param [Hydra::Works::GenericFile::Base] :parent_generic_file from which to remove the related object
-    # @param [Hydra::PCDM::Object] :child_related_object being removed
-    #
-    # @return [Hydra::Works::GenericFile::Base] the updated hydra works generic file
-
-    def self.call( parent_generic_file, child_related_object )
-      raise ArgumentError, 'parent_generic_file must be a hydra-works generic file' unless Hydra::Works.generic_file? parent_generic_file
-      raise ArgumentError, 'child_related_object must be a pcdm object' unless Hydra::PCDM.object? child_related_object
-      Hydra::PCDM::RemoveRelatedObjectFromObject.call( parent_generic_file, child_related_object )
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_work/add_generic_file.rb

@@ -1,19 +0,0 @@
-module Hydra::Works
-  class AddGenericFileToGenericWork
-
-    ##
-    # Add a generic_file to a generic_work.
-    #
-    # @param [Hydra::Works::GenericWork::Base] :parent_generic_work to which to add generic_work
-    # @param [Hydra::Works::GenericFile::Base] :child_generic_file being added
-    #
-    # @return [Hydra::Works::GenericWork::Base] the updated hydra works generic work
-
-    def self.call( parent_generic_work, child_generic_file )
-      raise ArgumentError, 'parent_generic_work must be a hydra-works generic work' unless Hydra::Works.generic_work? parent_generic_work
-      raise ArgumentError, 'child_generic_file must be a hydra-works generic file' unless Hydra::Works.generic_file? child_generic_file
-      Hydra::PCDM::AddObjectToObject.call( parent_generic_work, child_generic_file )
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_work/add_generic_work.rb

@@ -1,19 +0,0 @@
-module Hydra::Works
-  class AddGenericWorkToGenericWork
-
-    ##
-    # Add a generic_work to a generic_work.
-    #
-    # @param [Hydra::Works::GenericWork::Base] :parent_generic_work to which to add generic_work
-    # @param [Hydra::Works::GenericWork::Base] :child_generic_work being added
-    #
-    # @return [Hydra::Works::GenericWork::Base] the updated hydra works generic work
-
-    def self.call( parent_generic_work, child_generic_work )
-      raise ArgumentError, 'parent_generic_work must be a hydra-works generic work' unless Hydra::Works.generic_work? parent_generic_work
-      raise ArgumentError, 'child_generic_work must be a hydra-works generic work' unless Hydra::Works.generic_work? child_generic_work
-      Hydra::PCDM::AddObjectToObject.call( parent_generic_work, child_generic_work )
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_work/add_related_object.rb

@@ -1,19 +0,0 @@
-module Hydra::Works
-  class AddRelatedObjectToGenericWork
-
-    ##
-    # Add a related object to a generic work.
-    #
-    # @param [Hydra::Works::GenericWork::Base] :parent_generic_work to which to add the related object
-    # @param [Hydra::PCDM::Object] :child_related_object being added
-    #
-    # @return [Hydra::Works::GenericWork::Base] the updated hydra works generic work
-
-    def self.call( parent_generic_work, child_related_object )
-      raise ArgumentError, 'parent_generic_work must be a hydra-works generic work' unless Hydra::Works.generic_work? parent_generic_work
-      raise ArgumentError, 'child_related_object must be a pcdm object' unless Hydra::PCDM.object? child_related_object
-      Hydra::PCDM::AddRelatedObjectToObject.call( parent_generic_work, child_related_object )
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_work/get_generic_files.rb

@@ -1,17 +0,0 @@
-module Hydra::Works
-  class GetGenericFilesFromGenericWork
-
-    ##
-    # Get member generic files from a generic work in order.
-    #
-    # @param [Hydra::Works::GenericWork::Base] :parent_generic_work in which the child generic files are members
-    #
-    # @return [Array<Hydra::Works::GenericFile::Base>] all member generic files
-
-    def self.call( parent_generic_work )
-      raise ArgumentError, 'parent_generic_work must be a hydra-works generic work' unless Hydra::Works.generic_work? parent_generic_work
-      parent_generic_work.generic_files
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_work/get_generic_works.rb

@@ -1,17 +0,0 @@
-module Hydra::Works
-  class GetGenericWorksFromGenericWork
-
-    ##
-    # Get member generic works from a generic work in order.
-    #
-    # @param [Hydra::Works::GenericWork::Base] :parent_generic_work in which the child generic works are members
-    #
-    # @return [Array<Hydra::Works::GenericWork::Base>] all member generic works
-
-    def self.call( parent_generic_work )
-      raise ArgumentError, 'parent_generic_work must be a hydra-works generic work' unless Hydra::Works.generic_work? parent_generic_work
-      parent_generic_work.generic_works
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_work/get_related_objects.rb

@@ -1,17 +0,0 @@
-module Hydra::Works
-  class GetRelatedObjectsFromGenericWork
-
-    ##
-    # Get related objects from a generic_work.
-    #
-    # @param [Hydra::Works::GenericWork::Base] :parent_generic_work to which the child objects are related
-    #
-    # @return [Array<Hydra::Works::GenericWork::Base>] all related objects
-
-    def self.call( parent_generic_work )
-      raise ArgumentError, 'parent_generic_work must be a hydra-works generic work' unless Hydra::Works.generic_work? parent_generic_work
-      Hydra::PCDM::GetRelatedObjectsFromObject.call( parent_generic_work )
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_work/move_generic_file.rb

@@ -1,19 +0,0 @@
-module Hydra::Works
-  class MoveGenericFileToGenericWork
-
-    ##
-    # Move a generic file from one generic work to another
-    #
-    # @param [Hydra::Works::GenericWork] :old_parent_work where the generic file currently lives
-    # @param [Hydra::Works::GenericWork] :new_parent_work where the generic file is being moved
-    # @param [Hydra::Works::GenericFile] :child_generic_file being moved
-    #
-    # @return [Hydra::Works::GenericWork] the destination generic work
-    def self.call(old_parent_work, new_parent_work, child_generic_file)
-      AddGenericFileToGenericWork.call(new_parent_work, child_generic_file)
-      RemoveGenericFileFromGenericWork.call(old_parent_work, child_generic_file)
-      new_parent_work
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_work/remove_generic_file.rb

@@ -1,20 +0,0 @@
-module Hydra::Works
-  class RemoveGenericFileFromGenericWork
-
-    ##
-    # Remove a generic_file from a generic_work.
-    #
-    # @param [Hydra::Works::GenericWork::Base] :parent_generic_work from which to remove generic_work
-    # @param [Hydra::Works::GenericFile::Base] :child_generic_file being removed
-    # @param [Fixnum] :nth_occurrence remove nth occurrence of this generic_work in the list (default=1)
-    #
-    # @return [Hydra::Works::GenericWork::Base] the updated hydra works generic work
-
-    def self.call( parent_generic_work, child_generic_file, nth_occurrence=1 )
-      raise ArgumentError, 'parent_generic_work must be a hydra-works generic work' unless Hydra::Works.generic_work? parent_generic_work
-      raise ArgumentError, 'child_generic_file must be a hydra-works generic file' unless Hydra::Works.generic_file? child_generic_file
-      Hydra::PCDM::RemoveObjectFromObject.call( parent_generic_work, child_generic_file, nth_occurrence )
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_work/remove_generic_work.rb

@@ -1,20 +0,0 @@
-module Hydra::Works
-  class RemoveGenericWorkFromGenericWork
-
-    ##
-    # Remove a generic_work from a generic_work.
-    #
-    # @param [Hydra::Works::GenericWork::Base] :parent_generic_work from which to remove generic_work
-    # @param [Hydra::Works::GenericWork::Base] :child_generic_work being removed
-    # @param [Fixnum] :nth_occurrence remove nth occurrence of this generic_work in the list (default=1)
-    #
-    # @return [Hydra::Works::GenericWork::Base] the updated hydra works generic work
-
-    def self.call( parent_generic_work, child_generic_work, nth_occurrence=1 )
-      raise ArgumentError, 'parent_generic_work must be a hydra-works generic work' unless Hydra::Works.generic_work? parent_generic_work
-      raise ArgumentError, 'child_generic_work must be a hydra-works generic work' unless Hydra::Works.generic_work? child_generic_work
-      Hydra::PCDM::RemoveObjectFromObject.call( parent_generic_work, child_generic_work, nth_occurrence )
-    end
-
-  end
-end

data/lib/hydra/works/services/generic_work/remove_related_object.rb

@@ -1,19 +0,0 @@
-module Hydra::Works
-  class RemoveRelatedObjectFromGenericWork
-
-    ##
-    # Remove an object from a generic work.
-    #
-    # @param [Hydra::Works::GenericWork::Base] :parent_generic_work from which to remove the related object
-    # @param [Hydra::PCDM::Object] :child_related_object being removed
-    #
-    # @return [Hydra::Works::GenericWork::Base] the updated hydra works generic work
-
-    def self.call( parent_generic_work, child_related_object )
-      raise ArgumentError, 'parent_generic_work must be a hydra-works generic work' unless Hydra::Works.generic_work? parent_generic_work
-      raise ArgumentError, 'child_related_object must be a pcdm object' unless Hydra::PCDM.object? child_related_object
-      Hydra::PCDM::RemoveRelatedObjectFromObject.call( parent_generic_work, child_related_object )
-    end
-
-  end
-end