module MetofficeDatapoint::Api::TextMethods

Public: Wrapper class around the Met Office DataPoint API endpoints

Public Instance Methods

mountain_area_capabilities() click to toggle source

Public: Returns the forecast creation dates, valid from and to dates, and the general risk for each mountain area.

Returns a Hash.

# File lib/metoffice_datapoint/api/text_methods.rb, line 84
def mountain_area_capabilities
  query('txt/wxfcs/mountainarea/json/capabilities')
end
mountain_area_forecast(location_id) click to toggle source

Public: Returns a mountain area forecast covering the four day period after its issue date. API is updated at least once a day but may be updated more often.

location_id - An Integer corresponding to a mountain area.

Returns a Hash.

# File lib/metoffice_datapoint/api/text_methods.rb, line 94
def mountain_area_forecast(location_id)
  query("txt/wxfcs/mountainarea/json/#{location_id}")
end
mountain_area_sitelist() click to toggle source

Public: Returns a list of locations the mountain area forecast data feed provides data for. You can use this to find the ID of the site that you are interested in.

Returns a Hash.

# File lib/metoffice_datapoint/api/text_methods.rb, line 76
def mountain_area_sitelist
  query('txt/wxfcs/mountainarea/json/sitelist')
end
nationalparks_capabilities() click to toggle source

Public: Returns when the data for each of the National Park forecasts was updated. You can use this to check when the forecasts have updated rather than fetching the National Park forecasts repeatedly.

Returns a Hash.

# File lib/metoffice_datapoint/api/text_methods.rb, line 34
def nationalparks_capabilities
  query('txt/wxfcs/nationalpark/json/capabilities')
end
nationalparks_forecasts(location_id='all') click to toggle source

Public: Returns a text forecast for a National Park. API is updated twice daily, early morning and early afternoon.

Returns a Hash.

# File lib/metoffice_datapoint/api/text_methods.rb, line 42
def nationalparks_forecasts(location_id='all')
  query("txt/wxfcs/nationalpark/json/#{location_id}")
end
nationalparks_sitelist() click to toggle source

Public: Returns a list of locations the National Park forecast data feed provides data for. You can use this to find the ID of the site that you are interested in.

Returns a Hash.

# File lib/metoffice_datapoint/api/text_methods.rb, line 26
def nationalparks_sitelist
  query('txt/wxfcs/nationalpark/json/sitelist')
end
regional_capabilities() click to toggle source

Public: Returns when the regional forecast was updated. You can use this to check when the forecasts have updated rather than fetching the regional forecasts repeatedly.

Returns a Hash.

# File lib/metoffice_datapoint/api/text_methods.rb, line 58
def regional_capabilities
  query('txt/wxfcs/regionalforecast/json/capabilities')
end
regional_forecast(location_id) click to toggle source

Public: Returns regional forecast text. API is updated twice daily, AM and PM, normally early morning and early afternoon.

location_id - An Integer corresponding to a region.

Returns a Hash.

# File lib/metoffice_datapoint/api/text_methods.rb, line 68
def regional_forecast(location_id)
  query("txt/wxfcs/regionalforecast/json/#{location_id}")
end
regional_sitelist() click to toggle source

Public: Returns a list of locations the regional forecast data feed provides data for. You can use this to find the ID of the site that you are interested in.

Returns a Hash.

# File lib/metoffice_datapoint/api/text_methods.rb, line 50
def regional_sitelist
  query('txt/wxfcs/regionalforecast/json/sitelist')
end
ukextremes_latest_observations() click to toggle source

Public: Returns the regional observed extremes of weather across the UK for the day of issue. API is updated daily.

Returns a Hash.

# File lib/metoffice_datapoint/api/text_methods.rb, line 18
def ukextremes_latest_observations
  query('txt/wxobs/ukextremes/json/latest')
end
ukextremes_observations_capabilities() click to toggle source

Public: Returns when the regional extremes observations data feed was last updated, and the period it covers.

Returns a Hash.

# File lib/metoffice_datapoint/api/text_methods.rb, line 10
def ukextremes_observations_capabilities
  query('txt/wxobs/ukextremes/json/capabilities')
end

Private Instance Methods

query(path, options={}) click to toggle source
# File lib/metoffice_datapoint/api/text_methods.rb, line 100
def query(path, options={})
  Oj.load(get(path, options))
end