module Datacentred

Main Datacentred client module

This library acts as a Ruby wrapper for the DataCentred API.

Public Class Methods

access_key() click to toggle source

Access key credential for the DataCentred API.

This value is automatically loaded from the DATACENTRED_ACCESS environment variable.

You can find your API credentials by logging into the dashboard at my.datacentred.io

@return [String] API access key credential

# File lib/datacentred.rb, line 32
def self.access_key
  @@access_key ||= ENV['DATACENTRED_ACCESS']
end
access_key=(new_access_key) click to toggle source

Set a new access key value.

This will override any values loaded from environment variables.

@param [String] new_access_key New access key value @return [String] API access key credential

# File lib/datacentred.rb, line 42
def self.access_key=(new_access_key)
  @@access_key = new_access_key
end
secret_key() click to toggle source

Secret key credential for the DataCentred API.

This value is automatically loaded from the DATACENTRED_SECRET environment variable.

You can find your API credentials by logging into the dashboard at my.datacentred.io

@return [String] API secret key credential

# File lib/datacentred.rb, line 53
def self.secret_key
  @@secret_key ||= ENV['DATACENTRED_SECRET']
end
secret_key=(new_secret_key) click to toggle source

Set a new secret key value.

This will override any values loaded from environment variables.

@param [String] new_secret_key New secret key value

@return [String] API secret key credential

# File lib/datacentred.rb, line 64
def self.secret_key=(new_secret_key)
  @@secret_key = new_secret_key
end