open-weather-ruby-client 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ae98694e49ce5daa921935652931c2ef63892907641f17634cab2b16f044283
-  data.tar.gz: d318548404776897b45598a4ee1b0bf7c6b2cbda28c39758df96aece5c2c447b
+  metadata.gz: f58c9713754c10d3b49e6b5798db270924130a6b40cc96df49f1530cdff68bf4
+  data.tar.gz: 8e05928fde71a02d177df35ae3b6f1ab78f19f756e21b1f6a766133de6c37fee
 SHA512:
-  metadata.gz: 27f5329a0d98d2e5db78bad49e5724b0358827c98478cc83f4e5ddf87e7fefdcd3028e26753402e338f4616c836a05c17aecf4a9d8f05fa211d5f903d606e96c
-  data.tar.gz: a5e387ce420b0c24f51e5ba8168e7d8a5c29aaa74543af82565aa320dc0873165e99fb01b2cfb587fc5427544b5ff2dfa6edd0f11bae6ebb44097d698acaaf3f
+  metadata.gz: f047b48bec6d1f0b5b8391c1c9f7ac7896383c169253cd0cb2096d4532bb2801309a0c68ede79b87853068aecf6090939e507cb6e2f520b5091dc22cb1fbff80
+  data.tar.gz: 12c3e088084c4457e28659f4b82dca9b18d8926aea70eb87588a847a6523bb60c893b14919c3ce25a9ecc5458b33fb983a8af33ec62381d254a9a9c3ba5d8ffc

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-### 0.7.0 (8/23/2026)
+### 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).

data/README.md

@@ -3,6 +3,7 @@ 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/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).
 
@@ -31,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)
@@ -75,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
 ```
 
@@ -379,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.
@@ -413,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
@@ -423,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

@@ -10,6 +10,7 @@ module OpenWeather
     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/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

@@ -6,3 +6,4 @@ 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/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.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.7.0'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open-weather-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -205,6 +206,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+description:
 email: dblock@dblock.org
 executables: []
 extensions: []
@@ -220,6 +222,7 @@ files:
 - 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
@@ -243,6 +246,8 @@ files:
 - 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
@@ -276,6 +281,7 @@ homepage: http://github.com/dblock/open-weather-ruby-client
 licenses:
 - MIT
 metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -290,7 +296,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: OpenWeather API Ruby client.
 test_files: []