homepage

Documentation

Index

• Constants
• func Handler(homepageClient HomepageClienter) http.HandlerFunc
• type BabbageClient
• type Clients
• type HomepageClienter
  • func NewHomePagePublishingClient(clients *Clients) HomepageClienter
  • func NewHomePageWebClient(clients *Clients, updateInterval time.Duration, languages []string) HomepageClienter
• type HomepagePublishingClient
  • func (hpc *HomepagePublishingClient) Close()
  • func (hpc *HomepagePublishingClient) GetHomePage(ctx context.Context, userAccessToken, collectionID, lang string) (string, error)
  • func (hpc *HomepagePublishingClient) StartBackgroundUpdate(ctx context.Context, errorChannel chan error)
• type HomepageUpdater
  • func (hu *HomepageUpdater) GetHomePageUpdateFor(ctx context.Context, userAccessToken, collectionID, lang string) func() (string, error)
• type HomepageWebClient
  • func (hwc *HomepageWebClient) Close()
  • func (hwc *HomepageWebClient) GetHomePage(ctx context.Context, userAccessToken, collectionID, lang string) (string, error)
  • func (hwc *HomepageWebClient) StartBackgroundUpdate(ctx context.Context, errorChannel chan error)
• type ImageClient
• type MainFigure
• type RenderClient
• type ZebedeeClient

Constants

const (
	// HomepagePath is the string value which contains the URI to get the homepage's data.json
	HomepagePath = "/"

	// ImageVariant is the image variant to use for the homepage
	ImageVariant = "original"
)

Functions

func Handler

func Handler(homepageClient HomepageClienter) http.HandlerFunc

Handler handles requests to homepage endpoint

Types

type BabbageClient

type BabbageClient interface {
	GetReleaseCalendar(ctx context.Context, userAccessToken, fromDay, fromMonth, fromYear string) (m release_calendar.ReleaseCalendar, err error)
	Checker(ctx context.Context, check *health.CheckState) error
}

BabbageClient is an interface with methods required for a babbage client

type Clients

type Clients struct {
	Renderer RenderClient
	Zebedee  ZebedeeClient
	Babbage  BabbageClient
	ImageAPI ImageClient
}

Clients contains all the required Clients for frontend homepage controller

type HomepageClienter

type HomepageClienter interface {
	GetHomePage(ctx context.Context, userAccessToken, collectionID, lang string) (string, error)
	Close()
	StartBackgroundUpdate(ctx context.Context, errorChannel chan error)
}

func NewHomePagePublishingClient

func NewHomePagePublishingClient(clients *Clients) HomepageClienter

func NewHomePageWebClient

func NewHomePageWebClient(clients *Clients, updateInterval time.Duration, languages []string) HomepageClienter

type HomepagePublishingClient

type HomepagePublishingClient struct {
	HomepageUpdater
}

func (*HomepagePublishingClient) Close

func (hpc *HomepagePublishingClient) Close()

func (*HomepagePublishingClient) GetHomePage

func (hpc *HomepagePublishingClient) GetHomePage(ctx context.Context, userAccessToken, collectionID, lang string) (string, error)

func (*HomepagePublishingClient) StartBackgroundUpdate

func (hpc *HomepagePublishingClient) StartBackgroundUpdate(ctx context.Context, errorChannel chan error)

type HomepageUpdater

type HomepageUpdater struct {
	// contains filtered or unexported fields
}

func (*HomepageUpdater) GetHomePageUpdateFor

func (hu *HomepageUpdater) GetHomePageUpdateFor(ctx context.Context, userAccessToken, collectionID, lang string) func() (string, error)

type HomepageWebClient

type HomepageWebClient struct {
	HomepageUpdater
	// contains filtered or unexported fields
}

func (*HomepageWebClient) Close

func (hwc *HomepageWebClient) Close()

func (*HomepageWebClient) GetHomePage

func (hwc *HomepageWebClient) GetHomePage(ctx context.Context, userAccessToken, collectionID, lang string) (string, error)

func (*HomepageWebClient) StartBackgroundUpdate

func (hwc *HomepageWebClient) StartBackgroundUpdate(ctx context.Context, errorChannel chan error)

type ImageClient

type ImageClient interface {
	GetDownloadVariant(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, imageID, variant string) (m image.ImageDownload, err error)
	Checker(ctx context.Context, check *health.CheckState) error
}

ImageClient is an interface with methods required for the Image API service client

type MainFigure

type MainFigure struct {
	// contains filtered or unexported fields
}

type RenderClient

type RenderClient interface {
	Do(string, []byte) ([]byte, error)
	Checker(ctx context.Context, check *health.CheckState) error
}

RenderClient is an interface with methods required for rendering a template

type ZebedeeClient

type ZebedeeClient interface {
	GetTimeseriesMainFigure(ctx context.Context, userAuthToken, collectionID, lang, uri string) (m zebedee.TimeseriesMainFigure, err error)
	GetHomepageContent(ctx context.Context, userAccessToken, collectionID, lang, path string) (m zebedee.HomepageContent, err error)
	Checker(ctx context.Context, check *health.CheckState) error
}

ZebedeeClient is an interface with methods required for a zebedee client