open-weather-ruby-client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d3916328b6401b21690d359dab0aa1f893282b9456f7d9960fcb8a3024fc625
-  data.tar.gz: 66657fdd5b0cbad2889b5467cdf9e009b4b8e32cd997c0d86c7ddbf19b14e644
+  metadata.gz: 3b61381c999fcbbcefa63521936ee96cc28eb7648a9b2b13cc9d01a608d8b12f
+  data.tar.gz: aaa00190d52e86a471f2dca1e52c5c4f5fbf67cdfdf5639fe9302d793d1326e2
 SHA512:
-  metadata.gz: 75c4b1f7baafa1a3a61d5b8ba3223a8ac3eeabc2a6a1ccec506e8f718608088b1289487e562a3061d74ba517c09de8bcd4150e3cbad381e893fb9db1b71976ee
-  data.tar.gz: 6e769293fc354dd3af19780e4cba5a92a0730d2ded3db7976f44d25e8518b49b58bd62bfd7e033ab2ca2d7194db01df03e91a834a67b55824443f45465a9b59e
+  metadata.gz: 890ef7edc806545a9b83f99a87133d7ff83900593f17e5aadcf76f7389cfa7c6a3249d0f4911d6d257d493a00dd572880f8848ee68a6ba0cd5ffd9561c53c75f
+  data.tar.gz: 3094f7b9d058070590db2ddfabc99d9f799f00b3b185fb9efd93b348d9abd8f124ec8d2f0552f7430850bf08dc7cb698e802c648a32aa9dbaf333b343c0521b4

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 0.3.0 (2023/03/25)
+
+* [#30](https://github.com/dblock/open-weather-ruby-client/pull/30): Added support for Ruby 3.2 - [@petergoldstein](https://github.com/petergoldstein).
+* [#27](https://github.com/dblock/open-weather-ruby-client/pull/27): Removed default values for Faraday’s SSL settings ca_file and ca_path - [@sunny](https://github.com/sunny).
+* [#21](https://github.com/dblock/open-weather-ruby-client/pull/21), [#20](https://github.com/dblock/open-weather-ruby-client/pull/20), [#19](https://github.com/dblock/open-weather-ruby-client/pull/19), [#18](https://github.com/dblock/open-weather-ruby-client/pull/18): Added support for Stations API - [@wasabigeek](https://github.com/wasabigeek).
+* [#22](https://github.com/dblock/open-weather-ruby-client/pull/23): Removed API version from `Config#endpoint` - [@dblock](https://github.com/dblock).
+
 ### 0.2.0 (2020/05/17)
 
 * [#14](https://github.com/dblock/open-weather-ruby-client/pull/14): Added support for One Call API - [@dblock](https://github.com/dblock).

data/README.md

@@ -2,9 +2,9 @@ OpenWeather Ruby Client
 =======================
 
 [![Gem Version](https://badge.fury.io/rb/open-weather-ruby-client.svg)](https://badge.fury.io/rb/open-weather-ruby-client)
-[![Build Status](https://travis-ci.org/dblock/open-weather-ruby-client.svg?branch=master)](https://travis-ci.org/dblock/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)
 
-A Ruby client for the [OpenWeather API v2.5](https://openweathermap.org/api).
+A Ruby client for the [OpenWeather API v2.5 and v3.0](https://openweathermap.org/api).
 
 Unlike other clients, including [open-weather](https://github.com/coderhs/ruby_open_weather_map), provides a rich first class interface to OpenWeather models, structured timestamps, built-in metrics conversion for temperature and wind speed, offers more consistent error handling, and is implemented with thorough test coverage using actual OpenWeather data.
 
@@ -20,6 +20,14 @@ 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)
+  - [Stations](#stations)
+    - [Register a Station](#register-a-station)
+    - [List Stations](#list-stations)
+    - [Get Station](#get-station)
+    - [Update Station](#update-station)
+    - [Delete Station](#delete-station)
+    - [Create Measurements](#create-measurements)
+    - [Get Measurements](#get-measurements)
 - [Configuration](#configuration)
   - [Units](#units)
     - [Converting Temperature](#converting-temperature)
@@ -193,6 +201,96 @@ data.current # => OpenWeather::Models::OneCall::CurrentWeather
 data.hourly # => Array[OpenWeather::Models::OneCall::HourlyWeather]
 ```
 
+### Stations
+
+The [Stations API](https://openweathermap.org/stations) lets your manage personal weather stations and measurements.
+
+#### Register a Station
+
+To register a station, you can call the client method:
+```ruby
+data = client.register_station(external_id: 'SF_TEST001', ...) # => OpenWeather::Models::Station
+data.id # => '5ed2118acca8ce0001f1aeg1'
+data.external_id # => 'SF_TEST001'
+```
+Alternatively, call `register!` on an instance of `Station`:
+```ruby
+model = OpenWeather::Models::Station.new(external_id: 'SF_TEST001', ...)
+model.register!
+model.id # => '5ed2118acca8ce0001f1aeg1'
+```
+
+#### List Stations
+
+To list all stations, call the client method:
+```ruby
+client.list_stations # => Array[OpenWeather::Models::Station]
+```
+
+#### Get Station
+
+To get a station, call the client method:
+```ruby
+client.get_station('5ed2118acca8ce0001f1aeg1') # => OpenWeather::Models::Station
+```
+
+#### Update Station
+
+To update a station, call the client method:
+```ruby
+client.update_station('5ed2118acca8ce0001f1aeg1', external_id: 'SF_TEST002') # => OpenWeather::Models::Station
+```
+Alternatively, call `update!` on an instance of `Station`:
+```ruby
+model = OpenWeather::Models::Station.new(external_id: 'SF_TEST001', ...)
+model.register!
+model.update!(external_id: 'SF_TEST002')
+model.external_id # => 'SF_TEST002'
+```
+
+#### Delete Station
+
+To delete a station, call the client method:
+```ruby
+data = client.delete_station('5ed2118acca8ce0001f1aeg1') # => nil
+```
+
+#### Create Measurements
+
+To create measurements, call the client method:
+```ruby
+client.create_measurements([
+  {
+    "station_id": -1,
+    "dt": 1479817340,
+    "temperature": 18.7,
+    "wind_speed": 1.2,
+    "wind_gust": 3.4,
+    "pressure": 1021,
+    "humidity": 87,
+    "rain_1h": 2,
+    "clouds": [
+      {
+        "condition": 'NSC'
+      }
+    ]
+  }
+]) # => nil
+```
+
+#### Get Measurements
+
+To get measurements, call the client method with the required parameters:
+```ruby
+client.get_measurements(
+  station_id: '5ed21a12cca8ce0001f1aef1',
+  type: 'd',
+  limit: 100,
+  from: 1469817340,
+  to: 1591620047
+) # => Array[OpenWeather::Models::Stations::Measurement]
+```
+
 ## Configuration
 
 You can configure client options, globally.
@@ -211,7 +309,7 @@ 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/2.5/`.
+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.

data/lib/open_weather/client.rb

@@ -6,6 +6,7 @@ module OpenWeather
     include Request
     include Endpoints::Current
     include Endpoints::OneCall
+    include Endpoints::Stations
 
     attr_accessor(*Config::ATTRIBUTES)
 

data/lib/open_weather/config.rb

@@ -21,11 +21,11 @@ module OpenWeather
     attr_accessor(*Config::ATTRIBUTES)
 
     def reset
-      self.endpoint = 'https://api.openweathermap.org/data/2.5'
+      self.endpoint = 'https://api.openweathermap.org/data'
       self.api_key = nil
       self.user_agent = "OpenWeather Ruby Client/#{OpenWeather::VERSION}"
-      self.ca_path = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_DIR : nil
-      self.ca_file = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_FILE : nil
+      self.ca_path = nil
+      self.ca_file = nil
       self.proxy = nil
       self.logger = nil
       self.timeout = nil

data/lib/open_weather/connection.rb

@@ -11,7 +11,10 @@ module OpenWeather
     def connection
       @connection ||= begin
         options = {
-          headers: headers.merge('Accept' => 'application/json; charset=utf-8')
+          headers: headers.merge(
+            'Accept' => 'application/json; charset=utf-8',
+            'Content-Type' => 'application/json'
+          )
         }
 
         options[:headers]['User-Agent'] = user_agent if user_agent

data/lib/open_weather/endpoints/current.rb

@@ -38,7 +38,7 @@ module OpenWeather
             options.delete(:country)
           ].compact.join(',')
         end
-        OpenWeather::Models::City::Weather.new(get('weather', options), options)
+        OpenWeather::Models::City::Weather.new(get('2.5/weather', options), options)
       end
 
       def current_cities_geo_box(*args)
@@ -51,7 +51,7 @@ module OpenWeather
           options.delete(:lat_top),
           options.delete(:zoom)
         ].join(',')
-        OpenWeather::Models::List.new(get('box/city', options), options)
+        OpenWeather::Models::List.new(get('2.5/box/city', options), options)
       end
 
       def current_cities_geo_circle(*args)
@@ -63,7 +63,7 @@ module OpenWeather
           options[:cnt] = args.shift || 1
         end
 
-        OpenWeather::Models::List.new(get('find', options), options)
+        OpenWeather::Models::List.new(get('2.5/find', options), options)
       end
 
       def current_cities_id(*args)
@@ -71,7 +71,7 @@ module OpenWeather
         options[:id] = args.join(',') if args.any?
         options[:id] = options.delete(:ids) if options.key?(:ids)
         options[:id] = options[:id].join(',') if options[:id].is_a?(Array)
-        OpenWeather::Models::List.new(get('group', options), options)
+        OpenWeather::Models::List.new(get('2.5/group', options), options)
       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) ? 'onecall/timemachine' : 'onecall'
+        path = options.key?(:dt) ? '2.5/onecall/timemachine' : '2.5/onecall'
         OpenWeather::Models::OneCall::Weather.new(get(path, options), options)
       end
     end

data/lib/open_weather/endpoints/stations.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Endpoints
+    module Stations
+      def register_station(options = {})
+        OpenWeather::Models::Station.new(post('3.0/stations', options))
+      end
+
+      def list_stations
+        get('3.0/stations').map { |data| OpenWeather::Models::Station.new(data) }
+      end
+
+      def get_station(id)
+        validate_id(id)
+
+        OpenWeather::Models::Station.new(get("3.0/stations/#{id}"))
+      end
+
+      def update_station(id, options = {})
+        validate_id(id)
+
+        OpenWeather::Models::Station.new(put("3.0/stations/#{id}", options))
+      end
+
+      def delete_station(id)
+        validate_id(id)
+
+        delete("3.0/stations/#{id}")
+        nil
+      end
+
+      def create_measurements(measurements, options = {})
+        post('3.0/measurements', options.merge(body: measurements))
+        nil
+      end
+
+      def get_measurements(options)
+        required_keys = %i[station_id type limit from to]
+        missing_keys = required_keys - options.keys
+        raise ArgumentError, "Missing params: #{missing_keys.join(', ')}" if missing_keys.any?
+
+        get('3.0/measurements', options).map { |m| OpenWeather::Models::Stations::Measurement.new(m) }
+      end
+
+      private
+
+      def validate_id(id)
+        raise ArgumentError, 'Invalid ID' unless id&.is_a?(String)
+      end
+    end
+  end
+end

data/lib/open_weather/endpoints.rb

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

data/lib/open_weather/models/model.rb

@@ -10,7 +10,8 @@ module OpenWeather
       attr_reader :options
 
       def initialize(args = nil, options = {})
-        super args
+        transformed_args = args.respond_to?(:transform_keys) ? args.transform_keys(&:to_s) : args
+        super transformed_args
         @options = { units: OpenWeather.config.units }.merge(options || {})
       end
 

data/lib/open_weather/models/station.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    class Station < Model
+      property 'id', from: 'ID' # internal identifier for the station
+      property 'external_id' # external identifier for the station
+      property 'name' # name of the station
+      property 'latitude' #  geographical coordinates of the location (latitude)
+      property 'longitude' # geographical coordinates of the location (longitude)
+      property 'altitude' # height of station above sea level
+      property 'created_at' # timestamp when station was created
+      property 'updated_at' # timestamp when station was updated
+      property 'rank' # rank of station
+
+      def register!
+        data = OpenWeather::Client.new.register_station(to_h)
+        update_attributes!(data)
+
+        self
+      end
+
+      def update!(attributes)
+        data = OpenWeather::Client.new.update_station(id, attributes)
+        update_attributes!(data)
+
+        self
+      end
+
+      def delete!
+        OpenWeather::Client.new.delete_station(id)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    module Stations
+      class Humidity < Model
+        property 'average'
+        property 'weight'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    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 'date' # Time of measurement
+        property 'temp'
+        property 'humidity'
+        property 'wind'
+        property 'precipitation'
+        property 'pressure'
+
+        def initialize(args = nil, options = {})
+          super args, options
+
+          self.temp = OpenWeather::Models::Stations::Temp.new(temp, options) if temp
+          self.humidity = OpenWeather::Models::Stations::Humidity.new(humidity, options) if humidity
+          self.pressure = OpenWeather::Models::Stations::Pressure.new(pressure, options) if pressure
+          self.precipitation = OpenWeather::Models::Stations::Precipitation.new(precipitation, options) if precipitation
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    module Stations
+      class Precipitation < Model
+        property 'rain'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    module Stations
+      class Pressure < Model
+        property 'min'
+        property 'max'
+        property 'average'
+        property 'weight'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Models
+    module Stations
+      class Temp < Model
+        temperature_property 'min'
+        temperature_property 'max'
+        temperature_property 'average'
+        property 'weight'
+      end
+    end
+  end
+end

data/lib/open_weather/models.rb

@@ -13,3 +13,9 @@ require_relative 'models/snow'
 require_relative 'models/list'
 require_relative 'models/city'
 require_relative 'models/one_call'
+require_relative 'models/station'
+require_relative 'models/stations/measurement'
+require_relative 'models/stations/temp'
+require_relative 'models/stations/humidity'
+require_relative 'models/stations/pressure'
+require_relative 'models/stations/precipitation'

data/lib/open_weather/request.rb

@@ -20,6 +20,14 @@ module OpenWeather
 
     private
 
+    #
+    # @param [Symbol] method - Faraday HTTP method.
+    # @param [String] path - URL to send.
+    # @param [Hash] options - :appid, :lang, :units, :endpoint, :body keys will configure the request.
+    #   The rest will be converted to query params for GET/DELETE, or jsonified for POST/PUT.
+    #
+    # @return [Object] - the Faraday::Response#body.
+    #
     def request(method, path, options)
       options = options.dup
       options[:appid] ||= api_key if api_key.present?
@@ -33,7 +41,12 @@ module OpenWeather
           request.url(path, options)
         when :post, :put
           request.path = path
-          request.body = options unless options.empty?
+          request.params = { appid: options.delete(:appid) }
+          if options.key?(:body)
+            request.body = options.delete(:body).to_json
+          elsif !options.empty?
+            request.body = options.to_json
+          end
         end
         request.options.merge!(options.delete(:request)) if options.key?(:request)
       end

data/lib/open_weather/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open-weather-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-17 00:00:00.000000000 Z
+date: 2023-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: dblock@dblock.org
 executables: []
 extensions: []
@@ -82,6 +82,7 @@ files:
 - lib/open_weather/endpoints.rb
 - lib/open_weather/endpoints/current.rb
 - lib/open_weather/endpoints/one_call.rb
+- lib/open_weather/endpoints/stations.rb
 - lib/open_weather/errors.rb
 - lib/open_weather/errors/fault.rb
 - lib/open_weather/logger.rb
@@ -106,6 +107,12 @@ files:
 - lib/open_weather/models/one_call/weather.rb
 - lib/open_weather/models/rain.rb
 - lib/open_weather/models/snow.rb
+- lib/open_weather/models/station.rb
+- lib/open_weather/models/stations/humidity.rb
+- lib/open_weather/models/stations/measurement.rb
+- lib/open_weather/models/stations/precipitation.rb
+- lib/open_weather/models/stations/pressure.rb
+- lib/open_weather/models/stations/temp.rb
 - lib/open_weather/models/sys.rb
 - lib/open_weather/models/weather.rb
 - lib/open_weather/models/wind.rb
@@ -116,7 +123,7 @@ homepage: http://github.com/dblock/open-weather-ruby-client
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubygems_version: 3.1.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: OpenWeather API Ruby client.
 test_files: []