Module: MetofficeDatapoint

Extended by:

Configuration

Defined in:

lib/metoffice_datapoint.rb,
lib/metoffice_datapoint/api.rb,
lib/metoffice_datapoint/mash.rb,
lib/metoffice_datapoint/client.rb,
lib/metoffice_datapoint/errors.rb,
lib/metoffice_datapoint/request.rb,
lib/metoffice_datapoint/version.rb,
lib/metoffice_datapoint/configuration.rb,
lib/metoffice_datapoint/api/text_methods.rb,
lib/metoffice_datapoint/api/location_methods.rb,
lib/metoffice_datapoint/api/map_overlay_methods.rb,
lib/metoffice_datapoint/api/standalone_maps_methods.rb

Overview

Public: Provides a simple wrapper to the UK’s Met Office DataPoint API.

To use this gem, you'll need to register and obtain your own API Key.
See http://www.metoffice.gov.uk/datapoint/support/getting-started

Defined Under Namespace

Modules: Api, Configuration, Errors, Request Classes: Client, Mash

Constant Summary

VERSION =

Public: Version number, following Semantic Versioning 2.0.0. See semver.org/.

"0.0.1"

Constants included from Configuration

Configuration::DEFAULT_API_ENDPOINT, Configuration::DEFAULT_USER_AGENT, Configuration::VALID_OPTIONS_KEYS

Class Method Summary

• .new(options = {}) ⇒ Object

  Public: Alias for MetofficeDatapoint::Client.new.

Methods included from Configuration

configure, extended, options, reset

Class Method Details

.new(options = {}) ⇒ Object

Public: Alias for MetofficeDatapoint::Client.new

Examples

MetofficeDatapoint.new(api_key: 'your_api_key')

Returns MetofficeDatapoint::Client.

# File 'lib/metoffice_datapoint.rb', line 24

def new(options={})
  MetofficeDatapoint::Client.new(options)
end