weather

Documentation

Index

• type API
  • func NewAPI(sockets map[types.Socket]bool, pool types.Pool, id uuid.UUID) *API
  • func (a *API) Configure(message types.ClientMessage) error
  • func (a *API) Data() (interface{}, error)
  • func (a *API) Run()
• type OpenWeatherResponse
  • func (o *OpenWeatherResponse) Transform() interface{}
  • func (o *OpenWeatherResponse) Update(arguments interface{}) error

Types

type API

type API struct {
	types.BaseAPI
	Config     types.WeatherConfig
	LastCalled time.Time `json:"-"`
	// This is the object we get from the backend API - we could possible remove this and just have the ResponseObject
	DataObject OpenWeatherResponse `json:"-"`
	// This is the object we are passing to the frontend - only need to rebuild it when its stale
	ResponseObject types.WeatherResponse `json:"-"`
	ValidCache     bool
}

API for weather

func NewAPI

func NewAPI(sockets map[types.Socket]bool, pool types.Pool, id uuid.UUID) *API

NewAPI creates a new weather api for a client

func (*API) Configure

func (a *API) Configure(message types.ClientMessage) error

Configure for weather

func (*API) Data

func (a *API) Data() (interface{}, error)

Data gets the data to send to the websocket

func (*API) Run

func (a *API) Run()

Run main entry point to weather API

type OpenWeatherResponse

type OpenWeatherResponse struct {
	Coord      coord
	Weather    []weather
	Base       string
	Main       main
	Visibility float64
	Wind       wind
	Rain       rain
	Clouds     clouds
	DT         float64
	Sys        sys
	Timezone   float64
	ID         float64
	Name       string
	COD        float64
}

OpenWeatherResponse is the struct that encodes the API data from openweathermap.org

func (*OpenWeatherResponse) Transform

func (o *OpenWeatherResponse) Transform() interface{}

Transform turns the OpenWeatherResponse into a WeatherResponse

func (*OpenWeatherResponse) Update

func (o *OpenWeatherResponse) Update(arguments interface{}) error

Update builds the data object