handlers

package
v1.37.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 28, 2022 License: MIT Imports: 28 Imported by: 1

Documentation

Overview

Package handlers is a generated GoMock package.

Package handlers is a generated GoMock package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateFilterFlexID added in v1.32.0 

func CreateFilterFlexID(fc FilterClient, dc DatasetClient, cfg config.Config) http.HandlerFunc

CreateFilterFlexID creates a new filter ID for filter flex journeys

func CreateFilterID 

func CreateFilterID(c FilterClient, dc DatasetClient) http.HandlerFunc

CreateFilterID controls the creating of a filter idea when a new user journey is requested

func DatasetPage added in v1.34.0 

func DatasetPage(zc ZebedeeClient, rend RenderClient, fac FilesAPIClient) http.HandlerFunc

DataSet will load a legacy dataset page

func EditionsList 

func EditionsList(dc DatasetClient, zc ZebedeeClient, rend RenderClient, cfg config.Config, apiRouterVersion string) http.HandlerFunc

EditionsList will load a list of editions for a filterable dataset

func FilterOutput added in v1.34.0 

func FilterOutput(fc FilterClient, dimsc DimensionClient, dc DatasetClient, rend RenderClient, cfg config.Config, apiRouterVersion string) http.HandlerFunc

FilterOutput will load a filtered landing page

func FilterableLanding 

func FilterableLanding(dc DatasetClient, rend RenderClient, zc ZebedeeClient, cfg config.Config, apiRouterVersion string) http.HandlerFunc

FilterableLanding will load a filterable landing page

func LegacyLanding 

func LegacyLanding(zc ZebedeeClient, dc DatasetClient, fc FilesAPIClient, rend RenderClient) http.HandlerFunc

LegacyLanding will load a zebedee landing page

func MetadataText 

func MetadataText(dc DatasetClient, cfg config.Config) http.HandlerFunc

MetadataText generates a metadata text file

func VersionsList 

func VersionsList(dc DatasetClient, zc ZebedeeClient, rend RenderClient, cfg config.Config) http.HandlerFunc

VersionsList will load a list of versions for a filterable dataset

Types

type ClientError 

type ClientError interface {
	Error() string
	Code() int
}

ClientError is an interface that can be used to retrieve the status code if a client has errored

type DatasetClient 

type DatasetClient interface {
	Get(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID string) (m dataset.DatasetDetails, err error)
	GetByPath(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, path string) (m dataset.DatasetDetails, err error)
	GetEditions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID string) (m []dataset.Edition, err error)
	GetEdition(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID, edition string) (dataset.Edition, error)
	GetVersions(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition string, q *dataset.QueryParams) (m dataset.VersionsList, err error)
	GetVersion(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition, version string) (m dataset.Version, err error)
	GetVersionMetadata(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, id, edition, version string) (m dataset.Metadata, err error)
	GetVersionDimensions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, id, edition, version string) (m dataset.VersionDimensions, err error)
	GetOptions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, id, edition, version, dimension string, q *dataset.QueryParams) (m dataset.Options, err error)
}

DatasetClient is an interface with methods required for a dataset client

type DimensionClient added in v1.34.0 

type DimensionClient interface {
	GetAreas(ctx context.Context, input dimension.GetAreasInput) (dimension.GetAreasResponse, error)
}

DimensionClient is an interface with methods required for a dimension client

type FilesAPIClient added in v1.33.0 

type FilesAPIClient interface {
	GetFile(ctx context.Context, path string, authToken string) (files.FileMetaData, error)
}

FilesAPIClient is an interface with methods required for getting metadata from Files API

type FilterClient 

type FilterClient interface {
	CreateBlueprint(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, datasetID, edition, version string, names []string) (filterID, eTag string, err error)
	CreateFlexibleBlueprint(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, datasetID, edition, version string, dimensions []filter.ModelDimension, population_type string) (filterID, eTag string, err error)
	GetOutput(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, filterOutputID string) (m filter.Model, err error)
}

FilterClient is an interface with the methods required for a filter client

type MockClientError 

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

MockClientError is a mock of ClientError interface.

func NewMockClientError 

func NewMockClientError(ctrl *gomock.Controller) *MockClientError

NewMockClientError creates a new mock instance.

func (*MockClientError) Code 

func (m *MockClientError) Code() int

Code mocks base method.

func (*MockClientError) EXPECT 

func (m *MockClientError) EXPECT() *MockClientErrorMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockClientError) Error 

func (m *MockClientError) Error() string

Error mocks base method.

type MockClientErrorMockRecorder 

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

MockClientErrorMockRecorder is the mock recorder for MockClientError.

func (*MockClientErrorMockRecorder) Code 

func (mr *MockClientErrorMockRecorder) Code() *gomock.Call

Code indicates an expected call of Code.

func (*MockClientErrorMockRecorder) Error 

func (mr *MockClientErrorMockRecorder) Error() *gomock.Call

Error indicates an expected call of Error.

type MockDatasetClient 

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

MockDatasetClient is a mock of DatasetClient interface.

func NewMockDatasetClient 

func NewMockDatasetClient(ctrl *gomock.Controller) *MockDatasetClient

NewMockDatasetClient creates a new mock instance.

func (*MockDatasetClient) EXPECT 

func (m *MockDatasetClient) EXPECT() *MockDatasetClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockDatasetClient) Get 

func (m *MockDatasetClient) Get(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID string) (dataset.DatasetDetails, error)

Get mocks base method.

func (*MockDatasetClient) GetByPath 

func (m *MockDatasetClient) GetByPath(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, path string) (dataset.DatasetDetails, error)

GetByPath mocks base method.

func (*MockDatasetClient) GetEdition 

func (m *MockDatasetClient) GetEdition(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID, edition string) (dataset.Edition, error)

GetEdition mocks base method.

func (*MockDatasetClient) GetEditions 

func (m *MockDatasetClient) GetEditions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID string) ([]dataset.Edition, error)

GetEditions mocks base method.

func (*MockDatasetClient) GetOptions 

func (m *MockDatasetClient) GetOptions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, id, edition, version, dimension string, q *dataset.QueryParams) (dataset.Options, error)

GetOptions mocks base method.

func (*MockDatasetClient) GetVersion 

func (m *MockDatasetClient) GetVersion(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition, version string) (dataset.Version, error)

GetVersion mocks base method.

func (*MockDatasetClient) GetVersionDimensions added in v1.15.0 

func (m *MockDatasetClient) GetVersionDimensions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, id, edition, version string) (dataset.VersionDimensions, error)

GetVersionDimensions mocks base method.

func (*MockDatasetClient) GetVersionMetadata 

func (m *MockDatasetClient) GetVersionMetadata(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, id, edition, version string) (dataset.Metadata, error)

GetVersionMetadata mocks base method.

func (*MockDatasetClient) GetVersions 

func (m *MockDatasetClient) GetVersions(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition string, q *dataset.QueryParams) (dataset.VersionsList, error)

GetVersions mocks base method.

type MockDatasetClientMockRecorder 

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

MockDatasetClientMockRecorder is the mock recorder for MockDatasetClient.

func (*MockDatasetClientMockRecorder) Get 

func (mr *MockDatasetClientMockRecorder) Get(ctx, userAuthToken, serviceAuthToken, collectionID, datasetID interface{}) *gomock.Call

Get indicates an expected call of Get.

func (*MockDatasetClientMockRecorder) GetByPath 

func (mr *MockDatasetClientMockRecorder) GetByPath(ctx, userAuthToken, serviceAuthToken, collectionID, path interface{}) *gomock.Call

GetByPath indicates an expected call of GetByPath.

func (*MockDatasetClientMockRecorder) GetEdition 

func (mr *MockDatasetClientMockRecorder) GetEdition(ctx, userAuthToken, serviceAuthToken, collectionID, datasetID, edition interface{}) *gomock.Call

GetEdition indicates an expected call of GetEdition.

func (*MockDatasetClientMockRecorder) GetEditions 

func (mr *MockDatasetClientMockRecorder) GetEditions(ctx, userAuthToken, serviceAuthToken, collectionID, datasetID interface{}) *gomock.Call

GetEditions indicates an expected call of GetEditions.

func (*MockDatasetClientMockRecorder) GetOptions 

func (mr *MockDatasetClientMockRecorder) GetOptions(ctx, userAuthToken, serviceAuthToken, collectionID, id, edition, version, dimension, q interface{}) *gomock.Call

GetOptions indicates an expected call of GetOptions.

func (*MockDatasetClientMockRecorder) GetVersion 

func (mr *MockDatasetClientMockRecorder) GetVersion(ctx, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition, version interface{}) *gomock.Call

GetVersion indicates an expected call of GetVersion.

func (*MockDatasetClientMockRecorder) GetVersionDimensions added in v1.15.0 

func (mr *MockDatasetClientMockRecorder) GetVersionDimensions(ctx, userAuthToken, serviceAuthToken, collectionID, id, edition, version interface{}) *gomock.Call

GetVersionDimensions indicates an expected call of GetVersionDimensions.

func (*MockDatasetClientMockRecorder) GetVersionMetadata 

func (mr *MockDatasetClientMockRecorder) GetVersionMetadata(ctx, userAuthToken, serviceAuthToken, collectionID, id, edition, version interface{}) *gomock.Call

GetVersionMetadata indicates an expected call of GetVersionMetadata.

func (*MockDatasetClientMockRecorder) GetVersions 

func (mr *MockDatasetClientMockRecorder) GetVersions(ctx, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition, q interface{}) *gomock.Call

GetVersions indicates an expected call of GetVersions.

type MockDimensionClient added in v1.34.0 

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

MockDimensionClient is a mock of DimensionClient interface.

func NewMockDimensionClient added in v1.34.0 

func NewMockDimensionClient(ctrl *gomock.Controller) *MockDimensionClient

NewMockDimensionClient creates a new mock instance.

func (*MockDimensionClient) EXPECT added in v1.34.0 

func (m *MockDimensionClient) EXPECT() *MockDimensionClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockDimensionClient) GetAreas added in v1.34.0 

func (m *MockDimensionClient) GetAreas(ctx context.Context, input dimension.GetAreasInput) (dimension.GetAreasResponse, error)

GetAreas mocks base method.

type MockDimensionClientMockRecorder added in v1.34.0 

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

MockDimensionClientMockRecorder is the mock recorder for MockDimensionClient.

func (*MockDimensionClientMockRecorder) GetAreas added in v1.34.0 

func (mr *MockDimensionClientMockRecorder) GetAreas(ctx, input interface{}) *gomock.Call

GetAreas indicates an expected call of GetAreas.

type MockFilesAPIClient added in v1.33.0 

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

MockFilesAPIClient is a mock of FilesAPIClient interface.

func NewMockFilesAPIClient added in v1.33.0 

func NewMockFilesAPIClient(ctrl *gomock.Controller) *MockFilesAPIClient

NewMockFilesAPIClient creates a new mock instance.

func (*MockFilesAPIClient) EXPECT added in v1.33.0 

func (m *MockFilesAPIClient) EXPECT() *MockFilesAPIClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockFilesAPIClient) GetFile added in v1.33.0 

func (m *MockFilesAPIClient) GetFile(ctx context.Context, path, authToken string) (files.FileMetaData, error)

GetFile mocks base method.

type MockFilesAPIClientMockRecorder added in v1.33.0 

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

MockFilesAPIClientMockRecorder is the mock recorder for MockFilesAPIClient.

func (*MockFilesAPIClientMockRecorder) GetFile added in v1.33.0 

func (mr *MockFilesAPIClientMockRecorder) GetFile(ctx, path, authToken interface{}) *gomock.Call

GetFile indicates an expected call of GetFile.

type MockFilterClient 

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

MockFilterClient is a mock of FilterClient interface.

func NewMockFilterClient 

func NewMockFilterClient(ctrl *gomock.Controller) *MockFilterClient

NewMockFilterClient creates a new mock instance.

func (*MockFilterClient) CreateBlueprint 

func (m *MockFilterClient) CreateBlueprint(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, datasetID, edition, version string, names []string) (string, string, error)

CreateBlueprint mocks base method.

func (*MockFilterClient) CreateFlexibleBlueprint added in v1.32.0 

func (m *MockFilterClient) CreateFlexibleBlueprint(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, datasetID, edition, version string, dimensions []filter.ModelDimension, population_type string) (string, string, error)

CreateFlexibleBlueprint mocks base method.

func (*MockFilterClient) EXPECT 

func (m *MockFilterClient) EXPECT() *MockFilterClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockFilterClient) GetOutput added in v1.34.0 

func (m *MockFilterClient) GetOutput(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, filterOutputID string) (filter.Model, error)

GetOutput mocks base method.

type MockFilterClientMockRecorder 

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

MockFilterClientMockRecorder is the mock recorder for MockFilterClient.

func (*MockFilterClientMockRecorder) CreateBlueprint 

func (mr *MockFilterClientMockRecorder) CreateBlueprint(ctx, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, datasetID, edition, version, names interface{}) *gomock.Call

CreateBlueprint indicates an expected call of CreateBlueprint.

func (*MockFilterClientMockRecorder) CreateFlexibleBlueprint added in v1.32.0 

func (mr *MockFilterClientMockRecorder) CreateFlexibleBlueprint(ctx, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, datasetID, edition, version, dimensions, population_type interface{}) *gomock.Call

CreateFlexibleBlueprint indicates an expected call of CreateFlexibleBlueprint.

func (*MockFilterClientMockRecorder) GetOutput added in v1.34.0 

func (mr *MockFilterClientMockRecorder) GetOutput(ctx, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, filterOutputID interface{}) *gomock.Call

GetOutput indicates an expected call of GetOutput.

type MockRenderClient 

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

MockRenderClient is a mock of RenderClient interface.

func NewMockRenderClient 

func NewMockRenderClient(ctrl *gomock.Controller) *MockRenderClient

NewMockRenderClient creates a new mock instance.

func (*MockRenderClient) BuildPage added in v1.23.0 

func (m *MockRenderClient) BuildPage(w io.Writer, pageModel interface{}, templateName string)

BuildPage mocks base method.

func (*MockRenderClient) EXPECT 

func (m *MockRenderClient) EXPECT() *MockRenderClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockRenderClient) NewBasePageModel added in v1.23.0 

func (m *MockRenderClient) NewBasePageModel() model.Page

NewBasePageModel mocks base method.

type MockRenderClientMockRecorder 

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

MockRenderClientMockRecorder is the mock recorder for MockRenderClient.

func (*MockRenderClientMockRecorder) BuildPage added in v1.23.0 

func (mr *MockRenderClientMockRecorder) BuildPage(w, pageModel, templateName interface{}) *gomock.Call

BuildPage indicates an expected call of BuildPage.

func (*MockRenderClientMockRecorder) NewBasePageModel added in v1.23.0 

func (mr *MockRenderClientMockRecorder) NewBasePageModel() *gomock.Call

NewBasePageModel indicates an expected call of NewBasePageModel.

type MockZebedeeClient 

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

MockZebedeeClient is a mock of ZebedeeClient interface.

func NewMockZebedeeClient 

func NewMockZebedeeClient(ctrl *gomock.Controller) *MockZebedeeClient

NewMockZebedeeClient creates a new mock instance.

func (*MockZebedeeClient) EXPECT 

func (m *MockZebedeeClient) EXPECT() *MockZebedeeClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockZebedeeClient) Get 

func (m *MockZebedeeClient) Get(ctx context.Context, userAccessToken, path string) ([]byte, error)

Get mocks base method.

func (*MockZebedeeClient) GetBreadcrumb 

func (m *MockZebedeeClient) GetBreadcrumb(ctx context.Context, userAccessToken, collectionID, lang, path string) ([]zebedee.Breadcrumb, error)

GetBreadcrumb mocks base method.

func (*MockZebedeeClient) GetDataset 

func (m *MockZebedeeClient) GetDataset(ctx context.Context, userAccessToken, collectionID, lang, path string) (zebedee.Dataset, error)

GetDataset mocks base method.

func (*MockZebedeeClient) GetDatasetLandingPage 

func (m *MockZebedeeClient) GetDatasetLandingPage(ctx context.Context, userAccessToken, collectionID, lang, path string) (zebedee.DatasetLandingPage, error)

GetDatasetLandingPage mocks base method.

func (*MockZebedeeClient) GetHomepageContent added in v1.30.0 

func (m *MockZebedeeClient) GetHomepageContent(ctx context.Context, userAccessToken, collectionID, lang, path string) (zebedee.HomepageContent, error)

GetHomepageContent mocks base method.

type MockZebedeeClientMockRecorder 

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

MockZebedeeClientMockRecorder is the mock recorder for MockZebedeeClient.

func (*MockZebedeeClientMockRecorder) Get 

func (mr *MockZebedeeClientMockRecorder) Get(ctx, userAccessToken, path interface{}) *gomock.Call

Get indicates an expected call of Get.

func (*MockZebedeeClientMockRecorder) GetBreadcrumb 

func (mr *MockZebedeeClientMockRecorder) GetBreadcrumb(ctx, userAccessToken, collectionID, lang, path interface{}) *gomock.Call

GetBreadcrumb indicates an expected call of GetBreadcrumb.

func (*MockZebedeeClientMockRecorder) GetDataset 

func (mr *MockZebedeeClientMockRecorder) GetDataset(ctx, userAccessToken, collectionID, lang, path interface{}) *gomock.Call

GetDataset indicates an expected call of GetDataset.

func (*MockZebedeeClientMockRecorder) GetDatasetLandingPage 

func (mr *MockZebedeeClientMockRecorder) GetDatasetLandingPage(ctx, userAccessToken, collectionID, lang, path interface{}) *gomock.Call

GetDatasetLandingPage indicates an expected call of GetDatasetLandingPage.

func (*MockZebedeeClientMockRecorder) GetHomepageContent added in v1.30.0 

func (mr *MockZebedeeClientMockRecorder) GetHomepageContent(ctx, userAccessToken, collectionID, lang, path interface{}) *gomock.Call

GetHomepageContent indicates an expected call of GetHomepageContent.

type RenderClient 

type RenderClient interface {
	BuildPage(w io.Writer, pageModel interface{}, templateName string)
	NewBasePageModel() coreModel.Page
}

RenderClient is an interface with methods for require for rendering a template

type ZebedeeClient 

type ZebedeeClient interface {
	GetBreadcrumb(ctx context.Context, userAccessToken, collectionID, lang, path string) ([]zebedee.Breadcrumb, error)
	Get(ctx context.Context, userAccessToken, path string) ([]byte, error)
	GetDatasetLandingPage(ctx context.Context, userAccessToken, collectionID, lang, path string) (zebedee.DatasetLandingPage, error)
	GetDataset(ctx context.Context, userAccessToken, collectionID, lang, path string) (zebedee.Dataset, error)
	GetHomepageContent(ctx context.Context, userAccessToken, collectionID, lang, path string) (m zebedee.HomepageContent, err error)
}

ZebedeeClient is an interface for zebedee client

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.