cocina-models 0.55.0 → 0.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbed8aec9255570088565182862681d94908cb165e5f6be489ad103052a5f708
-  data.tar.gz: 526b172620cbe31ea3ca59871d0ed0a816bec3c01726214fd3634bf54ec24eba
+  metadata.gz: 352ed5623ee930889067e73d3d306dcdd552cc37cd5234c1a63b587d4c203721
+  data.tar.gz: a7bc8f6b3162e3e72eda861a99bf3e06fe0e94f8a94b0be155922848ba0aff24
 SHA512:
-  metadata.gz: 6a555879230729f246d468589fb3e5ec261cebc36ae17d1282b663ef1b0ff0a5bd4afc9e9ee9688978da98bf20e7f709f989a6b46934a103ad0fabe40ee2353a
-  data.tar.gz: 332f3a59c67779ccb81340a352baa9894e9c3c76cbf5ff2bed383b501c5ff9ec7fb6e1d80aa3610b9a3ee289448a6b93e59e50345bd97b7f9279acf684191db3
+  metadata.gz: 8527592a36ba28a38d00086db7e3f37e5aaed274d98b65a8c71a5b8cd3b3c9e7da8fb1f29ca5c213f62bc278e42253c5a3cf955ad10918bc009b444170e3ef6d
+  data.tar.gz: 676a84548def7a9993383f356e3315d440ebec5dfd5efad611be323fed8aee543d1669520779ffa6555a836da5d0fb2ced503099651da96b2039d39db5af4c02

data/lib/cocina/generator/schema.rb

@@ -96,7 +96,7 @@ module Cocina
         doc.properties.map do |key, properties_doc|
           property_class_for(properties_doc).new(properties_doc,
                                                  key: key,
-                                                 required: doc.requires?(properties_doc),
+                                                 required: doc.requires?(key),
                                                  parent: self)
         end
       end

data/lib/cocina/models/access.rb

@@ -7,6 +7,11 @@ module Cocina
       attribute :access, Types::Strict::String.default('dark').enum('world', 'stanford', 'location-based', 'citation-only', 'dark').meta(omittable: true)
       # If access is "location-based", which location should have access.
       attribute :readLocation, Types::Strict::String.enum('spec', 'music', 'ars', 'art', 'hoover', 'm&m').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)
+      # The license governing reuse of the Collection. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
+      attribute :license, Types::Strict::String.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/admin_policy_administrative.rb

@@ -3,14 +3,19 @@
 module Cocina
   module Models
     class AdminPolicyAdministrative < Struct
+      # This is an XML expression of the default access (see defaultAccess)
       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 :defaultAccess, DROAccess.optional.meta(omittable: true)
       attribute :registrationWorkflow, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
       # An additional workflow to start for objects managed by this admin policy once the end-accession workflow step is complete
       # example: wasCrawlPreassemblyWF
       attribute :disseminationWorkflow, Types::Strict::String.meta(omittable: true)
       attribute :collectionsForRegistration, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
-      attribute :roles, Types::Strict::Array.of(AccessRole).meta(omittable: true)
+      # example: druid:bc123df4567
       attribute :hasAdminPolicy, Types::Strict::String
+      # example: druid:bc123df4567
+      attribute :referencesAgreement, Types::Strict::String.meta(omittable: true)
+      attribute :roles, Types::Strict::Array.of(AccessRole).meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/admin_policy_default_access.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class AdminPolicyDefaultAccess < Struct
+      attribute :access, Types::Strict::String.enum('world', 'stanford', 'location-based', 'citation-only', 'dark').meta(omittable: true)
+      # Available for controlled digital lending.
+      attribute :controlledDigitalLending, Types::Strict::Bool.meta(omittable: true)
+      # The human readable copyright statement that applies
+      # example: Copyright World Trade Organization
+      attribute :copyright, Types::Strict::String.meta(omittable: true)
+      attribute :embargo, Embargo.optional.meta(omittable: true)
+      # Download access level. This is used in the transition from Fedora as a way to set a default download level at registration that is copied down to all the files.
+
+      attribute :download, Types::Strict::String.enum('world', 'stanford', 'location-based', 'none').meta(omittable: true)
+      # If access is "location-based", which location should have access. This is used in the transition from Fedora as a way to set a default readLocation at registration that is copied down to all the files.
+
+      attribute :readLocation, Types::Strict::String.enum('spec', 'music', 'ars', 'art', 'hoover', 'm&m').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)
+      # The license governing reuse of the Collection. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
+      attribute :license, Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/business_barcode.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    BusinessBarcode = Types::String.constrained(
+      format: /^2050[0-9]{7}$/i
+    )
+  end
+end

data/lib/cocina/models/catkey_barcode.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    CatkeyBarcode = Types::String.constrained(
+      format: /^[0-9]+-[0-9]+$/i
+    )
+  end
+end

data/lib/cocina/models/dro_access.rb

@@ -19,6 +19,8 @@ module Cocina
       # 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)
+      # The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
+      attribute :license, Types::Strict::String.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/identification.rb

@@ -8,6 +8,8 @@ module Cocina
       # 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/request_identification.rb

@@ -8,6 +8,8 @@ module Cocina
       # 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/standard_barcode.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    StandardBarcode = Types::String.constrained(
+      format: /^36105[0-9]{9}$/i
+    )
+  end
+end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.55.0'
+    VERSION = '0.56.0'
   end
 end

data/openapi.yml

@@ -118,6 +118,13 @@ components:
             - 'art'
             - 'hoover'
             - 'm&m'
+        useAndReproductionStatement:
+          description: 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).
+          type: string
+        license:
+          description: The license governing reuse of the Collection. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
+          type: string
     AccessRole:
       description: Access role conferred by an AdminPolicy to objects within it. (used by Argo)
       type: object
@@ -214,7 +221,11 @@ components:
       properties:
         defaultObjectRights:
           type: string
+          description: This is an XML expression of the default access (see defaultAccess)
+          deprecated: true
           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>
+        defaultAccess:
+          $ref: '#/components/schemas/DROAccess'
         registrationWorkflow:
           description: When you register an item with this admin policy, these are the workflows that are available.
           type: array
@@ -229,15 +240,72 @@ components:
           type: array
           items:
             type: string
+        hasAdminPolicy:
+          $ref: '#/components/schemas/Druid'
+        referencesAgreement:
+          $ref: '#/components/schemas/Druid'
         roles:
           description: The access roles conferred by this AdminPolicy (used by Argo)
           type: array
           items:
             $ref: '#/components/schemas/AccessRole'
-        hasAdminPolicy:
-          type: string
       required:
         - hasAdminPolicy
+    AdminPolicyDefaultAccess:
+      description: 'Provides the default access settings for an AdminPolicy. This is almost the same as DROAccess, but it provides no defaults.'
+      type: object
+      additionalProperties: false
+      properties:
+        access:
+          type: string
+          enum:
+            - 'world'
+            - 'stanford'
+            - 'location-based'
+            - 'citation-only'
+            - 'dark'
+        controlledDigitalLending:
+          description: Available for controlled digital lending.
+          type: boolean
+        copyright:
+          description: The human readable copyright statement that applies
+          example: Copyright World Trade Organization
+          type: string
+        embargo:
+          $ref: '#/components/schemas/Embargo'
+        download:
+          description: >
+            Download access level. This is used in the transition from Fedora as
+            a way to set a default download level at registration that is copied
+            down to all the files.
+
+          type: string
+          enum:
+            - 'world'
+            - 'stanford'
+            - 'location-based'
+            - 'none'
+        readLocation:
+          description: >
+            If access is "location-based", which location should have access.
+            This is used in the transition from Fedora as a way to set a default
+            readLocation at registration that is copied down to all the files.
+
+          type: string
+          enum:
+            - 'spec'
+            - 'music'
+            - 'ars'
+            - 'art'
+            - 'hoover'
+            - 'm&m'
+        useAndReproductionStatement:
+          description: 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).
+          type: string
+        license:
+          description: The license governing reuse of the Collection. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
+          type: string
     AppliesTo:
       description: Property model for indicating the parts, aspects, or versions of the resource to which a
         descriptive element is applicable.
@@ -248,6 +316,17 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/DescriptiveBasicValue"
+    Barcode:
+      description: 'A barcode'
+      oneOf:
+        - $ref: '#/components/schemas/BusinessBarcode'
+        - $ref: '#/components/schemas/CatkeyBarcode'
+        - $ref: '#/components/schemas/StandardBarcode'
+    BusinessBarcode:
+      description: The barcode associated with a business library DRO object, prefixed with 2050
+      type: string
+      pattern: '^2050[0-9]{7}$'
+      example: 20503740296
     CatalogLink:
       type: object
       additionalProperties: false
@@ -263,6 +342,11 @@ components:
           description: Record identifier that is unique within the context of the linked record's catalog.
           type: string
           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
     Collection:
       description: A group of Digital Repository Objects that indicate some type of conceptual grouping within the domain that is worth reusing across the system.
       type: object
@@ -809,6 +893,9 @@ components:
           description: 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).
           type: string
+        license:
+          description: The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
+          type: string
     DROStructural:
       description: Structural metadata
       type: object
@@ -1083,6 +1170,8 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/CatalogLink'
+        barcode:
+          $ref: '#/components/schemas/Barcode'
     Language:
       description: Languages, scripts, symbolic systems, and notations used in all
         or part of a resource or its descriptive metadata.
@@ -1502,6 +1591,8 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/CatalogLink'
+        barcode:
+          $ref: '#/components/schemas/Barcode'
       required:
         - sourceId
     Sequence:
@@ -1581,6 +1672,11 @@ components:
           type: string
         source:
           $ref: "#/components/schemas/Source"
+    StandardBarcode:
+      description: The standard barcode associated with a DRO object, prefixed with 36105
+      type: string
+      pattern: '^36105[0-9]{9}$'
+      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.55.0
+  version: 0.56.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -258,9 +258,12 @@ files:
 - lib/cocina/models/access_role_member.rb
 - lib/cocina/models/admin_policy.rb
 - lib/cocina/models/admin_policy_administrative.rb
+- lib/cocina/models/admin_policy_default_access.rb
 - lib/cocina/models/administrative.rb
 - lib/cocina/models/applies_to.rb
+- lib/cocina/models/business_barcode.rb
 - lib/cocina/models/catalog_link.rb
+- lib/cocina/models/catkey_barcode.rb
 - lib/cocina/models/checkable.rb
 - lib/cocina/models/collection.rb
 - lib/cocina/models/collection_identification.rb
@@ -307,6 +310,7 @@ files:
 - lib/cocina/models/source.rb
 - lib/cocina/models/source_id.rb
 - lib/cocina/models/standard.rb
+- lib/cocina/models/standard_barcode.rb
 - lib/cocina/models/title.rb
 - lib/cocina/models/validator.rb
 - lib/cocina/models/version.rb
@@ -330,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Data models for the SDR