cocina-models 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ee3417af99eea03235071ba77599819e998ed2ac7195d852ff55cfa1fd98605
-  data.tar.gz: 83381e6e15652ec933099ca02baaf394cd22d6ed55e72e7a68c62dc2d583f8e3
+  metadata.gz: 1be949cfe01f8591a3672f1aa22abd38d318334fd516d032eafc686ed59dec0a
+  data.tar.gz: de24e56fc74e0e1beb891d68020f12b75075015557310be867775b6727ee722b
 SHA512:
-  metadata.gz: a8e8632bfe52e7c8c10fd3e26ae739066a4029081c97d5c9546be83df8960b41920be45ec2bd1d3218e33a923ba9f94d4ea382c4ce8714bed869df4583c10a72
-  data.tar.gz: 7dd784ab41884b915103010c642cacf85c6db7ac58ebd27db9645fade4307d76e4b85b255a997f5618e977ec8732c632c914ab2789af4730dc324263faff5b5f
+  metadata.gz: 04edda64c833c0b8a3646c2d7b845a7741220809c7b3e6b6a6451a59c9dbc1b0df6370ab72d814c54b72b4e855d772152a0278dc1f99821bd20e7e00cb34ce97
+  data.tar.gz: e514ee482591acf73c3cb13ecc69cd20d368c720715f56086d0515d5925e7164d3200ec90b2310bc14a4d4b1822edff45a9f7df43875da13da612faf1ae45c63

data/docs/maps/Collection.json

@@ -4,7 +4,7 @@
   "title": "Digital Repository 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",
-  "required": ["@context", "@type", "externalIdentifier", "label", "internalIdentifier", "version", "administrative", "access", "identification", "structural"],
+  "required": ["@context", "@type", "externalIdentifier", "label", "internalIdentifier", "version", "administrative", "access", "description", "identification", "structural"],
   "properties": {
     "@context": {
       "description": "URI for the JSON-LD context definitions.",
@@ -33,6 +33,10 @@
       "description": "The Agent (User, Group, Application, Department, other) that deposited the Collection into SDR.",
       "$ref": "/Agent"
     },
+    "description": {
+      "description": "Descriptive metadata for the DRO.",
+      "$ref": "/Description"
+    },
     "externalIdentifier": {
       "description": "Identifier for the resource within the SDR architecture but outside of the repository. DRUID or UUID depending on resource type. Constant across resource versions. What clients will use calling the repository. Same as `identification.identifier`",
       "type": "string"
@@ -130,7 +134,7 @@
           "description": "Tags for release",
           "type": "array",
           "items": {
-            "$ref": "ReleaseTag.json"
+            "$ref": "/ReleaseTag"
           }
         },
         "sdrPreserve": {

data/docs/maps/DRO.json

@@ -4,7 +4,7 @@
   "title": "Digital Repository Object",
   "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",
-  "required": ["@context", "@type", "externalIdentifier", "label", "internalIdentifier", "version", "administrative", "access", "identification", "structural"],
+  "required": ["@context", "@type", "externalIdentifier", "label", "internalIdentifier", "version", "administrative", "access", "description", "identification", "structural"],
   "properties": {
     "@context": {
       "description": "URI for the JSON-LD context definitions.",
@@ -144,7 +144,7 @@
           "description": "Tags for release",
           "type": "array",
           "items": {
-            "$ref": "ReleaseTag.json"
+            "$ref": "/ReleaseTag"
           }
         },
         "sdrPreserve": {
@@ -160,6 +160,10 @@
         }
       }
     },
+    "description": {
+      "description": "Descriptive metadata for the DRO.",
+      "$ref": "/Description"
+    },
     "identification": {
       "description": "Identifying information for the DRO.",
       "type": "object",

data/docs/maps/Description.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "id": "http://cocina.sul.stanford.edu/schemas/Description",
+  "title": "Description",
+  "description": "The description of a work",
+  "type": "object",
+  "required": ["title"],
+  "properties": {
+    "title": {
+      "description": "The title of the item.",
+      "type": "array",
+      "items": {
+        "$ref": "/Title"
+      }
+    }
+  }
+}

data/docs/maps/ReleaseTag.json

@@ -1,5 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-06/schema#",
+  "id": "http://cocina.sul.stanford.edu/schemas/ReleaseTag",
   "title": "Release Tag",
   "description": "A tag that indicates the item or collection should be released.",
   "type": "object",
@@ -28,11 +29,11 @@
     },
     "who": {
       "description": "Who did this release",
-      "type": "string",
+      "type": "string"
     },
     "release": {
       "description": "Should it be released or withdrawn. Release is coded as true and withdraw as false",
       "type": "boolean"
-    },
+    }
   }
 }

data/docs/maps/Title.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "id": "http://cocina.sul.stanford.edu/schemas/Title",
+  "title": "Title",
+  "description": "A title of a work",
+  "type": "object",
+  "required": ["titleFull", "primary"],
+  "properties": {
+    "primary": {
+      "description": "Is this the primary title for the object",
+      "type": "boolean"
+    },
+    "titleFull": {
+      "description": "The full title for the object",
+      "type": "string"
+    }
+  }
+}

data/docs/schema.json

@@ -45,6 +45,7 @@
         "version",
         "administrative",
         "access",
+        "description",
         "identification",
         "structural"
       ],
@@ -84,6 +85,10 @@
           "description": "The Agent (User, Group, Application, Department, other) that deposited the Collection into SDR.",
           "$ref": "#/definitions/Agent"
         },
+        "description": {
+          "description": "Descriptive metadata for the DRO.",
+          "$ref": "#/definitions/Description"
+        },
         "externalIdentifier": {
           "description": "Identifier for the resource within the SDR architecture but outside of the repository. DRUID or UUID depending on resource type. Constant across resource versions. What clients will use calling the repository. Same as `identification.identifier`",
           "type": [
@@ -238,6 +243,15 @@
                 "string"
               ]
             },
+            "releaseTags": {
+              "description": "Tags for release",
+              "type": [
+                "array"
+              ],
+              "items": {
+                "$ref": "#/definitions/ReleaseTag"
+              }
+            },
             "sdrPreserve": {
               "description": "If this resource should be sent to Preservation.",
               "type": [
@@ -415,6 +429,7 @@
         "version",
         "administrative",
         "access",
+        "description",
         "identification",
         "structural"
       ],
@@ -624,6 +639,15 @@
                 "string"
               ]
             },
+            "releaseTags": {
+              "description": "Tags for release",
+              "type": [
+                "array"
+              ],
+              "items": {
+                "$ref": "#/definitions/ReleaseTag"
+              }
+            },
             "sdrPreserve": {
               "description": "If this resource should be sent to Preservation.",
               "type": [
@@ -641,6 +665,10 @@
             }
           }
         },
+        "description": {
+          "description": "Descriptive metadata for the DRO.",
+          "$ref": "#/definitions/Description"
+        },
         "identification": {
           "description": "Identifying information for the DRO.",
           "type": [
@@ -798,6 +826,12 @@
                 ]
               }
             },
+            "isMemberOf": {
+              "description": "Collection that this DRO is a member of",
+              "type": [
+                "string"
+              ]
+            },
             "isTargetOf": {
               "description": "An Annotation instance that applies to the DRO.",
               "type": [
@@ -817,6 +851,28 @@
         }
       }
     },
+    "Description": {
+      "$schema": "http://json-schema.org/draft-06/schema#",
+      "title": "Description",
+      "description": "The description of a work",
+      "type": [
+        "object"
+      ],
+      "required": [
+        "title"
+      ],
+      "properties": {
+        "title": {
+          "description": "The title of the item.",
+          "type": [
+            "array"
+          ],
+          "items": {
+            "$ref": "#/definitions/Title"
+          }
+        }
+      }
+    },
     "File": {
       "$schema": "http://json-schema.org/draft-06/schema#",
       "title": "File",
@@ -983,7 +1039,7 @@
           ],
           "properties": {
             "access": {
-              "description": "Access level for the File.",
+              "description": "Access level for the File. If \"dark\" this won't go into public xml contentMetadata.",
               "type": [
                 "string"
               ],
@@ -1359,6 +1415,62 @@
         }
       }
     },
+    "ReleaseTag": {
+      "$schema": "http://json-schema.org/draft-06/schema#",
+      "title": "Release Tag",
+      "description": "A tag that indicates the item or collection should be released.",
+      "type": [
+        "object"
+      ],
+      "required": [
+        "to",
+        "what",
+        "date",
+        "who",
+        "release"
+      ],
+      "properties": {
+        "to": {
+          "description": "What platform is it released to",
+          "type": [
+            "string"
+          ],
+          "enum": [
+            "Searchworks",
+            "Earthworks"
+          ]
+        },
+        "what": {
+          "description": "What is being released. This item or the whole collection.",
+          "type": [
+            "string"
+          ],
+          "enum": [
+            "self",
+            "collection"
+          ]
+        },
+        "date": {
+          "description": "When did this action happen",
+          "type": [
+            "string"
+          ],
+          "format": "date-time"
+        },
+        "who": {
+          "description": "Who did this release",
+          "type": [
+            "string"
+          ]
+        },
+        "release": {
+          "description": "Should it be released or withdrawn. Release is coded as true and withdraw as false",
+          "type": [
+            "boolean"
+          ]
+        }
+      }
+    },
     "Sequence": {
       "$schema": "http://json-schema.org/draft-06/schema#",
       "title": "Resource Sequence",
@@ -1413,6 +1525,32 @@
           }
         }
       }
+    },
+    "Title": {
+      "$schema": "http://json-schema.org/draft-06/schema#",
+      "title": "Title",
+      "description": "A title of a work",
+      "type": [
+        "object"
+      ],
+      "required": [
+        "titleFull",
+        "primary"
+      ],
+      "properties": {
+        "primary": {
+          "description": "Is this the primary title for the object",
+          "type": [
+            "boolean"
+          ]
+        },
+        "titleFull": {
+          "description": "The full title for the object",
+          "type": [
+            "string"
+          ]
+        }
+      }
     }
   },
   "properties": {
@@ -1425,14 +1563,23 @@
     "DRO": {
       "$ref": "#/definitions/DRO"
     },
+    "Description": {
+      "$ref": "#/definitions/Description"
+    },
     "File": {
       "$ref": "#/definitions/File"
     },
     "Fileset": {
       "$ref": "#/definitions/Fileset"
     },
+    "ReleaseTag": {
+      "$ref": "#/definitions/ReleaseTag"
+    },
     "Sequence": {
       "$ref": "#/definitions/Sequence"
+    },
+    "Title": {
+      "$ref": "#/definitions/Title"
     }
   },
   "description": "Hello world prmd API",

data/docs/schema.md

@@ -36,12 +36,14 @@ A group of Digital Repository Objects that indicate some type of conceptual grou
 | **administrative:isDescribedBy** | *string* | PURL/XML file that is a traditional representation of the metadata for the Collection. | `"example"` |
 | **administrative:lastUpdated** | *date-time* | When the resource in SDR was last updated. | `"2015-01-01T12:00:00Z"` |
 | **administrative:partOfProject** | *string* | Administrative or Internal project this resource is a part of. | `"example"` |
+| **administrative:releaseTags** | *array* | Tags for release | `[{"to":"Searchworks","what":"self","date":"2015-01-01T12:00:00Z","who":"example","release":true}]` |
 | **administrative:remediatedBy** | *array* | The Agent (User, Group, Application, Department, other) that remediated a Collection in SDR. | `[{"name":"example","sunetID":"example"}]` |
 | **administrative:sdrPreserve** | *boolean* | If this resource should be sent to Preservation. | `true` |
 | **citation** | *string* | Citation for the resource, including identifier, label, version, and a persistent URL to the object with SDR at the very least. | `"example"` |
 | **dedupeIdentifier** | *string* | Identifier retrieved from identification.sourceId that stands for analog or source identifier that this resource is a digital representation of. | `"example"` |
 | **depositor:name** | *string* | Primary label or name for an Agent. | `"example"` |
 | **depositor:sunetID** | *string* | Stanford University NetID for the Agent. | `"example"` |
+| **description:title** | *array* | The title of the item. | `[{"primary":true,"titleFull":"example"}]` |
 | **externalIdentifier** | *string* | Identifier for the resource within the SDR architecture but outside of the repository. DRUID or UUID depending on resource type. Constant across resource versions. What clients will use calling the repository. Same as `identification.identifier` | `"example"` |
 | **followingVersion** | *string* | Following version for the Collection within SDR. | `"example"` |
 | **identification:DOI** | *string* | Digital Object Identifier (DOI) for the Collection within this repository. | `"example"` |
@@ -90,12 +92,14 @@ Domain-defined abstraction of a 'work'. Digital Repository Objects' abstraction
 | **administrative:isDescribedBy** | *string* | Pointer to the PURL/XML file that is a traditional representation of the metadata for the DRO. | `"example"` |
 | **administrative:lastUpdated** | *date-time* | When the resource in SDR was last updated. | `"2015-01-01T12:00:00Z"` |
 | **administrative:partOfProject** | *string* | Administrative or Internal project this resource is a part of. | `"example"` |
+| **administrative:releaseTags** | *array* | Tags for release | `[{"to":"Searchworks","what":"self","date":"2015-01-01T12:00:00Z","who":"example","release":true}]` |
 | **administrative:remediatedBy** | *array* | The Agent (User, Group, Application, Department, other) that remediated a DRO in SDR. | `[{"name":"example","sunetID":"example"}]` |
 | **administrative:sdrPreserve** | *boolean* | If this resource should be sent to Preservation. | `true` |
 | **citation** | *string* | Citation for the resource, including identifier, label, version, and a persistent URL to the object with SDR at the very least. | `"example"` |
 | **dedupeIdentifier** | *string* | Identifier retrieved from identification.sourceId that stands for analog or source identifier that this resource is a digital representation of. | `"example"` |
 | **depositor:name** | *string* | Primary label or name for an Agent. | `"example"` |
 | **depositor:sunetID** | *string* | Stanford University NetID for the Agent. | `"example"` |
+| **description:title** | *array* | The title of the item. | `[{"primary":true,"titleFull":"example"}]` |
 | **externalIdentifier** | *string* | Identifier for the resource within the SDR architecture but outside of the repository. DRUID or UUID depending on resource type. Constant across resource versions. What clients will use calling the repository. Same as `identification.identifier` | `"example"` |
 | **followingVersion** | *string* | Following version for the Object within SDR. | `"example"` |
 | **identification:catalogLinks/catalog** | *string* | Catalog that is the source of the linked record. | `"example"` |
@@ -118,10 +122,23 @@ Domain-defined abstraction of a 'work'. Digital Repository Objects' abstraction
 | **structural:hasAgreement** | *string* | Agreement that covers the deposit of the DRO into SDR. | `"example"` |
 | **structural:hasMember** | *array* | Component or 'children' digital repository objects that are a part or portion of this 'parent' or aggregate DRO. | `[null]` |
 | **structural:hasMemberOrders** | *array* | Provided sequences or orderings of members of the Object, including some metadata about each sequence (i.e. sequence label, sequence type, if the sequence is primary, etc.). | `[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/sequence.jsonld","label":"example","startMember":"example","members":[null]}]` |
+| **structural:isMemberOf** | *string* | Collection that this DRO is a member of | `"example"` |
 | **structural:isTargetOf** | *string* | An Annotation instance that applies to the DRO. | `"example"` |
 | **version** | *integer* | Version for the DRO within SDR. | `42` |
 
 
+## <a name="resource-Description">Description</a>
+
+
+The description of a work
+
+### Attributes
+
+| Name | Type | Description | Example |
+| ------- | ------- | ------- | ------- |
+| **title** | *array* | The title of the item. | `[{"primary":true,"titleFull":"example"}]` |
+
+
 ## <a name="resource-File">File</a>
 
 
@@ -133,7 +150,7 @@ Binaries that are the basis of what our domain manages. Binaries here do not inc
 | ------- | ------- | ------- | ------- |
 | **@context** | *string* | URI for the JSON-LD context definitions. | `"example"` |
 | **@type** | *string* | The content type of the File.<br/> **one of:**`"http://cocina.sul.stanford.edu/models/file.jsonld"` | `"http://cocina.sul.stanford.edu/models/file.jsonld"` |
-| **access:access** | *string* | Access level for the File.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
+| **access:access** | *string* | Access level for the File. If "dark" this won't go into public xml contentMetadata.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
 | **access:download** | *string* | Download level for the File binary.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
 | **administrative:created** | *date-time* | When the resource in SDR was created. | `"2015-01-01T12:00:00Z"` |
 | **administrative:deleted** | *boolean* | If the resource has been deleted (but not purged). | `true` |
@@ -202,6 +219,22 @@ Relevant groupings of Files. Also called a File Grouping.
 | **version** | *integer* | Version for the Fileset within SDR. | `42` |
 
 
+## <a name="resource-ReleaseTag">Release Tag</a>
+
+
+A tag that indicates the item or collection should be released.
+
+### Attributes
+
+| Name | Type | Description | Example |
+| ------- | ------- | ------- | ------- |
+| **date** | *date-time* | When did this action happen | `"2015-01-01T12:00:00Z"` |
+| **release** | *boolean* | Should it be released or withdrawn. Release is coded as true and withdraw as false | `true` |
+| **to** | *string* | What platform is it released to<br/> **one of:**`"Searchworks"` or `"Earthworks"` | `"Searchworks"` |
+| **what** | *string* | What is being released. This item or the whole collection.<br/> **one of:**`"self"` or `"collection"` | `"self"` |
+| **who** | *string* | Who did this release | `"example"` |
+
+
 ## <a name="resource-Sequence">Resource Sequence</a>
 
 
@@ -218,3 +251,16 @@ A sequence or ordering of resources within a Collection or Object.
 | **startMember** | *string* | Identifier for the first member of the sequence. | `"example"` |
 
 
+## <a name="resource-Title">Title</a>
+
+
+A title of a work
+
+### Attributes
+
+| Name | Type | Description | Example |
+| ------- | ------- | ------- | ------- |
+| **primary** | *boolean* | Is this the primary title for the object | `true` |
+| **titleFull** | *string* | The full title for the object | `"example"` |
+
+

data/lib/cocina/models/admin_policy.rb

@@ -82,6 +82,9 @@ module Cocina
       attribute :version, Types::Coercible::Integer
       attribute(:access, Access.default { Access.new })
       attribute(:administrative, Administrative.default { Administrative.new })
+      # Allowing description to be omittable for now (until rolled out to consumers),
+      # but I think it's actually required for every DRO
+      attribute :description, Description.optional.default(nil)
       attribute(:identification, Identification.default { Identification.new })
       attribute(:structural, Structural.default { Structural.new })
 
@@ -95,6 +98,7 @@ module Cocina
 
         # params[:access] = Access.from_dynamic(dyn['access']) if dyn['access']
         params[:administrative] = Administrative.from_dynamic(dyn['administrative']) if dyn['administrative']
+        params[:description] = Description.from_dynamic(dyn.fetch('description'))
         AdminPolicy.new(params)
       end
 

data/lib/cocina/models/collection.rb

@@ -51,6 +51,9 @@ module Cocina
       attribute :version, Types::Coercible::Integer
       attribute(:access, Access.default { Access.new })
       attribute(:administrative, Administrative.default { Administrative.new })
+      # Allowing description to be omittable for now (until rolled out to consumers),
+      # but I think it's actually required for every DRO
+      attribute :description, Description.optional.default(nil)
       attribute(:identification, Identification.default { Identification.new })
       attribute(:structural, Structural.default { Structural.new })
 
@@ -64,7 +67,7 @@ module Cocina
 
         # params[:access] = Access.from_dynamic(dyn['access']) if dyn['access']
         params[:administrative] = Administrative.from_dynamic(dyn['administrative']) if dyn['administrative']
-
+        params[:description] = Description.from_dynamic(dyn.fetch('description'))
         Collection.new(params)
       end
 

data/lib/cocina/models/description.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cocina
+  module Models
+    # Descriptive metadata.  See http://sul-dlss.github.io/cocina-models/maps/Description.json
+    class Description < Dry::Struct
+      # Title element.  See http://sul-dlss.github.io/cocina-models/maps/Title.json
+      class Title < Dry::Struct
+        attribute :primary, Types::Strict::Bool
+        attribute :titleFull, Types::Strict::String
+
+        def self.from_dynamic(dyn)
+          Title.new(primary: dyn['primary'],
+                    titleFull: dyn['titleFull'])
+        end
+      end
+
+      attribute :title, Types::Strict::Array.of(Title)
+
+      def self.from_dynamic(dyn)
+        params = {
+          title: dyn.fetch('title').map { |title| Title.from_dynamic(title) }
+        }
+        Description.new(params)
+      end
+    end
+  end
+end

data/lib/cocina/models/dro.rb

@@ -74,6 +74,9 @@ module Cocina
       attribute :version, Types::Coercible::Integer
       attribute(:access, Access.default { Access.new })
       attribute(:administrative, Administrative.default { Administrative.new })
+      # Allowing description to be omittable for now (until rolled out to consumers),
+      # but I think it's actually required for every DRO
+      attribute :description, Description.optional.default(nil)
       attribute(:identification, Identification.default { Identification.new })
       attribute(:structural, Structural.default { Structural.new })
 
@@ -88,7 +91,7 @@ module Cocina
         params[:access] = Access.from_dynamic(dyn['access']) if dyn['access']
         params[:administrative] = Administrative.from_dynamic(dyn['administrative']) if dyn['administrative']
         params[:structural] = Structural.from_dynamic(dyn['structural']) if dyn['structural']
-
+        params[:description] = Description.from_dynamic(dyn.fetch('description'))
         DRO.new(params)
       end
 

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.15.0'
+    VERSION = '0.16.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-05 00:00:00.000000000 Z
+date: 2020-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -161,11 +161,13 @@ files:
 - docs/maps/Agent.json
 - docs/maps/Collection.json
 - docs/maps/DRO.json
+- docs/maps/Description.json
 - docs/maps/File.json
 - docs/maps/Fileset.json
 - docs/maps/README.md
 - docs/maps/ReleaseTag.json
 - docs/maps/Sequence.json
+- docs/maps/Title.json
 - docs/meta.json
 - docs/sampleETD/foxml-export.xml
 - docs/sampleETD/foxml.xml
@@ -177,6 +179,7 @@ files:
 - lib/cocina/models/admin_policy.rb
 - lib/cocina/models/checkable.rb
 - lib/cocina/models/collection.rb
+- lib/cocina/models/description.rb
 - lib/cocina/models/dro.rb
 - lib/cocina/models/file.rb
 - lib/cocina/models/file_set.rb
@@ -202,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Data models for the SDR