open-meteo 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1fd59fe55c171c4cefb24b80613933b28d10040fdff524490dcd9e6e2ed0514
-  data.tar.gz: 8231a53ba4250c627db4c44eb513f6f0cf41631c3a5ba3c3934a20d0ee731562
+  metadata.gz: c4d1b8d00c232c9cd399effc4246167fc6bdcf848cbe77d6ca4c84fa177a0979
+  data.tar.gz: 5e87b95a9ed8876b46bfce225fde195f2e43f5deb7b816e6271eacf76db54968
 SHA512:
-  metadata.gz: ec997727575db6186329054eca41b3c60c6729571788d012c57a74ed7c0314308ee75e11dc201287cc396d6be570b1e38ef675dd67ebd79e41d3d5a645de7957
-  data.tar.gz: 4055bd5d3d7d63c40f3cfa8eae6822f755d806c48b7e700e65ffd2de14bdd3761373318bba2699752c97db26621893cefb3ec1b34caa87d9151ca5c05b112d40
+  metadata.gz: 36ac57fc2acb0062996b48c3736058e2d7b2e4ab29dd4eea3ea9857d768bbf4a14a50a5496d44c69a1b307daf8c5d38e600a3f6b4bc359cd6084eebc646a0eec
+  data.tar.gz: a71d7e7e08144eb2dc61c850bb45e66bf1614031bddc8405c6babeb02a46572457d9796c6387b27fb43882355d514676c5eaa092e1dec97ab5f3e8c1dd6f5196

data/lib/open_meteo/application_contract.rb

@@ -0,0 +1,26 @@
+module OpenMeteo
+  ##
+  # Shared functionality for dry contracts.
+  class ApplicationContract < Dry::Validation::Contract
+    ##
+    # A validation error that can be raised on contract validation.
+    class ValidationError < StandardError
+      attr_reader :result, :errors
+
+      def initialize(result)
+        @errors = result.errors
+        first_error_key = result.errors.first.path.first
+        first_error_value = result[first_error_key]
+
+        super(
+          "Validation failed: :#{first_error_key} is #{first_error_value} but #{errors.first.text}",
+        )
+      end
+    end
+
+    def self.validate!(object)
+      result = new.call(object)
+      raise ValidationError, result unless result.errors.empty?
+    end
+  end
+end

data/lib/open_meteo/forecast/variables/general.rb

@@ -1,3 +1,5 @@
+require_relative "general_contract"
+
 module OpenMeteo
   class Forecast
     module Variables
@@ -5,18 +7,22 @@ module OpenMeteo
       # The Variables for a general request (meaning without a specific model) to the OpenMeteo API.
       #
       # See https://open-meteo.com/en/docs
-      class General
-        attr_reader :current, :hourly, :daily
-
-        def initialize(current:, hourly:, daily:)
-          @current = current
-          @hourly = hourly
-          @daily = daily
-        end
+      class General < Dry::Struct
+        attribute(
+          :current,
+          OpenMeteo::Types::Strict::Array.of(OpenMeteo::Types::Strict::Symbol).default([].freeze),
+        )
+        attribute(
+          :hourly,
+          OpenMeteo::Types::Strict::Array.of(OpenMeteo::Types::Strict::Symbol).default([].freeze),
+        )
+        attribute(
+          :daily,
+          OpenMeteo::Types::Strict::Array.of(OpenMeteo::Types::Strict::Symbol).default([].freeze),
+        )
 
-        def validate
-          # FIXME: Placeholder for validation
-          true
+        def validate!
+          GeneralContract.validate!(to_hash)
         end
 
         def to_get_params

data/lib/open_meteo/forecast/variables/general_contract.rb

@@ -0,0 +1,286 @@
+module OpenMeteo
+  class Forecast
+    module Variables
+      ##
+      # Validation contract for OpenMeteo::Forecast::Variables::General.
+      #
+      # See https://open-meteo.com/en/docs
+      class GeneralContract < OpenMeteo::ApplicationContract # rubocop:disable Metrics/ClassLength
+        params do
+          required(:current).array(:symbol)
+          required(:hourly).array(:symbol)
+          required(:daily).array(:symbol)
+        end
+
+        CURRENT_VARIABALES = %i[
+          apparent_temperature
+          cloudcover
+          is_day
+          precipitation
+          pressure_msl
+          rain
+          relativehumidity_2m
+          showers
+          snowfall
+          surface_pressure
+          temperature_2m
+          weathercode
+          winddirection_10m
+          windgusts_10m
+          windspeed_10m
+        ].freeze
+
+        HOURLY_VARIABLES_BASE = %i[
+          apparent_temperature
+          cloudcover
+          cloudcover_high
+          cloudcover_low
+          cloudcover_mid
+          dewpoint_2m
+          et0_fao_evapotranspiration
+          evapotranspiration
+          precipitation
+          precipitation_probability
+          pressure_msl
+          rain
+          relativehumidity_2m
+          showers
+          snow_depth
+          snowfall
+          soil_moisture_0_to_1cm
+          soil_moisture_1_to_3cm
+          soil_moisture_27_to_81cm
+          soil_moisture_3_to_9cm
+          soil_moisture_9_to_27cm
+          soil_temperature_0cm
+          soil_temperature_18cm
+          soil_temperature_54cm
+          soil_temperature_6cm
+          surface_pressure
+          temperature_120m
+          temperature_180m
+          temperature_2m
+          temperature_80m
+          vapor_pressure_deficit
+          visibility
+          weathercode
+          winddirection_10m
+          winddirection_120m
+          winddirection_180m
+          winddirection_80m
+          windgusts_10m
+          windspeed_10m
+          windspeed_120m
+          windspeed_180m
+          windspeed_80m
+        ].freeze
+
+        HOURLY_VARIABLES_ADDITIONAL = %i[
+          uv_index
+          uv_index_clear_sky
+          is_day
+          cape
+          freezinglevel_height
+        ].freeze
+
+        HOURLY_VARIABLES_SOLAR_RADIATION = %i[
+          shortwave_radiation
+          direct_radiation
+          diffuse_radiation
+          direct_normal_irradiance
+          terrestrial_radiation
+          shortwave_radiation_instant
+          direct_radiation_instant
+          diffuse_radiation_instant
+          direct_normal_irradiance_instant
+          terrestrial_radiation_instant
+        ].freeze
+
+        HOURLY_VARIABLES_PRESSURE_LEVEL_TEMPERATURE = %i[
+          temperature_1000hPa
+          temperature_975hPa
+          temperature_950hPa
+          temperature_925hPa
+          temperature_900hPa
+          temperature_850hPa
+          temperature_800hPa
+          temperature_700hPa
+          temperature_600hPa
+          temperature_500hPa
+          temperature_400hPa
+          temperature_300hPa
+          temperature_250hPa
+          temperature_200hPa
+          temperature_150hPa
+          temperature_100hPa
+          temperature_70hPa
+          temperature_50hPa
+          temperature_30hPa
+        ].freeze
+
+        HOURLY_VARIABLES_PRESSURE_LEVEL_RELATIVE_HUMIDITY = %i[
+          relativehumidity_1000hPa
+          relativehumidity_975hPa
+          relativehumidity_950hPa
+          relativehumidity_925hPa
+          relativehumidity_900hPa
+          relativehumidity_850hPa
+          relativehumidity_800hPa
+          relativehumidity_700hPa
+          relativehumidity_600hPa
+          relativehumidity_500hPa
+          relativehumidity_400hPa
+          relativehumidity_300hPa
+          relativehumidity_250hPa
+          relativehumidity_200hPa
+          relativehumidity_150hPa
+          relativehumidity_100hPa
+          relativehumidity_70hPa
+          relativehumidity_50hPa
+          relativehumidity_30hPa
+        ].freeze
+
+        HOURLY_VARIABLES_PRESSURE_LEVEL_CLOUDCOVER = %i[
+          cloudcover_1000hPa
+          cloudcover_975hPa
+          cloudcover_950hPa
+          cloudcover_925hPa
+          cloudcover_900hPa
+          cloudcover_850hPa
+          cloudcover_800hPa
+          cloudcover_700hPa
+          cloudcover_600hPa
+          cloudcover_500hPa
+          cloudcover_400hPa
+          cloudcover_300hPa
+          cloudcover_250hPa
+          cloudcover_200hPa
+          cloudcover_150hPa
+          cloudcover_100hPa
+          cloudcover_70hPa
+          cloudcover_50hPa
+          cloudcover_30hPa
+        ].freeze
+
+        HOURLY_VARIABLES_PRESSURE_LEVEL_WIND_SPEED = %i[
+          windspeed_1000hPa
+          windspeed_975hPa
+          windspeed_950hPa
+          windspeed_925hPa
+          windspeed_900hPa
+          windspeed_850hPa
+          windspeed_800hPa
+          windspeed_700hPa
+          windspeed_600hPa
+          windspeed_500hPa
+          windspeed_400hPa
+          windspeed_300hPa
+          windspeed_250hPa
+          windspeed_200hPa
+          windspeed_150hPa
+          windspeed_100hPa
+          windspeed_70hPa
+          windspeed_50hPa
+          windspeed_30hPa
+        ].freeze
+
+        HOURLY_VARIABLES_PRESSURE_LEVEL_WIND_DIRECTION = %i[
+          winddirection_1000hPa
+          winddirection_975hPa
+          winddirection_950hPa
+          winddirection_925hPa
+          winddirection_900hPa
+          winddirection_850hPa
+          winddirection_800hPa
+          winddirection_700hPa
+          winddirection_600hPa
+          winddirection_500hPa
+          winddirection_400hPa
+          winddirection_300hPa
+          winddirection_250hPa
+          winddirection_200hPa
+          winddirection_150hPa
+          winddirection_100hPa
+          winddirection_70hPa
+          winddirection_50hPa
+          winddirection_30hPa
+        ].freeze
+
+        HOURLY_VARIABLES_PRESSURE_LEVEL_GEOPOTENTIAL_HEIGHT = %i[
+          geopotential_height_1000hPa
+          geopotential_height_975hPa
+          geopotential_height_950hPa
+          geopotential_height_925hPa
+          geopotential_height_900hPa
+          geopotential_height_850hPa
+          geopotential_height_800hPa
+          geopotential_height_700hPa
+          geopotential_height_600hPa
+          geopotential_height_500hPa
+          geopotential_height_400hPa
+          geopotential_height_300hPa
+          geopotential_height_250hPa
+          geopotential_height_200hPa
+          geopotential_height_150hPa
+          geopotential_height_100hPa
+          geopotential_height_70hPa
+          geopotential_height_50hPa
+          geopotential_height_30hPa
+        ].freeze
+
+        HOURLY_VARIABLES = [
+          *HOURLY_VARIABLES_BASE,
+          *HOURLY_VARIABLES_ADDITIONAL,
+          *HOURLY_VARIABLES_SOLAR_RADIATION,
+          *HOURLY_VARIABLES_PRESSURE_LEVEL_TEMPERATURE,
+          *HOURLY_VARIABLES_PRESSURE_LEVEL_RELATIVE_HUMIDITY,
+          *HOURLY_VARIABLES_PRESSURE_LEVEL_CLOUDCOVER,
+          *HOURLY_VARIABLES_PRESSURE_LEVEL_WIND_SPEED,
+          *HOURLY_VARIABLES_PRESSURE_LEVEL_WIND_DIRECTION,
+          *HOURLY_VARIABLES_PRESSURE_LEVEL_GEOPOTENTIAL_HEIGHT,
+        ].freeze
+
+        DAILY_VARIABLES = %i[
+          apparent_temperature_max
+          apparent_temperature_min
+          et0_fao_evapotranspiration
+          precipitation_hours
+          precipitation_probability_max
+          precipitation_sum
+          rain_sum
+          shortwave_radiation_sum
+          showers_sum
+          snowfall_sum
+          sunrise
+          sunset
+          temperature_2m_max
+          temperature_2m_min
+          uv_index_clear_sky_max
+          uv_index_max
+          weathercode
+          winddirection_10m_dominant
+          windgusts_10m_max
+          windspeed_10m_max
+        ].freeze
+
+        rule(:current).each do
+          unless CURRENT_VARIABALES.include?(value)
+            key.failure("must be one of #{CURRENT_VARIABALES.join(", ")}")
+          end
+        end
+
+        rule(:hourly).each do
+          unless HOURLY_VARIABLES.include?(value)
+            key.failure("must be one of #{HOURLY_VARIABLES.join(", ")}")
+          end
+        end
+
+        rule(:daily).each do
+          unless DAILY_VARIABLES.include?(value)
+            key.failure("must be one of #{DAILY_VARIABLES.join(", ")}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/open_meteo/forecast.rb

@@ -9,6 +9,8 @@ module OpenMeteo
   class Forecast
     class ForecastModelNotImplemented < StandardError
     end
+    class WrongLocationType < StandardError
+    end
 
     def initialize(client: OpenMeteo::Client.new)
       @client = client
@@ -19,10 +21,10 @@ module OpenMeteo
 
       model_definition = get_model_definition(model)
 
-      variables = model_definition[:variables_class].new(**variables)
-      variables.validate
+      variables_object = model_definition[:variables_class].new(**variables)
+      variables_object.validate!
 
-      get_forecast(model_definition[:endpoint], location, variables)
+      get_forecast(model_definition[:endpoint], location, variables_object)
     end
 
     private
@@ -42,7 +44,7 @@ module OpenMeteo
     end
 
     def ensure_valid_location(location)
-      raise "Not an OpenMeteo::Location" unless location.is_a? OpenMeteo::Location
+      raise WrongLocationType unless location.is_a? OpenMeteo::Location
 
       location.validate!
     end

data/lib/open_meteo/location.rb

@@ -1,17 +1,14 @@
+require_relative "location_contract"
+
 module OpenMeteo
   ##
   # A location for a request to OpenMeteo.
-  class Location
-    attr_reader :latitude, :longitude
-
-    def initialize(longitude:, latitude:)
-      @longitude = longitude
-      @latitude = latitude
-    end
+  class Location < Dry::Struct
+    attribute :latitude, OpenMeteo::Types::Strict::Float
+    attribute :longitude, OpenMeteo::Types::Strict::Float
 
     def validate!
-      # FIXME: Placeholder for validation
-      true
+      LocationContract.validate!(to_hash)
     end
 
     def to_get_params

data/lib/open_meteo/location_contract.rb

@@ -0,0 +1,14 @@
+module OpenMeteo
+  ##
+  # Validation contract for OpenMeteo::Location.
+  class LocationContract < OpenMeteo::ApplicationContract
+    params do
+      required(:latitude).filled(:float)
+      required(:longitude).filled(:float)
+    end
+
+    rule(:latitude) { key.failure("must be within [-90;90]") if value < -90 || value > 90 }
+
+    rule(:longitude) { key.failure("must be within [-180;180]") if value < -180 || value > 180 }
+  end
+end

data/lib/open_meteo/types.rb

@@ -0,0 +1,13 @@
+require "dry-types"
+require "dry-struct"
+require "dry-validation"
+
+require_relative "application_contract"
+
+module OpenMeteo
+  ##
+  # The types from the dry-types gem.
+  module Types
+    include Dry.Types()
+  end
+end

data/lib/open_meteo/version.rb

@@ -1,3 +1,3 @@
 module OpenMeteo
-  VERSION = "0.0.2".freeze
+  VERSION = "0.0.3".freeze
 end

data/lib/open_meteo.rb

@@ -1,2 +1,3 @@
-require "open_meteo/forecast"
+require "open_meteo/types"
 require "open_meteo/location"
+require "open_meteo/forecast"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open-meteo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Peter Morgenstern
@@ -10,6 +10,46 @@ bindir: bin
 cert_chain: []
 date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -38,12 +78,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/open_meteo.rb
+- lib/open_meteo/application_contract.rb
 - lib/open_meteo/client.rb
 - lib/open_meteo/client/config.rb
 - lib/open_meteo/client/url_builder.rb
 - lib/open_meteo/forecast.rb
 - lib/open_meteo/forecast/variables/general.rb
+- lib/open_meteo/forecast/variables/general_contract.rb
 - lib/open_meteo/location.rb
+- lib/open_meteo/location_contract.rb
+- lib/open_meteo/types.rb
 - lib/open_meteo/version.rb
 homepage: https://github.com/open-meteo-ruby/open-meteo-ruby
 licenses:
@@ -65,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: A client for OpenMeteo weather data