Add US unit support for weather observations and forecasts
All checks were successful
ci/woodpecker/push/build-image Pipeline was successful
All checks were successful
ci/woodpecker/push/build-image Pipeline was successful
This commit is contained in:
19
internal/core/constants.go
Normal file
19
internal/core/constants.go
Normal file
@@ -0,0 +1,19 @@
|
||||
package core
|
||||
|
||||
// Units controls response-unit output formatting.
|
||||
type Units string
|
||||
|
||||
const (
|
||||
UnitsMetric Units = "metric"
|
||||
UnitsUS Units = "us"
|
||||
)
|
||||
|
||||
const (
|
||||
celsiusToFahrenheitScale = 9.0 / 5.0
|
||||
celsiusToFahrenheitOffset = 32.0
|
||||
kmhToMphFactor = 0.621371192237334
|
||||
metersToMilesFactor = 0.000621371192237334
|
||||
metersToFeetFactor = 3.280839895013123
|
||||
paToInHgFactor = 0.000295299830714045
|
||||
mmToInchesFactor = 0.03937007874015748
|
||||
)
|
||||
196
internal/core/payload.go
Normal file
196
internal/core/payload.go
Normal file
@@ -0,0 +1,196 @@
|
||||
package core
|
||||
|
||||
import (
|
||||
"time"
|
||||
|
||||
"gitea.maximumdirect.net/ejr/weatherfeeder/model"
|
||||
)
|
||||
|
||||
// WeatherObservationUS is the US-customary response shape for observations.
|
||||
type WeatherObservationUS struct {
|
||||
StationID string `json:"stationId,omitempty" xml:"stationId,omitempty"`
|
||||
StationName string `json:"stationName,omitempty" xml:"stationName,omitempty"`
|
||||
Timestamp time.Time `json:"timestamp" xml:"timestamp"`
|
||||
ConditionCode model.WMOCode `json:"conditionCode" xml:"conditionCode"`
|
||||
IsDay *bool `json:"isDay,omitempty" xml:"isDay,omitempty"`
|
||||
TextDescription string `json:"textDescription,omitempty" xml:"textDescription,omitempty"`
|
||||
TemperatureF *float64 `json:"temperatureF,omitempty" xml:"temperatureF,omitempty"`
|
||||
DewpointF *float64 `json:"dewpointF,omitempty" xml:"dewpointF,omitempty"`
|
||||
WindDirectionDegrees *float64 `json:"windDirectionDegrees,omitempty" xml:"windDirectionDegrees,omitempty"`
|
||||
WindSpeedMph *float64 `json:"windSpeedMph,omitempty" xml:"windSpeedMph,omitempty"`
|
||||
WindGustMph *float64 `json:"windGustMph,omitempty" xml:"windGustMph,omitempty"`
|
||||
BarometricPressureInHg *float64 `json:"barometricPressureInHg,omitempty" xml:"barometricPressureInHg,omitempty"`
|
||||
VisibilityMiles *float64 `json:"visibilityMiles,omitempty" xml:"visibilityMiles,omitempty"`
|
||||
RelativeHumidityPercent *float64 `json:"relativeHumidityPercent,omitempty" xml:"relativeHumidityPercent,omitempty"`
|
||||
ApparentTemperatureF *float64 `json:"apparentTemperatureF,omitempty" xml:"apparentTemperatureF,omitempty"`
|
||||
PresentWeather []model.PresentWeather `json:"presentWeather,omitempty" xml:"presentWeather,omitempty"`
|
||||
}
|
||||
|
||||
// WeatherForecastRunUS is the US-customary response shape for hourly forecasts.
|
||||
type WeatherForecastRunUS struct {
|
||||
LocationID string `json:"locationId,omitempty" xml:"locationId,omitempty"`
|
||||
LocationName string `json:"locationName,omitempty" xml:"locationName,omitempty"`
|
||||
IssuedAt time.Time `json:"issuedAt" xml:"issuedAt"`
|
||||
UpdatedAt *time.Time `json:"updatedAt,omitempty" xml:"updatedAt,omitempty"`
|
||||
Product model.ForecastProduct `json:"product" xml:"product"`
|
||||
Latitude *float64 `json:"latitude,omitempty" xml:"latitude,omitempty"`
|
||||
Longitude *float64 `json:"longitude,omitempty" xml:"longitude,omitempty"`
|
||||
ElevationFeet *float64 `json:"elevationFeet,omitempty" xml:"elevationFeet,omitempty"`
|
||||
Periods []WeatherForecastPeriodUS `json:"periods" xml:"periods"`
|
||||
}
|
||||
|
||||
// WeatherForecastPeriodUS is the US-customary response shape for forecast periods.
|
||||
type WeatherForecastPeriodUS struct {
|
||||
StartTime time.Time `json:"startTime" xml:"startTime"`
|
||||
EndTime time.Time `json:"endTime" xml:"endTime"`
|
||||
Name string `json:"name,omitempty" xml:"name,omitempty"`
|
||||
IsDay *bool `json:"isDay,omitempty" xml:"isDay,omitempty"`
|
||||
ConditionCode model.WMOCode `json:"conditionCode" xml:"conditionCode"`
|
||||
ConditionText string `json:"conditionText,omitempty" xml:"conditionText,omitempty"`
|
||||
ProviderRawDescription string `json:"providerRawDescription,omitempty" xml:"providerRawDescription,omitempty"`
|
||||
TextDescription string `json:"textDescription,omitempty" xml:"textDescription,omitempty"`
|
||||
DetailedText string `json:"detailedText,omitempty" xml:"detailedText,omitempty"`
|
||||
IconURL string `json:"iconUrl,omitempty" xml:"iconUrl,omitempty"`
|
||||
TemperatureF *float64 `json:"temperatureF,omitempty" xml:"temperatureF,omitempty"`
|
||||
TemperatureFMin *float64 `json:"temperatureFMin,omitempty" xml:"temperatureFMin,omitempty"`
|
||||
TemperatureFMax *float64 `json:"temperatureFMax,omitempty" xml:"temperatureFMax,omitempty"`
|
||||
DewpointF *float64 `json:"dewpointF,omitempty" xml:"dewpointF,omitempty"`
|
||||
RelativeHumidityPercent *float64 `json:"relativeHumidityPercent,omitempty" xml:"relativeHumidityPercent,omitempty"`
|
||||
WindDirectionDegrees *float64 `json:"windDirectionDegrees,omitempty" xml:"windDirectionDegrees,omitempty"`
|
||||
WindSpeedMph *float64 `json:"windSpeedMph,omitempty" xml:"windSpeedMph,omitempty"`
|
||||
WindGustMph *float64 `json:"windGustMph,omitempty" xml:"windGustMph,omitempty"`
|
||||
BarometricPressureInHg *float64 `json:"barometricPressureInHg,omitempty" xml:"barometricPressureInHg,omitempty"`
|
||||
VisibilityMiles *float64 `json:"visibilityMiles,omitempty" xml:"visibilityMiles,omitempty"`
|
||||
ApparentTemperatureF *float64 `json:"apparentTemperatureF,omitempty" xml:"apparentTemperatureF,omitempty"`
|
||||
CloudCoverPercent *float64 `json:"cloudCoverPercent,omitempty" xml:"cloudCoverPercent,omitempty"`
|
||||
ProbabilityOfPrecipitationPercent *float64 `json:"probabilityOfPrecipitationPercent,omitempty" xml:"probabilityOfPrecipitationPercent,omitempty"`
|
||||
PrecipitationAmountIn *float64 `json:"precipitationAmountIn,omitempty" xml:"precipitationAmountIn,omitempty"`
|
||||
SnowfallDepthIn *float64 `json:"snowfallDepthIn,omitempty" xml:"snowfallDepthIn,omitempty"`
|
||||
UVIndex *float64 `json:"uvIndex,omitempty" xml:"uvIndex,omitempty"`
|
||||
}
|
||||
|
||||
func ObservationPayload(obs *model.WeatherObservation, units Units) any {
|
||||
if obs == nil {
|
||||
return nil
|
||||
}
|
||||
if units == UnitsUS {
|
||||
converted := WeatherObservationUS{
|
||||
StationID: obs.StationID,
|
||||
StationName: obs.StationName,
|
||||
Timestamp: obs.Timestamp,
|
||||
ConditionCode: obs.ConditionCode,
|
||||
IsDay: copyBoolPtr(obs.IsDay),
|
||||
TextDescription: obs.TextDescription,
|
||||
TemperatureF: celsiusToFahrenheitPtr(obs.TemperatureC),
|
||||
DewpointF: celsiusToFahrenheitPtr(obs.DewpointC),
|
||||
WindDirectionDegrees: copyFloat64Ptr(obs.WindDirectionDegrees),
|
||||
WindSpeedMph: scalePtr(obs.WindSpeedKmh, kmhToMphFactor),
|
||||
WindGustMph: scalePtr(obs.WindGustKmh, kmhToMphFactor),
|
||||
BarometricPressureInHg: scalePtr(obs.BarometricPressurePa, paToInHgFactor),
|
||||
VisibilityMiles: scalePtr(obs.VisibilityMeters, metersToMilesFactor),
|
||||
RelativeHumidityPercent: copyFloat64Ptr(obs.RelativeHumidityPercent),
|
||||
ApparentTemperatureF: celsiusToFahrenheitPtr(obs.ApparentTemperatureC),
|
||||
PresentWeather: append([]model.PresentWeather(nil), obs.PresentWeather...),
|
||||
}
|
||||
return converted
|
||||
}
|
||||
return obs
|
||||
}
|
||||
|
||||
func ForecastPayload(run *model.WeatherForecastRun, units Units) any {
|
||||
if run == nil {
|
||||
return nil
|
||||
}
|
||||
if units == UnitsUS {
|
||||
out := WeatherForecastRunUS{
|
||||
LocationID: run.LocationID,
|
||||
LocationName: run.LocationName,
|
||||
IssuedAt: run.IssuedAt,
|
||||
UpdatedAt: copyTimePtr(run.UpdatedAt),
|
||||
Product: run.Product,
|
||||
Latitude: copyFloat64Ptr(run.Latitude),
|
||||
Longitude: copyFloat64Ptr(run.Longitude),
|
||||
ElevationFeet: scalePtr(run.ElevationMeters, metersToFeetFactor),
|
||||
Periods: make([]WeatherForecastPeriodUS, 0, len(run.Periods)),
|
||||
}
|
||||
for _, p := range run.Periods {
|
||||
out.Periods = append(out.Periods, WeatherForecastPeriodUS{
|
||||
StartTime: p.StartTime,
|
||||
EndTime: p.EndTime,
|
||||
Name: p.Name,
|
||||
IsDay: copyBoolPtr(p.IsDay),
|
||||
ConditionCode: p.ConditionCode,
|
||||
ConditionText: p.ConditionText,
|
||||
ProviderRawDescription: p.ProviderRawDescription,
|
||||
TextDescription: p.TextDescription,
|
||||
DetailedText: p.DetailedText,
|
||||
IconURL: p.IconURL,
|
||||
TemperatureF: celsiusToFahrenheitPtr(p.TemperatureC),
|
||||
TemperatureFMin: celsiusToFahrenheitPtr(p.TemperatureCMin),
|
||||
TemperatureFMax: celsiusToFahrenheitPtr(p.TemperatureCMax),
|
||||
DewpointF: celsiusToFahrenheitPtr(p.DewpointC),
|
||||
RelativeHumidityPercent: copyFloat64Ptr(p.RelativeHumidityPercent),
|
||||
WindDirectionDegrees: copyFloat64Ptr(p.WindDirectionDegrees),
|
||||
WindSpeedMph: scalePtr(p.WindSpeedKmh, kmhToMphFactor),
|
||||
WindGustMph: scalePtr(p.WindGustKmh, kmhToMphFactor),
|
||||
BarometricPressureInHg: scalePtr(p.BarometricPressurePa, paToInHgFactor),
|
||||
VisibilityMiles: scalePtr(p.VisibilityMeters, metersToMilesFactor),
|
||||
ApparentTemperatureF: celsiusToFahrenheitPtr(p.ApparentTemperatureC),
|
||||
CloudCoverPercent: copyFloat64Ptr(p.CloudCoverPercent),
|
||||
ProbabilityOfPrecipitationPercent: copyFloat64Ptr(p.ProbabilityOfPrecipitationPercent),
|
||||
PrecipitationAmountIn: scalePtr(p.PrecipitationAmountMm, mmToInchesFactor),
|
||||
SnowfallDepthIn: scalePtr(p.SnowfallDepthMM, mmToInchesFactor),
|
||||
UVIndex: copyFloat64Ptr(p.UVIndex),
|
||||
})
|
||||
}
|
||||
return out
|
||||
}
|
||||
return run
|
||||
}
|
||||
|
||||
func AlertsPayload(run *model.WeatherAlertRun, _ Units) any {
|
||||
if run == nil {
|
||||
return nil
|
||||
}
|
||||
return run
|
||||
}
|
||||
|
||||
func celsiusToFahrenheitPtr(v *float64) *float64 {
|
||||
if v == nil {
|
||||
return nil
|
||||
}
|
||||
out := (*v * celsiusToFahrenheitScale) + celsiusToFahrenheitOffset
|
||||
return &out
|
||||
}
|
||||
|
||||
func scalePtr(v *float64, factor float64) *float64 {
|
||||
if v == nil {
|
||||
return nil
|
||||
}
|
||||
out := *v * factor
|
||||
return &out
|
||||
}
|
||||
|
||||
func copyFloat64Ptr(v *float64) *float64 {
|
||||
if v == nil {
|
||||
return nil
|
||||
}
|
||||
out := *v
|
||||
return &out
|
||||
}
|
||||
|
||||
func copyBoolPtr(v *bool) *bool {
|
||||
if v == nil {
|
||||
return nil
|
||||
}
|
||||
out := *v
|
||||
return &out
|
||||
}
|
||||
|
||||
func copyTimePtr(v *time.Time) *time.Time {
|
||||
if v == nil {
|
||||
return nil
|
||||
}
|
||||
out := *v
|
||||
return &out
|
||||
}
|
||||
119
internal/core/payload_test.go
Normal file
119
internal/core/payload_test.go
Normal file
@@ -0,0 +1,119 @@
|
||||
package core
|
||||
|
||||
import (
|
||||
"math"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"gitea.maximumdirect.net/ejr/weatherfeeder/model"
|
||||
)
|
||||
|
||||
func TestObservationPayloadUS(t *testing.T) {
|
||||
obs := &model.WeatherObservation{
|
||||
StationID: "KSTL",
|
||||
Timestamp: time.Date(2026, 3, 20, 0, 0, 0, 0, time.UTC),
|
||||
ConditionCode: 2,
|
||||
TemperatureC: float64Ptr(20),
|
||||
DewpointC: float64Ptr(10),
|
||||
WindSpeedKmh: float64Ptr(100),
|
||||
WindGustKmh: float64Ptr(80),
|
||||
BarometricPressurePa: float64Ptr(101325),
|
||||
VisibilityMeters: float64Ptr(1609.344),
|
||||
ApparentTemperatureC: float64Ptr(25),
|
||||
RelativeHumidityPercent: float64Ptr(50),
|
||||
}
|
||||
|
||||
payload := ObservationPayload(obs, UnitsUS)
|
||||
converted, ok := payload.(WeatherObservationUS)
|
||||
if !ok {
|
||||
t.Fatalf("expected WeatherObservationUS payload, got %T", payload)
|
||||
}
|
||||
|
||||
assertApprox(t, converted.TemperatureF, 68.0, 0.0001)
|
||||
assertApprox(t, converted.WindSpeedMph, 62.1371192237, 0.0001)
|
||||
assertApprox(t, converted.BarometricPressureInHg, 29.9212524019, 0.0001)
|
||||
assertApprox(t, converted.VisibilityMiles, 1.0, 0.0001)
|
||||
|
||||
if converted.TemperatureF == nil || converted.DewpointF == nil || converted.ApparentTemperatureF == nil {
|
||||
t.Fatalf("expected converted Fahrenheit fields to be populated")
|
||||
}
|
||||
}
|
||||
|
||||
func TestForecastPayloadUS(t *testing.T) {
|
||||
issuedAt := time.Date(2026, 3, 20, 12, 0, 0, 0, time.UTC)
|
||||
updatedAt := issuedAt.Add(1 * time.Hour)
|
||||
run := &model.WeatherForecastRun{
|
||||
LocationID: "stl",
|
||||
IssuedAt: issuedAt,
|
||||
UpdatedAt: &updatedAt,
|
||||
Product: model.ForecastProductHourly,
|
||||
ElevationMeters: float64Ptr(1000),
|
||||
Periods: []model.WeatherForecastPeriod{
|
||||
{
|
||||
StartTime: issuedAt,
|
||||
EndTime: issuedAt.Add(1 * time.Hour),
|
||||
ConditionCode: 63,
|
||||
TemperatureC: float64Ptr(0),
|
||||
TemperatureCMin: float64Ptr(-5),
|
||||
TemperatureCMax: float64Ptr(5),
|
||||
WindSpeedKmh: float64Ptr(64.37376),
|
||||
PrecipitationAmountMm: float64Ptr(25.4),
|
||||
SnowfallDepthMM: float64Ptr(50.8),
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
payload := ForecastPayload(run, UnitsUS)
|
||||
converted, ok := payload.(WeatherForecastRunUS)
|
||||
if !ok {
|
||||
t.Fatalf("expected WeatherForecastRunUS payload, got %T", payload)
|
||||
}
|
||||
|
||||
assertApprox(t, converted.ElevationFeet, 3280.839895, 0.0001)
|
||||
if len(converted.Periods) != 1 {
|
||||
t.Fatalf("expected 1 period, got %d", len(converted.Periods))
|
||||
}
|
||||
period := converted.Periods[0]
|
||||
assertApprox(t, period.TemperatureF, 32.0, 0.0001)
|
||||
assertApprox(t, period.TemperatureFMin, 23.0, 0.0001)
|
||||
assertApprox(t, period.TemperatureFMax, 41.0, 0.0001)
|
||||
assertApprox(t, period.WindSpeedMph, 40.0, 0.0001)
|
||||
assertApprox(t, period.PrecipitationAmountIn, 1.0, 0.0001)
|
||||
assertApprox(t, period.SnowfallDepthIn, 2.0, 0.0001)
|
||||
}
|
||||
|
||||
func TestMetricPassthroughAndNilHandling(t *testing.T) {
|
||||
obs := &model.WeatherObservation{}
|
||||
metric := ObservationPayload(obs, UnitsMetric)
|
||||
metricObs, ok := metric.(*model.WeatherObservation)
|
||||
if !ok {
|
||||
t.Fatalf("expected metric payload to remain model type, got %T", metric)
|
||||
}
|
||||
if metricObs != obs {
|
||||
t.Fatalf("expected metric payload to be original pointer")
|
||||
}
|
||||
|
||||
if ObservationPayload(nil, UnitsUS) != nil {
|
||||
t.Fatalf("expected nil observation input to return nil payload")
|
||||
}
|
||||
if ForecastPayload(nil, UnitsUS) != nil {
|
||||
t.Fatalf("expected nil forecast input to return nil payload")
|
||||
}
|
||||
if AlertsPayload(nil, UnitsUS) != nil {
|
||||
t.Fatalf("expected nil alerts input to return nil payload")
|
||||
}
|
||||
}
|
||||
|
||||
func float64Ptr(v float64) *float64 {
|
||||
return &v
|
||||
}
|
||||
|
||||
func assertApprox(t *testing.T, got *float64, want, eps float64) {
|
||||
t.Helper()
|
||||
if got == nil {
|
||||
t.Fatalf("expected value near %f, got nil", want)
|
||||
}
|
||||
if math.Abs(*got-want) > eps {
|
||||
t.Fatalf("expected %f +/- %f, got %f", want, eps, *got)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user