Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement SetQueryParams in the Provider Interface #18

Merged
merged 3 commits into from
Oct 22, 2024
Merged

Implement SetQueryParams in the Provider Interface #18

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
85aec3c
Implement SetQueryParams in the Provider Interface
yendelevium Oct 20, 2024
300545f
Reduce redundant passing of queryParamters
yendelevium Oct 21, 2024
b912216
Address the latitude-longitude/lat-lon discrepancy in the queryParans…
yendelevium Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 33 additions & 9 deletions providers/meteoblue.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ import (
const meteoBlueProviderName = "meteoblue"

type MeteoBlueProvider struct {
client rest.HTTPClient
config config.MeteoProvider
client rest.HTTPClient
config config.MeteoProvider
queryParams map[string]string
}

func NewMeteoBlueProvider() (*MeteoBlueProvider, error) {
Expand Down Expand Up @@ -45,16 +46,26 @@ func NewMeteoBlueProvider() (*MeteoBlueProvider, error) {
client.EnableTrace()
}

return &MeteoBlueProvider{
provider := MeteoBlueProvider{
client: client,
config: meteoConfig,
}, nil
}
// Setting the default location to 0,0
provider.SetQueryParams(plumber.NewCoordinates(0, 0))

// Creating the new request(which will be reused in all FetchData calls) and setting the default queryParams on the client
provider.client.NewRequest()
provider.client.SetQueryParams(provider.queryParams)
return &provider, nil
}

func (p *MeteoBlueProvider) FetchData(qp map[string]string) (*plumber.BaseData, error) {
// Creating a new request everytime we fecth data
p.client.NewRequest()
resp, err := p.client.SetQueryParams(qp).Get(p.config.APIPath)
func (p *MeteoBlueProvider) FetchData(coords *plumber.Coordinates) (*plumber.BaseData, error) {
resp, err := p.client.
SetQueryParams(map[string]string{
"latitude": fmt.Sprintf("%f", coords.Latitude),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"lat"

"longitude": fmt.Sprintf("%f", coords.Longitude),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Open-Meteo uses "latitude" and "longitude" while Meteoblue uses "lat" and "lon".

This forms the URL as "...&lat=0.000000&latitude=10.901838&lon=0.000000&longitude=76.899845&tz=GMT"

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, then how about we don't set the latitude and longitude / lat - long while setting the default query params and directly set them for the first time in the FetchData() call?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reckon that should be okay.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

}).
Get(p.config.APIPath)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -86,6 +97,7 @@ func (p *MeteoBlueProvider) FetchData(qp map[string]string) (*plumber.BaseData,
return nil, fmt.Errorf("failed to unmarshal response: %w", err)
}

// TO-DO: #12
// Map the JSON response to plumber.BaseData
baseData := &plumber.BaseData{
Latitude: data.Latitude,
Expand All @@ -96,4 +108,16 @@ func (p *MeteoBlueProvider) FetchData(qp map[string]string) (*plumber.BaseData,
return baseData, nil
}

// Maybe add a MeteoBlueQueryParams like OpenMeteoQueryParams to have some standard for all providers?
// Set the QueryParams for the request
func (p *MeteoBlueProvider) SetQueryParams(coords *plumber.Coordinates) {
// Setting the queryParams on the provider
p.queryParams = map[string]string{
"lat": fmt.Sprintf("%f", coords.Latitude),
"lon": fmt.Sprintf("%f", coords.Longitude),
"tz": "GMT",
"format": "json",
"forecast_days": "1",
"apikey": p.config.APIKey,
}

}
33 changes: 22 additions & 11 deletions providers/open_meteo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ import (
const openMeteoProviderName = "open-meteo"

type OpenMeteoProvider struct {
client rest.HTTPClient
config config.MeteoProvider
client rest.HTTPClient
config config.MeteoProvider
queryParams map[string]string
}

// NewOpenMeteoProvider returns a new instance of OpenMeteoProvider
Expand Down Expand Up @@ -46,16 +47,27 @@ func NewOpenMeteoProvider() (*OpenMeteoProvider, error) {
client.EnableTrace()
}

return &OpenMeteoProvider{
provider := OpenMeteoProvider{
client: client,
config: meteoConfig,
}, nil
}
// Setting the default location to 0,0
provider.SetQueryParams(plumber.NewCoordinates(0, 0))
// Creating the new request(which will be reused in all FetchData calls) and setting the default queryParams on the client
provider.client.NewRequest()
provider.client.SetQueryParams(provider.queryParams)
return &provider, nil
}

// FetchData fetches API data from open-meteo provider for the given query parameters map
func (p *OpenMeteoProvider) FetchData(qp map[string]string) (*plumber.BaseData, error) {
p.client.NewRequest()
resp, err := p.client.SetQueryParams(qp).Get(p.config.APIPath)
func (p *OpenMeteoProvider) FetchData(coords *plumber.Coordinates) (*plumber.BaseData, error) {
resp, err := p.client.
SetQueryParams(map[string]string{
"latitude": fmt.Sprintf("%f", coords.Latitude),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"lat" and "long"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please ignore. What you have put here is correct.

"longitude": fmt.Sprintf("%f", coords.Longitude),
}).
Get(p.config.APIPath)

if err != nil {
return nil, err
}
Expand Down Expand Up @@ -86,9 +98,9 @@ func (p *OpenMeteoProvider) FetchData(qp map[string]string) (*plumber.BaseData,
return data, nil
}

// OpenMeteoQueryParams forms the query parameters for OpenMeteo API based on given coordinates
func OpenMeteoQueryParams(coords *plumber.Coordinates) map[string]string {
qp := map[string]string{
// SetQueryParams forms the query parameters for OpenMeteo API based on given coordinates
func (p *OpenMeteoProvider) SetQueryParams(coords *plumber.Coordinates) {
p.queryParams = map[string]string{
"latitude": fmt.Sprintf("%f", coords.Latitude),
"longitude": fmt.Sprintf("%f", coords.Longitude),
"current": "temperature_2m,relative_humidity_2m,apparent_temperature,is_day,precipitation,rain,showers,snowfall,weather_code,cloud_cover,pressure_msl,surface_pressure,wind_speed_10m,wind_direction_10m,wind_gusts_10m",
Expand All @@ -101,5 +113,4 @@ func OpenMeteoQueryParams(coords *plumber.Coordinates) map[string]string {
"cell_selection": "nearest",
"models": "best_match",
}
return qp
}
3 changes: 2 additions & 1 deletion providers/providers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ func init() {

// Provider interface defines the methods that each provider must implement
type Provider interface {
FetchData(queryParams map[string]string) (*plumber.BaseData, error)
FetchData(coords *plumber.Coordinates) (*plumber.BaseData, error)
SetQueryParams(coords *plumber.Coordinates)
}

// NewProvider returns the appropriate provider based on the name
Expand Down
17 changes: 3 additions & 14 deletions server/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ func Serve(ctx context.Context, args []string) {
w.WriteHeader(http.StatusInternalServerError)
return
}
bd, err := p.FetchData(providers.OpenMeteoQueryParams(plumber.NewCoordinates(11.0056, 76.9661)))
bd, err := p.FetchData(plumber.NewCoordinates(10.9018379, 76.8998445))
if err != nil {
logger.Error(e.FAIL, "err", err, "description", "Couldn't fetch data from OpenMeteoProvider")
w.WriteHeader(http.StatusInternalServerError)
Expand All @@ -66,19 +66,8 @@ func Serve(ctx context.Context, args []string) {
w.WriteHeader(http.StatusInternalServerError)
return
}
qp := map[string]string{
"lat": "47.558",
"lon": "7.587",
"asl": "279",
"tz": "Europe/Zurich",
"name": "Test",
"windspeed": "kmh",
"format": "json",
"history_days": "1",
"forecast_days": "0",
"apikey": cfg.MeteoProviders[0].APIKey,
}
bd, err := p.FetchData(qp)
// TO-DO : After defining the MB response, write it to the response
bd, err := p.FetchData(plumber.NewCoordinates(10.9018379, 76.8998445))
if err != nil {
logger.Error(e.FAIL, "err", err, "description", "Couldn't fetch data from MeteoBlueProvider")
w.WriteHeader(http.StatusInternalServerError)
Expand Down