feat: commercial license: providable api key

open-meteo · Jun 9, 2023 · abfe7d0 · abfe7d0
1 parent 963f160
commit abfe7d0
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 7 deletions.
diff --git a/lib/src/main/kotlin/com/openmeteo/api/AirQuality.kt b/lib/src/main/kotlin/com/openmeteo/api/AirQuality.kt
@@ -30,7 +30,9 @@ object AirQuality : Endpoint(
         override val pastDays: Int? = null,
         override val timezone: Timezone? = null,
         val domains: String? = null,
-    ) : Q.Coordinate, Q.Hourly, Q.TimeFormat, Q.DateRange, Q.PastDays, Q.Timezone
+        override val apikey: String?,
+    ) : Q.Coordinate, Q.Hourly, Q.TimeFormat, Q.DateRange, Q.PastDays, Q.Timezone,
+        Q.CommercialLicense
 
     @Serializable
     open class Response(

diff --git a/lib/src/main/kotlin/com/openmeteo/api/Forecast.kt b/lib/src/main/kotlin/com/openmeteo/api/Forecast.kt
@@ -48,9 +48,11 @@ object Forecast : Endpoint(
         override val elevation: Float? = null,
         override val models: String? = null,
         override val cellSelection: CellSelection? = null,
+        override val apikey: String?,
     ) : Q.Coordinate, Q.Elevation, Q.Daily, Q.Hourly, Q.TimeFormat, Q.DateRange,
         Q.PastDays, Q.ForecastDays, Q.CurrentWeather, Q.Timezone, Q.Models,
-        Q.TemperatureUnit, Q.WindSpeedUnit, Q.PrecipitationUnit, Q.CellSelection
+        Q.TemperatureUnit, Q.WindSpeedUnit, Q.PrecipitationUnit, Q.CellSelection,
+        Q.CommercialLicense
 
     @Serializable
     open class Response(

diff --git a/lib/src/main/kotlin/com/openmeteo/api/Historical.kt b/lib/src/main/kotlin/com/openmeteo/api/Historical.kt
@@ -42,8 +42,10 @@ object Historical : Endpoint(
         override val elevation: Float? = null,
         override val models: String? = null,
         override val cellSelection: CellSelection? = null,
+        override val apikey: String?,
     ) : Q.Coordinate, Q.Elevation, Q.DateRange, Q.Daily, Q.Hourly, Q.TimeFormat, Q.Timezone,
-        Q.TemperatureUnit, Q.WindSpeedUnit, Q.PrecipitationUnit, Q.Models, Q.CellSelection
+        Q.TemperatureUnit, Q.WindSpeedUnit, Q.PrecipitationUnit, Q.Models, Q.CellSelection,
+        Q.CommercialLicense
 
     @Serializable
     open class Response(

diff --git a/lib/src/main/kotlin/com/openmeteo/api/Marine.kt b/lib/src/main/kotlin/com/openmeteo/api/Marine.kt
@@ -35,8 +35,9 @@ object Marine : Endpoint(
         override val cellSelection: CellSelection? = null,
         @SerialName("length_unit")
         override val lengthUnit: LengthUnit? = null,
+        override val apikey: String? = null,
     ) : Q.Coordinate, Q.Daily, Q.Hourly, Q.TimeFormat, Q.Timezone, Q.PastDays,
-        Q.DateRange, Q.CellSelection, Q.LengthUnit
+        Q.DateRange, Q.CellSelection, Q.LengthUnit, Q.CommercialLicense
 
     @Serializable
     open class Response(

diff --git a/lib/src/main/kotlin/com/openmeteo/api/common/http/Endpoint.kt b/lib/src/main/kotlin/com/openmeteo/api/common/http/Endpoint.kt
@@ -80,11 +80,16 @@ open class Endpoint(
      * (from the specified query format or, if undefined, from json)
      */
     inline fun <reified R : Response, reified Q : Query> query(query: Q) =
-        runCatching { Query.toURL(query, context) }
+        Query.toURL(query, context)
+            .runCatching {
+                // set the "customer-" prefix to the host(name) if an api key was provided
+                val prefix = if (query is Query.CommercialLicense && query.apikey != null)
+                    "customer-" else ""
+                URL(protocol, prefix + host, port, file /* includes query */)
+            }
             .mapCatching { get(it) }
             .mapCatching {
                 if (query is Query.ContentFormat && query.format == ContentFormat.ProtoBuf)
-                    protoBuf<R>(it)
-                else json<R>(it)
+                    protoBuf<R>(it) else json<R>(it)
             }
 }
diff --git a/lib/src/main/kotlin/com/openmeteo/api/common/query/Query.kt b/lib/src/main/kotlin/com/openmeteo/api/common/query/Query.kt
@@ -218,4 +218,17 @@ interface Query {
         val cellSelection: com.openmeteo.api.common.CellSelection?
     }
 
+    /**
+     * Query that may be retrieved with a commercial license (api key)
+     */
+    interface CommercialLicense : Query {
+        /**
+         * The api key (commercial usage)
+         * When commerical usage use `customer-` prefix on all domains:
+         * - `https://customer-archive-api.open-meteo.com/v1/archive`
+         * - `https://customer-marine-api.open-meteo.com/v1/marine`
+         */
+        val apikey: String?
+    }
+
 }