open-meteo 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f33676766f8b3c6bb0e373337e836eafe3cc8d7d4d2f0ee17a5cd397768592e8
-  data.tar.gz: 928328683daf2420bd23852cff7aa08ca71ffc637050dd2df5a77aa072729ac0
+  metadata.gz: 60140c0aa4f49166a8d9efef379ba7628fb663bd65c712018f7e2089f43677d5
+  data.tar.gz: bd54e00eabe5518725f32b790e8da3257fc985e0e678d0220343ac528858fbe5
 SHA512:
-  metadata.gz: 85d8aef77f27747a258b26e54eece4a092843bf7bb5f5b852c4d85246e56ae94bfeb902219edf78b3501fe266e741ed6d4e8a4bb8928c39ae00be8a56bfa9479
-  data.tar.gz: bcd21c77a39fdc3bd8f30b2ef8f003ec52d68725b5f664852086f995ad620ad2ae804eb5c6605874e29a7c5de986aacd54b498c35d4d0be90a9cd3c45790ab7d
+  metadata.gz: 17a87ed4b29b65f93ff21bfad1c2579f37faa5eb7677f7598da708438e1888d54729af4bd1946328a0b37dc14f8fef9711bab95ab3619ccc7e16b6e0c300302f
+  data.tar.gz: 205a30320db01bf6406e69c02633c1799d81f660962b05d13749cb9f92c630044224833cd88bd1b46bcfaf85656b5067958fe94d636d92b861b7aed9bb5e82ec

data/lib/open_meteo/client/config.rb

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

data/lib/open_meteo/client/url_builder.rb

@@ -5,15 +5,15 @@ module OpenMeteo
     class UrlBuilder
       API_PATHS = { forecast: "v1/forecast", forecast_dwd_icon: "v1/dwd-icon" }.freeze
 
-      attr_reader :api_config
+      attr_reader :config
 
-      def initialize(api_config: OpenMeteo::Client::Config.new)
-        @api_config = api_config
+      def initialize(config: OpenMeteo::Client::Config.new)
+        @config = config
       end
 
       def build_url(endpoint, *args)
         relative_path = API_PATHS.fetch(endpoint.to_sym)
-        full_path = [api_config.url, relative_path].join("/")
+        full_path = [config.url, relative_path].join("/")
 
         URI::DEFAULT_PARSER.escape(format(full_path, args))
       end

data/lib/open_meteo/client.rb

@@ -1,6 +1,4 @@
-require "faraday"
-require "faraday/retry"
-
+require_relative "faraday_connection"
 require_relative "client/config"
 require_relative "client/url_builder"
 
@@ -13,22 +11,23 @@ module OpenMeteo
     class Timeout < StandardError
     end
 
-    # 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
-
-    attr_reader :api_config, :agent
+    attr_reader :config, :agent
 
-    def initialize(api_config: OpenMeteo::Client::Config.new, url_builder: nil, agent: nil)
-      @api_config = api_config
-      @url_builder = url_builder || UrlBuilder.new(api_config:)
-      @agent = agent || Faraday.new { |f| f.request :retry, RETRY_OPTIONS }
+    def initialize(
+      config: OpenMeteo::Client::Config.new,
+      url_builder: UrlBuilder.new(config:),
+      agent: FaradayConnection.new(config:)
+    )
+      @config = config
+      @url_builder = url_builder
+      @agent = agent
     end
 
     def get(endpoint_name, *endpoint_args, **get_params)
       endpoint = url_builder.build_url(endpoint_name, *endpoint_args)
 
-      agent.get do |request|
-        request.params = get_params.merge({ apikey: api_config.api_key }.compact)
+      agent.connect.get do |request|
+        request.params = get_params.merge({ apikey: config.api_key }.compact)
         request.url(endpoint)
       end
     rescue Faraday::ConnectionFailed => e

data/lib/open_meteo/configuration.rb

@@ -28,5 +28,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) }
+    add_setting :timeouts, -> { { timeout: 5, open_timeout: 5 } }
   end
 end

data/lib/open_meteo/faraday_connection.rb

@@ -0,0 +1,27 @@
+require "faraday"
+require "faraday/retry"
+
+module OpenMeteo
+  ##
+  # The Faraday connection
+  class FaradayConnection
+    # 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
+
+    attr_reader :config
+
+    def initialize(config: OpenMeteo::Client::Config.new)
+      @config = config
+    end
+
+    def connect
+      Faraday.new do |conn|
+        conn.options[:timeout] = config.timeouts[:timeout]
+        conn.options[:open_timeout] = config.timeouts[:open_timeout]
+
+        conn.request :retry, RETRY_OPTIONS
+        conn.response :logger
+      end
+    end
+  end
+end

data/lib/open_meteo/forecast.rb

@@ -12,7 +12,11 @@ module OpenMeteo
     class WrongLocationType < StandardError
     end
 
-    def initialize(client: OpenMeteo::Client.new, response_wrapper: OpenMeteo::ResponseWrapper.new)
+    def initialize(
+      config: OpenMeteo::Client::Config.new,
+      client: OpenMeteo::Client.new(config:),
+      response_wrapper: OpenMeteo::ResponseWrapper.new(config:)
+    )
       @client = client
       @response_wrapper = response_wrapper
     end

data/lib/open_meteo/response_wrapper.rb

@@ -3,6 +3,8 @@ module OpenMeteo
   # Wrap the JSON body response from the OpenMeteo request.
   #
   class ResponseWrapper
+    attr_reader :config
+
     def initialize(config: OpenMeteo::Client::Config.new)
       @config = config
     end

data/lib/open_meteo/version.rb

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

data/lib/open_meteo.rb

@@ -1,3 +1,4 @@
+require "open_meteo/faraday_connection"
 require "open_meteo/types"
 require "open_meteo/configuration"
 require "open_meteo/entities/location"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open-meteo
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Peter Morgenstern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-24 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -113,6 +113,7 @@ files:
 - lib/open_meteo/entities/forecast/units.rb
 - lib/open_meteo/entities/location.rb
 - lib/open_meteo/errors.rb
+- lib/open_meteo/faraday_connection.rb
 - lib/open_meteo/forecast.rb
 - lib/open_meteo/forecast/variables.rb
 - lib/open_meteo/response_wrapper.rb