Class: Openaq::Client

Inherits:

Object

• Object
• Openaq::Client

Includes:

Networking

Defined in:

lib/openaq/client.rb

Constant Summary

Constants included from Networking

Networking::PARAMS

Instance Method Summary

• #all_cities(params = {}) ⇒ Enumerator

  Returns an Enumerator of #cities.

• #all_countries(params = {}) ⇒ Enumerator

  Returns an Enumerator of #countries.

• #all_fetches(params = {}) ⇒ Enumerator

  Returns an Enumerator of #fetches.

• #all_latest(params = {}) ⇒ Enumerator

  Returns an Enumerator of #latest.

• #all_locations(params = {}) ⇒ Enumerator

  Returns an Enumerator of #locations.

• #all_measurements(params = {}) ⇒ Enumerator

  Returns an Enumerator of #measurements.

• #all_parameters(params = {}) ⇒ Enumerator

  Returns an Enumerator of #parameters.

• #all_sources(params = {}) ⇒ Enumerator

  Returns an Enumerator of #sources.

• #cities(params = {}) ⇒ Array<Hash>

  Provides a simple listing of cities within the platform.

• #countries(params = {}) ⇒ Array<Hash>

  Provides a simple listing of countries within the platform.

• #fetches(params = {}) ⇒ Array<Hash>

  Providing data about individual fetch operations that are used to populate data in the platform.

• #latest(params = {}) ⇒ Array<Hash>

  Provides the latest value of each available parameter for every location in the system.

• #locations(params = {}) ⇒ Array<Hash>

  Provides a list of measurement locations and their meta data.

• #measurements(params = {}) ⇒ Array<Hash>

  Provides data about individual measurements.

• #parameters(params = {}) ⇒ Array<Hash>

  Provides a simple listing of parameters within the platform.

• #sources(params = {}) ⇒ Array<Hash>

  Provides a list of data sources.

Methods included from Networking

#get, #paginated_get

Instance Method Details

#all_cities(params = {}) ⇒ Enumerator

Returns an Enumerator of #cities

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Enumerator)

# File 'lib/openaq/client.rb', line 24

#all_countries(params = {}) ⇒ Enumerator

Returns an Enumerator of #countries

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Enumerator)

# File 'lib/openaq/client.rb', line 30

#all_fetches(params = {}) ⇒ Enumerator

Returns an Enumerator of #fetches

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Enumerator)

# File 'lib/openaq/client.rb', line 36

#all_latest(params = {}) ⇒ Enumerator

Returns an Enumerator of #latest

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Enumerator)

# File 'lib/openaq/client.rb', line 42

#all_locations(params = {}) ⇒ Enumerator

Returns an Enumerator of #locations

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Enumerator)

# File 'lib/openaq/client.rb', line 48

#all_measurements(params = {}) ⇒ Enumerator

Returns an Enumerator of #measurements

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Enumerator)

# File 'lib/openaq/client.rb', line 54

#all_parameters(params = {}) ⇒ Enumerator

Returns an Enumerator of #parameters

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Enumerator)

# File 'lib/openaq/client.rb', line 60

#all_sources(params = {}) ⇒ Enumerator

Returns an Enumerator of #sources

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Enumerator)

# File 'lib/openaq/client.rb', line 66

#cities(params = {}) ⇒ Array<Hash>

Provides a simple listing of cities within the platform.

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Array<Hash>)

# File 'lib/openaq/client.rb', line 72

#countries(params = {}) ⇒ Array<Hash>

Provides a simple listing of countries within the platform.

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Array<Hash>)

# File 'lib/openaq/client.rb', line 78

#fetches(params = {}) ⇒ Array<Hash>

Providing data about individual fetch operations that are used to populate data in the platform.

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Array<Hash>)

# File 'lib/openaq/client.rb', line 84

#latest(params = {}) ⇒ Array<Hash>

Provides the latest value of each available parameter for every location in the system.

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Array<Hash>)

# File 'lib/openaq/client.rb', line 90

#locations(params = {}) ⇒ Array<Hash>

Provides a list of measurement locations and their meta data.

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Array<Hash>)

# File 'lib/openaq/client.rb', line 96

#measurements(params = {}) ⇒ Array<Hash>

Provides data about individual measurements

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Array<Hash>)

# File 'lib/openaq/client.rb', line 102

#parameters(params = {}) ⇒ Array<Hash>

Provides a simple listing of parameters within the platform.

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Array<Hash>)

# File 'lib/openaq/client.rb', line 108

#sources(params = {}) ⇒ Array<Hash>

Provides a list of data sources.

Parameters:

• params (defaults to: {}) —

  please read the Api Documentation

Returns:

• (Array<Hash>)

# File 'lib/openaq/client.rb', line 114