hyrax-ingest 0.1.0

data/lib/hyrax/ingest/has_report.rb

@@ -0,0 +1,17 @@
+require 'hyrax/ingest/reporting/report'
+require 'hyrax/ingest/errors'
+
+module Hyrax
+  module Ingest
+    module HasReport
+      def report
+        @report ||= Hyrax::Ingest::Reporting::Report.new
+      end
+
+      def report=(report)
+        raise Hyrax::Ingest::Errors::InvalidIngestReport unless report.is_a? Hyrax::Ingest::Reporting::Report
+        @report = report
+      end
+    end
+  end
+end

data/lib/hyrax/ingest/has_shared_sip.rb

@@ -0,0 +1,20 @@
+# Simple interface for injecting a Hyrax::Ingest::SIP dependency.
+require 'hyrax/ingest/sip'
+require 'hyrax/ingest/errors'
+
+module Hyrax
+  module Ingest
+    module HasSharedSIP
+      def shared_sip=(shared_sip)
+        unless shared_sip.nil?
+          raise Hyrax::Ingest::Errors::InvalidSIP.new(shared_sip) unless shared_sip.is_a? Hyrax::Ingest::SIP
+        end
+        @shared_sip = shared_sip
+      end
+
+      def shared_sip
+        @shared_sip
+      end
+    end
+  end
+end

data/lib/hyrax/ingest/has_sip.rb

@@ -0,0 +1,20 @@
+# Simple interface for injecting a Hyrax::Ingest::SIP dependency.
+
+require 'hyrax/ingest/sip'
+require 'hyrax/ingest/errors'
+
+module Hyrax
+  module Ingest
+    module HasSIP
+      def sip=(sip)
+        unless sip.nil?
+          raise Hyrax::Ingest::Errors::InvalidSIP.new(sip) unless sip.is_a? Hyrax::Ingest::SIP
+        end
+        @sip = sip
+      end
+
+      # @return [Hyrax::Ingest::SIP] the value of @sip attribute.
+      def sip; @sip; end
+    end
+  end
+end

data/lib/hyrax/ingest/ingester.rb

@@ -0,0 +1,75 @@
+require 'hyrax/ingest/ingester/active_fedora_base_ingester'
+require 'hyrax/ingest/ingester/file_set_ingester'
+require 'hyrax/ingest/ingester/work_ingester'
+require 'hyrax/ingest/ingester/preservation_event_ingester'
+require 'hyrax/ingest/errors'
+
+module Hyrax
+  module Ingest
+    module Ingester
+      class << self
+        # @return [Set] the set of all Ingester classes available by default.
+        def default_registered_classes
+          Set.new.tap do |registered_classes|
+            registered_classes << Hyrax::Ingest::Ingester::ActiveFedoraBaseIngester
+            registered_classes << Hyrax::Ingest::Ingester::FileSetIngester
+            registered_classes << Hyrax::Ingest::Ingester::WorkIngester
+            registered_classes << Hyrax::Ingest::Ingester::PreservationEventIngester
+          end
+        end
+
+        # @return [Set] The set of all registered Ingester classes
+        def registered_classes
+          @registered_classes ||= default_registered_classes
+        end
+
+        # @param [Class] klass The Ingester class to add to the set of available
+        #   Ingester classes.
+        # @raise [Hyrax::Ingest::Errors::InvalidIngesterClass] When the
+        #   parameter given does not inherit from the base Ingester class.
+        # @return [Set] The set of available ingester classes, with the new
+        #   one added.
+        def register_class(klass)
+          raise Hyrax::Ingest::Errors::InvalidIngesterClass.new(klass) unless klass.ancestors.include?(Hyrax::Ingest::Ingester::Base)
+          registered_classes.add(klass)
+        end
+
+        # @param [Class] klass The Ingester class to add to the set of available
+        #   Ingester classes.
+        # @return [Set] The set of available ingester classes, with the specified
+        #   class removed.
+        def unregister_class(klass)
+          registered_classes.delete(klass)
+        end
+
+        # @param [String] ingester_name The stringified name of the class
+        #   constant. The string "Ingester" will be appended if it's not already on there.
+        # @param [Hash] options The hash that will get passed to the
+        #   constructor of the Ingester class.
+        # @return An instance of the Ingester class.
+        def factory(ingester_name, options={})
+          find_class_by_name(ingester_name).new(options)
+        end
+
+        private
+          # @param [String] class_name The stringified class name, with or
+          #   without namespaces.
+          # @raise [Hyrax::Ingest::Errors::UnknownIngesterClass] When there is no
+          #   corresponding Ingester class for the given value of the `class_name`
+          #   param.
+          # @raise [Hyrax::Ingest::Errors::AmbiguousIngesterClass] When the value of
+          #   `class_name` param is insufficient in determining a Ingester class.
+          # @return [Class] The appropriate Ingester class.
+          def find_class_by_name(class_name)
+            class_name.to_s.sub!(/(Ingester)?$/, 'Ingester')
+            found_classes = registered_classes.select do |class_const|
+              (class_const.to_s == class_name) || (class_const.to_s =~ /::#{class_name}/)
+            end
+            raise Hyrax::Ingest::Errors::UnknownIngesterClass.new(class_name, registered_classes) if found_classes.count == 0
+            raise Hyrax::Ingest::Errors::AmbiguousIngesterClass.new(class_name, found_classes) if found_classes.count > 1
+            found_classes.first
+          end
+      end
+    end
+  end
+end

data/lib/hyrax/ingest/ingester/active_fedora_base_ingester.rb

@@ -0,0 +1,136 @@
+require 'hyrax/ingest/ingester/base'
+require 'active_support/inflector'
+require 'active_fedora'
+require 'hyrax/ingest/ingester/active_fedora_property_assigner'
+require 'hyrax/ingest/fetcher'
+require 'hyrax/ingest/transformer'
+
+module Hyrax
+  module Ingest
+    module Ingester
+      class ActiveFedoraBaseIngester < Base
+        include Interloper
+
+        attr_reader :af_model_class_name, :properties_config, :update_params, :shared_sip
+
+        before(:save_model!) { logger.info "Saving #{af_model_class_name}" }
+
+        after(:save_model!) do
+          if af_model.persisted?
+            logger.info "#{af_model_class_name} saved!"
+            report.stat[:models_saved] << af_model
+          else
+            logger.error "Validation Error(s): " + af_model.errors.map {|field, msg| "'#{field}' #{msg}" }.join('; ')
+            report.stat[:models_failed] << af_model
+          end
+        end
+
+        def initialize(config={})
+          raise ArgumentError, "Option :af_model_class_name is required" unless config.key?(:af_model_class_name)
+          @af_model_class_name = config.delete(:af_model_class_name).to_s
+          @properties_config = config.delete(:properties) || []
+          @update_params = config.delete(:update)
+          super(config)
+        end
+
+        def run!
+          assign_properties!
+          save_model!
+        end
+
+        def af_model
+          @af_model ||= new_or_existing_af_model
+        end
+
+        protected
+
+          def save_model!(continue_if_invalid: true)
+            af_model.save!
+            af_model
+          rescue ActiveFedora::RecordInvalid => e
+            raise e unless continue_if_invalid
+            false
+          end
+
+          def assign_properties!
+            property_assigners.each do |property_assigner|
+              property_assigner.assign!
+            end
+          end
+
+        private
+
+          def af_model_class
+            Object.const_get(af_model_class_name.to_s)
+          rescue NameError => e
+            raise Hyrax::Ingest::Errors::UnknownActiveFedoraModel.new(af_model_class_name)
+          end
+
+          def new_or_existing_af_model
+            if where_clause
+              af_model_class.where(where_clause).first.tap do |found_record|
+                raise Hyrax::Ingest::Errors::RecordNotFound.new(af_model_class, where_clause) unless found_record
+              end
+            else
+              af_model_class.new
+            end
+          end
+
+          def where_clause
+            return unless update_params
+            {}.tap do |where_clause|
+              update_params.each do |field, from_params|
+                where_clause[field] = begin
+                  value = create_fetcher_from_config(from_params[:from]).fetch
+                  # Cast to string unless value is an array
+                  value = value.to_s unless value.respond_to? :each
+                  value
+                end
+              end
+            end
+          end
+
+          def property_assigners
+            @property_assigners ||= properties_config.map do |property_config|
+              property_assigner_options = {
+                rdf_predicate: property_config[:rdf_predicate],
+                fetcher: create_fetcher_from_config(property_config[:from]),
+                af_model: af_model
+              }
+
+              if property_config.key?(:transform)
+                transformer_class_name = property_config[:transform].keys.first
+                transformer_class_options = property_config[:transform].values.first
+                property_assigner_options[:transformer] = Hyrax::Ingest::Transformer.factory(transformer_class_name, transformer_class_options)
+              end
+
+              ActiveFedoraPropertyAssigner.new(property_assigner_options)
+            end
+          end
+
+          def create_fetcher_from_config(fetcher_config)
+            fetcher_class_name = fetcher_config.keys.first
+            fetcher_class_options = fetcher_config.values.first
+            Hyrax::Ingest::Fetcher.factory(fetcher_class_name, fetcher_class_options).tap do |fetcher|
+              if fetcher.respond_to?(:sip=)
+                fetcher.sip = if use_shared_sip?(fetcher_config[fetcher_class_name])
+                  raise Hyrax::Ingest::Errors::NoSharedSIPSpecified unless shared_sip
+                  shared_sip
+                else
+                  sip
+                end
+              end
+              fetcher.iteration = iteration if fetcher.respond_to? :iteration=
+              fetcher.logger = logger if fetcher.respond_to? :logger=
+              fetcher.report = report if fetcher.respond_to? :report=
+            end
+          end
+
+          def use_shared_sip?(config)
+            truthy_vals = ['1', 'true', 'TRUE', 'True', 'yes', true]
+            return truthy_vals.include? config[:shared]
+          end
+      end
+    end
+  end
+end

data/lib/hyrax/ingest/ingester/active_fedora_file_ingester.rb

@@ -0,0 +1,17 @@
+module Hyrax
+  module Ingest
+    module Ingester
+      class ActiveFedoraFileIngester
+
+        attr_reader :type, :original_filename, :external_url, :content
+
+        def initialize(type:, original_filename: nil, external_url: nil, content: nil)
+          @type = type
+          @original_filename = original_filename
+          @external_url = external_url
+          @content = content
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/ingest/ingester/active_fedora_property_assigner.rb

@@ -0,0 +1,67 @@
+require 'hyrax/ingest/fetcher/base'
+require 'hyrax/ingest/errors'
+require 'active_fedora'
+require 'hyrax/ingest/has_report'
+require 'hyrax/ingest/has_logger'
+
+module Hyrax
+  module Ingest
+    module Ingester
+      class ActiveFedoraPropertyAssigner
+        include Interloper
+        include HasReport
+        include HasLogger
+
+        after(:assign!) do
+          logger.info "#{@fetched_and_transformed_value} assigned to property '#{property_name}' with rdf predicate '#{rdf_predicate}'"
+        end
+
+        attr_reader :rdf_predicate, :af_model, :fetcher, :transformer
+
+        def initialize(options={})
+          @rdf_predicate = options[:rdf_predicate]
+          @fetcher = options[:fetcher]
+          @af_model = options[:af_model]
+          @transformer = options[:transformer]
+          raise Hyrax::Ingest::Errors::UnknownActiveFedoraModel.new(@af_model.class) unless @af_model.is_a? ActiveFedora::Base
+          raise Hyrax::Ingest::Errors::InvalidFetcher.new(@fetcher.class) unless @fetcher.is_a? Hyrax::Ingest::Fetcher::Base
+        end
+
+        def assign!
+          af_model.set_value(property_name, fetched_and_transformed_value)
+        rescue ::ActiveTriples::Relation::ValueError => e
+          # Rethrow ActiveTriples::Relation::ValueError as something more specific to ingest.
+          raise Hyrax::Ingest::Errors::InvalidActiveFedoraPropertyValue.new(fetched_value, property_name, rdf_predicate)
+        end
+
+        private
+
+          def fetched_and_transformed_value
+            @fetched_and_transformed_value ||= if transformer
+              transformer.transform(fetched_value)
+            else
+              fetched_value
+            end
+          end
+
+          def fetched_value
+            @fetched_value ||= fetcher.fetch
+          end
+
+          # Performs a lookup of property name by RDF predicate.
+          # @return [Symbol] The symbol representing the accessor for the
+          #   property that matches the RDF predicate stored in the
+          #   @rdf_predicate attribtue.
+          def property_name
+            @property ||= begin
+              property = af_model.send(:properties).select do |_att, config|
+                config.predicate == rdf_predicate
+              end
+              raise Hyrax::Ingest::Errors::UnknownRdfPredicate.new(rdf_predicate, af_model.class) if property.keys.count == 0
+              property.keys.first.to_sym
+            end
+          end
+      end
+    end
+  end
+end

data/lib/hyrax/ingest/ingester/base.rb

@@ -0,0 +1,28 @@
+require 'hyrax/ingest/has_sip'
+require 'hyrax/ingest/has_shared_sip'
+require 'hyrax/ingest/has_iteration'
+require 'hyrax/ingest/has_logger'
+require 'hyrax/ingest/has_report'
+require 'hyrax/ingest/has_depositor'
+
+module Hyrax
+  module Ingest
+    module Ingester
+      class Base
+        include HasSIP
+        include HasSharedSIP
+        include HasIteration
+        include HasReport
+        include HasLogger
+        include HasDepositor
+
+        def initialize(config={})
+          self.depositor = config.delete(:depositor)
+        end
+
+        # no-op, meant to be overrriden
+        def run!; end
+      end
+    end
+  end
+end

data/lib/hyrax/ingest/ingester/file_set_ingester.rb

@@ -0,0 +1,68 @@
+require 'hyrax/ingest/ingester/active_fedora_base_ingester'
+require 'hyrax/ingest/ingester/active_fedora_file_ingester'
+
+module Hyrax
+  module Ingest
+    module Ingester
+      class FileSetIngester < ActiveFedoraBaseIngester
+        attr_reader :files_config, :preservation_events_config
+
+        def initialize(config={})
+          @files_config = config.delete(:Files) || []
+          @preservation_events_config = config.delete(:PreservationEvents) || []
+          config[:af_model_class_name] ||= 'FileSet'
+          super(config)
+        end
+
+        def run!
+          assign_properties!
+          apply_depositor_metadata!
+          save_model!
+          ingest_preservation_events!
+          add_files_to_file_set!
+          # return the new instance of the ActiveFedora model
+          af_model
+        end
+
+        private
+
+          def apply_depositor_metadata!
+            af_model.apply_depositor_metadata(depositor) if depositor
+          end
+
+          def add_files_to_file_set!
+            file_ingesters.each do |file_ingester|
+              if (file_ingester.external_url)
+                Hydra::Works::AddExternalFileToFileSet.call(af_model, file_ingester.external_url, file_ingester.type)
+              else
+                Hydra::Works::AddFileToFileSet.call(af_model, file_ingester.content, file_ingester.type)
+              end
+            end
+          end
+
+          def file_ingesters
+            @file_ingesters ||= files_config.map do |file_config|
+              Hyrax::Ingest::Ingester::ActiveFedoraFileIngester.new(file_config)
+            end
+          end
+
+          def ingest_preservation_events!
+            preservation_event_ingesters.each do |preservation_event_ingester|
+              preservation_event_ingester.run!
+            end
+          end
+
+          def preservation_event_ingesters
+            preservation_event_ingesters ||= preservation_events_config.map do |preservation_event_config|
+              preservation_event_config[:premis_event_related_object] = af_model
+              Hyrax::Ingest::Ingester::PreservationEventIngester.new(preservation_event_config).tap do |preservation_event_ingester|
+                preservation_event_ingester.sip = sip if preservation_event_ingester.respond_to?(:sip=)
+                preservation_event_ingester.shared_sip = shared_sip if preservation_event_ingester.respond_to?(:shared_sip=)
+                preservation_event_ingester.iteration = iteration if preservation_event_ingester.respond_to?(:iteration=)
+              end
+            end
+          end
+      end
+    end
+  end
+end