cocina-models 0.29.0 → 0.30.0

data/lib/cocina/models.rb

@@ -5,23 +5,34 @@ require 'zeitwerk'
 require 'dry-struct'
 require 'dry-types'
 require 'json'
+require 'openapi_parser'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'yaml'
 
 # Help Zeitwerk find some of our classes
 class CocinaModelsInflector < Zeitwerk::Inflector
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/MethodLength
   def camelize(basename, _abspath)
     case basename
     when 'dro'
       'DRO'
-    when 'dro_builder'
-      'DROBuilder'
     when 'request_dro'
       'RequestDRO'
+    when 'dro_access'
+      'DROAccess'
+    when 'dro_structural'
+      'DROStructural'
+    when 'request_dro_structural'
+      'RequestDROStructural'
     when 'version'
       'VERSION'
     else
       super
     end
   end
+  # rubocop:enable Metrics/CyclomaticComplexity
+  # rubocop:enable Metrics/MethodLength
 end
 
 loader = Zeitwerk::Loader.new
@@ -36,43 +47,58 @@ module Cocina
     # Raised when the type attribute is not valid.
     class UnknownTypeError < Error; end
 
+    # Raised when an error occurs validating against openapi.
+    class ValidationError < Error; end
+
     # Base class for Cocina Structs
     class Struct < Dry::Struct
       transform_keys(&:to_sym)
+      schema schema.strict
+    end
+
+    # DRY Types
+    module Types
+      include Dry.Types()
     end
 
     # @param [Hash] dyn a ruby hash representation of the JSON serialization of a collection or DRO
-    # @return [DRO,Collection]
+    # @param [boolean] validate
+    # @return [DRO,Collection,AdminPolicy]
     # @raises [UnknownTypeError] if a valid type is not found in the data
     # @raises [KeyError] if a type field cannot be found in the data
-    def self.build(dyn)
-      case dyn.fetch('type')
-      when *DRO::TYPES
-        DRO.new(dyn)
-      when *Collection::TYPES
-        Collection.new(dyn)
-      when *AdminPolicy::TYPES
-        AdminPolicy.new(dyn)
-      else
-        raise UnknownTypeError, "Unknown type: '#{dyn.fetch('type')}'"
-      end
+    # @raises [ValidationError] if hash representation fails openapi validation
+    def self.build(dyn, validate: true)
+      clazz = case dyn.fetch('type')
+              when *DRO::TYPES
+                DRO
+              when *Collection::TYPES
+                Collection
+              when *AdminPolicy::TYPES
+                AdminPolicy
+              else
+                raise UnknownTypeError, "Unknown type: '#{dyn.fetch('type')}'"
+              end
+      clazz.new(dyn, validate: validate)
     end
 
     # @param [Hash] dyn a ruby hash representation of the JSON serialization of a request for a Collection or DRO
+    # @param [boolean] validate
     # @return [RequestDRO,RequestCollection,RequestAdminPolicy]
     # @raises [UnknownTypeError] if a valid type is not found in the data
     # @raises [KeyError] if a type field cannot be found in the data
-    def self.build_request(dyn)
-      case dyn.fetch('type')
-      when *DRO::TYPES
-        RequestDRO.new(dyn)
-      when *Collection::TYPES
-        RequestCollection.new(dyn)
-      when *AdminPolicy::TYPES
-        RequestAdminPolicy.new(dyn)
-      else
-        raise UnknownTypeError, "Unknown type: '#{dyn.fetch('type')}'"
-      end
+    # @raises [ValidationError] if hash representation fails openapi validation
+    def self.build_request(dyn, validate: true)
+      clazz = case dyn.fetch('type')
+              when *DRO::TYPES
+                RequestDRO
+              when *Collection::TYPES
+                RequestCollection
+              when *AdminPolicy::TYPES
+                RequestAdminPolicy
+              else
+                raise UnknownTypeError, "Unknown type: '#{dyn.fetch('type')}'"
+              end
+      clazz.new(dyn, validate: validate)
     end
   end
 end

data/lib/cocina/models/access.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class Access < Struct
+      # Access level
+      attribute :access, Types::Strict::String.default('dark').enum('world', 'stanford', 'location-based', 'citation-only', 'dark').meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/admin_policy.rb

@@ -2,67 +2,24 @@
 
 module Cocina
   module Models
-    # An admin policy object.
     class AdminPolicy < Struct
       include Checkable
 
-      TYPES = [
-        Vocab.admin_policy
-      ].freeze
+      TYPES = ['http://cocina.sul.stanford.edu/models/admin_policy.jsonld'].freeze
 
-      # Subschema for access concerns
-      class Access < Struct
-      end
-
-      # Subschema for administrative concerns
-      class Administrative < Struct
-        # This was copied from the ActiveFedora defaults: Dor::AdminPolicyObject.new.defaultObjectRights.content
-        DEFAULT_OBJECT_RIGHTS = <<~XML
-          <?xml version="1.0" encoding="UTF-8"?>
-
-          <rightsMetadata>
-             <access type="discover">
-                <machine>
-                   <world/>
-                </machine>
-             </access>
-             <access type="read">
-                <machine>
-                   <world/>
-                </machine>
-             </access>
-             <use>
-                <human type="useAndReproduction"/>
-                <human type="creativeCommons"/>
-                <machine type="creativeCommons" uri=""/>
-                <human type="openDataCommons"/>
-                <machine type="openDataCommons" uri=""/>
-             </use>
-             <copyright>
-                <human/>
-             </copyright>
-          </rightsMetadata>
-        XML
-
-        # An XML blob that is to be used temporarily until we model rights
-        attribute :default_object_rights, Types::Strict::String.optional.default(DEFAULT_OBJECT_RIGHTS)
-
-        # which workflow to start when registering (used by Web Archive apos to start wasCrawlPreassemblyWF)
-        attribute :registration_workflow, Types::String.optional.default(nil)
-
-        # TODO: Allowing hasAdminPolicy to be omittable for now (until rolled out to consumers),
-        # but I think it's actually required for every Admin Policy
-        attribute :hasAdminPolicy, Types::Strict::String.optional.default(nil)
-      end
-
-      class Identification < Struct
-      end
-
-      class Structural < Struct
-      end
-
-      include AdminPolicyAttributes
+      # example: item
+      attribute :type, Types::Strict::String.enum(*AdminPolicy::TYPES)
+      # example: druid:bc123df4567
       attribute :externalIdentifier, Types::Strict::String
+      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/admin_policy_administrative.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class AdminPolicyAdministrative < Struct
+      attribute :defaultObjectRights, Types::Strict::String.default('<?xml version="1.0" encoding="UTF-8"?><rightsMetadata><access type="discover"><machine><world/></machine></access><access type="read"><machine><world/></machine></access><use><human type="useAndReproduction"/><human type="creativeCommons"/><machine type="creativeCommons" uri=""/><human type="openDataCommons"/><machine type="openDataCommons" uri=""/></use><copyright><human/></copyright></rightsMetadata>').meta(omittable: true)
+      attribute :registrationWorkflow, Types::Strict::String.meta(omittable: true)
+      attribute :hasAdminPolicy, Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/administrative.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class Administrative < Struct
+      # example: druid:bc123df4567
+      attribute :hasAdminPolicy, Types::Strict::String.meta(omittable: true)
+      attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).meta(omittable: true)
+      # Administrative or Internal project this resource is a part of
+      # example: Google Books
+      attribute :partOfProject, Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/catalog_link.rb

@@ -2,9 +2,12 @@
 
 module Cocina
   module Models
-    # Metadata for a catalog link
     class CatalogLink < Struct
+      # Catalog that is the source of the linked record.
+      # example: symphony
       attribute :catalog, Types::Strict::String
+      # Record identifier that is unique within the context of the linked record's catalog.
+      # example: 11403803
       attribute :catalogRecordId, Types::Strict::String
     end
   end

data/lib/cocina/models/collection.rb

@@ -2,43 +2,33 @@
 
 module Cocina
   module Models
-    # A digital repository collection.
-    # See http://sul-dlss.github.io/cocina-models/maps/Collection.json
     class Collection < Struct
       include Checkable
 
-      TYPES = [
-        Vocab.collection,
-        Vocab.curated_collection,
-        Vocab.exhibit,
-        Vocab.series,
-        Vocab.user_collection
-      ].freeze
+      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
 
-      # Subschema for access concerns
-      class Access < Struct
-        attribute :access, Types::String.default('dark')
-                                        .enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
-      end
-
-      # Subschema for administrative concerns
-      class Administrative < Struct
-        attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).default([].freeze)
-        # TODO: Allowing hasAdminPolicy to be omittable for now (until rolled out to consumers),
-        # but I think it's actually required for every Collection
-        attribute :hasAdminPolicy, Types::Strict::String.optional.default(nil)
-      end
-
-      # Identification sub-schema for the Collection
-      class Identification < Struct
-        attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).meta(omittable: true)
-      end
+      # The content type of the Collection. Selected from an established set of values.
+      # example: item
+      attribute :type, Types::Strict::String.enum(*Collection::TYPES)
+      # example: druid:bc123df4567
+      attribute :externalIdentifier, Types::Strict::String
+      # Primary processing label (can be same as title) for a Collection.
+      attribute :label, Types::Strict::String
+      # Version for the Collection within SDR.
+      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)
 
-      class Structural < Struct
+      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
-
-      include CollectionAttributes
-      attribute :externalIdentifier, Types::Strict::String
     end
   end
 end

data/lib/cocina/models/collection_identification.rb

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

data/lib/cocina/models/description.rb

@@ -2,15 +2,8 @@
 
 module Cocina
   module Models
-    # Descriptive metadata.  See http://sul-dlss.github.io/cocina-models/maps/Description.json
     class Description < Struct
-      # Title element.  See http://sul-dlss.github.io/cocina-models/maps/Title.json
-      class Title < Struct
-        attribute :primary, Types::Strict::Bool
-        attribute :titleFull, Types::Strict::String
-      end
-
-      attribute :title, Types::Strict::Array.of(Title)
+      attribute :title, Types::Strict::Array.of(Title).default([].freeze)
     end
   end
 end

data/lib/cocina/models/dro.rb

@@ -2,80 +2,44 @@
 
 module Cocina
   module Models
-    # A digital repository object.
-    # See http://sul-dlss.github.io/cocina-models/maps/DRO.json
     class DRO < Struct
       include Checkable
 
-      TYPES = [
-        Vocab.object,
-        Vocab.three_dimensional,
-        Vocab.agreement,
-        Vocab.book,
-        Vocab.document,
-        Vocab.geo,
-        Vocab.image,
-        Vocab.page,
-        Vocab.photograph,
-        Vocab.manuscript,
-        Vocab.map,
-        Vocab.media,
-        Vocab.track,
-        Vocab.webarchive_binary,
-        Vocab.webarchive_seed
-      ].freeze
-
-      # Subschema for access concerns
-      class Access < Struct
-        # Subschema for embargo concerns
-        class Embargo < Struct
-          attribute :releaseDate, Types::Params::DateTime
-          attribute :access, Types::String.default('dark')
-                                          .enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
-          attribute :useAndReproductionStatement, Types::Strict::String.meta(omittable: true)
-        end
-
-        attribute :access, Types::String.default('dark')
-                                        .enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
-        attribute :copyright, Types::Strict::String.meta(omittable: true)
-        attribute :embargo, Embargo.optional.meta(omittable: true)
-        attribute :useAndReproductionStatement, Types::Strict::String.meta(omittable: true)
-      end
-
-      # Subschema for administrative concerns
-      class Administrative < Struct
-        # TODO: Allowing hasAdminPolicy to be omittable for now (until rolled out to consumers),
-        # but I think it's actually required for every DRO
-        attribute :hasAdminPolicy, Types::Strict::String.optional.default(nil)
-        attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).meta(omittable: true).default([].freeze)
-        attribute :partOfProject, Types::Strict::String.meta(omittable: true)
-      end
-
-      # Identification sub-schema for the DRO
-      class Identification < Struct
-        attribute :sourceId, Types::Strict::String.meta(omittable: true)
-        attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).meta(omittable: true)
-      end
-
-      # Geographic sub-schema for the DRO
-      class Geographic < Struct
-        attribute :iso19139, Types::Strict::String
-      end
-
-      # Structural sub-schema for the DRO (uses FileSet, unlike RequestDRO which uses RequestFileSet)
-      class Structural < Struct
-        attribute :contains, Types::Strict::Array.of(FileSet).meta(omittable: true)
-        attribute :hasAgreement, Types::Strict::String.meta(omittable: true)
-        attribute :isMemberOf, Types::Strict::String.meta(omittable: true)
-        attribute :hasMemberOrders, Types::Strict::Array.of(Sequence).meta(omittable: true)
-      end
-
-      include DroAttributes
+      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
+
+      # The content type of the DRO. Selected from an established set of values.
+      # example: item
+      attribute :type, Types::Strict::String.enum(*DRO::TYPES)
+      # example: druid:bc123df4567
       attribute :externalIdentifier, Types::Strict::String
-      attribute(:structural, Structural.default { Structural.new })
-
-      def image?
-        type == Vocab.image
+      # Primary processing label (can be same as title) for a DRO.
+      attribute :label, Types::Strict::String
+      # Version for the DRO within SDR.
+      attribute :version, Types::Strict::Integer
+      attribute(:access, DROAccess.default { DROAccess.new })
+      attribute :administrative, Administrative.optional.meta(omittable: true)
+      attribute :description, Description.optional.meta(omittable: true)
+      attribute :identification, Identification.optional.meta(omittable: true)
+      attribute :structural, DROStructural.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