cocina-models 0.60.0 → 0.61.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 351185ae4a546fbe541c76edd5125bb4a0d7cb369c896e277c66eeda2212e7ce
-  data.tar.gz: 679fe34dd4861bb1627c38cba2fc1e84bfc5a1600e03be35dcedf52dfad3a80e
+  metadata.gz: 4303e7447ac07d23ba4075ed7a9ff66a098cf95f2b397fffee3cdd1a6f86a9b1
+  data.tar.gz: 5535dc06f87a9fd75490c71eae76a5db211a5a055e84956a2775c14703a9033e
 SHA512:
-  metadata.gz: 78190242ee4ba071e54fa5c0f22344fae84819ebd2c80366feabebb727ae363775252a447f2df89fad1735e79c2a4bbd3f5e089058a4f93f9ba1a98698891751
-  data.tar.gz: 72ab93abf8793848204471e7020ab610c16546b4c9586542456d60d95837f906e4e0d079976ac0acd9d07753d8bc14c4153b1b9239ec205ff77a54144e12cd30
+  metadata.gz: ccb5589caceaea881e141bb1c152fffa638b23c095a38cf8d3c767b063cc963727f91dc6f55dbf501f1df5e05e41f6ee501e71ea823bd7858fbbfedc85449e56
+  data.tar.gz: 7352328c35d6c5bb1e479545712b5d5d5355cfa73e06fe6961b7fdf3e47b620641cf0dc265b51c37915758117d86eee8ddf9fae42b7aeaf1287ae694e9a550c1

data/README.md

@@ -72,6 +72,7 @@ Once the above listed steps have been completed, all the following applications
 * [sul-dlss/google-books](https://github.com/sul-dlss/google-books/)
 * [sul-dlss/argo](https://github.com/sul-dlss/argo/)
 * [sul-dlss/pre-assembly](https://github.com/sul-dlss/pre-assembly/)
+* [sul-dlss/hydra_etd](https://github.com/sul-dlss/hydra_etd/)
 * [sul-dlss/hydrus](https://github.com/sul-dlss/hydrus/)
 * [sul-dlss/happy-heron](https://github.com/sul-dlss/happy-heron/)
 * [sul-dlss/infrastructure-integration-test](https://github.com/sul-dlss/infrastructure-integration-test/)

data/lib/cocina/models.rb

@@ -14,27 +14,19 @@ require 'thor'
 
 # Help Zeitwerk find some of our classes
 class CocinaModelsInflector < Zeitwerk::Inflector
-  # rubocop:disable Metrics/MethodLength
+  INFLECTIONS = {
+    'doi' => 'DOI',
+    'dro' => 'DRO',
+    'request_dro' => 'RequestDRO',
+    'dro_access' => 'DROAccess',
+    'dro_structural' => 'DROStructural',
+    'request_dro_structural' => 'RequestDROStructural',
+    'version' => 'VERSION'
+  }.freeze
+
   def camelize(basename, _abspath)
-    case basename
-    when 'dro'
-      'DRO'
-    when 'request_dro'
-      'RequestDRO'
-    when 'dro_access'
-      'DROAccess'
-    when 'dro_structural'
-      'DROStructural'
-    when 'request_dro_structural'
-      'RequestDROStructural'
-    when 'version'
-      'VERSION'
-    else
-      super
-    end
+    INFLECTIONS.fetch(basename) { super }
   end
-
-  # rubocop:enable Metrics/MethodLength
 end
 
 loader = Zeitwerk::Loader.new

data/lib/cocina/models/admin_policy.rb

@@ -7,7 +7,6 @@ module Cocina
 
       TYPES = ['http://cocina.sul.stanford.edu/models/admin_policy.jsonld'].freeze
 
-      # example: item
       attribute :type, Types::Strict::String.enum(*AdminPolicy::TYPES)
       # example: druid:bc123df4567
       attribute :externalIdentifier, Types::Strict::String

data/lib/cocina/models/collection.rb

@@ -12,7 +12,6 @@ module Cocina
                'http://cocina.sul.stanford.edu/models/series.jsonld'].freeze
 
       # 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

data/lib/cocina/models/collection_identification.rb

@@ -3,11 +3,11 @@
 module Cocina
   module Models
     class CollectionIdentification < Struct
+      attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).meta(omittable: true)
       # Unique identifier in some other system. This is because a large proportion of what is deposited in SDR, historically and currently, are representations of objects that are also represented in other systems. For example, digitized paper and A/V collections have physical manifestations, and those physical objects are managed in systems that have their own identifiers. Similarly, books have barcodes, archival materials have collection numbers and physical locations, etc. The sourceId allows determining if an item has been deposited before and where to look for the original item if you're looking at its SDR representation. The format is: "namespace:identifier"
 
       # 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/description.rb

@@ -12,7 +12,7 @@ module Cocina
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :subject, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
-      # Stanford persistent URL associated with the resource.
+      # Stanford persistent URL associated with the related resource. Note this is http, not https.
       attribute :purl, Types::Strict::String.meta(omittable: true)
       attribute :access, DescriptiveAccessMetadata.optional.meta(omittable: true)
       attribute :relatedResource, Types::Strict::Array.of(RelatedResource).meta(omittable: true)

data/lib/cocina/models/doi.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    DOI = Types::String.constrained(
+      format: %r{^10\.(25740|80343)/[b-df-hjkmnp-tv-z]{2}[0-9]{3}[b-df-hjkmnp-tv-z]{2}[0-9]{4}$}i
+    )
+  end
+end

data/lib/cocina/models/dro.rb

@@ -22,7 +22,6 @@ module Cocina
                '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

data/lib/cocina/models/identification.rb

@@ -3,13 +3,16 @@
 module Cocina
   module Models
     class Identification < Struct
+      # A barcode
+      attribute :barcode, Types::Nominal::Any.meta(omittable: true)
+      attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).meta(omittable: true)
+      # Digital Object Identifier (https://www.doi.org)
+      # example: 10.25740/druid:bc123df4567
+      attribute :doi, Types::Strict::String.meta(omittable: true)
       # Unique identifier in some other system. This is because a large proportion of what is deposited in SDR, historically and currently, are representations of objects that are also represented in other systems. For example, digitized paper and A/V collections have physical manifestations, and those physical objects are managed in systems that have their own identifiers. Similarly, books have barcodes, archival materials have collection numbers and physical locations, etc. The sourceId allows determining if an item has been deposited before and where to look for the original item if you're looking at its SDR representation. The format is: "namespace:identifier"
 
       # 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)
-      # A barcode
-      attribute :barcode, Types::Nominal::Any.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/purl.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    Purl = Types::String.constrained(
+      format: %r{^http://}i
+    )
+  end
+end

data/lib/cocina/models/related_resource.rb

@@ -18,7 +18,7 @@ module Cocina
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :standard, Standard.optional.meta(omittable: true)
       attribute :subject, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
-      # Stanford persistent URL associated with the related resource.
+      # Stanford persistent URL associated with the related resource. Note this is http, not https.
       attribute :purl, Types::Strict::String.meta(omittable: true)
       attribute :access, DescriptiveAccessMetadata.optional.meta(omittable: true)
       attribute :relatedResource, Types::Strict::Array.of(RelatedResource).meta(omittable: true)

data/lib/cocina/models/request_admin_policy.rb

@@ -7,7 +7,6 @@ module Cocina
 
       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

data/lib/cocina/models/request_collection.rb

@@ -11,7 +11,6 @@ module Cocina
                '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

data/lib/cocina/models/request_dro.rb

@@ -21,7 +21,6 @@ module Cocina
                'http://cocina.sul.stanford.edu/models/webarchive-binary.jsonld',
                'http://cocina.sul.stanford.edu/models/webarchive-seed.jsonld'].freeze
 
-      # example: item
       attribute :type, Types::Strict::String.enum(*RequestDRO::TYPES)
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer

data/lib/cocina/models/request_identification.rb

@@ -3,13 +3,13 @@
 module Cocina
   module Models
     class RequestIdentification < Struct
+      # A barcode
+      attribute :barcode, Types::Nominal::Any.meta(omittable: true)
+      attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).meta(omittable: true)
       # Unique identifier in some other system. This is because a large proportion of what is deposited in SDR, historically and currently, are representations of objects that are also represented in other systems. For example, digitized paper and A/V collections have physical manifestations, and those physical objects are managed in systems that have their own identifiers. Similarly, books have barcodes, archival materials have collection numbers and physical locations, etc. The sourceId allows determining if an item has been deposited before and where to look for the original item if you're looking at its SDR representation. The format is: "namespace:identifier"
 
       # 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)
-      # A barcode
-      attribute :barcode, Types::Nominal::Any.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.60.0'
+    VERSION = '0.61.3'
   end
 end

data/openapi.yml

@@ -176,7 +176,6 @@ components:
           type: string
           enum:
             - 'http://cocina.sul.stanford.edu/models/admin_policy.jsonld'
-          example: item
         externalIdentifier:
           $ref: '#/components/schemas/Druid'
         label:
@@ -308,12 +307,12 @@ components:
       description: The barcode associated with a business library DRO object, prefixed with 2050
       type: string
       pattern: '^2050[0-9]{7}$'
-      example: 20503740296
+      example: '20503740296'
     LaneMedicalBarcode:
       description: The barcode associated with a Lane Medical Library DRO object, prefixed with 245
       type: string
       pattern: '^245[0-9]{8}$'
-      example: 24503259768
+      example: '24503259768'
     CatalogLink:
       type: object
       additionalProperties: false
@@ -328,12 +327,12 @@ components:
         catalogRecordId:
           description: Record identifier that is unique within the context of the linked record's catalog.
           type: string
-          example: 11403803
+          example: '11403803'
     CatkeyBarcode:
       description: The barcode associated with a DRO object based on catkey, prefixed with 36105
       type: string
       pattern: '^[0-9]+-[0-9]+$'
-      example: 6772719-1001
+      example: '6772719-1001'
     CitationOnlyAccess:
       type: object
       properties:
@@ -375,7 +374,6 @@ components:
             - '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'
-          example: item
         externalIdentifier:
           $ref: '#/components/schemas/Druid'
         label:
@@ -426,12 +424,12 @@ components:
       type: object
       additionalProperties: false
       properties:
-        sourceId:
-          $ref: '#/components/schemas/SourceId'
         catalogLinks:
           type: array
           items:
             $ref: '#/components/schemas/CatalogLink'
+        sourceId:
+          $ref: '#/components/schemas/SourceId'
     Contributor:
       description: Property model for describing agents contributing in some way to
         the creation and history of the resource.
@@ -582,9 +580,7 @@ components:
           items:
             $ref: "#/components/schemas/DescriptiveValue"
         purl:
-          description: Stanford persistent URL associated with the resource.
-          type: string
-          format: uri
+          $ref: "#/components/schemas/Purl"
         access:
           $ref: "#/components/schemas/DescriptiveAccessMetadata"
         relatedResource:
@@ -879,6 +875,12 @@ components:
               $ref: '#/components/schemas/Standard'
               # description: An alphabet or other notation used to represent a
               #   language or other symbolic system of the descriptive element value.
+    DOI:
+      type: string
+      description: Digital Object Identifier (https://www.doi.org)
+      # The prod and test prefixes are permitted
+      pattern: '^10\.(25740|80343)\/[b-df-hjkmnp-tv-z]{2}[0-9]{3}[b-df-hjkmnp-tv-z]{2}[0-9]{4}$'
+      example: '10.25740/bc123df4567'
     DRO:
       description: Domain-defined abstraction of a 'work'. Digital Repository Objects' abstraction is describable for our domain’s purposes, i.e. for management needs within our system.
       type: object
@@ -903,7 +905,6 @@ components:
             - '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'
-          example: item
         externalIdentifier:
           $ref: '#/components/schemas/Druid'
         label:
@@ -953,36 +954,36 @@ components:
               description: The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
               type: string
               enum:
-                - https://www.gnu.org/licenses/agpl.txt
-                - https://www.apache.org/licenses/LICENSE-2.0
-                - https://opensource.org/licenses/BSD-2-Clause
-                - https://opensource.org/licenses/BSD-3-Clause
-                - https://creativecommons.org/licenses/by/4.0/legalcode
-                - https://creativecommons.org/licenses/by-nc/4.0/legalcode
-                - https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode
-                - https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode
-                - https://creativecommons.org/licenses/by-nd/4.0/legalcode
-                - https://creativecommons.org/licenses/by-sa/4.0/legalcode
-                - https://creativecommons.org/publicdomain/zero/1.0/legalcode
-                - https://opensource.org/licenses/cddl1
-                - https://www.eclipse.org/legal/epl-2.0
-                - https://www.gnu.org/licenses/gpl-3.0-standalone.html
-                - https://www.isc.org/downloads/software-support-policy/isc-license/
-                - https://www.gnu.org/licenses/lgpl-3.0-standalone.html
-                - https://opensource.org/licenses/MIT
-                - https://www.mozilla.org/MPL/2.0/
-                - https://opendatacommons.org/licenses/by/1-0/
-                - http://opendatacommons.org/licenses/odbl/1.0/ # Non cannonical, but in some of our data
-                - https://opendatacommons.org/licenses/odbl/1-0/
-                - https://creativecommons.org/publicdomain/mark/1.0/
-                - https://opendatacommons.org/licenses/pddl/1-0/
-                - https://creativecommons.org/licenses/by/3.0/legalcode
-                - https://creativecommons.org/licenses/by-sa/3.0/legalcode
-                - https://creativecommons.org/licenses/by-nd/3.0/legalcode
-                - https://creativecommons.org/licenses/by-nc/3.0/legalcode
-                - https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode
-                - https://creativecommons.org/licenses/by-nc-nd/3.0/legalcode
-                - http://cocina.sul.stanford.edu/licenses/none # Only used in some legacy ETDs and not actually permitted per the Project Chimera docs.
+                - 'https://www.gnu.org/licenses/agpl.txt'
+                - 'https://www.apache.org/licenses/LICENSE-2.0'
+                - 'https://opensource.org/licenses/BSD-2-Clause'
+                - 'https://opensource.org/licenses/BSD-3-Clause'
+                - 'https://creativecommons.org/licenses/by/4.0/legalcode'
+                - 'https://creativecommons.org/licenses/by-nc/4.0/legalcode'
+                - 'https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode'
+                - 'https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode'
+                - 'https://creativecommons.org/licenses/by-nd/4.0/legalcode'
+                - 'https://creativecommons.org/licenses/by-sa/4.0/legalcode'
+                - 'https://creativecommons.org/publicdomain/zero/1.0/legalcode'
+                - 'https://opensource.org/licenses/cddl1'
+                - 'https://www.eclipse.org/legal/epl-2.0'
+                - 'https://www.gnu.org/licenses/gpl-3.0-standalone.html'
+                - 'https://www.isc.org/downloads/software-support-policy/isc-license/'
+                - 'https://www.gnu.org/licenses/lgpl-3.0-standalone.html'
+                - 'https://opensource.org/licenses/MIT'
+                - 'https://www.mozilla.org/MPL/2.0/'
+                - 'https://opendatacommons.org/licenses/by/1-0/'
+                - 'http://opendatacommons.org/licenses/odbl/1.0/' # Non cannonical, but in some of our data
+                - 'https://opendatacommons.org/licenses/odbl/1-0/'
+                - 'https://creativecommons.org/publicdomain/mark/1.0/'
+                - 'https://opendatacommons.org/licenses/pddl/1-0/'
+                - 'https://creativecommons.org/licenses/by/3.0/legalcode'
+                - 'https://creativecommons.org/licenses/by-sa/3.0/legalcode'
+                - 'https://creativecommons.org/licenses/by-nd/3.0/legalcode'
+                - 'https://creativecommons.org/licenses/by-nc/3.0/legalcode'
+                - 'https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode'
+                - 'https://creativecommons.org/licenses/by-nc-nd/3.0/legalcode'
+                - 'http://cocina.sul.stanford.edu/licenses/none' # Only used in some legacy ETDs and not actually permitted per the Project Chimera docs.
     DROStructural:
       description: Structural metadata
       type: object
@@ -1218,14 +1219,16 @@ components:
       type: object
       additionalProperties: false
       properties:
-        sourceId:
-          $ref: '#/components/schemas/SourceId'
+        barcode:
+          $ref: '#/components/schemas/Barcode'
         catalogLinks:
           type: array
           items:
             $ref: '#/components/schemas/CatalogLink'
-        barcode:
-          $ref: '#/components/schemas/Barcode'
+        doi:
+          $ref: '#/components/schemas/DOI'
+        sourceId:
+          $ref: '#/components/schemas/SourceId'
     Language:
       description: Languages, scripts, symbolic systems, and notations used in all
         or part of a resource or its descriptive metadata.
@@ -1389,6 +1392,12 @@ components:
         width:
           description: Width in pixels
           type: integer
+    Purl:
+      description: Stanford persistent URL associated with the related resource. Note this is http, not https.
+      type: string
+      format: uri
+      # Canonical URI is http, even though this redirects to https.
+      pattern: '^http:\/\/'
     RelatedResource:
       description: Other resource associated with the described resource.
       type: object
@@ -1450,9 +1459,7 @@ components:
           items:
             $ref: "#/components/schemas/DescriptiveValue"
         purl:
-          description: Stanford persistent URL associated with the related resource.
-          type: string
-          format: uri
+          $ref: "#/components/schemas/Purl"
         access:
           $ref: "#/components/schemas/DescriptiveAccessMetadata"
         relatedResource:
@@ -1505,7 +1512,6 @@ components:
           type: string
           enum:
             - 'http://cocina.sul.stanford.edu/models/admin_policy.jsonld'
-          example: item
         label:
           type: string
         version:
@@ -1532,7 +1538,6 @@ components:
             - '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'
-          example: item
         label:
           type: string
         version:
@@ -1574,7 +1579,6 @@ components:
             - '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'
-          example: item
         label:
           type: string
         version:
@@ -1701,18 +1705,20 @@ components:
           items:
             $ref: '#/components/schemas/RequestFile'
     RequestIdentification:
-      description: Same as a Identification, but requires a sourceId.
+      # Doesn't permit a DOI because our DOIs all use the DRUID as part of the DOI.
+      # You have to register the object in order to get the DRUID before you can mint a DOI
+      description: Same as a Identification, but requires a sourceId and doesn't permit a DOI.
       type: object
       additionalProperties: false
       properties:
-        sourceId:
-          $ref: '#/components/schemas/SourceId'
+        barcode:
+          $ref: '#/components/schemas/Barcode'
         catalogLinks:
           type: array
           items:
             $ref: '#/components/schemas/CatalogLink'
-        barcode:
-          $ref: '#/components/schemas/Barcode'
+        sourceId:
+          $ref: '#/components/schemas/SourceId'
       required:
         - sourceId
     Sequence:
@@ -1796,7 +1802,7 @@ components:
       description: The standard barcode associated with a DRO object, prefixed with 36105
       type: string
       pattern: '^36105[0-9]{9}$'
-      example: 36105010362304
+      example: '36105010362304'
     Title:
       type: object
       additionalProperties: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.60.0
+  version: 0.61.3
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2021-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -284,6 +284,7 @@ files:
 - lib/cocina/models/descriptive_structured_value.rb
 - lib/cocina/models/descriptive_value.rb
 - lib/cocina/models/descriptive_value_language.rb
+- lib/cocina/models/doi.rb
 - lib/cocina/models/dro.rb
 - lib/cocina/models/dro_access.rb
 - lib/cocina/models/dro_structural.rb
@@ -303,6 +304,7 @@ files:
 - lib/cocina/models/location_based_download_access.rb
 - lib/cocina/models/message_digest.rb
 - lib/cocina/models/presentation.rb
+- lib/cocina/models/purl.rb
 - lib/cocina/models/related_resource.rb
 - lib/cocina/models/release_tag.rb
 - lib/cocina/models/request_admin_policy.rb