cocina-models 0.56.0 → 0.58.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 352ed5623ee930889067e73d3d306dcdd552cc37cd5234c1a63b587d4c203721
-  data.tar.gz: a7bc8f6b3162e3e72eda861a99bf3e06fe0e94f8a94b0be155922848ba0aff24
+  metadata.gz: 373c87def65c96c5e54fca772ded4c486a26ed1ed2ec5679e4d1f4483241d950
+  data.tar.gz: 58fd159bc6341d831d42ffd59cb7c42ff8fb0643c87c724753e69c100ec271f4
 SHA512:
-  metadata.gz: 8527592a36ba28a38d00086db7e3f37e5aaed274d98b65a8c71a5b8cd3b3c9e7da8fb1f29ca5c213f62bc278e42253c5a3cf955ad10918bc009b444170e3ef6d
-  data.tar.gz: 676a84548def7a9993383f356e3315d440ebec5dfd5efad611be323fed8aee543d1669520779ffa6555a836da5d0fb2ced503099651da96b2039d39db5af4c02
+  metadata.gz: 1ef5aec119f9230e8a274d2c97130c1c1fa421acf227f856613e7c2fb93542ef6f2af64b22e87b44448b6f428b37ba9e091bc1ed01acd16058f30329156e0d31
+  data.tar.gz: 759e9eee67dc7fc016727e0a4954c07c9d5d1a7a36b5f0eda210b26a12550112210bd7b0b8e59f0ab45e5a57b8e685fb377abb8a78ff74777ebbdc64c474c38a

data/lib/cocina/generator/schema.rb

@@ -97,6 +97,7 @@ module Cocina
           property_class_for(properties_doc).new(properties_doc,
                                                  key: key,
                                                  required: doc.requires?(key),
+                                                 nullable: properties_doc.nullable?,
                                                  parent: self)
         end
       end

data/lib/cocina/generator/schema_base.rb

@@ -4,12 +4,13 @@ module Cocina
   module Generator
     # Base class for generating from openapi
     class SchemaBase
-      attr_reader :schema_doc, :key, :required, :parent
+      attr_reader :schema_doc, :key, :required, :nullable, :parent
 
-      def initialize(schema_doc, key: nil, required: false, parent: nil)
+      def initialize(schema_doc, key: nil, required: false, nullable: false, parent: nil)
         @schema_doc = schema_doc
         @key = key
         @required = required
+        @nullable = nullable
         @parent = parent
       end
 
@@ -21,12 +22,20 @@ module Cocina
         key || schema_doc.name
       end
 
+      # Allows non-required values to not be provided. This allows smaller
+      # requests as not every field needs to be present.
       def omittable
         return '' if required
 
         '.meta(omittable: true)'
       end
 
+      # Allows nillable values to be set to nil. This is useful when doing
+      # an update and you want to clear out a value.
+      def optional
+        nullable ? '.optional' : ''
+      end
+
       def quote(item)
         return item unless schema_doc.type == 'string'
 

data/lib/cocina/generator/schema_value.rb

@@ -6,7 +6,8 @@ module Cocina
     class SchemaValue < SchemaBase
       # rubocop:disable Layout/LineLength
       def generate
-        "#{description}#{example}attribute :#{name.camelize(:lower)}, Types::#{dry_datatype(schema_doc)}#{default}#{enum}#{omittable}"
+        # optional has to come before default or the default value that gets set will be nil.
+        "#{description}#{example}attribute :#{name.camelize(:lower)}, Types::#{dry_datatype(schema_doc)}#{optional}#{default}#{enum}#{omittable}"
       end
       # rubocop:enable Layout/LineLength
 

data/lib/cocina/models/access.rb

@@ -5,6 +5,9 @@ module Cocina
     class Access < Struct
       # Access level
       attribute :access, Types::Strict::String.default('dark').enum('world', 'stanford', 'location-based', 'citation-only', 'dark').meta(omittable: true)
+      # The human readable copyright statement that applies
+      # example: Copyright World Trade Organization
+      attribute :copyright, Types::Strict::String.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

data/lib/cocina/models/admin_policy_administrative.rb

@@ -5,7 +5,7 @@ module Cocina
     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 :defaultAccess, AdminPolicyDefaultAccess.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

data/lib/cocina/models/admin_policy_default_access.rb

@@ -8,19 +8,18 @@ module Cocina
       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)
+      attribute :copyright, Types::Strict::String.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)
+      attribute :readLocation, Types::Strict::String.optional.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)
+      attribute :useAndReproductionStatement, Types::Strict::String.optional.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)
+      attribute :license, Types::Strict::String.optional.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/version.rb

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

data/openapi.yml

@@ -108,6 +108,10 @@ components:
             - 'citation-only'
             - 'dark'
           default: 'dark'
+        copyright:
+          description: The human readable copyright statement that applies
+          example: Copyright World Trade Organization
+          type: string
         readLocation:
           description: If access is "location-based", which location should have access.
           type: string
@@ -225,7 +229,7 @@ components:
           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'
+          $ref: '#/components/schemas/AdminPolicyDefaultAccess'
         registrationWorkflow:
           description: When you register an item with this admin policy, these are the workflows that are available.
           type: array
@@ -252,7 +256,7 @@ components:
       required:
         - hasAdminPolicy
     AdminPolicyDefaultAccess:
-      description: 'Provides the default access settings for an AdminPolicy. This is almost the same as DROAccess, but it provides no defaults.'
+      description: 'Provides the default access settings for an AdminPolicy. This is almost the same as DROAccess, but it provides no defaults and has no embargo.'
       type: object
       additionalProperties: false
       properties:
@@ -271,8 +275,7 @@ components:
           description: The human readable copyright statement that applies
           example: Copyright World Trade Organization
           type: string
-        embargo:
-          $ref: '#/components/schemas/Embargo'
+          nullable: true
         download:
           description: >
             Download access level. This is used in the transition from Fedora as
@@ -292,6 +295,7 @@ components:
             readLocation at registration that is copied down to all the files.
 
           type: string
+          nullable: true
           enum:
             - 'spec'
             - 'music'
@@ -303,9 +307,11 @@ 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
+          nullable: true
         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
+          nullable: true
     AppliesTo:
       description: Property model for indicating the parts, aspects, or versions of the resource to which a
         descriptive element is applicable.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.56.0
+  version: 0.58.2
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -334,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Data models for the SDR