cocina-models 0.29.0 → 0.30.0

data/lib/cocina/models/dro_access.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DROAccess < Struct
+      attribute :access, Types::Strict::String.default('dark').enum('world', 'stanford', 'location-based', 'citation-only', 'dark').meta(omittable: true)
+      # The human readable copyright statement that applies
+      # example: Copyright World Trade Organization
+      attribute :copyright, Types::Strict::String.meta(omittable: true)
+      # The human readable use and reproduction statement that applies
+      # example: Property rights reside with the repository. Literary rights reside with the creators of the documents or their heirs. To obtain permission to publish or reproduce, please contact the Public Services Librarian of the Dept. of Special Collections (http://library.stanford.edu/spc).
+      attribute :useAndReproductionStatement, Types::Strict::String.meta(omittable: true)
+      attribute :embargo, Embargo.optional.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/dro_structural.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DROStructural < Struct
+      attribute :contains, Types::Strict::Array.of(FileSet).meta(omittable: true)
+      attribute :hasMemberOrders, Types::Strict::Array.of(Sequence).meta(omittable: true)
+      # example: druid:bc123df4567
+      attribute :isMemberOf, Types::Strict::String.meta(omittable: true)
+      # Agreement that covers the deposit of the DRO into SDR.
+      attribute :hasAgreement, Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/embargo.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class Embargo < Struct
+      # Date when the Collection is released from an embargo.
+      # example: 2029-06-22T07:00:00.000+00:00
+      attribute :releaseDate, Types::Params::DateTime
+      # Access level that applies when embargo expires.
+      attribute :access, Types::Strict::String.enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
+      # The human readable use and reproduction statement that applies when the embargo expires.
+      # example: These materials are in the public domain.
+      attribute :useAndReproductionStatement, Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/file.rb

@@ -2,47 +2,31 @@
 
 module Cocina
   module Models
-    # Metadata for a file.
-    # See http://sul-dlss.github.io/cocina-models/maps/File.json
     class File < Struct
       include Checkable
 
-      TYPES = [
-        Vocab.file
-      ].freeze
+      TYPES = ['http://cocina.sul.stanford.edu/models/file.jsonld'].freeze
 
-      # Represents access controls on the file
-      class Access < Struct
-        attribute :access, Types::String.default('dark')
-                                        .enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
-      end
-
-      # Represents the administration of the file
-      class Administrative < Struct
-        attribute :sdrPreserve, Types::Strict::Bool.optional.default(true)
-        attribute :shelve, Types::Strict::Bool.optional.default(false)
-      end
-
-      # Represents a digest (checksum) value for a file
-      class Fixity < Struct
-        attribute :type, Types::String.enum('md5', 'sha1')
-        attribute :digest, Types::Strict::String
-      end
-
-      class Identification < Struct
-      end
-
-      # Represents some technical aspect of the file
-      class Presentation < Struct
-        attribute :height, Types::Strict::Integer.optional.default(nil)
-        attribute :width, Types::Strict::Integer.optional.default(nil)
-      end
-
-      class Structural < Struct
-      end
-
-      include FileAttributes
+      # The content type of the File.
+      attribute :type, Types::Strict::String.enum(*File::TYPES)
+      # Identifier for the resource within the SDR architecture but outside of the repository. UUID. Constant across resource versions. What clients will use calling the repository.
       attribute :externalIdentifier, Types::Strict::String
+      # Primary processing label (can be same as title) for a File.
+      attribute :label, Types::Strict::String
+      # Filename for a file. Can be same as label.
+      attribute :filename, Types::Strict::String.meta(omittable: true)
+      # Size of the File (binary) in bytes.
+      attribute :size, Types::Strict::Integer.meta(omittable: true)
+      # Version for the File within SDR.
+      attribute :version, Types::Strict::Integer
+      # MIME Type of the File.
+      attribute :hasMimeType, Types::Strict::String.meta(omittable: true)
+      # Use for the File.
+      attribute :use, Types::Strict::String.meta(omittable: true)
+      attribute :hasMessageDigests, Types::Strict::Array.of(MessageDigest).default([].freeze)
+      attribute(:access, Access.default { Access.new })
+      attribute(:administrative, FileAdministrative.default { FileAdministrative.new })
+      attribute :presentation, Presentation.optional.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/file_administrative.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class FileAdministrative < Struct
+      attribute :sdrPreserve, Types::Strict::Bool.default(true)
+      attribute :shelve, Types::Strict::Bool.default(false)
+    end
+  end
+end

data/lib/cocina/models/file_set.rb

@@ -2,26 +2,19 @@
 
 module Cocina
   module Models
-    # Metadata for a file set.
-    # See http://sul-dlss.github.io/cocina-models/maps/Fileset.json
     class FileSet < Struct
       include Checkable
 
-      TYPES = [
-        Vocab.fileset
-      ].freeze
+      TYPES = ['http://cocina.sul.stanford.edu/models/fileset.jsonld'].freeze
 
-      class Identification < Struct
-      end
-
-      # Structural sub-schema that contains File (unlike the one in RequestFileSet which contains RequestFile)
-      class Structural < Struct
-        attribute :contains, Types::Strict::Array.of(Cocina::Models::File).meta(omittable: true)
-      end
-
-      include FileSetAttributes
+      # The content type of the Fileset.
+      attribute :type, Types::Strict::String.enum(*FileSet::TYPES)
       attribute :externalIdentifier, Types::Strict::String
-      attribute(:structural, Structural.default { Structural.new })
+      # Primary processing label for a Fileset.
+      attribute :label, Types::Strict::String
+      # Version for the Fileset within SDR.
+      attribute :version, Types::Strict::Integer
+      attribute :structural, FileSetStructural.optional.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/file_set_structural.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class FileSetStructural < Struct
+      attribute :contains, Types::Strict::Array.of(File).meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/geographic.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class Geographic < Struct
+      # Geographic ISO 19139 XML metadata
+      attribute :iso19139, Types::Strict::String
+    end
+  end
+end

data/lib/cocina/models/identification.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class Identification < Struct
+      # example: sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026
+      attribute :sourceId, Types::Strict::String.meta(omittable: true)
+      attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/message_digest.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class MessageDigest < Struct
+      include Checkable
+
+      TYPES = %w[md5
+                 sha1].freeze
+
+      # The algorithm that was used
+      attribute :type, Types::Strict::String.enum(*MessageDigest::TYPES)
+      # The digest value Base64 encoded
+      attribute :digest, Types::Strict::String
+    end
+  end
+end

data/lib/cocina/models/presentation.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class Presentation < Struct
+      # Height in pixels
+      attribute :height, Types::Strict::Integer.meta(omittable: true)
+      # Width in pixels
+      attribute :width, Types::Strict::Integer.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/release_tag.rb

@@ -2,14 +2,19 @@
 
 module Cocina
   module Models
-    # Subschema for release tags
     class ReleaseTag < Struct
-      attribute :to, Types::Strict::String.enum('Searchworks', 'Earthworks')
-      attribute :what, Types::Strict::String.enum('self', 'collection')
-      # we use 'when' other places, but that's reserved word, so 'date' it is!
-      attribute :date, Types::Params::DateTime
-      attribute :who, Types::Strict::String
-      attribute :release, Types::Strict::Bool
+      # Who did this release
+      # example: petucket
+      attribute :who, Types::Strict::String.meta(omittable: true)
+      # What is being released. This item or the whole collection.
+      # example: self
+      attribute :what, Types::Strict::String.enum('self', 'collection').meta(omittable: true)
+      # When did this action happen
+      attribute :date, Types::Params::DateTime.meta(omittable: true)
+      # What platform is it released to
+      # example: Searchworks
+      attribute :to, Types::Strict::String.meta(omittable: true)
+      attribute :release, Types::Strict::Bool.default(false)
     end
   end
 end

data/lib/cocina/models/request_admin_policy.rb

@@ -2,10 +2,22 @@
 
 module Cocina
   module Models
-    # A request to create an AdminPolicy object.
-    # This is the same as an AdminPolicy, but without externalIdentifier (as that wouldn't have been created yet).
     class RequestAdminPolicy < Struct
-      include AdminPolicyAttributes
+      include Checkable
+
+      TYPES = ['http://cocina.sul.stanford.edu/models/admin_policy.jsonld'].freeze
+
+      # example: item
+      attribute :type, Types::Strict::String.enum(*RequestAdminPolicy::TYPES)
+      attribute :label, Types::Strict::String
+      attribute :version, Types::Strict::Integer
+      attribute(:administrative, AdminPolicyAdministrative.default { AdminPolicyAdministrative.new })
+      attribute :description, Description.optional.meta(omittable: true)
+
+      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
+        Validator.validate(self, attributes.with_indifferent_access) if validate
+        super(attributes, safe, &block)
+      end
     end
   end
 end

data/lib/cocina/models/request_collection.rb

@@ -2,11 +2,28 @@
 
 module Cocina
   module Models
-    # A request to create a digital repository collection.
-    # This is the same as a Collection, but without externalIdentifier (as that wouldn't have been created yet).
-    # See http://sul-dlss.github.io/cocina-models/maps/Collection.json
     class RequestCollection < Struct
-      include CollectionAttributes
+      include Checkable
+
+      TYPES = ['http://cocina.sul.stanford.edu/models/collection.jsonld',
+               'http://cocina.sul.stanford.edu/models/curated-collection.jsonld',
+               'http://cocina.sul.stanford.edu/models/user-collection.jsonld',
+               'http://cocina.sul.stanford.edu/models/exhibit.jsonld',
+               'http://cocina.sul.stanford.edu/models/series.jsonld'].freeze
+
+      # example: item
+      attribute :type, Types::Strict::String.enum(*RequestCollection::TYPES)
+      attribute :label, Types::Strict::String
+      attribute :version, Types::Strict::Integer
+      attribute(:access, Access.default { Access.new })
+      attribute :administrative, Administrative.optional.meta(omittable: true)
+      attribute :description, Description.optional.meta(omittable: true)
+      attribute :identification, CollectionIdentification.optional.meta(omittable: true)
+
+      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
+        Validator.validate(self, attributes.with_indifferent_access) if validate
+        super(attributes, safe, &block)
+      end
     end
   end
 end

data/lib/cocina/models/request_dro.rb

@@ -2,19 +2,40 @@
 
 module Cocina
   module Models
-    # A request to create a digital repository object.
-    # This is the same as a DRO, but without externalIdentifier (as that wouldn't have been created yet)
-    # See http://sul-dlss.github.io/cocina-models/maps/DRO.json
     class RequestDRO < Struct
-      # Structural sub-schema that contains RequestFileSet (unlike the DRO which contains FileSet)
-      class Structural < Struct
-        attribute :contains, Types::Strict::Array.of(RequestFileSet).meta(omittable: true)
-        attribute :isMemberOf, Types::Strict::String.meta(omittable: true)
-        attribute :hasMemberOrders, Types::Strict::Array.of(Sequence).meta(omittable: true)
-      end
+      include Checkable
+
+      TYPES = ['http://cocina.sul.stanford.edu/models/object.jsonld',
+               'http://cocina.sul.stanford.edu/models/3d.jsonld',
+               'http://cocina.sul.stanford.edu/models/agreement.jsonld',
+               'http://cocina.sul.stanford.edu/models/book.jsonld',
+               'http://cocina.sul.stanford.edu/models/document.jsonld',
+               'http://cocina.sul.stanford.edu/models/geo.jsonld',
+               'http://cocina.sul.stanford.edu/models/image.jsonld',
+               'http://cocina.sul.stanford.edu/models/page.jsonld',
+               'http://cocina.sul.stanford.edu/models/photograph.jsonld',
+               'http://cocina.sul.stanford.edu/models/manuscript.jsonld',
+               'http://cocina.sul.stanford.edu/models/map.jsonld',
+               'http://cocina.sul.stanford.edu/models/media.jsonld',
+               'http://cocina.sul.stanford.edu/models/track.jsonld',
+               'http://cocina.sul.stanford.edu/models/webarchive-binary.jsonld',
+               'http://cocina.sul.stanford.edu/models/webarchive-seed.jsonld'].freeze
 
-      include DroAttributes
-      attribute(:structural, Structural.default { Structural.new })
+      # example: item
+      attribute :type, Types::Strict::String.enum(*RequestDRO::TYPES)
+      attribute :label, Types::Strict::String
+      attribute :version, Types::Strict::Integer
+      attribute :access, DROAccess.optional.meta(omittable: true)
+      attribute :administrative, Administrative.optional.meta(omittable: true)
+      attribute :description, Description.optional.meta(omittable: true)
+      attribute :identification, Identification.optional.meta(omittable: true)
+      attribute :structural, RequestDROStructural.optional.meta(omittable: true)
+      attribute :geographic, Geographic.optional.meta(omittable: true)
+
+      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
+        Validator.validate(self, attributes.with_indifferent_access) if validate
+        super(attributes, safe, &block)
+      end
     end
   end
 end

data/lib/cocina/models/request_dro_structural.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class RequestDROStructural < Struct
+      attribute :contains, Types::Strict::Array.of(RequestFileSet).meta(omittable: true)
+      attribute :hasMemberOrders, Types::Strict::Array.of(Sequence).meta(omittable: true)
+      # example: druid:bc123df4567
+      attribute :isMemberOf, Types::Strict::String.meta(omittable: true)
+      attribute :hasAgreement, Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/request_file.rb

@@ -2,14 +2,23 @@
 
 module Cocina
   module Models
-    # a request to create a File object.
-    # This is the same as a File, but without externalIdentifier (as that wouldn't have been created yet)
-    # See http://sul-dlss.github.io/cocina-models/maps/File.json
     class RequestFile < Struct
-      include FileAttributes
-      # externalIdentifier is used when submitting files to the SDR API to identify the file so that the
-      # uploaded files can be associated with the DRO.
+      include Checkable
+
+      TYPES = ['http://cocina.sul.stanford.edu/models/file.jsonld'].freeze
+
+      attribute :type, Types::Strict::String.enum(*RequestFile::TYPES)
+      attribute :label, Types::Strict::String
+      attribute :filename, Types::Strict::String
+      attribute :size, Types::Strict::Integer.meta(omittable: true)
+      attribute :version, Types::Strict::Integer
+      attribute :hasMimeType, Types::Strict::String.meta(omittable: true)
       attribute :externalIdentifier, Types::Strict::String.meta(omittable: true)
+      attribute :use, Types::Strict::String.meta(omittable: true)
+      attribute :hasMessageDigests, Types::Strict::Array.of(MessageDigest).default([].freeze)
+      attribute(:access, Access.default { Access.new })
+      attribute(:administrative, FileAdministrative.default { FileAdministrative.new })
+      attribute :presentation, Presentation.optional.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/request_file_set.rb

@@ -2,17 +2,15 @@
 
 module Cocina
   module Models
-    # A request to create a FileSet object.
-    # This is the same as a FileSet, but without externalIdentifier (as that wouldn't have been created yet)
-    # See http://sul-dlss.github.io/cocina-models/maps/FileSet.json
     class RequestFileSet < Struct
-      # Structural sub-schema that contains RequestFile (unlike the one in FileSet which contains File)
-      class Structural < Struct
-        attribute :contains, Types::Strict::Array.of(RequestFile).meta(omittable: true)
-      end
+      include Checkable
 
-      include FileSetAttributes
-      attribute(:structural, Structural.default { Structural.new })
+      TYPES = ['http://cocina.sul.stanford.edu/models/fileset.jsonld'].freeze
+
+      attribute :type, Types::Strict::String.enum(*RequestFileSet::TYPES)
+      attribute :label, Types::Strict::String
+      attribute :version, Types::Strict::Integer
+      attribute(:structural, RequestFileSetStructural.default { RequestFileSetStructural.new })
     end
   end
 end

data/lib/cocina/models/request_file_set_structural.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class RequestFileSetStructural < Struct
+      attribute :contains, Types::Strict::Array.of(RequestFile).meta(omittable: true)
+    end
+  end
+end