open-weather-ruby-client 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6f08b9b57fd352c8ad1733b4b25f9bb261d015a226fa40da66f506772824452
-  data.tar.gz: eb4e97da6efd6dacac6c827c42039de81cb9aa399511cb8d5736131dc6a7ba53
+  metadata.gz: 50db5335dc75a5a05dceb8c71b9de5a46b325e15f3a4a7a61ea04e7667be4937
+  data.tar.gz: f0666d4eab1829d74d4a76c0ea484e8b555199ffdbfd6684f0dd259587e2f930
 SHA512:
-  metadata.gz: 0a842f0686f6886c2d7c17e214adfa1834c7f7b4d497950a00a1e372f97b394e3ced599f14a219246b93367c472f609bbf930feb42721555187dfd86554cd1c4
-  data.tar.gz: 05dbb02fa61d7d30aa1bdd4cd538725dd3b46f19f63a48963b63a3576c2320ae9f816a22b5fc8d6fd5ad2ae22387a09a0573657f2ebfdbad9fa8755164a72de5
+  metadata.gz: d6cb7dc0addc30dbc76108b055ac1a36dcc5b9d91049af28ce8ee3c5e046c19a0431218ce037f2f7d1be550ae06c7faddf8ff33073a924b767d6ac4edcaed158
+  data.tar.gz: 818a28e582b0f359ce1005fcc0fead12135a2f0b1c8f0d2cd8a46dbebf11e66901937a351b09ce66589d9f98525a53cdc3c476a164e1f8ab98a259f183f2e68c

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.5.0 (2024/07/03)
+
+* [#25](https://github.com/dblock/open-weather-ruby-client/pull/25): Exposed the national weather alerts response in the One Call API - [@troya2](https://github.com/troya2).
+* [#38](https://github.com/dblock/open-weather-ruby-client/pull/38): Migrated to One Call 3.0 API - [@jeanmartin](https://github.com/jeanmartin).
+* [#39](https://github.com/dblock/open-weather-ruby-client/pull/39): Added support for the hourly forecast in the pro 2.5 API - [@troya2](https://github.com/troya2).
+
 ### 0.4.0 (2023/08/13)
 
 * [#33](https://github.com/dblock/open-weather-ruby-client/pull/33): Upgrade Faraday to 2.x - [@dgarwood](https://github.com/dgarwood).

data/README.md

@@ -20,6 +20,7 @@ Unlike other clients, including [open-weather](https://github.com/coderhs/ruby_o
   - [One Call](#one-call)
     - [Current and Forecast Weather](#current-and-forecast-weather)
     - [Historical Weather](#historical-weather)
+  - [Hourly Forecast (Pro)](#hourly-forecast-pro)
   - [Stations](#stations)
     - [Register a Station](#register-a-station)
     - [List Stations](#list-stations)
@@ -87,10 +88,21 @@ data.main.temp # => 12
 ```
 
 Returns weather by city, optional state (in the US) and optional ISO 3166 country code.
+Names that cannot be resolved will cause the API call to raise a `Faraday::ResourceNotFound` error.
 
 ```ruby
-client.current_city('New York', 'NY', 'US')
-client.current_weather(city: 'New York', state: 'NY', country: 'US')
+client.current_city('Sydney')
+client.current_city('London, UK')
+client.current_city('London', 'UK')
+client.current_city('Albany')
+client.current_city('Albany, New York')
+client.current_city('Albany, New York', 'US')
+client.current_city('Albany, NY', 'US')
+client.current_city('Albany', 'New York', 'US')
+client.current_city('Albany', 'NY', 'US')
+client.current_city('Albany', 'NY')  # 2-letter state abbreviation w/o country will raise Faraday::ResourceNotFound
+
+client.current_weather(city: 'Albany', state: 'NY', country: 'US')
 ```
 
 Returns weather by city ID.
@@ -167,7 +179,7 @@ data.main.temp # => 285.15
 
 ### One Call
 
-[One Call API](https://openweathermap.org/api/one-call-api) provides current weather, minute forecast for 1 hour, hourly forecast for 48 hours, daily forecast for 7 days, and historical weather data for 5 previous days for any geographical coordinate.
+[One Call API](https://openweathermap.org/api/one-call-api) provides current weather, minute forecast for 1 hour, hourly forecast for 48 hours, daily forecast for 7 days, historical weather data for 5 previous days for any geographical coordinate, and national weather alerts.
 
 See [OpenWeather::Models::OneCall](lib/open_weather/models/one_call) for all available models and properties.
 
@@ -175,6 +187,7 @@ See [OpenWeather::Models::OneCall](lib/open_weather/models/one_call) for all ava
 
 ```ruby
 data = client.one_call(lat: 33.441792, lon: -94.037689) # => OpenWeather::Models::OneCall::Weather
+
 data.lat # => 33.44
 data.lon # => -94.04
 data.timezone # => 'America/Chicago'
@@ -182,6 +195,7 @@ data.current # => OpenWeather::Models::OneCall::CurrentWeather
 data.minutely # => Array[OpenWeather::Models::OneCall::MinutelyWeather]
 data.hourly # => Array[OpenWeather::Models::OneCall::HourlyWeather]
 data.daily # => Array[OpenWeather::Models::OneCall::DailyWeather]
+data.alerts # => Array[OpenWeather::Models::OneCall::Alert]
 ```
 
 Exclude minutely and hourly data.
@@ -194,6 +208,7 @@ client.one_call(lat: 33.441792, lon: -94.037689, exclude: ['minutely', 'hourly']
 
 ```ruby
 data = client.one_call(lat: 33.441792, lon: -94.037689, dt: Time.now - 24 * 60 * 60) # => OpenWeather::Models::OneCall::Weather
+
 data.lat # => 33.44
 data.lon # => -94.04
 data.timezone # => 'America/Chicago'
@@ -201,6 +216,28 @@ data.current # => OpenWeather::Models::OneCall::CurrentWeather
 data.hourly # => Array[OpenWeather::Models::OneCall::HourlyWeather]
 ```
 
+### Hourly Forecast (Pro)
+
+The [Hourly Forecast API](https://openweathermap.org/api/hourly-forecast) provides hourly weather forecast for 4 days.  Note: This API requires a piad api-key from [OpenWeather.org](https://openweathermap.org/full-price#current).
+
+```ruby
+data = client.client.hourly(lat: 33.5312, lon: -111.9426) # => OpenWeather::Models::Forecast::Hourly
+
+data.cnt # => 96 (number of entries)
+data.list.first # => OpenWeather::Models::Forecast::Forecast
+data.list.first.dt # => Time
+data.list.first.main # => OpenWeather::Models::Forecast::Main
+data.list.first.weather # => Array[OpenWeather::Models::Forecast::Weather]
+data.list.first.clouds # => OpenWeather::Models::Forecast::Clouds or nil
+data.list.first.wind # => OpenWeather::Models::Forecast::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::Forecast::Rain or nil
+data.list.first.snow # => OpenWeather::Models::Forecast::Snow or nil
+data.list.first.sys # => OpenWeather::Models::Forecast::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.

data/lib/open_weather/client.rb

@@ -5,6 +5,7 @@ module OpenWeather
     include Connection
     include Request
     include Endpoints::Current
+    include Endpoints::Hourly
     include Endpoints::OneCall
     include Endpoints::Stations
 

data/lib/open_weather/config.rb

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

data/lib/open_weather/endpoints/hourly.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Endpoints
+    module Hourly
+      def hourly(lat, lon = nil, options = {})
+        # default to the pro endpoint if not specified
+        endpoint = options.delete(:endpoint) || pro_endpoint
+        options = options.merge(endpoint: endpoint)
+
+        options = lat.is_a?(Hash) ? options.merge(lat) : options.merge(lat: lat, lon: lon)
+        OpenWeather::Models::Forecast::Hourly.new(get('2.5/forecast/hourly', options), options)
+      end
+    end
+  end
+end

data/lib/open_weather/endpoints/one_call.rb

@@ -7,7 +7,7 @@ module OpenWeather
         options = lat.is_a?(Hash) ? options.merge(lat) : options.merge(lat: lat, lon: lon)
         options[:exclude] = options[:exclude].join(',') if options[:exclude].is_a?(Array)
         options[:dt] = options[:dt].to_i if options[:dt].is_a?(Time)
-        path = options.key?(:dt) ? '2.5/onecall/timemachine' : '2.5/onecall'
+        path = options.key?(:dt) ? '3.0/onecall/timemachine' : '3.0/onecall'
         OpenWeather::Models::OneCall::Weather.new(get(path, options), options)
       end
     end

data/lib/open_weather/endpoints.rb

@@ -3,3 +3,4 @@
 require_relative 'endpoints/current'
 require_relative 'endpoints/one_call'
 require_relative 'endpoints/stations'
+require_relative 'endpoints/hourly'

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    module Forecast
+      class City < Model
+        property 'id' # City ID
+        property 'name' # City name
+        property 'coord', transform_with: ->(v) { OpenWeather::Models::Coord.new(v) } # City geo location
+        property 'country' # Country code (GB, JP etc.).
+        property 'timezone' # shift in seconds from 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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    module Forecast
+      class Forecast < Model
+        property 'dt', transform_with: ->(v) { Time.at(v).utc } # time of data forcasted, UTC
+        property 'dt_txt' # Time of data forecasted, ISO, UTC
+        property 'main'
+        property 'weather'
+        property 'clouds'
+        property 'wind'
+        property 'rain'
+        property 'snow'
+        property 'visibility' # Average visibility, metres. The maximum value of the visibility is 10km
+        property 'pop' # Probability of precipitation. The values of the parameter vary between 0 and 1, where 0 is equal to 0%, 1 is equal to 100%
+        property 'sys'
+
+        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

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

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

data/lib/open_weather/models/forecast.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'forecast/hourly'
+require_relative 'forecast/forecast'
+require_relative 'forecast/city'

data/lib/open_weather/models/one_call/alert.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    module OneCall
+      class Alert < Model
+        property 'sender_name'
+        property 'event'
+        property 'start', transform_with: ->(v) { Time.at(v).utc } # UTC
+        property 'end', transform_with: ->(v) { Time.at(v).utc } # UTC
+        property 'description'
+      end
+    end
+  end
+end

data/lib/open_weather/models/one_call/daily_weather.rb

@@ -20,6 +20,7 @@ module OpenWeather
         property 'rain' # precipitation volume, mm
         property 'snow' # snow volume, mm
         property 'weather'
+        property 'summary'
 
         def initialize(args = nil, options = {})
           super args, options

data/lib/open_weather/models/one_call/weather.rb

@@ -11,6 +11,7 @@ module OpenWeather
         property 'minutely' # minute forecast weather
         property 'hourly' # hourly forecast weather
         property 'daily' # daily forecast weather
+        property 'alerts' # weather alerts for the location
 
         def initialize(args = nil, options = {})
           super args, options
@@ -19,6 +20,7 @@ module OpenWeather
           self.minutely = minutely.map { |i| OpenWeather::Models::OneCall::MinutelyWeather.new(i, options) } if minutely
           self.hourly = hourly.map { |i| OpenWeather::Models::OneCall::HourlyWeather.new(i, options) } if hourly
           self.daily = daily.map { |i| OpenWeather::Models::OneCall::DailyWeather.new(i, options) } if daily
+          self.alerts = alerts.map { |i| OpenWeather::Models::OneCall::Alert.new(i, options) } if alerts
         end
       end
     end

data/lib/open_weather/models/one_call.rb

@@ -7,3 +7,4 @@ require_relative 'one_call/daily_weather'
 require_relative 'one_call/hourly_weather'
 require_relative 'one_call/minutely_weather'
 require_relative 'one_call/weather'
+require_relative 'one_call/alert'

data/lib/open_weather/models.rb

@@ -13,6 +13,7 @@ require_relative 'models/snow'
 require_relative 'models/list'
 require_relative 'models/city'
 require_relative 'models/one_call'
+require_relative 'models/forecast'
 require_relative 'models/station'
 require_relative 'models/stations/measurement'
 require_relative 'models/stations/temp'

data/lib/open_weather/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open-weather-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-13 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -207,6 +207,7 @@ files:
 - lib/open_weather/connection.rb
 - lib/open_weather/endpoints.rb
 - lib/open_weather/endpoints/current.rb
+- lib/open_weather/endpoints/hourly.rb
 - lib/open_weather/endpoints/one_call.rb
 - lib/open_weather/endpoints/stations.rb
 - lib/open_weather/errors.rb
@@ -217,6 +218,10 @@ files:
 - lib/open_weather/models/city/weather.rb
 - lib/open_weather/models/clouds.rb
 - lib/open_weather/models/coord.rb
+- lib/open_weather/models/forecast.rb
+- lib/open_weather/models/forecast/city.rb
+- lib/open_weather/models/forecast/forecast.rb
+- lib/open_weather/models/forecast/hourly.rb
 - lib/open_weather/models/list.rb
 - lib/open_weather/models/main.rb
 - lib/open_weather/models/mixins.rb
@@ -224,6 +229,7 @@ files:
 - lib/open_weather/models/mixins/temp.rb
 - lib/open_weather/models/model.rb
 - lib/open_weather/models/one_call.rb
+- lib/open_weather/models/one_call/alert.rb
 - lib/open_weather/models/one_call/current_weather.rb
 - lib/open_weather/models/one_call/daily_weather.rb
 - lib/open_weather/models/one_call/feels_like.rb
@@ -264,7 +270,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.6
 signing_key:
 specification_version: 4
 summary: OpenWeather API Ruby client.