OpenWeather's One Call API isn't free anymore

[oleg-glushko]

For this, I am going to use a weather service called OpenWeather. OpenWeather provides a free RESTful API weather service (where REST stands for REpresentational State Transfer) and will act as a more realistic example. I have also created a public NuGet package to serve the chapter and act as a client for the OpenWeather RESTful APIs.

It seems like OpenWeather doesn't provide this service for free anymore, so I can't follow the examples in your TDD book. I keep getting "401 Unauthorized" messages from the One Call API. Also, v2.5 states: "Invalid API key." and v3.0 says: "Please note that using One Call 3.0 requires a separate subscription to the One Call by Call plan.". But it accepts my key when I switch to the "forecast" endpoint.

[oleg-glushko]

While Adam hasn't answered, I adapted the client to use the "/forecast" endpoint, so I could continue reading the book.

using Newtonsoft.Json.Converters;
using Newtonsoft.Json;

namespace Uqs.Weather.ApiClient;

#pragma warning disable CS8618
public record WeatherResponse
{
    public long Cod;
    public long Message;
    public long Cnt;
    public Forecast[] List;
    public City City;
}

public record Forecast
{
    [JsonConverter(typeof(UnixDateTimeConverter))]
    public DateTime Dt;
    public Main Main;
    public Weather[] Weather;
    public Clouds Clouds;
    public Wind Wind;
    public long Visibility;
    public double Pop;
    public Rain Rain;
    public Snow Snow;
    public Sys Sys;
    [JsonProperty("dt_txt")]
    public DateTime DtTxt;
}

public record Main
{
    public double Temp;
    [JsonProperty("feels_like")]
    public double FeelsLike;
    [JsonProperty("temp_min")]
    public double TempMin;
    [JsonProperty("temp_max")]
    public double TempMax;
    public long Pressure;
    [JsonProperty("sea_level")]
    public long SeaLevel;
    [JsonProperty("grnd_level")]
    public long GrndLevel;
    public long Humidity;
    [JsonProperty("temp_kf")]
    public double TempKf;
}

public record Weather
{
    public long Id;
    public string Main;
    public string Description;
    public string Icon;
}

public record Clouds
{
    public long All;
}

public record Wind
{
    public double Speed;
    public long Deg;
    public double Gust;
}

public record Rain
{
    [JsonProperty("3h")]
    public decimal ThreeHours;
}

public record Snow
{
    [JsonProperty("3h")]
    public decimal ThreeHours;
}

public record Sys
{
    public string Pod;
}

public record City
{
    public int Id;
    public string Name;
    public Coord Coord;
    public string Country;
    public int Population;
    public long TimeZone;
    [JsonConverter(typeof(UnixDateTimeConverter))]
    public DateTime Sunrise;
    [JsonConverter(typeof(UnixDateTimeConverter))]
    public DateTime Sunset;
}

public record Coord
{
    public long Lat;
    public long Lon;
}

#pragma warning restore CS8618

namespace Uqs.Weather.ApiClient;

public interface IClient
{
    public Task<WeatherResponse> WeatherCallAsync(decimal latitude, decimal longitude, Units unit);
}

using Newtonsoft.Json;
using System.Globalization;
using System.Web;

namespace Uqs.Weather.ApiClient;

public class Client : IClient
{
    private readonly string _apiKey;
    private readonly HttpClient _httpClient;
    private const string BASE_URL = "https://api.openweathermap.org/data/2.5";

    public Client(string apiKey, HttpClient httpClient)
    {
        _apiKey = apiKey;
        _httpClient = httpClient;
    }

    public async Task<WeatherResponse> WeatherCallAsync(decimal latitude, decimal longitude, Units unit)
    {
        const string WEATHER_URL_TEMPLATE = "/forecast";
        var uriBuilder = new UriBuilder(BASE_URL + WEATHER_URL_TEMPLATE);
        var query = HttpUtility.ParseQueryString("");
        query["lat"] = latitude.ToString(CultureInfo.InvariantCulture);
        query["lon"] = longitude.ToString(CultureInfo.InvariantCulture);
        query["appid"] = _apiKey;
        query["units"] = unit.ToString().ToLower();
        uriBuilder.Query = query.ToString();

        var jsonResponse = await _httpClient.GetStringAsync(uriBuilder.Uri.AbsoluteUri);
        if (string.IsNullOrEmpty(jsonResponse))
        {
            throw new InvalidOperationException("No response from the service");
        }

        WeatherResponse weatherResponse = JsonConvert.DeserializeObject<WeatherResponse>(jsonResponse)!;

        return weatherResponse;
    }
}

[HttpGet("GetRealWeatherForecast")]
public async Task<IEnumerable<WeatherForecast>> GetReal()
{
    string apiKey = _config["OpenWeather:Key"];
    HttpClient httpClient = new();
    Client openWeatherClient = new(apiKey, httpClient);

    WeatherResponse res = await openWeatherClient.WeatherCallAsync(GREENWICH_LAT, GREENWICH_LON, Units.Metric);

    var noon = TimeSpan.FromHours(12);

    IEnumerable<WeatherForecast> wfs = res.List
        .Where(x => x.Dt.TimeOfDay == noon)
        .Select(x => new WeatherForecast() {
            Date = x.Dt,
            TemperatureC = (int)Math.Round(x.Main.Temp),
            Summary = MapFeelToTemp((int)Math.Round(x.Main.Temp));
        })
        // .Skip(1) // drop a current day
        .Take(FORECAST_DAYS)
        .ToList();

    return wfs;
}