com.gu.commercial.branding.Branding.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commercial-shared_2.12 Show documentation
commercial-shared
The newest version!
package com.gu.commercial.branding

import com.gu.contentapi.client.model.v1.Sponsorship

sealed trait ContainerBranding

case class Branding(
  brandingType: BrandingType,
  sponsorName: String,
  logo: Logo,
  logoForDarkBackground: Option[Logo],
  aboutThisLink: String,
  hostedCampaignColour: Option[String]
) extends ContainerBranding {
  // In some cases we want to prevent sponsors from being inherited from the section.
  // To do this CP can add a "No Sponsor" sponsorship to the top tag of the series.
  def isUnsponsored: Boolean = sponsorName.replace(" ", "").toLowerCase == "nosponsor"

  def isPaid: Boolean = brandingType == PaidContent
  def isSponsored: Boolean = brandingType == Sponsored
  def isFoundationFunded: Boolean = brandingType == Foundation
}

object Branding {

  val defaultAboutThisLink = "https://www.theguardian.com/info/2016/jan/25/content-funding"

  def fromSponsorship(webTitle: String, campaignColour: Option[String], sponsorship: Sponsorship): Branding = {
    Branding(
      brandingType = BrandingType.fromSponsorshipType(sponsorship.sponsorshipType),
      sponsorName = sponsorship.sponsorName,
      logo = Logo.make(
        title = webTitle,
        sponsorshipType = sponsorship.sponsorshipType,
        sponsorshipPackage = sponsorship.sponsorshipPackage,
        src = sponsorship.sponsorLogo,
        dimensions = sponsorship.sponsorLogoDimensions,
        link = sponsorship.sponsorLink
      ),
      logoForDarkBackground = sponsorship.highContrastSponsorLogo.map { src =>
        Logo.make(
          title = webTitle,
          sponsorshipType = sponsorship.sponsorshipType,
          sponsorshipPackage = sponsorship.sponsorshipPackage,
          src,
          dimensions = sponsorship.highContrastSponsorLogoDimensions,
          link = sponsorship.sponsorLink
        )
      },
      aboutThisLink = sponsorship.aboutLink getOrElse defaultAboutThisLink,
      hostedCampaignColour = campaignColour
    )
  }
}

/**
  * Signifies a paid container with multiple sponsors.
  * The container won't show a logo but will have the paid styling.
  */
case object PaidMultiSponsorBranding extends ContainerBranding