feat: Add copyright holder and authorship to filevalue

CHANGELOG.md

@@ -78,7 +78,7 @@
 
 ### Enhancements
 
-* Split license into licenseText and licenseUri (DEV-4398) ([#3436](https://github.com/dasch-swiss/dsp-api/issues/3436)) ([76d2db2](https://github.com/dasch-swiss/dsp-api/commit/76d2db25a75ffd43294e2d1d25e98f53f5d0e275))
+* Split license into licenseIdentifier and licenseUri (DEV-4398) ([#3436](https://github.com/dasch-swiss/dsp-api/issues/3436)) ([76d2db2](https://github.com/dasch-swiss/dsp-api/commit/76d2db25a75ffd43294e2d1d25e98f53f5d0e275))
 
 
 ### Bug Fixes

integration/src/test/scala/org/knora/webapi/E2EZSpec.scala

@@ -56,6 +56,9 @@ abstract class E2EZSpec extends ZIOSpecDefault with TestStartupUtils {
       response <- client.url(urlFull).addHeaders(Headers(bearer)).get("").orDie
     } yield response
 
+  def sendPutRequestAsRoot(url: String, data: String): ZIO[env, String, Response] =
+    sendPutRequestAsRoot(url, Body.fromString(data))
+
   def sendPutRequestAsRoot(url: String, body: Body): URIO[env, Response] =
     for {
       token    <- getRootToken.mapError(Exception(_)).orDie

integration/src/test/scala/org/knora/webapi/messages/admin/responder/IntegrationTestAdminJsonProtocol.scala

@@ -44,14 +44,11 @@ import org.knora.webapi.slice.admin.api.model.Project
 import org.knora.webapi.slice.admin.api.model.ProjectAdminMembersGetResponseADM
 import org.knora.webapi.slice.admin.api.model.ProjectMembersGetResponseADM
 import org.knora.webapi.slice.admin.api.model.ProjectOperationResponseADM
+import org.knora.webapi.slice.admin.domain.model.*
 import org.knora.webapi.slice.admin.domain.model.Group
-import org.knora.webapi.slice.admin.domain.model.KnoraProject.CopyrightAttribution
-import org.knora.webapi.slice.admin.domain.model.KnoraProject.LicenseText
-import org.knora.webapi.slice.admin.domain.model.KnoraProject.LicenseUri
 import org.knora.webapi.slice.admin.domain.model.KnoraProject.Longname
 import org.knora.webapi.slice.admin.domain.model.KnoraProject.Shortcode
 import org.knora.webapi.slice.admin.domain.model.KnoraProject.Shortname
-import org.knora.webapi.slice.admin.domain.model.User
 import org.knora.webapi.slice.common.Value.StringValue
 
 /**
@@ -207,12 +204,12 @@ object IntegrationTestAdminJsonProtocol extends TriplestoreJsonProtocol {
       case _             => throw DeserializationException("Value must be a JSON string.")
   }
 
-  implicit object CopyrightAttributionFormat extends StringValueFormat[CopyrightAttribution] {
-    override val from: String => Either[String, CopyrightAttribution] = CopyrightAttribution.from
+  implicit object CopyrightHolderFormat extends StringValueFormat[CopyrightHolder] {
+    override val from: String => Either[String, CopyrightHolder] = CopyrightHolder.from
   }
 
-  implicit object LicenseTextFormat extends StringValueFormat[LicenseText] {
-    override val from: String => Either[String, LicenseText] = LicenseText.from
+  implicit object LicenseIdentifierFormat extends StringValueFormat[LicenseIdentifier] {
+    override val from: String => Either[String, LicenseIdentifier] = LicenseIdentifier.from
   }
 
   implicit object LicenseUriFormat extends StringValueFormat[LicenseUri] {

integration/src/test/scala/org/knora/webapi/models/filemodels/FileModelUtil.scala

@@ -11,9 +11,10 @@ import org.knora.webapi.messages.OntologyConstants
 import org.knora.webapi.messages.SmartIri
 import org.knora.webapi.messages.StringFormatter
 import org.knora.webapi.messages.v2.responder.valuemessages.*
-import org.knora.webapi.slice.admin.domain.model.KnoraProject.CopyrightAttribution
-import org.knora.webapi.slice.admin.domain.model.KnoraProject.LicenseText
-import org.knora.webapi.slice.admin.domain.model.KnoraProject.LicenseUri
+import org.knora.webapi.slice.admin.domain.model.Authorship
+import org.knora.webapi.slice.admin.domain.model.CopyrightHolder
+import org.knora.webapi.slice.admin.domain.model.LicenseIdentifier
+import org.knora.webapi.slice.admin.domain.model.LicenseUri
 import org.knora.webapi.slice.resources.IiifImageRequestUrl
 
 object FileModelUtil {
@@ -86,10 +87,11 @@ object FileModelUtil {
     internalMimeType: Option[String],
     originalFilename: Option[String],
     originalMimeType: Option[String],
-    comment: Option[String],
-    copyrightAttribution: Option[CopyrightAttribution],
-    licenseText: Option[LicenseText],
-    licenseUri: Option[LicenseUri],
+    copyrightHolder: Option[CopyrightHolder] = None,
+    authorship: Option[List[Authorship]] = None,
+    licenseIdentifier: Option[LicenseIdentifier] = None,
+    licenseUri: Option[LicenseUri] = None,
+    comment: Option[String] = None,
   ): FileValueContentV2 =
     fileType match {
       case FileType.DocumentFile(pageCount, dimX, dimY) =>
@@ -100,9 +102,10 @@ object FileModelUtil {
             internalMimeType = internalMimeType.getOrElse("application/pdf"),
             originalFilename = originalFilename,
             originalMimeType = Some(originalMimeType.getOrElse("application/pdf")),
-            copyrightAttribution,
-            licenseText,
-            licenseUri,
+            copyrightHolder = copyrightHolder,
+            authorship = authorship,
+            licenseIdentifier = licenseIdentifier,
+            licenseUri = licenseUri,
           ),
           pageCount = pageCount,
           dimX = dimX,
@@ -117,9 +120,10 @@ object FileModelUtil {
             internalMimeType = internalMimeType.getOrElse("image/jp2"),
             originalFilename = originalFilename,
             originalMimeType = originalMimeType,
-            copyrightAttribution,
-            licenseText,
-            licenseUri,
+            copyrightHolder = copyrightHolder,
+            authorship = authorship,
+            licenseIdentifier = licenseIdentifier,
+            licenseUri = licenseUri,
           ),
           dimX = dimX,
           dimY = dimY,
@@ -133,9 +137,10 @@ object FileModelUtil {
             internalMimeType = internalMimeType.getOrElse("image/jp2"),
             originalFilename = originalFilename,
             originalMimeType = originalMimeType,
-            copyrightAttribution,
-            licenseText,
-            licenseUri,
+            copyrightHolder = copyrightHolder,
+            authorship = authorship,
+            licenseIdentifier = licenseIdentifier,
+            licenseUri = licenseUri,
           ),
           externalUrl = externalUrl,
           comment = comment,
@@ -148,9 +153,10 @@ object FileModelUtil {
             internalMimeType = internalMimeType.get,
             originalFilename = originalFilename,
             originalMimeType = internalMimeType,
-            copyrightAttribution,
-            licenseText,
-            licenseUri,
+            copyrightHolder = copyrightHolder,
+            authorship = authorship,
+            licenseIdentifier = licenseIdentifier,
+            licenseUri = licenseUri,
           ),
         )
       case FileType.TextFile =>
@@ -161,9 +167,10 @@ object FileModelUtil {
             internalMimeType = internalMimeType.get,
             originalFilename = originalFilename,
             originalMimeType = internalMimeType,
-            copyrightAttribution,
-            licenseText,
-            licenseUri,
+            copyrightHolder = copyrightHolder,
+            authorship = authorship,
+            licenseIdentifier = licenseIdentifier,
+            licenseUri = licenseUri,
           ),
         )
       case FileType.AudioFile =>
@@ -174,9 +181,10 @@ object FileModelUtil {
             internalMimeType = internalMimeType.get,
             originalFilename = originalFilename,
             originalMimeType = internalMimeType,
-            copyrightAttribution,
-            licenseText,
-            licenseUri,
+            copyrightHolder = copyrightHolder,
+            authorship = authorship,
+            licenseIdentifier = licenseIdentifier,
+            licenseUri = licenseUri,
           ),
         )
       case FileType.ArchiveFile =>
@@ -187,9 +195,10 @@ object FileModelUtil {
             internalMimeType = internalMimeType.getOrElse("application/zip"),
             originalFilename = originalFilename,
             originalMimeType = internalMimeType,
-            copyrightAttribution,
-            licenseText,
-            licenseUri,
+            copyrightHolder = copyrightHolder,
+            authorship = authorship,
+            licenseIdentifier = licenseIdentifier,
+            licenseUri = licenseUri,
           ),
           comment = comment,
         )

integration/src/test/scala/org/knora/webapi/models/filemodels/FileModels.scala

@@ -15,20 +15,19 @@ import org.knora.webapi.messages.v2.responder.resourcemessages.CreateResourceV2
 import org.knora.webapi.messages.v2.responder.resourcemessages.CreateValueInNewResourceV2
 import org.knora.webapi.sharedtestdata.SharedTestDataADM
 import org.knora.webapi.slice.admin.api.model.Project
-import org.knora.webapi.slice.admin.domain.model.KnoraProject.CopyrightAttribution
-import org.knora.webapi.slice.admin.domain.model.KnoraProject.LicenseText
-import org.knora.webapi.slice.admin.domain.model.KnoraProject.LicenseUri
-import org.knora.webapi.slice.admin.domain.model.KnoraProject.Shortcode
+import org.knora.webapi.slice.admin.domain.model.*
+import org.knora.webapi.slice.admin.domain.model.KnoraProject.*
 
 sealed abstract case class UploadFileRequest private (
   fileType: FileType,
   internalFilename: String,
   label: String,
   resourceIRI: Option[String] = None,
-  copyrightAttribution: Option[CopyrightAttribution] = None,
-  licenseText: Option[LicenseText] = None,
+  copyrightHolder: Option[CopyrightHolder] = None,
+  authorship: Option[List[Authorship]] = None,
+  licenseIdentifier: Option[LicenseIdentifier] = None,
   licenseUri: Option[LicenseUri] = None,
-) {
+) { self =>
 
   /**
    * Create a JSON-LD serialization of the request. This can be used for e2e and integration tests.
@@ -57,22 +56,32 @@ sealed abstract case class UploadFileRequest private (
       case None    => ""
     }
 
-    s"""{
-       |  $resorceIRIOrEmptyString"@type" : "$ontologyName:$classNameWithDefaults",
-       |  "$fileValuePropertyName" : {
-       |    "@type" : "$fileValueType",
-       |    "knora-api:fileValueHasFilename" : "$internalFilename"
-       |    ${copyrightAttribution.map(ca => s""","knora-api:hasCopyrightAttribution" : "${ca.value}"""").getOrElse("")}
-       |    ${licenseText.map(l => s""","knora-api:hasLicenseText" : "${l.value}"""").getOrElse("")}
-       |    ${licenseUri
-        .map(u => s""", "knora-api:hasLicenseUri" : { "@type" : "xsd:anyURI", "@value":"${u.value}" }""")
-        .getOrElse("")}
-       |  },
-       |  "knora-api:attachedToProject" : {
-       |    "@id" : "http://rdfh.ch/projects/$shortcode"
-       |  },
-       |  "rdfs:label" : "$label",
-       |  $context}""".stripMargin
+    val copyrightHolderJson =
+      copyrightHolder.map(ca => s""","knora-api:hasCopyrightHolder" : "${ca.value}"""").getOrElse("")
+    val authorshipJson = authorship
+      .filter(_.nonEmpty)
+      .map(a => s""","knora-api:hasAuthorship" : [ ${a.map(_.value).mkString("\"", "\",\"", "\"")} ]""")
+      .getOrElse("")
+
+    val jsonLd =
+      s"""{
+         |  $resorceIRIOrEmptyString"@type" : "$ontologyName:$classNameWithDefaults",
+         |  "$fileValuePropertyName" : {
+         |    "@type" : "$fileValueType",
+         |    "knora-api:fileValueHasFilename" : "$internalFilename"
+         |    $copyrightHolderJson
+         |    $authorshipJson
+         |    ${licenseIdentifier.map(l => s""","knora-api:hasLicenseIdentifier" : "${l.value}"""").getOrElse("")}
+         |    ${licenseUri
+          .map(u => s""", "knora-api:hasLicenseUri" : { "@type" : "xsd:anyURI", "@value":"${u.value}" }""")
+          .getOrElse("")}
+         |  },
+         |  "knora-api:attachedToProject" : {
+         |    "@id" : "http://rdfh.ch/projects/$shortcode"
+         |  },
+         |  "rdfs:label" : "$label",
+         |  $context}""".stripMargin
+    jsonLd
   }
 
   /**
@@ -116,9 +125,6 @@ sealed abstract case class UploadFileRequest private (
     resourceClassIRI: Option[SmartIri] = None,
     valuePropertyIRI: Option[SmartIri] = None,
     project: Option[Project] = None,
-    copyrightAttribution: Option[CopyrightAttribution] = None,
-    licenseText: Option[LicenseText] = None,
-    licenseUri: Option[LicenseUri] = None,
   ): CreateResourceV2 = {
     implicit val stringFormatter: StringFormatter = StringFormatter.getGeneralInstance
 
@@ -137,9 +143,10 @@ sealed abstract case class UploadFileRequest private (
       originalFilename = originalFilename,
       originalMimeType = originalMimeType,
       comment = comment,
-      copyrightAttribution,
-      licenseText,
-      licenseUri,
+      copyrightHolder = self.copyrightHolder,
+      authorship = self.authorship,
+      licenseIdentifier = self.licenseIdentifier,
+      licenseUri = self.licenseUri,
     )
 
     val values = List(
@@ -190,17 +197,19 @@ object UploadFileRequest {
     internalFilename: String,
     label: String = "test label",
     resourceIRI: Option[String] = None,
-    copyrightAttribution: Option[CopyrightAttribution] = None,
-    licenseText: Option[LicenseText] = None,
+    copyrightHolder: Option[CopyrightHolder] = None,
+    authorship: Option[List[Authorship]] = None,
+    licenseIdentifier: Option[LicenseIdentifier] = None,
     licenseUri: Option[LicenseUri] = None,
   ): UploadFileRequest =
     new UploadFileRequest(
       fileType,
       internalFilename,
       label,
       resourceIRI,
-      copyrightAttribution,
-      licenseText,
+      copyrightHolder,
+      authorship,
+      licenseIdentifier,
       licenseUri,
     ) {}
 }

integration/src/test/scala/org/knora/webapi/responders/v2/ResourcesResponderV2Spec.scala

@@ -40,7 +40,7 @@ import org.knora.webapi.models.filemodels.*
 import org.knora.webapi.responders.v2.ResourcesResponseCheckerV2.compareReadResourcesSequenceV2Response
 import org.knora.webapi.routing.UnsafeZioRun
 import org.knora.webapi.sharedtestdata.SharedTestDataADM
-import org.knora.webapi.slice.admin.domain.model.User
+import org.knora.webapi.slice.admin.domain.model.*
 import org.knora.webapi.slice.resources.IiifImageRequestUrl
 import org.knora.webapi.store.triplestore.api.TriplestoreService
 import org.knora.webapi.store.triplestore.api.TriplestoreService.Queries.Ask

integration/src/test/scala/org/knora/webapi/responders/v2/ValuesResponderV2Spec.scala

@@ -4318,10 +4318,6 @@ class ValuesResponderV2Spec extends CoreSpec with ImplicitSender {
               Some(mimeTypeJP2),
               Some("test.tiff"),
               Some(mimeTypeTIFF),
-              None,
-              None,
-              None,
-              None,
             ),
           ),
           anythingUser1,
@@ -4370,10 +4366,6 @@ class ValuesResponderV2Spec extends CoreSpec with ImplicitSender {
               Some(internalMimeType),
               originalFilename,
               originalMimeType,
-              None,
-              None,
-              None,
-              None,
             ),
           ),
           anythingUser1,