controllers

Documentation

Index

• func AuthCallback(w http.ResponseWriter, r *http.Request)
• func CORSOptionsHandler(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)
• func CheckCache(c *data.CacheRepository) func(http.ResponseWriter, *http.Request, http.HandlerFunc)
• func CheckCacheFresh(c *data.CacheRepository) func(http.ResponseWriter, *http.Request, http.HandlerFunc)
• func CreateApplication(applicationRepository data.AppRepository) func(http.ResponseWriter, *http.Request)
• func DeleteApplication(applicationRepository data.AppRepository) func(http.ResponseWriter, *http.Request)
• func GetAnalyzerPackage(categoryRepository *data.FooRepository, seriesRepository *data.FooRepository, ...) func(http.ResponseWriter, *http.Request)
• func GetCategories(categoryRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetCategoriesByName(categoryRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetCategoriesByUniverse(categoryRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetCategory(categoryRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetCategoryByIdGeoFreq(categoryRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetCategoryPackage(categoryRepository *data.FooRepository, seriesRepository *data.FooRepository, ...) func(http.ResponseWriter, *http.Request)
• func GetCategoryRoots(categoryRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetCensusData(cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetExportPackage(seriesRepo *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetForecastByCategoryId(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetFreqByCategoryId(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetFullRelativeURL(r *http.Request) string
• func GetGeographiesByCategory(geographyRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetInflatedSearchResultByGeoAndFreq(searchRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetInflatedSearchResultByGeoAndFreqAndUniverse(searchRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetInflatedSeriesByGroupId(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository, ...) func(http.ResponseWriter, *http.Request)
• func GetInflatedSeriesByGroupIdGeoAndFreq(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository, ...) func(http.ResponseWriter, *http.Request)
• func GetMeasurementByCategoryId(measurementRepository *data.FooRepository, ...) func(http.ResponseWriter, *http.Request)
• func GetSearchPackage(searchRepository *data.SearchRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSearchResultByGeoAndFreq(searchRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSearchResultByGeoAndFreqAndUniverse(searchRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSearchSummary(searchRepository *data.SearchRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSearchSummaryByUniverse(searchRepository *data.SearchRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSeriesByGroupId(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository, ...) func(http.ResponseWriter, *http.Request)
• func GetSeriesByGroupIdAndFreq(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository, ...) func(http.ResponseWriter, *http.Request)
• func GetSeriesByGroupIdAndGeoHandle(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository, ...) func(http.ResponseWriter, *http.Request)
• func GetSeriesByGroupIdGeoHandleAndFreq(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository, ...) func(http.ResponseWriter, *http.Request)
• func GetSeriesById(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSeriesByName(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSeriesBySearchText(searchRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSeriesBySearchTextAndUniverse(searchRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSeriesObservations(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSeriesPackage(seriesRepository *data.FooRepository, categoryRepository *data.FooRepository, ...) func(http.ResponseWriter, *http.Request)
• func GetSeriesSiblingsById(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSeriesSiblingsByIdAndFreq(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSeriesSiblingsByIdAndGeo(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSeriesSiblingsByIdGeoAndFreq(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSeriesSiblingsFreqById(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func GetSibllingGeographiesBySeriesId(geographyRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)
• func IndexHandler(w http.ResponseWriter, r *http.Request)
• func ReadApplications(applicationRepository data.AppRepository) func(http.ResponseWriter, *http.Request)
• func UpdateApplication(applicationRepository data.AppRepository) func(http.ResponseWriter, *http.Request)
• func ValidApiKey(applicationRepository *data.FooRepository) func(http.ResponseWriter, *http.Request, http.HandlerFunc)
• func WriteCache(r *http.Request, c *data.CacheRepository, payload []byte)
• func WriteResponse(w http.ResponseWriter, payload []byte)
• type AnalyzerPackage
• type ApplicationResource
• type ApplicationsResource
• type CategoriesResource
• type CategoryPackage
• type CategoryResource
• type ExportPackage
• type FeedbackResource
• type ForecastListResource
• type FrequencyListResource
• type GeographiesResource
• type InflatedSeriesListResource
• type MeasurementListResource
• type ObservationList
• type SearchPackage
• type SearchSummaryResource
• type SeriesListResource
• type SeriesPackage
• type SeriesResource
• type UserResource

Functions

func AuthCallback

func AuthCallback(w http.ResponseWriter, r *http.Request)

AuthCallback is the callback used by GitHub

func CORSOptionsHandler

func CORSOptionsHandler(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)

func CheckCache

func CheckCache(c *data.CacheRepository) func(http.ResponseWriter, *http.Request, http.HandlerFunc)

func CheckCacheFresh

func CheckCacheFresh(c *data.CacheRepository) func(http.ResponseWriter, *http.Request, http.HandlerFunc)

func CreateApplication

func CreateApplication(applicationRepository data.AppRepository) func(http.ResponseWriter, *http.Request)

CreateApplication returns a handler that will create applications

func DeleteApplication

func DeleteApplication(applicationRepository data.AppRepository) func(http.ResponseWriter, *http.Request)

DeleteApplication returns a handler that deletes an application

func GetAnalyzerPackage

func GetAnalyzerPackage(
	categoryRepository *data.FooRepository,
	seriesRepository *data.FooRepository,
	cacheRepository *data.CacheRepository,
	momTransformationOnly bool,
) func(http.ResponseWriter, *http.Request)

func GetCategories

func GetCategories(categoryRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetCategoriesByName

func GetCategoriesByName(categoryRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetCategoriesByUniverse

func GetCategoriesByUniverse(categoryRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetCategory

func GetCategory(categoryRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetCategoryByIdGeoFreq

func GetCategoryByIdGeoFreq(categoryRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

it seems this method is no longer used

func GetCategoryPackage

func GetCategoryPackage(
	categoryRepository *data.FooRepository,
	seriesRepository *data.FooRepository,
	cacheRepository *data.CacheRepository,
) func(http.ResponseWriter, *http.Request)

func GetCategoryRoots

func GetCategoryRoots(categoryRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetCensusData

func GetCensusData(cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)

GetCensusData retrieves data from api.census.gov

func GetExportPackage

func GetExportPackage(seriesRepo *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetForecastByCategoryId

func GetForecastByCategoryId(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetFreqByCategoryId

func GetFreqByCategoryId(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetFullRelativeURL

func GetFullRelativeURL(r *http.Request) string

func GetGeographiesByCategory

func GetGeographiesByCategory(geographyRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetInflatedSearchResultByGeoAndFreq

func GetInflatedSearchResultByGeoAndFreq(searchRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetInflatedSearchResultByGeoAndFreqAndUniverse

func GetInflatedSearchResultByGeoAndFreqAndUniverse(searchRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetInflatedSeriesByGroupId

func GetInflatedSeriesByGroupId(
	seriesRepository *data.FooRepository,
	cacheRepository *data.CacheRepository,
	groupType data.GroupType,
) func(http.ResponseWriter, *http.Request)

func GetInflatedSeriesByGroupIdGeoAndFreq

func GetInflatedSeriesByGroupIdGeoAndFreq(
	seriesRepository *data.FooRepository,
	cacheRepository *data.CacheRepository,
	groupType data.GroupType,
) func(http.ResponseWriter, *http.Request)

func GetMeasurementByCategoryId

func GetMeasurementByCategoryId(
	measurementRepository *data.FooRepository,
	cacheRepository *data.CacheRepository,
) func(http.ResponseWriter, *http.Request)

func GetSearchPackage

func GetSearchPackage(
	searchRepository *data.SearchRepository,
	cacheRepository *data.CacheRepository,
) func(http.ResponseWriter, *http.Request)

func GetSearchResultByGeoAndFreq

func GetSearchResultByGeoAndFreq(searchRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetSearchResultByGeoAndFreqAndUniverse

func GetSearchResultByGeoAndFreqAndUniverse(searchRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetSearchSummary

func GetSearchSummary(searchRepository *data.SearchRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetSearchSummaryByUniverse

func GetSearchSummaryByUniverse(searchRepository *data.SearchRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetSeriesByGroupId

func GetSeriesByGroupId(
	seriesRepository *data.FooRepository,
	cacheRepository *data.CacheRepository,
	groupType data.GroupType,
) func(http.ResponseWriter, *http.Request)

func GetSeriesByGroupIdAndFreq

func GetSeriesByGroupIdAndFreq(
	seriesRepository *data.FooRepository,
	cacheRepository *data.CacheRepository,
	groupType data.GroupType,
) func(http.ResponseWriter, *http.Request)

func GetSeriesByGroupIdAndGeoHandle

func GetSeriesByGroupIdAndGeoHandle(
	seriesRepository *data.FooRepository,
	cacheRepository *data.CacheRepository,
	groupType data.GroupType,
) func(http.ResponseWriter, *http.Request)

func GetSeriesByGroupIdGeoHandleAndFreq

func GetSeriesByGroupIdGeoHandleAndFreq(
	seriesRepository *data.FooRepository,
	cacheRepository *data.CacheRepository,
	groupType data.GroupType,
) func(http.ResponseWriter, *http.Request)

func GetSeriesById

func GetSeriesById(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetSeriesByName

func GetSeriesByName(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetSeriesBySearchText

func GetSeriesBySearchText(searchRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetSeriesBySearchTextAndUniverse

func GetSeriesBySearchTextAndUniverse(searchRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetSeriesObservations

func GetSeriesObservations(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetSeriesPackage

func GetSeriesPackage(
	seriesRepository *data.FooRepository,
	categoryRepository *data.FooRepository,
	cacheRepository *data.CacheRepository,
) func(http.ResponseWriter, *http.Request)

func GetSeriesSiblingsById

func GetSeriesSiblingsById(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetSeriesSiblingsByIdAndFreq

func GetSeriesSiblingsByIdAndFreq(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetSeriesSiblingsByIdAndGeo

func GetSeriesSiblingsByIdAndGeo(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetSeriesSiblingsByIdGeoAndFreq

func GetSeriesSiblingsByIdGeoAndFreq(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetSeriesSiblingsFreqById

func GetSeriesSiblingsFreqById(seriesRepository *data.FooRepository, cacheRepository *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func GetSibllingGeographiesBySeriesId

func GetSibllingGeographiesBySeriesId(geographyRepository *data.FooRepository, c *data.CacheRepository) func(http.ResponseWriter, *http.Request)

func IndexHandler

func IndexHandler(w http.ResponseWriter, r *http.Request)

IndexHandler produces the landing page

func ReadApplications

func ReadApplications(applicationRepository data.AppRepository) func(http.ResponseWriter, *http.Request)

ReadApplications returns a handler that returns all of the user's applications

func UpdateApplication

func UpdateApplication(applicationRepository data.AppRepository) func(http.ResponseWriter, *http.Request)

UpdateApplication will return a handler for updating an application

func ValidApiKey

func ValidApiKey(applicationRepository *data.FooRepository) func(http.ResponseWriter, *http.Request, http.HandlerFunc)

func WriteCache

func WriteCache(r *http.Request, c *data.CacheRepository, payload []byte)

func WriteResponse

func WriteResponse(w http.ResponseWriter, payload []byte)

Types

type AnalyzerPackage

type AnalyzerPackage struct {
	Data models.DataPortalAnalyzerPackage `json:"data"`
}

GET - /package/analyzer

type ApplicationResource

type ApplicationResource struct {
	Data models.Application `json:"data"`
}

for POST/PUT - /applications for GET - /applications/id

type ApplicationsResource

type ApplicationsResource struct {
	Data []models.Application `json:"data"`
}

for GET - /applications

type CategoriesResource

type CategoriesResource struct {
	Data []models.Category `json:"data"`
}

GET - /category

type CategoryPackage

type CategoryPackage struct {
	Data models.DataPortalCategoryPackage `json:"data"`
}

GET - /package/category

type CategoryResource

type CategoryResource struct {
	Data models.Category `json:"data"`
}

GET - /category/id

type ExportPackage

type ExportPackage struct {
	Data []models.InflatedSeries `json:"data"`
}

GET - /package/export

type FeedbackResource

type FeedbackResource struct {
	Data models.Feedback `json:"data"`
}

POST - /feedback

type ForecastListResource

type ForecastListResource struct {
	Data []string `json:"data"`
}

for core API, all prefixed by /v1

type FrequencyListResource

type FrequencyListResource struct {
	Data []models.DataPortalFrequency `json:"data"`
}

GET - /series/siblings/freq

type GeographiesResource

type GeographiesResource struct {
	Data []models.DataPortalGeography `json:"data"`
}

GET - /geo

type InflatedSeriesListResource

type InflatedSeriesListResource struct {
	Data []models.InflatedSeries `json:"data"`
}

for core API, all prefixed by /v1

type MeasurementListResource

type MeasurementListResource struct {
	Data []models.Measurement `json:"data"`
}

GET - /category/measurements

type ObservationList

type ObservationList struct {
	Data models.SeriesObservations `json:"data"`
}

GET - /series/observations

type SearchPackage

type SearchPackage struct {
	Data models.DataPortalSearchPackage `json:"data"`
}

GET - /package/search

type SearchSummaryResource

type SearchSummaryResource struct {
	Data models.SearchSummary `json:"data"`
}

GET - /search

type SeriesListResource

type SeriesListResource struct {
	Data []models.DataPortalSeries `json:"data"`
}

GET - /category/series

type SeriesPackage

type SeriesPackage struct {
	Data models.DataPortalSeriesPackage `json:"data"`
}

GET - /package/series

type SeriesResource

type SeriesResource struct {
	Data models.DataPortalSeries `json:"data"`
}

GET - /series

type UserResource

type UserResource struct {
	User         string
	Applications []models.Application
}

for main display