open-meteo 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1fd59fe55c171c4cefb24b80613933b28d10040fdff524490dcd9e6e2ed0514
-  data.tar.gz: 8231a53ba4250c627db4c44eb513f6f0cf41631c3a5ba3c3934a20d0ee731562
+  metadata.gz: 823b394116c34b4acad4f7a01f7e48aa70db6b1953f316cf65c5fe7bc10c22fd
+  data.tar.gz: 472b5dd09142afea3e1f496654719150fa3d172a05ef6519d188d558e8f6e2d5
 SHA512:
-  metadata.gz: ec997727575db6186329054eca41b3c60c6729571788d012c57a74ed7c0314308ee75e11dc201287cc396d6be570b1e38ef675dd67ebd79e41d3d5a645de7957
-  data.tar.gz: 4055bd5d3d7d63c40f3cfa8eae6822f755d806c48b7e700e65ffd2de14bdd3761373318bba2699752c97db26621893cefb3ec1b34caa87d9151ca5c05b112d40
+  metadata.gz: c52a61be8ca120808d296925106c5d19c4486b6cf0835606a05484be01f4f25268af330baae510ce3dd0f6b240391673dca8e4bdcac5121742330c6a81b3c8e3
+  data.tar.gz: 686bdb878b51779187d22b1262d479fedcff9f179761cfc4049754f7bd213d44ff19196f0ba5c4eb849de647722ab7694cda6f3c4190df491bef4e91776e3c1a

data/lib/open_meteo/client/config.rb

@@ -3,10 +3,11 @@ module OpenMeteo
     ##
     # The configuration for the OpenMeteo::Client.
     class Config
-      attr_reader :host
+      attr_reader :host, :logger
 
-      def initialize(host: "api.open-meteo.com")
-        @host = host
+      def initialize(host: nil, logger: nil)
+        @host = host || OpenMeteo.configuration.host
+        @logger = logger || OpenMeteo.configuration.logger
       end
 
       def url

data/lib/open_meteo/configuration.rb

@@ -0,0 +1,31 @@
+module OpenMeteo
+  ##
+  # The global configuration of the OpenMeteo client.
+  #
+  # @see OpenMeteo.configure
+  class Configuration
+    def initialize
+      @config = {}
+    end
+
+    ##
+    # Create a getter and a setter for a setting.
+    #
+    # If the default value is a Proc, it will be called on initialize.
+    #
+    # @param name: Symbol
+    # @param default: Proc | Object
+    def self.add_setting(name, default)
+      define_method name do
+        @config[name] ||= default.is_a?(Proc) ? default.call : default
+      end
+
+      define_method "#{name}=" do |value|
+        @config[name] = value
+      end
+    end
+
+    add_setting :logger, -> { Logger.new($stdout) }
+    add_setting :host, "api.open-meteo.com"
+  end
+end

data/lib/open_meteo/entities/contracts/application_contract.rb

@@ -0,0 +1,30 @@
+module OpenMeteo
+  module Entities
+    module Contracts
+      ##
+      # 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
+  end
+end

data/lib/open_meteo/entities/contracts/location_contract.rb

@@ -0,0 +1,18 @@
+module OpenMeteo
+  module Entities
+    module Contracts
+      ##
+      # Validation contract for OpenMeteo::Entities::Location.
+      class LocationContract < OpenMeteo::Entities::Contracts::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
+  end
+end

data/lib/open_meteo/entities/forecast/current.rb

@@ -0,0 +1,20 @@
+module OpenMeteo
+  module Entities
+    class Forecast
+      ##
+      # A forecast Entity for current data returned by OpenMeteo
+      class Current
+        attr_reader :item, :units, :raw_json_current, :raw_json_current_units
+
+        def initialize(json_current, json_current_units)
+          @item = json_current && OpenMeteo::Entities::Forecast::Item.new(json_current)
+          @units =
+            json_current_units && OpenMeteo::Entities::Forecast::Units.new(json_current_units)
+
+          @raw_json_current = json_current
+          @raw_json_current_units = json_current_units
+        end
+      end
+    end
+  end
+end

data/lib/open_meteo/entities/forecast/daily.rb

@@ -0,0 +1,33 @@
+module OpenMeteo
+  module Entities
+    class Forecast
+      ##
+      # A forecast Entity for daily data returned by OpenMeteo
+      class Daily
+        attr_reader :items, :units, :raw_json_daily, :raw_json_daily_units
+
+        def initialize(json_daily, json_daily_units)
+          @items = initialize_items(json_daily)
+          @units = json_daily_units && OpenMeteo::Entities::Forecast::Units.new(json_daily_units)
+
+          @raw_json_daily = json_daily
+          @raw_json_daily_units = json_daily_units
+        end
+
+        private
+
+        def initialize_items(json_daily)
+          json_daily["time"]
+            .map do |element|
+              json_daily
+                .keys
+                .each_with_object({}) do |attr, json_item|
+                  json_item[attr] = json_daily[attr][json_daily["time"].index(element)]
+                end
+            end
+            .map { |json_item| OpenMeteo::Entities::Forecast::Item.new(json_item) }
+        end
+      end
+    end
+  end
+end

data/lib/open_meteo/entities/forecast/hourly.rb

@@ -0,0 +1,33 @@
+module OpenMeteo
+  module Entities
+    class Forecast
+      ##
+      # A forecast Entity for hourly data returned by OpenMeteo
+      class Hourly
+        attr_reader :items, :units, :raw_json_hourly, :raw_json_hourly_units
+
+        def initialize(json_hourly, json_hourly_units)
+          @items = initialize_items(json_hourly)
+          @units = json_hourly_units && OpenMeteo::Entities::Forecast::Units.new(json_hourly_units)
+
+          @raw_json_hourly = json_hourly
+          @raw_json_hourly_units = json_hourly_units
+        end
+
+        private
+
+        def initialize_items(json_hourly)
+          json_hourly["time"]
+            .map do |element|
+              json_hourly
+                .keys
+                .each_with_object({}) do |attr, json_item|
+                  json_item[attr] = json_hourly[attr][json_hourly["time"].index(element)]
+                end
+            end
+            .map { |json_item| OpenMeteo::Entities::Forecast::Item.new(json_item) }
+        end
+      end
+    end
+  end
+end

data/lib/open_meteo/entities/forecast/item.rb

@@ -0,0 +1,81 @@
+module OpenMeteo
+  module Entities
+    class Forecast
+      ##
+      # A forecast entity for a data item returned by OpenMeteo
+      class Item
+        class UnknownWeatherCode < StandardError
+        end
+
+        ##
+        # The conversion map of weather_codes to a more descriptive symbol.
+        #
+        # See "WMO Weather interpretation codes (WW)" on
+        # https://open-meteo.com/en/docs
+        WMO_CODE_TO_SYMBOL_MAP = {
+          0 => :clear_sky,
+          1 => :mainly_clear,
+          2 => :partly_cloudy,
+          3 => :overcast,
+          45 => :fog,
+          48 => :depositing_rime_fog,
+          51 => :drizzle_light,
+          53 => :drizzle_moderate,
+          55 => :drizzle_dense,
+          56 => :freezing_drizzle_light,
+          57 => :freezing_drizzle_dense,
+          61 => :rain_slight,
+          63 => :rain_moderate,
+          65 => :rain_heavy,
+          66 => :freezing_rain_slight,
+          67 => :freezing_rain_heavy,
+          71 => :snow_slight,
+          73 => :snow_moderate,
+          75 => :snow_heavy,
+          77 => :snow_grains,
+          80 => :rain_showers_slight,
+          81 => :rain_showers_moderate,
+          82 => :rain_showers_violent,
+          85 => :snow_showers_slight,
+          86 => :snow_showers_heavy,
+          95 => :thunderstorm_slight_or_moderate,
+          96 => :thunderstorm_with_slight_hail,
+          99 => :thunderstorm_with_heavy_hail,
+        }.freeze
+
+        attr_reader :raw_json, :attributes, :time
+
+        def initialize(json_data)
+          @raw_json = json_data
+
+          @attributes = json_data.keys
+          @time = json_data["time"]
+        end
+
+        ##
+        # Provide a symbol for the weather_code.
+        #
+        # @see WMO_CODE_TO_SYMBOL_MAP
+        def weather_code_symbol
+          return if weather_code.nil?
+
+          WMO_CODE_TO_SYMBOL_MAP.fetch(weather_code) { raise UnknownWeatherCode, weather_code }
+        end
+
+        private
+
+        def method_missing(name, *args)
+          if raw_json.key?(name.to_s)
+            raw_json[name.to_s]
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(name, include_private = false)
+          raw_json.key?(name.to_s) || super
+        end
+      end
+    end
+  end
+end

data/lib/open_meteo/entities/forecast/units.rb

@@ -0,0 +1,32 @@
+module OpenMeteo
+  module Entities
+    class Forecast
+      ##
+      # A forecast entity for data units returned by OpenMeteo
+      class Units
+        attr_reader :raw_json_units, :attributes, :time
+
+        def initialize(json_units)
+          @raw_json_units = json_units
+
+          @attributes = json_units.keys
+          @time = json_units["time"]
+        end
+
+        private
+
+        def method_missing(name, *args)
+          if raw_json_units.key?(name.to_s)
+            raw_json_units[name.to_s]
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(name, include_private = false)
+          raw_json_units.key?(name.to_s) || super
+        end
+      end
+    end
+  end
+end

data/lib/open_meteo/entities/forecast.rb

@@ -0,0 +1,37 @@
+require_relative "forecast/current"
+require_relative "forecast/hourly"
+require_relative "forecast/daily"
+require_relative "forecast/units"
+require_relative "forecast/item"
+
+module OpenMeteo
+  module Entities
+    #
+    # A forecast Entity with data returned by OpenMeteo
+    class Forecast
+      attr_reader :attributes, :current, :hourly, :daily, :raw_json
+
+      def initialize(json_body)
+        @raw_json = json_body
+
+        @current =
+          json_body["current"] &&
+            OpenMeteo::Entities::Forecast::Current.new(
+              json_body["current"],
+              json_body["current_units"],
+            )
+        @hourly =
+          json_body["hourly"] &&
+            OpenMeteo::Entities::Forecast::Hourly.new(
+              json_body["hourly"],
+              json_body["hourly_units"],
+            )
+        @daily =
+          json_body["daily"] &&
+            OpenMeteo::Entities::Forecast::Daily.new(json_body["daily"], json_body["daily_units"])
+
+        @attributes = json_body.keys
+      end
+    end
+  end
+end

data/lib/open_meteo/entities/location.rb

@@ -0,0 +1,20 @@
+require_relative "contracts/location_contract"
+
+module OpenMeteo
+  module Entities
+    ##
+    # A location for a request to OpenMeteo.
+    class Location < Dry::Struct
+      attribute :latitude, OpenMeteo::Types::Coercible::Decimal
+      attribute :longitude, OpenMeteo::Types::Coercible::Decimal
+
+      def validate!
+        OpenMeteo::Entities::Contracts::LocationContract.validate!(to_hash)
+      end
+
+      def to_get_params
+        { latitude:, longitude: }
+      end
+    end
+  end
+end

data/lib/open_meteo/errors.rb

@@ -0,0 +1,6 @@
+module OpenMeteo
+  module Errors
+    class ResponseError < StandardError
+    end
+  end
+end

data/lib/open_meteo/forecast/variables.rb

@@ -0,0 +1,32 @@
+module OpenMeteo
+  class Forecast
+    ##
+    # The Variables for a forecast request to the OpenMeteo API.
+    #
+    # See https://open-meteo.com/en/docs
+    class Variables < 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 to_get_params
+        get_params = {}
+
+        get_params[:current] = current.join(",") if current != []
+        get_params[:hourly] = hourly.join(",") if hourly != []
+        get_params[:daily] = daily.join(",") if daily != []
+
+        get_params
+      end
+    end
+  end
+end

data/lib/open_meteo/forecast.rb

@@ -1,5 +1,5 @@
 require_relative "client"
-require_relative "forecast/variables/general"
+require_relative "forecast/variables"
 
 module OpenMeteo
   ##
@@ -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,9 @@ module OpenMeteo
 
       model_definition = get_model_definition(model)
 
-      variables = model_definition[:variables_class].new(**variables)
-      variables.validate
+      variables_object = OpenMeteo::Forecast::Variables.new(**variables)
 
-      get_forecast(model_definition[:endpoint], location, variables)
+      get_forecast(model_definition[:endpoint], location, variables_object)
     end
 
     private
@@ -32,7 +33,6 @@ module OpenMeteo
     AVAILABLE_FORECAST_MODELS = {
       general: {
         # See https://open-meteo.com/en/docs
-        variables_class: OpenMeteo::Forecast::Variables::General,
         endpoint: :forecast,
       },
     }.freeze
@@ -42,7 +42,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::Entities::Location
 
       location.validate!
     end

data/lib/open_meteo/response_wrapper.rb

@@ -0,0 +1,40 @@
+module OpenMeteo
+  ##
+  # Wrap the JSON body response from the OpenMeteo request.
+  #
+  class ResponseWrapper
+    def initialize(config: OpenMeteo::Client::Config.new)
+      @config = config
+    end
+
+    def wrap(response, entity:)
+      raise OpenMeteo::Errors::ResponseError, "Empty body" if response.body.nil?
+
+      json_body = JSON.parse(response.body)
+      check_for_error(response, json_body)
+
+      entity.new(json_body)
+    rescue JSON::ParserError
+      raise OpenMeteo::Errors::ResponseError, "Unable to parse the response body: #{response.body}"
+    end
+
+    private
+
+    def check_for_error(response, json_body)
+      return if response.status == 200
+
+      error_messages = extract_error_messages(json_body)
+
+      @config.logger.debug(error_messages)
+
+      raise OpenMeteo::Errors::ResponseError, error_messages
+    end
+
+    def extract_error_messages(json_body)
+      error_value = json_body["error"]
+      return "" if error_value.nil? || error_value == false
+
+      json_body["reason"].to_s
+    end
+  end
+end

data/lib/open_meteo/types.rb

@@ -0,0 +1,13 @@
+require "dry-types"
+require "dry-struct"
+require "dry-validation"
+
+require_relative "entities/contracts/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.1.0".freeze
 end

data/lib/open_meteo.rb

@@ -1,2 +1,37 @@
+require "open_meteo/types"
+require "open_meteo/configuration"
+require "open_meteo/entities/location"
+require "open_meteo/entities/forecast"
 require "open_meteo/forecast"
-require "open_meteo/location"
+require "open_meteo/response_wrapper"
+require "open_meteo/errors"
+
+##
+# The OpenMeteo client.
+module OpenMeteo
+  # Returns the global `OpenMeteo::Configuration` object. While
+  # you _can_ use this method to access the configuration, the more common
+  # convention is to use `OpenMeteo.configure``
+  #
+  # @example
+  #     OpenMeteo.configuration.logger = Logger.new($stdout)
+  # @see OpenMeteo.configure
+  # @see OpenMeteo::Configuration
+  def self.configuration
+    @configuration ||= OpenMeteo::Configuration.new
+  end
+
+  # Yields the global configuration to a block.
+  # @yield [Configuration] global configuration
+  #
+  # @example
+  #     OpenMeteo.configure do |config|
+  #       config.logger Logger.new($stdout)
+  #     end
+  # @see OpenMeteo::Configuration
+  def self.configure
+    raise ArgumentError, "Please provide a block to configure" unless block_given?
+
+    yield configuration
+  end
+end

metadata

@@ -1,15 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: open-meteo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Peter Morgenstern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-03 00:00:00.000000000 Z
+date: 2023-11-08 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
@@ -41,9 +81,21 @@ files:
 - lib/open_meteo/client.rb
 - lib/open_meteo/client/config.rb
 - lib/open_meteo/client/url_builder.rb
+- lib/open_meteo/configuration.rb
+- lib/open_meteo/entities/contracts/application_contract.rb
+- lib/open_meteo/entities/contracts/location_contract.rb
+- lib/open_meteo/entities/forecast.rb
+- lib/open_meteo/entities/forecast/current.rb
+- lib/open_meteo/entities/forecast/daily.rb
+- lib/open_meteo/entities/forecast/hourly.rb
+- lib/open_meteo/entities/forecast/item.rb
+- lib/open_meteo/entities/forecast/units.rb
+- lib/open_meteo/entities/location.rb
+- lib/open_meteo/errors.rb
 - lib/open_meteo/forecast.rb
-- lib/open_meteo/forecast/variables/general.rb
-- lib/open_meteo/location.rb
+- lib/open_meteo/forecast/variables.rb
+- lib/open_meteo/response_wrapper.rb
+- lib/open_meteo/types.rb
 - lib/open_meteo/version.rb
 homepage: https://github.com/open-meteo-ruby/open-meteo-ruby
 licenses:
@@ -65,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: A client for OpenMeteo weather data

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

@@ -1,34 +0,0 @@
-module OpenMeteo
-  class Forecast
-    module Variables
-      ##
-      # 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
-
-        def validate
-          # FIXME: Placeholder for validation
-          true
-        end
-
-        def to_get_params
-          get_params = {}
-
-          get_params[:current] = current.join(",") if current != []
-          get_params[:hourly] = hourly.join(",") if hourly != []
-          get_params[:daily] = daily.join(",") if daily != []
-
-          get_params
-        end
-      end
-    end
-  end
-end

data/lib/open_meteo/location.rb

@@ -1,21 +0,0 @@
-module OpenMeteo
-  ##
-  # A location for a request to OpenMeteo.
-  class Location
-    attr_reader :latitude, :longitude
-
-    def initialize(longitude:, latitude:)
-      @longitude = longitude
-      @latitude = latitude
-    end
-
-    def validate!
-      # FIXME: Placeholder for validation
-      true
-    end
-
-    def to_get_params
-      { latitude:, longitude: }
-    end
-  end
-end