open-weather-ruby-client 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c8876fceee8fa7e6f946be1b82161cfbfc8ef8b4aad00497d62b92eade54d63
-  data.tar.gz: 9ca8ab329c506558cde05eb20c33c29c6a88f9b8f74816d560e23afbeb07e270
+  metadata.gz: f58c9713754c10d3b49e6b5798db270924130a6b40cc96df49f1530cdff68bf4
+  data.tar.gz: 8e05928fde71a02d177df35ae3b6f1ab78f19f756e21b1f6a766133de6c37fee
 SHA512:
-  metadata.gz: 319c7c0dd8477f8ba00efae26150a56a390a7ca15e5522a87d46b80896a16356406df8d07a4a9f79969e0008be79850683aa13bc8e29ee62f42b5892594bc0da
-  data.tar.gz: 7b085b56ec87b9f397b83b49946cc4ed91fe52c24797a8b43dd643d3634285da4cf0fd95b46796c17cb98578e75c5d6928be0b1033fd117e50722706f60a9005
+  metadata.gz: f047b48bec6d1f0b5b8391c1c9f7ac7896383c169253cd0cb2096d4532bb2801309a0c68ede79b87853068aecf6090939e507cb6e2f520b5091dc22cb1fbff80
+  data.tar.gz: 12c3e088084c4457e28659f4b82dca9b18d8926aea70eb87588a847a6523bb60c893b14919c3ce25a9ecc5458b33fb983a8af33ec62381d254a9a9c3ba5d8ffc

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+### 0.8.0 (2026/10/09)
+
+* [#54](https://github.com/dblock/open-weather-ruby-client/pull/54): Add support for the Geocoding API (`geo_direct`, `geo_reverse`, `geo_zip`) - [@dblock](https://github.com/dblock).
+* [#50](https://github.com/dblock/open-weather-ruby-client/pull/50): Fixes `Danger Comment` workflow failing with a `contents: none` permissions error - [@dblock](https://github.com/dblock).
+* [#51](https://github.com/dblock/open-weather-ruby-client/pull/51): Adds test coverage reporting with [coveralls.io](https://coveralls.io) - [@dblock](https://github.com/dblock).
+* [#53](https://github.com/dblock/open-weather-ruby-client/pull/53): Fixed coverage reporting to Coveralls not running on pull requests by switching from `coveralls_reborn`/`COVERALLS_REPO_TOKEN` to `coverallsapp/github-action`/`GITHUB_TOKEN` - [@dblock](https://github.com/dblock).
+* [#56](https://github.com/dblock/open-weather-ruby-client/pull/56): Correct spelling of Celsius and Fahrenheit - [@dblock](https://github.com/dblock).
+### 0.7.0 (2026/8/23)
+
+* [#49](https://github.com/dblock/open-weather-ruby-client/pull/49): Migrate Danger to use the `danger-pr-comment` reusable workflow - [@dblock](https://github.com/dblock), [@Copilot](https://github.com/apps/copilot-swe-agent).
+* [#49](https://github.com/dblock/open-weather-ruby-client/pull/49): Upgrade danger-changelog to 0.8.0 and danger-toc to 0.2.0 - [@dblock](https://github.com/dblock), [@Copilot](https://github.com/apps/copilot-swe-agent).
+* [#46](https://github.com/dblock/open-weather-ruby-client/pull/46): Added support for the five day forecast API - [@mgm702](https://github.com/mgm702).
+* [#48](https://github.com/dblock/open-weather-ruby-client/pull/48): Modernized CI: dropped EOL Ruby 2.7/3.0, added Ruby 3.3/3.4 to the test matrix, bumped `actions/checkout` to v7, and fixed the Tests badge link in the README - [@dblock](https://github.com/dblock), [@Copilot](https://github.com/apps/copilot-swe-agent).
+
 ### 0.6.0 (2024/10/19)
 
 * [#40](https://github.com/dblock/open-weather-ruby-client/pull/40): Fixing rubocop violations and improved .rubocop.yml - [@troya2](https://github.com/troya2).

data/README.md

@@ -2,7 +2,8 @@ OpenWeather Ruby Client
 =======================
 
 [![Gem Version](https://badge.fury.io/rb/open-weather-ruby-client.svg)](https://badge.fury.io/rb/open-weather-ruby-client)
-[![Tests Status](https://github.com/dblock/open-weather-ruby-client/actions/workflows/test.yml/badge.svg)](https://github.com/dblock/open-weather-ruby-client/actions)
+[![Tests Status](https://github.com/dblock/open-weather-ruby-client/actions/workflows/test.yml/badge.svg)](https://github.com/dblock/open-weather-ruby-client/actions/workflows/test.yml)
+[![Coverage Status](https://coveralls.io/repos/github/dblock/open-weather-ruby-client/badge.svg?branch=master)](https://coveralls.io/github/dblock/open-weather-ruby-client?branch=master)
 
 A Ruby client for the [OpenWeather API v2.5 and v3.0](https://openweathermap.org/api).
 
@@ -22,6 +23,7 @@ Unlike other clients, including [open-weather](https://github.com/coderhs/ruby_o
     - [Historical Weather](#historical-weather)
   - [Hourly Forecast (Pro)](#hourly-forecast-pro)
   - [30 Day Forecast (Pro)](#30-day-forecast-pro)
+  - [5 Day Forecast](#5-day-forecast)
   - [Stations](#stations)
     - [Register a Station](#register-a-station)
     - [List Stations](#list-stations)
@@ -30,6 +32,10 @@ Unlike other clients, including [open-weather](https://github.com/coderhs/ruby_o
     - [Delete Station](#delete-station)
     - [Create Measurements](#create-measurements)
     - [Get Measurements](#get-measurements)
+  - [Geocoding](#geocoding)
+    - [Direct Geocoding](#direct-geocoding)
+    - [Reverse Geocoding](#reverse-geocoding)
+    - [Zip Code Geocoding](#zip-code-geocoding)
 - [Configuration](#configuration)
   - [Units](#units)
     - [Converting Temperature](#converting-temperature)
@@ -74,8 +80,8 @@ data.main.humidity # => 81
 data.main.pressure # => 1005
 data.main.temp # => 282.57
 data.main.temp_max # => 283.15, degrees Kelvin
-data.main.temp_max_c # => 10, degrees Celcius
-data.main.temp_max_f # => 50.0, degrees Farenheit
+data.main.temp_max_c # => 10, degrees Celsius
+data.main.temp_max_f # => 50.0, degrees Fahrenheit
 data.main.temp_min # => 281.48
 ```
 
@@ -266,6 +272,28 @@ data.list.first.rain # => double or nil - Precipitation volume, mm. Please note
 data.list.first.snow # => double or nil - Snow volume, mm. Please note that only mm as units of measurement are available for this parameter
 ```
 
+### 5 Day Forecast
+
+The [5 Day Forecast API](https://openweathermap.org/forecast5) provides weather forecast for 5 days with data every 3 hours by geographic coordinates.
+
+```ruby
+data = client.client.five_day_forecast(lat: 33.5312, lon: -111.9426, appid: "<your api key>") # => OpenWeather::Models::Forecast::FiveDay
+
+data.cnt # => 40 (number of entries)
+data.list.first # => OpenWeather::Models::Forecast::FiveDay::Forecast
+data.list.first.dt # => Time
+data.list.first.main # => OpenWeather::Models::Main
+data.list.first.weather # => Array[OpenWeather::Models::Weather]
+data.list.first.clouds # => OpenWeather::Models::Clouds or nil
+data.list.first.wind # => OpenWeather::Models::Wind or nil
+data.list.first.visibility # => 10000
+data.list.first.pop # => 0.1 (probability of precipitation from 0.0 to 1.0 (0% to 100%))
+data.list.first.rain # => OpenWeather::Models::Rain or nil
+data.list.first.snow # => OpenWeather::Models::Snow or nil
+data.list.first.sys # => OpenWeather::Models::Sys or nil
+data.list.first.dt_txt # => String (Time of data forecasted, ISO, UTC)
+```
+
 ### Stations
 
 The [Stations API](https://openweathermap.org/stations) lets your manage personal weather stations and measurements.
@@ -356,6 +384,43 @@ client.get_measurements(
 ) # => Array[OpenWeather::Models::Stations::Measurement]
 ```
 
+### Geocoding
+
+The [Geocoding API](https://openweathermap.org/api/geocoding-api) converts city names and zip/post codes to geographical coordinates, and vice versa.
+
+#### Direct Geocoding
+
+To get geographical coordinates for a city name, call the client method:
+```ruby
+client.geo_direct('London', nil, 'GB') # => Array[OpenWeather::Models::GeoLocation]
+```
+Or pass a hash of options.
+```ruby
+client.geo_direct(city: 'London', state: nil, country: 'GB', limit: 5) # => Array[OpenWeather::Models::GeoLocation]
+```
+
+#### Reverse Geocoding
+
+To get a location name for geographical coordinates, call the client method:
+```ruby
+client.geo_reverse(51.5074456, -0.1277653) # => Array[OpenWeather::Models::GeoLocation]
+```
+Or pass a hash of options.
+```ruby
+client.geo_reverse(lat: 51.5074456, lon: -0.1277653, limit: 5) # => Array[OpenWeather::Models::GeoLocation]
+```
+
+#### Zip Code Geocoding
+
+To get geographical coordinates for a zip/post code, call the client method:
+```ruby
+client.geo_zip('94040', 'US') # => OpenWeather::Models::GeoLocationZip
+```
+Or pass a hash of options.
+```ruby
+client.geo_zip(zip: '94040', country: 'US') # => OpenWeather::Models::GeoLocationZip
+```
+
 ## Configuration
 
 You can configure client options, globally.
@@ -390,7 +455,7 @@ The OpenWeather API returns responses in `standard`, `metric`, and `imperial` un
 ```ruby
 data = client.weather(id: 2643743, units: 'metric')
 data.name # => 'London'
-data.main.temp # => 12, degrees Celcius
+data.main.temp # => 12, degrees Celsius
 ```
 
 ```ruby
@@ -400,20 +465,20 @@ end
 
 data = client.weather(id: 2643743)
 data.name # => 'London'
-data.main.temp # => 12, degrees Celcius
+data.main.temp # => 12, degrees Celsius
 ```
 
 #### Converting Temperature
 
-APIs that return temperature support conversion between default, metric and imperial units, regardless of what units were requested. The following example requests current weather in metric units in Moscow. Use `_k` for Kelvin, `_c` for Celcius and `_f` for Farenheit.
+APIs that return temperature support conversion between default, metric and imperial units, regardless of what units were requested. The following example requests current weather in metric units in Moscow. Use `_k` for Kelvin, `_c` for Celsius and `_f` for Fahrenheit.
 
 ```ruby
 data = client.current_weather(city: 'Moscow', units: 'metric') # => OpenWeather::Models::City::Weather
 
-data.main.temp_max # => 12, degrees Celcius, metric as requested
-data.main.temp_max_c # => 12, degrees Celcius
+data.main.temp_max # => 12, degrees Celsius, metric as requested
+data.main.temp_max_c # => 12, degrees Celsius
 data.main.temp_max_k # => 285.15, degrees Kelvin
-data.main.temp_max_f # => 53.6, degrees Farenheit
+data.main.temp_max_f # => 53.6, degrees Fahrenheit
 ```
 
 #### Converting Wind Speed

data/lib/open_weather/client.rb

@@ -7,8 +7,10 @@ module OpenWeather
     include Endpoints::Current
     include Endpoints::Hourly
     include Endpoints::ThirtyDayForecast
+    include Endpoints::FiveDayForecast
     include Endpoints::OneCall
     include Endpoints::Stations
+    include Endpoints::Geocoding
 
     attr_accessor(*Config::ATTRIBUTES)
 

data/lib/open_weather/config.rb

@@ -7,6 +7,7 @@ module OpenWeather
     ATTRIBUTES = %i[
       endpoint
       pro_endpoint
+      geo_endpoint
       api_key
       proxy
       user_agent
@@ -24,6 +25,7 @@ module OpenWeather
     def reset
       self.endpoint = 'https://api.openweathermap.org/data'
       self.pro_endpoint = 'https://pro.openweathermap.org/data'
+      self.geo_endpoint = 'https://api.openweathermap.org/geo'
       self.api_key = nil
       self.user_agent = "OpenWeather Ruby Client/#{OpenWeather::VERSION}"
       self.ca_path = nil

data/lib/open_weather/endpoints/five_day_forecast.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Endpoints
+    module FiveDayForecast
+      def five_day_forecast(lat, lon = nil, options = {})
+        options = lat.is_a?(Hash) ? options.merge(lat) : options.merge(lat: lat, lon: lon)
+        OpenWeather::Models::Forecast::FiveDay::FiveDay.new(get('2.5/forecast', options), options)
+      end
+    end
+  end
+end

data/lib/open_weather/endpoints/geocoding.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Endpoints
+    module Geocoding
+      def geo_direct(name, state = nil, country = nil, options = {})
+        options = name.is_a?(Hash) ? options.merge(name) : options.merge(city: name, state: state, country: country)
+        options[:q] = [
+          options.delete(:city),
+          options.delete(:state),
+          options.delete(:country)
+        ].compact.join(',')
+        options[:endpoint] ||= geo_endpoint
+
+        get('1.0/direct', options).map { |data| OpenWeather::Models::GeoLocation.new(data) }
+      end
+
+      def geo_reverse(lat, lon = nil, options = {})
+        options = lat.is_a?(Hash) ? options.merge(lat) : options.merge(lat: lat, lon: lon)
+        options[:endpoint] ||= geo_endpoint
+
+        get('1.0/reverse', options).map { |data| OpenWeather::Models::GeoLocation.new(data) }
+      end
+
+      def geo_zip(code, country = nil, options = {})
+        options = code.is_a?(Hash) ? options.merge(code) : options.merge(zip: code, country: country)
+        options[:zip] = [
+          options.delete(:zip),
+          options.delete(:country)
+        ].compact.join(',')
+        options[:endpoint] ||= geo_endpoint
+
+        OpenWeather::Models::GeoLocationZip.new(get('1.0/zip', options))
+      end
+    end
+  end
+end

data/lib/open_weather/endpoints.rb

@@ -5,3 +5,5 @@ require_relative 'endpoints/one_call'
 require_relative 'endpoints/stations'
 require_relative 'endpoints/hourly'
 require_relative 'endpoints/thirty_day_forecast'
+require_relative 'endpoints/five_day_forecast'
+require_relative 'endpoints/geocoding'

data/lib/open_weather/models/forecast/five_day/five_day.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    module Forecast
+      module FiveDay
+        class FiveDay < Model
+          include Enumerable
+
+          property 'cod'
+          property 'message'
+          property 'cnt'
+          property 'list'
+
+          def initialize(args = nil, options = {})
+            super args, options
+
+            self.list = list.map { |forecast| Forecast.new(forecast, options) } if list
+          end
+        end
+      end
+    end
+  end
+end

data/lib/open_weather/models/forecast/five_day/forecast.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    module Forecast
+      module FiveDay
+        class Forecast < Model
+          property 'dt', transform_with: ->(v) { Time.at(v).utc } # time of data forcasted, UTC
+          property 'main' # Main weather data
+          property 'weather' # Array of OpenWeather::Models::Weather
+          property 'clouds' # Cloudiness data
+          property 'wind' # Wind data
+          property 'visibility' # Visibility, meter
+          property 'pop' # Probability of precipitation
+          property 'rain' # Rain data
+          property 'snow' # Snow data
+          property 'sys' # System data
+          property 'dt_txt' # Date and time of calculation, UTC
+
+          def initialize(args = nil, options = {})
+            super args, options
+
+            self.main = OpenWeather::Models::Main.new(main, options) if main
+            self.weather = weather.map { |w| OpenWeather::Models::Weather.new(w, options) } if weather
+            self.clouds = OpenWeather::Models::Clouds.new(clouds, options) if clouds
+            self.wind = OpenWeather::Models::Wind.new(wind, options) if wind
+            self.rain = OpenWeather::Models::Rain.new(rain, options) if rain
+            self.snow = OpenWeather::Models::Snow.new(snow, options) if snow
+            self.sys = OpenWeather::Models::Sys.new(sys, options) if sys
+          end
+        end
+      end
+    end
+  end
+end

data/lib/open_weather/models/forecast/five_day.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'five_day/five_day'
+require_relative 'five_day/forecast'

data/lib/open_weather/models/forecast/thirty_day/forecast.rb

@@ -8,7 +8,7 @@ module OpenWeather
           property 'dt', transform_with: ->(v) { Time.at(v).utc } # time of data forcasted, UTC
           property 'sunrise', transform_with: ->(v) { Time.at(v).utc } # Sunrise time, UTC
           property 'sunset', transform_with: ->(v) { Time.at(v).utc } # Sunset time, UTC
-          property 'temp' # Array of OpenWeather::Models::Forecast::ThityDay::Temp
+          property 'temp' # Array of OpenWeather::Models::Forecast::ThirtyDay::Temp
           property 'feels_like' # OpenWeather::Models::OneCall::FeelsLike
           property 'pressure' # Atmospheric pressure on the sea level, hPa
           property 'humidity' # Humidity, % (e.g. integer 24 means 24% cloudiness)

data/lib/open_weather/models/forecast.rb

@@ -2,5 +2,6 @@
 
 require_relative 'forecast/hourly'
 require_relative 'forecast/thirty_day'
+require_relative 'forecast/five_day'
 require_relative 'forecast/forecast'
 require_relative 'forecast/city'

data/lib/open_weather/models/geo_location.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    class GeoLocation < Model
+      property 'name' # name of the found location
+      property 'local_names' # name of the found location in different languages
+      property 'lat' # geo location, latitude
+      property 'lon' # geo location, longitude
+      property 'country' # country of the found location
+      property 'state' # state of the found location
+    end
+  end
+end

data/lib/open_weather/models/geo_location_zip.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    class GeoLocationZip < Model
+      property 'zip' # zip/post code
+      property 'name' # name of the found location
+      property 'lat' # geo location, latitude
+      property 'lon' # geo location, longitude
+      property 'country' # country of the found location
+    end
+  end
+end

data/lib/open_weather/models/mixins/temp.rb

@@ -15,11 +15,11 @@ module OpenWeather
             end
 
             define_method "#{field}_c" do
-              to_celcius(send(field))
+              to_celsius(send(field))
             end
 
             define_method "#{field}_f" do
-              to_farenheit(send(field))
+              to_fahrenheit(send(field))
             end
           end
         end
@@ -37,7 +37,7 @@ module OpenWeather
           end
         end
 
-        def to_celcius(value)
+        def to_celsius(value)
           case units
           when :metric
             value
@@ -48,7 +48,7 @@ module OpenWeather
           end
         end
 
-        def to_farenheit(value)
+        def to_fahrenheit(value)
           case units
           when :metric
             ((value.to_f * 9 / 5) + 32).round(2)

data/lib/open_weather/models/wind.rb

@@ -5,6 +5,7 @@ module OpenWeather
     class Wind < Model
       speed_property 'speed' # wind speed in meter/sec or miles/hour
       property 'deg' # wind direction in degrees (meteorological)
+      speed_property 'gust' # gust speed in meters/sec for miles/hour
     end
   end
 end

data/lib/open_weather/models.rb

@@ -15,6 +15,8 @@ require_relative 'models/city'
 require_relative 'models/one_call'
 require_relative 'models/forecast'
 require_relative 'models/station'
+require_relative 'models/geo_location'
+require_relative 'models/geo_location_zip'
 require_relative 'models/stations/measurement'
 require_relative 'models/stations/temp'
 require_relative 'models/stations/humidity'

data/lib/open_weather/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenWeather
-  VERSION = '0.6.0'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open-weather-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-19 00:00:00.000000000 Z
+date: 2026-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -72,28 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: danger-pr-comment
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: danger-toc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +221,8 @@ files:
 - lib/open_weather/connection.rb
 - lib/open_weather/endpoints.rb
 - lib/open_weather/endpoints/current.rb
+- lib/open_weather/endpoints/five_day_forecast.rb
+- lib/open_weather/endpoints/geocoding.rb
 - lib/open_weather/endpoints/hourly.rb
 - lib/open_weather/endpoints/one_call.rb
 - lib/open_weather/endpoints/stations.rb
@@ -221,12 +237,17 @@ files:
 - lib/open_weather/models/coord.rb
 - lib/open_weather/models/forecast.rb
 - lib/open_weather/models/forecast/city.rb
+- lib/open_weather/models/forecast/five_day.rb
+- lib/open_weather/models/forecast/five_day/five_day.rb
+- lib/open_weather/models/forecast/five_day/forecast.rb
 - lib/open_weather/models/forecast/forecast.rb
 - lib/open_weather/models/forecast/hourly.rb
 - lib/open_weather/models/forecast/thirty_day.rb
 - lib/open_weather/models/forecast/thirty_day/forecast.rb
 - lib/open_weather/models/forecast/thirty_day/temp.rb
 - lib/open_weather/models/forecast/thirty_day/thirty_day.rb
+- lib/open_weather/models/geo_location.rb
+- lib/open_weather/models/geo_location_zip.rb
 - lib/open_weather/models/list.rb
 - lib/open_weather/models/main.rb
 - lib/open_weather/models/mixins.rb
@@ -275,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: OpenWeather API Ruby client.