open-meteo 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1fd59fe55c171c4cefb24b80613933b28d10040fdff524490dcd9e6e2ed0514
+  data.tar.gz: 8231a53ba4250c627db4c44eb513f6f0cf41631c3a5ba3c3934a20d0ee731562
+SHA512:
+  metadata.gz: ec997727575db6186329054eca41b3c60c6729571788d012c57a74ed7c0314308ee75e11dc201287cc396d6be570b1e38ef675dd67ebd79e41d3d5a645de7957
+  data.tar.gz: 4055bd5d3d7d63c40f3cfa8eae6822f755d806c48b7e700e65ffd2de14bdd3761373318bba2699752c97db26621893cefb3ec1b34caa87d9151ca5c05b112d40

data/lib/open_meteo/client/config.rb

@@ -0,0 +1,17 @@
+module OpenMeteo
+  class Client
+    ##
+    # The configuration for the OpenMeteo::Client.
+    class Config
+      attr_reader :host
+
+      def initialize(host: "api.open-meteo.com")
+        @host = host
+      end
+
+      def url
+        "https://#{host}"
+      end
+    end
+  end
+end

data/lib/open_meteo/client/url_builder.rb

@@ -0,0 +1,22 @@
+module OpenMeteo
+  class Client
+    ##
+    # The class that constructs the URLs for given endpoints.
+    class UrlBuilder
+      API_PATHS = { forecast: "v1/forecast" }.freeze
+
+      attr_reader :api_config
+
+      def initialize(api_config: OpenMeteo::Client::Config.new)
+        @api_config = api_config
+      end
+
+      def build_url(endpoint, *args)
+        relative_path = API_PATHS.fetch(endpoint.to_sym)
+        full_path = [api_config.url, relative_path].join("/")
+
+        URI::DEFAULT_PARSER.escape(format(full_path, args))
+      end
+    end
+  end
+end

data/lib/open_meteo/client.rb

@@ -0,0 +1,44 @@
+require "faraday"
+
+require_relative "client/config"
+require_relative "client/url_builder"
+
+module OpenMeteo
+  ##
+  # The client that makes the actual requests to the OpenMeteo API.
+  class Client
+    class ConnectionFailed < StandardError
+    end
+    class Timeout < StandardError
+    end
+
+    attr_reader :api_config
+
+    def initialize(
+      api_config: OpenMeteo::Client::Config.new,
+      url_builder: OpenMeteo::Client::UrlBuilder.new,
+      agent: Faraday.new
+    )
+      @api_config = api_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 |req|
+        req.params = get_params
+        req.url(endpoint)
+      end
+    rescue Faraday::ConnectionFailed => e
+      raise ConnectionFailed, "Could not connect to OpenMeteo API: #{e.message}"
+    rescue Faraday::TimeoutError
+      raise Timeout, "Timeout error from the OpenMeteo API"
+    end
+
+    private
+
+    attr_reader :agent, :url_builder
+  end
+end

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

@@ -0,0 +1,34 @@
+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/forecast.rb

@@ -0,0 +1,55 @@
+require_relative "client"
+require_relative "forecast/variables/general"
+
+module OpenMeteo
+  ##
+  # Perform a forecase request to the OpenMeteo API.
+  #
+  # See https://open-meteo.com/en/docs
+  class Forecast
+    class ForecastModelNotImplemented < StandardError
+    end
+
+    def initialize(client: OpenMeteo::Client.new)
+      @client = client
+    end
+
+    def get(location:, variables:, model: :general)
+      ensure_valid_location(location)
+
+      model_definition = get_model_definition(model)
+
+      variables = model_definition[:variables_class].new(**variables)
+      variables.validate
+
+      get_forecast(model_definition[:endpoint], location, variables)
+    end
+
+    private
+
+    attr_reader :client
+
+    AVAILABLE_FORECAST_MODELS = {
+      general: {
+        # See https://open-meteo.com/en/docs
+        variables_class: OpenMeteo::Forecast::Variables::General,
+        endpoint: :forecast,
+      },
+    }.freeze
+
+    def get_model_definition(model)
+      AVAILABLE_FORECAST_MODELS.fetch(model) { raise ForecastModelNotImplemented }
+    end
+
+    def ensure_valid_location(location)
+      raise "Not an OpenMeteo::Location" unless location.is_a? OpenMeteo::Location
+
+      location.validate!
+    end
+
+    def get_forecast(endpoint, location, variables)
+      get_params = { **location.to_get_params, **variables.to_get_params }
+      client.get(endpoint, **get_params)
+    end
+  end
+end

data/lib/open_meteo/location.rb

@@ -0,0 +1,21 @@
+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

data/lib/open_meteo/version.rb

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

data/lib/open_meteo.rb

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: open-meteo
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Peter Morgenstern
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/open_meteo.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/location.rb
+- lib/open_meteo/version.rb
+homepage: https://github.com/open-meteo-ruby/open-meteo-ruby
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A client for OpenMeteo weather data
+test_files: []