Add register stations

CHANGELOG.md

@@ -1,6 +1,7 @@
 ### 0.2.1 (Next)
 
 * Your contribution here.
+* [#18](https://github.com/dblock/open-weather-ruby-client/pull/18): Add register_station endpoint - [@wasabigeek](https://github.com/wasabigeek).
 
 ### 0.2.0 (2020/05/17)
 

README.md

@@ -20,6 +20,8 @@ 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)
 - [Configuration](#configuration)
   - [Units](#units)
     - [Converting Temperature](#converting-temperature)
@@ -193,6 +195,25 @@ 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'
+```
+
 ## Configuration
 
 You can configure client options, globally.

lib/open_weather/client.rb

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

lib/open_weather/connection.rb

@@ -11,7 +11,10 @@ def headers
     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

lib/open_weather/endpoints.rb

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

lib/open_weather/endpoints/stations.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OpenWeather
+  module Endpoints
+    module Stations
+      def register_station(options = {})
+        OpenWeather::Models::Station.new(post('stations', options))
+      end
+    end
+  end
+end

lib/open_weather/models.rb

@@ -13,3 +13,4 @@
 require_relative 'models/list'
 require_relative 'models/city'
 require_relative 'models/one_call'
+require_relative 'models/station'

lib/open_weather/models/model.rb

@@ -10,7 +10,8 @@ class Model < Hashie::Trash
       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
 

lib/open_weather/models/station.rb

@@ -0,0 +1,24 @@
+# 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
+    end
+  end
+end

lib/open_weather/request.rb

@@ -33,7 +33,8 @@ def request(method, path, options)
           request.url(path, options)
         when :post, :put
           request.path = path
-          request.body = options unless options.empty?
+          request.params = { appid: options.delete(:appid) }
+          request.body = options.to_json unless options.empty?
         end
         request.options.merge!(options.delete(:request)) if options.key?(:request)
       end

spec/lib/open_weather/models/station_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe OpenWeather::Models::Station do
+  include_context 'API client', endpoint: 'https://api.openweathermap.org/data/3.0'
+
+  describe '.register!' do
+    let(:create_attributes) do
+      {
+        external_id: 'SF_TEST001',
+        name: 'San Francisco Test Station',
+        latitude: 37.76,
+        longitude: -122.43,
+        altitude: 150
+      }
+    end
+
+    before do
+      allow(OpenWeather::Client).to receive(:new).and_return(client)
+    end
+
+    it 'registers a station via the Client', vcr: { cassette_name: 'stations/register_success' } do
+      model = described_class.new(create_attributes)
+      result = model.register!
+      expect(result.object_id).to eq(model.object_id)
+      expect(result).to have_attributes(create_attributes.merge(id: '5ed21a12cca8ce0001f1aef1'))
+    end
+  end
+end

spec/open_weather/endpoints/stations_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'stations' do
+  include_context 'API client', endpoint: 'https://api.openweathermap.org/data/3.0'
+
+  it 'registers a station', vcr: { cassette_name: 'stations/register_success' } do
+    data = client.register_station(
+      external_id: 'SF_TEST001',
+      name: 'San Francisco Test Station',
+      latitude: 37.76,
+      longitude: -122.43,
+      altitude: 150
+    )
+    expect(data).to be_a(OpenWeather::Models::Station)
+    expect(data).to have_attributes(
+      id: '5ed21a12cca8ce0001f1aef1',
+      external_id: 'SF_TEST001',
+      name: 'San Francisco Test Station',
+      latitude: 37.76,
+      longitude: -122.43,
+      altitude: 150
+    )
+  end
+end

spec/support/shared/api_client.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-RSpec.shared_context 'API client', shared_context: :metadata do
+RSpec.shared_context 'API client', shared_context: :metadata do |params|
   before do
     OpenWeather::Config.reset
+    OpenWeather::Config.endpoint = params[:endpoint] if params&.key?(:endpoint)
   end
   let(:client) { OpenWeather::Client.new(api_key: ENV['OPEN_WEATHER_API_KEY'] || 'api-key') }
 end