open-weather-ruby-client 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50db5335dc75a5a05dceb8c71b9de5a46b325e15f3a4a7a61ea04e7667be4937
-  data.tar.gz: f0666d4eab1829d74d4a76c0ea484e8b555199ffdbfd6684f0dd259587e2f930
+  metadata.gz: 3c8876fceee8fa7e6f946be1b82161cfbfc8ef8b4aad00497d62b92eade54d63
+  data.tar.gz: 9ca8ab329c506558cde05eb20c33c29c6a88f9b8f74816d560e23afbeb07e270
 SHA512:
-  metadata.gz: d6cb7dc0addc30dbc76108b055ac1a36dcc5b9d91049af28ce8ee3c5e046c19a0431218ce037f2f7d1be550ae06c7faddf8ff33073a924b767d6ac4edcaed158
-  data.tar.gz: 818a28e582b0f359ce1005fcc0fead12135a2f0b1c8f0d2cd8a46dbebf11e66901937a351b09ce66589d9f98525a53cdc3c476a164e1f8ab98a259f183f2e68c
+  metadata.gz: 319c7c0dd8477f8ba00efae26150a56a390a7ca15e5522a87d46b80896a16356406df8d07a4a9f79969e0008be79850683aa13bc8e29ee62f42b5892594bc0da
+  data.tar.gz: 7b085b56ec87b9f397b83b49946cc4ed91fe52c24797a8b43dd643d3634285da4cf0fd95b46796c17cb98578e75c5d6928be0b1033fd117e50722706f60a9005

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 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).
+* [#41](https://github.com/dblock/open-weather-ruby-client/pull/41): Added additional tests for hourly forecast that include all data types - i.e. rain and snow - [@troya2](https://github.com/troya2).
+* [#42](https://github.com/dblock/open-weather-ruby-client/pull/42): Added support for the thirty day forecast in the pro 2.5 API - [@troya2](https://github.com/troya2).
+* [#45](https://github.com/dblock/open-weather-ruby-client/pull/45): Added support for One Call 3.0 API on base plan - [@dblock](https://github.com/dblock).
+
 ### 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).

data/README.md

@@ -21,6 +21,7 @@ Unlike other clients, including [open-weather](https://github.com/coderhs/ruby_o
     - [Current and Forecast Weather](#current-and-forecast-weather)
     - [Historical Weather](#historical-weather)
   - [Hourly Forecast (Pro)](#hourly-forecast-pro)
+  - [30 Day Forecast (Pro)](#30-day-forecast-pro)
   - [Stations](#stations)
     - [Register a Station](#register-a-station)
     - [List Stations](#list-stations)
@@ -192,6 +193,7 @@ data.lat # => 33.44
 data.lon # => -94.04
 data.timezone # => 'America/Chicago'
 data.current # => OpenWeather::Models::OneCall::CurrentWeather
+data.data # => Array]OpenWeather::Models::OneCall::CurrentWeather] (on base plan)
 data.minutely # => Array[OpenWeather::Models::OneCall::MinutelyWeather]
 data.hourly # => Array[OpenWeather::Models::OneCall::HourlyWeather]
 data.daily # => Array[OpenWeather::Models::OneCall::DailyWeather]
@@ -218,12 +220,13 @@ 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).
+The [Hourly Forecast API](https://openweathermap.org/api/hourly-forecast) provides hourly weather forecast for 4 days.  Note: This API requires a paid 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 = client.client.hourly(lat: 33.5312, lon: -111.9426, appid: "<your api key>") # => OpenWeather::Models::Forecast::Hourly
 
 data.cnt # => 96 (number of entries)
+data.city # => OpenWeather::Models::Forecast::City
 data.list.first # => OpenWeather::Models::Forecast::Forecast
 data.list.first.dt # => Time
 data.list.first.main # => OpenWeather::Models::Forecast::Main
@@ -238,6 +241,31 @@ data.list.first.sys # => OpenWeather::Models::Forecast::Sys or nil
 data.list.first.dt_txt # => String (Time of data forecasted, ISO, UTC)
 ```
 
+### 30 Day Forecast (Pro)
+
+The [30 Day Forecast API](https://openweathermap.org/api/forecast30) provides daily weather forecast for 30 days.  Note: This API requires a paid api-key from [OpenWeather.org](https://openweathermap.org/full-price#current).
+
+```ruby
+data = client.client.forecast(lat: 33.5312, lon: -111.9426, appid: "<your api key>") # => OpenWeather::Models::Forecast::ThirtyDay::ThirtyDay
+
+data.cnt # => 30 (number of entries - sometimes this is 29)
+data.city # => OpenWeather::Models::Forecast::City
+data.list.first # => OpenWeather::Models::Forecast::ThirtyDay::Forecast
+data.list.first.dt # => Time - time of data forcasted, UTC
+data.list.first.sunrise # => Time - Sunrise time, UTC
+data.list.first.sunset # => Time - Sunset time, UTC
+data.list.first.temp # => OpenWeather::Models::Forecast::ThirtyDay::Temp
+data.list.first.feels_like # => OpenWeather::Models::OneCall::FeelsLike
+data.list.first.pressure # => int - Atmospheric pressure on the sea level, hPa
+data.list.first.humidity # => int - Humidity, % (e.g. integer 24 means 24% cloudiness)
+data.list.first.weather # => Array[OpenWeather::Models::Weather]
+data.list.first.speed # => double - Wind speed. Unit Default: meter/sec, Metric: meter/sec, Imperial: miles/hour
+data.list.first.deg # => int - Wind direction, degrees (meteorological)
+data.list.first.clouds # => int - Cloudiness, % (e.g. integer 78 means 78% cloudiness)
+data.list.first.rain # => double or nil - Precipitation volume, mm. Please note that only mm as units of measurement are available for this parameter
+data.list.first.snow # => double or nil - Snow volume, mm. Please note that only mm as units of measurement are available for this parameter
+```
+
 ### Stations
 
 The [Stations API](https://openweathermap.org/stations) lets your manage personal weather stations and measurements.
@@ -341,19 +369,19 @@ end
 
 The following settings are supported.
 
-setting             | description
---------------------|------------
-api_key             | Required API key.
-lang                | Default language in API responses.
-units               | Default units in API responses.
-endpoint            | Defaults to `https://api.openweathermap.org/data`.
-user_agent          | User-agent, defaults to _OpenWeather Ruby Client/version_.
-proxy               | Optional HTTP proxy.
-ca_path             | Optional SSL certificates path.
-ca_file             | Optional SSL certificates file.
-logger              | Optional `Logger` instance that logs HTTP requests.
-timeout             | Optional open/read timeout in seconds.
-open_timeout        | Optional connection open timeout in seconds.
+| setting      | description                                                |
+| ------------ | ---------------------------------------------------------- |
+| api_key      | Required API key.                                          |
+| lang         | Default language in API responses.                         |
+| units        | Default units in API responses.                            |
+| endpoint     | Defaults to `https://api.openweathermap.org/data`.         |
+| user_agent   | User-agent, defaults to _OpenWeather Ruby Client/version_. |
+| proxy        | Optional HTTP proxy.                                       |
+| ca_path      | Optional SSL certificates path.                            |
+| ca_file      | Optional SSL certificates file.                            |
+| logger       | Optional `Logger` instance that logs HTTP requests.        |
+| timeout      | Optional open/read timeout in seconds.                     |
+| open_timeout | Optional connection open timeout in seconds.               |
 
 ### Units
 

data/lib/open_weather/client.rb

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

data/lib/open_weather/endpoints/stations.rb

@@ -46,7 +46,7 @@ module OpenWeather
       private
 
       def validate_id(id)
-        raise ArgumentError, 'Invalid ID' unless id&.is_a?(String)
+        raise ArgumentError, 'Invalid ID' unless id.is_a?(String)
       end
     end
   end

data/lib/open_weather/endpoints/thirty_day_forecast.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Endpoints
+    module ThirtyDayForecast
+      def thirty_day_forecast(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::ThirtyDay::ThirtyDay.new(get('2.5/forecast/climate', options), options)
+      end
+    end
+  end
+end

data/lib/open_weather/endpoints.rb

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

data/lib/open_weather/logger.rb

@@ -6,7 +6,7 @@ module OpenWeather
   class Logger < ::Logger
     def self.logger
       @logger ||= begin
-        logger = new STDOUT
+        logger = new $stdout
         logger.level = Logger::WARN
         logger
       end

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

@@ -11,6 +11,7 @@ module OpenWeather
         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
+        property 'population' # City population
       end
     end
   end

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

@@ -13,7 +13,7 @@ module OpenWeather
         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 'pop' # Probability of precipitation. Varies from 0 and 1, where 0 is equal to 0%, 1 is equal to 100%
         property 'sys'
 
         def initialize(args = nil, options = {})

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    module Forecast
+      module ThirtyDay
+        class Forecast < Model
+          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 '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)
+          property 'weather' # Array of OpenWeather::Models::Weather
+          property 'speed' # Wind speed. Unit Default: meter/sec, Metric: meter/sec, Imperial: miles/hour
+          property 'deg' # Wind direction, degrees (meteorological)
+          property 'clouds' # Cloudiness, % (e.g. integer 78 means 78% cloudiness)
+          property 'rain' # Precipitation volume, mm. Unit will only be in mm
+          property 'snow' # Snow volume, mm. Unit will only be in mm
+
+          def initialize(args = nil, options = {})
+            super args, options
+
+            self.temp = Temp.new(temp, options) if temp
+            self.feels_like = OpenWeather::Models::OneCall::FeelsLike.new(feels_like, options) if feels_like
+            self.weather = weather.map { |w| OpenWeather::Models::Weather.new(w, options) } if weather
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    module Forecast
+      module ThirtyDay
+        class Temp < Model
+          temperature_property 'day' # Day temperature. Default: Kelvin, Metric: Celsius, Imperial: Fahrenheit
+          temperature_property 'min' # Min daily temperature. Default: Kelvin, Metric: Celsius, Imperial: Fahrenheit
+          temperature_property 'max' # Max daily temperature. Default: Kelvin, Metric: Celsius, Imperial: Fahrenheit
+          temperature_property 'night' # Night temperature. Default: Kelvin, Metric: Celsius, Imperial: Fahrenheit
+          temperature_property 'eve' # Evening temperature. Default: Kelvin, Metric: Celsius, Imperial: Fahrenheit
+          temperature_property 'morn' # Morning temperature. Default: Kelvin, Metric: Celsius, Imperial: Fahrenheit
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    module Forecast
+      module ThirtyDay
+        class ThirtyDay < Model
+          include Enumerable
+
+          property 'cod' # Internal parameter
+          property 'message' # Internal parameter
+          property 'city'
+          property 'cnt' # Number of items in list
+          property 'list' # List of ??? objects
+
+          def initialize(args = nil, options = {})
+            super args, options
+
+            self.list = list.map { |forecast| Forecast.new(forecast, options) } if list
+            self.city = OpenWeather::Models::Forecast::City.new(city, options) if city
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'thirty_day/thirty_day'
+require_relative 'thirty_day/forecast'
+require_relative 'thirty_day/temp'

data/lib/open_weather/models/forecast.rb

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

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

@@ -31,7 +31,7 @@ module OpenWeather
           when :metric
             (value.to_f + 273.15).round(2)
           when :imperial
-            ((value.to_f - 32) * 5 / 9 + 273.15).round(2)
+            (((value.to_f - 32) * 5 / 9) + 273.15).round(2)
           else
             value
           end
@@ -55,7 +55,7 @@ module OpenWeather
           when :imperial
             value
           else
-            ((value.to_f - 273.15) * 9 / 5 + 32).round(2)
+            (((value.to_f - 273.15) * 9 / 5) + 32).round(2)
           end
         end
       end

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

@@ -11,7 +11,9 @@ module OpenWeather
         temperature_property 'feels_like' # temperature, accounts for the human perception of weather
         property 'pressure' # atmospheric pressure on the sea level, hPa
         property 'humidity' # humidity, %
-        temperature_property 'dew_point' # atmospheric temperature (varying according to pressure and humidity) below which water droplets begin to condense and dew can form
+        # atmospheric temperature (varying according to pressure and humidity)
+        # below which water droplets begin to condense and dew can form
+        temperature_property 'dew_point'
         property 'clouds' # cloudiness, %
         property 'uvi' # UV index
         property 'visibility' # average visibility, meters

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

@@ -11,7 +11,9 @@ module OpenWeather
         property 'feels_like'
         property 'pressure' # atmospheric pressure on the sea level, hPa
         property 'humidity' # humidity, %
-        temperature_property 'dew_point' # atmospheric temperature (varying according to pressure and humidity) below which water droplets begin to condense and dew can form
+        # atmospheric temperature (varying according to pressure and humidity)
+        # below which water droplets begin to condense and dew can form
+        temperature_property 'dew_point'
         speed_property 'wind_speed' # wind speed
         speed_property 'wind_gust' # wind gust
         property 'wind_deg' # wind direction, degrees (meteorological)

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

@@ -9,7 +9,9 @@ module OpenWeather
         temperature_property 'feels_like'
         property 'pressure' # atmospheric pressure on the sea level, hPa
         property 'humidity' # humidity, %
-        temperature_property 'dew_point' # atmospheric temperature (varying according to pressure and humidity) below which water droplets begin to condense and dew can form
+        # atmospheric temperature (varying according to pressure and humidity)
+        # below which water droplets begin to condense and dew can form
+        temperature_property 'dew_point'
         property 'clouds' # cloudiness, %
         property 'visibility' # average visibility, meters
         speed_property 'wind_speed' # wind speed.

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

@@ -12,11 +12,13 @@ module OpenWeather
         property 'hourly' # hourly forecast weather
         property 'daily' # daily forecast weather
         property 'alerts' # weather alerts for the location
+        property 'data' # weather data
 
         def initialize(args = nil, options = {})
           super args, options
 
           self.current = OpenWeather::Models::OneCall::CurrentWeather.new(current, options) if current
+          self.data = data.map { |i| OpenWeather::Models::OneCall::CurrentWeather.new(i, options) } if data
           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

data/lib/open_weather/models/stations/measurement.rb

@@ -5,7 +5,7 @@ module OpenWeather
     module Stations
       class Measurement < Model
         property 'station_id' # The internal ID of the station
-        property 'type' # Type of the aggregated data - minute, hour or day. Specifies the letters m, h or d respectively
+        property 'type' # Type of the aggregated data - minute, hour or day - the letters m, h or d respectively
         property 'date' # Time of measurement
         property 'temp'
         property 'humidity'

data/lib/open_weather/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open-weather-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-03 00:00:00.000000000 Z
+date: 2024-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -210,6 +210,7 @@ files:
 - lib/open_weather/endpoints/hourly.rb
 - lib/open_weather/endpoints/one_call.rb
 - lib/open_weather/endpoints/stations.rb
+- lib/open_weather/endpoints/thirty_day_forecast.rb
 - lib/open_weather/errors.rb
 - lib/open_weather/errors/fault.rb
 - lib/open_weather/logger.rb
@@ -222,6 +223,10 @@ files:
 - 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/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/list.rb
 - lib/open_weather/models/main.rb
 - lib/open_weather/models/mixins.rb
@@ -270,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: OpenWeather API Ruby client.