cocina-models 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6579b5a67f571fcdc927fc706ede76393f43ebd308afa239c5af2b51d002cbc7
-  data.tar.gz: 3cf796d0d505cece4aa1f168ce3d7fdc5d3f3430cc452aec55678e0fad756c4f
+  metadata.gz: 4da1f34a862366edd3a370ae52e3d9cecb29dc1f1f4938196444db5071870a56
+  data.tar.gz: f8a2b7fc4d308bbf884a46b5f2c765f7989f2467a3749742faad34112a5b30d7
 SHA512:
-  metadata.gz: dfd14169ccf6c62d828642dd806030bc456f1838e3891b8205570f72782e47cbe3bc10b50fa175ae52bbaeafb5fd6b0bd9d756d42f08c22ef41075b682c9629b
-  data.tar.gz: 1503063b275634492bd6bd050c170989c01cd0051fa133bc2c9a6999b71eede591a1a3da7040d57f19ff62fe2c71f39d9c77cffbf59e1f4a510b2ee87d1d80f6
+  metadata.gz: b9ade72909e628f07fdbddd8ab673482410e92571897543b2266194ee5c5d060f3efc003dcf1431c0583ee73f6a31a06b1a4b0d93b9e2818b4ec169fb665bffc
+  data.tar.gz: fda63f0e397f9f9778e5ae957bc8bd9866038cb82d649f11e09d64d0d89d618878ddac1ade3659b5786ce83ab73605b56fdf874c34212edf2d7d054f5e24ea0d

data/.rubocop_todo.yml

@@ -1,18 +1,14 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-01-13 15:35:17 -0800 using RuboCop version 0.74.0.
+# on 2020-02-13 12:54:33 -0500 using RuboCop version 0.79.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-Metrics/AbcSize:
-  Max: 18
-
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: Max.
 RSpec/ExampleLength:
   Exclude:
     - 'spec/cocina/models/dro_spec.rb'
-    - 'spec/cocina/models/file_spec.rb'
+    - 'spec/cocina/models/request_dro_spec.rb'

data/README.md

@@ -22,10 +22,10 @@ cd docs
 prmd combine --meta meta.json  maps/ > schema.json
 
 # Check it’s all good
-$ prmd verify schema.json
+prmd verify schema.json
 
 # Build docs
-$ prmd doc schema.json > schema.md
+prmd doc schema.json > schema.md
 ```
 
 Then check in the resulting changes to `docs/schema.json` and `docs/schema.md`

data/docs/maps/DRO.json

@@ -86,10 +86,22 @@
           "type": "string",
           "enum": ["world", "stanford", "location-based", "citation-only", "dark"]
         },
-        "embargoReleaseDate": {
-          "description": "Date when the DRO is released from an embargo, if an embargo exists.",
-          "type": "string",
-          "format": "date-time"
+        "embargo": {
+          "description": "Embargo metadata",
+          "type": "object",
+          "required": ["releaseDate", "access"],
+          "properties": {
+            "releaseDate": {
+              "description": "Date when the DRO is released from an embargo.",
+              "type": "string",
+              "format": "date-time"
+            },
+            "access": {
+              "description": "Access level for the DRO when released from embargo.",
+              "type": "string",
+              "enum": ["world", "stanford", "location-based", "citation-only", "dark"]
+            }
+          }
         },
         "license": {
           "description": "The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).",

data/docs/schema.json

@@ -557,12 +557,37 @@
                 "dark"
               ]
             },
-            "embargoReleaseDate": {
-              "description": "Date when the DRO is released from an embargo, if an embargo exists.",
+            "embargo": {
+              "description": "Embargo metadata",
               "type": [
-                "string"
+                "object"
               ],
-              "format": "date-time"
+              "required": [
+                "releaseDate",
+                "access"
+              ],
+              "properties": {
+                "releaseDate": {
+                  "description": "Date when the DRO is released from an embargo.",
+                  "type": [
+                    "string"
+                  ],
+                  "format": "date-time"
+                },
+                "access": {
+                  "description": "Access level for the DRO when released from embargo.",
+                  "type": [
+                    "string"
+                  ],
+                  "enum": [
+                    "world",
+                    "stanford",
+                    "location-based",
+                    "citation-only",
+                    "dark"
+                  ]
+                }
+              }
             },
             "license": {
               "description": "The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).",

data/docs/schema.md

@@ -81,7 +81,8 @@ Domain-defined abstraction of a 'work'. Digital Repository Objects' abstraction
 | **access:access** | *string* | Access level for the DRO.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
 | **access:copyright** | *string* | The human readable copyright statement that applies to the DRO. | `"example"` |
 | **access:download** | *string* | Download level for the DRO metadata.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
-| **access:embargoReleaseDate** | *date-time* | Date when the DRO is released from an embargo, if an embargo exists. | `"2015-01-01T12:00:00Z"` |
+| **access:embargo:access** | *string* | Access level for the DRO when released from embargo.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
+| **access:embargo:releaseDate** | *date-time* | Date when the DRO is released from an embargo. | `"2015-01-01T12:00:00Z"` |
 | **access:license** | *string* | The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.). | `"example"` |
 | **access:reuseAndReproductionStatement** | *string* | The human readable reuse and reproduction statement that applies to the DRO. | `"example"` |
 | **access:termsOfUse** | *string* | License or terms of use governing reuse of the DRO. Should be a text statement. | `"example"` |

data/lib/cocina/models/dro.rb

@@ -26,7 +26,14 @@ module Cocina
 
       # Subschema for access concerns
       class Access < Struct
-        attribute :embargoReleaseDate, Types::Params::DateTime.meta(omittable: true)
+        # 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')
+        end
+
+        attribute :embargo, Embargo.optional.default(nil)
       end
 
       # Subschema for administrative concerns

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.21.0'
+    VERSION = '0.22.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -209,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Data models for the SDR