Add measurements

CHANGELOG.md

@@ -1,7 +1,7 @@
 ### 0.2.1 (Next)
 
 * Your contribution here.
-* [#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).
+* [#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).
 
 ### 0.2.0 (2020/05/17)
 

README.md

@@ -26,6 +26,8 @@ Unlike other clients, including [open-weather](https://github.com/coderhs/ruby_o
     - [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)
@@ -253,6 +255,42 @@ To delete a station, call the client method:
 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 mandatory parameters:
+```ruby
+client.get_measurements(
+  station_id: '5ed21a12cca8ce0001f1aef1',
+  type: 'd',
+  limit: 100,
+  from: 1469817340,
+  to: 1591620047
+) # => Array[Hash]
+```
+
 ## Configuration
 
 You can configure client options, globally.

lib/open_weather/endpoints/stations.rb

@@ -30,6 +30,19 @@ def delete_station(id)
         nil
       end
 
+      def create_measurements(measurements, options = {})
+        post('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(', ')}" unless missing_keys.empty?
+
+        get('measurements', options)
+      end
+
       private
 
       def validate_id(id)

lib/open_weather/request.rb

@@ -20,6 +20,14 @@ def delete(path, options = {})
 
     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?
@@ -34,7 +42,11 @@ def request(method, path, options)
         when :post, :put
           request.path = path
           request.params = { appid: options.delete(:appid) }
-          request.body = options.to_json unless options.empty?
+          if options.key?(:body)
+            request.body = options.delete(:body).to_json
+          elsif !options.empty? # is a Hash, so `.present?` doesn't capture the same behaviour
+            request.body = options.to_json
+          end
         end
         request.options.merge!(options.delete(:request)) if options.key?(:request)
       end

spec/open_weather/endpoints/stations_spec.rb

@@ -94,4 +94,68 @@
       end
     end
   end
+
+  describe '#create_measurements' do
+    it 'creates measurements', vcr: { cassette_name: 'stations/create_measurement_success' } do
+      create_params = {
+        "station_id": '5ed21a12cca8ce0001f1aef1',
+        "dt": 1479817340,
+        "temperature": 18.7,
+        "wind_speed": 1.2,
+        "wind_gust": 3.4,
+        "pressure": 1021,
+        "humidity": 87,
+        "rain_1h": 2,
+        "clouds": [
+          {
+            "condition": 'NSC'
+          }
+        ]
+      }
+      data = client.create_measurements([create_params])
+      expect(data).to be_nil
+    end
+
+    context 'when station does not exist' do
+      it 'raises error', vcr: { cassette_name: 'stations/create_measurement_failed_with_invalid_station' } do
+        create_params = {
+          "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'
+            }
+          ]
+        }
+        expect { client.create_measurements([create_params]) }
+          .to raise_error(OpenWeather::Errors::Fault, /expected=string, got=number/)
+      end
+    end
+  end
+
+  describe '#get_measurements' do
+    it 'gets measurements', vcr: { cassette_name: 'stations/get_measurement_success' } do
+      data = client.get_measurements(
+        station_id: '5ed21a12cca8ce0001f1aef1',
+        type: 'd',
+        limit: 100,
+        from: 1469817340,
+        to: 1591620047
+      )
+      expect(data.size).to eq(1)
+      expect(data.first['station_id']).to eq('5ed21a12cca8ce0001f1aef1')
+    end
+
+    context 'without mandatory params' do
+      it 'raises error' do
+        expect { client.get_measurements(something: 'something') }.to raise_error(ArgumentError, /station_id, type, limit, from, to/)
+      end
+    end
+  end
 end