Module: Datacentred

Defined in:
lib/datacentred.rb,
lib/datacentred/error.rb,
lib/datacentred/response.rb,
lib/datacentred/model/base.rb,
lib/datacentred/model/role.rb,
lib/datacentred/model/user.rb,
lib/datacentred/model/usage.rb,
lib/datacentred/request/base.rb,
lib/datacentred/model/project.rb,
lib/datacentred/model/version.rb,
lib/datacentred/request/roles.rb,
lib/datacentred/request/usage.rb,
lib/datacentred/request/users.rb,
lib/datacentred/request/projects.rb,
lib/datacentred/request/versions.rb

Overview

Main Datacentred client module

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

Defined Under Namespace

Modules: Errors, Model, Request Classes: Project, Response, Role, Usage, User, Version

Class Method Summary collapse

Class Method Details

.access_key ⇒ String

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

Returns:

  • (String) —

    API access key credential



32
33
34
 
# File 'lib/datacentred.rb', line 32

def self.access_key
  @@access_key ||= ENV['DATACENTRED_ACCESS']
end

.access_key=(new_access_key) ⇒ String

Set a new access key value.

This will override any values loaded from environment variables.

Parameters:

  • new_access_key (String) —

    New access key value

Returns:

  • (String) —

    API access key credential



42
43
44
 
# File 'lib/datacentred.rb', line 42

def self.access_key=(new_access_key)
  @@access_key = new_access_key
end

.secret_key ⇒ String

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

Returns:

  • (String) —

    API secret key credential



53
54
55
 
# File 'lib/datacentred.rb', line 53

def self.secret_key
  @@secret_key ||= ENV['DATACENTRED_SECRET']
end

.secret_key=(new_secret_key) ⇒ String

Set a new secret key value.

This will override any values loaded from environment variables.

Parameters:

  • new_secret_key (String) —

    New secret key value

Returns:

  • (String) —

    API secret key credential



64
65
66
 
# File 'lib/datacentred.rb', line 64

def self.secret_key=(new_secret_key)
  @@secret_key = new_secret_key
end