cocina-models 0.29.0 → 0.33.0

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 && name
+        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 && name
+        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, RequestIdentification.default { RequestIdentification.new })
+      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 && name
+        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

data/lib/cocina/models/request_identification.rb

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

data/lib/cocina/models/sequence.rb

@@ -2,12 +2,10 @@
 
 module Cocina
   module Models
-    # Metadata for a sequence.  See http://sul-dlss.github.io/cocina-models/maps/Sequence.json
     class Sequence < Struct
-      attribute :viewingDirection, Types::String.enum('left-to-right',
-                                                      'right-to-left',
-                                                      'top-to-bottom',
-                                                      'bottom-to-top').optional
+      attribute :members, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
+      # The direction that a sequence of canvases should be displayed to the user
+      attribute :viewingDirection, Types::Strict::String.enum('right-to-left', 'left-to-right').meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/source.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class Source < Struct
+      # Code representing the value source.
+      attribute :code, Types::Strict::String.meta(omittable: true)
+      # URI for the value source.
+      attribute :uri, Types::Strict::String.meta(omittable: true)
+      # String describing the value source.
+      attribute :value, Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/validator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # Perform validation against openapi
+    class Validator
+      def self.validate(clazz, attributes)
+        method_name = clazz.name.split('::').last
+        request_operation = root.request_operation(:post, "/validate/#{method_name}")
+        request_operation.validate_request_body('application/json', attributes)
+      rescue OpenAPIParser::OpenAPIError => e
+        raise ValidationError, e.message
+      end
+
+      # rubocop:disable Style/ClassVars
+      def self.root
+        @@root ||= OpenAPIParser.parse(YAML.load_file(openapi_path))
+      end
+      # rubocop:enable Style/ClassVars
+      private_class_method :root
+
+      def self.openapi_path
+        ::File.expand_path('../../../openapi.yml', __dir__)
+      end
+      private_class_method :openapi_path
+    end
+  end
+end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.29.0'
+    VERSION = '0.33.0'
   end
 end

data/lib/cocina/models/vocab.rb

@@ -4,111 +4,96 @@ module Cocina
   module Models
     # A digital repository object.  See http://sul-dlss.github.io/cocina-models/maps/DRO.json
     class Vocab
-      ROOT = 'http://cocina.sul.stanford.edu/models/'
-
-      ### Object types ###
+      def self.three_dimensional
+        'http://cocina.sul.stanford.edu/models/3d.jsonld'
+      end
 
-      # This is the most generic type
-      def self.object
-        "#{ROOT}object.jsonld"
+      def self.admin_policy
+        'http://cocina.sul.stanford.edu/models/admin_policy.jsonld'
       end
 
       def self.agreement
-        "#{ROOT}agreement.jsonld"
+        'http://cocina.sul.stanford.edu/models/agreement.jsonld'
       end
 
-      def self.document
-        "#{ROOT}document.jsonld"
+      def self.book
+        'http://cocina.sul.stanford.edu/models/book.jsonld'
       end
 
-      def self.geo
-        "#{ROOT}geo.jsonld"
+      def self.collection
+        'http://cocina.sul.stanford.edu/models/collection.jsonld'
       end
 
-      def self.page
-        "#{ROOT}page.jsonld"
+      def self.curated_collection
+        'http://cocina.sul.stanford.edu/models/curated-collection.jsonld'
       end
 
-      def self.photograph
-        "#{ROOT}photograph.jsonld"
+      def self.document
+        'http://cocina.sul.stanford.edu/models/document.jsonld'
       end
 
-      def self.manuscript
-        "#{ROOT}manuscript.jsonld"
+      def self.exhibit
+        'http://cocina.sul.stanford.edu/models/exhibit.jsonld'
       end
 
-      def self.map
-        "#{ROOT}map.jsonld"
+      def self.file
+        'http://cocina.sul.stanford.edu/models/file.jsonld'
       end
 
-      def self.track
-        "#{ROOT}track.jsonld"
+      def self.fileset
+        'http://cocina.sul.stanford.edu/models/fileset.jsonld'
       end
 
-      def self.webarchive_binary
-        "#{ROOT}webarchive-binary.jsonld"
+      def self.geo
+        'http://cocina.sul.stanford.edu/models/geo.jsonld'
       end
 
-      def self.webarchive_seed
-        "#{ROOT}webarchive-seed.jsonld"
+      def self.image
+        'http://cocina.sul.stanford.edu/models/image.jsonld'
       end
 
-      # For time based media
-      def self.media
-        "#{ROOT}media.jsonld"
+      def self.manuscript
+        'http://cocina.sul.stanford.edu/models/manuscript.jsonld'
       end
 
-      def self.image
-        "#{ROOT}image.jsonld"
+      def self.map
+        'http://cocina.sul.stanford.edu/models/map.jsonld'
       end
 
-      def self.book
-        "#{ROOT}book.jsonld"
+      def self.media
+        'http://cocina.sul.stanford.edu/models/media.jsonld'
       end
 
-      def self.three_dimensional
-        "#{ROOT}3d.jsonld"
+      def self.object
+        'http://cocina.sul.stanford.edu/models/object.jsonld'
       end
 
-      ### File type ###
-
-      def self.file
-        "#{ROOT}file.jsonld"
+      def self.page
+        'http://cocina.sul.stanford.edu/models/page.jsonld'
       end
 
-      ### Fileset type ###
-
-      def self.fileset
-        "#{ROOT}fileset.jsonld"
+      def self.photograph
+        'http://cocina.sul.stanford.edu/models/photograph.jsonld'
       end
 
-      ### Collection types ###
-
-      # The most generic type of collection
-      def self.collection
-        "#{ROOT}collection.jsonld"
+      def self.series
+        'http://cocina.sul.stanford.edu/models/series.jsonld'
       end
 
-      def self.curated_collection
-        "#{ROOT}curated-collection.jsonld"
+      def self.track
+        'http://cocina.sul.stanford.edu/models/track.jsonld'
       end
 
       def self.user_collection
-        "#{ROOT}user-collection.jsonld"
-      end
-
-      def self.exhibit
-        "#{ROOT}exhibit.jsonld"
+        'http://cocina.sul.stanford.edu/models/user-collection.jsonld'
       end
 
-      def self.series
-        "#{ROOT}series.jsonld"
+      def self.webarchive_binary
+        'http://cocina.sul.stanford.edu/models/webarchive-binary.jsonld'
       end
 
-      ### Admin Policy type ###
-
-      def self.admin_policy
-        "#{ROOT}admin_policy.jsonld"
+      def self.webarchive_seed
+        'http://cocina.sul.stanford.edu/models/webarchive-seed.jsonld'
       end
     end
   end