Add forecast API

.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: test
+
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: ">=27"
+          gleam-version: "1.3.2"
+          rebar3-version: "3"
+          # elixir-version: "1.15.4"
+      - run: gleam deps download
+      - run: gleam test
+      - run: gleam format --check src test

README.md

@@ -1,4 +1,4 @@
-# 🌤️ Sunny (WIP)
+# 🌤️ Sunny
 
 An [Open-meteo API](https://open-meteo.com/) client written in Gleam. 
 
@@ -12,44 +12,64 @@ Makes it easier to get weather forecasts, current and past weather data with dif
 Add this package to your gleam project (not online yet)
 
 ```sh
-gleam add sunny@1
+gleam add sunny
 ```
 
-### Getting the coordinates of a city
+### Getting the current temperature in a city
+<details open>
+  <summary>Example code</summary>
+
 ```gleam
+import gleam/dict
+import gleam/io
+import gleam/option
+
 import sunny
+import sunny/api/forecast
+import sunny/api/forecast/instant
 import sunny/api/geocoding
+import sunny/measurement
 
 pub fn main() {
-  // Use `new_commercial("<your_api_key>")` if you have a commercial Open-meteo
-  // API access 
   let sunny = sunny.new()
 
   let assert Ok(location) =
-    geocoding.get_first_location(sunny, {
+    sunny
+    |> geocoding.get_first_location(
       geocoding.params("marseille")
-      |> geocoding.set_language(geocoding.French)
-    })
+      |> geocoding.set_language(geocoding.French),
+    )
+
+  let assert Ok(forecast_result) =
+    sunny
+    |> forecast.get_forecast(
+      forecast.params(geocoding.location_to_position(location))
+      |> forecast.set_current([instant.Temperature2m]),
+    )
+
+  let assert option.Some(current_data) = forecast_result.current
+
+  let assert Ok(temperature) =
+    current_data.data |> dict.get(instant.Temperature2m)
 
   io.println(
     location.name
-    <> " is located at :\n"
-    <> float.to_string(location.latitude)
-    <> "\n"
-    <> float.to_string(location.longitude),
+    <> "'s current temperature is : "
+    <> measurement.to_string(temperature),
   )
 }
 ```
+</details>
+
+More examples in the `test/examples` directory
 
 Further documentation can be found at <https://hexdocs.pm/sunny>.
 
 
 ## Contributing
 
-The project is open for contributions ! Make a fork, and once you made the changes you wanted, make a PR.
+Contributions are very welcome ! Make a fork, and once you made the changes you wanted, make a PR.
 
 ### Todo 
-- Weather forecast API
 - Historical forecast API
 - Air quality API
-- Make tests to make sure nothing is breaking

gleam.toml

@@ -1,5 +1,6 @@
 name = "sunny"
 version = "0.2.0"
+gleam = ">= 0.32.0"
 
 # Fill out these fields if you intend to generate HTML documentation or publish
 # your project to the Hex package manager.
@@ -14,9 +15,10 @@ version = "0.2.0"
 
 [dependencies]
 gleam_stdlib = ">= 0.34.0 and < 2.0.0"
-gleam_json = ">= 2.0.0 and < 3.0.0"
 gleam_http = ">= 3.6.0 and < 4.0.0"
 efetch = ">= 2.0.1 and < 3.0.0"
+birl = ">= 1.7.1 and < 2.0.0"
+gleam_json = ">= 1.0.1 and < 2.0.0"
 
 [dev-dependencies]
-gleeunit = ">= 1.0.0 and < 2.0.0"
+glacier = ">= 1.1.0 and < 2.0.0"

manifest.toml

@@ -2,20 +2,32 @@
 # You typically do not need to edit this file
 
 packages = [
+  { name = "argv", version = "1.0.2", build_tools = ["gleam"], requirements = [], otp_app = "argv", source = "hex", outer_checksum = "BA1FF0929525DEBA1CE67256E5ADF77A7CDDFE729E3E3F57A5BDCAA031DED09D" },
+  { name = "birl", version = "1.7.1", build_tools = ["gleam"], requirements = ["gleam_stdlib", "ranger"], otp_app = "birl", source = "hex", outer_checksum = "5C66647D62BCB11FE327E7A6024907C4A17954EF22865FE0940B54A852446D01" },
   { name = "efetch", version = "2.0.1", build_tools = ["gleam"], requirements = ["gleam_erlang", "gleam_fetch", "gleam_http", "gleam_httpc", "gleam_javascript", "gleam_stdlib"], otp_app = "efetch", source = "hex", outer_checksum = "849E38898C13436517C31A16D94C4642B3FFC444E26E293A14A1E3A8B7081C8A" },
+  { name = "filepath", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "filepath", source = "hex", outer_checksum = "EFB6FF65C98B2A16378ABC3EE2B14124168C0CE5201553DE652E2644DCFDB594" },
+  { name = "fs", version = "8.6.1", build_tools = ["rebar3"], requirements = [], otp_app = "fs", source = "hex", outer_checksum = "61EA2BDAEDAE4E2024D0D25C63E44DCCF65622D4402DB4A2DF12868D1546503F" },
+  { name = "glacier", version = "1.1.0", build_tools = ["gleam"], requirements = ["argv", "fs", "glacier_gleeunit", "gleam_community_ansi", "gleam_community_colour", "gleam_stdlib", "shellout", "simplifile"], otp_app = "glacier", source = "hex", outer_checksum = "FC194FE584147BA997BAA1D33305A64BFE3F01112DBC70D27A3AC491A4338CC7" },
+  { name = "glacier_gleeunit", version = "1.2.1001", build_tools = ["gleam"], requirements = ["argv", "gleam_stdlib"], otp_app = "glacier_gleeunit", source = "hex", outer_checksum = "F63ABBCE21DDBB0410B1365756BA4F897B504EA567A24462A1BC3291972FC981" },
+  { name = "gleam_community_ansi", version = "1.4.0", build_tools = ["gleam"], requirements = ["gleam_community_colour", "gleam_stdlib"], otp_app = "gleam_community_ansi", source = "hex", outer_checksum = "FE79E08BF97009729259B6357EC058315B6FBB916FAD1C2FF9355115FEB0D3A4" },
+  { name = "gleam_community_colour", version = "1.4.0", build_tools = ["gleam"], requirements = ["gleam_json", "gleam_stdlib"], otp_app = "gleam_community_colour", source = "hex", outer_checksum = "795964217EBEDB3DA656F5EB8F67D7AD22872EB95182042D3E7AFEF32D3FD2FE" },
   { name = "gleam_erlang", version = "0.25.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_erlang", source = "hex", outer_checksum = "054D571A7092D2A9727B3E5D183B7507DAB0DA41556EC9133606F09C15497373" },
   { name = "gleam_fetch", version = "1.0.1", build_tools = ["gleam"], requirements = ["gleam_http", "gleam_javascript", "gleam_stdlib"], otp_app = "gleam_fetch", source = "hex", outer_checksum = "4AE60B21A9A664137A79B1BEB93F751CB27F1DDED4086CA00C0260F5FFACBD80" },
   { name = "gleam_http", version = "3.6.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_http", source = "hex", outer_checksum = "8C07DF9DF8CC7F054C650839A51C30A7D3C26482AC241C899C1CEA86B22DBE51" },
   { name = "gleam_httpc", version = "2.2.0", build_tools = ["gleam"], requirements = ["gleam_http", "gleam_stdlib"], otp_app = "gleam_httpc", source = "hex", outer_checksum = "CF76C71002DEECF6DC5D9CA83D962728FAE166B57926BE442D827004D3C7DF1B" },
   { name = "gleam_javascript", version = "0.11.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_javascript", source = "hex", outer_checksum = "483631D3001FCE8EB12ADEAD5E1B808440038E96F93DA7A32D326C82F480C0B2" },
-  { name = "gleam_json", version = "2.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_json", source = "hex", outer_checksum = "CB10B0E7BF44282FB25162F1A24C1A025F6B93E777CCF238C4017E4EEF2CDE97" },
+  { name = "gleam_json", version = "1.0.1", build_tools = ["gleam"], requirements = ["gleam_stdlib", "thoas"], otp_app = "gleam_json", source = "hex", outer_checksum = "9063D14D25406326C0255BDA0021541E797D8A7A12573D849462CAFED459F6EB" },
   { name = "gleam_stdlib", version = "0.39.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "2D7DE885A6EA7F1D5015D1698920C9BAF7241102836CE0C3837A4F160128A9C4" },
-  { name = "gleeunit", version = "1.2.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "F7A7228925D3EE7D0813C922E062BFD6D7E9310F0BEE585D3A42F3307E3CFD13" },
+  { name = "ranger", version = "1.2.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "ranger", source = "hex", outer_checksum = "1566C272B1D141B3BBA38B25CB761EF56E312E79EC0E2DFD4D3C19FB0CC1F98C" },
+  { name = "shellout", version = "1.6.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "shellout", source = "hex", outer_checksum = "E2FCD18957F0E9F67E1F497FC9FF57393392F8A9BAEAEA4779541DE7A68DD7E0" },
+  { name = "simplifile", version = "2.0.1", build_tools = ["gleam"], requirements = ["filepath", "gleam_stdlib"], otp_app = "simplifile", source = "hex", outer_checksum = "5FFEBD0CAB39BDD343C3E1CCA6438B2848847DC170BA2386DF9D7064F34DF000" },
+  { name = "thoas", version = "1.2.1", build_tools = ["rebar3"], requirements = [], otp_app = "thoas", source = "hex", outer_checksum = "E38697EDFFD6E91BD12CEA41B155115282630075C2A727E7A6B2947F5408B86A" },
 ]
 
 [requirements]
+birl = { version = ">= 1.7.1 and < 2.0.0" }
 efetch = { version = ">= 2.0.1 and < 3.0.0" }
+glacier = { version = ">= 1.1.0 and < 2.0.0" }
 gleam_http = { version = ">= 3.6.0 and < 4.0.0" }
-gleam_json = { version = ">= 2.0.0 and < 3.0.0" }
+gleam_json = { version = ">= 1.0.1 and < 2.0.0"}
 gleam_stdlib = { version = ">= 0.34.0 and < 2.0.0" }
-gleeunit = { version = ">= 1.0.0 and < 2.0.0" }

src/sunny.gleam

@@ -5,15 +5,17 @@ import sunny/internal/defaults
 /// need anything more).
 /// 
 /// If you have a commercial Open-meteo API acess, check out `new_commercial`.
-/// 
-/// To change some client parameters (such as the base url), check out the
-/// `sunny/client` module.
 pub fn new() -> Client {
   Client(defaults.base_url, False, "")
 }
 
-/// Creates a new commercial Open-meteo client with the default values
+/// Creates a new commercial Open-meteo client with the default values.
 /// Takes your Open-meteo api key as an argument.
 pub fn new_commercial(key: String) -> Client {
   Client(defaults.base_url, True, key)
 }
+
+/// Takes a Client and returns a new one with a custom base url.
+pub fn set_base_url(client: Client, url: String) -> Client {
+  Client(..client, base_url: url)
+}