cocina-models 0.67.1 → 0.68.0

data/lib/cocina/models/object_type.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # This vocabulary defines the top level object type
+    class ObjectType
+      def self.three_dimensional
+        'https://cocina.sul.stanford.edu/models/3d'
+      end
+
+      def self.admin_policy
+        'https://cocina.sul.stanford.edu/models/admin_policy'
+      end
+
+      def self.agreement
+        'https://cocina.sul.stanford.edu/models/agreement'
+      end
+
+      def self.book
+        'https://cocina.sul.stanford.edu/models/book'
+      end
+
+      def self.collection
+        'https://cocina.sul.stanford.edu/models/collection'
+      end
+
+      def self.curated_collection
+        'https://cocina.sul.stanford.edu/models/curated-collection'
+      end
+
+      def self.document
+        'https://cocina.sul.stanford.edu/models/document'
+      end
+
+      def self.exhibit
+        'https://cocina.sul.stanford.edu/models/exhibit'
+      end
+
+      def self.file
+        'https://cocina.sul.stanford.edu/models/file'
+      end
+
+      def self.geo
+        'https://cocina.sul.stanford.edu/models/geo'
+      end
+
+      def self.image
+        'https://cocina.sul.stanford.edu/models/image'
+      end
+
+      def self.manuscript
+        'https://cocina.sul.stanford.edu/models/manuscript'
+      end
+
+      def self.map
+        'https://cocina.sul.stanford.edu/models/map'
+      end
+
+      def self.media
+        'https://cocina.sul.stanford.edu/models/media'
+      end
+
+      def self.object
+        'https://cocina.sul.stanford.edu/models/object'
+      end
+
+      def self.page
+        'https://cocina.sul.stanford.edu/models/page'
+      end
+
+      def self.photograph
+        'https://cocina.sul.stanford.edu/models/photograph'
+      end
+
+      def self.series
+        'https://cocina.sul.stanford.edu/models/series'
+      end
+
+      def self.track
+        'https://cocina.sul.stanford.edu/models/track'
+      end
+
+      def self.user_collection
+        'https://cocina.sul.stanford.edu/models/user-collection'
+      end
+
+      def self.webarchive_binary
+        'https://cocina.sul.stanford.edu/models/webarchive-binary'
+      end
+
+      def self.webarchive_seed
+        'https://cocina.sul.stanford.edu/models/webarchive-seed'
+      end
+    end
+  end
+end

data/lib/cocina/models/request_admin_policy.rb

@@ -7,7 +7,7 @@ module Cocina
 
       include Checkable
 
-      TYPES = ['http://cocina.sul.stanford.edu/models/admin_policy.jsonld'].freeze
+      TYPES = ['https://cocina.sul.stanford.edu/models/admin_policy'].freeze
 
       # The version of Cocina with which this object conforms.
       # example: 1.2.3

data/lib/cocina/models/request_administrative.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class RequestAdministrative < Struct
+      # example: druid:bc123df4567
+      attribute :hasAdminPolicy, Types::Strict::String
+      attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).default([].freeze)
+      # Internal project this resource is a part of. This governs routing of messages about this object.
+      # example: Google Books
+      attribute :partOfProject, Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/request_collection.rb

@@ -7,11 +7,11 @@ module Cocina
 
       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
+      TYPES = ['https://cocina.sul.stanford.edu/models/collection',
+               'https://cocina.sul.stanford.edu/models/curated-collection',
+               'https://cocina.sul.stanford.edu/models/user-collection',
+               'https://cocina.sul.stanford.edu/models/exhibit',
+               'https://cocina.sul.stanford.edu/models/series'].freeze
 
       # The version of Cocina with which this object conforms.
       # example: 1.2.3
@@ -20,7 +20,7 @@ module Cocina
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer.default(1).enum(1)
       attribute(:access, CollectionAccess.default { CollectionAccess.new })
-      attribute(:administrative, Administrative.default { Administrative.new })
+      attribute(:administrative, RequestAdministrative.default { RequestAdministrative.new })
       attribute :description, RequestDescription.optional.meta(omittable: true)
       attribute :identification, CollectionIdentification.optional.meta(omittable: true)
     end

data/lib/cocina/models/request_dro.rb

@@ -7,21 +7,21 @@ module Cocina
 
       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
+      TYPES = ['https://cocina.sul.stanford.edu/models/object',
+               'https://cocina.sul.stanford.edu/models/3d',
+               'https://cocina.sul.stanford.edu/models/agreement',
+               'https://cocina.sul.stanford.edu/models/book',
+               'https://cocina.sul.stanford.edu/models/document',
+               'https://cocina.sul.stanford.edu/models/geo',
+               'https://cocina.sul.stanford.edu/models/image',
+               'https://cocina.sul.stanford.edu/models/page',
+               'https://cocina.sul.stanford.edu/models/photograph',
+               'https://cocina.sul.stanford.edu/models/manuscript',
+               'https://cocina.sul.stanford.edu/models/map',
+               'https://cocina.sul.stanford.edu/models/media',
+               'https://cocina.sul.stanford.edu/models/track',
+               'https://cocina.sul.stanford.edu/models/webarchive-binary',
+               'https://cocina.sul.stanford.edu/models/webarchive-seed'].freeze
 
       # The version of Cocina with which this object conforms.
       # example: 1.2.3
@@ -30,7 +30,7 @@ module Cocina
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer.default(1).enum(1)
       attribute :access, DROAccess.optional.meta(omittable: true)
-      attribute(:administrative, Administrative.default { Administrative.new })
+      attribute(:administrative, RequestAdministrative.default { RequestAdministrative.new })
       attribute :description, RequestDescription.optional.meta(omittable: true)
       attribute(:identification, RequestIdentification.default { RequestIdentification.new })
       attribute :structural, RequestDROStructural.optional.meta(omittable: true)

data/lib/cocina/models/request_file.rb

@@ -5,7 +5,7 @@ module Cocina
     class RequestFile < Struct
       include Checkable
 
-      TYPES = ['http://cocina.sul.stanford.edu/models/file.jsonld'].freeze
+      TYPES = ['https://cocina.sul.stanford.edu/models/file'].freeze
 
       attribute :type, Types::Strict::String.enum(*RequestFile::TYPES)
       attribute :label, Types::Strict::String

data/lib/cocina/models/request_file_set.rb

@@ -5,22 +5,22 @@ module Cocina
     class RequestFileSet < Struct
       include Checkable
 
-      TYPES = ['http://cocina.sul.stanford.edu/models/resources/audio.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/attachment.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/document.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/file.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/image.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/main-augmented.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/main-original.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/media.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/object.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/page.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/permissions.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/preview.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/supplement.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/3d.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/thumb.jsonld',
-               'http://cocina.sul.stanford.edu/models/resources/video.jsonld'].freeze
+      TYPES = ['https://cocina.sul.stanford.edu/models/resources/audio',
+               'https://cocina.sul.stanford.edu/models/resources/attachment',
+               'https://cocina.sul.stanford.edu/models/resources/document',
+               'https://cocina.sul.stanford.edu/models/resources/file',
+               'https://cocina.sul.stanford.edu/models/resources/image',
+               'https://cocina.sul.stanford.edu/models/resources/main-augmented',
+               'https://cocina.sul.stanford.edu/models/resources/main-original',
+               'https://cocina.sul.stanford.edu/models/resources/media',
+               'https://cocina.sul.stanford.edu/models/resources/object',
+               'https://cocina.sul.stanford.edu/models/resources/page',
+               'https://cocina.sul.stanford.edu/models/resources/permissions',
+               'https://cocina.sul.stanford.edu/models/resources/preview',
+               'https://cocina.sul.stanford.edu/models/resources/supplement',
+               'https://cocina.sul.stanford.edu/models/resources/3d',
+               'https://cocina.sul.stanford.edu/models/resources/thumb',
+               'https://cocina.sul.stanford.edu/models/resources/video'].freeze
 
       attribute :type, Types::Strict::String.enum(*RequestFileSet::TYPES)
       attribute :label, Types::Strict::String

data/lib/cocina/models/stanford_access.rb

@@ -4,11 +4,11 @@ module Cocina
   module Models
     class StanfordAccess < Struct
       # Access level.
-      attribute :access, Types::Strict::String.enum('stanford')
+      attribute :view, Types::Strict::String.enum('stanford')
       # Download access level.
       attribute :download, Types::Strict::String.enum('stanford')
-      # If access is "location-based", which location should have access.
-      attribute :readLocation, Types::Strict::String.optional.enum('').meta(omittable: true)
+      # Not used for this access type, must be null.
+      attribute :location, Types::Strict::String.optional.enum('').meta(omittable: true)
       attribute :controlledDigitalLending, Types::Strict::Bool.enum(false).meta(omittable: true)
     end
   end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.67.1'
+    VERSION = '0.68.0'
   end
 end

data/lib/cocina/models/world_access.rb

@@ -4,11 +4,11 @@ module Cocina
   module Models
     class WorldAccess < Struct
       # Access level.
-      attribute :access, Types::Strict::String.enum('world')
+      attribute :view, Types::Strict::String.enum('world')
       # Download access level.
       attribute :download, Types::Strict::String.enum('none', 'stanford', 'world')
-      # If access is "location-based", which location should have access.
-      attribute :readLocation, Types::Strict::String.optional.enum('').meta(omittable: true)
+      # Not used for this access type, must be null.
+      attribute :location, Types::Strict::String.optional.enum('').meta(omittable: true)
       attribute :controlledDigitalLending, Types::Strict::Bool.enum(false).meta(omittable: true)
     end
   end

data/lib/cocina/models.rb

@@ -42,7 +42,7 @@ module Cocina
     # Raised when the type attribute is not valid.
     class UnknownTypeError < Error; end
 
-    # Raised when an error occurs validating against openapi.
+    # Raised when the type attribute is missing or an error occurs validating against openapi.
     class ValidationError < Error; end
 
     # Base class for Cocina Structs
@@ -60,10 +60,10 @@ module Cocina
     # @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
+    # @raises [ValidationError] if a type field cannot be found in the data
     # @raises [ValidationError] if hash representation fails openapi validation
     def self.build(dyn, validate: true)
-      clazz = case dyn.fetch('type')
+      clazz = case type_for(dyn)
               when *DRO::TYPES
                 DRO
               when *Collection::TYPES
@@ -71,7 +71,7 @@ module Cocina
               when *AdminPolicy::TYPES
                 AdminPolicy
               else
-                raise UnknownTypeError, "Unknown type: '#{dyn.fetch('type')}'"
+                raise UnknownTypeError, "Unknown type: '#{dyn.with_indifferent_access.fetch('type')}'"
               end
       clazz.new(dyn, false, validate)
     end
@@ -80,10 +80,10 @@ module Cocina
     # @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
+    # @raises [ValidationError] if a type field cannot be found in the data
     # @raises [ValidationError] if hash representation fails openapi validation
     def self.build_request(dyn, validate: true)
-      clazz = case dyn.fetch('type')
+      clazz = case type_for(dyn)
               when *DRO::TYPES
                 RequestDRO
               when *Collection::TYPES
@@ -91,9 +91,16 @@ module Cocina
               when *AdminPolicy::TYPES
                 RequestAdminPolicy
               else
-                raise UnknownTypeError, "Unknown type: '#{dyn.fetch('type')}'"
+                raise UnknownTypeError, "Unknown type: '#{dyn.with_indifferent_access.fetch('type')}'"
               end
       clazz.new(dyn, false, validate)
     end
+
+    def self.type_for(dyn)
+      dyn.with_indifferent_access.fetch('type')
+    rescue KeyError
+      raise ValidationError, 'Type field not found'
+    end
+    private_class_method :type_for
   end
 end