ddr-models 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa0d6d02e9d75d08088ce93d1c11dc5b1456a069
-  data.tar.gz: 2d42ecd5e033747bee3cfee78ba52e4afc9d3857
+  metadata.gz: 4b7c6859f35b96af9cad8b5b91ed7b10e977b661
+  data.tar.gz: 75abf6c0b0abf5744fa84b2340bb0bf22cc39879
 SHA512:
-  metadata.gz: ec48a38252f3deafadce7a27fea0616464f7fe5308a0ec21a86a7990cef1b418a5f364f6958776a63d7e1f86e86b9e81317d51574293da7a42c18f3b17d01fb3
-  data.tar.gz: 6345df75af88af8010e7ea961c75845c745fc375978926c3c7598d1d64099cf9513eb42237db616aa6f9c96e4c04e158c47585bc89c7b32cb58dca853e802a2d
+  metadata.gz: e53213dd9dd3d14e582ce2558b7e4efb0c66656de2f4a6232aa0c91bedbb12212eecad26982f32bfdd2b0218b15a5f6f002e92c92fdbb9887631a6cbb4871c48
+  data.tar.gz: eb9a5b39e08e90d70321ade9812d2f69440d4b4fa1f5cbd73e2450ca22f34f68edd6d23cbbdd50c46beb3681e026e8469f04c9a16abf9bee2a2f3ef75a93fbd5

data/README.md

@@ -25,6 +25,7 @@ ddr-models has several runtime dependencies that are independently configurable:
 - [hydra-head](https://github.com/projecthydra/hydra-head)
 - [ddr-antivirus](https://github.com/duke-libraries/ddr-antivirus)
 - [devise-remote-user](https://github.com/duke-libraries/devise-remote-user)
+- [ezid-client](https://github.com/duke-libaries/ezid-client)
 
 ddr-models configuration options:
 

data/db/migrate/20141216040225_drop_minted_ids.rb

@@ -0,0 +1,9 @@
+class DropMintedIds < ActiveRecord::Migration
+  def up
+    drop_table :minted_ids
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/db/migrate/20141218020612_add_exception_to_events.rb

@@ -0,0 +1,7 @@
+class AddExceptionToEvents < ActiveRecord::Migration
+  def change
+    change_table :events do |t|
+      t.string :exception
+    end
+  end
+end

data/lib/ddr/datastreams.rb

@@ -24,6 +24,7 @@ module Ddr
 
     autoload :ContentMetadataDatastream
     autoload :DescriptiveMetadataDatastream
+    autoload :PreservationMetadataDatastream
     autoload :PropertiesDatastream
     autoload :DatastreamBehavior
     autoload :RoleAssignmentsDatastream

data/lib/ddr/datastreams/preservation_metadata_datastream.rb

@@ -0,0 +1,13 @@
+module Ddr
+  module Datastreams
+    class PreservationMetadataDatastream < ActiveFedora::NtriplesRDFDatastream
+
+      property :permanent_id, 
+      predicate: Ddr::Vocab::Preservation.permanentId
+
+      property :permanent_url, 
+      predicate: Ddr::Vocab::Preservation.permanentUrl
+
+    end
+  end
+end

data/lib/ddr/events/event.rb

@@ -4,6 +4,11 @@ module Ddr
 
       belongs_to :user, inverse_of: :events
 
+      # ActiveSupport::Notifications::Instrumenter sets payload[:exception]
+      #   to an array of [<exception class name>, <exception message>]
+      #   and we want to store this data in a string field.
+      serialize :exception, JSON
+
       # Event date time - for PREMIS and Solr
       DATE_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%LZ"
 
@@ -32,6 +37,7 @@ module Ddr
       validate :object_exists # unless/until we have a deaccession-type of event
  
       after_initialize :set_defaults
+      before_save { failure! if exception.present? }
 
       # Receive message sent by ActiveSupport::Notifications
       def self.call(*args)

data/lib/ddr/index_fields.rb

@@ -32,6 +32,7 @@ module Ddr
     OBJECT_MODIFIED_DATE      = solr_name :system_modified, :stored_sortable, type: :date
     ORIGINAL_FILENAME         = solr_name :original_filename, :symbol
     PERMANENT_ID              = solr_name :permanent_id, :stored_sortable, type: :string
+    PERMANENT_URL             = solr_name :permanent_url, :stored_sortable, type: :string
     TITLE                     = solr_name :title, :stored_sortable
     WORKFLOW_STATE            = solr_name :workflow_state, :stored_sortable
 

data/lib/ddr/managers.rb

@@ -0,0 +1,8 @@
+module Ddr
+  module Managers
+    extend ActiveSupport::Autoload
+
+    autoload :PermanentIdManager
+
+  end
+end

data/lib/ddr/managers/permanent_id_manager.rb

@@ -0,0 +1,93 @@
+require "ezid-client"
+require "resque"
+
+module Ddr
+  module Managers
+    # 
+    # PermanentIdManager is responsible for managing the permanent id for an object.
+    #
+    # @api private
+    class PermanentIdManager
+
+      PERMANENT_URL_BASE = "http://id.library.duke.edu/"
+      TARGET_URL_BASE = "http://repository.lib.duke.edu/"
+
+      ASSIGN_EVENT_SUMMARY = "Permanent ID assigned"
+
+      SOFTWARE = Ezid::Client.version
+
+      attr_reader :object
+
+      def initialize(object)
+        @object = object
+      end
+
+      def assign_later
+        Resque.enqueue(AssignmentJob, object.pid)
+      end
+
+      def assign
+        raise Ddr::Models::Error, "Permanent ID already assigned." if object.permanent_id
+        ActiveSupport::Notifications.instrument(Ddr::Notifications::UPDATE,
+                                                pid: object.pid, 
+                                                software: SOFTWARE,
+                                                summary: ASSIGN_EVENT_SUMMARY
+                                                ) do |payload|
+
+          assign!
+          payload[:detail] = <<-EOS
+Permanent ID:  #{object.permanent_id}
+Permanent URL: #{object.permanent_url}
+EZID Metadata:
+#{record.metadata}
+          EOS
+        end
+      end
+
+      # A job class for background execution
+      class AssignmentJob
+        @queue = :permanent_id
+
+        def self.perform(pid)
+          object = ActiveFedora::Base.find(pid)
+          object.permanent_id_manager.assign
+        end
+      end
+
+      def default_metadata
+        { profile: "dc", 
+          export: "no" 
+        }
+      end
+
+      def record
+        return @record if @record
+        if object.permanent_id
+          @record = Ezid::Identifier.find(object.permanent_id.to_s)
+        end
+      end
+
+      private
+
+        def assign!
+          @record = mint
+          object.permanent_id = record.id
+          object.permanent_url = (PERMANENT_URL_BASE + object.permanent_id)
+          object.save
+        end
+
+        # @return [Ezid::Identifier]
+        def mint
+          ezid = Ezid::Identifier.create(default_metadata)
+          ezid.target = default_target_url(ezid.id)
+          ezid.save
+          ezid
+        end
+
+        def default_target_url(id)
+          TARGET_URL_BASE + id
+        end
+
+    end
+  end
+end

data/lib/ddr/metadata/#permanent_id_record.rb#

@@ -0,0 +1,13 @@
+module Ddr
+  module Metadata
+    class PermanentIdRecord
+
+      def self.find(id)
+        Ezid::Identifier.find(id)
+      end
+
+      
+
+    end
+  end
+end

data/lib/ddr/models.rb

@@ -15,9 +15,11 @@ require 'ddr/auth'
 require 'ddr/datastreams'
 require 'ddr/events'
 require 'ddr/index_fields'
+require 'ddr/managers'
 require 'ddr/metadata'
 require 'ddr/notifications'
 require 'ddr/utils'
+require 'ddr/vocab'
 require 'ddr/workflow'
 
 module Ddr
@@ -36,6 +38,7 @@ module Ddr
     autoload :HasChildren
     autoload :HasContent
     autoload :HasContentMetadata
+    autoload :HasPreservationMetadata
     autoload :HasProperties
     autoload :HasRoleAssignments
     autoload :HasThumbnail
@@ -43,16 +46,17 @@ module Ddr
     autoload :Indexing
     autoload :FileManagement
     autoload :Licensable
-    autoload :MintedId
-    autoload :PermanentIdentification
     autoload :SolrDocument
-    
+
     # Base directory of external file store
-    mattr_accessor :external_file_store      
+    mattr_accessor :external_file_store
 
     # Regexp for building external file subpath from hex digest
     mattr_accessor :external_file_subpath_regexp
-      
+
+    # Whether permanent IDs should be automatically assigned on create
+    mattr_accessor :auto_assign_permanent_ids
+
     # Yields an object with module configuration accessors
     def self.configure
       yield self

data/lib/ddr/models/#has_ezid_identifier.rb#

@@ -0,0 +1,26 @@
+module Ddr
+  module Models
+    module HasEzidIdentifier
+
+      protected
+
+
+      def create_identifier
+        create_ezid
+      end
+
+      private
+
+      def create_ezid
+        metadata = Ddr::Metadata::Ezid.new(self)
+        ezid_identifier = Ezid::Identifier.create(metadata)
+        Ddr::Metadata::PermanentIdentifier.new(ezid_identifier.id)
+      end
+
+      def get_ezid
+        Ezid::Identifier.find(permanent_id.value)
+      end
+
+    end
+  end
+end

data/lib/ddr/models/#has_permanent_identifier.rb#

@@ -0,0 +1,9 @@
+module Ddr
+  module Models
+    module HasPermanentIdentifier
+
+      
+
+    end
+  end
+end

data/lib/ddr/models/base.rb

@@ -13,24 +13,24 @@ module Ddr
       include FixityCheckable
       include FileManagement
       include Indexing
-      include PermanentIdentification
       include HasRoleAssignments
       include Hydra::Validations
       include HasWorkflow
-      
+      include HasPreservationMetadata
+
       def copy_admin_policy_or_permissions_from(other)
         copy_permissions_from(other) unless copy_admin_policy_from(other)
       end
-      
+
       def association_query(association)
         # XXX Ideally we would include a clause to limit by AF model, but this should suffice
         ActiveFedora::SolrService.construct_query_for_rel(reflections[association].options[:property] => internal_uri)
       end
-      
+
       # e.g., "Collection duke:1"
       def model_pid
         [self.class.to_s, pid].join(" ")
-      end  
+      end
 
     end
   end

data/lib/ddr/models/engine.rb

@@ -23,6 +23,10 @@ module Ddr
         ActiveFedora::Predicates.set_predicates(Ddr::Metadata::PREDICATES)
       end
 
+      initializer "ddr_models.permanent_ids" do
+        Ddr::Models.auto_assign_permanent_ids = Rails.env.production?
+      end
+
       # Configure devise-remote-user
       initializer "ddr_auth.remote_user" do
         require "devise_remote_user"
@@ -62,6 +66,13 @@ module Ddr
         Ddr::Auth.collection_creators_group = ENV["COLLECTION_CREATORS_GROUP"]
       end
 
+      initializer "ezid_client" do
+        unless Rails.env.production?
+          require "ezid/test_helper"
+          ezid_test_mode!
+        end
+      end
+
     end
   end
 end

data/lib/ddr/models/has_preservation_metadata.rb

@@ -0,0 +1,28 @@
+module Ddr
+  module Models
+    module HasPreservationMetadata
+      extend ActiveSupport::Concern
+
+      included do
+        has_metadata "preservationMetadata",
+                     type: Ddr::Datastreams::PreservationMetadataDatastream,
+                     versionable: true,
+                     control_group: "M"
+
+        has_attributes :permanent_id, :permanent_url,
+        datastream: "preservationMetadata", multiple: false
+
+        after_create :assign_permanent_id!, if: "Ddr::Models.auto_assign_permanent_ids"
+      end
+
+      def permanent_id_manager
+        @permanent_id_manager ||= Ddr::Managers::PermanentIdManager.new(self)
+      end
+
+      def assign_permanent_id!
+        permanent_id_manager.assign_later
+      end
+
+    end
+  end
+end

data/lib/ddr/models/indexing.rb

@@ -12,9 +12,14 @@ module Ddr
           Ddr::IndexFields::TITLE => title_display,
           Ddr::IndexFields::INTERNAL_URI => internal_uri,
           Ddr::IndexFields::IDENTIFIER => identifier_sort,
-          Ddr::IndexFields::PERMANENT_ID => permanent_id,
           Ddr::IndexFields::WORKFLOW_STATE => workflow_state
         }
+        if permanent_id.present?
+          fields[Ddr::IndexFields::PERMANENT_ID] = permanent_id
+        end
+        if permanent_url.present?
+          fields[Ddr::IndexFields::PERMANENT_URL] = permanent_url
+        end
         if respond_to? :fixity_checks
           last_fixity_check = fixity_checks.last
           fields.merge!(last_fixity_check.to_solr) if last_fixity_check
@@ -50,4 +55,4 @@ module Ddr
 
     end
   end
-end
+end

data/lib/ddr/models/version.rb

@@ -1,5 +1,5 @@
 module Ddr
   module Models
-    VERSION = "1.5.0"
+    VERSION = "1.6.0"
   end
 end

data/lib/ddr/vocab.rb

@@ -0,0 +1,8 @@
+module Ddr
+  module Vocab
+    extend ActiveSupport::Autoload
+
+    autoload :Preservation
+
+  end
+end

data/lib/ddr/vocab.rb~

@@ -0,0 +1,9 @@
+module Ddr
+  module Vocab
+    extend ActiveSupport::Autoload
+
+    autoload :PREMIS
+    autoload :Preservation
+
+  end
+end

data/lib/ddr/vocab/preservation.rb

@@ -0,0 +1,14 @@
+module Ddr
+  module Vocab
+    class Preservation < RDF::StrictVocabulary("http://repository.lib.duke.edu/vocab/preservation/")
+
+      property "permanentId", 
+      label: "Permanent Identifier",
+      subPropertyOf: RDF::DC.identifier
+      
+      property "permanentUrl",
+      label: "Permanent URL"
+                                  
+    end
+  end
+end