reverse_proxy

Documentation

Index

• func ConnectElasticClient(elasticSearchURL string) (client *elasticsearch.Client, err error)
• func ConnectRedisClient(redisHost string) (client *redis.Client)
• type App
  • func New(redisHost string, router *mux.Router, baseURL string, harvardAPIKey string, ...) (app App, err error)
  • func (app App) LogFatal(err error)
  • func (app App) Logger(inner http.Handler) http.Handler
  • func (app App) ReadPlacesData() (placeIDs []PlaceID, parsedData []Place)
  • func (app App) RespondWithError(w http.ResponseWriter, code int, errorData interface{})
• type CollectionsObject
• type CollectionsResponse
• type DataPayload
• type Place
  • func (place *Place) MarshalBinary() ([]byte, error)
• type PlaceID
  • func (p *PlaceID) MarshalBinary() ([]byte, error)
• type PlaceIdPayload
• type PlacesPayload
• type PublicationsPayload
• type PublicationsResponse
• type RecordPayload
• type RecordsPayload
• type RootPayload
• type Route
• type Routes
• type SearchResultsPayload

Functions

func ConnectElasticClient

func ConnectElasticClient(elasticSearchURL string) (client *elasticsearch.Client, err error)

func ConnectRedisClient

func ConnectRedisClient(redisHost string) (client *redis.Client)

Types

type App

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

func New

func New(redisHost string, router *mux.Router, baseURL string, harvardAPIKey string, elasticSearchURL string) (app App, err error)

func (App) LogFatal

func (app App) LogFatal(err error)

LogFatal to handle logging errors

func (App) Logger

func (app App) Logger(inner http.Handler) http.Handler

Logger function

func (App) ReadPlacesData

func (app App) ReadPlacesData() (placeIDs []PlaceID, parsedData []Place)

func (App) RespondWithError

func (app App) RespondWithError(w http.ResponseWriter, code int, errorData interface{})

RespondWithError handler for sending errors over http

type CollectionsObject

type CollectionsObject struct {
	Accessionmethod     string      `json:"accessionmethod"`
	Accessionyear       int         `json:"accessionyear"`
	Accesslevel         int         `json:"accesslevel"`
	Century             string      `json:"century"`
	Classification      string      `json:"classification"`
	Classificationid    int         `json:"classificationid"`
	Colorcount          int         `json:"colorcount"`
	Commentary          interface{} `json:"commentary"`
	Contact             string      `json:"contact"`
	Contextualtextcount int         `json:"contextualtextcount"`
	Copyright           interface{} `json:"copyright"`
	Creditline          string      `json:"creditline"`
	Culture             string      `json:"culture"`
	Datebegin           int         `json:"datebegin"`
	Dated               string      `json:"dated"`
	Dateend             int         `json:"dateend"`
	Dateoffirstpageview string      `json:"dateoffirstpageview,omitempty"`
	Dateoflastpageview  string      `json:"dateoflastpageview,omitempty"`
	Department          string      `json:"department"`
	Description         interface{} `json:"description"`
	Details             struct {
		Coins struct {
			Dateonobject       interface{} `json:"dateonobject"`
			Denomination       interface{} `json:"denomination"`
			Dieaxis            interface{} `json:"dieaxis"`
			Metal              string      `json:"metal"`
			Obverseinscription interface{} `json:"obverseinscription"`
			Reverseinscription interface{} `json:"reverseinscription"`
		} `json:"coins"`
	} `json:"details"`
	Dimensions           string      `json:"dimensions"`
	Division             string      `json:"division"`
	Edition              interface{} `json:"edition"`
	Exhibitioncount      int         `json:"exhibitioncount"`
	Groupcount           int         `json:"groupcount"`
	ID                   int         `json:"id"`
	Imagecount           int         `json:"imagecount"`
	Imagepermissionlevel int         `json:"imagepermissionlevel"`
	Images               []struct {
		Baseimageurl    string      `json:"baseimageurl"`
		Copyright       string      `json:"copyright"`
		Displayorder    int         `json:"displayorder"`
		Format          string      `json:"format"`
		Height          int         `json:"height"`
		Idsid           int         `json:"idsid"`
		Iiifbaseuri     string      `json:"iiifbaseuri"`
		Imageid         int         `json:"imageid"`
		Publiccaption   interface{} `json:"publiccaption"`
		Renditionnumber string      `json:"renditionnumber"`
		Width           int         `json:"width"`
	} `json:"images"`
	Labeltext    interface{} `json:"labeltext"`
	Lastupdate   string      `json:"lastupdate"`
	Markscount   int         `json:"markscount"`
	Mediacount   int         `json:"mediacount"`
	Medium       string      `json:"medium"`
	Objectid     int         `json:"objectid"`
	Objectnumber string      `json:"objectnumber"`
	Peoplecount  int         `json:"peoplecount"`
	Period       interface{} `json:"period"`
	Periodid     interface{} `json:"periodid"`
	Places       []struct {
		Displayname string `json:"displayname"`
		Placeid     int    `json:"placeid"`
		Type        string `json:"type"`
	} `json:"places"`
	Primaryimageurl  string      `json:"primaryimageurl"`
	Provenance       interface{} `json:"provenance"`
	Publicationcount int         `json:"publicationcount"`
	Rank             int         `json:"rank"`
	Relatedcount     int         `json:"relatedcount"`
	SeeAlso          []struct {
		Format  string `json:"format"`
		ID      string `json:"id"`
		Profile string `json:"profile"`
		Type    string `json:"type"`
	} `json:"seeAlso"`
	Signed                  interface{} `json:"signed"`
	Standardreferencenumber interface{} `json:"standardreferencenumber"`
	State                   interface{} `json:"state"`
	Style                   interface{} `json:"style"`
	Technique               string      `json:"technique"`
	Techniqueid             int         `json:"techniqueid"`
	Terms                   struct {
		Century []struct {
			ID   int    `json:"id"`
			Name string `json:"name"`
		} `json:"century"`
		Culture []struct {
			ID   int    `json:"id"`
			Name string `json:"name"`
		} `json:"culture"`
		Medium []struct {
			ID   int    `json:"id"`
			Name string `json:"name"`
		} `json:"medium"`
		Place []struct {
			ID   int    `json:"id"`
			Name string `json:"name"`
		} `json:"place"`
	} `json:"terms"`
	Title  string `json:"title"`
	Titles []struct {
		Displayorder int    `json:"displayorder"`
		Title        string `json:"title"`
		Titleid      int    `json:"titleid"`
		Titletype    string `json:"titletype"`
	} `json:"titles"`
	Titlescount                  int    `json:"titlescount"`
	Totalpageviews               int    `json:"totalpageviews"`
	Totaluniquepageviews         int    `json:"totaluniquepageviews"`
	URL                          string `json:"url"`
	Verificationlevel            int    `json:"verificationlevel"`
	Verificationleveldescription string `json:"verificationleveldescription"`
	Worktypes                    []struct {
		Worktype   string `json:"worktype"`
		Worktypeid string `json:"worktypeid"`
	} `json:"worktypes"`
}

type CollectionsResponse

type CollectionsResponse struct {
	Records []CollectionsObject `json:"records"`
}

type DataPayload

type DataPayload struct {
	Error   bool   `json:"error"`
	Message string `json:"message"`
}

DataPayload structure for error responses

type Place

type Place struct {
	Objectcount   int    `json:"objectcount"`
	ID            int    `json:"id"`
	LastUpdate    string `json:"lastupdate"`
	HasChildren   int    `json:"haschildren"`
	Level         int    `json:"level"`
	PlaceID       int    `json:"placeid"`
	PathForward   string `json:"pathforward"`
	ParentPlaceID int64  `json:"parentplaceid"`
	Name          string `json:"name"`
	TgnID         int    `json:"tgn_id,omitempty"`
	Geo           struct {
		Lon float64 `json:"lon"`
		Lat float64 `json:"lat"`
	} `json:"geo,omitempty"`
}

func (*Place) MarshalBinary

func (place *Place) MarshalBinary() ([]byte, error)

type PlaceID

type PlaceID struct {
	ParentPlaceId int64  `json:"parentPlaceID"`
	PathForward   string `json:"pathForward"`
}

func (*PlaceID) MarshalBinary

func (p *PlaceID) MarshalBinary() ([]byte, error)

type PlaceIdPayload

type PlaceIdPayload struct {
	Error   bool      `json:"error"`
	Message string    `json:"message"`
	Places  []PlaceID `json:"places"`
}

type PlacesPayload

type PlacesPayload struct {
	Error   bool    `json:"error"`
	Message string  `json:"message"`
	Places  []Place `json:"places"`
}

type PublicationsPayload

type PublicationsPayload struct {
	Error        bool          `json:"error"`
	Message      string        `json:"message"`
	Publications []interface{} `json:"publications"`
}

type PublicationsResponse

type PublicationsResponse struct {
	Records []interface{} `json:"records"`
}

type RecordPayload

type RecordPayload struct {
	Error   bool        `json:"error"`
	Message string      `json:"message"`
	Record  interface{} `json:"record"`
}

type RecordsPayload

type RecordsPayload struct {
	Error   bool        `json:"error"`
	Message string      `json:"message"`
	Records interface{} `json:"records"`
}

type RootPayload

type RootPayload struct {
	Error   bool        `json:"error"`
	Payload interface{} `json:"payload"`
}

RootPayload structure for error responses

type Route

type Route struct {
	Name    string
	Method  string
	Pattern string

	HandlerFunc http.HandlerFunc
}

Route defines a structure for routes

type Routes

type Routes []Route

Routes defines the list of routes of our API

type SearchResultsPayload

type SearchResultsPayload struct {
	Error   bool        `json:"error"`
	Message string      `json:"message"`
	Results interface{} `json:"results"`
}