open-meteo 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60140c0aa4f49166a8d9efef379ba7628fb663bd65c712018f7e2089f43677d5
-  data.tar.gz: bd54e00eabe5518725f32b790e8da3257fc985e0e678d0220343ac528858fbe5
+  metadata.gz: 19125290e7d78eb6a4493ac3b774347b09c9bbbb5753243e77e90a49f0f7c590
+  data.tar.gz: f7975e9e2b8d7a49d6fd7b91c13caa0005966a8770c45536405a85f3e0a26cc8
 SHA512:
-  metadata.gz: 17a87ed4b29b65f93ff21bfad1c2579f37faa5eb7677f7598da708438e1888d54729af4bd1946328a0b37dc14f8fef9711bab95ab3619ccc7e16b6e0c300302f
-  data.tar.gz: 205a30320db01bf6406e69c02633c1799d81f660962b05d13749cb9f92c630044224833cd88bd1b46bcfaf85656b5067958fe94d636d92b861b7aed9bb5e82ec
+  metadata.gz: 5829c7d1b646385e0c8d2b8d25b6ce2faca5c4cab22a905c9fc6e62ca5cf2c1bee5c112129a11c11938b787ecec642d28e1c512302f2848c591f5618e60144d7
+  data.tar.gz: 0e2a5f8debf66630755b20ec5832d3a4f740bcd7fa0531fb4132516740f7b8b5aa315e8a697a679628892c43ea0fc8744184d55674e45a73e6f3adcc7bb257e2

data/lib/open_meteo/client/url_builder.rb

@@ -3,7 +3,11 @@ module OpenMeteo
     ##
     # The class that constructs the URLs for given endpoints.
     class UrlBuilder
-      API_PATHS = { forecast: "v1/forecast", forecast_dwd_icon: "v1/dwd-icon" }.freeze
+      API_PATHS = {
+        forecast: "v1/forecast",
+        forecast_dwd_icon: "v1/dwd-icon",
+        search: "v1/search",
+      }.freeze
 
       attr_reader :config
 
@@ -11,11 +15,11 @@ module OpenMeteo
         @config = config
       end
 
-      def build_url(endpoint, *args)
+      def build_url(endpoint, path_params = {})
         relative_path = API_PATHS.fetch(endpoint.to_sym)
         full_path = [config.url, relative_path].join("/")
 
-        URI::DEFAULT_PARSER.escape(format(full_path, args))
+        URI::DEFAULT_PARSER.escape(format(full_path, path_params))
       end
     end
   end

data/lib/open_meteo/client.rb

@@ -23,11 +23,11 @@ module OpenMeteo
       @agent = agent
     end
 
-    def get(endpoint_name, *endpoint_args, **get_params)
-      endpoint = url_builder.build_url(endpoint_name, *endpoint_args)
+    def get(endpoint_name, path_params: {}, query_params: {})
+      endpoint = url_builder.build_url(endpoint_name, path_params)
 
       agent.connect.get do |request|
-        request.params = get_params.merge({ apikey: config.api_key }.compact)
+        request.params = query_params.merge({ apikey: config.api_key }.compact)
         request.url(endpoint)
       end
     rescue Faraday::ConnectionFailed => e

data/lib/open_meteo/entities/location.rb

@@ -12,7 +12,7 @@ module OpenMeteo
         OpenMeteo::Entities::Contracts::LocationContract.validate!(to_hash)
       end
 
-      def to_get_params
+      def to_query_params
         { latitude:, longitude: }
       end
     end

data/lib/open_meteo/entities/search.rb

@@ -0,0 +1,48 @@
+module OpenMeteo
+  module Entities
+    ##
+    # A Search Result in the Open Meteo Geocoding API. Represents one possible location.
+    SearchResult =
+      Struct.new(
+        :id,
+        :name,
+        :latitude,
+        :longitude,
+        :elevation,
+        :feature_code,
+        :country_code,
+        :admin_1_id,
+        :admin_2_id,
+        :admin_3_id,
+        :admin_4_id,
+        :timezone,
+        :population,
+        :postcodes,
+        :country_id,
+        :country,
+        :admin_1,
+        :admin_2,
+        :admin_3,
+        :admin_4,
+        keyword_init: true,
+      )
+
+    ##
+    # A list of possible locations from the Geocoding API
+    class Search
+      attr_reader :attributes, :results, :raw_json
+
+      def initialize(json_body)
+        @raw_json = json_body
+
+        @results =
+          json_body["results"].map do |result|
+            normalized_result = result.transform_keys { |key| key.to_s.gsub(/(\w)(\d)/, '\1_\2') }
+
+            SearchResult.new(normalized_result)
+          end
+        @attributes = json_body.keys
+      end
+    end
+  end
+end

data/lib/open_meteo/faraday_connection.rb

@@ -20,7 +20,7 @@ module OpenMeteo
         conn.options[:open_timeout] = config.timeouts[:open_timeout]
 
         conn.request :retry, RETRY_OPTIONS
-        conn.response :logger
+        conn.response :logger, config.logger
       end
     end
   end

data/lib/open_meteo/forecast/variables.rb

@@ -25,15 +25,18 @@ module OpenMeteo
         :models,
         OpenMeteo::Types::Strict::Array.of(OpenMeteo::Types::Strict::Symbol).default([].freeze),
       )
+      attribute(:timezone, OpenMeteo::Types::Strict::String.optional.default(nil))
 
-      def to_get_params
-        get_params = {}
+      def to_query_params
+        query_params = {}
 
         %i[current minutely_15 hourly daily models].each do |key|
-          get_params[key] = send(key).join(",") if send(key) != []
+          query_params[key] = send(key).join(",") if send(key) != []
         end
 
-        get_params
+        %i[timezone].each { |key| query_params[key] = send(key) if send(key) }
+
+        query_params
       end
     end
   end

data/lib/open_meteo/forecast.rb

@@ -31,10 +31,6 @@ module OpenMeteo
       get_forecast(model_definition[:endpoint], location, variables_object)
     end
 
-    private
-
-    attr_reader :client
-
     AVAILABLE_FORECAST_MODELS = {
       general: {
         # See https://open-meteo.com/en/docs
@@ -46,6 +42,10 @@ module OpenMeteo
       },
     }.freeze
 
+    private
+
+    attr_reader :client
+
     def get_model_definition(model)
       AVAILABLE_FORECAST_MODELS.fetch(model) { raise ForecastModelNotImplemented }
     end
@@ -57,8 +57,8 @@ module OpenMeteo
     end
 
     def get_forecast(endpoint, location, variables)
-      get_params = { **location.to_get_params, **variables.to_get_params }
-      response = client.get(endpoint, **get_params)
+      query_params = { **location.to_query_params, **variables.to_query_params }
+      response = client.get(endpoint, query_params:)
 
       @response_wrapper.wrap(response, entity: OpenMeteo::Entities::Forecast)
     end

data/lib/open_meteo/search/variables.rb

@@ -0,0 +1,16 @@
+module OpenMeteo
+  class Search
+    ##
+    # The variables used for a Search in the Open Meteo Geocoding API
+    class Variables < Dry::Struct
+      attribute(:count, OpenMeteo::Types::Strict::Integer.optional.default(nil))
+      attribute(:language, OpenMeteo::Types::Strict::String.optional.default(nil))
+
+      def to_query_params
+        %i[count language].each_with_object({}) do |key, query_params|
+          query_params[key] = send(key) if send(key)
+        end
+      end
+    end
+  end
+end

data/lib/open_meteo/search.rb

@@ -0,0 +1,36 @@
+require_relative "client"
+require_relative "search/variables"
+
+module OpenMeteo
+  ##
+  # Perform a search request to the Open Meteo Geocoding API
+  #
+  # Returns a list of possible locations based of a location name string
+  # https://open-meteo.com/en/docs/geocoding-api
+  class Search
+    def initialize(
+      config: OpenMeteo::Client::Config.new(host: "geocoding-api.open-meteo.com"),
+      client: OpenMeteo::Client.new(config:),
+      response_wrapper: OpenMeteo::ResponseWrapper.new(config:)
+    )
+      @client = client
+      @response_wrapper = response_wrapper
+    end
+
+    def get(name:, variables:)
+      variables_object = OpenMeteo::Search::Variables.new(**variables)
+      search_get(name, variables_object)
+    end
+
+    private
+
+    attr_reader :client
+
+    def search_get(name, variables)
+      query_params = { name:, **variables.to_query_params }
+      response = client.get(:search, query_params:)
+
+      @response_wrapper.wrap(response, entity: OpenMeteo::Entities::Search)
+    end
+  end
+end

data/lib/open_meteo/version.rb

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

data/lib/open_meteo.rb

@@ -3,7 +3,9 @@ require "open_meteo/types"
 require "open_meteo/configuration"
 require "open_meteo/entities/location"
 require "open_meteo/entities/forecast"
+require "open_meteo/entities/search"
 require "open_meteo/forecast"
+require "open_meteo/search"
 require "open_meteo/response_wrapper"
 require "open_meteo/errors"
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: open-meteo
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Peter Morgenstern
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2025-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -90,7 +89,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
-description:
 email:
 - gundel.peter@gmail.com
 executables: []
@@ -112,11 +110,14 @@ files:
 - lib/open_meteo/entities/forecast/minutely_15.rb
 - lib/open_meteo/entities/forecast/units.rb
 - lib/open_meteo/entities/location.rb
+- lib/open_meteo/entities/search.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
+- lib/open_meteo/search.rb
+- lib/open_meteo/search/variables.rb
 - lib/open_meteo/types.rb
 - lib/open_meteo/version.rb
 homepage: https://github.com/open-meteo-ruby/open-meteo-ruby
@@ -124,7 +125,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,8 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A client for OpenMeteo weather data
 test_files: []