handlers

package
v1.27.0 Latest Latest
Warning

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

Go to latest
Published: Sep 28, 2020 License: MIT Imports: 28 Imported by: 0

Documentation

Overview

Package handlers is a generated GoMock package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ClientError

type ClientError interface {
	error
	Code() int
}

ClientError implements error interface with additional code method

type DatasetClient

type DatasetClient interface {
	Checker(ctx context.Context, check *health.CheckState) error
	Get(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID string) (m dataset.DatasetDetails, err error)
	GetVersion(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, datasetID, edition, version string) (m dataset.Version, 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, datasetID, edition, version, dimension string) (m dataset.Options, err error)
	GetVersionMetadata(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID, edition, version string) (m dataset.Metadata, err error)
}

DatasetClient is an interface with methods required for a dataset client

type Filter

type Filter struct {
	Renderer           Renderer
	FilterClient       FilterClient
	DatasetClient      DatasetClient
	HierarchyClient    HierarchyClient
	SearchClient       SearchClient
	SearchAPIAuthToken string

	EnableDatasetPreview bool
	APIRouterVersion     string
	// contains filtered or unexported fields
}

Filter represents the handlers for Filtering

func NewFilter

func NewFilter(r Renderer, fc FilterClient, dc DatasetClient, hc HierarchyClient,
	sc SearchClient, val Validator, searchAPIAuthToken, downloadServiceURL, apiRouterVersion string, enableDatasetPreview bool) *Filter

NewFilter creates a new instance of Filter

func (*Filter) AddList

func (f *Filter) AddList() http.HandlerFunc

AddList adds a list of values

func (*Filter) Age

func (f *Filter) Age() http.HandlerFunc

Age is a handler which will create age values on a filter job

func (*Filter) DimensionAddAll

func (f *Filter) DimensionAddAll() http.HandlerFunc

DimensionAddAll will add all dimension values to a basket

func (*Filter) DimensionRemoveAll

func (f *Filter) DimensionRemoveAll() http.HandlerFunc

DimensionRemoveAll removes all options on a particular dimensions

func (*Filter) DimensionRemoveOne

func (f *Filter) DimensionRemoveOne() http.HandlerFunc

DimensionRemoveOne removes an individual option on a dimensions

func (*Filter) DimensionSelector

func (f *Filter) DimensionSelector() http.HandlerFunc

DimensionSelector controls the render of the range selector template Contains stubbed data for now - page to be populated by the API

func (*Filter) FilterOverview

func (f *Filter) FilterOverview() http.HandlerFunc

FilterOverview controls the render of the filter overview template Contains stubbed data for now - page to be populated by the API

func (*Filter) FilterOverviewClearAll

func (f *Filter) FilterOverviewClearAll() http.HandlerFunc

FilterOverviewClearAll removes all selected options for all dimensions

func (*Filter) GetAllDimensionOptionsJSON

func (f *Filter) GetAllDimensionOptionsJSON() http.HandlerFunc

GetAllDimensionOptionsJSON will return a list of all options from the dataset api

func (*Filter) GetFilterJob

func (f *Filter) GetFilterJob() http.HandlerFunc

GetFilterJob returns the filter output json to the client to form preview for AJAX request

func (*Filter) GetSelectedDimensionOptionsJSON

func (f *Filter) GetSelectedDimensionOptionsJSON() http.HandlerFunc

GetSelectedDimensionOptionsJSON will return a list of selected options from the filter api with corresponding label

func (*Filter) Hierarchy

func (f *Filter) Hierarchy() http.HandlerFunc

func (*Filter) HierarchyUpdate

func (f *Filter) HierarchyUpdate() http.HandlerFunc

HierarchyUpdate controls the updating of a hierarchy job

func (*Filter) OutputPage

func (f *Filter) OutputPage() http.HandlerFunc

OutputPage controls the rendering of the preview and download page

func (*Filter) Search

func (f *Filter) Search() http.HandlerFunc

Search handles a users search, calling various APIs to form a search results hierarchy page

func (*Filter) SearchUpdate

func (f *Filter) SearchUpdate() http.HandlerFunc

SearchUpdate will update a dimension based on selected search resultss

func (Filter) Submit

func (f Filter) Submit() http.HandlerFunc

Submit handles the submitting of a filter job through the filter API

func (*Filter) Time

func (f *Filter) Time() http.HandlerFunc

Time specifically handles the data for the time dimension page

func (*Filter) UpdateAge

func (f *Filter) UpdateAge() http.HandlerFunc

UpdateAge is a handler which will update age values on a filter job

func (*Filter) UpdateTime

func (f *Filter) UpdateTime() http.HandlerFunc

UpdateTime will update the time filter based on the radio selected filters by the user

func (*Filter) UseLatest

func (f *Filter) UseLatest() http.HandlerFunc

UseLatest will create a new filter job for the same dataset with the latest version

type FilterClient

type FilterClient interface {
	Checker(ctx context.Context, check *health.CheckState) error
	GetDimensions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID string) (dims []filter.Dimension, err error)
	GetDimensionOptions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name string) (fdv []filter.DimensionOption, err error)
	GetJobState(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, filterID string) (f filter.Model, err error)
	GetOutput(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, filterOutputID string) (f filter.Model, err error)
	GetDimension(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name string) (dim filter.Dimension, err error)
	AddDimensionValue(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name, value string) error
	RemoveDimensionValue(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name, value string) error
	RemoveDimension(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name string) (err error)
	AddDimension(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name string) (err error)
	AddDimensionValues(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name string, options []string) error
	UpdateBlueprint(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID string, m filter.Model, doSubmit bool) (filter.Model, error)
	CreateBlueprint(context.Context, string, string, string, string, string, string, string, []string) (string, error)
	GetPreview(context.Context, string, string, string, string, string) (filter.Preview, error)
}

FilterClient contains the methods expected for a filter client

type FilterModelDimensions

type FilterModelDimensions []filter.ModelDimension

FilterModelDimensions represents a list of dimensions

func (FilterModelDimensions) Len

func (d FilterModelDimensions) Len() int

func (FilterModelDimensions) Less

func (d FilterModelDimensions) Less(i, j int) bool

func (FilterModelDimensions) Swap

func (d FilterModelDimensions) Swap(i, j int)

type HierarchyClient

type HierarchyClient interface {
	Checker(ctx context.Context, check *health.CheckState) error
	GetRoot(ctx context.Context, instanceID, name string) (hierarchy.Model, error)
	GetChild(ctx context.Context, instanceID, name, code string) (hierarchy.Model, error)
}

HierarchyClient contains methods expected for a hierarchy client

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) Checker added in v1.18.0

func (m *MockDatasetClient) Checker(ctx context.Context, check *healthcheck.CheckState) error

Checker mocks base method

func (*MockDatasetClient) EXPECT

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) GetOptions

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

GetOptions mocks base method

func (*MockDatasetClient) GetVersion

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

GetVersion mocks base method

func (*MockDatasetClient) GetVersionDimensions added in v1.22.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, datasetID, edition, version string) (dataset.Metadata, error)

GetVersionMetadata mocks base method

type MockDatasetClientMockRecorder

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

MockDatasetClientMockRecorder is the mock recorder for MockDatasetClient

func (*MockDatasetClientMockRecorder) Checker added in v1.18.0

func (mr *MockDatasetClientMockRecorder) Checker(ctx, check interface{}) *gomock.Call

Checker indicates an expected call of Checker

func (*MockDatasetClientMockRecorder) Get

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

Get indicates an expected call of Get

func (*MockDatasetClientMockRecorder) GetOptions

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

GetOptions indicates an expected call of GetOptions

func (*MockDatasetClientMockRecorder) GetVersion

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

GetVersion indicates an expected call of GetVersion

func (*MockDatasetClientMockRecorder) GetVersionDimensions added in v1.22.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, datasetID, edition, version interface{}) *gomock.Call

GetVersionMetadata indicates an expected call of GetVersionMetadata

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) AddDimension

func (m *MockFilterClient) AddDimension(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name string) error

AddDimension mocks base method

func (*MockFilterClient) AddDimensionValue

func (m *MockFilterClient) AddDimensionValue(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name, value string) error

AddDimensionValue mocks base method

func (*MockFilterClient) AddDimensionValues

func (m *MockFilterClient) AddDimensionValues(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name string, options []string) error

AddDimensionValues mocks base method

func (*MockFilterClient) Checker added in v1.18.0

func (m *MockFilterClient) Checker(ctx context.Context, check *healthcheck.CheckState) error

Checker mocks base method

func (*MockFilterClient) CreateBlueprint

func (m *MockFilterClient) CreateBlueprint(arg0 context.Context, arg1, arg2, arg3, arg4, arg5, arg6, arg7 string, arg8 []string) (string, error)

CreateBlueprint mocks base method

func (*MockFilterClient) EXPECT

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

func (*MockFilterClient) GetDimension

func (m *MockFilterClient) GetDimension(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name string) (filter.Dimension, error)

GetDimension mocks base method

func (*MockFilterClient) GetDimensionOptions

func (m *MockFilterClient) GetDimensionOptions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name string) ([]filter.DimensionOption, error)

GetDimensionOptions mocks base method

func (*MockFilterClient) GetDimensions

func (m *MockFilterClient) GetDimensions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID string) ([]filter.Dimension, error)

GetDimensions mocks base method

func (*MockFilterClient) GetJobState

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

GetJobState mocks base method

func (*MockFilterClient) GetOutput

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

GetOutput mocks base method

func (*MockFilterClient) GetPreview

func (m *MockFilterClient) GetPreview(arg0 context.Context, arg1, arg2, arg3, arg4, arg5 string) (filter.Preview, error)

GetPreview mocks base method

func (*MockFilterClient) RemoveDimension

func (m *MockFilterClient) RemoveDimension(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name string) error

RemoveDimension mocks base method

func (*MockFilterClient) RemoveDimensionValue

func (m *MockFilterClient) RemoveDimensionValue(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name, value string) error

RemoveDimensionValue mocks base method

func (*MockFilterClient) UpdateBlueprint

func (m_2 *MockFilterClient) UpdateBlueprint(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID string, m filter.Model, doSubmit bool) (filter.Model, error)

UpdateBlueprint mocks base method

type MockFilterClientMockRecorder

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

MockFilterClientMockRecorder is the mock recorder for MockFilterClient

func (*MockFilterClientMockRecorder) AddDimension

func (mr *MockFilterClientMockRecorder) AddDimension(ctx, userAuthToken, serviceAuthToken, collectionID, filterID, name interface{}) *gomock.Call

AddDimension indicates an expected call of AddDimension

func (*MockFilterClientMockRecorder) AddDimensionValue

func (mr *MockFilterClientMockRecorder) AddDimensionValue(ctx, userAuthToken, serviceAuthToken, collectionID, filterID, name, value interface{}) *gomock.Call

AddDimensionValue indicates an expected call of AddDimensionValue

func (*MockFilterClientMockRecorder) AddDimensionValues

func (mr *MockFilterClientMockRecorder) AddDimensionValues(ctx, userAuthToken, serviceAuthToken, collectionID, filterID, name, options interface{}) *gomock.Call

AddDimensionValues indicates an expected call of AddDimensionValues

func (*MockFilterClientMockRecorder) Checker added in v1.18.0

func (mr *MockFilterClientMockRecorder) Checker(ctx, check interface{}) *gomock.Call

Checker indicates an expected call of Checker

func (*MockFilterClientMockRecorder) CreateBlueprint

func (mr *MockFilterClientMockRecorder) CreateBlueprint(arg0, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8 interface{}) *gomock.Call

CreateBlueprint indicates an expected call of CreateBlueprint

func (*MockFilterClientMockRecorder) GetDimension

func (mr *MockFilterClientMockRecorder) GetDimension(ctx, userAuthToken, serviceAuthToken, collectionID, filterID, name interface{}) *gomock.Call

GetDimension indicates an expected call of GetDimension

func (*MockFilterClientMockRecorder) GetDimensionOptions

func (mr *MockFilterClientMockRecorder) GetDimensionOptions(ctx, userAuthToken, serviceAuthToken, collectionID, filterID, name interface{}) *gomock.Call

GetDimensionOptions indicates an expected call of GetDimensionOptions

func (*MockFilterClientMockRecorder) GetDimensions

func (mr *MockFilterClientMockRecorder) GetDimensions(ctx, userAuthToken, serviceAuthToken, collectionID, filterID interface{}) *gomock.Call

GetDimensions indicates an expected call of GetDimensions

func (*MockFilterClientMockRecorder) GetJobState

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

GetJobState indicates an expected call of GetJobState

func (*MockFilterClientMockRecorder) GetOutput

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

GetOutput indicates an expected call of GetOutput

func (*MockFilterClientMockRecorder) GetPreview

func (mr *MockFilterClientMockRecorder) GetPreview(arg0, arg1, arg2, arg3, arg4, arg5 interface{}) *gomock.Call

GetPreview indicates an expected call of GetPreview

func (*MockFilterClientMockRecorder) RemoveDimension

func (mr *MockFilterClientMockRecorder) RemoveDimension(ctx, userAuthToken, serviceAuthToken, collectionID, filterID, name interface{}) *gomock.Call

RemoveDimension indicates an expected call of RemoveDimension

func (*MockFilterClientMockRecorder) RemoveDimensionValue

func (mr *MockFilterClientMockRecorder) RemoveDimensionValue(ctx, userAuthToken, serviceAuthToken, collectionID, filterID, name, value interface{}) *gomock.Call

RemoveDimensionValue indicates an expected call of RemoveDimensionValue

func (*MockFilterClientMockRecorder) UpdateBlueprint

func (mr *MockFilterClientMockRecorder) UpdateBlueprint(ctx, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, m, doSubmit interface{}) *gomock.Call

UpdateBlueprint indicates an expected call of UpdateBlueprint

type MockHierarchyClient

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

MockHierarchyClient is a mock of HierarchyClient interface

func NewMockHierarchyClient

func NewMockHierarchyClient(ctrl *gomock.Controller) *MockHierarchyClient

NewMockHierarchyClient creates a new mock instance

func (*MockHierarchyClient) Checker added in v1.18.0

Checker mocks base method

func (*MockHierarchyClient) EXPECT

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

func (*MockHierarchyClient) GetChild

func (m *MockHierarchyClient) GetChild(ctx context.Context, instanceID, name, code string) (hierarchy.Model, error)

GetChild mocks base method

func (*MockHierarchyClient) GetRoot

func (m *MockHierarchyClient) GetRoot(ctx context.Context, instanceID, name string) (hierarchy.Model, error)

GetRoot mocks base method

type MockHierarchyClientMockRecorder

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

MockHierarchyClientMockRecorder is the mock recorder for MockHierarchyClient

func (*MockHierarchyClientMockRecorder) Checker added in v1.18.0

func (mr *MockHierarchyClientMockRecorder) Checker(ctx, check interface{}) *gomock.Call

Checker indicates an expected call of Checker

func (*MockHierarchyClientMockRecorder) GetChild

func (mr *MockHierarchyClientMockRecorder) GetChild(ctx, instanceID, name, code interface{}) *gomock.Call

GetChild indicates an expected call of GetChild

func (*MockHierarchyClientMockRecorder) GetRoot

func (mr *MockHierarchyClientMockRecorder) GetRoot(ctx, instanceID, name interface{}) *gomock.Call

GetRoot indicates an expected call of GetRoot

type MockRenderer

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

MockRenderer is a mock of Renderer interface

func NewMockRenderer

func NewMockRenderer(ctrl *gomock.Controller) *MockRenderer

NewMockRenderer creates a new mock instance

func (*MockRenderer) Checker added in v1.18.0

func (m *MockRenderer) Checker(ctx context.Context, check *healthcheck.CheckState) error

Checker mocks base method

func (*MockRenderer) Do

func (m *MockRenderer) Do(path string, b []byte) ([]byte, error)

Do mocks base method

func (*MockRenderer) EXPECT

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

type MockRendererMockRecorder

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

MockRendererMockRecorder is the mock recorder for MockRenderer

func (*MockRendererMockRecorder) Checker added in v1.18.0

func (mr *MockRendererMockRecorder) Checker(ctx, check interface{}) *gomock.Call

Checker indicates an expected call of Checker

func (*MockRendererMockRecorder) Do

func (mr *MockRendererMockRecorder) Do(path, b interface{}) *gomock.Call

Do indicates an expected call of Do

type MockSearchClient

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

MockSearchClient is a mock of SearchClient interface

func NewMockSearchClient

func NewMockSearchClient(ctrl *gomock.Controller) *MockSearchClient

NewMockSearchClient creates a new mock instance

func (*MockSearchClient) Checker added in v1.18.0

func (m *MockSearchClient) Checker(ctx context.Context, check *healthcheck.CheckState) error

Checker mocks base method

func (*MockSearchClient) Dimension

func (m *MockSearchClient) Dimension(ctx context.Context, datasetID, edition, version, name, query string, params ...search.Config) (*search.Model, error)

Dimension mocks base method

func (*MockSearchClient) EXPECT

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

type MockSearchClientMockRecorder

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

MockSearchClientMockRecorder is the mock recorder for MockSearchClient

func (*MockSearchClientMockRecorder) Checker added in v1.18.0

func (mr *MockSearchClientMockRecorder) Checker(ctx, check interface{}) *gomock.Call

Checker indicates an expected call of Checker

func (*MockSearchClientMockRecorder) Dimension

func (mr *MockSearchClientMockRecorder) Dimension(ctx, datasetID, edition, version, name, query interface{}, params ...interface{}) *gomock.Call

Dimension indicates an expected call of Dimension

type Renderer

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

Renderer provides an interface for a service template renderer

type SearchClient

type SearchClient interface {
	Checker(ctx context.Context, check *health.CheckState) error
	Dimension(ctx context.Context, datasetID, edition, version, name, query string, params ...search.Config) (m *search.Model, err error)
}

SearchClient contains methods expected for a search client

type Validator

type Validator interface {
	Validate(*http.Request, interface{}) error
}

Validator provides methods a to validate a request

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL