open-meteo 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 823b394116c34b4acad4f7a01f7e48aa70db6b1953f316cf65c5fe7bc10c22fd
-  data.tar.gz: 472b5dd09142afea3e1f496654719150fa3d172a05ef6519d188d558e8f6e2d5
+  metadata.gz: f33676766f8b3c6bb0e373337e836eafe3cc8d7d4d2f0ee17a5cd397768592e8
+  data.tar.gz: 928328683daf2420bd23852cff7aa08ca71ffc637050dd2df5a77aa072729ac0
 SHA512:
-  metadata.gz: c52a61be8ca120808d296925106c5d19c4486b6cf0835606a05484be01f4f25268af330baae510ce3dd0f6b240391673dca8e4bdcac5121742330c6a81b3c8e3
-  data.tar.gz: 686bdb878b51779187d22b1262d479fedcff9f179761cfc4049754f7bd213d44ff19196f0ba5c4eb849de647722ab7694cda6f3c4190df491bef4e91776e3c1a
+  metadata.gz: 85d8aef77f27747a258b26e54eece4a092843bf7bb5f5b852c4d85246e56ae94bfeb902219edf78b3501fe266e741ed6d4e8a4bb8928c39ae00be8a56bfa9479
+  data.tar.gz: bcd21c77a39fdc3bd8f30b2ef8f003ec52d68725b5f664852086f995ad620ad2ae804eb5c6605874e29a7c5de986aacd54b498c35d4d0be90a9cd3c45790ab7d

data/lib/open_meteo/client/config.rb

@@ -3,9 +3,10 @@ module OpenMeteo
     ##
     # The configuration for the OpenMeteo::Client.
     class Config
-      attr_reader :host, :logger
+      attr_reader :api_key, :host, :logger
 
-      def initialize(host: nil, logger: nil)
+      def initialize(api_key: nil, host: nil, logger: nil)
+        @api_key = api_key || OpenMeteo.configuration.api_key
         @host = host || OpenMeteo.configuration.host
         @logger = logger || OpenMeteo.configuration.logger
       end

data/lib/open_meteo/client/url_builder.rb

@@ -3,7 +3,7 @@ module OpenMeteo
     ##
     # The class that constructs the URLs for given endpoints.
     class UrlBuilder
-      API_PATHS = { forecast: "v1/forecast" }.freeze
+      API_PATHS = { forecast: "v1/forecast", forecast_dwd_icon: "v1/dwd-icon" }.freeze
 
       attr_reader :api_config
 

data/lib/open_meteo/client.rb

@@ -1,4 +1,5 @@
 require "faraday"
+require "faraday/retry"
 
 require_relative "client/config"
 require_relative "client/url_builder"
@@ -12,24 +13,23 @@ module OpenMeteo
     class Timeout < StandardError
     end
 
-    attr_reader :api_config
+    # See https://github.com/lostisland/faraday-retry/tree/main#usage
+    RETRY_OPTIONS = { max: 3, interval: 0.05, interval_randomness: 0.5, backoff_factor: 3 }.freeze
 
-    def initialize(
-      api_config: OpenMeteo::Client::Config.new,
-      url_builder: OpenMeteo::Client::UrlBuilder.new,
-      agent: Faraday.new
-    )
+    attr_reader :api_config, :agent
+
+    def initialize(api_config: OpenMeteo::Client::Config.new, url_builder: nil, agent: nil)
       @api_config = api_config
-      @url_builder = url_builder
-      @agent = agent
+      @url_builder = url_builder || UrlBuilder.new(api_config:)
+      @agent = agent || Faraday.new { |f| f.request :retry, RETRY_OPTIONS }
     end
 
     def get(endpoint_name, *endpoint_args, **get_params)
       endpoint = url_builder.build_url(endpoint_name, *endpoint_args)
 
-      agent.get do |req|
-        req.params = get_params
-        req.url(endpoint)
+      agent.get do |request|
+        request.params = get_params.merge({ apikey: api_config.api_key }.compact)
+        request.url(endpoint)
       end
     rescue Faraday::ConnectionFailed => e
       raise ConnectionFailed, "Could not connect to OpenMeteo API: #{e.message}"
@@ -39,6 +39,6 @@ module OpenMeteo
 
     private
 
-    attr_reader :agent, :url_builder
+    attr_reader :url_builder
   end
 end

data/lib/open_meteo/configuration.rb

@@ -27,5 +27,6 @@ module OpenMeteo
 
     add_setting :logger, -> { Logger.new($stdout) }
     add_setting :host, "api.open-meteo.com"
+    add_setting :api_key, -> { ENV.fetch("OPEN_METEO_API_KEY", nil) }
   end
 end

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

@@ -0,0 +1,35 @@
+module OpenMeteo
+  module Entities
+    class Forecast
+      ##
+      # A forecast Entity for 15 minute data returned by OpenMeteo
+      class Minutely15
+        attr_reader :items, :units, :raw_json_hourly, :raw_json_hourly_units
+
+        def initialize(json_minutely_15, json_minutely_15_units)
+          @items = initialize_items(json_minutely_15)
+          @units =
+            json_minutely_15_units &&
+              OpenMeteo::Entities::Forecast::Units.new(json_minutely_15_units)
+
+          @raw_json_minutely_15 = json_minutely_15
+          @raw_json_minutely_15_units = json_minutely_15_units
+        end
+
+        private
+
+        def initialize_items(json_minutely_15)
+          json_minutely_15["time"]
+            .map do |element|
+              json_minutely_15
+                .keys
+                .each_with_object({}) do |attr, json_item|
+                  json_item[attr] = json_minutely_15[attr][json_minutely_15["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.rb

@@ -1,4 +1,5 @@
 require_relative "forecast/current"
+require_relative "forecast/minutely_15"
 require_relative "forecast/hourly"
 require_relative "forecast/daily"
 require_relative "forecast/units"
@@ -9,29 +10,35 @@ module OpenMeteo
     #
     # A forecast Entity with data returned by OpenMeteo
     class Forecast
-      attr_reader :attributes, :current, :hourly, :daily, :raw_json
+      attr_reader :attributes, :current, :minutely_15, :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"])
+        init_data_for(OpenMeteo::Entities::Forecast::Current)
+        init_data_for(OpenMeteo::Entities::Forecast::Minutely15)
+        init_data_for(OpenMeteo::Entities::Forecast::Hourly)
+        init_data_for(OpenMeteo::Entities::Forecast::Daily)
 
         @attributes = json_body.keys
       end
+
+      private
+
+      def init_data_for(klass)
+        name = name_for_klass(klass)
+
+        return if raw_json[name.to_s].nil?
+
+        instance_variable_set("@#{name}", klass.new(raw_json[name.to_s], raw_json["#{name}_units"]))
+      end
+
+      def name_for_klass(klass)
+        # Extract that last part of the class name, e.g. "Minutely15"
+        # from "OpenMeteo::Entities::Forecast::Minutely15"
+        # but as snake_case version e.g. "minutely_15"
+        klass.to_s.split("::").last.downcase.gsub(/(\d+)/, '_\1').to_sym
+      end
     end
   end
 end

data/lib/open_meteo/forecast/variables.rb

@@ -9,6 +9,10 @@ module OpenMeteo
         :current,
         OpenMeteo::Types::Strict::Array.of(OpenMeteo::Types::Strict::Symbol).default([].freeze),
       )
+      attribute(
+        :minutely_15,
+        OpenMeteo::Types::Strict::Array.of(OpenMeteo::Types::Strict::Symbol).default([].freeze),
+      )
       attribute(
         :hourly,
         OpenMeteo::Types::Strict::Array.of(OpenMeteo::Types::Strict::Symbol).default([].freeze),
@@ -17,13 +21,17 @@ module OpenMeteo
         :daily,
         OpenMeteo::Types::Strict::Array.of(OpenMeteo::Types::Strict::Symbol).default([].freeze),
       )
+      attribute(
+        :models,
+        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 != []
+        %i[current minutely_15 hourly daily models].each do |key|
+          get_params[key] = send(key).join(",") if send(key) != []
+        end
 
         get_params
       end

data/lib/open_meteo/forecast.rb

@@ -3,7 +3,7 @@ require_relative "forecast/variables"
 
 module OpenMeteo
   ##
-  # Perform a forecase request to the OpenMeteo API.
+  # Perform a forecast request to the OpenMeteo API.
   #
   # See https://open-meteo.com/en/docs
   class Forecast
@@ -12,8 +12,9 @@ module OpenMeteo
     class WrongLocationType < StandardError
     end
 
-    def initialize(client: OpenMeteo::Client.new)
+    def initialize(client: OpenMeteo::Client.new, response_wrapper: OpenMeteo::ResponseWrapper.new)
       @client = client
+      @response_wrapper = response_wrapper
     end
 
     def get(location:, variables:, model: :general)
@@ -35,6 +36,10 @@ module OpenMeteo
         # See https://open-meteo.com/en/docs
         endpoint: :forecast,
       },
+      dwd_icon: {
+        # See https://open-meteo.com/en/docs/dwd-api
+        endpoint: :forecast_dwd_icon,
+      },
     }.freeze
 
     def get_model_definition(model)
@@ -49,7 +54,9 @@ module OpenMeteo
 
     def get_forecast(endpoint, location, variables)
       get_params = { **location.to_get_params, **variables.to_get_params }
-      client.get(endpoint, **get_params)
+      response = client.get(endpoint, **get_params)
+
+      @response_wrapper.wrap(response, entity: OpenMeteo::Entities::Forecast)
     end
   end
 end

data/lib/open_meteo/version.rb

@@ -1,3 +1,3 @@
 module OpenMeteo
-  VERSION = "0.1.0".freeze
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open-meteo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Morgenstern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-08 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -70,6 +70,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 description:
 email:
 - gundel.peter@gmail.com
@@ -89,6 +109,7 @@ files:
 - 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/minutely_15.rb
 - lib/open_meteo/entities/forecast/units.rb
 - lib/open_meteo/entities/location.rb
 - lib/open_meteo/errors.rb
@@ -117,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A client for OpenMeteo weather data