IMAGEDAM 2050: Graphics usage placeholder

common-lib/src/main/scala/com/gu/mediaservice/lib/elasticsearch/MappingTest.scala

@@ -185,6 +185,9 @@ object MappingTest {
       )),
       downloadUsageMetadata = Some(DownloadUsageMetadata(
         downloadedBy = "me"
+      )),
+      graphicsUsageMetadata = Some(GraphicsUsageMetadata(
+        addedBy = "me"
       ))
     )),
     leases = LeasesByMedia.build(List(

common-lib/src/main/scala/com/gu/mediaservice/lib/elasticsearch/Mappings.scala

@@ -296,6 +296,10 @@ object Mappings {
     keywordField("downloadedBy")
   ))
 
+  def graphicsUsageMetadata(name: String): ObjectField = nonDynamicObjectField(name).copy(properties = Seq(
+    keywordField("addedBy")
+  ))
+
   def usagesMapping(name: String): NestedField = nestedField(name).copy(properties = Seq(
     keywordField("id"),
     sStemmerAnalysed("title"),
@@ -310,7 +314,8 @@ object Mappings {
     digitalUsageMetadata("digitalUsageMetadata"),
     syndicationUsageMetadata("syndicationUsageMetadata"),
     frontUsageMetadata("frontUsageMetadata"),
-    downloadUsageMetadata("downloadUsageMetadata")
+    downloadUsageMetadata("downloadUsageMetadata"),
+    graphicsUsageMetadata("graphicsUsageMetadata")
   ))
 
   def leaseMapping(name: String): ObjectField = nonDynamicObjectField(name).copy(properties = Seq(

common-lib/src/main/scala/com/gu/mediaservice/lib/usage/ItemToMediaUsage.scala

@@ -29,6 +29,8 @@ object ItemToMediaUsage {
         .map(_.asScala.toMap).flatMap(buildFront),
       Option(item.getMap[Any]("download_metadata"))
         .map(_.asScala.toMap).flatMap(buildDownload),
+      Option(item.getMap[Any]("graphics_metadata"))
+        .map(_.asScala.toMap).flatMap(buildGraphics),
       new DateTime(item.getLong("last_modified")),
       Try {
         item.getLong("date_added")
@@ -99,4 +101,12 @@ object ItemToMediaUsage {
       )
     }.toOption
   }
+
+  private def buildGraphics(metadataMap: Map[String, Any]): Option[GraphicsUsageMetadata] = {
+    Try {
+      GraphicsUsageMetadata(
+        metadataMap("addedBy").asInstanceOf[String]
+      )
+    }
+  }.toOption
 }

common-lib/src/main/scala/com/gu/mediaservice/lib/usage/UsageBuilder.scala

@@ -18,7 +18,8 @@ object UsageBuilder {
     usage.digitalUsageMetadata,
     usage.syndicationUsageMetadata,
     usage.frontUsageMetadata,
-    usage.downloadUsageMetadata
+    usage.downloadUsageMetadata,
+    usage.graphicsUsageMetadata
   )
 
   private def buildStatusString(usage: MediaUsage): UsageStatus = if (usage.isRemoved) RemovedUsageStatus else usage.status
@@ -28,11 +29,13 @@ object UsageBuilder {
   }
 
   private def buildUsageReference(usage: MediaUsage): List[UsageReference] = {
+
     usage.usageType match {
       case DigitalUsage => buildDigitalUsageReference(usage)
       case PrintUsage => buildPrintUsageReference(usage)
       case SyndicationUsage => buildSyndicationUsageReference(usage)
       case DownloadUsage => buildDownloadUsageReference(usage)
+      case GraphicsUsage => buildGraphicsUsageReference(usage)
     }
   }
 
@@ -80,4 +83,14 @@ object UsageBuilder {
   }).getOrElse(
     List[UsageReference]()
   )
+
+  private def buildGraphicsUsageReference(usage: MediaUsage): List[UsageReference] = usage.graphicsUsageMetadata.map (metadata => {
+    List(
+      UsageReference(
+        GraphicsUsageReference,None, name = Some(metadata.addedBy)
+      )
+    )
+  }).getOrElse(
+    List[UsageReference]()
+  )
 }

common-lib/src/main/scala/com/gu/mediaservice/model/usage/GraphicsUsageMetadata.scala

@@ -0,0 +1,16 @@
+package com.gu.mediaservice.model.usage
+
+import play.api.libs.json.{Json, Reads, Writes}
+
+case class GraphicsUsageMetadata(
+      addedBy: String
+) extends UsageMetadata {
+  override def toMap: Map[String, Any] = Map(
+    "addedBy" -> addedBy
+  )
+}
+
+object GraphicsUsageMetadata {
+  implicit val reader: Reads[GraphicsUsageMetadata] = Json.reads[GraphicsUsageMetadata]
+  implicit val writer: Writes[GraphicsUsageMetadata] = Json.writes[GraphicsUsageMetadata]
+}

common-lib/src/main/scala/com/gu/mediaservice/model/usage/MediaUsage.scala

@@ -11,20 +11,21 @@ case class MediaUsageKey(
   grouping: String,
 )
 case class MediaUsage(
-  usageId: UsageId,
-  grouping: String,
-  mediaId: String,
-  usageType: UsageType,
-  mediaType: String,
-  status: UsageStatus,
-  printUsageMetadata: Option[PrintUsageMetadata],
-  digitalUsageMetadata: Option[DigitalUsageMetadata],
-  syndicationUsageMetadata: Option[SyndicationUsageMetadata],
-  frontUsageMetadata: Option[FrontUsageMetadata],
-  downloadUsageMetadata: Option[DownloadUsageMetadata],
-  lastModified: DateTime,
-  dateAdded: Option[DateTime] = None,
-  dateRemoved: Option[DateTime] = None
+                       usageId: UsageId,
+                       grouping: String,
+                       mediaId: String,
+                       usageType: UsageType,
+                       mediaType: String,
+                       status: UsageStatus,
+                       printUsageMetadata: Option[PrintUsageMetadata],
+                       digitalUsageMetadata: Option[DigitalUsageMetadata],
+                       syndicationUsageMetadata: Option[SyndicationUsageMetadata],
+                       frontUsageMetadata: Option[FrontUsageMetadata],
+                       downloadUsageMetadata: Option[DownloadUsageMetadata],
+                       graphicsUsageMetadata: Option[GraphicsUsageMetadata],
+                       lastModified: DateTime,
+                       dateAdded: Option[DateTime] = None,
+                       dateRemoved: Option[DateTime] = None
 ) extends GridLogging {
 
   def isGridLikeId(implicit logMarker: LogMarker): Boolean = {
@@ -60,7 +61,8 @@ case class MediaUsage(
     digitalUsageMetadata,
     syndicationUsageMetadata,
     frontUsageMetadata,
-    downloadUsageMetadata
+    downloadUsageMetadata,
+    graphicsUsageMetadata
     // NOTE that we don't compare any date fields
   )
 

common-lib/src/main/scala/com/gu/mediaservice/model/usage/Usage.scala

@@ -5,21 +5,22 @@ import org.joda.time.DateTime
 import play.api.libs.functional.syntax._
 
 case class Usage(
-  id: String,
-  references: List[UsageReference],
-  platform: UsageType,
-  media: String,
-  status: UsageStatus,
-  dateAdded: Option[DateTime],
-  dateRemoved: Option[DateTime],
-  lastModified: DateTime,
+                  id: String,
+                  references: List[UsageReference],
+                  platform: UsageType,
+                  media: String,
+                  status: UsageStatus,
+                  dateAdded: Option[DateTime],
+                  dateRemoved: Option[DateTime],
+                  lastModified: DateTime,
 
-  // TODO collapse this field into an `Option[UsageMetadata]`
-  printUsageMetadata: Option[PrintUsageMetadata] = None,
-  digitalUsageMetadata: Option[DigitalUsageMetadata] = None,
-  syndicationUsageMetadata: Option[SyndicationUsageMetadata] = None,
-  frontUsageMetadata: Option[FrontUsageMetadata] = None,
-  downloadUsageMetadata: Option[DownloadUsageMetadata] = None
+                  // TODO collapse this field into an `Option[UsageMetadata]`
+                  printUsageMetadata: Option[PrintUsageMetadata] = None,
+                  digitalUsageMetadata: Option[DigitalUsageMetadata] = None,
+                  syndicationUsageMetadata: Option[SyndicationUsageMetadata] = None,
+                  frontUsageMetadata: Option[FrontUsageMetadata] = None,
+                  downloadUsageMetadata: Option[DownloadUsageMetadata] = None,
+                  graphicsUsageMetadata: Option[GraphicsUsageMetadata] = None
 )
 object Usage {
   import com.gu.mediaservice.lib.formatting._
@@ -37,7 +38,8 @@ object Usage {
       (__ \ "digitalUsageMetadata").writeNullable[DigitalUsageMetadata] ~
       (__ \ "syndicationUsageMetadata").writeNullable[SyndicationUsageMetadata] ~
       (__ \ "frontUsageMetadata").writeNullable[FrontUsageMetadata] ~
-      (__ \ "downloadUsageMetadata").writeNullable[DownloadUsageMetadata]
+      (__ \ "downloadUsageMetadata").writeNullable[DownloadUsageMetadata] ~
+      (__ \ "graphicsUsageMetadata").writeNullable[GraphicsUsageMetadata]
     )(unlift(Usage.unapply))
 
   implicit val reads: Reads[Usage] = (
@@ -53,6 +55,7 @@ object Usage {
       (__ \ "digitalUsageMetadata").readNullable[DigitalUsageMetadata] ~
       (__ \ "syndicationUsageMetadata").readNullable[SyndicationUsageMetadata] ~
       (__ \ "frontUsageMetadata").readNullable[FrontUsageMetadata] ~
-      (__ \ "downloadUsageMetadata").readNullable[DownloadUsageMetadata]
+      (__ \ "downloadUsageMetadata").readNullable[DownloadUsageMetadata] ~
+      (__ \ "graphicsUsageMetadata").readNullable[GraphicsUsageMetadata]
     )(Usage.apply _)
 }

common-lib/src/main/scala/com/gu/mediaservice/model/usage/UsageReferenceType.scala

@@ -10,6 +10,7 @@ trait UsageReferenceType {
     case SyndicationUsageReference => "syndication"
     case FrontUsageReference => "front"
     case DownloadUsageReference => "download"
+    case GraphicsUsageReference => "graphics"
   }
 }
 
@@ -24,6 +25,7 @@ object UsageReferenceType {
     case "syndication" => SyndicationUsageReference
     case "front" => FrontUsageReference
     case "download" => DownloadUsageReference
+    case "graphics" => GraphicsUsageReference
   }
 }
 
@@ -33,3 +35,4 @@ object ComposerUsageReference extends UsageReferenceType
 object SyndicationUsageReference extends UsageReferenceType
 object FrontUsageReference extends UsageReferenceType
 object DownloadUsageReference extends UsageReferenceType
+object GraphicsUsageReference extends UsageReferenceType

common-lib/src/main/scala/com/gu/mediaservice/model/usage/UsageStatus.scala

@@ -11,6 +11,7 @@ sealed trait UsageStatus {
     case DownloadedUsageStatus => "downloaded"
     case FailedUsageStatus => "failed"
     case UnknownUsageStatus => "unknown"
+    case GraphicsUsageStatus => "graphics"
   }
 }
 
@@ -23,6 +24,7 @@ object UsageStatus {
     case "downloaded" => DownloadedUsageStatus
     case "failed" => FailedUsageStatus
     case "unknown" => UnknownUsageStatus
+    case "graphics" => GraphicsUsageStatus
     case _ => throw new IllegalArgumentException("Invalid usage status")
   }
 
@@ -39,6 +41,7 @@ object RemovedUsageStatus extends UsageStatus
 object SyndicatedUsageStatus extends UsageStatus
 object DownloadedUsageStatus extends UsageStatus
 object FailedUsageStatus extends UsageStatus
+object GraphicsUsageStatus extends UsageStatus
 
 // For Fronts usages as we don't know if a front is in draft or is live
 // TODO remove this once we do!

common-lib/src/main/scala/com/gu/mediaservice/model/usage/UsageType.scala

@@ -8,6 +8,7 @@ trait UsageType {
     case DigitalUsage => "digital"
     case SyndicationUsage => "syndication"
     case DownloadUsage => "download"
+    case GraphicsUsage => "graphics"
   }
 }
 
@@ -20,10 +21,12 @@ object UsageType {
     case "digital" => DigitalUsage
     case "syndication" => SyndicationUsage
     case "download" => DownloadUsage
+    case "graphics" => GraphicsUsage
   }
 }
 
 object PrintUsage extends UsageType
 object DigitalUsage extends UsageType
 object SyndicationUsage extends UsageType
 object DownloadUsage extends UsageType
+object GraphicsUsage extends UsageType

usage/app/controllers/UsageApi.scala

@@ -256,6 +256,30 @@ class UsageApi(
     )
   }}
 
+  def setGraphicsUsages() = auth(parse.json) { req =>
+
+    val request = (req.body \ "data").validate[GraphicsUsageRequest]
+    request.fold(
+      e => respondError(
+        BadRequest,
+        errorKey = "graphics-usage-parse-failed",
+        errorMessage = JsError.toJson(e).toString
+      ),
+      usageRequest => {
+        implicit val logMarker: LogMarker = MarkerMap(
+          "requestType" -> "set-graphics-usages",
+          "requestId" -> RequestLoggingFilter.getRequestId(req),
+          "image-id" -> usageRequest.mediaId,
+        ) ++ apiKeyMarkers(req.user.accessor)
+        logger.info(logMarker, "recording graphics usage")
+        val group = usageGroupOps.build(usageRequest)
+        usageApiSubject.onNext(WithLogMarker.includeUsageGroup(group))
+        Accepted
+      }
+    )
+
+  }
+
   def updateUsageStatus(mediaId: String, usageId: String) = auth.async(parse.json) {req => {
     val request = (req.body \ "data").validate[UsageStatus]
     request.fold(

usage/app/lib/MediaUsageBuilder.scala

@@ -18,6 +18,7 @@ object MediaUsageBuilder {
     None,
     None,
     None,
+    None,
     printUsage.dateAdded
   )
 
@@ -36,6 +37,7 @@ object MediaUsageBuilder {
       None,
       None,
       None,
+      None,
       lastModified = mediaWrapper.lastModified
     )
   }
@@ -54,6 +56,7 @@ object MediaUsageBuilder {
       syndicationUsageMetadata = Some(syndicationUsageRequest.metadata),
       None,
       None,
+      None,
       lastModified = syndicationUsageRequest.dateAdded
     )
   }
@@ -73,6 +76,7 @@ object MediaUsageBuilder {
       syndicationUsageMetadata = None,
       frontUsageMetadata = Some(frontUsageRequest.metadata),
       None,
+      None,
       lastModified = frontUsageRequest.dateAdded
     )
   }
@@ -92,7 +96,28 @@ object MediaUsageBuilder {
       syndicationUsageMetadata = None,
       frontUsageMetadata = None,
       downloadUsageMetadata = Some(downloadUsageRequest.metadata),
+      None,
       lastModified = downloadUsageRequest.dateAdded
     )
   }
+
+  def build(graphicsUsageRequest: GraphicsUsageRequest, groupId: String): MediaUsage = {
+    val usageId = UsageIdBuilder.build(graphicsUsageRequest)
+
+    MediaUsage (
+      usageId,
+      groupId,
+      graphicsUsageRequest.mediaId,
+      GraphicsUsage,
+      mediaType = "image",
+      graphicsUsageRequest.status,
+      printUsageMetadata = None,
+      digitalUsageMetadata = None,
+      syndicationUsageMetadata = None,
+      frontUsageMetadata = None,
+      downloadUsageMetadata = None,
+      graphicsUsageMetadata = Some(graphicsUsageRequest.metadata),
+      lastModified = graphicsUsageRequest.dateAdded
+    )
+  }
 }

usage/app/lib/UsageRecorder.scala

@@ -50,7 +50,7 @@ class UsageRecorder(
 
   val dbUpdateStream: Observable[WithLogMarker[Set[String]]] = getUpdatesStream(dbMatchStream)
 
-  val notificationStream: Observable[WithLogMarker[UsageNotice]] = getNotificationStream(dbUpdateStream)
+val notificationStream: Observable[WithLogMarker[UsageNotice]] = getNotificationStream(dbUpdateStream)
 
   val notifiedStream: Observable[LogMarker] = notificationStream.map(usageNotifier.send)
 

usage/app/model/GraphicsUsageRequest.scala

@@ -0,0 +1,21 @@
+package model
+
+import com.gu.mediaservice.model.usage.{GraphicsUsageMetadata, GraphicsUsageStatus, UsageStatus}
+import org.joda.time.DateTime
+import play.api.libs.json.{JodaReads, JodaWrites, Json, Reads, Writes}
+
+case class GraphicsUsageRequest(
+   dateAdded: DateTime,
+   addedBy: String,
+   mediaId: String
+) {
+  val metadata: GraphicsUsageMetadata = GraphicsUsageMetadata(addedBy)
+  val status: UsageStatus = GraphicsUsageStatus
+}
+object GraphicsUsageRequest {
+  import JodaWrites._
+  import JodaReads._
+
+  implicit val reads: Reads[GraphicsUsageRequest] = Json.reads[GraphicsUsageRequest]
+  implicit val writes: Writes[GraphicsUsageRequest] = Json.writes[GraphicsUsageRequest]
+}